To use the glossary, you'll need to create glossary terms and give each term a definition. You can also include an optional display title.
- Term: The word you expect someone to read in your documentation.
- Display title: An optional field you can display instead of the term in the glossary page and in glossary term search results. The display title lets you include an acronym or punctuation alongside the term.
- Definition: The definition you'd like displayed for that term.
For example, let's say we have this entry in our Glossary page:
| Term | Display title | Definition |
|---|---|---|
| IdP | Identity Provider (IdP) | Identity Provider (IdP), sometimes called an Identity Service Provider or Identity Assertion Provider, is an online service or website that authenticates users on the Internet by means of security tokens. In this case, via SAML 2.0. |
IdP is what our automatic highlighting would match on.
Identity Provider (IdP) is what would display in the Glossary page and in search results.
And the definition in all places would be displayed as: Identity Provider (IdP), sometimes called an Identity Service Provider or Identity Assertion Provider, is an online service or website that authenticates users on the Internet by means of security tokens. In this case, via SAML 2.0.
Terms
Glossary terms may contain:
- Letters (abcABC)
- Numbers (0123)
- Spaces ( )
- Dashes (- and --)
- Underscores ( _ )
- Apostrophes ( ' )
Other characters (like parentheses, periods or commas, and quotation marks) will be removed.
Display titles
Use display titles to display a different title for the term on:
- The built-in glossary page
- Glossary term search results, if used
These titles are automatically formatted in bold. They can include special characters that are prohibited in glossary terms. Refer to When should I use display titles? for more information.
When you enter a display title, that title is what we use to create the glossary page alphabetical listings.
No automatic highlighting for display titles
Display titles are used for the glossary page and glossary term search results display only and have no impact on automatic highlighting.
Definitions
Use our streamlined glossary definition WYSIWYG editor to include bold, italics, underline, hyperlinks, superscript, and subscript text in your definitions.
Add new paragraphs or line breaks (Shift + Enter) just as you would in the article editor.
What about images?
Glossary definitions cannot contain images, since they don't format well in the on-hover definitions. We recommend inserting a link to the image in the definition or a link to an article containing the image instead.
