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

Last round of typos from Carol (I think)

Browse Source
This commit is contained in:
Davide P. Cervone 2011-03-23 22:38:55 -04:00
parent 41cdadab9a
commit 4b35e6e4f0
50 changed files with 194 additions and 189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/html/CSS-styles.html
View File

@ -64,7 +64,7 @@ rather than just <tt class="docutils literal"><span class="pre">ul</span> <span
<p>The value used to define the CSS style can either be a string <p>The value used to define the CSS style can either be a string
containing the CSS definition, or a javascript object that is itself a containing the CSS definition, or a javascript object that is itself a
collection of <cite>name:value</cite> pairs, where the <cite>name</cite> is the attribute collection of <cite>name:value</cite> pairs, where the <cite>name</cite> is the attribute
being defined and <cite>value</cite> is the value that attibute should be given. being defined and <cite>value</cite> is the value that attribute should be given.
Note that, since this is a JavaScript object, the pairs are separated Note that, since this is a JavaScript object, the pairs are separated
by commas (not semi-colons) and the values are enclosed in quotation by commas (not semi-colons) and the values are enclosed in quotation
marks. If the name contains dashes, it should be enclosed in marks. If the name contains dashes, it should be enclosed in

2
docs/html/HTML-snippets.html
View File

@ -53,7 +53,7 @@
<span id="html-snippets"></span><h1>Describing HTML snippets<a class="headerlink" href="#describing-html-snippets" title="Permalink to this headline"></a></h1> <span id="html-snippets"></span><h1>Describing HTML snippets<a class="headerlink" href="#describing-html-snippets" title="Permalink to this headline"></a></h1>
<p>A number of MathJax configuration options allow you to specify an HTML <p>A number of MathJax configuration options allow you to specify an HTML
snippet using a JavaScript object. This lets you include HTML in your snippet using a JavaScript object. This lets you include HTML in your
configutation files even though they are not HTML files themselves. configuration files even though they are not HTML files themselves.
The format is fairly simple, but flexible enough to let you represent The format is fairly simple, but flexible enough to let you represent
complicated HTML trees.</p> complicated HTML trees.</p>
<p>An HTML snippet is an array consisting of a series of elements that format <p>An HTML snippet is an array consisting of a series of elements that format

2
docs/html/_sources/CSS-styles.txt
View File

@ -18,7 +18,7 @@ rather than just ``ul li``.
The value used to define the CSS style can either be a string The value used to define the CSS style can either be a string
containing the CSS definition, or a javascript object that is itself a containing the CSS definition, or a javascript object that is itself a
collection of `name:value` pairs, where the `name` is the attribute collection of `name:value` pairs, where the `name` is the attribute
being defined and `value` is the value that attibute should be given. being defined and `value` is the value that attribute should be given.
Note that, since this is a JavaScript object, the pairs are separated Note that, since this is a JavaScript object, the pairs are separated
by commas (not semi-colons) and the values are enclosed in quotation by commas (not semi-colons) and the values are enclosed in quotation
marks. If the name contains dashes, it should be enclosed in marks. If the name contains dashes, it should be enclosed in

2
docs/html/_sources/HTML-snippets.txt
View File

@ -6,7 +6,7 @@ Describing HTML snippets
A number of MathJax configuration options allow you to specify an HTML A number of MathJax configuration options allow you to specify an HTML
snippet using a JavaScript object. This lets you include HTML in your snippet using a JavaScript object. This lets you include HTML in your
configutation files even though they are not HTML files themselves. configuration files even though they are not HTML files themselves.
The format is fairly simple, but flexible enough to let you represent The format is fairly simple, but flexible enough to let you represent
complicated HTML trees. complicated HTML trees.

12
docs/html/_sources/api/ajax.txt
View File

@ -113,7 +113,7 @@ Methods
parameter is the name of the file that has been loaded. This parameter is the name of the file that has been loaded. This
routine will cause any callback functions registered for the file routine will cause any callback functions registered for the file
or included in the :meth:`MathJax.Ajax.Require()` calls to be or included in the :meth:`MathJax.Ajax.Require()` calls to be
executed, passing them the status or the load executed, passing them the status of the load
(``MathJax.Ajax.STATUS.OK`` or ``MathJax.Ajax.STATUS.ERROR``) as (``MathJax.Ajax.STATUS.OK`` or ``MathJax.Ajax.STATUS.ERROR``) as
their last parameter. their last parameter.
@ -145,7 +145,7 @@ Methods
.. method:: loadHook(file,callback) .. method:: loadHook(file,callback)
Registers a callback to be executed when the given file is Registers a callback to be executed when the given file is
loaded. The file load operation need to be started when this loaded. The file load operation needs to be started when this
method is called, so it can be used to register a hook for a file method is called, so it can be used to register a hook for a file
that may be loaded in the future. that may be loaded in the future.
@ -156,11 +156,11 @@ Methods
.. method:: Preloading(file1[,file2...]) .. method:: Preloading(file1[,file2...])
Used withing combined configuration files to indicate what files are Used with combined configuration files to indicate what files are
in the configuration file. Marks the files are loading (since there in the configuration file. Marks the files as loading (since there
will never be an explicit :meth:`Load()` or :meth:`Require()` call for will never be an explicit :meth:`Load()` or :meth:`Require()` call for
then), so that load-hooks and other load-related events can be them), so that load-hooks and other load-related events can be
properly processed. properly processed when the :meth:`loadComplete()` occurs.
:Parameters: :Parameters:
- **file1, file2, ...** --- the names of the files in the combined file - **file1, file2, ...** --- the names of the files in the combined file

8
docs/html/_sources/api/callback.txt
View File

