A. Installation and Settings

1. Copy this whole folder to sites/default/modules (or replace "default" with the appropriate name) directory, as usual. Drupal should automatically detect the module. Enable the module on the module administration page.
2. Glossary terms are managed as vocabularies within the taxonomy module. To get started with Glossary, create a new vocabulary on the taxonomy administration page. The vocabulary need not be associated with any modules, though you can attach detailed description to terms by adding nodes to the terms, so it might be a good idea to associate the vocabulary with the "story" module. Add a few terms to the vocabulary. The term title should be the glossary entry, the description should be the explanation of that term. You can make use of the hierarchy, synonym, and related terms features. These features impact the display of the glossary when viewed in an overview.
3. Prior to release 1.5 for D5 (and later versions), Glossary used the input format hook to display its settings (for 4.7 and earlier D5 releases, see How to Install Glossary). There is now a separate settings page at "Administer » Site configuration » Glossary." The general settings are on the "General" tab.
4. The settings for each input format are under the tabs that are labeled with the name of the input format. Remember that if you later add a new input format, you will have to revisit this page to set it up. Also remember, as with all tabbed settings forms, you need to click the "Save configuration" button on each page.
5. If you would like to use the glossary icon, a default one is included with this module.
6. If you want a search box on your glossary page, enable the block on admin/block page.

Menu

The module provides a "suggested" menu item for "http://www.example.com/glossary" which takes the user to either the glossary overview page, if there is only one vocabulary in use, or a list of all the glossary vocabularies for them to select an overview.

Conversion note: It is not uncommon for site to already have a "glossary" URL for something like a hard-coded HTML glossary. If such a menu entry already exists, you may not see this module's menu items. Delete existing menu items for "glossary" before enabling this module.

You may add a "shortcut" menu item that takes the user directly to a specific glossary vocabulary. The path for this would be "glossary/xxx" where xxx is the vocabulary id for that particular vocabulary. This can be useful if you set up a glossary vocabulary that is not selected for an indicator, but for which you want the same type of display. For example, you may want something like a "Dictionary of Common Abbreviations" for your users, but don't want these terms flagged.

To further shorten the load time, if you are using the "page per letter" option, you may also specify the first letter the user is to see by coding: "glossary/xxx/lettery" where "y" is the single letter to be shown (note: "letter" must be exactly that string).

Settings

General

• Allow the user to disable glossary links - If selected, the user will have a checkbox added to their "My Account" page to allow them to disable Glossary indicator displays.
• Hide unused input format tabs - Determines whether or not to hide settings tabs for input formats that are not glossary-enabled. If you have additional input formats, the tabs can get a cluttered look; this helps un-clutter the page.
• Show glossary across many smaller pages - this breaks long glossaries up by the first letter of the term. If it is not selected, all of the terms will be shown on a single page. If this is selected, when you first go into the glossary listing, you will see all terms. If you then click on a letter, you will see only the terms that start with that letter (page-per-letter).
• Show glossary terms even if there is no description - by default, Glossary omits terms from the list if there is no term description. This setting overrides that. This is useful on free-tagging vocabularies that rarely get descriptions.
• Show glossary term descriptions on the Glossary page - term descriptions may be large and/or include pictures, therefore the Glossary page can take a long time to load if you include the full descriptions.
• Clicking on a term link will - when a user clicks on a term link in the content, you may choose to 1) show only the single term, or 2) show the whole glossary but advanced to the term (uses named anchors).

Alphabet

This is where you control the content of the "alphabar" at the top of the Glossary overview. This section is mostly for people who use a language other than English, but you may still want to visit this page.

• Enter all the letters of your alphabet, in the correct order - This will be prefilled with English letters. If you use a different language, enter your complete alphabet in it's correct collating order. NOTE: You may also need to alter the collation setting on your term_data table in the database.
• Enter all the digits of your alphabet, in the correct order - This is prefilled with 0 - 9 Arabic numerals; if you use different ones, enter them here. If you do not want to use digits to begin your glossary terms, you can delete the contents of this field.
• Suppress unused letters - This will cause unused letters to be omitted from the alphabar. I would not generally recommend this, but some adopters have asked for it.
• Alphabar separator - This is the character that will separate the letters in the alphabar. There are several choices.

Clear Cache

There are times when the module simply is not able to, programmatically, determine that the cache needs to be cleared (in part or in whole). This page provides a button to manually clear it. It may also be useful when testing changes to the module or settings.

For Each Input Format

Note that changing any of the following values will clear the cache_filter.

• Select Vocabulary - select the vocabulary(-ies ) to associate with the glossary.
• Make Glossary links absolute - RSS feeds need absolute links to ensure they point back to this site. If you are not providing RSS feeds, it is better to leave this turned off.
• Match type - how to match the term
• word - the whole word must match the term
• right or left substring - requires a word break on either the left or right.
• left substring - requires a word break on the left.
• right substring - requires a word break on the right.
• any substring - match any substring
• Case sensitivity - whether or not the term match should be case sensitive or not.
• Replace matches - indicates whether you want all of a particular term flagged or just the first occurrence on the page.
• Blocked elements - content of html elements (tags) listed here won't be filtered for matches. Type the tags with a space between them and omitting the brackets (< and >). Glossary links will never be included inside <a>, <code>, <pre>, and [no-glossary] [/no-glossary] elements (so you need not include these).

Link Style

• Term Indicator - select which type of glossary term indicator you prefer: Superscript, Icon, Abbr, Acronym, or Cite. Note: If the Hovertips and Clicktips module is installed, you will also have the option: Hovertip.
• Superscript - this sets the value to be used for the superscript indicator, if it is being used.
• Glossary Icon URL - this specifies the path for the icon, if it is being used. This is relative to the base path of your site, so it should not begin with a slash ("/").

Permissions

The Glossary module does not use separate administration permissions. The users would need to have 'administer filters' permission to administer the module and 'administer taxonomy' to change the terms themselves.