You can use this topic to grab notes, cautions, tables, etc. Use it as a placeholder in your own help file to keep things here you may want to use but don't want to create manually. For example, these caution and warning tables have preset spacing above them so that the text above is not almost directly on the table as it would be if you didn't adjust the table padding, and they are the same in space above as the note and important note.
At the end of this topic is a representation of all the styles used in this template.
Danger, always severe injury or death. Suggestion: A brief few words in bold serves to quickly describe the warning. I've yet to need to use this one while working at Inter-Tel, but you never know. It's here in case you need to use it.
|
DANGER
|
Explosives. Handle explosives like it's the last thing you will ever do. Failure to handle explosives with the utmost attention to detail and care will lead to death. |
Warning, possible severe injury. Suggestion: A brief few words in bold serves to quickly describe the warning.
|
WARNING
|
Electric Shock. Unplug the power cord before attempting to work inside the chassis. Working inside the chassis with the power cord plugged in could result in severe electrical shock and injury. |
Caution, possible minor injury. Suggestion: A brief few words in bold serves to quickly describe the caution.
|
CAUTION
|
Sharp Edges. Sharp edges inside the chassis could result in personal injury. |
Notice style: no injury but possible data or equipment hazard, etc. Suggestion: A brief few words in bold serves to quickly describe the Notice.
|
NOTICE: System Instability. A multiple-application CT Gateway is supported on the same computer running the Unified Communicator Server service application software, but only UC and SIP Server should connect to it.
|
Important note style. Suggestion: A brief few words in bold serves to quickly describe the Important note. We decided not to use the Important style in our manuals/user guides, but it is still here until you remove it from your help files. At some point, I'll update the templates to remove this style.
IMPORTANT: Security Issue. To avoid security issues, it is recommended you NOT leave the Password field blank when logging in, and do not write the password where it can easily be accessed (for example, a sticky note attached to the monitor).
Note style. Suggestion: A brief few words in italic serves to quickly describe the Note.
NOTE: Disabling automatic logon. Click the Log off button from the main Web client window. The logon screen appears and you can enter a new username/password, and choose whether or not to check the box to save the new logon information. The auto-logon feature allows for seamless integration with the UC Tray Client.
Preformatted table examples: These have table a margin padding of 6px that allows for correct spacing after text. Similar to the notes, etc. above.
|
Property and Description |
Property and Description |
|
Event |
Information Logged |
Event |
Information Logged |
|
Add/Delete Tenant Group |
Tenant-Group Name |
Database Backup |
Automatic/Manual, Filename |
|
Field |
Description |
|
Company |
Type a company, job title, or department name for this contact. There is a 255 character limit for each field. |
|
Title |
|
|
Department |
|
|
Address Panel |
|
|
Street |
Type a street address using up to two fields, city, state/province, zip/postal code, and country for this contact. Each field has a 127 character limit. |
|
City |
|
|
State/Province |
|
|
Zip/Postal Code |
|
|
Country |
|
|
Phone Numbers Panel |
|
|
Work Phone |
Type a work phone, fax, or up to two custom numbers. There is an 80 character limit for each field. |
|
Work Fax |
|
|
Custom Number #1 |
|
|
Custom Number #2 |
|
|
Work E-mail |
Type a work e-mail address of up to 255 characters. |
|
Field |
Description |
|
Company |
Type a company, job title, or department name for this contact. There is a 255 character limit for each field. |
|
Title |
|
|
Department |
|
|
Street |
Type a street address using up to two fields, city, state/province, zip/postal code, and country for this contact. Each field has a 127 character limit. |
|
City |
|
|
State/Province |
|
|
Zip/Postal Code |
|
|
Country |
|
|
Work Phone |
Type a work phone, fax, or up to two custom numbers. There is an 80 character limit for each field. |
|
Work Fax |
|
|
Custom Number #1 |
|
|
Custom Number #2 |
|
|
Work E-mail |
Type a work e-mail address of up to 255 characters. |
|
NOTES: Requirements. The following settings are required to use some of the Outbound Communication options:
|
|
IMPORTANT: Requirements. The following settings are required to use some of the Outbound Communication options:
|
|
8pt Registered Trademark ®
The above registered trademarks are not created using the Insert > Symbol option in RoboHelp because RoboHelp will not allow you to superscript them. I created the mark above using ALT key-0174. It is OK to use the Insert > Symbol option to insert the trademark symbol ™ .
As for the remaining headings, I try to stay away from using them as I have found that dropdown DHTML works better to contain the page and avoid long scrolling. I think we should keep them for those that want to use them for example in shorter pages. Experiment with DHTML but avoid putting in too much information as you defeat its purpose by having the user scroll too much in the dropdown. I have done this, but am working to alleviate it by having the user jump to another html file through a link.
Normal is our default paragraph font Arial 10pt. Use the tool bar arrows to nest Normal under lists.
bullet1
Use the arrow tools on the toolbar to nest the bullets. All bullet styles are used in text, in procedures and in tables. Strongly advise against creating additional list styles or modifying the current styles.
bullet1
Normal Use the arrow tool on the tool bar to nest Normal under lists.
Normal
bullet2 Use the arrow tools on the toolbar to nest the bullets.
bullet2
Normal Use the arrow tool on the tool bar to nest Normal under lists.
Normal
bullet3
bullet3
Normal
bullet1
bullet1
blank (blank) can be used to gain space quickly instead of changing graphic or table parameters
step — All steps shown here use default nesting.
In all numbered and bulleted lists, the default RoboHelp values are used with the exception of the space above values. Therefore, use the tool bar arrows to nest the substeps and bulleted lists accordingly. Use the Normal style with the arrows to nest text under the steps and bulleted lists.
step
substep You may need to manually set the starting substep on occasion. In general, always check numbered lists to see they increment correctly. Manually correct those steps that don't increment. Do this by right-clicking the step and selecting Bullets and Numbering. At the bottom of the dialog box, change the Restart numbering at value. Setting this value to 1 is also the same as “a”, 2 for b, and so on.
substep
When you start inserting all these bullets and substeps, RoboHelp can get confused. So before leaving your procedure, check that the sequence is correct for the steps and substeps.
substep
bullet1
Normal
bullet1
bullet2
Normal
bullet2
bullet3
Normal
bullet3
substep
substep
step
bullet1
bullet1
Normal
bullet2
bullet2
Normal
bullet3
bullet3
Normal
bullet1
step
step
Caution is used with Caution table. It is never necessary to use this style unless you are creating the caution manually.
Cautionsymbol (Cautionsymbol) is used as a placeholder in the above table for the triangle. It is never necessary to use this style unless you are creating the caution manually.
datetimecopyright is Arial 8 pt and is used in the About page as the format for the date and time at the bottom of the page. This is where you go to determine if the engineer or other user has the most up-to-date file. Many times, this is the only way you can quickly determine if the development team used your most recent help file. The date in this file should match one of the dates of the output files you keep on your system or in the final help folder in Jeff's Temp folder for GA. You might want to consider renaming your output folders after compiling for the engineer or when you want to post another help file. This way, what you post or give the engineer will match one of the copies you kept on your system. Typically, the development teams will be one build behind your latest. This style is also used for copyright text.
filenamefilediroutput is courier new 9 pt and is used for console output text. If you only need to apply courier to something, use the courier character tag.
Example text using the courier character tag.
Graybackgndtext is used to achieve the note effect when you need to enter a return in your note. Use the note style to actually create a note. Examples below
NOTE: The contacts you add to your address book display as (or a variation depending on status). This icon or variation only appears for accounts or contacts linked to accounts. This icon appears in search results for personal contacts and company contacts. It also appears in the Personal Contacts tab, of the main interface, for simple contacts (not linked to accounts). Personal Contacts displaying do not receive real-time updates or status. Keep in mind that if the contact you are editing is an account on the system, editing any field will not allow that field to autoupdate if the account changes this information.
Graybackgndtext
Graybackgndtext
Graybackgndtext
NOTE: This is the beginning format for creating a Note as in the example above. To achieve the example above you can copy the placeholder note example above into your help file. Or, you can create the Note look above manually by inserting one space, type and highlight the word NOTE: including the colon; apply the white bold text and Inter-Tel Blue fill color.
IMPORTANT: important style is used to create this important note. Either copy this important note and modify or create it manually. If creating it manually, enter a space, type IMPORTANT:, highlight IMPORTANT:, make the text white bold and make the highlight inter-telblue.
Normalright is used for situations in tables where I wanted
a certain look; suggest keeping it instead of
overwriting the regular Normal tag by using the
right justify button
Step
Step
Step
tablehead is for the heading rows in tables; centered; Arial 10 pt Bold examples below
|
Field |
Description |
|
Company |
Type a company, job title, or department name for this contact. There is a 255 character limit for each field. |
|
Title |
|
|
Department |
|
|
Address Panel |
|
|
Street |
Type a street address using up to two fields, city, state/province, zip/postal code, and country for this contact. Each field has a 127 character limit. |
|
City |
|
|
State/Province |
|
|
Zip/Postal Code |
|
|
Country |
|
|
Phone Numbers Panel |
|
|
Work Phone |
Type a work phone, fax, or up to two custom numbers. There is an 80 character limit for each field. |
|
Work Fax |
|
|
Custom Number #1 |
|
|
Custom Number #2 |
|
|
Work E-mail |
Type a work e-mail address of up to 255 characters. |
|
Property and Description |
Property and Description |
|
This column shows dropdown examples. |
This column shows expanding text examples. |
Danger is used with Danger table It is never necessary to use this style unless you are creating the danger manually. This is the ANSI stardard color for Dangers. Do not change it.
Dangersymbol (Dangersymbol)s used to hold the warning graphic in the above table. It is never necessary to use this style unless creating the warning manually.
Warning is used with Warning table It is never necessary to use this style unless you are creating the warning manually.
warningsymbol (warningsymbol) is used to hold the warning graphic in the above table. It is never necessary to use this style unless creating the warning manually.
expandingtext
Glossary text Not sure what this one does but RoboHelp needs it. Do not delete it.
Default paragraph font Not sure what this one does but RoboHelp needs it. Do not delete it.
Conditional text Hidden: Use this condition tag for anything you do not want to see in the help output. Just because a topic does not appear in your TOC or is not used in your project it will appear in the final output search results because it is in your topics list. Condition tags are imported, but do not appear in the Project Settings area. So you will need to create a Hidden condition tag and make it blue. So for example, you imported all the files in this WebHelp template to a new project. The condition tag above is called Hidden and it's blue. RoboHelp will import it but you will not see it in the Project folder until you create it.
Conditional text Online: Reserved
Conditional text Print: Reserved
This is what will go at the bottom of every page. The feedback page has changed as well to explain to the user how to give us the .htm file name. If you do not need related topics, copy the other version below this one and use it instead. For new topics, delete the first column in the table if you do not need it. If you don't need related topics or you don't want to allow your users to print the page they are viewing, delete those table columns. Regardless of which of the following you use, leave the feedback column.
