gcode-mirror / google-highly-open-participation-drupal

Automatically exported from code.google.com/p/google-highly-open-participation-drupal
0 stars 0 forks source link

Add an escape mechanism to Glossary module #133

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Drupal Issue: http://drupal.org/node/208217

<h3>Task description</h3>
<p>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.</p>
<ol>
<li>occasionally, the user just wants to skip a section of content
entirely;</li>
<li>in some cases, we need to flag a phrase rather than single words ("coal
mining" rather than "coal" and "mining");</li>
<li>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.</li>
</ol>

<h3>Possible approaches</h3>
<p>It has been suggested that special case &lt;SPAN> tags could be used.
For example:</p>
<pre>
&lt;span class="glossary-skip">a section of content that should not be
scanned for terms&lt;/span>
&lt;span class="glossary-phrase">a phrase that should be used as a single
entity&lt;/span>
&lt;code>code that should be ignored when scanning.&lt;/code>
</pre>
<p>Another suggestion has been to use some code inside comment tags
("&lt;!--xxx-->").</p>

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

<h3>Resources</h3>
<ul>
<li><a href="http://drupal.org/project/glossary">Project page</a></li>
<li><a href="http://drupal.org/node/7261">Current issue</a></li>
<li><a href="http://drupal.org/node/196880">Handbook page</a></li>
<li><a href="http://nanwich.info">Demonstration site</a></li>
<li><a href="http://api.drupal.org/api/function/hook_filter/5">hook_filter
API documentation</a></li>
<li><a
href="http://api.drupal.org/api/file/developer/examples/filter_example.module/5"
>Example
filter module</a></li>
</ul>

<h3>Primary contact</h3>
<p><a href="http://drupal.org/user/101412">Nancy Wichmann</a>, <a
href="mailto:nan_wich@bellsouth.net">direct email</a>

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

GoogleCodeExporter commented 9 years ago
This didn't go like I expected it to. This is not a defect - I suspect I 
somehow got
directed to the wrong place.

Original comment by nanw...@gmail.com on 10 Jan 2008 at 1:21

GoogleCodeExporter commented 9 years ago
I'm setting this as withdrawn because of the HTML tags in the issue and we 
can't edit
those.  Please repost this but don't use HTML this time, since Google doesn't 
allow it.

Don't worry about the tags and status--we'll clean those up once you repost the
issue.  Don't forget to change the title of the associated drupal issue to 
match the
new GHOP task number.

Original comment by acli...@gmail.com on 10 Jan 2008 at 3:09