Update documentation to reflect new situation for element(s) parameters

docs/html/_sources/api/hub.txt

@@ -187,24 +187,26 @@ Methods
 
 .. Method:: Typeset([element[,callback]])
 
-    Calls the preprocessors on the given element, and then typesets
+    Calls the preprocessors on the given element (or elements if it is an
-    any math elements within the element.  If no `element` is
+    array of elements), and then typesets any math elements within the
-    provided, the whole document is processed.  The `element` is
+    element.  If no `element` is provided, the whole document is processed.
-    either the DOM `id` of the element, or a reference to the DOM
+    The `element` is either the DOM `id` of the element, a reference to
-    element itself.  The `callback` is called when the process is
+    the DOM element itself, or an array of id's or refereneces.  The
-    complete.  See the :ref:`Modifying Math <typeset-math>` section
+    `callback` is called when the process is complete.  See the
-    for details of how to use this method properly.
+    :ref:`Modifying Math <typeset-math>` section for details of how to use
+    this method properly.
 
     :Parameters:
-        - **element** --- the element whose math is to be typeset
+        - **element** --- the element(s) whose math is to be typeset
         - **callback** --- the callback specification
     :Returns: the callback object
 
 .. method:: PreProcess([element[,callback]])
 
-    Calls the loaded preprocessors on the entire document, or on the
+    Calls the loaded preprocessors on the entire document, or on the given
-    given DOM element.  The `element` is either the DOM `id` of the
+    DOM element (or elements, if it is an array of elements).  The
-    element, or a reference to the DOM element itself.  The `callback`
+    `element` is either the DOM `id` of the element, a reference to the
+    DOM element itself, or an array of id's or references.  The `callback`
     is called when the processing is complete.
         
     :Parameters:
@@ -214,43 +216,44 @@ Methods
 
 .. method:: Process([element[,callback]])
 
-    Scans either the entire document or a given DOM `element` for
+    Scans either the entire document or a given DOM `element` (or array of
-    MathJax ``<script>`` tags and processes the math those tags
+    elements) for MathJax ``<script>`` tags and processes the math those
-    contain.  The `element` is either the DOM `id` of the element to
+    tags contain.  The `element` is either the DOM `id` of the element to
-    scan, or a reference to the DOM element itself.  The `callback` is
+    scan, a reference to the DOM element itself, or an array of id's or
-    called when the processing is complete.
+    references.  The `callback` is called when the processing is complete.
         
     :Parameters:
-        - **element** --- the element to be processed
+        - **element** --- the element(s) to be processed
         - **callback** --- the callback specification
     :Returns: the callback object
 
 .. method:: Update([element[,callback]])
 
-    Scans either the entire document or a given DOM element for
+    Scans either the entire document or a given DOM element (or elements if
-    mathematics that has changed since the last time it was processed,
+    it is an array of elements) for mathematics that has changed since the
-    or is new, and typesets the mathematics they contain.  The
+    last time it was processed, or is new, and typesets the mathematics
-    `element` is either the DOM `id` of the element to scan, or a
+    they contain.  The `element` is either the DOM `id` of the element to
-    reference to the DOM element itself.  The `callback` is called
+    scan, a reference to the DOM element itself, or an array of id's or
-    when the processing is complete.
+    references.  The `callback` is called when the processing is complete.
         
     :Parameters:
-        - **element** --- the element to be updated
+        - **element** --- the element(s) to be updated
         - **callback** --- the callback specification
     :Returns: the callback object
 
 .. method:: Reprocess([element[,callback]])
 
-    Removes any typeset mathematics from the document or DOM
+    Removes any typeset mathematics from the document or DOM element (or
-    element, and then processes the mathematics again,
+    elements if it is an array of elements), and then processes the
-    re-typesetting everything.  This may be necessary, for example, if
+    mathematics again, re-typesetting everything.  This may be necessary,
-    the CSS styles have changed and those changes would affect the
+    for example, if the CSS styles have changed and those changes would
-    mathematics.  The `element` is either the DOM `id` of the element
+    affect the mathematics.  The `element` is either the DOM `id` of the
-    to scan, or a reference to the DOM element itself.  The `callback`
+    element to scan, a reference to the DOM element itself, or an array of
-    is called when the processing is complete.
+    id's or references.  The `callback` is called when the processing is
+    complete.
         
     :Parameters:
-        - **element** --- the element to be reprocessed
+        - **element** --- the element(s) to be reprocessed
         - **callback** --- the callback specification
     :Returns: the callback object
 

docs/html/_sources/options/hub.txt

