Creating Glossaries

Glossaries enable you to define and implement a set of terms to use in your documentation. A glossary may be valuable when you have to create content that uses specific terminology. A glossary provides context to readers when met with unfamiliar terms.

Glossary Term

You use the term element to link to a glossary entry topic. If you hover over the term, a tooltip with the term definition appears.

Figure 1. Glossary Term.

The following example shows the glossary term publish in the HTML5 output.

An example of the glossary term topic rendered with DITA-OT

Glossary Entry Topic

If you click the term element that links to the glossary entry topic, you open the glossary entry topic.

Figure 2. Glossary Entry Topic
An example of the glossary entry element rendered with DITA-OT