Task description

The heart of the Glossary module is a Drupal filter (see 'Resources' below). There are three cases in which the current glossary filter doesn't work as desired. Adding a mechanism to address this will make this module much more useful.

  1. occasionally, the user just wants to skip a section of content entirely;
  2. in some cases, we need to flag a phrase rather than single words ("coal mining" rather than "coal" and "mining");
  3. within certain already identified sections, such as a block of code, we need to not flag the terms as this can lead to erroneous copy-and-pasting.

Possible approach

It has been suggested that special case <SPAN> tags could be used. For example:

<span class="glossary-skip">a section of content that should not be scanned for terms</span>
<span class="glossary-phrase">a phrase that should be used as a single entity</span>
<code>code that should be ignored when scanning.

Deliverables

  1. A patch ready to be committed, created against the current "-dev" version that provides the desired functionality. This may include (but is not anticipated) changes to the README.txt distribution, if appropriate.
  2. Changes or additions ready to be committed (other than minor editorial corrections) to the Handbook pages.

Resources

Primary contact

Nancy Wichmann, direct email

Comments

aclight’s picture

Status: Active » Reviewed & tested by the community

This description looks pretty good to me. I'm not so sure about using span tags to designate these special cases, but I guess that's up to you to decide.

nancydru’s picture

It doesn't have to be spans. I had also thought of something inside comment tags.