Fix typos, and include details about what files must be included in the configuration pages for the individual modules

git-svn-id: https://mathjax.svn.sourceforge.net/svnroot/mathjax/trunk@535 b8fd5906-0fad-46e2-a0d3-10d94ff285d1
This commit is contained in:
Davide Cervone 2010-07-29 21:57:15 +00:00
parent 4d1320dfbc
commit 9dee8248f6
55 changed files with 146 additions and 107 deletions

View File

@ -14,6 +14,9 @@ speak of an "object", as it could be either a native JavaScript
object, or a MathJax object. We will use `Object` (capitalized) or object, or a MathJax object. We will use `Object` (capitalized) or
`MathJax.Object` for, when the distinction is important. `MathJax.Object` for, when the distinction is important.
You may also want to view the :ref:`advanced topics <advanced-topics>`
on the main MathJax documentation page.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

View File

@ -53,7 +53,7 @@ Static Methods
:Parameters: :Parameters:
- **def** --- object that defines the properties and methods - **def** --- object that defines the properties and methods
- **static** --- object that defines stati properties and methods - **static** --- object that defines static properties and methods
:Returns: the new object class :Returns: the new object class
.. method:: Augment(def[,static]) .. method:: Augment(def[,static])
@ -64,7 +64,7 @@ Static Methods
:Parameters: :Parameters:
- **def** --- object that defines the properties and methods - **def** --- object that defines the properties and methods
- **static** --- object that defines stati properties and methods - **static** --- object that defines static properties and methods
:Returns: the object class itself :Returns: the object class itself

View File

@ -31,6 +31,8 @@ Basic Usage
The MathJax Community <community> The MathJax Community <community>
.. _advanced-topics:
Advanced Topics Advanced Topics
=============== ===============

View File