@@ -145,6 +145,16 @@ behavior of MathJax.  They are given with their default values.
     which case you will need to call :meth:`MathJax.Hub.Typeset()`
     yourself by hand, set this value to ``true``.
 
+.. describe:: element: []
+
+    This is a list of DOM element ID's that are the ones to process for
+    mathematics when any of the Hub typesetting calls (Typeset, Process,
+    Update, etc.)  are called with no element specified, and during
+    MathJax's initial typesetting run when it starts up.  This lets you
+    restrict the processing to particular containers rather than scanning
+    the entire document for mathematics.  If none are supplied, the entire
+    document is processed.
+
 .. describe:: menuSettings: { ... }
 
     This block contains settings for the mathematics contextual menu

docs/html/_sources/options/jsMath2jax.txt

@@ -20,12 +20,6 @@ section in your :meth:`MathJax.Hub.Config()` call.  For example
 
 would set the ``preview`` parameter to ``"none"``.
 
-
-.. describe:: element: null
-
-    The id name of the element that should be processed by `jsMath2jax`.
-    The default is the whole document.
-
 .. describe:: preview: "TeX"
 
     This controls whether `jsMath2jax` inserts ``MathJax_Preview`` spans

docs/html/_sources/options/mml2jax.txt

@@ -20,11 +20,6 @@ set any of these options, include a ``mml2jax`` section in your
 
 would set the ``preview`` parameter to ``"none"``.
 
-.. describe:: element: null
-
-    The id name of the element that should be processed by `mml2jax`.
-    The default is the whole document.
-
 .. describe:: preview: "alttext"
 
     This controls whether `mml2jax` inserts ``MathJax_Preview`` spans

docs/html/_sources/options/tex2jax.txt

@@ -22,11 +22,6 @@ would set the ``inlineMath`` delimiters for the `tex2jax`
 preprocessor.
 
 
-.. describe:: element: null
-
-    The id name of the element that should be processed by `tex2jax`.
-    The default is the whole document.
-
 .. describe:: inlineMath: [['\\\(','\\\)']]
 
     Array of pairs of strings that are to be used as in-line math

docs/html/api/hub.html

