Creating Glossaries
Glossaries enable you to define and easily implement a set of terms to use in your documentation.
Glossary Term
You use the term element to link to the glossary entry topic. If you hover over the term, a tooltip with the term definition appears.
The following example shows the glossary term “publish” in the HTML5 output.
Glossary Entry Topic
If you click the term element that links to the glossary entry topic, you open the glossary entry topic.
Create a Glossary
Using glossary terms in your topics requires initial configuration.
Create Glossary Entry Topics
Use the glossary entry topic to define individual glossary terms and their definitions.
Create a Glossary Map
Create a map that contains a collection of glossary terms.
Add a Glossary Map to the Shared Map
Add your glossary map to a shared warehouse map for easy reuse.
- In the content library, hover over the shared map and click the Dock button.
- In the content library right-click the shared map and select Dock.
- In the content library, navigate to the glossary map you want to add to the shared map.
- Drag and drop the glossary map into the Map Editor and click Insert if needed.
Add the Shared Map to a Deliverable Map
Ensure that the shared map is added to a deliverable map.
- In the content library, hover over the deliverable map and click the Dock button.
- In the content library, right-click the deliverable map and select Dock.
- In the content library, navigate to the shared map you want to add to the deliverable map.
- Drag and drop the shared map into the deliverable map and click Insert if needed.
- Hover-over the shared map and click the wrench icon.
- From the processing-role drop-down menu, select resource-only.
Insert a Glossary Term to a Topic
You add a glossary term to a topic by key-referencing glossary entry topics.
- In the content library, hover over a topic and click Open.
- In the content library, double-click a topic.
- Place your cursor where you want to insert a glossary term.
- Press (Mac) or (Windows).
- In the dialog, do the following: