Skip to main content

Glossary Title

Abstract

Learn how to add a glossary title element and set it to be auto-generated or manually generated. You can also control if a glossary title is bookmarked for PDF and whether it appears in HTML outputs.

When you create a glossary, you add a glossary element, and by default, this includes a title element inside it. You can use the glossary title to name the glossary. But depending on how you have set up your glossary, you may decide that you do not want a title at all.

One of the most common ways to set up a glossary is to create a topic called "Glossary" and then add a glossary element to it. In this scenario, the topic's title is glossary, so there is no real need for a glossary title as well. That's not a problem - you can delete the glossary title and the glossary will still work as expected. In the following image, "Glossary" is the topic's title and then the actual glossary has no title of its own.

A topic with Glossary as its title. It contains a glossary element and inside that there are some glossary definitions.

But it is also possible to add a glossary to a topic that is not called "Glossary". For example, you could add a glossary to a topic called "Reference". In this scenario, it can be a good idea to include a glossary title as well. The title will make it easier for your readers to find your glossary, seeing as there is no "Glossary" topic. In the following image, a glossary has been added to a "Reference" topic, and the glossary has a title called "Glossary".

A topic called "Reference" and it contains a glossary. The glossary has its own title, which is labelled "Glossary".

If you are going to use a glossary title, you should consider: