Overview: Creating an Article Glossary / Dictionary
The glossary feature is a great way to define terms, and have the meaning easily rendered to the end-user.
Written by Amanda Stançani
Updated at October 10th, 2024, by Ivanna Parra
Table of Contents
Article Glossary Video Walkthrough: What is an Article Glossary? How does a term get displayed? Example of a defined term / glossary Creating / Defining a Glossary Glossary Section Article EditorArticle Glossary Video Walkthrough:
The Glossary feature allows you to create a list of terms and phrases that will help users better understand the content. It's as easy as hovering over and we show you what the expression means!
What is an Article Glossary?
The Article Glossary is a simple way to define unique terms to your business or organization, and have the explanation/meaning be presented instantly to the user. You can think of it as a dictionary of terms.
After defining a term, all you need to do is use it, and Helpjuice will automatically insert the definition for it to be visible (on hover), when you save (or auto-save) an article.
If the Word/Expression is underlined, you can simply hover over and we will tell you what it means!
How does a term get displayed?
In the editor: You can simply click on the blue highlighted word, and you will see its definition pop-up.
In the knowledge base: Once viewing an article, you will see the term highlighted in a blue & dotted line under the word. Simply hover over it.
Example of a defined term / glossary
Helpjuice Article Glossary feature is fantastic. As you can see, hovering over the glossary term will display the meaning. Cool, isn't it ?!
Creating / Defining a Glossary
Creating your Glossary is super easy and you can do this in the Glossary Section AND directly in the Article Editor.
Glossary Section
To access this section:
- Access your Dashboard
- Click on the Glossary option
- Enter the Expression and its Definition
- Click Save
You will notice that each item added has an Edit icon (where you can edit Expressions and their Definitions) and a Delete icon. If you delete the Expression, you will lose definitions in all articles where this expression appears.
Article Editor
You can also add Expressions to the glossary directly from the Article Editor.
- Click New Article or edit an existing article
- Select the word you want to add to the Glossary
- Click Add to Glossary (Old Editor) or Insert Glossary (New Editor)
- Add the meaning of the highlighted Expression
- Click Save to Glossary or Cancel
Please note that:
- Any user can edit Expressions, but Created By will display the name of the user who created them, not the name of who updated the expressions. Additionally, Internal Users can click on the Edit icon directly on the front end and all users will be able to upvote/downvote the definition (according to the Access Level of the article).
- Definition By and Votes can be removed via Code Customization. Super Administrators and Administrators have full access to the Customize section, but if you need any help with the code, do not hesitate to submit a customization request and our team will take care of everything!
- It is also worth mentioning that all Expressions and Definitions will be shared across different languages.