- 23 Sep 2022
- 2 Minutes à lire
Glossary - Getting started
- Mis à jour le 23 Sep 2022
- 2 Minutes à lire
Enhance your Knowledge base by adding the glossary to help readers understand the frequently used terms(word/phrase/acronym/abbreviation).
The dotted line identifies glossary terms in your articles and category pages. Readers can hover over the glossary term and view the definition on the Knowledge base site. Reuse the glossary terms in your articles and category pages when required.
For example, you want to add a glossary term for the acronym GDPR. Add the term name as GDPR and definition as General Data Protection Regulation.
Glossary terms would be available in both the Knowledge base and Knowledge base assistant.
Glossary - Article links
Navigation links for glossary
- How to add the glossary overview page link in the header?
- How to add the glossary overview page link in the footer?
- How to add the glossary overview page link in the menu?
- How to add the glossary overview page link on the Home page?
Go to Content tools → Content reuse → Glossary, and the list of existing glossary terms appear (if added)
- Languages - You can filter the glossary terms for a specific language. Click on the languages dropdown to choose a language from the available list
- New term - To add new terms
- Import glossary - To import glossary terms in bulk
- Delete - To delete glossary terms
- Filter - To filter the glossary terms. You can use the Search, Updated by, and Last updated on to narrow down the search results
- Term - Glossary term name appears here. Hover over the Preview button to view the preview of the definition
- Dependencies - If the term is associated with any article/category page, the View option appears.
- Click the View option, and the Articles/Categories used blade appears with the list of articles/categories the term is associated
- Click on the article/category name to view the name, article version, contributor profile image, contributor name, language, version, article status, and last updated date of the article/category
- Last updated on - Last updated time/date information of the term
- Last updated by - Name and profile image of the team account updated the term recently
Why does the knowledge base need a glossary?
- You would often use abbreviations, acronyms, or common terms in your knowledge base. When you add these terms in multiple articles, you must provide a definition in the first instance. However, this is a tedious action for a technical writer.
- To avoid such action, you can associate the respective terms in the desired articles/category pages as a glossary term. So when a reader hovers over the term with the mouse pointer, the definition of the term appears.
- You can also add your product-specific terms as glossary terms to educate the readers and help them understand better