@ -5,10 +5,11 @@ The FontWarnings extension
************************** **************************
The options below control the operation of the `FontWarnings` The options below control the operation of the `FontWarnings`
extension, when it is loaded in teh `extensions` array of your extension that is run when you include ``"FontWarnings.js"`` in the
configuration. They are listed with their default values. To set any `extensions` array of your configuration. They are listed with their
of these options, include a ``FontWarnings`` section in your default values. To set any of these options, include a
:meth:`MathJax.Hub.Config()` call. For example ``FontWarnings`` section in your :meth:`MathJax.Hub.Config()` call.
For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -4,11 +4,12 @@
The HTML-CSS output processor The HTML-CSS output processor
***************************** *****************************
The options below control the operation of the HTML-CSS output processor. The options below control the operation of the HTML-CSS output
They are listed with their default values. To set any of these processor that is run when you include ``"output/HTML-CSS"`` in the
options, include a ``"HTML-CSS"`` section in your `jax` array of your configuration. They are listed with their default
:meth:`MathJax.Hub.Config()` call. Note that, because of the dash, values. To set any of these options, include a ``"HTML-CSS"`` section
you need to enclose the name in quotes. For example in your :meth:`MathJax.Hub.Config()` call. Note that, because of the
dash, you need to enclose the name in quotes. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -4,15 +4,16 @@
The MMLorHTML configuration options The MMLorHTML configuration options
*********************************** ***********************************
The options below control the operation of the MMLorHTML selection. The options below control the operation of the MMLorHTML configuration
They are listed with their default values. To set any of these file that is run when you include ``"MMLorHTML.js"`` in the `config`
options, include a ``MMLorHTML`` section in your array of your configuration. They are listed with their default
:meth:`MathJax.Hub.Config()` call. For example values. To set any of these options, include a ``MMLorHTML`` section
in your :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript
MathJax.Hub.Config({ MathJax.Hub.Config({
MMorHTMLL: { MMLorHTML: {
prefer: { prefer: {
Opera: "MML" Opera: "MML"
} }

View File

@ -4,9 +4,10 @@
The MathML input processor The MathML input processor
************************** **************************
The options below control the operation of the MathML input processor. The options below control the operation of the MathML input processor
They are listed with their default values. To set any of these that is run when you include ``"input/MathML"`` in the `jax` array of
options, include a ``MathML`` section in your your configuration. They are listed with their default values. To
set any of these options, include a ``MathML`` section in your
:meth:`MathJax.Hub.Config()` call. For example :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -5,9 +5,10 @@ The NativeMML output processor
****************************** ******************************
The options below control the operation of the NativeMML output The options below control the operation of the NativeMML output
processor. They are listed with their default values. To set any of processor that is run when you include ``"output/NativeMML"`` in the
these options, include a ``NativeMML`` section in your `jax` array of your configuration. They are listed with their default
:meth:`MathJax.Hub.Config()` call. For example values. To set any of these options, include a ``NativeMML`` section
in your :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -4,9 +4,10 @@
The TeX input processor The TeX input processor
*********************** ***********************
The options below control the operation of the TeX input processor. The options below control the operation of the TeX input processor
They are listed with their default values. To set any of these that is run when you include ``"input/TeX"`` in the `jax` array of
options, include a ``TeX`` section in your your configuration. They are listed with their default values. To
set any of these options, include a ``TeX`` section in your
:meth:`MathJax.Hub.Config()` call. For example :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -5,9 +5,10 @@ The jsMath2jax Preprocessor
*************************** ***************************
The options below control the operation of the `jsMath2jax` The options below control the operation of the `jsMath2jax`
preprocessor. They are listed with their default values. To set any preprocessor that is run when you include ``"jsMath2jax.js"`` in the
of these options, include a ``jsMath2jax`` section in your `extensions` array of your configuration. They are listed with their
:meth:`MathJax.Hub.Config()` call. For example default values. To set any of these options, include a ``jsMath2jax``
section in your :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -4,9 +4,10 @@
The mml2jax Preprocessor The mml2jax Preprocessor
************************ ************************
The options below control the operation of the `mml2jax` preprocessor. The options below control the operation of the `mml2jax` preprocessor
They are listed with their default values. To set any of these that is run when you include ``"mml2jax.js"`` in the `extensions` array
options, include a ``mml2jax`` section in your of your configuration. They are listed with their default values. To
set any of these options, include a ``mml2jax`` section in your
:meth:`MathJax.Hub.Config()` call. For example :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -4,9 +4,10 @@
The tex2jax Preprocessor The tex2jax Preprocessor
************************ ************************
The options below control the operation of the `tex2jax` The options below control the operation of the `tex2jax` preprocessor
preprocessor. They are listed with their default values. To set any that is run when you include ``"tex2jax.js"`` in the `extensions` array
of these options, include a ``tex2jax`` section in your of your configuration. They are listed with their default values. To
set any of these options, include a ``tex2jax`` section in your
:meth:`MathJax.Hub.Config()` call. For example :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -4,7 +4,7 @@
Synchronizing your code with MathJax Synchronizing your code with MathJax
************************************ ************************************
MathJax performs mauch of its activity asynchronously, meaning that MathJax performs much of its activity asynchronously, meaning that
the calls that you make to initiate these actions will return before the calls that you make to initiate these actions will return before
the actions are completed, and your code will continue to run even the actions are completed, and your code will continue to run even
though the actions have not been finished (and may not even be started though the actions have not been finished (and may not even be started

View File

@ -58,6 +58,8 @@ its own object library. This means there is an ambiguity when we
speak of an &#8220;object&#8221;, as it could be either a native JavaScript speak of an &#8220;object&#8221;, as it could be either a native JavaScript
object, or a MathJax object. We will use <cite>Object</cite> (capitalized) or object, or a MathJax object. We will use <cite>Object</cite> (capitalized) or
<cite>MathJax.Object</cite> for, when the distinction is important.</p> <cite>MathJax.Object</cite> for, when the distinction is important.</p>
<p>You may also want to view the <a class="reference internal" href="../index.html#advanced-topics"><em>advanced topics</em></a>
on the main MathJax documentation page.</p>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="variable.html">The MathJax variable</a></li> <li class="toctree-l1"><a class="reference internal" href="variable.html">The MathJax variable</a></li>

View File

@ -99,7 +99,7 @@ new static methods and properties.</p>
<tbody valign="top"> <tbody valign="top">
<tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><ul class="first simple"> <tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><ul class="first simple">
<li><strong>def</strong> &#8212; object that defines the properties and methods</li> <li><strong>def</strong> &#8212; object that defines the properties and methods</li>
<li><strong>static</strong> &#8212; object that defines stati properties and methods</li> <li><strong>static</strong> &#8212; object that defines static properties and methods</li>
</ul> </ul>
</td> </td>
</tr> </tr>
@ -122,7 +122,7 @@ properties and methods automatically.</p>
<tbody valign="top"> <tbody valign="top">
<tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><ul class="first simple"> <tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><ul class="first simple">
<li><strong>def</strong> &#8212; object that defines the properties and methods</li> <li><strong>def</strong> &#8212; object that defines the properties and methods</li>
<li><strong>static</strong> &#8212; object that defines stati properties and methods</li> <li><strong>static</strong> &#8212; object that defines static properties and methods</li>
</ul> </ul>
</td> </td>
</tr> </tr>

View File

@ -73,7 +73,7 @@ MathML that works in all modern browsers.</p>
</div> </div>
</div> </div>
<div class="section" id="advanced-topics"> <div class="section" id="advanced-topics">
<h2>Advanced Topics<a class="headerlink" href="#advanced-topics" title="Permalink to this headline"></a></h2> <span id="id1"></span><h2>Advanced Topics<a class="headerlink" href="#advanced-topics" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="model.html">The MathJax Processing Model</a></li> <li class="toctree-l1"><a class="reference internal" href="model.html">The MathJax Processing Model</a></li>

Binary file not shown.

View File

@ -52,10 +52,11 @@
<div class="section" id="the-fontwarnings-extension"> <div class="section" id="the-fontwarnings-extension">
<span id="configure-fontwarnings"></span><h1>The FontWarnings extension<a class="headerlink" href="#the-fontwarnings-extension" title="Permalink to this headline"></a></h1> <span id="configure-fontwarnings"></span><h1>The FontWarnings extension<a class="headerlink" href="#the-fontwarnings-extension" title="Permalink to this headline"></a></h1>
<p>The options below control the operation of the <cite>FontWarnings</cite> <p>The options below control the operation of the <cite>FontWarnings</cite>
extension, when it is loaded in teh <cite>extensions</cite> array of your extension that is run when you include <tt class="docutils literal"><span class="pre">&quot;FontWarnings.js&quot;</span></tt> in the
configuration. They are listed with their default values. To set any <cite>extensions</cite> array of your configuration. They are listed with their
of these options, include a <tt class="docutils literal"><span class="pre">FontWarnings</span></tt> section in your default values. To set any of these options, include a
<tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p> <tt class="docutils literal"><span class="pre">FontWarnings</span></tt> section in your <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call.
For example</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span> <div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span>
<span class="nx">FontWarnings</span><span class="o">:</span> <span class="p">{</span> <span class="nx">FontWarnings</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">fadeoutTime</span><span class="o">:</span> <span class="mi">2</span><span class="o">*</span><span class="mi">1000</span> <span class="nx">fadeoutTime</span><span class="o">:</span> <span class="mi">2</span><span class="o">*</span><span class="mi">1000</span>

View File

@ -51,11 +51,12 @@
<div class="section" id="the-html-css-output-processor"> <div class="section" id="the-html-css-output-processor">
<span id="configure-html-css"></span><h1>The HTML-CSS output processor<a class="headerlink" href="#the-html-css-output-processor" title="Permalink to this headline"></a></h1> <span id="configure-html-css"></span><h1>The HTML-CSS output processor<a class="headerlink" href="#the-html-css-output-processor" title="Permalink to this headline"></a></h1>
<p>The options below control the operation of the HTML-CSS output processor. <p>The options below control the operation of the HTML-CSS output
They are listed with their default values. To set any of these processor that is run when you include <tt class="docutils literal"><span class="pre">&quot;output/HTML-CSS&quot;</span></tt> in the
options, include a <tt class="docutils literal"><span class="pre">&quot;HTML-CSS&quot;</span></tt> section in your <cite>jax</cite> array of your configuration. They are listed with their default
<tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. Note that, because of the dash, values. To set any of these options, include a <tt class="docutils literal"><span class="pre">&quot;HTML-CSS&quot;</span></tt> section
you need to enclose the name in quotes. For example</p> in your <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. Note that, because of the
dash, you need to enclose the name in quotes. For example</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span> <div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span>
<span class="s2">&quot;HTML-CSS&quot;</span><span class="o">:</span> <span class="p">{</span> <span class="s2">&quot;HTML-CSS&quot;</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">preferredFont</span><span class="o">:</span> <span class="s2">&quot;STIX&quot;</span> <span class="nx">preferredFont</span><span class="o">:</span> <span class="s2">&quot;STIX&quot;</span>

View File

@ -51,12 +51,13 @@
<div class="section" id="the-mmlorhtml-configuration-options"> <div class="section" id="the-mmlorhtml-configuration-options">
<span id="configure-mmlorhtml"></span><h1>The MMLorHTML configuration options<a class="headerlink" href="#the-mmlorhtml-configuration-options" title="Permalink to this headline"></a></h1> <span id="configure-mmlorhtml"></span><h1>The MMLorHTML configuration options<a class="headerlink" href="#the-mmlorhtml-configuration-options" title="Permalink to this headline"></a></h1>
<p>The options below control the operation of the MMLorHTML selection. <p>The options below control the operation of the MMLorHTML configuration
They are listed with their default values. To set any of these file that is run when you include <tt class="docutils literal"><span class="pre">&quot;MMLorHTML.js&quot;</span></tt> in the <cite>config</cite>
options, include a <tt class="docutils literal"><span class="pre">MMLorHTML</span></tt> section in your array of your configuration. They are listed with their default
<tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p> values. To set any of these options, include a <tt class="docutils literal"><span class="pre">MMLorHTML</span></tt> section
in your <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span> <div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span>
<span class="nx">MMorHTMLL</span><span class="o">:</span> <span class="p">{</span> <span class="nx">MMLorHTML</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">prefer</span><span class="o">:</span> <span class="p">{</span> <span class="nx">prefer</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">Opera</span><span class="o">:</span> <span class="s2">&quot;MML&quot;</span> <span class="nx">Opera</span><span class="o">:</span> <span class="s2">&quot;MML&quot;</span>
<span class="p">}</span> <span class="p">}</span>

View File

@ -51,9 +51,10 @@
<div class="section" id="the-mathml-input-processor"> <div class="section" id="the-mathml-input-processor">
<span id="configure-mathml"></span><h1>The MathML input processor<a class="headerlink" href="#the-mathml-input-processor" title="Permalink to this headline"></a></h1> <span id="configure-mathml"></span><h1>The MathML input processor<a class="headerlink" href="#the-mathml-input-processor" title="Permalink to this headline"></a></h1>
<p>The options below control the operation of the MathML input processor. <p>The options below control the operation of the MathML input processor
They are listed with their default values. To set any of these that is run when you include <tt class="docutils literal"><span class="pre">&quot;input/MathML&quot;</span></tt> in the <cite>jax</cite> array of
options, include a <tt class="docutils literal"><span class="pre">MathML</span></tt> section in your your configuration. They are listed with their default values. To
set any of these options, include a <tt class="docutils literal"><span class="pre">MathML</span></tt> section in your
<tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p> <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span> <div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span>
<span class="nx">MathML</span><span class="o">:</span> <span class="p">{</span> <span class="nx">MathML</span><span class="o">:</span> <span class="p">{</span>

View File

@ -52,9 +52,10 @@
<div class="section" id="the-nativemml-output-processor"> <div class="section" id="the-nativemml-output-processor">
<span id="configure-nativemml"></span><h1>The NativeMML output processor<a class="headerlink" href="#the-nativemml-output-processor" title="Permalink to this headline"></a></h1> <span id="configure-nativemml"></span><h1>The NativeMML output processor<a class="headerlink" href="#the-nativemml-output-processor" title="Permalink to this headline"></a></h1>
<p>The options below control the operation of the NativeMML output <p>The options below control the operation of the NativeMML output
processor. They are listed with their default values. To set any of processor that is run when you include <tt class="docutils literal"><span class="pre">&quot;output/NativeMML&quot;</span></tt> in the
these options, include a <tt class="docutils literal"><span class="pre">NativeMML</span></tt> section in your <cite>jax</cite> array of your configuration. They are listed with their default
<tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p> values. To set any of these options, include a <tt class="docutils literal"><span class="pre">NativeMML</span></tt> section
in your <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span> <div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span>
<span class="nx">NativeMML</span><span class="o">:</span> <span class="p">{</span> <span class="nx">NativeMML</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">scale</span><span class="o">:</span> <span class="mi">105</span> <span class="nx">scale</span><span class="o">:</span> <span class="mi">105</span>

View File

@ -51,9 +51,10 @@
<div class="section" id="the-tex-input-processor"> <div class="section" id="the-tex-input-processor">
<span id="configure-tex"></span><h1>The TeX input processor<a class="headerlink" href="#the-tex-input-processor" title="Permalink to this headline"></a></h1> <span id="configure-tex"></span><h1>The TeX input processor<a class="headerlink" href="#the-tex-input-processor" title="Permalink to this headline"></a></h1>
<p>The options below control the operation of the TeX input processor. <p>The options below control the operation of the TeX input processor
They are listed with their default values. To set any of these that is run when you include <tt class="docutils literal"><span class="pre">&quot;input/TeX&quot;</span></tt> in the <cite>jax</cite> array of
options, include a <tt class="docutils literal"><span class="pre">TeX</span></tt> section in your your configuration. They are listed with their default values. To
set any of these options, include a <tt class="docutils literal"><span class="pre">TeX</span></tt> section in your
<tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p> <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span> <div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span>
<span class="nx">TeX</span><span class="o">:</span> <span class="p">{</span> <span class="nx">TeX</span><span class="o">:</span> <span class="p">{</span>

View File

@ -52,9 +52,10 @@
<div class="section" id="the-jsmath2jax-preprocessor"> <div class="section" id="the-jsmath2jax-preprocessor">
<span id="configure-jsmath2jax"></span><h1>The jsMath2jax Preprocessor<a class="headerlink" href="#the-jsmath2jax-preprocessor" title="Permalink to this headline"></a></h1> <span id="configure-jsmath2jax"></span><h1>The jsMath2jax Preprocessor<a class="headerlink" href="#the-jsmath2jax-preprocessor" title="Permalink to this headline"></a></h1>
<p>The options below control the operation of the <cite>jsMath2jax</cite> <p>The options below control the operation of the <cite>jsMath2jax</cite>
preprocessor. They are listed with their default values. To set any preprocessor that is run when you include <tt class="docutils literal"><span class="pre">&quot;jsMath2jax.js&quot;</span></tt> in the
of these options, include a <tt class="docutils literal"><span class="pre">jsMath2jax</span></tt> section in your <cite>extensions</cite> array of your configuration. They are listed with their
<tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p> default values. To set any of these options, include a <tt class="docutils literal"><span class="pre">jsMath2jax</span></tt>
section in your <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span> <div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span>
<span class="nx">jsMath2jax</span><span class="o">:</span> <span class="p">{</span> <span class="nx">jsMath2jax</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">preview</span><span class="o">:</span> <span class="s2">&quot;none&quot;</span> <span class="nx">preview</span><span class="o">:</span> <span class="s2">&quot;none&quot;</span>

View File

@ -51,9 +51,10 @@
<div class="section" id="the-mml2jax-preprocessor"> <div class="section" id="the-mml2jax-preprocessor">
<span id="configure-mml2jax"></span><h1>The mml2jax Preprocessor<a class="headerlink" href="#the-mml2jax-preprocessor" title="Permalink to this headline"></a></h1> <span id="configure-mml2jax"></span><h1>The mml2jax Preprocessor<a class="headerlink" href="#the-mml2jax-preprocessor" title="Permalink to this headline"></a></h1>
<p>The options below control the operation of the <cite>mml2jax</cite> preprocessor. <p>The options below control the operation of the <cite>mml2jax</cite> preprocessor
They are listed with their default values. To set any of these that is run when you include <tt class="docutils literal"><span class="pre">&quot;mml2jax.js&quot;</span></tt> in the <cite>extensions</cite> array
options, include a <tt class="docutils literal"><span class="pre">mml2jax</span></tt> section in your of your configuration. They are listed with their default values. To
set any of these options, include a <tt class="docutils literal"><span class="pre">mml2jax</span></tt> section in your
<tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p> <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span> <div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span>
<span class="nx">mml2jax</span><span class="o">:</span> <span class="p">{</span> <span class="nx">mml2jax</span><span class="o">:</span> <span class="p">{</span>

View File

@ -51,9 +51,10 @@
<div class="section" id="the-tex2jax-preprocessor"> <div class="section" id="the-tex2jax-preprocessor">
<span id="configure-tex2jax"></span><h1>The tex2jax Preprocessor<a class="headerlink" href="#the-tex2jax-preprocessor" title="Permalink to this headline"></a></h1> <span id="configure-tex2jax"></span><h1>The tex2jax Preprocessor<a class="headerlink" href="#the-tex2jax-preprocessor" title="Permalink to this headline"></a></h1>
<p>The options below control the operation of the <cite>tex2jax</cite> <p>The options below control the operation of the <cite>tex2jax</cite> preprocessor
preprocessor. They are listed with their default values. To set any that is run when you include <tt class="docutils literal"><span class="pre">&quot;tex2jax.js&quot;</span></tt> in the <cite>extensions</cite> array
of these options, include a <tt class="docutils literal"><span class="pre">tex2jax</span></tt> section in your of your configuration. They are listed with their default values. To
set any of these options, include a <tt class="docutils literal"><span class="pre">tex2jax</span></tt> section in your
<tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p> <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call. For example</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span> <div class="highlight-javascript"><div class="highlight"><pre><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span>
<span class="nx">tex2jax</span><span class="o">:</span> <span class="p">{</span> <span class="nx">tex2jax</span><span class="o">:</span> <span class="p">{</span>

File diff suppressed because one or more lines are too long

View File

@ -49,7 +49,7 @@
<div class="section" id="synchronizing-your-code-with-mathjax"> <div class="section" id="synchronizing-your-code-with-mathjax">
<span id="synchronization"></span><h1>Synchronizing your code with MathJax<a class="headerlink" href="#synchronizing-your-code-with-mathjax" title="Permalink to this headline"></a></h1> <span id="synchronization"></span><h1>Synchronizing your code with MathJax<a class="headerlink" href="#synchronizing-your-code-with-mathjax" title="Permalink to this headline"></a></h1>
<p>MathJax performs mauch of its activity asynchronously, meaning that <p>MathJax performs much of its activity asynchronously, meaning that
the calls that you make to initiate these actions will return before the calls that you make to initiate these actions will return before
the actions are completed, and your code will continue to run even the actions are completed, and your code will continue to run even
though the actions have not been finished (and may not even be started though the actions have not been finished (and may not even be started

View File

@ -14,6 +14,9 @@ speak of an "object", as it could be either a native JavaScript
object, or a MathJax object. We will use `Object` (capitalized) or object, or a MathJax object. We will use `Object` (capitalized) or
`MathJax.Object` for, when the distinction is important. `MathJax.Object` for, when the distinction is important.
You may also want to view the :ref:`advanced topics <advanced-topics>`
on the main MathJax documentation page.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

View File

@ -53,7 +53,7 @@ Static Methods
:Parameters: :Parameters:
- **def** --- object that defines the properties and methods - **def** --- object that defines the properties and methods
- **static** --- object that defines stati properties and methods - **static** --- object that defines static properties and methods
:Returns: the new object class :Returns: the new object class
.. method:: Augment(def[,static]) .. method:: Augment(def[,static])
@ -64,7 +64,7 @@ Static Methods
:Parameters: :Parameters:
- **def** --- object that defines the properties and methods - **def** --- object that defines the properties and methods
- **static** --- object that defines stati properties and methods - **static** --- object that defines static properties and methods
:Returns: the object class itself :Returns: the object class itself

View File

@ -31,6 +31,8 @@ Basic Usage
The MathJax Community <community> The MathJax Community <community>
.. _advanced-topics:
Advanced Topics Advanced Topics
=============== ===============

View File

@ -5,10 +5,11 @@ The FontWarnings extension
************************** **************************
The options below control the operation of the `FontWarnings` The options below control the operation of the `FontWarnings`
extension, when it is loaded in teh `extensions` array of your extension that is run when you include ``"FontWarnings.js"`` in the
configuration. They are listed with their default values. To set any `extensions` array of your configuration. They are listed with their
of these options, include a ``FontWarnings`` section in your default values. To set any of these options, include a
:meth:`MathJax.Hub.Config()` call. For example ``FontWarnings`` section in your :meth:`MathJax.Hub.Config()` call.
For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -4,11 +4,12 @@
The HTML-CSS output processor The HTML-CSS output processor
***************************** *****************************
The options below control the operation of the HTML-CSS output processor. The options below control the operation of the HTML-CSS output
They are listed with their default values. To set any of these processor that is run when you include ``"output/HTML-CSS"`` in the
options, include a ``"HTML-CSS"`` section in your `jax` array of your configuration. They are listed with their default
:meth:`MathJax.Hub.Config()` call. Note that, because of the dash, values. To set any of these options, include a ``"HTML-CSS"`` section
you need to enclose the name in quotes. For example in your :meth:`MathJax.Hub.Config()` call. Note that, because of the
dash, you need to enclose the name in quotes. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -4,15 +4,16 @@
The MMLorHTML configuration options The MMLorHTML configuration options
*********************************** ***********************************
The options below control the operation of the MMLorHTML selection. The options below control the operation of the MMLorHTML configuration
They are listed with their default values. To set any of these file that is run when you include ``"MMLorHTML.js"`` in the `config`
options, include a ``MMLorHTML`` section in your array of your configuration. They are listed with their default
:meth:`MathJax.Hub.Config()` call. For example values. To set any of these options, include a ``MMLorHTML`` section
in your :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript
MathJax.Hub.Config({ MathJax.Hub.Config({
MMorHTMLL: { MMLorHTML: {
prefer: { prefer: {
Opera: "MML" Opera: "MML"
} }

View File

@ -4,9 +4,10 @@
The MathML input processor The MathML input processor
************************** **************************
The options below control the operation of the MathML input processor. The options below control the operation of the MathML input processor
They are listed with their default values. To set any of these that is run when you include ``"input/MathML"`` in the `jax` array of
options, include a ``MathML`` section in your your configuration. They are listed with their default values. To
set any of these options, include a ``MathML`` section in your
:meth:`MathJax.Hub.Config()` call. For example :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -5,9 +5,10 @@ The NativeMML output processor
****************************** ******************************
The options below control the operation of the NativeMML output The options below control the operation of the NativeMML output
processor. They are listed with their default values. To set any of processor that is run when you include ``"output/NativeMML"`` in the
these options, include a ``NativeMML`` section in your `jax` array of your configuration. They are listed with their default
:meth:`MathJax.Hub.Config()` call. For example values. To set any of these options, include a ``NativeMML`` section
in your :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -4,9 +4,10 @@
The TeX input processor The TeX input processor
*********************** ***********************
The options below control the operation of the TeX input processor. The options below control the operation of the TeX input processor
They are listed with their default values. To set any of these that is run when you include ``"input/TeX"`` in the `jax` array of
options, include a ``TeX`` section in your your configuration. They are listed with their default values. To
set any of these options, include a ``TeX`` section in your
:meth:`MathJax.Hub.Config()` call. For example :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -5,9 +5,10 @@ The jsMath2jax Preprocessor
*************************** ***************************
The options below control the operation of the `jsMath2jax` The options below control the operation of the `jsMath2jax`
preprocessor. They are listed with their default values. To set any preprocessor that is run when you include ``"jsMath2jax.js"`` in the
of these options, include a ``jsMath2jax`` section in your `extensions` array of your configuration. They are listed with their
:meth:`MathJax.Hub.Config()` call. For example default values. To set any of these options, include a ``jsMath2jax``
section in your :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -4,9 +4,10 @@
The mml2jax Preprocessor The mml2jax Preprocessor
************************ ************************
The options below control the operation of the `mml2jax` preprocessor. The options below control the operation of the `mml2jax` preprocessor
They are listed with their default values. To set any of these that is run when you include ``"mml2jax.js"`` in the `extensions` array
options, include a ``mml2jax`` section in your of your configuration. They are listed with their default values. To
set any of these options, include a ``mml2jax`` section in your
:meth:`MathJax.Hub.Config()` call. For example :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -4,9 +4,10 @@
The tex2jax Preprocessor The tex2jax Preprocessor
************************ ************************
The options below control the operation of the `tex2jax` The options below control the operation of the `tex2jax` preprocessor
preprocessor. They are listed with their default values. To set any that is run when you include ``"tex2jax.js"`` in the `extensions` array
of these options, include a ``tex2jax`` section in your of your configuration. They are listed with their default values. To
set any of these options, include a ``tex2jax`` section in your
:meth:`MathJax.Hub.Config()` call. For example :meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript .. code-block:: javascript

View File

@ -4,7 +4,7 @@
Synchronizing your code with MathJax Synchronizing your code with MathJax
************************************ ************************************
MathJax performs mauch of its activity asynchronously, meaning that MathJax performs much of its activity asynchronously, meaning that
the calls that you make to initiate these actions will return before the calls that you make to initiate these actions will return before
the actions are completed, and your code will continue to run even the actions are completed, and your code will continue to run even
though the actions have not been finished (and may not even be started though the actions have not been finished (and may not even be started