@ -35,7 +35,7 @@ A callback specification is any one of the following:
.. describe:: fn .. describe:: fn
A function that is to be called when the callback is executed. A function that is to be called when the callback is executed.
No additional data is passed to it (other that what it is No additional data is passed to it (other than what it is
called with at the time the callback is executed), and `this` called with at the time the callback is executed), and `this`
will be the window object. will be the window object.
@ -145,7 +145,7 @@ of a file), or in response to a user action. For example:
function f(x) {alert("x contains "+x)}; function f(x) {alert("x contains "+x)};
function DelayedX(time) { function DelayedX(time) {
var x = "hi"; var x = "hi";
setTimeout(MathJax.Callback([f, x], time); setTimeout(MathJax.Callback([f, x], time));
} }
The ``DelayedX`` function arranges for the function ``f`` to be called at The ``DelayedX`` function arranges for the function ``f`` to be called at
@ -174,7 +174,7 @@ Callback Object Properties
.. describe:: called .. describe:: called
Set to ``true`` after the callback has been called, and undefined Set to ``true`` after the callback has been called, and undefined
otherwise. A callback will not be exectued a second time unless otherwise. A callback will not be executed a second time unless
the callback's :meth:`reset()` method is called first, or its the callback's :meth:`reset()` method is called first, or its
``autoReset`` property is set to ``true``. ``autoReset`` property is set to ``true``.
@ -224,7 +224,7 @@ MathJax.Callback Methods
Calls each callback in the `hooks` array (or the single hook if it Calls each callback in the `hooks` array (or the single hook if it
is not an array), passing it the arguments stored in the data is not an array), passing it the arguments stored in the data
array. It `reset` is ``true``, then the callback's array. If `reset` is ``true``, then the callback's
:meth:`reset()` method will be called before each hook is :meth:`reset()` method will be called before each hook is
executed. If any of the hooks returns a `Callback` object, then executed. If any of the hooks returns a `Callback` object, then
it collects those callbacks and returns a new callback that will it collects those callbacks and returns a new callback that will

8
docs/html/_sources/api/elementjax.txt
View File

@ -34,7 +34,7 @@ Class Properties
.. describe:: directory .. describe:: directory
The directory where the jax files are stored (e.g., ``"[MathJax]/jax/element/mml"``); The directory where the jax files are stored (e.g., ``"[MathJax]/jax/element/mml"``).
Instance Properties Instance Properties
@ -80,19 +80,19 @@ Methods
.. Method:: Text(text[,callback]) .. Method:: Text(text[,callback])
Sets the input text for this element to the given text and Sets the input text for this element to the given text and
reprocesses the mathematics. (I.e., update the equation to the reprocesses the mathematics. (I.e., updates the equation to the
new one given by `text`). When the processing is complete, the new one given by `text`). When the processing is complete, the
`callback`, if any, is called. `callback`, if any, is called.
:Parameters: :Parameters:
- **text** --- the new mathematic source string for the element - **text** --- the new mathematics source string for the element
- **callback** --- the callback specification - **callback** --- the callback specification
:Returns: the callback object :Returns: the callback object
.. Method:: Reprocess([callback]) .. Method:: Reprocess([callback])
:noindex: :noindex:
Remove the output and produce it again. This may be necessary if Removes the output and produces it again. This may be necessary if
there are changes to the CSS styles that would affect the layout there are changes to the CSS styles that would affect the layout
of the mathematics, for example. The `callback`, if any, is of the mathematics, for example. The `callback`, if any, is
called when the process completes. called when the process completes.

4
docs/html/_sources/api/html.txt
View File

@ -5,7 +5,7 @@ The MathJax.HTML Object
*********************** ***********************
The ``MathJax.HTML`` object provides routines for creating HTML The ``MathJax.HTML`` object provides routines for creating HTML
elements and adding them to the page, and int particular, it contains elements and adding them to the page, and in particular, it contains
the code that processes MathJax's :ref:`HTML snippets <html-snippets>` the code that processes MathJax's :ref:`HTML snippets <html-snippets>`
and turns them into actual DOM objects. It also implements the and turns them into actual DOM objects. It also implements the
methods used to manage the cookies used by MathJax. methods used to manage the cookies used by MathJax.
@ -108,7 +108,7 @@ Methods
discussed below. discussed below.
:Parameters: :Parameters:
- **name** --- the name that identifies the coookie - **name** --- the name that identifies the cookie
- **data** --- object containing the data to store in the cookie - **data** --- object containing the data to store in the cookie
:Returns: ``null`` :Returns: ``null``

20
docs/html/_sources/api/hub.txt
View File

@ -14,7 +14,7 @@ loading is asynchronous, a number of the methods below may return
before their actions are completed. For this reason, they include before their actions are completed. For this reason, they include
callback functions that are called when the action completes. These callback functions that are called when the action completes. These
can be used to synchronize actions that require the mathematics to be can be used to synchronize actions that require the mathematics to be
completed before those action occur. See the :ref:`Using Callbacks completed before those actions occur. See the :ref:`Using Callbacks
<using-callbacks>` documentation for more details. <using-callbacks>` documentation for more details.
@ -58,9 +58,9 @@ Properties
These are boolean values that indicate whether the browser is These are boolean values that indicate whether the browser is
running on a Macintosh computer or a Windows computer. They running on a Macintosh computer or a Windows computer. They
will both be ``false`` for a Linux computer will both be ``false`` for a Linux computer.
.. describe:: isForefox, isSafari, isChrome, isOpera, isMSIE, isKonqueror .. describe:: isFirefox, isSafari, isChrome, isOpera, isMSIE, isKonqueror
These are ``true`` when the browser is the indicated one, and These are ``true`` when the browser is the indicated one, and
``false`` otherwise. ``false`` otherwise.
@ -80,7 +80,7 @@ Properties
browsers and whose values are the functions to be performed. browsers and whose values are the functions to be performed.
Each function is passed one parameter, which is the Each function is passed one parameter, which is the
``MathJax.Hub.Browser`` object. You do not need to include ``MathJax.Hub.Browser`` object. You do not need to include
every browser as one of your choices (only those for which you every browser as one of your choices --- only those for which you
need to do special processing. For example: need to do special processing. For example:
.. code-block:: javascript .. code-block:: javascript
@ -148,8 +148,8 @@ Methods
Registers a listener for a particular message being sent to the Registers a listener for a particular message being sent to the
startup signal (where initialization and component startup startup signal (where initialization and component startup
messages are sent). When the message equals the `type`, the messages are sent). When the message equals the `type`, the
`callback will be called with the message as its parameter. `callback` will be called with the message as its parameter.
See the :ref:`Using Signals <using-signals>` dcocumentation for See the :ref:`Using Signals <using-signals>` documentation for
more details. more details.
:Parameters: :Parameters:
@ -304,8 +304,8 @@ Methods
Returns ``0`` if the element is not a ``<script>`` that can be Returns ``0`` if the element is not a ``<script>`` that can be
processed by MathJax or the result of an output jax, returns ``-1`` processed by MathJax or the result of an output jax, returns ``-1``
if element is an unprocessed ``<script>`` tag that could be if the element is an unprocessed ``<script>`` tag that could be
handled by MathJax, and returns ``1`` if element is a processed handled by MathJax, and returns ``1`` if the element is a processed
``<script>`` tag or an element that is the result of an output jax. ``<script>`` tag or an element that is the result of an output jax.
:Parameters: :Parameters:
@ -316,7 +316,7 @@ Methods
Inserts data from the `src` object into the `dst` object. The Inserts data from the `src` object into the `dst` object. The
`key:value` pairs in `src` are (recursively) copied into `dst`, so `key:value` pairs in `src` are (recursively) copied into `dst`, so
that if `value` is itself an object, its contents is copied into that if `value` is itself an object, its content is copied into
the corresponding object in `dst`. That is, objects within `src` the corresponding object in `dst`. That is, objects within `src`
are merged into the corresponding objects in `dst` (they don't are merged into the corresponding objects in `dst` (they don't
replace them). replace them).
@ -333,7 +333,7 @@ Methods
The `script` is a reference to the ``<script>`` tag where the The `script` is a reference to the ``<script>`` tag where the
error occurred, and `error` is the ``Error`` object for the error. error occurred, and `error` is the ``Error`` object for the error.
The default action is to insert an HTML snippet at the location of The default action is to insert an HTML snippet at the location of
the script, but this routine can be overriden durring MathJax the script, but this routine can be overriden during MathJax
configuration in order to perform some other action. configuration in order to perform some other action.
``MathJax.Hub.lastError`` holds the ``error`` value of the last ``MathJax.Hub.lastError`` holds the ``error`` value of the last
error on the page. error on the page.

14
docs/html/_sources/api/index.txt
View File

@ -7,12 +7,14 @@ The MathJax API
The following links document the various components that make up The following links document the various components that make up
MathJax. These are implemented as JavaScript objects contained within MathJax. These are implemented as JavaScript objects contained within
the single global variable, ``MathJax``. Although JavaScript includes the single global variable, ``MathJax``. Although JavaScript includes
an objects with some inheritance capabilities, they do not constitute an object system with some inheritance capabilities, they do not
a full object-oriented programming model, so MathJax implements constitute a full object-oriented programming model, so MathJax
its own object library. This means there is an ambiguity when we implements its own object library. This means there is an ambiguity
speak of an "object", as it could be either a native JavaScript when we speak of an "object", as it could be either a native
object, or a MathJax object. We will use `Object` (capitalized) or JavaScript object, or a MathJax object. When the distinction is
`MathJax.Object` for, when the distinction is important. importat, we will use `Object` (capitalized) or `MathJax.Object` for
the latter; the javascript object will always be listed in lower
case.
You may also want to view the :ref:`advanced topics <advanced-topics>` You may also want to view the :ref:`advanced topics <advanced-topics>`
on the main MathJax documentation page. on the main MathJax documentation page.

2
docs/html/_sources/api/inputjax.txt
View File

@ -45,7 +45,7 @@ Properties
.. describe:: directory .. describe:: directory
The directory where the jax files are stored (e.g., ``"[MathJax]/jax/input/TeX"``); The directory where the jax files are stored (e.g., ``"[MathJax]/jax/input/TeX"``).
.. describe:: elementJax .. describe:: elementJax

12
docs/html/_sources/api/jax.txt
View File

@ -28,7 +28,7 @@ Class Properties
.. describe:: directory .. describe:: directory
The name of the jax directory (usually ``"[MathJax]/jax"). The name of the jax directory (usually ``"[MathJax]/jax"``).
Overridden in the subclass to be the specific directory for the Overridden in the subclass to be the specific directory for the
class, e.g. ``"[MathJax]/jax/input"``. class, e.g. ``"[MathJax]/jax/input"``.
@ -73,7 +73,7 @@ Methods
This is the method that the ``MathJax.Hub`` calls when it needs the This is the method that the ``MathJax.Hub`` calls when it needs the
input or output jax to process the given math ``<script>``. Its input or output jax to process the given math ``<script>``. Its
default action is to start loading the jax's ``jax.js`` file, and default action is to start loading the jax's ``jax.js`` file, and
redefine itself to simplu return the callback for the laod operation redefine itself to simply return the callback for the load operation
(so that further calls to it will cause the processing to wait for the (so that further calls to it will cause the processing to wait for the
callback). Once the ``jax.js`` file has loaded, this method is callback). Once the ``jax.js`` file has loaded, this method is
replaced by the jax's :meth:`Translate()` method, so that subsequent calls replaced by the jax's :meth:`Translate()` method, so that subsequent calls
@ -89,11 +89,11 @@ Methods
This is a stub for a routine that should be defined by the jax's This is a stub for a routine that should be defined by the jax's
``jax.js`` file when it is loaded. It should perform the translation ``jax.js`` file when it is loaded. It should perform the translation
action for the specific jax. For an input jax, it should return the action for the specific jax. For an input jax, it should return the
`ElementJax` object that it created. The :meth:`Translate()` mehtod is `ElementJax` object that it created. The :meth:`Translate()` method is
never called directly by MathJax; during the :meth:`loadComplete()` never called directly by MathJax; during the :meth:`loadComplete()`
call, this funciton is copied to the :meth:`Process()` method, and is call, this function is copied to the :meth:`Process()` method, and is
called via that name. The default :meth:`Translate()` method throws an called via that name. The default :meth:`Translate()` method throws an
error indicating that the :meth:`Translate()` meth was not been error indicating that the :meth:`Translate()` method was not
redefined. That way, if the ``jax.js`` file fails to load for some redefined. That way, if the ``jax.js`` file fails to load for some
reason, you will receive an error trying to process mathematics with reason, you will receive an error trying to process mathematics with
this jax. this jax.
@ -147,7 +147,7 @@ Methods
5. Post the "[name] Jax Startup" message to the startup signal. 5. Post the "[name] Jax Startup" message to the startup signal.
6. Perform the jax's :meth:`Startup()` method. 6. Perform the jax's :meth:`Startup()` method.
7. Post the "[name] Jax Ready" message to the startup signal. 7. Post the "[name] Jax Ready" message to the startup signal.
8. perform the :meth:`MathJax.Ajax.loadComplete()` call for the 8. Perform the :meth:`MathJax.Ajax.loadComplete()` call for the
``jax.js`` file. ``jax.js`` file.
Note that the configuration process (the :meth:`Config()` call) can Note that the configuration process (the :meth:`Config()` call) can

10
docs/html/_sources/api/message.txt
View File

@ -25,7 +25,7 @@ set via
}); });
Because of a bug in Internet Explorer, in order to change the side of Because of a bug in Internet Explorer, in order to change the side of
the screen where the the message occurs, you must also set the side the screen where the message occurs, you must also set the side
for ``#MathJax_MSIE_Frame``, as in for ``#MathJax_MSIE_Frame``, as in
.. code-block:: javascript .. code-block:: javascript
@ -44,7 +44,7 @@ displayed on screen, it gets an id number that is used when you want
to remove or change that message. That way, when a message is to remove or change that message. That way, when a message is
removed, the previous message (if any) can be redisplayed if it hasn't removed, the previous message (if any) can be redisplayed if it hasn't
been removed. This allows for intermittent messages (like file been removed. This allows for intermittent messages (like file
loading messages) to obscure longer-term message (like "Processing loading messages) to obscure longer-term messages (like "Processing
Math" messages) temporarily. Math" messages) temporarily.
@ -92,14 +92,14 @@ Methods
directory). directory).
:Parameters: :Parameters:
- **file** --- the name of the file being loaded. - **file** --- the name of the file being loaded
:Returns: the message id number for the message created. :Returns: the message id number for the message created
.. method:: filterText(text,n) .. method:: filterText(text,n)
This method is called on each message before it is displayed. It can This method is called on each message before it is displayed. It can
be used to modify (e.g., shorten) the various messages before they are be used to modify (e.g., shorten) the various messages before they are
displayed. The default action is to check of the ``messageStyle`` displayed. The default action is to check if the ``messageStyle``
configuration parameter is ``simple``, and if so, convert loading and configuration parameter is ``simple``, and if so, convert loading and
processing messages to a simpler form. This method can be overridden processing messages to a simpler form. This method can be overridden
to perform other sanitization of the message strings. to perform other sanitization of the message strings.

6
docs/html/_sources/api/queue.txt
View File

@ -6,7 +6,7 @@ The MathJax.Callback.Queue Class
The ``MathJax.Callback.Queue`` object is one of the key mechanisms The ``MathJax.Callback.Queue`` object is one of the key mechanisms
used by MathJax to synchronize its actions with those that occur used by MathJax to synchronize its actions with those that occur
asynchronously, like loading files and stylesheets. A `Queue` obejct asynchronously, like loading files and stylesheets. A `Queue` object
is used to coordinate a sequence of actions so that they are performed is used to coordinate a sequence of actions so that they are performed
one after another, even when one action has to wait for an one after another, even when one action has to wait for an
asynchronous process to complete. This guarantees that operations are asynchronous process to complete. This guarantees that operations are
@ -66,7 +66,7 @@ Methods
.. method:: Suspend() .. method:: Suspend()
Increments the `running` property, indicating that any commands that Increments the `running` property, indicating that any commands that
are added the queue should not be executed immediately, but should are added to the queue should not be executed immediately, but should
be queued for later execution (when its :meth:`Resume()` is be queued for later execution (when its :meth:`Resume()` is
called). This method is used internally; you should not need to called). This method is used internally; you should not need to
call it yourself. call it yourself.
@ -86,7 +86,7 @@ Methods
(passing it the original callback) is queued instead, and it (passing it the original callback) is queued instead, and it
simply returns the callback it was passed. Since the queue will simply returns the callback it was passed. Since the queue will
wait for a callback if it is the return value of one of the wait for a callback if it is the return value of one of the
commands it executes, this effectively make the queue wait for the commands it executes, this effectively makes the queue wait for the
original callback at that point in the command queue. original callback at that point in the command queue.
:Parameters: :Parameters:

14
docs/html/_sources/api/signal.txt
View File

@ -7,9 +7,9 @@ The MathJax.Callback.Signal Class
The ``MathJax.Callback.Signal`` object is one of the key mechanisms The ``MathJax.Callback.Signal`` object is one of the key mechanisms
used by MathJax to synchronize its actions with those that occur used by MathJax to synchronize its actions with those that occur
asynchronously, like loading files and stylesheets. A `Signal` object asynchronously, like loading files and stylesheets. A `Signal` object
is used to pulicise the fact that MathJax has performed certain is used to publicize the fact that MathJax has performed certain
actions, giving other code running the the web page the chance to actions, giving other code running the web page the chance to react to
react to those actions. See :ref:`Synchronizing with MathJax those actions. See :ref:`Synchronizing with MathJax
<synchronization>` for more details, and :ref:`Using Signals <synchronization>` for more details, and :ref:`Using Signals
<using-signals>` in particular for examples of how to specify and use <using-signals>` in particular for examples of how to specify and use
MathJax `Signal` objects. MathJax `Signal` objects.
@ -30,7 +30,7 @@ Properties
.. describe:: posted .. describe:: posted
Array used internally to stored the post history so that when new Array used internally to store the post history so that when new
listeners express interests in this signal, they can be informed listeners express interests in this signal, they can be informed
of the signals that have been posted so far. This can be cleared of the signals that have been posted so far. This can be cleared
using the signal's :meth:`Clear()` method. using the signal's :meth:`Clear()` method.
@ -39,7 +39,7 @@ Properties
Array of callbacks to the listeners who have expressed interest in Array of callbacks to the listeners who have expressed interest in
hearing about posts to this signal. When a post occurs, the hearing about posts to this signal. When a post occurs, the
listeners are called in each turn, passing them the message that listeners are called, each in turn, passing them the message that
was posted. was posted.
@ -51,7 +51,7 @@ Methods
Posts a message to all the listeners for the signal. The listener Posts a message to all the listeners for the signal. The listener
callbacks are called in turn (with the message as an argument), callbacks are called in turn (with the message as an argument),
and if any return a `Callback` object, the posting will be and if any return a `Callback` object, the posting will be
suspended until the callback is exectured. In this way, the suspended until the callback is executed. In this way, the
:meth:`Post()` call can operate asynchronously, and so the :meth:`Post()` call can operate asynchronously, and so the
`callback` parameter is used to synchronize with its operation; `callback` parameter is used to synchronize with its operation;
the `callback` will be called when all the listeners have responded the `callback` will be called when all the listeners have responded
@ -133,7 +133,7 @@ Methods
function that must check the message each time it is called. function that must check the message each time it is called.
Although the `message` here is a string, if a message posted to the Although the `message` here is a string, if a message posted to the
signal is an array, then only the first element of that array is signal is an array, then only the first element of that array is
used to match against message. That way, if a message contains an used to match against the message. That way, if a message contains an
identifier plus arguments, the hook will match the identifier and identifier plus arguments, the hook will match the identifier and
still get called with the complete set of arguments. still get called with the complete set of arguments.

4
docs/html/_sources/api/variable.txt
View File

@ -24,7 +24,7 @@ Main MathJax Components
.. describe:: MathJax.Message .. describe:: MathJax.Message
Contains the code to handle the intermittant message window that Contains the code to handle the intermittent message window that
periodically appears in the lower left-hand corner of the window. periodically appears in the lower left-hand corner of the window.
.. describe:: MathJax.HTML .. describe:: MathJax.HTML
@ -65,7 +65,7 @@ Main MathJax Components
.. describe:: MathJax.ElementJax .. describe:: MathJax.ElementJax
The base class for all element `jax` objects. Subclasses for The base class for all element `jax` objects. Subclasses for
specific element jax are creates as sub-objects of specific element jax are created as sub-objects of
``MathJax.ElementJax``. For example, the mml element jax loads ``MathJax.ElementJax``. For example, the mml element jax loads
itself as ``MathJax.ElementJax.mml``. itself as ``MathJax.ElementJax.mml``.

2
docs/html/_sources/glossary.txt
View File

@ -29,7 +29,7 @@ Glossary
particular message is sent along the signal channel. particular message is sent along the signal channel.
HTML-CSS HTML-CSS
MathJax output form that employs only on HTML and CSS 2.1, MathJax output form that relys only on HTML and CSS 2.1,
allowing MathJax to remain compatible across all browsers. allowing MathJax to remain compatible across all browsers.
jax jax

2
docs/html/_sources/start.txt
View File

@ -227,7 +227,7 @@ math mode, you must enable that explicitly in your configuration:
tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]} tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]}
}); });
</script> </script>
<script type="text/javascipt" src="path-to-mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> <script type="text/javascript" src="path-to-mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
See the ``config/default.js`` file, or the :ref:`tex2jax configuration See the ``config/default.js`` file, or the :ref:`tex2jax configuration
options <configure-tex2jax>` page, for additional configuration options <configure-tex2jax>` page, for additional configuration

12
docs/html/api/ajax.html
View File

@ -192,7 +192,7 @@ file has been completely loaded and initialized. The <cite>file</cite>
parameter is the name of the file that has been loaded. This parameter is the name of the file that has been loaded. This
routine will cause any callback functions registered for the file routine will cause any callback functions registered for the file
or included in the <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Ajax.Require()</span></tt> calls to be or included in the <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Ajax.Require()</span></tt> calls to be
executed, passing them the status or the load executed, passing them the status of the load
(<tt class="docutils literal"><span class="pre">MathJax.Ajax.STATUS.OK</span></tt> or <tt class="docutils literal"><span class="pre">MathJax.Ajax.STATUS.ERROR</span></tt>) as (<tt class="docutils literal"><span class="pre">MathJax.Ajax.STATUS.OK</span></tt> or <tt class="docutils literal"><span class="pre">MathJax.Ajax.STATUS.ERROR</span></tt>) as
their last parameter.</p> their last parameter.</p>
<table class="docutils field-list" frame="void" rules="none"> <table class="docutils field-list" frame="void" rules="none">
@ -260,7 +260,7 @@ puts a warning message into the MathJax message box on screen.</p>
<dt id="loadHook"> <dt id="loadHook">
<tt class="descname">loadHook</tt><big>(</big><em>file</em>, <em>callback</em><big>)</big><a class="headerlink" href="#loadHook" title="Permalink to this definition"></a></dt> <tt class="descname">loadHook</tt><big>(</big><em>file</em>, <em>callback</em><big>)</big><a class="headerlink" href="#loadHook" title="Permalink to this definition"></a></dt>
<dd><p>Registers a callback to be executed when the given file is <dd><p>Registers a callback to be executed when the given file is
loaded. The file load operation need to be started when this loaded. The file load operation needs to be started when this
method is called, so it can be used to register a hook for a file method is called, so it can be used to register a hook for a file
that may be loaded in the future.</p> that may be loaded in the future.</p>
<table class="docutils field-list" frame="void" rules="none"> <table class="docutils field-list" frame="void" rules="none">
@ -283,11 +283,11 @@ that may be loaded in the future.</p>
<dl class="method"> <dl class="method">
<dt id="Preloading"> <dt id="Preloading">
<tt class="descname">Preloading</tt><big>(</big><em>file1</em><span class="optional">[</span>, <em>file2...</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#Preloading" title="Permalink to this definition"></a></dt> <tt class="descname">Preloading</tt><big>(</big><em>file1</em><span class="optional">[</span>, <em>file2...</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#Preloading" title="Permalink to this definition"></a></dt>
<dd><p>Used withing combined configuration files to indicate what files are <dd><p>Used with combined configuration files to indicate what files are
in the configuration file. Marks the files are loading (since there in the configuration file. Marks the files as loading (since there
will never be an explicit <a class="reference internal" href="#Load" title="Load"><tt class="xref py py-meth docutils literal"><span class="pre">Load()</span></tt></a> or <a class="reference internal" href="#Require" title="Require"><tt class="xref py py-meth docutils literal"><span class="pre">Require()</span></tt></a> call for will never be an explicit <a class="reference internal" href="#Load" title="Load"><tt class="xref py py-meth docutils literal"><span class="pre">Load()</span></tt></a> or <a class="reference internal" href="#Require" title="Require"><tt class="xref py py-meth docutils literal"><span class="pre">Require()</span></tt></a> call for
then), so that load-hooks and other load-related events can be them), so that load-hooks and other load-related events can be
properly processed.</p> properly processed when the <a class="reference internal" href="#loadComplete" title="loadComplete"><tt class="xref py py-meth docutils literal"><span class="pre">loadComplete()</span></tt></a> occurs.</p>
<table class="docutils field-list" frame="void" rules="none"> <table class="docutils field-list" frame="void" rules="none">
<col class="field-name" /> <col class="field-name" />
<col class="field-body" /> <col class="field-body" />

8
docs/html/api/callback.html
View File

@ -78,7 +78,7 @@ specification into a Callback object if needed.</p>
<dt> <dt>
<tt class="descname">fn</tt></dt> <tt class="descname">fn</tt></dt>
<dd><p>A function that is to be called when the callback is executed. <dd><p>A function that is to be called when the callback is executed.
No additional data is passed to it (other that what it is No additional data is passed to it (other than what it is
called with at the time the callback is executed), and <cite>this</cite> called with at the time the callback is executed), and <cite>this</cite>
will be the window object.</p> will be the window object.</p>
</dd></dl> </dd></dl>
@ -189,7 +189,7 @@ of a file), or in response to a user action. For example:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="kd">function</span> <span class="nx">f</span><span class="p">(</span><span class="nx">x</span><span class="p">)</span> <span class="p">{</span><span class="nx">alert</span><span class="p">(</span><span class="s2">&quot;x contains &quot;</span><span class="o">+</span><span class="nx">x</span><span class="p">)};</span> <div class="highlight-javascript"><div class="highlight"><pre><span class="kd">function</span> <span class="nx">f</span><span class="p">(</span><span class="nx">x</span><span class="p">)</span> <span class="p">{</span><span class="nx">alert</span><span class="p">(</span><span class="s2">&quot;x contains &quot;</span><span class="o">+</span><span class="nx">x</span><span class="p">)};</span>
<span class="kd">function</span> <span class="nx">DelayedX</span><span class="p">(</span><span class="nx">time</span><span class="p">)</span> <span class="p">{</span> <span class="kd">function</span> <span class="nx">DelayedX</span><span class="p">(</span><span class="nx">time</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">x</span> <span class="o">=</span> <span class="s2">&quot;hi&quot;</span><span class="p">;</span> <span class="kd">var</span> <span class="nx">x</span> <span class="o">=</span> <span class="s2">&quot;hi&quot;</span><span class="p">;</span>
<span class="nx">setTimeout</span><span class="p">(</span><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Callback</span><span class="p">([</span><span class="nx">f</span><span class="p">,</span> <span class="nx">x</span><span class="p">],</span> <span class="nx">time</span><span class="p">);</span> <span class="nx">setTimeout</span><span class="p">(</span><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Callback</span><span class="p">([</span><span class="nx">f</span><span class="p">,</span> <span class="nx">x</span><span class="p">],</span> <span class="nx">time</span><span class="p">));</span>
<span class="p">}</span> <span class="p">}</span>
</pre></div> </pre></div>
</div> </div>
@ -225,7 +225,7 @@ function.</p>
<dt> <dt>
<tt class="descname">called</tt></dt> <tt class="descname">called</tt></dt>
<dd><p>Set to <tt class="docutils literal"><span class="pre">true</span></tt> after the callback has been called, and undefined <dd><p>Set to <tt class="docutils literal"><span class="pre">true</span></tt> after the callback has been called, and undefined
otherwise. A callback will not be exectued a second time unless otherwise. A callback will not be executed a second time unless
the callback&#8217;s <a class="reference internal" href="#reset" title="reset"><tt class="xref py py-meth docutils literal"><span class="pre">reset()</span></tt></a> method is called first, or its the callback&#8217;s <a class="reference internal" href="#reset" title="reset"><tt class="xref py py-meth docutils literal"><span class="pre">reset()</span></tt></a> method is called first, or its
<tt class="docutils literal"><span class="pre">autoReset</span></tt> property is set to <tt class="docutils literal"><span class="pre">true</span></tt>.</p> <tt class="docutils literal"><span class="pre">autoReset</span></tt> property is set to <tt class="docutils literal"><span class="pre">true</span></tt>.</p>
</dd></dl> </dd></dl>
@ -293,7 +293,7 @@ commands.</p>
<tt class="descname">executeHooks</tt><big>(</big><em>hooks</em><span class="optional">[</span>, <em>data</em><span class="optional">[</span>, <em>reset</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#executeHooks" title="Permalink to this definition"></a></dt> <tt class="descname">executeHooks</tt><big>(</big><em>hooks</em><span class="optional">[</span>, <em>data</em><span class="optional">[</span>, <em>reset</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#executeHooks" title="Permalink to this definition"></a></dt>
<dd><p>Calls each callback in the <cite>hooks</cite> array (or the single hook if it <dd><p>Calls each callback in the <cite>hooks</cite> array (or the single hook if it
is not an array), passing it the arguments stored in the data is not an array), passing it the arguments stored in the data
array. It <cite>reset</cite> is <tt class="docutils literal"><span class="pre">true</span></tt>, then the callback&#8217;s array. If <cite>reset</cite> is <tt class="docutils literal"><span class="pre">true</span></tt>, then the callback&#8217;s
<a class="reference internal" href="#reset" title="reset"><tt class="xref py py-meth docutils literal"><span class="pre">reset()</span></tt></a> method will be called before each hook is <a class="reference internal" href="#reset" title="reset"><tt class="xref py py-meth docutils literal"><span class="pre">reset()</span></tt></a> method will be called before each hook is
executed. If any of the hooks returns a <cite>Callback</cite> object, then executed. If any of the hooks returns a <cite>Callback</cite> object, then
it collects those callbacks and returns a new callback that will it collects those callbacks and returns a new callback that will

8
docs/html/api/elementjax.html
View File

@ -82,7 +82,7 @@ that class.</p>
<dl class="describe"> <dl class="describe">
<dt> <dt>
<tt class="descname">directory</tt></dt> <tt class="descname">directory</tt></dt>
<dd><p>The directory where the jax files are stored (e.g., <tt class="docutils literal"><span class="pre">&quot;[MathJax]/jax/element/mml&quot;</span></tt>);</p> <dd><p>The directory where the jax files are stored (e.g., <tt class="docutils literal"><span class="pre">&quot;[MathJax]/jax/element/mml&quot;</span></tt>).</p>
</dd></dl> </dd></dl>
</div> </div>
@ -137,7 +137,7 @@ rather than <tt class="docutils literal"><span class="pre">MathJax.Hub</span></t
<dt id="Text"> <dt id="Text">
<tt class="descname">Text</tt><big>(</big><em>text</em><span class="optional">[</span>, <em>callback</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#Text" title="Permalink to this definition"></a></dt> <tt class="descname">Text</tt><big>(</big><em>text</em><span class="optional">[</span>, <em>callback</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#Text" title="Permalink to this definition"></a></dt>
<dd><p>Sets the input text for this element to the given text and <dd><p>Sets the input text for this element to the given text and
reprocesses the mathematics. (I.e., update the equation to the reprocesses the mathematics. (I.e., updates the equation to the
new one given by <cite>text</cite>). When the processing is complete, the new one given by <cite>text</cite>). When the processing is complete, the
<cite>callback</cite>, if any, is called.</p> <cite>callback</cite>, if any, is called.</p>
<table class="docutils field-list" frame="void" rules="none"> <table class="docutils field-list" frame="void" rules="none">
@ -145,7 +145,7 @@ new one given by <cite>text</cite>). When the processing is complete, the
<col class="field-body" /> <col class="field-body" />
<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>text</strong> &#8212; the new mathematic source string for the element</li> <li><strong>text</strong> &#8212; the new mathematics source string for the element</li>
<li><strong>callback</strong> &#8212; the callback specification</li> <li><strong>callback</strong> &#8212; the callback specification</li>
</ul> </ul>
</td> </td>
@ -160,7 +160,7 @@ new one given by <cite>text</cite>). When the processing is complete, the
<dl class="method"> <dl class="method">
<dt> <dt>
<tt class="descname">Reprocess</tt><big>(</big><span class="optional">[</span><em>callback</em><span class="optional">]</span><big>)</big></dt> <tt class="descname">Reprocess</tt><big>(</big><span class="optional">[</span><em>callback</em><span class="optional">]</span><big>)</big></dt>
<dd><p>Remove the output and produce it again. This may be necessary if <dd><p>Removes the output and produces it again. This may be necessary if
there are changes to the CSS styles that would affect the layout there are changes to the CSS styles that would affect the layout
of the mathematics, for example. The <cite>callback</cite>, if any, is of the mathematics, for example. The <cite>callback</cite>, if any, is
called when the process completes.</p> called when the process completes.</p>

4
docs/html/api/html.html
View File

@ -54,7 +54,7 @@
<div class="section" id="the-mathjax-html-object"> <div class="section" id="the-mathjax-html-object">
<span id="api-html"></span><h1>The MathJax.HTML Object<a class="headerlink" href="#the-mathjax-html-object" title="Permalink to this headline"></a></h1> <span id="api-html"></span><h1>The MathJax.HTML Object<a class="headerlink" href="#the-mathjax-html-object" title="Permalink to this headline"></a></h1>
<p>The <tt class="docutils literal"><span class="pre">MathJax.HTML</span></tt> object provides routines for creating HTML <p>The <tt class="docutils literal"><span class="pre">MathJax.HTML</span></tt> object provides routines for creating HTML
elements and adding them to the page, and int particular, it contains elements and adding them to the page, and in particular, it contains
the code that processes MathJax&#8217;s <a class="reference internal" href="../HTML-snippets.html#html-snippets"><em>HTML snippets</em></a> the code that processes MathJax&#8217;s <a class="reference internal" href="../HTML-snippets.html#html-snippets"><em>HTML snippets</em></a>
and turns them into actual DOM objects. It also implements the and turns them into actual DOM objects. It also implements the
methods used to manage the cookies used by MathJax.</p> methods used to manage the cookies used by MathJax.</p>
@ -217,7 +217,7 @@ discussed below.</p>
<col class="field-body" /> <col class="field-body" />
<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>name</strong> &#8212; the name that identifies the coookie</li> <li><strong>name</strong> &#8212; the name that identifies the cookie</li>
<li><strong>data</strong> &#8212; object containing the data to store in the cookie</li> <li><strong>data</strong> &#8212; object containing the data to store in the cookie</li>
</ul> </ul>
</td> </td>

20
docs/html/api/hub.html
View File

@ -63,7 +63,7 @@ loading is asynchronous, a number of the methods below may return
before their actions are completed. For this reason, they include before their actions are completed. For this reason, they include
callback functions that are called when the action completes. These callback functions that are called when the action completes. These
can be used to synchronize actions that require the mathematics to be can be used to synchronize actions that require the mathematics to be
completed before those action occur. See the <a class="reference internal" href="../callbacks.html#using-callbacks"><em>Using Callbacks</em></a> documentation for more details.</p> completed before those actions occur. See the <a class="reference internal" href="../callbacks.html#using-callbacks"><em>Using Callbacks</em></a> documentation for more details.</p>
<div class="section" id="properties"> <div class="section" id="properties">
<h2>Properties<a class="headerlink" href="#properties" title="Permalink to this headline"></a></h2> <h2>Properties<a class="headerlink" href="#properties" title="Permalink to this headline"></a></h2>
<dl class="describe"> <dl class="describe">
@ -114,12 +114,12 @@ additional properties and methods concerning the browser:</p>
<tt class="descname">isMac and isPC</tt></dt> <tt class="descname">isMac and isPC</tt></dt>
<dd><p>These are boolean values that indicate whether the browser is <dd><p>These are boolean values that indicate whether the browser is
running on a Macintosh computer or a Windows computer. They running on a Macintosh computer or a Windows computer. They
will both be <tt class="docutils literal"><span class="pre">false</span></tt> for a Linux computer</p> will both be <tt class="docutils literal"><span class="pre">false</span></tt> for a Linux computer.</p>
</dd></dl> </dd></dl>
<dl class="describe"> <dl class="describe">
<dt> <dt>
<tt class="descname">isForefox, isSafari, isChrome, isOpera, isMSIE, isKonqueror</tt></dt> <tt class="descname">isFirefox, isSafari, isChrome, isOpera, isMSIE, isKonqueror</tt></dt>
<dd><p>These are <tt class="docutils literal"><span class="pre">true</span></tt> when the browser is the indicated one, and <dd><p>These are <tt class="docutils literal"><span class="pre">true</span></tt> when the browser is the indicated one, and
<tt class="docutils literal"><span class="pre">false</span></tt> otherwise.</p> <tt class="docutils literal"><span class="pre">false</span></tt> otherwise.</p>
</dd></dl> </dd></dl>
@ -142,7 +142,7 @@ for instance.</p>
browsers and whose values are the functions to be performed. browsers and whose values are the functions to be performed.
Each function is passed one parameter, which is the Each function is passed one parameter, which is the
<tt class="docutils literal"><span class="pre">MathJax.Hub.Browser</span></tt> object. You do not need to include <tt class="docutils literal"><span class="pre">MathJax.Hub.Browser</span></tt> object. You do not need to include
every browser as one of your choices (only those for which you every browser as one of your choices &#8212; only those for which you
need to do special processing. For example:</p> need to do special processing. 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">Browser</span><span class="p">.</span><span class="nx">Select</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">Browser</span><span class="p">.</span><span class="nx">Select</span><span class="p">(</span>
<span class="nx">MSIE</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">browser</span><span class="p">)</span> <span class="p">{</span> <span class="nx">MSIE</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">browser</span><span class="p">)</span> <span class="p">{</span>
@ -256,8 +256,8 @@ parameter.</p>
<dd><p>Registers a listener for a particular message being sent to the <dd><p>Registers a listener for a particular message being sent to the
startup signal (where initialization and component startup startup signal (where initialization and component startup
messages are sent). When the message equals the <cite>type</cite>, the messages are sent). When the message equals the <cite>type</cite>, the
<cite>callback will be called with the message as its parameter. <cite>callback</cite> will be called with the message as its parameter.
See the :ref:`Using Signals &lt;using-signals&gt;</cite> dcocumentation for See the <a class="reference internal" href="../signals.html#using-signals"><em>Using Signals</em></a> documentation for
more details.</p> more details.</p>
<table class="docutils field-list" frame="void" rules="none"> <table class="docutils field-list" frame="void" rules="none">
<col class="field-name" /> <col class="field-name" />
@ -555,8 +555,8 @@ element, or a reference to the DOM element itself.</p>
<tt class="descname">isJax</tt><big>(</big><em>element</em><big>)</big><a class="headerlink" href="#isJax" title="Permalink to this definition"></a></dt> <tt class="descname">isJax</tt><big>(</big><em>element</em><big>)</big><a class="headerlink" href="#isJax" title="Permalink to this definition"></a></dt>
<dd><p>Returns <tt class="docutils literal"><span class="pre">0</span></tt> if the element is not a <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> that can be <dd><p>Returns <tt class="docutils literal"><span class="pre">0</span></tt> if the element is not a <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> that can be
processed by MathJax or the result of an output jax, returns <tt class="docutils literal"><span class="pre">-1</span></tt> processed by MathJax or the result of an output jax, returns <tt class="docutils literal"><span class="pre">-1</span></tt>
if element is an unprocessed <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> tag that could be if the element is an unprocessed <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> tag that could be
handled by MathJax, and returns <tt class="docutils literal"><span class="pre">1</span></tt> if element is a processed handled by MathJax, and returns <tt class="docutils literal"><span class="pre">1</span></tt> if the element is a processed
<tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> tag or an element that is the result of an output jax.</p> <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> tag or an element that is the result of an output jax.</p>
<table class="docutils field-list" frame="void" rules="none"> <table class="docutils field-list" frame="void" rules="none">
<col class="field-name" /> <col class="field-name" />
@ -579,7 +579,7 @@ handled by MathJax, and returns <tt class="docutils literal"><span class="pre">1
<tt class="descname">Insert</tt><big>(</big><em>dst</em>, <em>src</em><big>)</big><a class="headerlink" href="#Insert" title="Permalink to this definition"></a></dt> <tt class="descname">Insert</tt><big>(</big><em>dst</em>, <em>src</em><big>)</big><a class="headerlink" href="#Insert" title="Permalink to this definition"></a></dt>
<dd><p>Inserts data from the <cite>src</cite> object into the <cite>dst</cite> object. The <dd><p>Inserts data from the <cite>src</cite> object into the <cite>dst</cite> object. The
<cite>key:value</cite> pairs in <cite>src</cite> are (recursively) copied into <cite>dst</cite>, so <cite>key:value</cite> pairs in <cite>src</cite> are (recursively) copied into <cite>dst</cite>, so
that if <cite>value</cite> is itself an object, its contents is copied into that if <cite>value</cite> is itself an object, its content is copied into
the corresponding object in <cite>dst</cite>. That is, objects within <cite>src</cite> the corresponding object in <cite>dst</cite>. That is, objects within <cite>src</cite>
are merged into the corresponding objects in <cite>dst</cite> (they don&#8217;t are merged into the corresponding objects in <cite>dst</cite> (they don&#8217;t
replace them).</p> replace them).</p>
@ -608,7 +608,7 @@ of a math element (i.e., an error in the MathJax code itself).
The <cite>script</cite> is a reference to the <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> tag where the The <cite>script</cite> is a reference to the <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> tag where the
error occurred, and <cite>error</cite> is the <tt class="docutils literal"><span class="pre">Error</span></tt> object for the error. error occurred, and <cite>error</cite> is the <tt class="docutils literal"><span class="pre">Error</span></tt> object for the error.
The default action is to insert an HTML snippet at the location of The default action is to insert an HTML snippet at the location of
the script, but this routine can be overriden durring MathJax the script, but this routine can be overriden during MathJax
configuration in order to perform some other action. configuration in order to perform some other action.
<tt class="docutils literal"><span class="pre">MathJax.Hub.lastError</span></tt> holds the <tt class="docutils literal"><span class="pre">error</span></tt> value of the last <tt class="docutils literal"><span class="pre">MathJax.Hub.lastError</span></tt> holds the <tt class="docutils literal"><span class="pre">error</span></tt> value of the last
error on the page.</p> error on the page.</p>

14
docs/html/api/index.html
View File

@ -54,12 +54,14 @@
<p>The following links document the various components that make up <p>The following links document the various components that make up
MathJax. These are implemented as JavaScript objects contained within MathJax. These are implemented as JavaScript objects contained within
the single global variable, <tt class="docutils literal"><span class="pre">MathJax</span></tt>. Although JavaScript includes the single global variable, <tt class="docutils literal"><span class="pre">MathJax</span></tt>. Although JavaScript includes
an objects with some inheritance capabilities, they do not constitute an object system with some inheritance capabilities, they do not
a full object-oriented programming model, so MathJax implements constitute a full object-oriented programming model, so MathJax
its own object library. This means there is an ambiguity when we implements its own object library. This means there is an ambiguity
speak of an &#8220;object&#8221;, as it could be either a native JavaScript when we speak of an &#8220;object&#8221;, as it could be either a native
object, or a MathJax object. We will use <cite>Object</cite> (capitalized) or JavaScript object, or a MathJax object. When the distinction is
<cite>MathJax.Object</cite> for, when the distinction is important.</p> importat, we will use <cite>Object</cite> (capitalized) or <cite>MathJax.Object</cite> for
the latter; the javascript object will always be listed in lower
case.</p>
<p>You may also want to view the <a class="reference internal" href="../index.html#advanced-topics"><em>advanced topics</em></a> <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> on the main MathJax documentation page.</p>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">

2
docs/html/api/inputjax.html
View File

@ -92,7 +92,7 @@ that class.</p>
<dl class="describe"> <dl class="describe">
<dt> <dt>
<tt class="descname">directory</tt></dt> <tt class="descname">directory</tt></dt>
<dd><p>The directory where the jax files are stored (e.g., <tt class="docutils literal"><span class="pre">&quot;[MathJax]/jax/input/TeX&quot;</span></tt>);</p> <dd><p>The directory where the jax files are stored (e.g., <tt class="docutils literal"><span class="pre">&quot;[MathJax]/jax/input/TeX&quot;</span></tt>).</p>
</dd></dl> </dd></dl>
<dl class="describe"> <dl class="describe">

16
docs/html/api/jax.html
View File

@ -72,9 +72,9 @@ other jax classes.</p>
<dl class="describe"> <dl class="describe">
<dt> <dt>
<tt class="descname">directory</tt></dt> <tt class="descname">directory</tt></dt>
<dd><p>The name of the jax directory (usually <tt class="docutils literal"><span class="pre">&quot;[MathJax]/jax&quot;).</span> <dd><p>The name of the jax directory (usually <tt class="docutils literal"><span class="pre">&quot;[MathJax]/jax&quot;</span></tt>).
<span class="pre">Overridden</span> <span class="pre">in</span> <span class="pre">the</span> <span class="pre">subclass</span> <span class="pre">to</span> <span class="pre">be</span> <span class="pre">the</span> <span class="pre">specific</span> <span class="pre">directory</span> <span class="pre">for</span> <span class="pre">the</span> Overridden in the subclass to be the specific directory for the
<span class="pre">class,</span> <span class="pre">e.g.</span> <span class="pre">``&quot;[MathJax]/jax/input&quot;</span></tt>.</p> class, e.g. <tt class="docutils literal"><span class="pre">&quot;[MathJax]/jax/input&quot;</span></tt>.</p>
</dd></dl> </dd></dl>
<dl class="describe"> <dl class="describe">
@ -128,7 +128,7 @@ configuration subsection for the specific jax in question.</p>
<dd><p>This is the method that the <tt class="docutils literal"><span class="pre">MathJax.Hub</span></tt> calls when it needs the <dd><p>This is the method that the <tt class="docutils literal"><span class="pre">MathJax.Hub</span></tt> calls when it needs the
input or output jax to process the given math <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt>. Its input or output jax to process the given math <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt>. Its
default action is to start loading the jax&#8217;s <tt class="docutils literal"><span class="pre">jax.js</span></tt> file, and default action is to start loading the jax&#8217;s <tt class="docutils literal"><span class="pre">jax.js</span></tt> file, and
redefine itself to simplu return the callback for the laod operation redefine itself to simply return the callback for the load operation
(so that further calls to it will cause the processing to wait for the (so that further calls to it will cause the processing to wait for the
callback). Once the <tt class="docutils literal"><span class="pre">jax.js</span></tt> file has loaded, this method is callback). Once the <tt class="docutils literal"><span class="pre">jax.js</span></tt> file has loaded, this method is
replaced by the jax&#8217;s <a class="reference internal" href="#Translate" title="Translate"><tt class="xref py py-meth docutils literal"><span class="pre">Translate()</span></tt></a> method, so that subsequent calls replaced by the jax&#8217;s <a class="reference internal" href="#Translate" title="Translate"><tt class="xref py py-meth docutils literal"><span class="pre">Translate()</span></tt></a> method, so that subsequent calls
@ -160,11 +160,11 @@ to <a class="reference internal" href="hub.html#Process" title="Process"><tt cla
<dd><p>This is a stub for a routine that should be defined by the jax&#8217;s <dd><p>This is a stub for a routine that should be defined by the jax&#8217;s
<tt class="docutils literal"><span class="pre">jax.js</span></tt> file when it is loaded. It should perform the translation <tt class="docutils literal"><span class="pre">jax.js</span></tt> file when it is loaded. It should perform the translation
action for the specific jax. For an input jax, it should return the action for the specific jax. For an input jax, it should return the
<cite>ElementJax</cite> object that it created. The <a class="reference internal" href="#Translate" title="Translate"><tt class="xref py py-meth docutils literal"><span class="pre">Translate()</span></tt></a> mehtod is <cite>ElementJax</cite> object that it created. The <a class="reference internal" href="#Translate" title="Translate"><tt class="xref py py-meth docutils literal"><span class="pre">Translate()</span></tt></a> method is
never called directly by MathJax; during the <a class="reference internal" href="ajax.html#loadComplete" title="loadComplete"><tt class="xref py py-meth docutils literal"><span class="pre">loadComplete()</span></tt></a> never called directly by MathJax; during the <a class="reference internal" href="ajax.html#loadComplete" title="loadComplete"><tt class="xref py py-meth docutils literal"><span class="pre">loadComplete()</span></tt></a>
call, this funciton is copied to the <a class="reference internal" href="hub.html#Process" title="Process"><tt class="xref py py-meth docutils literal"><span class="pre">Process()</span></tt></a> method, and is call, this function is copied to the <a class="reference internal" href="hub.html#Process" title="Process"><tt class="xref py py-meth docutils literal"><span class="pre">Process()</span></tt></a> method, and is
called via that name. The default <a class="reference internal" href="#Translate" title="Translate"><tt class="xref py py-meth docutils literal"><span class="pre">Translate()</span></tt></a> method throws an called via that name. The default <a class="reference internal" href="#Translate" title="Translate"><tt class="xref py py-meth docutils literal"><span class="pre">Translate()</span></tt></a> method throws an
error indicating that the <a class="reference internal" href="#Translate" title="Translate"><tt class="xref py py-meth docutils literal"><span class="pre">Translate()</span></tt></a> meth was not been error indicating that the <a class="reference internal" href="#Translate" title="Translate"><tt class="xref py py-meth docutils literal"><span class="pre">Translate()</span></tt></a> method was not
redefined. That way, if the <tt class="docutils literal"><span class="pre">jax.js</span></tt> file fails to load for some redefined. That way, if the <tt class="docutils literal"><span class="pre">jax.js</span></tt> file fails to load for some
reason, you will receive an error trying to process mathematics with reason, you will receive an error trying to process mathematics with
this jax.</p> this jax.</p>
@ -249,7 +249,7 @@ following:</p>
<li>Post the &#8220;[name] Jax Startup&#8221; message to the startup signal.</li> <li>Post the &#8220;[name] Jax Startup&#8221; message to the startup signal.</li>
<li>Perform the jax&#8217;s <a class="reference internal" href="#Startup" title="Startup"><tt class="xref py py-meth docutils literal"><span class="pre">Startup()</span></tt></a> method.</li> <li>Perform the jax&#8217;s <a class="reference internal" href="#Startup" title="Startup"><tt class="xref py py-meth docutils literal"><span class="pre">Startup()</span></tt></a> method.</li>
<li>Post the &#8220;[name] Jax Ready&#8221; message to the startup signal.</li> <li>Post the &#8220;[name] Jax Ready&#8221; message to the startup signal.</li>
<li>perform the <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Ajax.loadComplete()</span></tt> call for the <li>Perform the <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Ajax.loadComplete()</span></tt> call for the
<tt class="docutils literal"><span class="pre">jax.js</span></tt> file.</li> <tt class="docutils literal"><span class="pre">jax.js</span></tt> file.</li>
</ol> </ol>
</div></blockquote> </div></blockquote>

10
docs/html/api/message.html
View File

@ -71,7 +71,7 @@ set via</p>
</pre></div> </pre></div>
</div> </div>
<p>Because of a bug in Internet Explorer, in order to change the side of <p>Because of a bug in Internet Explorer, in order to change the side of
the screen where the the message occurs, you must also set the side the screen where the message occurs, you must also set the side
for <tt class="docutils literal"><span class="pre">#MathJax_MSIE_Frame</span></tt>, as in</p> for <tt class="docutils literal"><span class="pre">#MathJax_MSIE_Frame</span></tt>, as in</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">styles</span><span class="o">:</span> <span class="p">{</span> <span class="nx">styles</span><span class="o">:</span> <span class="p">{</span>
@ -87,7 +87,7 @@ displayed on screen, it gets an id number that is used when you want
to remove or change that message. That way, when a message is to remove or change that message. That way, when a message is
removed, the previous message (if any) can be redisplayed if it hasn&#8217;t removed, the previous message (if any) can be redisplayed if it hasn&#8217;t
been removed. This allows for intermittent messages (like file been removed. This allows for intermittent messages (like file
loading messages) to obscure longer-term message (like &#8220;Processing loading messages) to obscure longer-term messages (like &#8220;Processing
Math&#8221; messages) temporarily.</p> Math&#8221; messages) temporarily.</p>
<div class="section" id="methods"> <div class="section" id="methods">
<h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headline"></a></h2> <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headline"></a></h2>
@ -168,11 +168,11 @@ directory).</p>
<col class="field-body" /> <col class="field-body" />
<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>file</strong> &#8212; the name of the file being loaded.</li> <li><strong>file</strong> &#8212; the name of the file being loaded</li>
</ul> </ul>
</td> </td>
</tr> </tr>
<tr class="field"><th class="field-name">Returns :</th><td class="field-body"><p class="first last">the message id number for the message created.</p> <tr class="field"><th class="field-name">Returns :</th><td class="field-body"><p class="first last">the message id number for the message created</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -184,7 +184,7 @@ directory).</p>
<tt class="descname">filterText</tt><big>(</big><em>text</em>, <em>n</em><big>)</big><a class="headerlink" href="#filterText" title="Permalink to this definition"></a></dt> <tt class="descname">filterText</tt><big>(</big><em>text</em>, <em>n</em><big>)</big><a class="headerlink" href="#filterText" title="Permalink to this definition"></a></dt>
<dd><p>This method is called on each message before it is displayed. It can <dd><p>This method is called on each message before it is displayed. It can
be used to modify (e.g., shorten) the various messages before they are be used to modify (e.g., shorten) the various messages before they are
displayed. The default action is to check of the <tt class="docutils literal"><span class="pre">messageStyle</span></tt> displayed. The default action is to check if the <tt class="docutils literal"><span class="pre">messageStyle</span></tt>
configuration parameter is <tt class="docutils literal"><span class="pre">simple</span></tt>, and if so, convert loading and configuration parameter is <tt class="docutils literal"><span class="pre">simple</span></tt>, and if so, convert loading and
processing messages to a simpler form. This method can be overridden processing messages to a simpler form. This method can be overridden
to perform other sanitization of the message strings.</p> to perform other sanitization of the message strings.</p>

11
docs/html/api/queue.html
View File

@ -55,7 +55,7 @@
<span id="api-queue"></span><h1>The MathJax.Callback.Queue Class<a class="headerlink" href="#the-mathjax-callback-queue-class" title="Permalink to this headline"></a></h1> <span id="api-queue"></span><h1>The MathJax.Callback.Queue Class<a class="headerlink" href="#the-mathjax-callback-queue-class" title="Permalink to this headline"></a></h1>
<p>The <tt class="docutils literal"><span class="pre">MathJax.Callback.Queue</span></tt> object is one of the key mechanisms <p>The <tt class="docutils literal"><span class="pre">MathJax.Callback.Queue</span></tt> object is one of the key mechanisms
used by MathJax to synchronize its actions with those that occur used by MathJax to synchronize its actions with those that occur
asynchronously, like loading files and stylesheets. A <cite>Queue</cite> obejct asynchronously, like loading files and stylesheets. A <cite>Queue</cite> object
is used to coordinate a sequence of actions so that they are performed is used to coordinate a sequence of actions so that they are performed
one after another, even when one action has to wait for an one after another, even when one action has to wait for an
asynchronous process to complete. This guarantees that operations are asynchronous process to complete. This guarantees that operations are
@ -120,17 +120,16 @@ synchronization, say as an entry in some other queue).</p>
<dl class="method"> <dl class="method">
<dt> <dt>
<tt class="descname">Process</tt><big>(</big><big>)</big></dt> <tt class="descname">Process</tt><big>(</big><big>)</big></dt>
<dd><blockquote> <dd><p>Process the commands in the queue, provided the queue is not
<div>Process the commands in the queue, provided the queue is not
waiting for another command to complete. This method is used waiting for another command to complete. This method is used
internally; you should not need to call it yourself.</div></blockquote> internally; you should not need to call it yourself.</p>
</dd></dl> </dd></dl>
<dl class="method"> <dl class="method">
<dt id="Suspend"> <dt id="Suspend">
<tt class="descname">Suspend</tt><big>(</big><big>)</big><a class="headerlink" href="#Suspend" title="Permalink to this definition"></a></dt> <tt class="descname">Suspend</tt><big>(</big><big>)</big><a class="headerlink" href="#Suspend" title="Permalink to this definition"></a></dt>
<dd><p>Increments the <cite>running</cite> property, indicating that any commands that <dd><p>Increments the <cite>running</cite> property, indicating that any commands that
are added the queue should not be executed immediately, but should are added to the queue should not be executed immediately, but should
be queued for later execution (when its <a class="reference internal" href="#Resume" title="Resume"><tt class="xref py py-meth docutils literal"><span class="pre">Resume()</span></tt></a> is be queued for later execution (when its <a class="reference internal" href="#Resume" title="Resume"><tt class="xref py py-meth docutils literal"><span class="pre">Resume()</span></tt></a> is
called). This method is used internally; you should not need to called). This method is used internally; you should not need to
call it yourself.</p> call it yourself.</p>
@ -154,7 +153,7 @@ rather than a callback specification. A callback to this function
(passing it the original callback) is queued instead, and it (passing it the original callback) is queued instead, and it
simply returns the callback it was passed. Since the queue will simply returns the callback it was passed. Since the queue will
wait for a callback if it is the return value of one of the wait for a callback if it is the return value of one of the
commands it executes, this effectively make the queue wait for the commands it executes, this effectively makes the queue wait for the
original callback at that point in the command queue.</p> original callback at that point in the command queue.</p>
<table class="docutils field-list" frame="void" rules="none"> <table class="docutils field-list" frame="void" rules="none">
<col class="field-name" /> <col class="field-name" />

