Glossary term
Writes a newly introduced term in a special font and
establishes a hyperlink to its definition in the glossary.
Syntax.
Syntax [
<term baseform [gloss | nogloss]>text<\term>
]
Or:
[
<term baseform [gloss | nogloss] |text|
]
Or:
Where:
- baseform
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.
- gloss
(Default.) Requests that HelpTag verify that the term is
in the glossary.
- nogloss
Allows the term to be missing from the glossary.
The shorthand form for <term> is double plus signs
(++) used before and after the 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 both do not appear in the glossary and
do not use the nogloss parameter.
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.
Example.
The following markup puts "structural elements" in a special font to
indicate it is a glossary term and creates a hyperlink to the glossary.
Because the nogloss parameter is not used, HelpTag ensures that the
singular form ("structural element") appears in the glossary.
SGML views a document as a hierarchy of
<term "structural element"|structural elements|.
|
See Also.
Printable version
