Glossworthy

Getting started

Glossworthy is not on the Atlassian Marketplace yet. These steps apply once it is listed.

1. In Confluence, open Apps → Explore more apps, search for Glossworthy and install it. You need to be a Confluence admin to install apps.
2. Open Apps → Glossworthy and add your first terms, or import them from a CSV file.
3. Edit any page, type / and insert Glossworthy index or Glossworthy: terms on this page.

There is one glossary for the whole site, and every space sees the same terms. Any licensed Confluence user can add, edit, delete and import terms.

Adding and editing terms

Open Apps → Glossworthy and choose Add term. Each term has these fields:

Use Edit or Delete next to any term. Renaming a term to the name of another existing term is refused, so one term never silently overwrites another.

Importing and exporting CSV

Choose Import CSV, paste the file's contents and press Check. Nothing is saved yet: you see how many terms would be added or updated, how many are unchanged, and every row with a problem. Press Import when you're happy.

term,definition,acronym,synonyms
Service Level Agreement,"The service levels we promise customers, in writing.",SLA,service agreement; uptime promise
Application Programming Interface,How programs talk to each other.,API,

• The header row can list the columns in any order. Without a header, columns are read as term, definition, acronym, synonyms.
• Quoted fields can contain commas, quotes (written as "") and line breaks. UTF-8 files with a byte-order mark and Windows line endings work.
• Valid rows are imported even when other rows fail. Each failure is reported with its row number and reason, so you can fix just those rows and import again.
• Re-importing the same file changes nothing. If a term appears twice in one file, the later row wins.
• Up to 5,000 rows and 2 MB per import. Split larger files.

Export CSV produces a file in the same format. Importing it into another site recreates the same glossary.

Macros

How terms are found on a page:

• Whole words only: API is found in "the API" but not in "RAPID".
• Terms and synonyms match regardless of capitals, and a hyphen counts as a space: "service-level agreement" finds Service Level Agreement.
• Acronyms match only with the same capitals, so the acronym IT is not found in the word "it".
• Text inside macro settings is ignored. The page must be saved or published before its terms can be listed.

Looking up selected text

Select a word or phrase on any page and choose Look up in Glossworthy from the menu that appears. It matches a term, an acronym or a synonym, ignoring surrounding punctuation.

If the text isn't in the glossary, you can add it there and then: write a definition, optionally an acronym, and choose Add to glossary.

Data and privacy

• Glossworthy has no servers of its own and sends nothing outside Atlassian. It is built to qualify for Atlassian's Runs on Atlassian programme.
• It does not record who edited a term, and it has no analytics or tracking.
• We, the vendor, cannot see your glossary.
• Permissions it asks for: app storage, and read access to pages and blog posts (for the terms-on-this-page macro).
• Export your glossary to CSV before uninstalling if you want to keep it.

Troubleshooting

Changelog