What would you like to know more about?

Naming Glossary Entries

When possible, start all filenames for your glossary entry topics with "g_".

  • The rest of the filename should reflect the content of the <glossterm> element in the glossary entry topic. This helps you find all your glossary entries within your filesystem.

  • Use the underscore ("_") character to separate words, rather than a space (spaces in DITA filenames can cause problems).

  • The id attribute for the glossary entry topic should be the same as the filename (minus the .dita extension). You may opt to omit the "gl_" from the id attribute as well, so long as the id attribute value matches the same term used in the filename. So, if a topic is named "gl_mallard.dita", the id of the glossary entry topic should be "g_mallard" or "mallard".

  • Although this topic does not address the concept of keys in DITA, we also advise using the value of the id attribute as the key name.