Each glossary entry consists of a term (the text to be matched for markup), a link to an attachment that provides its definition, a tooltip (optional), and markup conditions (Match Whole Word and/or Match Case). Glossary terms can include both spaces and special characters, and there is no limit to the length of a term. However, each term must include at least one non-space character and cannot begin or end with one or more spaces. In addition, glossary terms must be unique, on a case-insensitive basis, within a glossary document. Therefore, for example, one glossary cannot include both the terms "document" and "Document". You must enter a valid term before you can set any of the properties of the glossary entry (Definition Link, Tooltip, markup conditions).

You can use any type of attachment (package file, web page, or URL) as a definition link. In the Developer and in published Player outputs, glossary terms appearing in bubble text in topic frames or web page text are linked to their definition attachments. Users can click glossary links to display the attachments containing the definitions of the glossary terms. Glossaries are also included in the Training Guide and Instructor Manual as a list of terms and definitions at the end of the document. If you publish content containing more than one glossary to one of these document outputs, the glossaries are merged and presented as one alphabetical list. If a term appears in more than one of the merged glossaries, it is listed multiple times, once for each glossary in which it appears. However, only those terms with definition link attachments that typically appear in document outputs are included in the glossary. Specifically, the types of definition links included in the glossary sections of document outputs are package files (graphics only), web pages, and URLs (addresses only). Therefore, if a definition link is a non-graphic package file, such as an Excel spreadsheet, the corresponding term is not included in the document glossary.

You also have the option to enter text for a tooltip that identifies the link contents. These tooltips appear in the Player when a user rests the mouse pointer over the link text. For example, because these links apply to glossary terms, you might use the tooltip "definition". However, the length of the tooltip is not limited, and you can use a different tooltip for each term, if desired.

Tip: Although there is no limit to the length of a tooltip, concise, descriptive tooltips are most useful.

In addition, you can specify that the glossary term must match the whole word only, preventing words containing the glossary term from being marked as glossary links. For example, if the Match Whole Word option is selected for the glossary term “test”, the word “testing” is not marked as a glossary link. You also have the option to require glossary terms to match the specified case, so that words that are not typed in uppercase and lowercase letters exactly as the term in the glossary document are not marked as glossary links.

After adding glossary terms, you should update glossary links to apply your changes.

To add a glossary term to a glossary document:

1. In the empty Glossary Term cell in the bottom row of the table, type the term.
    
2. In the Definition Link cell in the same row, select an attachment for the definition link.
    
3. In the Tooltip cell in the same row, type a tooltip, if desired.
    
4. Set the markup conditions.
    
   By default, Match Whole Word is selected, and Match Case is not selected. Change a setting by checking or clearing the appropriate option.
    
5. Continue adding terms or save and close the glossary document.
    
   When you close a glossary that is assigned to one or more documents after making changes to it, you are prompted to update the glossary links. Select Save the glossary and update the links and click OK to close the glossary and update links. Otherwise, you can select Save the glossary and click OK to close the glossary without updating links. Click Cancel to close the glossary document without saving changes.

Tip: To navigate in the glossary, you can click in the desired cell or press TAB to move one cell to the right or SHIFT+TAB to move one cell to the left.

Table of Contents  Back