Skip to main content

Help readers understand terms on a page

Once a glossary has terms, readers can get a definition on the page where the term is used. There are three ways: the list under the page title, the menu for selected text, and highlighting in the page text.

Who can do this: any reader uses the list and the selection menu. A space admin turns highlighting on. See Permissions.

Steps​

See all terms of a page​

  1. Open a Confluence page.
  2. Click Glossary under the page title.

The list shows every term found in the text of the page, with its definition. Nothing has to be installed for this.

Look up a word or phrase​

  1. Select text on the page.
  2. Choose Glossary in the menu that appears for the selection.

The panel shows the terms found in the selected text.

Turn on highlighting in the page text​

Highlighting marks the terms right in the text and shows the definition when the reader points at a term. It needs the browser extension.

  1. As a space admin, open the glossary settings of the space: click Settings on the Glossary page.
  2. On the Settings tab, turn on Enable Terms Highlighter extension and click Submit.
  3. Ask readers to install the Highlighter Extension.

Result​

On a page that contains terms, a banner with Terms detected appears at the top. Readers with the extension see the terms highlighted in the text. Readers without it see an invitation to install the extension in the same banner, and can still use the Glossary list under the page title.

Good to know​

  • A term is found only as a whole word. The term Cat is not found in Category.
  • Letter case does not matter for ordinary words. Postmortem is found in postmortem and in POSTMORTEM.
  • Abbreviations must match exactly. A word with two or more capital letters and no spaces is found only in the same letter case: SLA is not found in sla.
  • The list contains only the terms used on the page, not the whole glossary. A term is found by its name or by one of its alternative forms.
  • A long definition is collapsed. If a definition is longer than 250 characters, the list shows its beginning. Expand opens it, Hide collapses it again.
  • The banner closes by itself after 15 seconds. Dismiss closes it at once.
  • Highlighting can be turned on for all spaces at once. A Confluence admin turns on the same option in the Global settings.
  • With highlighting turned off, the rest still works. The banner is not shown and nothing is sent to the extension, but the Glossary list under the page title shows the terms as before.

All rules of detection are in How terms are found in text.