Common Desktop Environment: Help System Author's and Programmer's Guide


Glossary term: Writes a newly introduced term in a special font and establishes a hyperlink to its definition in the glossary.


<term baseform [gloss | nogloss]>text<\term>


<term baseform [gloss | nogloss]|text|





The form of the term as it appears in the glossary if it is not the same as used in the text. This difference can occur, for example, when the term is used in the text in its plural form but appears in the glossary in its singular form. If the term includes spaces or special characters, put the baseform string in quotes.


Default. Requests that HelpTag verify that the term is in the glossary.


Omits the term from the glossary; however, the term is formatted in a bold font.

The shorthand form uses two ++ (plus signs) before and after the glossary term.

Note -

If your help volume does not include a glossary, use the nogloss parameter.

When HelpTag processes the help volume, warning messages are issued to indicate glossary terms that were not marked with the nogloss parameter and do not have corresponding definitions in the glossary.

Tagging a term with the <term> element automatically creates a hyperlink to the glossary. If there is no glossary, the link will not work.

A <\term> end tag is required if the long form is used.


The following markup puts "structural elements" in a special font (boldface with a dotted underscore) to indicate it is a glossary term and creates a hyperlink to the glossary. Because the glossary entry contains a space, the text is in quotes. The plural form appears in the text. HelpTag checks for the singular form in the glossary and reports an error if it is not found.

SGML views a document as a hierarchy
of <term "structural element"|structural elements|.

See Also