All glossary term highlighting is driven by the glossary term itself. This term cannot contain parentheses, quotation marks, and other special characters.
This works well for highlighting, but it's not uncommon to want to display a more complete version of the term in the Glossary page itself or in the glossary term search results.
This is what the display title is for: it's the version of the term you'd like to appear on the glossary page and in glossary search results.
If you don't enter a display title, then the term itself is used. If you enter a display title, that's what's used.
For example: in our glossary, we have a glossary term for IdP. This is the term that we use everywhere in our documentation, so we keep that as the term itself so our highlighting works properly. But for our glossary page, we like to display the full title alongside the acronym, so we use a display title for that.
Here's what the term's setup looks like in Glossary:
| Glossary 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. |
And here's how it displays in our glossary:
I
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.
Note that while the display title is used on the glossary page, the glossary term (IdP, in our example) is still used in the autohighlighting of glossary terms.
Display title use cases
Display titles can be great for these situations:
- Display the full term with an acronym in parentheses (e.g. term = We Love Owls and display title = We Love Owls (WLO)).
- Display a term with a list of additional terms (e.g. term = Identity Provider and display title = Identity Provider (a.k.a. Identity Service Provider; Identity Assertion Provider)).
- If you use the glossary to provide contact details on departments or individuals, display the full department name or the person's name + title (e.g. term = HR Dept and display title = Human Resources Department).
