Glossary terms are used for terms with definitions. When users click a glossary term in Habitat or a content reader, the term and its definition display in a pop-up.
Include the Glossary for a Project
To add a new glossary term, you must first include the glossary for your project. See Configure Inkdoc settings.
Insert a Glossary Term
- In Edit mode, highlight the text you would like to make a glossary term.
-
Hover over the Insert Link option in the inline toolbar.
A dropdown menu appears.
- Click Insert Glossary Term, or use the keyboard shortcut.
- To link to an existing glossary term, search for the term and click Link.
- To add a new glossary term, click Add New. Enter the term and glossary text, and then click Add New Glossary Term.
- You can use bold, italics, underline, superscript, and subscript to format your text.
- If you want to add a link, select the text and click the link icon to display the link editor, which functions in the same way as when adding a link on a page.
The images show how to add a glossary term. To preview your glossary term, click the linked text, and the Preview window appears.
Glossary terms can only consist of letters and numbers. The & character is not supported.
Edit, Unlink, or Delete a Glossary Term
- Click the linked text to bring up the Preview window and do one of the following:
- Click Unlink to remove the glossary term link from the text.
- Click Edit Term to change the glossary text, and Update Glossary Term to save your changes. The Glossary Term will change wherever it is referenced in the project.
- To delete a glossary term, click Edit Term and then click Delete.
- Click OK to confirm.
A glossary term may be referenced in other places in your project. If you delete a glossary term, you will need to unlink any additional references to the term. Use Review Errors to check for broken links after you next build or publish.
View Glossary Terms
You can also view all glossary terms for a project.
- Click Edit Content in the navigation bar.
- Click Additional Files, which is located under the Table of Contents sidebar.
- Click Glossary.
- Switch to Preview mode.
The page displays all the project's glossary terms.