@@ -330,19 +330,20 @@ supply as many <cite>callback</cite> specifications in one call to the
 <dl class="method">
 <dt id="Typeset">
 <tt class="descname">Typeset</tt><big>(</big><span class="optional">[</span><em>element</em><span class="optional">[</span>, <em>callback</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#Typeset" title="Permalink to this definition">¶</a></dt>
-<dd><p>Calls the preprocessors on the given element, and then typesets
+<dd><p>Calls the preprocessors on the given element (or elements if it is an
-any math elements within the element.  If no <cite>element</cite> is
+array of elements), and then typesets any math elements within the
-provided, the whole document is processed.  The <cite>element</cite> is
+element.  If no <cite>element</cite> is provided, the whole document is processed.
-either the DOM <cite>id</cite> of the element, or a reference to the DOM
+The <cite>element</cite> is either the DOM <cite>id</cite> of the element, a reference to
-element itself.  The <cite>callback</cite> is called when the process is
+the DOM element itself, or an array of id&#8217;s or refereneces.  The
-complete.  See the <a class="reference internal" href="../typeset.html#typeset-math"><em>Modifying Math</em></a> section
+<cite>callback</cite> is called when the process is complete.  See the
-for details of how to use this method properly.</p>
+<a class="reference internal" href="../typeset.html#typeset-math"><em>Modifying Math</em></a> section for details of how to use
+this method properly.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><ul class="first simple">
-<li><strong>element</strong> &#8212; the element whose math is to be typeset</li>
+<li><strong>element</strong> &#8212; the element(s) whose math is to be typeset</li>
 <li><strong>callback</strong> &#8212; the callback specification</li>
 </ul>
 </td>
@@ -357,9 +358,10 @@ for details of how to use this method properly.</p>
 <dl class="method">
 <dt id="PreProcess">
 <tt class="descname">PreProcess</tt><big>(</big><span class="optional">[</span><em>element</em><span class="optional">[</span>, <em>callback</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#PreProcess" title="Permalink to this definition">¶</a></dt>
-<dd><p>Calls the loaded preprocessors on the entire document, or on the
+<dd><p>Calls the loaded preprocessors on the entire document, or on the given
-given DOM element.  The <cite>element</cite> is either the DOM <cite>id</cite> of the
+DOM element (or elements, if it is an array of elements).  The
-element, or a reference to the DOM element itself.  The <cite>callback</cite>
+<cite>element</cite> is either the DOM <cite>id</cite> of the element, a reference to the
+DOM element itself, or an array of id&#8217;s or references.  The <cite>callback</cite>
 is called when the processing is complete.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -381,17 +383,17 @@ is called when the processing is complete.</p>
 <dl class="method">
 <dt id="Process">
 <tt class="descname">Process</tt><big>(</big><span class="optional">[</span><em>element</em><span class="optional">[</span>, <em>callback</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#Process" title="Permalink to this definition">¶</a></dt>
-<dd><p>Scans either the entire document or a given DOM <cite>element</cite> for
+<dd><p>Scans either the entire document or a given DOM <cite>element</cite> (or array of
-MathJax <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> tags and processes the math those tags
+elements) for MathJax <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> tags and processes the math those
-contain.  The <cite>element</cite> is either the DOM <cite>id</cite> of the element to
+tags contain.  The <cite>element</cite> is either the DOM <cite>id</cite> of the element to
-scan, or a reference to the DOM element itself.  The <cite>callback</cite> is
+scan, a reference to the DOM element itself, or an array of id&#8217;s or
-called when the processing is complete.</p>
+references.  The <cite>callback</cite> is called when the processing is complete.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><ul class="first simple">
-<li><strong>element</strong> &#8212; the element to be processed</li>
+<li><strong>element</strong> &#8212; the element(s) to be processed</li>
 <li><strong>callback</strong> &#8212; the callback specification</li>
 </ul>
 </td>
@@ -406,18 +408,18 @@ called when the processing is complete.</p>
 <dl class="method">
 <dt id="Update">
 <tt class="descname">Update</tt><big>(</big><span class="optional">[</span><em>element</em><span class="optional">[</span>, <em>callback</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#Update" title="Permalink to this definition">¶</a></dt>
-<dd><p>Scans either the entire document or a given DOM element for
+<dd><p>Scans either the entire document or a given DOM element (or elements if
-mathematics that has changed since the last time it was processed,
+it is an array of elements) for mathematics that has changed since the
-or is new, and typesets the mathematics they contain.  The
+last time it was processed, or is new, and typesets the mathematics
-<cite>element</cite> is either the DOM <cite>id</cite> of the element to scan, or a
+they contain.  The <cite>element</cite> is either the DOM <cite>id</cite> of the element to
-reference to the DOM element itself.  The <cite>callback</cite> is called
+scan, a reference to the DOM element itself, or an array of id&#8217;s or
-when the processing is complete.</p>
+references.  The <cite>callback</cite> is called when the processing is complete.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><ul class="first simple">
-<li><strong>element</strong> &#8212; the element to be updated</li>
+<li><strong>element</strong> &#8212; the element(s) to be updated</li>
 <li><strong>callback</strong> &#8212; the callback specification</li>
 </ul>
 </td>
@@ -432,19 +434,20 @@ when the processing is complete.</p>
 <dl class="method">
 <dt id="Reprocess">
 <tt class="descname">Reprocess</tt><big>(</big><span class="optional">[</span><em>element</em><span class="optional">[</span>, <em>callback</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#Reprocess" title="Permalink to this definition">¶</a></dt>
-<dd><p>Removes any typeset mathematics from the document or DOM
+<dd><p>Removes any typeset mathematics from the document or DOM element (or
-element, and then processes the mathematics again,
+elements if it is an array of elements), and then processes the
-re-typesetting everything.  This may be necessary, for example, if
+mathematics again, re-typesetting everything.  This may be necessary,
-the CSS styles have changed and those changes would affect the
+for example, if the CSS styles have changed and those changes would
-mathematics.  The <cite>element</cite> is either the DOM <cite>id</cite> of the element
+affect the mathematics.  The <cite>element</cite> is either the DOM <cite>id</cite> of the
-to scan, or a reference to the DOM element itself.  The <cite>callback</cite>
+element to scan, a reference to the DOM element itself, or an array of
-is called when the processing is complete.</p>
+id&#8217;s or references.  The <cite>callback</cite> is called when the processing is
+complete.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><ul class="first simple">
-<li><strong>element</strong> &#8212; the element to be reprocessed</li>
+<li><strong>element</strong> &#8212; the element(s) to be reprocessed</li>
 <li><strong>callback</strong> &#8212; the callback specification</li>
 </ul>
 </td>

docs/html/options/hub.html

@@ -208,6 +208,18 @@ which case you will need to call <tt class="xref py py-meth docutils literal"><s
 yourself by hand, set this value to <tt class="docutils literal"><span class="pre">true</span></tt>.</p>
 </dd></dl>
 
+<dl class="describe">
+<dt>
+<tt class="descname">element: []</tt></dt>
+<dd><p>This is a list of DOM element ID&#8217;s that are the ones to process for
+mathematics when any of the Hub typesetting calls (Typeset, Process,
+Update, etc.)  are called with no element specified, and during
+MathJax&#8217;s initial typesetting run when it starts up.  This lets you
+restrict the processing to particular containers rather than scanning
+the entire document for mathematics.  If none are supplied, the entire
+document is processed.</p>
+</dd></dl>
+
 <dl class="describe">
 <dt>
 <tt class="descname">menuSettings: { ... }</tt></dt>

docs/html/options/jsMath2jax.html

@@ -66,13 +66,6 @@ section in your <tt class="xref py py-meth docutils literal"><span class="pre">M
 </pre></div>
 </div>
 <p>would set the <tt class="docutils literal"><span class="pre">preview</span></tt> parameter to <tt class="docutils literal"><span class="pre">&quot;none&quot;</span></tt>.</p>
-<dl class="describe">
-<dt>
-<tt class="descname">element: null</tt></dt>
-<dd><p>The id name of the element that should be processed by <cite>jsMath2jax</cite>.
-The default is the whole document.</p>
-</dd></dl>
-
 <dl class="describe">
 <dt>
 <tt class="descname">preview: &quot;TeX&quot;</tt></dt>

docs/html/options/mml2jax.html

@@ -66,13 +66,6 @@ set any of these options, include a <tt class="docutils literal"><span class="pr
 </pre></div>
 </div>
 <p>would set the <tt class="docutils literal"><span class="pre">preview</span></tt> parameter to <tt class="docutils literal"><span class="pre">&quot;none&quot;</span></tt>.</p>
-<dl class="describe">
-<dt>
-<tt class="descname">element: null</tt></dt>
-<dd><p>The id name of the element that should be processed by <cite>mml2jax</cite>.
-The default is the whole document.</p>
-</dd></dl>
-
 <dl class="describe">
 <dt>
 <tt class="descname">preview: &quot;alttext&quot;</tt></dt>

docs/html/options/tex2jax.html

@@ -67,13 +67,6 @@ set any of these options, include a <tt class="docutils literal"><span class="pr
 </div>
 <p>would set the <tt class="docutils literal"><span class="pre">inlineMath</span></tt> delimiters for the <cite>tex2jax</cite>
 preprocessor.</p>
-<dl class="describe">
-<dt>
-<tt class="descname">element: null</tt></dt>
-<dd><p>The id name of the element that should be processed by <cite>tex2jax</cite>.
-The default is the whole document.</p>
-</dd></dl>
-
 <dl class="describe">
 <dt>
 <tt class="descname">inlineMath: [['\(','\)']]</tt></dt>

docs/source/api/hub.rst

@@ -187,24 +187,26 @@ Methods
 
 .. Method:: Typeset([element[,callback]])
 
-    Calls the preprocessors on the given element, and then typesets
+    Calls the preprocessors on the given element (or elements if it is an
-    any math elements within the element.  If no `element` is
+    array of elements), and then typesets any math elements within the
-    provided, the whole document is processed.  The `element` is
+    element.  If no `element` is provided, the whole document is processed.
-    either the DOM `id` of the element, or a reference to the DOM
+    The `element` is either the DOM `id` of the element, a reference to
-    element itself.  The `callback` is called when the process is
+    the DOM element itself, or an array of id's or refereneces.  The
-    complete.  See the :ref:`Modifying Math <typeset-math>` section
+    `callback` is called when the process is complete.  See the
-    for details of how to use this method properly.
+    :ref:`Modifying Math <typeset-math>` section for details of how to use
+    this method properly.
 
     :Parameters:
-        - **element** --- the element whose math is to be typeset
+        - **element** --- the element(s) whose math is to be typeset
         - **callback** --- the callback specification
     :Returns: the callback object
 
 .. method:: PreProcess([element[,callback]])
 
-    Calls the loaded preprocessors on the entire document, or on the
+    Calls the loaded preprocessors on the entire document, or on the given
-    given DOM element.  The `element` is either the DOM `id` of the
+    DOM element (or elements, if it is an array of elements).  The
-    element, or a reference to the DOM element itself.  The `callback`
+    `element` is either the DOM `id` of the element, a reference to the
+    DOM element itself, or an array of id's or references.  The `callback`
     is called when the processing is complete.
         
     :Parameters:
@@ -214,43 +216,44 @@ Methods
 
 .. method:: Process([element[,callback]])
 
-    Scans either the entire document or a given DOM `element` for
+    Scans either the entire document or a given DOM `element` (or array of
-    MathJax ``<script>`` tags and processes the math those tags
+    elements) for MathJax ``<script>`` tags and processes the math those
-    contain.  The `element` is either the DOM `id` of the element to
+    tags contain.  The `element` is either the DOM `id` of the element to
-    scan, or a reference to the DOM element itself.  The `callback` is
+    scan, a reference to the DOM element itself, or an array of id's or
-    called when the processing is complete.
+    references.  The `callback` is called when the processing is complete.
         
     :Parameters:
-        - **element** --- the element to be processed
+        - **element** --- the element(s) to be processed
         - **callback** --- the callback specification
     :Returns: the callback object
 
 .. method:: Update([element[,callback]])
 
-    Scans either the entire document or a given DOM element for
+    Scans either the entire document or a given DOM element (or elements if
-    mathematics that has changed since the last time it was processed,
+    it is an array of elements) for mathematics that has changed since the
-    or is new, and typesets the mathematics they contain.  The
+    last time it was processed, or is new, and typesets the mathematics
-    `element` is either the DOM `id` of the element to scan, or a
+    they contain.  The `element` is either the DOM `id` of the element to
-    reference to the DOM element itself.  The `callback` is called
+    scan, a reference to the DOM element itself, or an array of id's or
-    when the processing is complete.
+    references.  The `callback` is called when the processing is complete.
         
     :Parameters:
-        - **element** --- the element to be updated
+        - **element** --- the element(s) to be updated
         - **callback** --- the callback specification
     :Returns: the callback object
 
 .. method:: Reprocess([element[,callback]])
 
-    Removes any typeset mathematics from the document or DOM
+    Removes any typeset mathematics from the document or DOM element (or
-    element, and then processes the mathematics again,
+    elements if it is an array of elements), and then processes the
-    re-typesetting everything.  This may be necessary, for example, if
+    mathematics again, re-typesetting everything.  This may be necessary,
-    the CSS styles have changed and those changes would affect the
+    for example, if the CSS styles have changed and those changes would
-    mathematics.  The `element` is either the DOM `id` of the element
+    affect the mathematics.  The `element` is either the DOM `id` of the
-    to scan, or a reference to the DOM element itself.  The `callback`
+    element to scan, a reference to the DOM element itself, or an array of
-    is called when the processing is complete.
+    id's or references.  The `callback` is called when the processing is
+    complete.
         
     :Parameters:
-        - **element** --- the element to be reprocessed
+        - **element** --- the element(s) to be reprocessed
         - **callback** --- the callback specification
     :Returns: the callback object
 

docs/source/options/hub.rst

@@ -145,6 +145,16 @@ behavior of MathJax.  They are given with their default values.
     which case you will need to call :meth:`MathJax.Hub.Typeset()`
     yourself by hand, set this value to ``true``.
 
+.. describe:: element: []
+
+    This is a list of DOM element ID's that are the ones to process for
+    mathematics when any of the Hub typesetting calls (Typeset, Process,
+    Update, etc.)  are called with no element specified, and during
+    MathJax's initial typesetting run when it starts up.  This lets you
+    restrict the processing to particular containers rather than scanning
+    the entire document for mathematics.  If none are supplied, the entire
+    document is processed.
+
 .. describe:: menuSettings: { ... }
 
     This block contains settings for the mathematics contextual menu

docs/source/options/jsMath2jax.rst

@@ -20,12 +20,6 @@ section in your :meth:`MathJax.Hub.Config()` call.  For example
 
 would set the ``preview`` parameter to ``"none"``.
 
-
-.. describe:: element: null
-
-    The id name of the element that should be processed by `jsMath2jax`.
-    The default is the whole document.
-
 .. describe:: preview: "TeX"
 
     This controls whether `jsMath2jax` inserts ``MathJax_Preview`` spans

docs/source/options/mml2jax.rst

@@ -20,11 +20,6 @@ set any of these options, include a ``mml2jax`` section in your
 
 would set the ``preview`` parameter to ``"none"``.
 
-.. describe:: element: null
-
-    The id name of the element that should be processed by `mml2jax`.
-    The default is the whole document.
-
 .. describe:: preview: "alttext"
 
     This controls whether `mml2jax` inserts ``MathJax_Preview`` spans

docs/source/options/tex2jax.rst

@@ -22,11 +22,6 @@ would set the ``inlineMath`` delimiters for the `tex2jax`
 preprocessor.
 
 
-.. describe:: element: null
-
-    The id name of the element that should be processed by `tex2jax`.
-    The default is the whole document.
-
 .. describe:: inlineMath: [['\\\(','\\\)']]
 
     Array of pairs of strings that are to be used as in-line math