Fix spelling and grammar typos in docs
This commit is contained in:
parent
99ef8710cc
commit
85975e7880
|
@ -55,7 +55,7 @@ Properties
|
||||||
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.
|
||||||
|
|
|
@ -7,7 +7,7 @@ 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
|
objects with some inheritance capabilities, they do not constitute
|
||||||
a full object-oriented programming model, so MathJax implements
|
a full object-oriented programming model, so MathJax implements
|
||||||
its own object library. This means there is an ambiguity when we
|
its own object library. This means there is an ambiguity when we
|
||||||
speak of an "object", as it could be either a native JavaScript
|
speak of an "object", as it could be either a native JavaScript
|
||||||
|
|
|
@ -88,7 +88,7 @@ Methods
|
||||||
This is a temporary routine that is used while the ``jax.js`` file
|
This is a temporary routine that is used while the ``jax.js`` file
|
||||||
is loading. It throws an error indicating the the
|
is loading. It throws an error indicating the the
|
||||||
:meth:`Translate()` method hasn't been redefined. That way, if
|
:meth:`Translate()` method hasn't been redefined. That way, if
|
||||||
the ``jax.js`` file failes to load for some reason, you will
|
the ``jax.js`` file fails to load for some reason, you will
|
||||||
receive an error trying to process mathematics with this input
|
receive an error trying to process mathematics with this input
|
||||||
jax.
|
jax.
|
||||||
|
|
||||||
|
|
|
@ -65,8 +65,8 @@ Methods
|
||||||
:Parameters:
|
:Parameters:
|
||||||
- **message** --- the text to display in the message area
|
- **message** --- the text to display in the message area
|
||||||
- **n** --- the message id number
|
- **n** --- the message id number
|
||||||
- **delay** --- amout of time to display the message
|
- **delay** --- amount of time to display the message
|
||||||
:Returns: the message id nuber for this message.
|
:Returns: the message id number for this message.
|
||||||
|
|
||||||
.. method:: Clear(n[,delay])
|
.. method:: Clear(n[,delay])
|
||||||
|
|
||||||
|
|
|
@ -36,8 +36,8 @@ and wait for them all to be loaded before performing some action, you
|
||||||
can create a `Queue` into which you push the results of the
|
can create a `Queue` into which you push the results of the
|
||||||
:meth:`MathJax.Ajax.Require()` calls, and then push a callback for the
|
:meth:`MathJax.Ajax.Require()` calls, and then push a callback for the
|
||||||
action. The final action will not be performed until all the
|
action. The final action will not be performed until all the
|
||||||
file-load callbacks (which preceed it int he queue) have been called;
|
file-load callbacks (which preceed it in the queue) have been called;
|
||||||
i.e., the action will not occur until all the files are loaded.
|
i.e. the action will not occur until all the files are loaded.
|
||||||
|
|
||||||
|
|
||||||
Specifying a Callback
|
Specifying a Callback
|
||||||
|
@ -199,7 +199,7 @@ information about the valid methods of specifying a callback.
|
||||||
Creating a Callback Explicitly
|
Creating a Callback Explicitly
|
||||||
==============================
|
==============================
|
||||||
|
|
||||||
When you call a method that accpets a callback, you usually pass it a
|
When you call a method that accepts a callback, you usually pass it a
|
||||||
callback specification (like in the examples above), which *describes*
|
callback specification (like in the examples above), which *describes*
|
||||||
a callback (the method will create the actual `Callback` object, and
|
a callback (the method will create the actual `Callback` object, and
|
||||||
return that to you as its return value). You don't usually create
|
return that to you as its return value). You don't usually create
|
||||||
|
@ -212,8 +212,8 @@ argument, and you may want that function to be a method of an object,
|
||||||
and would run into the problem described in the previous section if
|
and would run into the problem described in the previous section if
|
||||||
you simply passed the object's method to ``setTimeout()``. Or you
|
you simply passed the object's method to ``setTimeout()``. Or you
|
||||||
might want to pass an argument to the function called by
|
might want to pass an argument to the function called by
|
||||||
``setTimeout()``. (Altough the ``setTimeout()`` function can accept
|
``setTimeout()``. (Although the ``setTimeout()`` function can accept
|
||||||
additional arguements that are supposed to be passed on to the code
|
additional arguments that are supposed to be passed on to the code
|
||||||
when it is called, Internet Explorer does not implement that feature,
|
when it is called, Internet Explorer does not implement that feature,
|
||||||
so you can't rely on it.) You can use a `Callback` object to
|
so you can't rely on it.) You can use a `Callback` object to
|
||||||
do this, and the :meth:`MathJax.Callback()` method will create one for
|
do this, and the :meth:`MathJax.Callback()` method will create one for
|
||||||
|
|
|
@ -7,7 +7,7 @@ the wider community of MathJax users. The MathJax project maintains
|
||||||
forums where users can ask questions about how to use MathJax, make
|
forums where users can ask questions about how to use MathJax, make
|
||||||
suggestions about future features for MathJax, and present their own
|
suggestions about future features for MathJax, and present their own
|
||||||
solutions to problems that they have faced. There is also a
|
solutions to problems that they have faced. There is also a
|
||||||
bug-traking system where you can report errors that you have found
|
bug-tracking system where you can report errors that you have found
|
||||||
with MathJax in your environment.
|
with MathJax in your environment.
|
||||||
|
|
||||||
|
|
||||||
|
@ -47,7 +47,7 @@ and `existing tickets
|
||||||
first to see if it has already been reported.
|
first to see if it has already been reported.
|
||||||
You could also be using an outdated version of MathJax, so be sure to
|
You could also be using an outdated version of MathJax, so be sure to
|
||||||
:ref:`upgrade your copy <getting-mathjax-svn>` to verify that the
|
:ref:`upgrade your copy <getting-mathjax-svn>` to verify that the
|
||||||
problem persists in the lastest version.
|
problem persists in the latest version.
|
||||||
|
|
||||||
|
|
||||||
.. _badge:
|
.. _badge:
|
||||||
|
|
|
@ -244,7 +244,7 @@ plugin <http://www.dessci.com/en/products/mathplayer/>`_ installed
|
||||||
will use the NativeMML output processor, while all other browsers will
|
will use the NativeMML output processor, while all other browsers will
|
||||||
use the HTML-CSS output processor. Since native MathML support is
|
use the HTML-CSS output processor. Since native MathML support is
|
||||||
faster than MathJax's HTML-CSS processor, this will mean that the web
|
faster than MathJax's HTML-CSS processor, this will mean that the web
|
||||||
pages will display faster for Firefox and IE than they woudl
|
pages will display faster for Firefox and IE than they would
|
||||||
otherwise. This speed comes at the cost, however, as you are now
|
otherwise. This speed comes at the cost, however, as you are now
|
||||||
relying on the native MathML support to render the mathematics, and
|
relying on the native MathML support to render the mathematics, and
|
||||||
that is outside of MathJax's control. There may be spacing or other
|
that is outside of MathJax's control. There may be spacing or other
|
||||||
|
@ -325,7 +325,7 @@ For example,
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
is a configration that includes two settings for the MathJax Hub (one
|
is a configuration that includes two settings for the MathJax Hub (one
|
||||||
for `showProcessingMessages` and one of the `jax` array), and a
|
for `showProcessingMessages` and one of the `jax` array), and a
|
||||||
configuration object for the TeX input processor. The latter includes
|
configuration object for the TeX input processor. The latter includes
|
||||||
a setting for the TeX input processor's `TagSide` option (to set tags
|
a setting for the TeX input processor's `TagSide` option (to set tags
|
||||||
|
|
|
@ -105,7 +105,7 @@ of a copy of MathJax from your own server.
|
||||||
Here is a script that runs MathJax in any document that contains
|
Here is a script that runs MathJax in any document that contains
|
||||||
MathML (whether its includes MathJax or not). That allows
|
MathML (whether its includes MathJax or not). That allows
|
||||||
browsers that don't have native MathML support to view any web pages
|
browsers that don't have native MathML support to view any web pages
|
||||||
with MathML, even if they say it only works in Forefox and
|
with MathML, even if they say it only works in Firefox and
|
||||||
IE+MathPlayer.
|
IE+MathPlayer.
|
||||||
|
|
||||||
.. code-block:: javascript
|
.. code-block:: javascript
|
||||||
|
|
|
@ -49,7 +49,7 @@ use
|
||||||
rm -rf fonts
|
rm -rf fonts
|
||||||
unzip fonts.zip
|
unzip fonts.zip
|
||||||
|
|
||||||
to udpate your copy of MathJax to the current release version. If the
|
to update your copy of MathJax to the current release version. If the
|
||||||
``fonts.zip`` file has been updated, you will need to remove the old
|
``fonts.zip`` file has been updated, you will need to remove the old
|
||||||
fonts directory and unpack the new one bring your installation up to
|
fonts directory and unpack the new one bring your installation up to
|
||||||
date. If you keep MathJax updated in this way, you will be sure that
|
date. If you keep MathJax updated in this way, you will be sure that
|
||||||
|
@ -64,7 +64,7 @@ may not include all the latest patches and features), use
|
||||||
|
|
||||||
.. code-block:: sh
|
.. code-block:: sh
|
||||||
|
|
||||||
svn co http://mathjax.svn.sourcesforge.net/svnroot/mathjax/tags/mathjax-1.0 mathajx
|
svn co http://mathjax.svn.sourceforge.net/svnroot/mathjax/tags/mathjax-1.0 mathjax
|
||||||
cd mathjax
|
cd mathjax
|
||||||
unzip fonts.zip
|
unzip fonts.zip
|
||||||
|
|
||||||
|
@ -129,10 +129,10 @@ a different site. For example, a departmental server at
|
||||||
``www.math.yourcollege.edu`` might like to use a college-wide
|
``www.math.yourcollege.edu`` might like to use a college-wide
|
||||||
installation at ``www.yourcollege.edu`` rather than installing a
|
installation at ``www.yourcollege.edu`` rather than installing a
|
||||||
separate copy on the departmental machine. MathJax can certainly
|
separate copy on the departmental machine. MathJax can certainly
|
||||||
be loaded from another server, but there is one imporant caveat ---
|
be loaded from another server, but there is one important caveat ---
|
||||||
Firefox's same-origin security policy for cross-domain scripting.
|
Firefox's same-origin security policy for cross-domain scripting.
|
||||||
|
|
||||||
Firefox’s interpretation of the same-origin policy is more strict than
|
Firefox's interpretation of the same-origin policy is more strict than
|
||||||
most other browsers, and it affects how fonts are loaded with the
|
most other browsers, and it affects how fonts are loaded with the
|
||||||
`@font-face` CSS directive. MathJax uses this directive to load
|
`@font-face` CSS directive. MathJax uses this directive to load
|
||||||
web-based math fonts into a page when the user doesn't have them
|
web-based math fonts into a page when the user doesn't have them
|
||||||
|
@ -162,7 +162,7 @@ server <http://www.apache.org/>`_. In the remote server's
|
||||||
|
|
||||||
and make sure the permissions allow the server to read this file.
|
and make sure the permissions allow the server to read this file.
|
||||||
(The file's name starts with a period, which causes it to be an
|
(The file's name starts with a period, which causes it to be an
|
||||||
"invisible" file on unix-based operating systems. Some systems,
|
"invisible" file on UNIX-based operating systems. Some systems,
|
||||||
particularly graphic user interfaces, may not allow you to create such
|
particularly graphic user interfaces, may not allow you to create such
|
||||||
files, so you might need to use the command-line interface to
|
files, so you might need to use the command-line interface to
|
||||||
accomplish this.)
|
accomplish this.)
|
||||||
|
|
|
@ -36,7 +36,7 @@ mathematics so that the browser will render it as MathML. In
|
||||||
addition, MathJax provides its contextual menu for the MathML, which
|
addition, MathJax provides its contextual menu for the MathML, which
|
||||||
lets the user zoom the mathematics for easier reading, get the copy
|
lets the user zoom the mathematics for easier reading, get the copy
|
||||||
the source markup, and so on, so there is added value to using MathJax
|
the source markup, and so on, so there is added value to using MathJax
|
||||||
even whith a pure MathML workflow.
|
even with a pure MathML workflow.
|
||||||
|
|
||||||
|
|
||||||
MathML in HTML pages
|
MathML in HTML pages
|
||||||
|
@ -44,7 +44,7 @@ MathML in HTML pages
|
||||||
|
|
||||||
For MathML that is handled via the pre-processor, you should not use
|
For MathML that is handled via the pre-processor, you should not use
|
||||||
the named MathML entities, but rather use the numeric entities like
|
the named MathML entities, but rather use the numeric entities like
|
||||||
``√`` or unicode characters embedded in the page itself. The
|
``√`` or Unicode characters embedded in the page itself. The
|
||||||
reason is that entities are replaced by the browser before MathJax
|
reason is that entities are replaced by the browser before MathJax
|
||||||
runs, and some browsers report errors for unknown entities. For
|
runs, and some browsers report errors for unknown entities. For
|
||||||
browsers that are not MathML-aware, that will cause errors to be
|
browsers that are not MathML-aware, that will cause errors to be
|
||||||
|
@ -55,7 +55,7 @@ If you must use named entities, you may need to declare them in the
|
||||||
`DOCTYPE` declaration by hand.
|
`DOCTYPE` declaration by hand.
|
||||||
|
|
||||||
When you use MathML in an HTML document rather than an XHTML one
|
When you use MathML in an HTML document rather than an XHTML one
|
||||||
(MathJax will work woth both), you should not use the "self-closing"
|
(MathJax will work with both), you should not use the "self-closing"
|
||||||
form for tags with no content, but should use separate open and close
|
form for tags with no content, but should use separate open and close
|
||||||
tags. That is, use
|
tags. That is, use
|
||||||
|
|
||||||
|
|
|
@ -46,7 +46,7 @@ directly, as described below, rather than having MathJax run
|
||||||
another preprocessor. This will speed up the final display of the
|
another preprocessor. This will speed up the final display of the
|
||||||
mathematics, since the extra preprocessing step would not be needed,
|
mathematics, since the extra preprocessing step would not be needed,
|
||||||
and it also avoids the conflict between the use of the less-than sign,
|
and it also avoids the conflict between the use of the less-than sign,
|
||||||
``<``, in mathematics and asn an HTML special character (that starts
|
``<``, in mathematics and as a special character in HTML (that starts
|
||||||
an HTML tag).
|
an HTML tag).
|
||||||
|
|
||||||
|
|
||||||
|
@ -194,7 +194,7 @@ jax acts as a translator into MathML.
|
||||||
output format. For example, the NativeMML output jax inserts MathML
|
output format. For example, the NativeMML output jax inserts MathML
|
||||||
tags into the page to represent the mathematics, while the HTML-CSS
|
tags into the page to represent the mathematics, while the HTML-CSS
|
||||||
output jax uses HTML with CSS styling to lay out the mathematics so
|
output jax uses HTML with CSS styling to lay out the mathematics so
|
||||||
that it can be displayed even in browsers that dont understand
|
that it can be displayed even in browsers that don't understand
|
||||||
MathML. Output jax could be produced that render the mathematics
|
MathML. Output jax could be produced that render the mathematics
|
||||||
using SVG, for example, or that speak an equation for the blind
|
using SVG, for example, or that speak an equation for the blind
|
||||||
users. The MathJax contextual menu can be used to switch between the
|
users. The MathJax contextual menu can be used to switch between the
|
||||||
|
|
|
@ -75,7 +75,7 @@ fill that in for you based on the abilities of your user's browser.
|
||||||
|
|
||||||
You can customize which choice to make on a browser-by-browser basis
|
You can customize which choice to make on a browser-by-browser basis
|
||||||
or a global basis. See the ``config/MathJax.js`` file or the
|
or a global basis. See the ``config/MathJax.js`` file or the
|
||||||
:ref:`Configuring MathJax <configuration>` section for futher
|
:ref:`Configuring MathJax <configuration>` section for further
|
||||||
details.
|
details.
|
||||||
|
|
||||||
MathJax produces MathML that models the underlying mathematics as best
|
MathJax produces MathML that models the underlying mathematics as best
|
||||||
|
@ -84,8 +84,7 @@ particular MathML implementation. When you make the choice to use the
|
||||||
NativeMML output processor, you are making a trade-off: gaining speed
|
NativeMML output processor, you are making a trade-off: gaining speed
|
||||||
at the expense of quality and reliability, a decision that should not
|
at the expense of quality and reliability, a decision that should not
|
||||||
be taken lightly. Note, however, that a user can employ the MathJax
|
be taken lightly. Note, however, that a user can employ the MathJax
|
||||||
contectual menu to select the other other renderer if he or she
|
contextual menu to select the other renderer if he or she wishes.
|
||||||
wishes.
|
|
||||||
|
|
||||||
|
|
||||||
.. _html-css-with-ie8:
|
.. _html-css-with-ie8:
|
||||||
|
@ -115,11 +114,11 @@ mode. You can accomplish this by including the line
|
||||||
|
|
||||||
at the top of the ``<head>`` section of your HTML documents. This
|
at the top of the ``<head>`` section of your HTML documents. This
|
||||||
lets you keep the strict `DOCTYPE` for validation purposes, while
|
lets you keep the strict `DOCTYPE` for validation purposes, while
|
||||||
still managing to get reasonable perforance from Internet Explorer
|
still managing to get reasonable performance from Internet Explorer
|
||||||
8. Note that this line must come at the beginning of the ``<head>``,
|
8. Note that this line must come at the beginning of the ``<head>``,
|
||||||
before any stylesheets or other content are loaded.
|
before any stylesheets or other content are loaded.
|
||||||
|
|
||||||
Altertnatively, you can use the `MMLorHTML` configuration file
|
Alternatively, you can use the `MMLorHTML` configuration file
|
||||||
described above to select NativeMML output when possible, and request
|
described above to select NativeMML output when possible, and request
|
||||||
that your users install the `MathPlayer plugin
|
that your users install the `MathPlayer plugin
|
||||||
<http://www.dessci.com/en/products/mathplayer/>`_, which will render
|
<http://www.dessci.com/en/products/mathplayer/>`_, which will render
|
||||||
|
|
|
@ -8,7 +8,7 @@ The `callback queue` is one of MathJax's main tools for synchronizing
|
||||||
its actions, both internally, and with external programs, like
|
its actions, both internally, and with external programs, like
|
||||||
javascript code that you may write as part of dynamic web pages.
|
javascript code that you may write as part of dynamic web pages.
|
||||||
Because many actions in MathJax (like loading files) operate
|
Because many actions in MathJax (like loading files) operate
|
||||||
asynchornously, MathJax needs a way to coordinate those actions so
|
asynchronously, MathJax needs a way to coordinate those actions so
|
||||||
that they occur in the right order. The
|
that they occur in the right order. The
|
||||||
`MathJax.Callback.Queue` object provides that mechanism.
|
`MathJax.Callback.Queue` object provides that mechanism.
|
||||||
|
|
||||||
|
@ -197,13 +197,13 @@ instead are defined in extensions that are loaded automatically when
|
||||||
needed. The typesetting of an expression containing one of these TeX
|
needed. The typesetting of an expression containing one of these TeX
|
||||||
commands can cause the typesetting process to be suspended while the
|
commands can cause the typesetting process to be suspended while the
|
||||||
file is loaded, and then restarted when the extension has become
|
file is loaded, and then restarted when the extension has become
|
||||||
evailable.
|
available.
|
||||||
|
|
||||||
As a result, any call to :meth:`MathJax.Hub.Typeset()` (or
|
As a result, any call to :meth:`MathJax.Hub.Typeset()` (or
|
||||||
:meth:`MathJax.Hub.Process()`, or :meth:`MathJax.Hub.Update()`, etc.)
|
:meth:`MathJax.Hub.Process()`, or :meth:`MathJax.Hub.Update()`, etc.)
|
||||||
could return long before the mathematics is actually typeset, and the
|
could return long before the mathematics is actually typeset, and the
|
||||||
rest of your code may run before the mathematics is available. If you
|
rest of your code may run before the mathematics is available. If you
|
||||||
have code that relys on the mathematics being visible on screen, you
|
have code that relies on the mathematics being visible on screen, you
|
||||||
will need to break that out into a separate operation that is
|
will need to break that out into a separate operation that is
|
||||||
synchronized with the typesetting via the MathJax queue.
|
synchronized with the typesetting via the MathJax queue.
|
||||||
|
|
||||||
|
|
|
@ -59,7 +59,7 @@ have the listener perform the configuration when the message arrives.
|
||||||
But even if the extension *has* already been loaded, this will still
|
But even if the extension *has* already been loaded, this will still
|
||||||
work, because the listener will receive the ready signal even if it
|
work, because the listener will receive the ready signal even if it
|
||||||
has already been posted. In this way, listening for signals is a
|
has already been posted. In this way, listening for signals is a
|
||||||
robust method of synchonizing code components no matter when they are
|
robust method of synchronizing code components no matter when they are
|
||||||
loaded and run.
|
loaded and run.
|
||||||
|
|
||||||
In some cases, it may be inappropriate for a new listener to receive
|
In some cases, it may be inappropriate for a new listener to receive
|
||||||
|
@ -106,7 +106,7 @@ details of the messages sent during startup. See also the
|
||||||
``test/sample-signals.html`` file (and its source) for examples of
|
``test/sample-signals.html`` file (and its source) for examples of
|
||||||
using signals. This example lists all the signals that occur while
|
using signals. This example lists all the signals that occur while
|
||||||
MathJax is processing that page, so it gives useful information about
|
MathJax is processing that page, so it gives useful information about
|
||||||
the details of the signals produced by variuous components.
|
the details of the signals produced by various components.
|
||||||
|
|
||||||
In this example, the listener starts loading an extra configuration
|
In this example, the listener starts loading an extra configuration
|
||||||
file (from the same directory as the web page). Since it returns
|
file (from the same directory as the web page). Since it returns
|
||||||
|
|
|
@ -79,7 +79,7 @@ the ``AMSmath`` and ``AMSsymbols`` extensions. The comments in the
|
||||||
file should help you do this, but more detailed instructions are
|
file should help you do this, but more detailed instructions are
|
||||||
included in the :ref:`Configuring MathJax <configuration>` document.
|
included in the :ref:`Configuring MathJax <configuration>` document.
|
||||||
There are also ways to configure MathJax other than by using the
|
There are also ways to configure MathJax other than by using the
|
||||||
``config/MathJax.js`` file; these are descibed on that page as well.
|
``config/MathJax.js`` file; these are described on that page as well.
|
||||||
|
|
||||||
|
|
||||||
Linking MathJax into a web page
|
Linking MathJax into a web page
|
||||||
|
|
|
@ -29,7 +29,7 @@ how to specify a callback.
|
||||||
**Queues** are MathJax's means of synchronizing actions that must be
|
**Queues** are MathJax's means of synchronizing actions that must be
|
||||||
performed sequentially, even when they involve asynchronous events
|
performed sequentially, even when they involve asynchronous events
|
||||||
like loading files or dynamically creating stylesheets. The actions
|
like loading files or dynamically creating stylesheets. The actions
|
||||||
that you put in the queue are `Callback` objects that will be perfomed
|
that you put in the queue are `Callback` objects that will be performed
|
||||||
in sequence, with MathJax handling the linking of one action to the
|
in sequence, with MathJax handling the linking of one action to the
|
||||||
next. MathJax maintains a master queue that you can use to
|
next. MathJax maintains a master queue that you can use to
|
||||||
synchronize with MathJax, but you can also create your own private
|
synchronize with MathJax, but you can also create your own private
|
||||||
|
@ -48,7 +48,7 @@ This works somewhat like an event handler, except that many different
|
||||||
types of events can go through the same signal, and the signals have a
|
types of events can go through the same signal, and the signals have a
|
||||||
"memory", meaning that if you register an interest in a particular
|
"memory", meaning that if you register an interest in a particular
|
||||||
type of signal and that signal has already occurred, you will be told
|
type of signal and that signal has already occurred, you will be told
|
||||||
about the past occurrances as well as any future ones. See the
|
about the past occurrences as well as any future ones. See the
|
||||||
:ref:`Signal Object <api-signal>` reference page for more details.
|
:ref:`Signal Object <api-signal>` reference page for more details.
|
||||||
See also the ``test/sample-signals.html`` file in the MathJax ``test``
|
See also the ``test/sample-signals.html`` file in the MathJax ``test``
|
||||||
directory for a working example of using signals.
|
directory for a working example of using signals.
|
||||||
|
|
|
@ -55,7 +55,7 @@ example,
|
||||||
|
|
||||||
... when $x<y$ we have ...
|
... when $x<y$ we have ...
|
||||||
|
|
||||||
will cause a problem, because the brower will think ``<y`` is the
|
will cause a problem, because the browser will think ``<y`` is the
|
||||||
beginning of a tag named ``y`` (even though there is no such tag in
|
beginning of a tag named ``y`` (even though there is no such tag in
|
||||||
HTML). When this happens, the browser will think the tag continues up
|
HTML). When this happens, the browser will think the tag continues up
|
||||||
to the next ``>`` in the document (typically the end of the next
|
to the next ``>`` in the document (typically the end of the next
|
||||||
|
@ -63,7 +63,7 @@ actual tag in the HTML file), and you may notice that you are missing
|
||||||
part of the text of the document. In the example above, the `` we
|
part of the text of the document. In the example above, the `` we
|
||||||
have ...`` will not be displayed because the browsers thinks it is
|
have ...`` will not be displayed because the browsers thinks it is
|
||||||
part of the tag starting at ``<y``. This is one indication you can
|
part of the tag starting at ``<y``. This is one indication you can
|
||||||
use to spot this prooblem; it is a common error and should be avoided.
|
use to spot this problem; it is a common error and should be avoided.
|
||||||
|
|
||||||
Usually, it is sufficient to simply put spaces around these symbols to
|
Usually, it is sufficient to simply put spaces around these symbols to
|
||||||
cause the browser to avoid them, so
|
cause the browser to avoid them, so
|
||||||
|
@ -202,7 +202,7 @@ noUndefined
|
||||||
|
|
||||||
The `noUndefined` extension causes undefined control sequences to be
|
The `noUndefined` extension causes undefined control sequences to be
|
||||||
shown as their macro names rather than produce an error message. So
|
shown as their macro names rather than produce an error message. So
|
||||||
``$X_{\xxx}$`` would display as an "X" with a subscript consiting of the
|
``$X_{\xxx}$`` would display as an "X" with a subscript consisting of the
|
||||||
text ``\xxx`` in red.
|
text ``\xxx`` in red.
|
||||||
|
|
||||||
To enable and configure this extension, use for example
|
To enable and configure this extension, use for example
|
||||||
|
@ -243,7 +243,7 @@ Examples:
|
||||||
\unicode{65} % the character 'A'
|
\unicode{65} % the character 'A'
|
||||||
\unicode{x41} % the character 'A'
|
\unicode{x41} % the character 'A'
|
||||||
\unicode[.55,0.05]{x22D6} % less-than with dot, with height .55em and depth 0.05em
|
\unicode[.55,0.05]{x22D6} % less-than with dot, with height .55em and depth 0.05em
|
||||||
\unicode[.55,0.05][Geramond]{x22D6} % same taken from Geramond font
|
\unicode[.55,0.05][Garamond]{x22D6} % same taken from Garamond font
|
||||||
\unicode[Garamond]{x22D6} % same, but with default height, depth of .8em,.2em
|
\unicode[Garamond]{x22D6} % same, but with default height, depth of .8em,.2em
|
||||||
|
|
||||||
Once a size and font are provided for a given unicode point, they need
|
Once a size and font are provided for a given unicode point, they need
|
||||||
|
|
|
@ -14,7 +14,7 @@ then MathJax will look for unprocessed mathematics on the page and
|
||||||
typeset it, leaving unchanged any math that has already been typeset.
|
typeset it, leaving unchanged any math that has already been typeset.
|
||||||
|
|
||||||
You should not simply call this method directly, however. Because
|
You should not simply call this method directly, however. Because
|
||||||
MathJax operates asynchonously (see :ref:`Synchronizing with MathJax
|
MathJax operates asynchronously (see :ref:`Synchronizing with MathJax
|
||||||
<synchronization>` for details), you need to be sure that
|
<synchronization>` for details), you need to be sure that
|
||||||
your call to :meth:`MathJax.Hub.Typeset()` is synchronized with the
|
your call to :meth:`MathJax.Hub.Typeset()` is synchronized with the
|
||||||
other actions that MathJax is taking. For example, it may already be
|
other actions that MathJax is taking. For example, it may already be
|
||||||
|
@ -32,7 +32,7 @@ To queue the typeset action, use the command
|
||||||
This will cause MathJax to typeset the page when it is next able to do
|
This will cause MathJax to typeset the page when it is next able to do
|
||||||
so. It guarantees that the typesetting will synchronize properly
|
so. It guarantees that the typesetting will synchronize properly
|
||||||
with the loading of jax, extensions, fonts, stylesheets, and other
|
with the loading of jax, extensions, fonts, stylesheets, and other
|
||||||
asynchornous activity, and is the only truely safe way to ask MathJax
|
asynchronous activity, and is the only truly safe way to ask MathJax
|
||||||
to process additional material.
|
to process additional material.
|
||||||
|
|
||||||
The :meth:`MathJax.Hub.Typeset()` command also accepts a parameter
|
The :meth:`MathJax.Hub.Typeset()` command also accepts a parameter
|
||||||
|
@ -60,7 +60,7 @@ Note that the :meth:`MathJax.Hub.Queue()` method will return
|
||||||
immediately, regardless of whether the typesetting has taken place or
|
immediately, regardless of whether the typesetting has taken place or
|
||||||
not, so you can not assume that the mathematics is visible after you
|
not, so you can not assume that the mathematics is visible after you
|
||||||
make this call. That means that things like the size of the container
|
make this call. That means that things like the size of the container
|
||||||
for the mathematics may not yet reflect the size of the typeet
|
for the mathematics may not yet reflect the size of the typeset
|
||||||
mathematics. If you need to perform actions that depend on the
|
mathematics. If you need to perform actions that depend on the
|
||||||
mathematics being typeset, you should push *those* actions onto the
|
mathematics being typeset, you should push *those* actions onto the
|
||||||
``MathJax.Hub.queue`` as well.
|
``MathJax.Hub.queue`` as well.
|
||||||
|
@ -140,7 +140,7 @@ The actions you can perform on an element jax include:
|
||||||
.. describe:: SourceElement()
|
.. describe:: SourceElement()
|
||||||
|
|
||||||
to obtain a reference to the original
|
to obtain a reference to the original
|
||||||
``<script>`` object that is assocaited with this element jax.
|
``<script>`` object that is associated with this element jax.
|
||||||
|
|
||||||
|
|
||||||
Note that once you have located an element jax, you can keep using it
|
Note that once you have located an element jax, you can keep using it
|
||||||
|
@ -153,7 +153,7 @@ displayed.
|
||||||
|
|
||||||
To get the element jax the first time, you need to be sure that you
|
To get the element jax the first time, you need to be sure that you
|
||||||
ask MathJax for it **after** MathJax has processed the page the first
|
ask MathJax for it **after** MathJax has processed the page the first
|
||||||
time. This is another sitaution where you want to use the MathJax
|
time. This is another situation where you want to use the MathJax
|
||||||
queue. If your startup code performs the commands
|
queue. If your startup code performs the commands
|
||||||
|
|
||||||
.. code-block:: javascript
|
.. code-block:: javascript
|
||||||
|
|
Loading…
Reference in New Issue
Block a user