1. Title

This title will be used to match terms within the page contents.

2. Term history

This option gives the ability to restore a previous definition version. 

3. Definition

Term definition is limited to 30000 characters.

4. Related vocabulary

Define alternatives and related vocabulary to the term. Smart Terms suggest five types of related vocabulary by default: 

  • Acronym
  • Synonym
  • Slang
  • Idiom
  • Plurals
  • Other

You can manage and add up to 10 related vocabularies from Smart Terms configuration.

The related vocabulary has an important feature; the term will be highlighted across pages' content if its title or one of its related vocabularies are detected.

For example, if the acronym API is defined for the term with the title Application Programming Interface, both texts will be highlighted on pages and the same definition will pop-up.

Related vocabulary has an informative purpose. It displays within the term viewer, terms glossary, and pages highlight pop-up. No automatic processing is performed to order or prioritize related vocabulary types.

If the acronym API is defined for Application Programming Interface and Air Pollution Index, both definitions will be displayed for API highlight.

5. Labels

Set Confluence labels for the term. You can choose a pre-existing label, or you can create a new one. Check this link  for more details about Confluence labels creation.

Labels are used to filter terms in the glossary or while searching in Confluence.

6. Media

This option allows adding media and dynamic content for the term.

Image

There are two ways to add Images to a term:

  • Attachment: Upload an image file. The accepted formats are: (png, jpg, jpeg, gif, bmp, webp, svg)
  • Link: Use an image link from the Internet or your Intranet

Note that the maximum allowed size of attachments is defined by the Confluence administrator.

Dimensions: Smart Terms uses a responsive image display mechanism. High-resolution images are preferred for better term quality. 

Secured Links: Non-HTTPS image links may not display.

You can add an image description.

Video & Audio

There are two ways to add a video or audio to a term. 

  • Attachment: Upload a media file. The accepted formats are: (mp4, mp3, WebM, m4v, ogv, ogg, wav)
  • Link: Using a link from the Internet or your Intranet, Smart Terms automatically converts links from:
    • YouTube
    • Vimeo
    • SoundCloud
    • Streamable
    • Vidyard
    • Wistia
    • Twitch
    • Facebook
    • DailyMotion

Note that the maximum allowed size of attachments is defined by the Confluence administrator.

Secured Links: links from non HTTPS domains may not display.

Options you can use to customize the video display:

  • Autoplay: Autoplay the video or audio automatically when viewing a term
  • Media description: displays a video/audio description

Embed code

Use Embed to display an HTML code in the term.

You can add a description for HTML codes.

Smart Terms applies strict safety rules for this type of media. Embedding javascript scripts directly into the code may not work. Make sure the HTML code is correctly displayed before saving the term.

PDF

There are two ways to add PDF files to a term: 

  • Attachment: Upload a PDF file
  • Link: use a link from the Internet or Intranet

Note that the maximum allowed size of attachments is defined by the Confluence administrator.

Secured Links: links for PDF files from non HTTPS domains may not display

You can add a description for the PDF file.

7. Term Languages

Add a new translation or select an existing one to edit it. Available languages are set by the Confluence admin from the global configuration.

All the above fields are translated except for labels.

8. AI definition [Cloud]

Generate term definitions with the help of OpenAI's ChatGPT. 

You can generate up to 500 definitions per month.

9. Highlight options

Enable highlight

This option is used to enable the highlight of the term. 

When this option is unchecked, the term will no longer be highlighted. However, it will still be displayed in the glossary.

Highlight globally

When this option is enabled, the term will be highlighted across all pages across Confluence.

This option is not available when:

  • The space glossary is global.
  • Enable single terms globalization option is disabled.
  • Enable single terms globalization is enabled but the space of the current term is not in the restriction list.

For further details, check the section Administration > App configuration > Highlight options

10. Related terms

Connect terms using pre-defined relations from Smart Terms global configuration. Related terms are made by selecting the relation's description and searching for an existing term.

You can delete a related term by hovering over it and clicking on the delete button.

11. Term information

This provides details about the current term creator and last modification date.