14
docs/html/api/signal.html
View File

@ -56,9 +56,9 @@
<p>The <tt class="docutils literal"><span class="pre">MathJax.Callback.Signal</span></tt> object is one of the key mechanisms <p>The <tt class="docutils literal"><span class="pre">MathJax.Callback.Signal</span></tt> object is one of the key mechanisms
used by MathJax to synchronize its actions with those that occur used by MathJax to synchronize its actions with those that occur
asynchronously, like loading files and stylesheets. A <cite>Signal</cite> object asynchronously, like loading files and stylesheets. A <cite>Signal</cite> object
is used to pulicise the fact that MathJax has performed certain is used to publicize the fact that MathJax has performed certain
actions, giving other code running the the web page the chance to actions, giving other code running the web page the chance to react to
react to those actions. See <a class="reference internal" href="../synchronize.html#synchronization"><em>Synchronizing with MathJax</em></a> for more details, and <a class="reference internal" href="../signals.html#using-signals"><em>Using Signals</em></a> in particular for examples of how to specify and use those actions. See <a class="reference internal" href="../synchronize.html#synchronization"><em>Synchronizing with MathJax</em></a> for more details, and <a class="reference internal" href="../signals.html#using-signals"><em>Using Signals</em></a> in particular for examples of how to specify and use
MathJax <cite>Signal</cite> objects.</p> MathJax <cite>Signal</cite> objects.</p>
<p>The <cite>Callback Signal</cite> object is a subclass of the <a class="reference internal" href="queue.html#api-queue"><em>Callback Queue</em></a> object.</p> <p>The <cite>Callback Signal</cite> object is a subclass of the <a class="reference internal" href="queue.html#api-queue"><em>Callback Queue</em></a> object.</p>
<div class="section" id="properties"> <div class="section" id="properties">
@ -75,7 +75,7 @@ the signal return references to the same object.</p>
<dl class="describe"> <dl class="describe">
<dt> <dt>
<tt class="descname">posted</tt></dt> <tt class="descname">posted</tt></dt>
<dd><p>Array used internally to stored the post history so that when new <dd><p>Array used internally to store the post history so that when new
listeners express interests in this signal, they can be informed listeners express interests in this signal, they can be informed
of the signals that have been posted so far. This can be cleared of the signals that have been posted so far. This can be cleared
using the signal&#8217;s <a class="reference internal" href="message.html#Clear" title="Clear"><tt class="xref py py-meth docutils literal"><span class="pre">Clear()</span></tt></a> method.</p> using the signal&#8217;s <a class="reference internal" href="message.html#Clear" title="Clear"><tt class="xref py py-meth docutils literal"><span class="pre">Clear()</span></tt></a> method.</p>
@ -86,7 +86,7 @@ using the signal&#8217;s <a class="reference internal" href="message.html#Clear"
<tt class="descname">listeners</tt></dt> <tt class="descname">listeners</tt></dt>
<dd><p>Array of callbacks to the listeners who have expressed interest in <dd><p>Array of callbacks to the listeners who have expressed interest in
hearing about posts to this signal. When a post occurs, the hearing about posts to this signal. When a post occurs, the
listeners are called in each turn, passing them the message that listeners are called, each in turn, passing them the message that
was posted.</p> was posted.</p>
</dd></dl> </dd></dl>
@ -99,7 +99,7 @@ was posted.</p>
<dd><p>Posts a message to all the listeners for the signal. The listener <dd><p>Posts a message to all the listeners for the signal. The listener
callbacks are called in turn (with the message as an argument), callbacks are called in turn (with the message as an argument),
and if any return a <cite>Callback</cite> object, the posting will be and if any return a <cite>Callback</cite> object, the posting will be
suspended until the callback is exectured. In this way, the suspended until the callback is executed. In this way, the
<a class="reference internal" href="#Post" title="Post"><tt class="xref py py-meth docutils literal"><span class="pre">Post()</span></tt></a> call can operate asynchronously, and so the <a class="reference internal" href="#Post" title="Post"><tt class="xref py py-meth docutils literal"><span class="pre">Post()</span></tt></a> call can operate asynchronously, and so the
<cite>callback</cite> parameter is used to synchronize with its operation; <cite>callback</cite> parameter is used to synchronize with its operation;
the <cite>callback</cite> will be called when all the listeners have responded the <cite>callback</cite> will be called when all the listeners have responded
@ -224,7 +224,7 @@ the given message. This is a little easier than having to write a
function that must check the message each time it is called. function that must check the message each time it is called.
Although the <cite>message</cite> here is a string, if a message posted to the Although the <cite>message</cite> here is a string, if a message posted to the
signal is an array, then only the first element of that array is signal is an array, then only the first element of that array is
used to match against message. That way, if a message contains an used to match against the message. That way, if a message contains an
identifier plus arguments, the hook will match the identifier and identifier plus arguments, the hook will match the identifier and
still get called with the complete set of arguments.</p> still get called with the complete set of arguments.</p>
<p>Returns the <cite>Callback</cite> object that was produced.</p> <p>Returns the <cite>Callback</cite> object that was produced.</p>

