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.
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 itself, we like to display the full title alongside the acronym. This is what the display title is for: it's basically the version of the term you'd like to appear on the glossary page.
If no display title is specified, then the term itself is used. If a display title is present, that's what's used.
So here's what the term's setup looks like in Knowledge Base > Glossary:
And here's how it displays in our glossary:
Note that the display title is what's used on the glossary page, but IdP is still used in the autohighlighting of glossary terms.
Display titles can be great for:
- Displaying the full term with an acronym in parentheses (e.g. term = We Love Owls and display title = We Love Owls (WLO))
- Displaying 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, this could be the full department name or the person's name + title (e.g. term = HR Dept and display title = Human Resources Department)
