Add an escape mechanism to Glossary module

[GoogleCodeExporter]

Drupal Issue # : 208217

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 approaches
* 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.</code>

* Another suggestion has been to use some code inside comment tags
("<!--xxx-->").

Deliverables

1. Before coding, a brief description of the mechanism chosen.
2. 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.
3. Changes or additions ready to be committed (other than minor editorial
corrections) to the Handbook pages.

Resources

* Project page: http://drupal.org/project/glossary
* Current issue: http://drupal.org/node/7261
* Handbook page: http://drupal.org/node/196880
* Demonstration site: http://nanwich.info
* hook_filter API documentation:
http://api.drupal.org/api/function/hook_filter/5
* Example filter module:
http://api.drupal.org/api/file/developer/examples/filter_example.module/5

Primary contact
Nancy Wichmann (http://drupal.org/user/101412, nan_wich@bellsouth.net)

Original issue reported on code.google.com by nanw...@gmail.com on 10 Jan 2008 at 6:10

[GoogleCodeExporter]

Original comment by acli...@gmail.com on 10 Jan 2008 at 6:12

• Changed state: Open
• Added labels: Code, DrupalIssue-208217
• Removed labels: Priority-Medium, Type-Defect

[GoogleCodeExporter]

I claim this task.

Original comment by mwroc...@gmail.com on 21 Jan 2008 at 9:03

[GoogleCodeExporter]

Ok mwrochna, it's yours.

Original comment by acli...@gmail.com on 22 Jan 2008 at 12:38

• Changed state: Claimed
• Added labels: ClaimedBy-mwrochna, DueDate-2008-01-28

[GoogleCodeExporter]

I just wanted to check in and see how this task is coming along.  Could you 
please
post the progress you've made so far to the issue for this task on drupal.org 
please,
so we can make sure you're on the right track.

Now that it's too late to claim another issue, we'll allow you to work on this 
task
until the final deadline of midnight PST on Feb. 4, 2008.  However, tasks must 
be
*reviewed* by this deadline as well, so it would be great if you could get your 
work
to us as soon as possible so we can start the review process.

Thanks

Original comment by acli...@gmail.com on 26 Jan 2008 at 3:52

[GoogleCodeExporter]

The issue (http://drupal.org/node/208217) is fixed, latest patch and 
documentation 
parts attached.

Original comment by mwroc...@gmail.com on 29 Jan 2008 at 6:56

Attachments:

• glossary_filter5.patch
• glossary_documentation1.txt

[GoogleCodeExporter]

Great!  NancyW has committed the code from this task, so you're done.  Thanks 
for
uploading the documents here.

Also, if you have not done so already, please read my post at
http://groups.drupal.org/node/8391 to learn about what you *must* do to claim 
your prize.

Original comment by acli...@gmail.com on 29 Jan 2008 at 7:53

• Changed state: Closed
• Added labels: AdminChecked