4
docs/html/api/variable.html
View File

@ -77,7 +77,7 @@ operate asynchronously is handled here.</p>
<dl class="describe"> <dl class="describe">
<dt> <dt>
<tt class="descname">MathJax.Message</tt></dt> <tt class="descname">MathJax.Message</tt></dt>
<dd><p>Contains the code to handle the intermittant message window that <dd><p>Contains the code to handle the intermittent message window that
periodically appears in the lower left-hand corner of the window.</p> periodically appears in the lower left-hand corner of the window.</p>
</dd></dl> </dd></dl>
@ -131,7 +131,7 @@ itself as <tt class="docutils literal"><span class="pre">MathJax.OutputJax[&quot
<dt> <dt>
<tt class="descname">MathJax.ElementJax</tt></dt> <tt class="descname">MathJax.ElementJax</tt></dt>
<dd><p>The base class for all element <cite>jax</cite> objects. Subclasses for <dd><p>The base class for all element <cite>jax</cite> objects. Subclasses for
specific element jax are creates as sub-objects of specific element jax are created as sub-objects of
<tt class="docutils literal"><span class="pre">MathJax.ElementJax</span></tt>. For example, the mml element jax loads <tt class="docutils literal"><span class="pre">MathJax.ElementJax</span></tt>. For example, the mml element jax loads
itself as <tt class="docutils literal"><span class="pre">MathJax.ElementJax.mml</span></tt>.</p> itself as <tt class="docutils literal"><span class="pre">MathJax.ElementJax.mml</span></tt>.</p>
</dd></dl> </dd></dl>

2
docs/html/glossary.html
View File

@ -66,7 +66,7 @@ messages. Your code can register an &#8220;interest&#8221; in a signal,
or can register a <a class="reference internal" href="#term-callback"><em class="xref std std-term">callback</em></a> to be called when a or can register a <a class="reference internal" href="#term-callback"><em class="xref std std-term">callback</em></a> to be called when a
particular message is sent along the signal channel.</dd> particular message is sent along the signal channel.</dd>
<dt id="term-html-css">HTML-CSS</dt> <dt id="term-html-css">HTML-CSS</dt>
<dd>MathJax output form that employs only on HTML and CSS 2.1, <dd>MathJax output form that relys only on HTML and CSS 2.1,
allowing MathJax to remain compatible across all browsers.</dd> allowing MathJax to remain compatible across all browsers.</dd>
<dt id="term-jax">jax</dt> <dt id="term-jax">jax</dt>
<dd>MathJax&#8217;s input and output processors are called &#8220;jax&#8221;, as is <dd>MathJax&#8217;s input and output processors are called &#8220;jax&#8221;, as is

2
docs/html/index.html
View File

@ -121,7 +121,7 @@ MathML that works in all modern browsers.</p>
</li> </li>
</ul> </ul>
<hr class="docutils" /> <hr class="docutils" />
<p>This version of the documentation was built March 21, 2011.</p> <p>This version of the documentation was built March 23, 2011.</p>
</div> </div>
</div> </div>

2
docs/html/searchindex.js
View File

File diff suppressed because one or more lines are too long

2
docs/html/start.html
View File

@ -227,7 +227,7 @@ math mode, you must enable that explicitly in your configuration:</p>
<span class="nx">tex2jax</span><span class="o">:</span> <span class="p">{</span><span class="nx">inlineMath</span><span class="o">:</span> <span class="p">[[</span><span class="s1">&#39;$&#39;</span><span class="p">,</span><span class="s1">&#39;$&#39;</span><span class="p">],</span> <span class="p">[</span><span class="s1">&#39;\\(&#39;</span><span class="p">,</span><span class="s1">&#39;\\)&#39;</span><span class="p">]]}</span> <span class="nx">tex2jax</span><span class="o">:</span> <span class="p">{</span><span class="nx">inlineMath</span><span class="o">:</span> <span class="p">[[</span><span class="s1">&#39;$&#39;</span><span class="p">,</span><span class="s1">&#39;$&#39;</span><span class="p">],</span> <span class="p">[</span><span class="s1">&#39;\\(&#39;</span><span class="p">,</span><span class="s1">&#39;\\)&#39;</span><span class="p">]]}</span>
<span class="p">});</span> <span class="p">});</span>
<span class="nt">&lt;/script&gt;</span> <span class="nt">&lt;/script&gt;</span>
<span class="nt">&lt;script </span><span class="na">type=</span><span class="s">&quot;text/javascipt&quot;</span> <span class="na">src=</span><span class="s">&quot;path-to-mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML&quot;</span><span class="nt">&gt;&lt;/script&gt;</span> <span class="nt">&lt;script </span><span class="na">type=</span><span class="s">&quot;text/javascript&quot;</span> <span class="na">src=</span><span class="s">&quot;path-to-mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML&quot;</span><span class="nt">&gt;&lt;/script&gt;</span>
</pre></div> </pre></div>
</div> </div>
<p>See the <tt class="docutils literal"><span class="pre">config/default.js</span></tt> file, or the <a class="reference internal" href="options/tex2jax.html#configure-tex2jax"><em>tex2jax configuration <p>See the <tt class="docutils literal"><span class="pre">config/default.js</span></tt> file, or the <a class="reference internal" href="options/tex2jax.html#configure-tex2jax"><em>tex2jax configuration

