suzanne.soy/scribble-mathjax
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update wording of processClass to correctly reflect its interaction with skipTags

Browse Source
This commit is contained in:
Davide P. Cervone 2011-07-27 16:10:01 -04:00
parent 3ccf3af4e7
commit 65e344e73f
4 changed files with 40 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/html/_sources/options/tex2jax.txt
View File

@ -125,14 +125,16 @@ preprocessor.
.. describe:: processClass: "tex2jax_process"
This is the class name used to mark elements whose contents
*should* be processed by `tex2jax`. This is used to turn on
processing within tags that have been marked as ignored or skipped
above. Note that this is a regular expression, and so you need to
be sure to quote any `regexp` special characters. The pattern is
inserted into one that requires your pattern to match a complete
word, so setting ``processClass: "class2"`` would cause it to
match an element with ``class="class1 class2 class3"``. Note that
you can assign several classes by separating them by the vertical
line character (``|``). For instance, with ``processClass:
"class1|class2"`` any element assigned a class of either
``class1`` or ``class2`` will have its contents processed.
*should* be processed by `tex2jax`. This is used to restart
processing within tags that have been marked as ignored via the
``ignoreClass`` or to cause a tag that appears in the ``skipTags``
list to be processed rather than skipped. Note that this is a
regular expression, and so you need to be sure to quote any
`regexp` special characters. The pattern is inserted into one
that requires your pattern to match a complete word, so setting
``processClass: "class2"`` would cause it to match an element with
``class="class1 class2 class3"``. Note that you can assign
several classes by separating them by the vertical line character
(``|``). For instance, with ``processClass: "class1|class2"`` any
element assigned a class of either ``class1`` or ``class2`` will
have its contents processed.

24
docs/html/options/tex2jax.html
View File

@ -177,17 +177,19 @@ will be skipped.</p>
<dt>
<tt class="descname">processClass: &quot;tex2jax_process&quot;</tt></dt>
<dd><p>This is the class name used to mark elements whose contents
<em>should</em> be processed by <cite>tex2jax</cite>. This is used to turn on
processing within tags that have been marked as ignored or skipped
above. Note that this is a regular expression, and so you need to
be sure to quote any <cite>regexp</cite> special characters. The pattern is
inserted into one that requires your pattern to match a complete
word, so setting <tt class="docutils literal"><span class="pre">processClass:</span> <span class="pre">&quot;class2&quot;</span></tt> would cause it to
match an element with <tt class="docutils literal"><span class="pre">class=&quot;class1</span> <span class="pre">class2</span> <span class="pre">class3&quot;</span></tt>. Note that
you can assign several classes by separating them by the vertical
line character (<tt class="docutils literal"><span class="pre">|</span></tt>). For instance, with <tt class="docutils literal"><span class="pre">processClass:</span>
<span class="pre">&quot;class1|class2&quot;</span></tt> any element assigned a class of either
<tt class="docutils literal"><span class="pre">class1</span></tt> or <tt class="docutils literal"><span class="pre">class2</span></tt> will have its contents processed.</p>
<em>should</em> be processed by <cite>tex2jax</cite>. This is used to restart
processing within tags that have been marked as ignored via the
<tt class="docutils literal"><span class="pre">ignoreClass</span></tt> or to cause a tag that appears in the <tt class="docutils literal"><span class="pre">skipTags</span></tt>
list to be processed rather than skipped. Note that this is a
regular expression, and so you need to be sure to quote any
<cite>regexp</cite> special characters. The pattern is inserted into one
that requires your pattern to match a complete word, so setting
<tt class="docutils literal"><span class="pre">processClass:</span> <span class="pre">&quot;class2&quot;</span></tt> would cause it to match an element with
<tt class="docutils literal"><span class="pre">class=&quot;class1</span> <span class="pre">class2</span> <span class="pre">class3&quot;</span></tt>. Note that you can assign
several classes by separating them by the vertical line character
(<tt class="docutils literal"><span class="pre">|</span></tt>). For instance, with <tt class="docutils literal"><span class="pre">processClass:</span> <span class="pre">&quot;class1|class2&quot;</span></tt> any
element assigned a class of either <tt class="docutils literal"><span class="pre">class1</span></tt> or <tt class="docutils literal"><span class="pre">class2</span></tt> will
have its contents processed.</p>
</dd></dl>
</div>

2
docs/html/searchindex.js
View File

File diff suppressed because one or more lines are too long

24
docs/source/options/tex2jax.rst
View File

@ -125,14 +125,16 @@ preprocessor.
.. describe:: processClass: "tex2jax_process"
This is the class name used to mark elements whose contents
*should* be processed by `tex2jax`. This is used to turn on
processing within tags that have been marked as ignored or skipped
above. Note that this is a regular expression, and so you need to
be sure to quote any `regexp` special characters. The pattern is
inserted into one that requires your pattern to match a complete
word, so setting ``processClass: "class2"`` would cause it to
match an element with ``class="class1 class2 class3"``. Note that
you can assign several classes by separating them by the vertical
line character (``|``). For instance, with ``processClass:
"class1|class2"`` any element assigned a class of either
``class1`` or ``class2`` will have its contents processed.
*should* be processed by `tex2jax`. This is used to restart
processing within tags that have been marked as ignored via the
``ignoreClass`` or to cause a tag that appears in the ``skipTags``
list to be processed rather than skipped. Note that this is a
regular expression, and so you need to be sure to quote any
`regexp` special characters. The pattern is inserted into one
that requires your pattern to match a complete word, so setting
``processClass: "class2"`` would cause it to match an element with
``class="class1 class2 class3"``. Note that you can assign
several classes by separating them by the vertical line character
(``|``). For instance, with ``processClass: "class1|class2"`` any
element assigned a class of either ``class1`` or ``class2`` will
have its contents processed.