Skip to Content

Create and Maintain a Site Glossary

The Glossary module allows administrators with permission to edit the site's taxonomy to create a sitewide glossary. Administrators can optionally make glossary terms automatically link to their descriptions by using input filters.

To Start a Glossary

  1. Make sure the Glossary module is enabled. Click administer » modules, and check the box next to glossary.
  2. Add a new vocabulary. Click administer » categories » add vocabulary tab.
  3. Create some terms for your vocabulary. The term titles will be the words to be defined, and the descriptions will be each word's definition.
  4. (optional) To enable automatic linking of glossary terms, enable the Glossary filter for each input format you use on the site.

Automatically Linking Words to the Glossary Definition

  1. Click administer » input formats.
  2. Click the "configure" link in the row of the input format you want to enable glossary for.
  3. Check the box next to Glossary filter.
  4. Click the "Save configuration" button.
  5. Click the configure tab for the input format.
  6. Look for the Glossary filters box.
  7. Select the vocabulary or vocabularies—to select more than one, hold down the CTRL key for the PC, Cmd/Apple key for Macs—you wish to associate with the glossary. This will be the same vocabulary as you created when you started a glossary. (See instructions for starting a glossary above.)
  8. Select the Match type..
    • word matches only the term title with the whole word in the text.
    • right or left substring matches the term title with either the beginning or the end of a word in text.
    • right substring matches tht term title with only the end of the word in the text.
    • left substring matches the terme title with only the beginning of the word in the tetxt.
    • any substring matches the term title with the word appearing anywhere in the text.
  9. Select the case sensitivity of the matches.
  10. Select whether you want to have all matches replaced, or just the first match.
  11. Select how glossary terms will be indicated.
    • supserscript will place superscript linked text next to the glossary term.
    • icon will place a linked icon next to the glossary term.
    • acronym will wrap the term in an <acronym> tag and give the title attribute the appropriate description.
  12. If you chose superscript above, you can select what text will appear as superscript next to the glossary term. For example, if you choose "i" (without quotes), and the glossary term is module, the text will look something like the following: modulei with an appropriate link.
  13. If you chose icon, there is a space for you to choose the icon graphic. One is supplied with the module.
  14. Click the "Save configuration" button.
  15. Repeat for the other input formats as necessary.

Based on the settings you've chosen and the configuration of the filter, glossary terms will automatically be linked to their definitions when each individual item is published. In other words, there is no need to add any special code to the terms when writing.