2
docs/source/CSS-styles.rst
View File

@ -18,7 +18,7 @@ rather than just ``ul li``.
The value used to define the CSS style can either be a string The value used to define the CSS style can either be a string
containing the CSS definition, or a javascript object that is itself a containing the CSS definition, or a javascript object that is itself a
collection of `name:value` pairs, where the `name` is the attribute collection of `name:value` pairs, where the `name` is the attribute
being defined and `value` is the value that attibute should be given. being defined and `value` is the value that attribute should be given.
Note that, since this is a JavaScript object, the pairs are separated Note that, since this is a JavaScript object, the pairs are separated
by commas (not semi-colons) and the values are enclosed in quotation by commas (not semi-colons) and the values are enclosed in quotation
marks. If the name contains dashes, it should be enclosed in marks. If the name contains dashes, it should be enclosed in

2
docs/source/HTML-snippets.rst
View File

@ -6,7 +6,7 @@ Describing HTML snippets
A number of MathJax configuration options allow you to specify an HTML A number of MathJax configuration options allow you to specify an HTML
snippet using a JavaScript object. This lets you include HTML in your snippet using a JavaScript object. This lets you include HTML in your
configutation files even though they are not HTML files themselves. configuration files even though they are not HTML files themselves.
The format is fairly simple, but flexible enough to let you represent The format is fairly simple, but flexible enough to let you represent
complicated HTML trees. complicated HTML trees.

