Smart Terms for Confluence: best practices guide
Guide for terms creators
The status of the attribute (R/O) can vary depending on your use case and needs.
Attribute |
| Required/Optional | Description |
|---|---|---|---|
Term | R | The term itself | |
Definition |
| R | The explanation of the term (without it, the term will not be highlighted) |
Related vocabulary | Acronyms | O/R | It's an abbreviation for the term (generally when it's composed of more than one word) |
Synonyms | O/R | A term that means the same as the initial term | |
Idioms | O | It's an expression that has a metaphorical meaning that's different from the phrase's literal meaning | |
Slangs | O | The informal word or expression for the term | |
Other | O | Any other linked terms or something you want to add for reference | |
Labels |
| O/R | Labels will help surface when searching for a term in the glossary and the Confluence advanced search. |
Medias |
| O | They are the images, videos, pdfs, and HTML embed that represent or give more meaning to the term. |
Guide for Smart Terms for Confluence admins
Highlight Options | Use case |
|---|---|
Disable highlight | You don't need the terms highlight in all spaces. |
Enable global glossaries | You need different glossaries to be highlighted in other spaces. |
Enable the option to make individual terms global | You need specific terms to be highlighted in all spaces. |
Disable glossary terms | You want to remove the highlight of a glossary or more. |
Disable highlight through browser extension | You need the highlight occasionally so you use the modal highlight or the highlighter macro. |
Guide for Smart Terms users (Cloud only)
Smart Terms highlighters | The usage | The icon |
|---|---|---|
Live highlight | It highlights the terms on the same Confluence page you’re viewing. To activate it, you need to upload the extension of the browser you’re using. |
 Live highlight icon
|
Modal highlighter | When clicked, it opens a modal page where you can find the highlighted terms. You see the modal highlight when the extension is disabled. |
|
Terms highlighter macro | It only highlights the terms existing within the macro. |
|
Issues/Improvements for Smart Terms
Ask your team to refer to this table when needed and fill it in with their requests.
Description | Type | Status |
|---|---|---|
How do I make terms global? | Question | RESOLVED |
Can’t delete labels from terms | Bug | EScalated |
Disable term highlighting in code blocks | Feature request | Shipped |