Glossary for Confluence: documentation and support

Getting started

1. Install Glossary for Confluence from the Atlassian Marketplace.
2. Open Apps > Glossary for the site glossary (Confluence admins can edit it) or Glossary in any space sidebar for that space's glossary.
3. Add terms one at a time, or import a CSV (see below).
4. Readers see a "N glossary terms" item next to the byline of every page that mentions your terms. Click it for the definitions.

Where definitions show up

• Page byline: "N glossary terms" lists every term the page mentions, how often, and its definition. No browser extension needed.
• Glossary index macro: insert "Glossary index" on a page for an A-Z list with letter navigation, label filter and search. Choose space and site terms, space only, or site only.
• Glossary term macro: insert "Glossary term" inline; readers click it to see the definition.
• Select text > Define in glossary: look up any phrase you highlight, or add it to the glossary if it is missing.

How matching works

• Whole words only, case-insensitive. Short all-caps acronyms (up to 6 characters, such as IT or API) are case-sensitive, so "it" never matches "IT".
• Synonyms count as the term. Simple plurals (term + s/es) count when "Match plurals" is on.
• The longest phrase wins: "API gateway" is counted once, not also as "API".
• Code blocks, macro settings and template placeholders are ignored.
• Draft terms are hidden from readers when "Hide drafts from readers" is on.
• A space term with the same name as a site term overrides it inside that space.

CSV format

Header row, then one term per line (RFC 4180; quote fields that contain commas):

term,definition,synonyms,labels,link,status
SLA,Service Level Agreement: the uptime we promise customers,Service Level Agreement,support,https://example.com/sla,approved

• synonyms and labels: separate several values with ; or |.
• Labels are lowercased and spaces become hyphens ("Customer Success" becomes customer-success).
• status is approved (default) or draft. link must start with https://.
• Merge adds new terms and updates matching ones; Replace clears that glossary first, then imports the file. Errors are reported per line and the other lines still import.
• Only term and definition are required. Leave out a column and merge keeps the stored value for it.

Permissions

• Everyone sees only matches from pages they are allowed to view.
• The site glossary is edited by Confluence admins. Space glossaries are editable by everyone unless an admin turns that off in Settings.
• "Used on N pages" counts are visible to Confluence admins only.
• If the licence lapses, the glossary stays readable and edits are blocked until it is renewed.

Privacy and security

The App runs on Atlassian Forge with no external servers ("Runs on Atlassian"). Page content is processed in memory and never stored. Full details are in the privacy policy.

Support

• Email: glossary-support@tewodros.me
• We reply within 2 business days; data loss or the App being unavailable is acknowledged within 1 business day.
• Security issues: glossary-security@tewodros.me. We follow Atlassian's Security Bug Fix Policy.

When you write, include your site URL (yoursite.atlassian.net), what you did, what you expected, and a screenshot if possible. Please do not send page contents we do not need.