12
docs/source/api/ajax.rst
View File

@ -113,7 +113,7 @@ Methods
parameter is the name of the file that has been loaded. This parameter is the name of the file that has been loaded. This
routine will cause any callback functions registered for the file routine will cause any callback functions registered for the file
or included in the :meth:`MathJax.Ajax.Require()` calls to be or included in the :meth:`MathJax.Ajax.Require()` calls to be
executed, passing them the status or the load executed, passing them the status of the load
(``MathJax.Ajax.STATUS.OK`` or ``MathJax.Ajax.STATUS.ERROR``) as (``MathJax.Ajax.STATUS.OK`` or ``MathJax.Ajax.STATUS.ERROR``) as
their last parameter. their last parameter.
@ -145,7 +145,7 @@ Methods
.. method:: loadHook(file,callback) .. method:: loadHook(file,callback)
Registers a callback to be executed when the given file is Registers a callback to be executed when the given file is
loaded. The file load operation need to be started when this loaded. The file load operation needs to be started when this
method is called, so it can be used to register a hook for a file method is called, so it can be used to register a hook for a file
that may be loaded in the future. that may be loaded in the future.
@ -156,11 +156,11 @@ Methods
.. method:: Preloading(file1[,file2...]) .. method:: Preloading(file1[,file2...])
Used withing combined configuration files to indicate what files are Used with combined configuration files to indicate what files are
in the configuration file. Marks the files are loading (since there in the configuration file. Marks the files as loading (since there
will never be an explicit :meth:`Load()` or :meth:`Require()` call for will never be an explicit :meth:`Load()` or :meth:`Require()` call for
then), so that load-hooks and other load-related events can be them), so that load-hooks and other load-related events can be
properly processed. properly processed when the :meth:`loadComplete()` occurs.
:Parameters: :Parameters:
- **file1, file2, ...** --- the names of the files in the combined file - **file1, file2, ...** --- the names of the files in the combined file

