Getting Started

Table of Contents

Creating a Glossary and Index

You can easily create a glossary and/or index for your publication.

Create a glossary
  1. In a separate topic, add a glossary element.

  2. Add your entries with the element glossentry, each with a term (glossterm) and a definition (glossdef).

  3. In your actual content (in the topics of your publication), add references to the glossary by simple glossterm elements in line in the text.

    When you publish your publication, the glossterms will be recognized and automatically linked to the glossary.


    If you should happen to use glossterm text that is not identical to the glossterm in the glossary itself, you can add the identical text as a baseform attribute. For example if you have the term "Configure" in your glossary, but in your topic you need to refer to it in text as "configuring", you can add the attribute baseform with the exact value "Configure".

Create an index
  1. Create an index by having a separate topic with no other content than the title.

  2. Then just add an empty index element.

  3. Now in your topics, where ever you want to, create index references using the element indexterm in line in your text content. Each needs to have at least one child element, such as primary.

    The index will now be automatically created, alphabetically sorted, categorized by letter, and linked to from the text.