Jump to content United States-English
HP.com Home Products and Services Support and Drivers Solutions How to Buy
» Contact HP
More options
HP.com home
Common Desktop Environment: Help System Author's and Programmer's Guide > Chapter 3 Writing a Help Topic

Creating a Glossary

» 

Technical documentation

» Feedback
Content starts here

 » Table of Contents

 » Glossary

 » Index

Like a glossary in a book, your help volume can contain a glossary that defines important terms. The glossary, which is marked using the Glossary element, is the last topic in your help volume. The glossary contains the definitions for all the terms that are marked with the <GlossTerm> tag.

Glossary contains the following components in the following order:

  • Title (optional)

  • TitleAbbrev (optional)

  • one or more GlossEntries

To Mark a Glossary Term

The GlossTerm tag is used to mark a term in the document text that is glossed in the Glossary. Note that the GlossTerm element is also used to contain those terms as they occur in GlossEntries in the Glossary.

Each key word or phrase that you enter with the GlossTerm element automatically becomes a link to the term's definition in the Glossary.

To Define a Term in the Glossary

Terms are defined in the Glossay by using the GlossEntry element. A GlossEntry contains, in order, a required GlossTerm, an optional Acronym, and an optional Abbrev, followed by any number of GlossSees and GlossDefs, in any order.

GlossDef is the definition of a GlossTerm in a GlossEntry. It may contain, in any order, Comments, GlossSeeAlsos, paragraphs, and other block-oriented elements.

GlossDef has the Common attributes and also the Subject attribute. The Subject attribute may hold a list of subject areas as keywords, separated only by spaces.

Syntax

<Glossary>
...
<GlossEntry>
<GlossTerm>
term
</GlossTerm>
<GlossDef>
text of definition
</GlossDef>
</GlossEntry>
...
</Glossary>
Printable version
Privacy statement Using this site means you accept its terms Feedback to webmaster
© Hewlett-Packard Development Company, L.P.