8
docs/source/api/callback.rst
View File

@ -35,7 +35,7 @@ A callback specification is any one of the following:
.. describe:: fn .. describe:: fn
A function that is to be called when the callback is executed. A function that is to be called when the callback is executed.
No additional data is passed to it (other that what it is No additional data is passed to it (other than what it is
called with at the time the callback is executed), and `this` called with at the time the callback is executed), and `this`
will be the window object. will be the window object.
@ -145,7 +145,7 @@ of a file), or in response to a user action. For example:
function f(x) {alert("x contains "+x)}; function f(x) {alert("x contains "+x)};
function DelayedX(time) { function DelayedX(time) {
var x = "hi"; var x = "hi";
setTimeout(MathJax.Callback([f, x], time); setTimeout(MathJax.Callback([f, x], time));
} }
The ``DelayedX`` function arranges for the function ``f`` to be called at The ``DelayedX`` function arranges for the function ``f`` to be called at
@ -174,7 +174,7 @@ Callback Object Properties
.. describe:: called .. describe:: called
Set to ``true`` after the callback has been called, and undefined Set to ``true`` after the callback has been called, and undefined
otherwise. A callback will not be exectued a second time unless otherwise. A callback will not be executed a second time unless
the callback's :meth:`reset()` method is called first, or its the callback's :meth:`reset()` method is called first, or its
``autoReset`` property is set to ``true``. ``autoReset`` property is set to ``true``.
@ -224,7 +224,7 @@ MathJax.Callback Methods
Calls each callback in the `hooks` array (or the single hook if it Calls each callback in the `hooks` array (or the single hook if it
is not an array), passing it the arguments stored in the data is not an array), passing it the arguments stored in the data
array. It `reset` is ``true``, then the callback's array. If `reset` is ``true``, then the callback's
:meth:`reset()` method will be called before each hook is :meth:`reset()` method will be called before each hook is
executed. If any of the hooks returns a `Callback` object, then executed. If any of the hooks returns a `Callback` object, then
it collects those callbacks and returns a new callback that will it collects those callbacks and returns a new callback that will

8
docs/source/api/elementjax.rst
View File

@ -34,7 +34,7 @@ Class Properties
.. describe:: directory .. describe:: directory
The directory where the jax files are stored (e.g., ``"[MathJax]/jax/element/mml"``); The directory where the jax files are stored (e.g., ``"[MathJax]/jax/element/mml"``).
Instance Properties Instance Properties
@ -80,19 +80,19 @@ Methods
.. Method:: Text(text[,callback]) .. Method:: Text(text[,callback])
Sets the input text for this element to the given text and Sets the input text for this element to the given text and
reprocesses the mathematics. (I.e., update the equation to the reprocesses the mathematics. (I.e., updates the equation to the
new one given by `text`). When the processing is complete, the new one given by `text`). When the processing is complete, the
`callback`, if any, is called. `callback`, if any, is called.
:Parameters: :Parameters:
- **text** --- the new mathematic source string for the element - **text** --- the new mathematics source string for the element
- **callback** --- the callback specification - **callback** --- the callback specification
:Returns: the callback object :Returns: the callback object
.. Method:: Reprocess([callback]) .. Method:: Reprocess([callback])
:noindex: :noindex:
Remove the output and produce it again. This may be necessary if Removes the output and produces it again. This may be necessary if
there are changes to the CSS styles that would affect the layout there are changes to the CSS styles that would affect the layout
of the mathematics, for example. The `callback`, if any, is of the mathematics, for example. The `callback`, if any, is
called when the process completes. called when the process completes.

4
docs/source/api/html.rst
View File

@ -5,7 +5,7 @@ The MathJax.HTML Object
*********************** ***********************
The ``MathJax.HTML`` object provides routines for creating HTML The ``MathJax.HTML`` object provides routines for creating HTML
elements and adding them to the page, and int particular, it contains elements and adding them to the page, and in particular, it contains
the code that processes MathJax's :ref:`HTML snippets <html-snippets>` the code that processes MathJax's :ref:`HTML snippets <html-snippets>`
and turns them into actual DOM objects. It also implements the and turns them into actual DOM objects. It also implements the
methods used to manage the cookies used by MathJax. methods used to manage the cookies used by MathJax.
@ -108,7 +108,7 @@ Methods
discussed below. discussed below.
:Parameters: :Parameters:
- **name** --- the name that identifies the coookie - **name** --- the name that identifies the cookie
- **data** --- object containing the data to store in the cookie - **data** --- object containing the data to store in the cookie
:Returns: ``null`` :Returns: ``null``

20
docs/source/api/hub.rst
View File

@ -14,7 +14,7 @@ loading is asynchronous, a number of the methods below may return
before their actions are completed. For this reason, they include before their actions are completed. For this reason, they include
callback functions that are called when the action completes. These callback functions that are called when the action completes. These
can be used to synchronize actions that require the mathematics to be can be used to synchronize actions that require the mathematics to be
completed before those action occur. See the :ref:`Using Callbacks completed before those actions occur. See the :ref:`Using Callbacks
<using-callbacks>` documentation for more details. <using-callbacks>` documentation for more details.
@ -58,9 +58,9 @@ Properties
These are boolean values that indicate whether the browser is These are boolean values that indicate whether the browser is
running on a Macintosh computer or a Windows computer. They running on a Macintosh computer or a Windows computer. They
will both be ``false`` for a Linux computer will both be ``false`` for a Linux computer.
.. describe:: isForefox, isSafari, isChrome, isOpera, isMSIE, isKonqueror .. describe:: isFirefox, isSafari, isChrome, isOpera, isMSIE, isKonqueror
These are ``true`` when the browser is the indicated one, and These are ``true`` when the browser is the indicated one, and
``false`` otherwise. ``false`` otherwise.
@ -80,7 +80,7 @@ Properties
browsers and whose values are the functions to be performed. browsers and whose values are the functions to be performed.
Each function is passed one parameter, which is the Each function is passed one parameter, which is the
``MathJax.Hub.Browser`` object. You do not need to include ``MathJax.Hub.Browser`` object. You do not need to include
every browser as one of your choices (only those for which you every browser as one of your choices --- only those for which you
need to do special processing. For example: need to do special processing. For example:
.. code-block:: javascript .. code-block:: javascript
@ -148,8 +148,8 @@ Methods
Registers a listener for a particular message being sent to the Registers a listener for a particular message being sent to the
startup signal (where initialization and component startup startup signal (where initialization and component startup
messages are sent). When the message equals the `type`, the messages are sent). When the message equals the `type`, the
`callback will be called with the message as its parameter. `callback` will be called with the message as its parameter.
See the :ref:`Using Signals <using-signals>` dcocumentation for See the :ref:`Using Signals <using-signals>` documentation for
more details. more details.
:Parameters: :Parameters:
@ -304,8 +304,8 @@ Methods
Returns ``0`` if the element is not a ``<script>`` that can be Returns ``0`` if the element is not a ``<script>`` that can be
processed by MathJax or the result of an output jax, returns ``-1`` processed by MathJax or the result of an output jax, returns ``-1``
if element is an unprocessed ``<script>`` tag that could be if the element is an unprocessed ``<script>`` tag that could be
handled by MathJax, and returns ``1`` if element is a processed handled by MathJax, and returns ``1`` if the element is a processed
``<script>`` tag or an element that is the result of an output jax. ``<script>`` tag or an element that is the result of an output jax.
:Parameters: :Parameters:
@ -316,7 +316,7 @@ Methods
Inserts data from the `src` object into the `dst` object. The Inserts data from the `src` object into the `dst` object. The
`key:value` pairs in `src` are (recursively) copied into `dst`, so `key:value` pairs in `src` are (recursively) copied into `dst`, so
that if `value` is itself an object, its contents is copied into that if `value` is itself an object, its content is copied into
the corresponding object in `dst`. That is, objects within `src` the corresponding object in `dst`. That is, objects within `src`
are merged into the corresponding objects in `dst` (they don't are merged into the corresponding objects in `dst` (they don't
replace them). replace them).
@ -333,7 +333,7 @@ Methods
The `script` is a reference to the ``<script>`` tag where the The `script` is a reference to the ``<script>`` tag where the
error occurred, and `error` is the ``Error`` object for the error. error occurred, and `error` is the ``Error`` object for the error.
The default action is to insert an HTML snippet at the location of The default action is to insert an HTML snippet at the location of
the script, but this routine can be overriden durring MathJax the script, but this routine can be overriden during MathJax
configuration in order to perform some other action. configuration in order to perform some other action.
``MathJax.Hub.lastError`` holds the ``error`` value of the last ``MathJax.Hub.lastError`` holds the ``error`` value of the last
error on the page. error on the page.

14
docs/source/api/index.rst
View File

@ -7,12 +7,14 @@ The MathJax API
The following links document the various components that make up The following links document the various components that make up
MathJax. These are implemented as JavaScript objects contained within MathJax. These are implemented as JavaScript objects contained within
the single global variable, ``MathJax``. Although JavaScript includes the single global variable, ``MathJax``. Although JavaScript includes
an objects with some inheritance capabilities, they do not constitute an object system with some inheritance capabilities, they do not
a full object-oriented programming model, so MathJax implements constitute a full object-oriented programming model, so MathJax
its own object library. This means there is an ambiguity when we implements its own object library. This means there is an ambiguity
speak of an "object", as it could be either a native JavaScript when we speak of an "object", as it could be either a native
object, or a MathJax object. We will use `Object` (capitalized) or JavaScript object, or a MathJax object. When the distinction is
`MathJax.Object` for, when the distinction is important. importat, we will use `Object` (capitalized) or `MathJax.Object` for
the latter; the javascript object will always be listed in lower
case.
You may also want to view the :ref:`advanced topics <advanced-topics>` You may also want to view the :ref:`advanced topics <advanced-topics>`
on the main MathJax documentation page. on the main MathJax documentation page.

2
docs/source/api/inputjax.rst
View File

@ -45,7 +45,7 @@ Properties
.. describe:: directory .. describe:: directory
The directory where the jax files are stored (e.g., ``"[MathJax]/jax/input/TeX"``); The directory where the jax files are stored (e.g., ``"[MathJax]/jax/input/TeX"``).
.. describe:: elementJax .. describe:: elementJax

12
docs/source/api/jax.rst
View File

@ -28,7 +28,7 @@ Class Properties
.. describe:: directory .. describe:: directory
The name of the jax directory (usually ``"[MathJax]/jax"). The name of the jax directory (usually ``"[MathJax]/jax"``).
Overridden in the subclass to be the specific directory for the Overridden in the subclass to be the specific directory for the
class, e.g. ``"[MathJax]/jax/input"``. class, e.g. ``"[MathJax]/jax/input"``.
@ -73,7 +73,7 @@ Methods
This is the method that the ``MathJax.Hub`` calls when it needs the This is the method that the ``MathJax.Hub`` calls when it needs the
input or output jax to process the given math ``<script>``. Its input or output jax to process the given math ``<script>``. Its
default action is to start loading the jax's ``jax.js`` file, and default action is to start loading the jax's ``jax.js`` file, and
redefine itself to simplu return the callback for the laod operation redefine itself to simply return the callback for the load operation
(so that further calls to it will cause the processing to wait for the (so that further calls to it will cause the processing to wait for the
callback). Once the ``jax.js`` file has loaded, this method is callback). Once the ``jax.js`` file has loaded, this method is
replaced by the jax's :meth:`Translate()` method, so that subsequent calls replaced by the jax's :meth:`Translate()` method, so that subsequent calls
@ -89,11 +89,11 @@ Methods
This is a stub for a routine that should be defined by the jax's This is a stub for a routine that should be defined by the jax's
``jax.js`` file when it is loaded. It should perform the translation ``jax.js`` file when it is loaded. It should perform the translation
action for the specific jax. For an input jax, it should return the action for the specific jax. For an input jax, it should return the
`ElementJax` object that it created. The :meth:`Translate()` mehtod is `ElementJax` object that it created. The :meth:`Translate()` method is
never called directly by MathJax; during the :meth:`loadComplete()` never called directly by MathJax; during the :meth:`loadComplete()`
call, this funciton is copied to the :meth:`Process()` method, and is call, this function is copied to the :meth:`Process()` method, and is
called via that name. The default :meth:`Translate()` method throws an called via that name. The default :meth:`Translate()` method throws an
error indicating that the :meth:`Translate()` meth was not been error indicating that the :meth:`Translate()` method was not
redefined. That way, if the ``jax.js`` file fails to load for some redefined. That way, if the ``jax.js`` file fails to load for some
reason, you will receive an error trying to process mathematics with reason, you will receive an error trying to process mathematics with
this jax. this jax.
@ -147,7 +147,7 @@ Methods
5. Post the "[name] Jax Startup" message to the startup signal. 5. Post the "[name] Jax Startup" message to the startup signal.
6. Perform the jax's :meth:`Startup()` method. 6. Perform the jax's :meth:`Startup()` method.
7. Post the "[name] Jax Ready" message to the startup signal. 7. Post the "[name] Jax Ready" message to the startup signal.
8. perform the :meth:`MathJax.Ajax.loadComplete()` call for the 8. Perform the :meth:`MathJax.Ajax.loadComplete()` call for the
``jax.js`` file. ``jax.js`` file.
Note that the configuration process (the :meth:`Config()` call) can Note that the configuration process (the :meth:`Config()` call) can

10
docs/source/api/message.rst
View File

@ -25,7 +25,7 @@ set via
}); });
Because of a bug in Internet Explorer, in order to change the side of Because of a bug in Internet Explorer, in order to change the side of
the screen where the the message occurs, you must also set the side the screen where the message occurs, you must also set the side
for ``#MathJax_MSIE_Frame``, as in for ``#MathJax_MSIE_Frame``, as in
.. code-block:: javascript .. code-block:: javascript
@ -44,7 +44,7 @@ displayed on screen, it gets an id number that is used when you want
to remove or change that message. That way, when a message is to remove or change that message. That way, when a message is
removed, the previous message (if any) can be redisplayed if it hasn't removed, the previous message (if any) can be redisplayed if it hasn't
been removed. This allows for intermittent messages (like file been removed. This allows for intermittent messages (like file
loading messages) to obscure longer-term message (like "Processing loading messages) to obscure longer-term messages (like "Processing
Math" messages) temporarily. Math" messages) temporarily.
@ -92,14 +92,14 @@ Methods
directory). directory).
:Parameters: :Parameters:
- **file** --- the name of the file being loaded. - **file** --- the name of the file being loaded
:Returns: the message id number for the message created. :Returns: the message id number for the message created
.. method:: filterText(text,n) .. method:: filterText(text,n)
This method is called on each message before it is displayed. It can This method is called on each message before it is displayed. It can
be used to modify (e.g., shorten) the various messages before they are be used to modify (e.g., shorten) the various messages before they are
displayed. The default action is to check of the ``messageStyle`` displayed. The default action is to check if the ``messageStyle``
configuration parameter is ``simple``, and if so, convert loading and configuration parameter is ``simple``, and if so, convert loading and
processing messages to a simpler form. This method can be overridden processing messages to a simpler form. This method can be overridden
to perform other sanitization of the message strings. to perform other sanitization of the message strings.

6
docs/source/api/queue.rst
View File

@ -6,7 +6,7 @@ The MathJax.Callback.Queue Class
The ``MathJax.Callback.Queue`` object is one of the key mechanisms The ``MathJax.Callback.Queue`` object is one of the key mechanisms
used by MathJax to synchronize its actions with those that occur used by MathJax to synchronize its actions with those that occur
asynchronously, like loading files and stylesheets. A `Queue` obejct asynchronously, like loading files and stylesheets. A `Queue` object
is used to coordinate a sequence of actions so that they are performed is used to coordinate a sequence of actions so that they are performed
one after another, even when one action has to wait for an one after another, even when one action has to wait for an
asynchronous process to complete. This guarantees that operations are asynchronous process to complete. This guarantees that operations are
@ -66,7 +66,7 @@ Methods
.. method:: Suspend() .. method:: Suspend()
Increments the `running` property, indicating that any commands that Increments the `running` property, indicating that any commands that
are added the queue should not be executed immediately, but should are added to the queue should not be executed immediately, but should
be queued for later execution (when its :meth:`Resume()` is be queued for later execution (when its :meth:`Resume()` is
called). This method is used internally; you should not need to called). This method is used internally; you should not need to
call it yourself. call it yourself.
@ -86,7 +86,7 @@ Methods
(passing it the original callback) is queued instead, and it (passing it the original callback) is queued instead, and it
simply returns the callback it was passed. Since the queue will simply returns the callback it was passed. Since the queue will
wait for a callback if it is the return value of one of the wait for a callback if it is the return value of one of the
commands it executes, this effectively make the queue wait for the commands it executes, this effectively makes the queue wait for the
original callback at that point in the command queue. original callback at that point in the command queue.
:Parameters: :Parameters:

14
docs/source/api/signal.rst
View File

@ -7,9 +7,9 @@ The MathJax.Callback.Signal Class
The ``MathJax.Callback.Signal`` object is one of the key mechanisms The ``MathJax.Callback.Signal`` object is one of the key mechanisms
used by MathJax to synchronize its actions with those that occur used by MathJax to synchronize its actions with those that occur
asynchronously, like loading files and stylesheets. A `Signal` object asynchronously, like loading files and stylesheets. A `Signal` object
is used to pulicise the fact that MathJax has performed certain is used to publicize the fact that MathJax has performed certain
actions, giving other code running the the web page the chance to actions, giving other code running the web page the chance to react to
react to those actions. See :ref:`Synchronizing with MathJax those actions. See :ref:`Synchronizing with MathJax
<synchronization>` for more details, and :ref:`Using Signals <synchronization>` for more details, and :ref:`Using Signals
<using-signals>` in particular for examples of how to specify and use <using-signals>` in particular for examples of how to specify and use
MathJax `Signal` objects. MathJax `Signal` objects.
@ -30,7 +30,7 @@ Properties
.. describe:: posted .. describe:: posted
Array used internally to stored the post history so that when new Array used internally to store the post history so that when new
listeners express interests in this signal, they can be informed listeners express interests in this signal, they can be informed
of the signals that have been posted so far. This can be cleared of the signals that have been posted so far. This can be cleared
using the signal's :meth:`Clear()` method. using the signal's :meth:`Clear()` method.
@ -39,7 +39,7 @@ Properties
Array of callbacks to the listeners who have expressed interest in Array of callbacks to the listeners who have expressed interest in
hearing about posts to this signal. When a post occurs, the hearing about posts to this signal. When a post occurs, the
listeners are called in each turn, passing them the message that listeners are called, each in turn, passing them the message that
was posted. was posted.
@ -51,7 +51,7 @@ Methods
Posts a message to all the listeners for the signal. The listener Posts a message to all the listeners for the signal. The listener
callbacks are called in turn (with the message as an argument), callbacks are called in turn (with the message as an argument),
and if any return a `Callback` object, the posting will be and if any return a `Callback` object, the posting will be
suspended until the callback is exectured. In this way, the suspended until the callback is executed. In this way, the
:meth:`Post()` call can operate asynchronously, and so the :meth:`Post()` call can operate asynchronously, and so the
`callback` parameter is used to synchronize with its operation; `callback` parameter is used to synchronize with its operation;
the `callback` will be called when all the listeners have responded the `callback` will be called when all the listeners have responded
@ -133,7 +133,7 @@ Methods
function that must check the message each time it is called. function that must check the message each time it is called.
Although the `message` here is a string, if a message posted to the Although the `message` here is a string, if a message posted to the
signal is an array, then only the first element of that array is signal is an array, then only the first element of that array is
used to match against message. That way, if a message contains an used to match against the message. That way, if a message contains an
identifier plus arguments, the hook will match the identifier and identifier plus arguments, the hook will match the identifier and
still get called with the complete set of arguments. still get called with the complete set of arguments.

4
docs/source/api/variable.rst
View File

@ -24,7 +24,7 @@ Main MathJax Components
.. describe:: MathJax.Message .. describe:: MathJax.Message
Contains the code to handle the intermittant message window that Contains the code to handle the intermittent message window that
periodically appears in the lower left-hand corner of the window. periodically appears in the lower left-hand corner of the window.
.. describe:: MathJax.HTML .. describe:: MathJax.HTML
@ -65,7 +65,7 @@ Main MathJax Components
.. describe:: MathJax.ElementJax .. describe:: MathJax.ElementJax
The base class for all element `jax` objects. Subclasses for The base class for all element `jax` objects. Subclasses for
specific element jax are creates as sub-objects of specific element jax are created as sub-objects of
``MathJax.ElementJax``. For example, the mml element jax loads ``MathJax.ElementJax``. For example, the mml element jax loads
itself as ``MathJax.ElementJax.mml``. itself as ``MathJax.ElementJax.mml``.

2
docs/source/glossary.rst
View File

@ -29,7 +29,7 @@ Glossary
particular message is sent along the signal channel. particular message is sent along the signal channel.
HTML-CSS HTML-CSS
MathJax output form that employs only on HTML and CSS 2.1, MathJax output form that relys only on HTML and CSS 2.1,
allowing MathJax to remain compatible across all browsers. allowing MathJax to remain compatible across all browsers.
jax jax

2
docs/source/start.rst
View File

@ -227,7 +227,7 @@ math mode, you must enable that explicitly in your configuration:
tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]} tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]}
}); });
</script> </script>
<script type="text/javascipt" src="path-to-mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> <script type="text/javascript" src="path-to-mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
See the ``config/default.js`` file, or the :ref:`tex2jax configuration See the ``config/default.js`` file, or the :ref:`tex2jax configuration
options <configure-tex2jax>` page, for additional configuration options <configure-tex2jax>` page, for additional configuration