Skip to main content

Explain a term in the page text

As a page author you can make sure a definition is one click away, for every reader and without a browser extension. Use the Add term from Glossary macro to attach one term to a place in the text, or the Term Highlight Block macro to highlight every term in a piece of text.

Who can do this: anyone who can edit the page, see Permissions.

Steps​

Attach one term to a place in the text​

  1. Open the page in the Confluence editor and put the cursor where the term should be.
  2. Type /Glossary and choose the Add term from Glossary macro.
  3. Select the macro and click the edit button in its toolbar to open the settings.
  4. In Select term, choose the term.
  5. Optional: choose the Language, a Highlight color and a Font style: Bold or Italic.
  6. Close the settings and publish the page.

The settings are described in Intext Term Macro.

Highlight all terms in a piece of text​

  1. Open the page in the Confluence editor.
  2. Type /Highlight and choose the Term Highlight Block macro.
  3. Write or paste the text inside the block.
  4. Optional: open the settings of the macro and choose a Font style and a Highlight color.
  5. Publish the page.

The settings are described in Term Highlight Block.

Result​

  • Add term from Glossary shows the name of the term in the text, in the style you chose. A click on it opens a popup with the name and the definition.
  • Term Highlight Block shows your text with the terms highlighted. The button next to the block opens the list of the terms found in it, in alphabetical order.

Good to know​

  • The language is chosen for each macro. A macro set to German shows the German name of the term.
  • A macro without a term is a placeholder. Until you choose a term in the settings, the published page shows a placeholder and no term.
  • The block finds names and alternative forms. It uses the same rules as the rest of the app, see How terms are found in text.
  • A block without terms highlights nothing. The button that opens the list is inactive.
  • In-text terms are exported to Word. The document contains the name of the term in the language chosen in the macro.