diff --git a/docs/html/CSS-styles.html b/docs/html/CSS-styles.html index 31afc0b78..616f24db2 100644 --- a/docs/html/CSS-styles.html +++ b/docs/html/CSS-styles.html @@ -64,7 +64,7 @@ rather than just ul 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 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 by commas (not semi-colons) and the values are enclosed in quotation marks. If the name contains dashes, it should be enclosed in diff --git a/docs/html/HTML-snippets.html b/docs/html/HTML-snippets.html index 1edd0cd0e..ad4167220 100644 --- a/docs/html/HTML-snippets.html +++ b/docs/html/HTML-snippets.html @@ -53,7 +53,7 @@

Describing HTML snippetsΒΆ

A number of MathJax configuration options allow you to specify an HTML 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 complicated HTML trees.

An HTML snippet is an array consisting of a series of elements that format diff --git a/docs/html/_sources/CSS-styles.txt b/docs/html/_sources/CSS-styles.txt index 32920c9b7..bf014f5c2 100644 --- a/docs/html/_sources/CSS-styles.txt +++ b/docs/html/_sources/CSS-styles.txt @@ -18,7 +18,7 @@ rather than just ``ul li``. 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 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 by commas (not semi-colons) and the values are enclosed in quotation marks. If the name contains dashes, it should be enclosed in diff --git a/docs/html/_sources/HTML-snippets.txt b/docs/html/_sources/HTML-snippets.txt index 21427aaa0..5f8b9b07c 100644 --- a/docs/html/_sources/HTML-snippets.txt +++ b/docs/html/_sources/HTML-snippets.txt @@ -6,7 +6,7 @@ Describing HTML snippets A number of MathJax configuration options allow you to specify an HTML 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 complicated HTML trees. diff --git a/docs/html/_sources/api/ajax.txt b/docs/html/_sources/api/ajax.txt index 28daa6752..4a4caefb5 100644 --- a/docs/html/_sources/api/ajax.txt +++ b/docs/html/_sources/api/ajax.txt @@ -113,7 +113,7 @@ Methods parameter is the name of the file that has been loaded. This routine will cause any callback functions registered for the file 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 their last parameter. @@ -145,7 +145,7 @@ Methods .. method:: loadHook(file,callback) 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 that may be loaded in the future. @@ -156,11 +156,11 @@ Methods .. method:: Preloading(file1[,file2...]) - Used withing combined configuration files to indicate what files are - in the configuration file. Marks the files are loading (since there + Used with combined configuration files to indicate what files are + in the configuration file. Marks the files as loading (since there will never be an explicit :meth:`Load()` or :meth:`Require()` call for - then), so that load-hooks and other load-related events can be - properly processed. + them), so that load-hooks and other load-related events can be + properly processed when the :meth:`loadComplete()` occurs. :Parameters: - **file1, file2, ...** --- the names of the files in the combined file diff --git a/docs/html/_sources/api/callback.txt b/docs/html/_sources/api/callback.txt index 3e51db0d6..b8f42613e 100644 --- a/docs/html/_sources/api/callback.txt +++ b/docs/html/_sources/api/callback.txt @@ -35,7 +35,7 @@ A callback specification is any one of the following: .. describe:: fn 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` 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 DelayedX(time) { 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 @@ -174,7 +174,7 @@ Callback Object Properties .. describe:: called 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 ``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 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 executed. If any of the hooks returns a `Callback` object, then it collects those callbacks and returns a new callback that will diff --git a/docs/html/_sources/api/elementjax.txt b/docs/html/_sources/api/elementjax.txt index a2a2eee1a..f7af083e7 100644 --- a/docs/html/_sources/api/elementjax.txt +++ b/docs/html/_sources/api/elementjax.txt @@ -34,7 +34,7 @@ Class Properties .. 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 @@ -80,19 +80,19 @@ Methods .. Method:: Text(text[,callback]) 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 `callback`, if any, is called. :Parameters: - - **text** --- the new mathematic source string for the element + - **text** --- the new mathematics source string for the element - **callback** --- the callback specification :Returns: the callback object .. Method:: Reprocess([callback]) :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 of the mathematics, for example. The `callback`, if any, is called when the process completes. diff --git a/docs/html/_sources/api/html.txt b/docs/html/_sources/api/html.txt index 784489d08..43ce36bd4 100644 --- a/docs/html/_sources/api/html.txt +++ b/docs/html/_sources/api/html.txt @@ -5,7 +5,7 @@ The MathJax.HTML Object *********************** 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 ` and turns them into actual DOM objects. It also implements the methods used to manage the cookies used by MathJax. @@ -108,7 +108,7 @@ Methods discussed below. :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 :Returns: ``null`` diff --git a/docs/html/_sources/api/hub.txt b/docs/html/_sources/api/hub.txt index a836236a4..2d3a5fe20 100644 --- a/docs/html/_sources/api/hub.txt +++ b/docs/html/_sources/api/hub.txt @@ -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 callback functions that are called when the action completes. These 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 ` documentation for more details. @@ -58,9 +58,9 @@ Properties These are boolean values that indicate whether the browser is 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 ``false`` otherwise. @@ -80,7 +80,7 @@ Properties browsers and whose values are the functions to be performed. Each function is passed one parameter, which is the ``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: .. code-block:: javascript @@ -148,8 +148,8 @@ Methods Registers a listener for a particular message being sent to the startup signal (where initialization and component startup messages are sent). When the message equals the `type`, the - `callback will be called with the message as its parameter. - See the :ref:`Using Signals ` dcocumentation for + `callback` will be called with the message as its parameter. + See the :ref:`Using Signals ` documentation for more details. :Parameters: @@ -163,7 +163,7 @@ Methods completely loaded and processed. (The callback is called when the file makes its :meth:`MathJax.Ajax.loadComplete()` call.) The `file` should be the complete file name, e.g., - ``"[MathJax]/config/MathJax.js"``. + ``"[MathJax]/config/default.js"``. :Parameters: - **file** --- the name of the file to wait for @@ -304,8 +304,8 @@ Methods Returns ``0`` if the element is not a `` -to first load the main configuraiton, then the local modifications. You -can also load MathJax from the CDN and a local configuration from your own -server: +to first load the main configuration, then the local modifications. + +You can also load MathJax from the MathJax CDN server but use a configuration from +your own local server: .. code-block:: html @@ -271,6 +280,24 @@ server: src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML,http://myserver.com/MathJax/config/local/local.js"> +Because the ``local.js`` file is not on the CDN server, you must give +the complete URL to the local configuration file. Note that you also +have to edit the :meth:`loadComplete()` call that is at the bottom of +the configuration file to change it from +``[MathJax]/config/local/local.js`` to the complete URL as you give it +in the ``config`` parameter: + +.. code-block:: javascript + + MathJax.Ajax.loadComplete("http://myserver.com/MathJax/config/local/local.js"); + +That is because the ``[MathJax]`` in the original URL refers to the +root directory where ``MathJax.js`` was loaded, which is on the CDN, +not your local server, and so you need to tell MathJax the actual +location of your configuration file. + + +.. _inline-config: Using in-line configuration options =================================== @@ -315,7 +342,7 @@ For instance, This example includes the `tex2jax` preprocessor and configures it to use both the standard :term:`TeX` and :term:`LaTeX` math delimiters. It uses the `TeX` input processor and the `HTML-CSS` output processor, and forces the -HTML-CSS processor to use the TeX fonts rather that other locally installed +HTML-CSS processor to use the TeX fonts rather than other locally installed fonts (e.g., :term:`STIX` fonts). See the :ref:`configuration options ` section (or the comments in the ``config/default.js`` file) for more information about the configuration options that you can @@ -323,9 +350,9 @@ include in the :meth:`MathJax.Hub.Config()` call. Note that this configuration does **not** load any pre-defined configuration file. Note that you can combine in-line configuration with file-based -configuration, simply include ``text/x-mathjax-config`` scripts as above, +configuration; simply include ``text/x-mathjax-config`` scripts as above, but also include ``config=filename`` when you load the ``MathJax.js`` -file. For example, the `tex2jax` preprocessor does **not** the TeX +file. For example, the `tex2jax` preprocessor does **not** enable the TeX single-dollar in-line math delimiters by default. You can load one of the pre-defined configuration files that include the TeX preprocessor, and use an in-line configuration block to enable the single-dollar signs: @@ -376,11 +403,12 @@ used a combined configuration file, however, it already includes all the main files that MathJax needs, so there is not much loss in delaying the startup.) -You can set ``delayStartupUntil=configured`` in order to delay the startup -configuration until the :meth:`MathJax.Hub.Configured()` method is -called. This allows you to delay startup until later on the page, but -then restart MathJax configuration process as soon as possible rather than -waiting for the entire page to load. For example, you could use +You can set ``delayStartupUntil=configured`` in order to delay the +startup configuration until the :meth:`MathJax.Hub.Configured()` +method is called. This allows you to delay startup until later on the +page, but then restart the MathJax configuration process as soon as +possible rather than waiting for the entire page to load. For +example, you could use .. code-block:: html @@ -398,7 +426,7 @@ in your theme's header file, and in its footer, so that MathJax will delay setting up until the footer is reached, but will not have to wait until images and other files are -laoded. If you have ``text/x-mathjax-config`` script tags within the main +loaded. If you have ``text/x-mathjax-config`` script tags within the main body of the document, MathJax will read and process those before continuing its startup. In this way you can use a default configuration that can be modified on a page-by-page basis. diff --git a/docs/html/_sources/dynamic.txt b/docs/html/_sources/dynamic.txt index 349830c31..24b565fe4 100644 --- a/docs/html/_sources/dynamic.txt +++ b/docs/html/_sources/dynamic.txt @@ -45,7 +45,7 @@ Here is an example of how to load and configure MathJax dynamically: You can adjust the ``config`` variable to your needs, but be careful to get the commas right. The ``window.opera`` test is because some versions of -Opera doesn't handle setting ``script.text`` properly, while Internet +Opera don't handle setting ``script.text`` properly, while Internet Explorer doesn't handle setting the ``innerHTML`` of a script tag. Here is a version that uses the ``config=filename`` method to @@ -97,9 +97,9 @@ server-based copy. The MathJax CDN works nicely for this. ---- Here is a script that runs MathJax in any document that contains -MathML (whether its includes MathJax or not). That allows +MathML (whether it includes MathJax or not). That allows 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. .. code-block:: javascript diff --git a/docs/html/_sources/glossary.txt b/docs/html/_sources/glossary.txt index 30a3d082a..14e18cc93 100644 --- a/docs/html/_sources/glossary.txt +++ b/docs/html/_sources/glossary.txt @@ -29,7 +29,7 @@ Glossary particular message is sent along the signal channel. 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. jax diff --git a/docs/html/_sources/installation.txt b/docs/html/_sources/installation.txt index eb4af110f..97b518c6b 100644 --- a/docs/html/_sources/installation.txt +++ b/docs/html/_sources/installation.txt @@ -50,7 +50,7 @@ date or out of date). If MathJax needs updating, use cd MathJax git pull origin -to udpate your copy of MathJax to the current release version. If you +to update your copy of MathJax to the current release version. If you keep MathJax updated in this way, you will be sure that you have the latest bug fixes and new features as they become available. @@ -86,15 +86,15 @@ there is a crucial change that needs to be made). If you want to use the patched version of a release, then check out the branch rather than the tag. Use -.. code-block::sh +.. code-block:: sh cd MathJax git branch -to get a list of the available branches. There be separate branches +to get a list of the available branches. There are separate branches for the main releases, but with ``-latest`` appended. These contain all the patches for that particular release. You can check out one of -the branchs just as you would a tagged copy. For example, the branch +the branches just as you would a tagged copy. For example, the branch for the ``v1.1`` tagged release is ``v1.1-latest``. To get this release, use @@ -144,7 +144,7 @@ use cd MathJax svn update -to udpate your copy of MathJax to the current release version. If you +to update your copy of MathJax to the current release version. If you keep MathJax updated in this way, you will be sure that you have the latest bug fixes and new features as they become available. @@ -162,7 +162,7 @@ described below. You can use to check out revision number `nnn`, but it is not easy to tell what svn revision number is associated with a particular release. GitHub's -``svn`` service doesn't appear to allow you to sepecify a particular +``svn`` service doesn't appear to allow you to specify a particular tagged version. @@ -194,13 +194,13 @@ right), you can also select the ``Download .tar.gz`` or ``Download MathJax that contains all the latest changes and bug-fixes. You can also get older tagged versions (if there are any). -If a packaged release recevies any important updates, then those +If a packaged release receives any important updates, then those updates will be part of the `branch` for that version. The link to the ``.zip`` file in the download list will be the original release version, not the patched version. To obtain the patched version, use the `Branches` drop down menu (at the far left of the menus within the page) to select the release branch that you want (for example -``v1.1-latest``), and then use the downlaod button and the ``Downlaod +``v1.1-latest``), and then use the download button and the ``Download .tar.gz`` or ``Download .zip`` button to get the latest patched version of that release. @@ -240,7 +240,7 @@ a different site. For example, a departmental server at ``www.math.yourcollege.edu`` might like to use a college-wide installation at ``www.yourcollege.edu`` rather than installing a 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 and IE9's same-origin security policy for cross-domain scripting. Firefox's interpretation of the same-origin policy is more strict than most @@ -259,7 +259,7 @@ mode`, so it exhibits this same behavior. There is a solution to this, however, if you manage the server where MathJax is installed, and if that server is running the `Apache web server `_. In the remote server's -``MathJax/fonts/HTML-CSS/TeX/otf`` folder, create a file called +``MathJax/fonts/`` folder, create a file called ``.htaccess`` that contains the following lines: :: @@ -302,7 +302,7 @@ from your hard disk. Firefox's interpretation of the same-origin policy for local files is that the "same domain" for a page is the directory where that page exists, or any of its subdirectories. So if you use MathJax in a page with a ``file://`` URL, and if MathJax is -loaded from a diretory other than the one containing the original +loaded from a directory other than the one containing the original page, then MathJax will not be able to access the web-based fonts in Firefox. In that case, MathJax will fall back on image fonts to display the mathematics. diff --git a/docs/html/_sources/mathjax.txt b/docs/html/_sources/mathjax.txt index 70d3b3b51..c9dae62b2 100644 --- a/docs/html/_sources/mathjax.txt +++ b/docs/html/_sources/mathjax.txt @@ -22,10 +22,10 @@ image-based, and so it is available for search engines, meaning that your equations can be searchable, just like the text of your pages. MathJax allows page authors to write formulas using TeX and LaTeX notation, or `MathML `_, a World Wide -Web Constortium standard for representing mathematics in XML format. +Web Consortium standard for representing mathematics in XML format. MathJax will even convert TeX notation into MathML, so that it can be rendered more quickly by those browsers that support MathML natively, -or so that you can copy and past it into other programs. +or so that you can copy and paste it into other programs. MathJax is modular, so it loads components only when necessary, and can be extended to include new capabilities as needed. MathJax is diff --git a/docs/html/_sources/mathml.txt b/docs/html/_sources/mathml.txt index b14eb201c..8bcc40f79 100644 --- a/docs/html/_sources/mathml.txt +++ b/docs/html/_sources/mathml.txt @@ -16,7 +16,7 @@ Because of MathJax's modular design, you do not need to use all three of these components. For example, you could use the `tex2jax` preprocessor and the TeX input processor, but the NativeMML output processor, so that your mathematics is entered in TeX format, but -displayed as MathML. Or you could use the `mml2jax` reprocessor and +displayed as MathML. Or you could use the `mml2jax` preprocessor and MathML input processor with the HTML-CSS output processor to make MathML available in browsers that don't have native MathML support. It is also possible to have MathJax select the output processor for @@ -42,7 +42,7 @@ even with a pure MathML workflow. MathML in HTML pages ==================== -For MathML that is handled via the pre-processor, you should not use +For MathML that is handled via the preprocessor, you should not use the named MathML entities, but rather use the numeric entities like ``√`` or unicode characters embedded in the page itself. The reason is that entities are replaced by the browser before MathJax @@ -87,7 +87,7 @@ The deficiencies include: ``msgroup``, ``msrow``, ``mscarries``, and ``mscarry``. - Limited support for line breaking (they are only allowed in direct - children of ``mrow`` or implied ``mrow`` elements. + children of ``mrow`` or implied ``mrow`` elements). - No support for alignment groups in table. diff --git a/docs/html/_sources/model.txt b/docs/html/_sources/model.txt index 1eaf6b670..4bfd6c428 100644 --- a/docs/html/_sources/model.txt +++ b/docs/html/_sources/model.txt @@ -38,7 +38,7 @@ preprocessors for :ref:`TeX notation `, :ref:`MathML notation `, and the :ref:`jsMath notation ` that uses `span` and `div` tags. -For pages that are constructed programatically, such as HTML +For pages that are constructed programmatically, such as HTML pages that result from running a processor on text in some other format (e.g., pages produced from Markdown documents, or via programs like `tex4ht`), it would be best to use MathJax's special tags @@ -46,7 +46,7 @@ directly, as described below, rather than having MathJax run another preprocessor. This will speed up the final display of the mathematics, since the extra preprocessing step would not be needed, 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 an HTML special character (that starts an HTML tag). @@ -192,21 +192,21 @@ by MathJax (called an `element jax`). This internal format is essentially MathML (represented as JavaScript objects), so an input jax acts as a translator into MathML. -**Output jax** convert that internal element jax format into a specific -output format. For example, the NativeMML output jax inserts MathML -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 -that it can be displayed even in browsers that dont understand -MathML. Output jax could be produced that render the mathematics -using SVG, for example, or that speak an equation for the blind -users. The MathJax contextual menu can be used to switch between the -output jax that are available. +**Output jax** convert that internal element jax format into a +specific output format. For example, the NativeMML output jax inserts +MathML 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 that it can be displayed even in browsers that don't +understand MathML. Output jax could be produced that render the +mathematics using SVG, for example, or that speak an equation for +blind users. The MathJax contextual menu can be used to switch +between the output jax that are available. Each input and output jax has a small configuration file that is loaded when that input jax is included in the `jax` array in the MathJax configuration, and a larger file that implements the core functionality of that particular jax. The latter file is loaded -when the first time the jax is needed by MathJax to process some +the first time the jax is needed by MathJax to process some mathematics. The **MathJax Hub** keeps track of the internal representations of the diff --git a/docs/html/_sources/options/FontWarnings.txt b/docs/html/_sources/options/FontWarnings.txt index f0dba6ffa..e1682f1e8 100644 --- a/docs/html/_sources/options/FontWarnings.txt +++ b/docs/html/_sources/options/FontWarnings.txt @@ -23,76 +23,76 @@ would set the ``fadeoutTime`` option to 2000 milliseconds (2 seconds). .. describe:: messageStyle: { ... } - This sets the CSS styles to be used for the font warning message - window. See the ``extensions/FontWarnings.js`` file for details of - what are set by default. See the :ref:`CSS style objects - ` for details about how to specify CSS styles - via javascript objects. + This sets the CSS styles to be used for the font warning message + window. See the ``extensions/FontWarnings.js`` file for details of + what are set by default. See the :ref:`CSS style objects + ` for details about how to specify CSS styles + via javascript objects. .. describe:: Message: { ... } - This block contains HTML snippets to be used for the various - messages that the FontWarning extension can produce. There are - three messages that you can redefine to suit your needs: + This block contains HTML snippets to be used for the various + messages that the FontWarning extension can produce. There are + three messages that you can redefine to suit your needs: - .. describe:: webFont: [ ... ] + .. describe:: webFont: [ ... ] - The message used for when MathJax uses web-based fonts (rather - than local fonts installed on the user's system). + The message used for when MathJax uses web-based fonts (rather + than local fonts installed on the user's system). - .. describe:: imageFonts: [ ... ] + .. describe:: imageFonts: [ ... ] - The message used for when MathJax must use image fonts rather - than local or web-based fonts (for those browsers that don't - handle the ``@font-face`` CSS directive). + The message used for when MathJax must use image fonts rather + than local or web-based fonts (for those browsers that don't + handle the ``@font-face`` CSS directive). - .. describe:: noFonts: [ ... ] + .. describe:: noFonts: [ ... ] - The message used when MathJax is unable to find any font to use - (i.e., neither local nor web-based nor image-based fonts are - available). + The message used when MathJax is unable to find any font to use + (i.e., neither local nor web-based nor image-based fonts are + available). - Any message that is set to ``null`` rather than an HTML snippet - array will not be presented to the user, so you can set, for - example, the ``webFont`` message to ``null`` in order to have the - ``imageFonts`` and ``noFonts`` messages, but no message if MathJax - uses web-based fonts. + Any message that is set to ``null`` rather than an HTML snippet + array will not be presented to the user, so you can set, for + example, the ``webFont`` message to ``null`` in order to have the + ``imageFonts`` and ``noFonts`` messages, but no message if MathJax + uses web-based fonts. - See the description of :ref:`HTML snippets ` for - details about how to describe the messages using HTML snippets. - Note that in addition to the usual rules for defining such - snippets, the FontWarnings snippets can include references to - pre-defined snippets (that represent elements common to all three - messages). These are defined below in the ``HTML`` block, and are - referenced using ``["name"]`` within the snippet, where `name` is - the name of one of the snippets defined in the ``HTML`` - configuration block. For example + See the description of :ref:`HTML snippets ` for + details about how to describe the messages using HTML snippets. + Note that in addition to the usual rules for defining such + snippets, the FontWarnings snippets can include references to + pre-defined snippets (that represent elements common to all three + messages). These are defined below in the ``HTML`` block, and are + referenced using ``["name"]`` within the snippet, where `name` is + the name of one of the snippets defined in the ``HTML`` + configuration block. For example - .. code-block:: javascript + .. code-block:: javascript - Message: { - noFonts: [ - ["closeBox"], - "MathJax is unable to locate a font to use to display ", - "its mathematics, and image fonts are not available, so it ", - "is falling back on generic unicode characters in hopes that ", - "your browser will be able to display them. Some characters ", - "may not show up properly, or possibly not at all.", - ["fonts"], - ["webfonts"] - ] - } + Message: { + noFonts: [ + ["closeBox"], + "MathJax is unable to locate a font to use to display ", + "its mathematics, and image fonts are not available, so it ", + "is falling back on generic unicode characters in hopes that ", + "your browser will be able to display them. Some characters ", + "may not show up properly, or possibly not at all.", + ["fonts"], + ["webfonts"] + ] + } - refers to the ``closeBox``, ``fonts`` and ``webfonts`` snippets in + refers to the ``closeBox``, ``fonts`` and ``webfonts`` snippets declared in the ``HTML`` section. .. describe:: HTML: { ... } This object defines HTML snippets that are common to more than one - message in the ``Message`` section above. They can be called in - by using ``["name"]`` in an HTML snippet, where `name` refers to - the name of the snippet in the ``HTML`` block. The pre-defined - snippets are: + message in the ``Message`` section above. They can be included in + other HTML snippets by by using ``["name"]`` in an HTML snippet, + where `name` refers to the name of the snippet in the ``HTML`` + block. The pre-defined snippets are: .. describe:: closeBox diff --git a/docs/html/_sources/options/HTML-CSS.txt b/docs/html/_sources/options/HTML-CSS.txt index 6dc40c86a..b350953f8 100644 --- a/docs/html/_sources/options/HTML-CSS.txt +++ b/docs/html/_sources/options/HTML-CSS.txt @@ -32,7 +32,7 @@ would set the ``preferredFont`` option to the :term:`STIX` fonts. .. describe:: minScaleAdjust: 50 - This gives a minimum scale (as a percent) for the scaling used my + This gives a minimum scale (as a percent) for the scaling used by MathJax to match the equation to the surrounding text. This will prevent MathJax from making the mathematics too small. @@ -57,7 +57,7 @@ would set the ``preferredFont`` option to the :term:`STIX` fonts. This is the web-based font to use when none of the fonts listed above are available on the user's computer. Note that currently only the `TeX` font is available in a web-based form (they are - stored in the ``fonts/HTML-CSS`` folder in the MathJax directory. + stored in the ``fonts/HTML-CSS`` folder in the MathJax directory). Set this to ``null`` to disable web fonts. .. describe:: imageFont: "TeX" @@ -65,7 +65,7 @@ would set the ``preferredFont`` option to the :term:`STIX` fonts. This is the font to use for image fallback mode (when none of the fonts listed above are available and the browser doesn't support web-fonts via the ``@font-face`` CSS directive). Note that currently - only the TeX font is available as an image font (they are stores + only the TeX font is available as an image font (they are stored in the ``fonts/HTML-CSS`` directory). Set this to ``null`` if you want to prevent the use of image fonts diff --git a/docs/html/_sources/options/MMLorHTML.txt b/docs/html/_sources/options/MMLorHTML.txt index f61eced30..023de9461 100644 --- a/docs/html/_sources/options/MMLorHTML.txt +++ b/docs/html/_sources/options/MMLorHTML.txt @@ -20,7 +20,7 @@ in your :meth:`MathJax.Hub.Config()` call. For example } }); -would set the ``prefer`` option so that Opera browser would prefer +would set the ``prefer`` option so that the Opera browser would prefer MathML to HTML-CSS output (while leaving the settings for other browsers unchanged). diff --git a/docs/html/_sources/options/MathMenu.txt b/docs/html/_sources/options/MathMenu.txt index 67abacdb5..03ea8e31b 100644 --- a/docs/html/_sources/options/MathMenu.txt +++ b/docs/html/_sources/options/MathMenu.txt @@ -35,7 +35,7 @@ would set the ``delay`` option to 600 milliseconds. .. describe:: showRenderer: true This controls whether the "Math Renderer" item will be displayed in - the the "Settings" submenu of the mathematics contextual menu. It + the "Settings" submenu of the mathematics contextual menu. It allows the user to change between the `HTML-CSS` and `NativeMML` output processors for the mathematics on the page. Set to ``false`` to prevent this menu item from showing. @@ -43,9 +43,9 @@ would set the ``delay`` option to 600 milliseconds. .. describe:: showContext: false This controls whether the "Contextual Menu" item will be displayed - in the the "Settings" submenu of the mathematics contextual menu. + in the "Settings" submenu of the mathematics contextual menu. It allows the user to decide whether the MathJax menu or the - browser's default contextual manu will be shown when the context + browser's default contextual menu will be shown when the context menu click occurs over mathematics typeset by MathJax. (The main reason to allow pass-through to the browser's menu is to gain access to the MathPlayer contextual menu when the NativeMML output @@ -56,7 +56,7 @@ would set the ``delay`` option to 600 milliseconds. .. describe:: showFontMenu: false This controls whether the "Font Preference" item will be displayed - in the the "Settings" submenu of the mathematics contextual menu. + in the "Settings" submenu of the mathematics contextual menu. This submenu lets the user select what font to use in the mathematics produced by the `HTML-CSS` output processor. Note that changing the selection in the font menu will cause the page to diff --git a/docs/html/_sources/options/NativeMML.txt b/docs/html/_sources/options/NativeMML.txt index 478dd63fa..ef2b12e55 100644 --- a/docs/html/_sources/options/NativeMML.txt +++ b/docs/html/_sources/options/NativeMML.txt @@ -18,13 +18,13 @@ in your :meth:`MathJax.Hub.Config()` call. For example } }); -would set the ``sale`` option to 105 percent. +would set the ``scale`` option to 105 percent. .. describe:: scale: 100 The scaling factor (as a percentage) of math with respect to the surrounding text. Since the `NativeMML` output relies on the - browser's natiove MathML support, MathJax does not control the + browser's native MathML support, MathJax does not control the font size used in the mathematics. You may need to set this value to compensate for the size selected by the browser. The user can also adjust this value using the contextual menu item associated @@ -49,7 +49,7 @@ would set the ``sale`` option to 105 percent. There is a separate menu setting for MSIE since the code to handle that is a bit delicate; if it turns out to have unexpected - consequences, you can turn it off without turing off other the + consequences, you can turn it off without turning off the menu support in other browsers. .. describe:: styles: {} diff --git a/docs/html/_sources/options/TeX.txt b/docs/html/_sources/options/TeX.txt index 38793247a..19471fff6 100644 --- a/docs/html/_sources/options/TeX.txt +++ b/docs/html/_sources/options/TeX.txt @@ -47,7 +47,7 @@ to be defined within the TeX input processor. This lists macros to define before the TeX input processor begins. These are name:value pairs where the `name` gives the name of the TeX macro to be defined, and `value` gives the replacement text for the - macro. The `value` canbe an array of the form `[value,n]`, where + macro. The `value` can be an array of the form `[value,n]`, where `value` is the replacement text and `n` is the number of parameters for the macro. Note that since the `value` is a javascript string, backslashes in the replacement text must be doubled to prevent them @@ -64,12 +64,12 @@ to be defined within the TeX input processor. would ask the TeX processor to define two new macros: ``\RR``, which produces a bold-face "R", and ``\bold{...}``, which takes one - parameter and set it in the bold-face font. + parameter and sets it in the bold-face font. .. describe:: MAXMACROS: 10000 Because a definition of the form ``\def\x{\x} \x`` would cause MathJax - to loop infinitely, the `MAXMACROS` constant will limit the nuber of + to loop infinitely, the `MAXMACROS` constant will limit the number of macro substitutions allowed in any expression processed by MathJax. .. describe:: MAXBUFFER: 5*1024 @@ -78,4 +78,4 @@ to be defined within the TeX input processor. infinitely, and at the same time stack up lots of a's in MathJax's equation buffer, the `MAXBUFFER` constant is used to limit the size of the string being processed by MathJax. It is set to 5KB, which should - be sufficient for any reasonable equation. \ No newline at end of file + be sufficient for any reasonable equation. diff --git a/docs/html/_sources/options/hub.txt b/docs/html/_sources/options/hub.txt index 364a749e2..4c9e4d9c4 100644 --- a/docs/html/_sources/options/hub.txt +++ b/docs/html/_sources/options/hub.txt @@ -52,11 +52,11 @@ behavior of MathJax. They are given with their default values. are not using one of the preprocessors, you need to insert something extra into your HTML file in order to avoid a bug in Internet Explorer. IE removes spaces from the DOM that it thinks - are redundent, and since a `` - to load MathJax from our distributed netowrk service. + to load MathJax from our distributed network service. .. image:: ../images/mt_head.png 5. Save the file. This will enable MathJax with both TeX and MathML input, so you should be able to start adding mathematical content to - your pages. If you need to adjust the configuraiton, see + your pages. If you need to adjust the configuration, see :ref:`Configuring MathJax ` for more details. diff --git a/docs/html/_sources/platforms/wordpress.txt b/docs/html/_sources/platforms/wordpress.txt index ef3df88c6..25b380f2e 100644 --- a/docs/html/_sources/platforms/wordpress.txt +++ b/docs/html/_sources/platforms/wordpress.txt @@ -38,5 +38,5 @@ better choice than editing the theme directly. 4. Save the file. This will enable MathJax with both TeX and MathML input, so you should be able to start adding mathematical content to - your pages. If you need to adjust the configuraiton, see + your pages. If you need to adjust the configuration, see :ref:`Configuring MathJax ` for more details. diff --git a/docs/html/_sources/queues.txt b/docs/html/_sources/queues.txt index d85fa50d0..289118049 100644 --- a/docs/html/_sources/queues.txt +++ b/docs/html/_sources/queues.txt @@ -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 javascript code that you may write as part of dynamic web pages. 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 `MathJax.Callback.Queue` object provides that mechanism. @@ -69,11 +69,11 @@ that could operate asynchronously. For example: [f, 2] ); -Here, the command ``MathJax.Ajax.require("extensions/AMSmath.js")`` is -queued between two calls to ``f``. The first call to ``f(1)`` will be -made immediately, then the :meth:`MathJax.Ajax.Require` statement will -be performed. Since the ``Require`` method loads a file, it operates -asynchronously, and its return value is a `MathJax.Callback` +Here, the command ``MathJax.Ajax.Require("[MathJax]/extensions/AMSmath.js")`` +is queued between two calls to ``f``. The first call to ``f(1)`` will +be made immediately, then the :meth:`MathJax.Ajax.Require` statement +will be performed. Since the ``Require`` method loads a file, it +operates asynchronously, and its return value is a `MathJax.Callback` object that will be called when the file is loaded. The call to ``f(2)`` will not be made until that callback is performed, effectively synchronizing the second call to ``f`` with the completion @@ -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 commands can cause the typesetting process to be suspended while the file is loaded, and then restarted when the extension has become -evailable. +available. As a result, any call to :meth:`MathJax.Hub.Typeset()` (or :meth:`MathJax.Hub.Process()`, or :meth:`MathJax.Hub.Update()`, etc.) could return long before the mathematics is actually typeset, and the 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 synchronized with the typesetting via the MathJax queue. diff --git a/docs/html/_sources/signals.txt b/docs/html/_sources/signals.txt index 418248c3b..7b385c884 100644 --- a/docs/html/_sources/signals.txt +++ b/docs/html/_sources/signals.txt @@ -5,7 +5,7 @@ Using Signals ************* Because much of MathJax operates asynchronously, it is important for -MathJax to be able to indicated to other components operating on the +MathJax to be able to indicate to other components operating on the page that certain actions have been taken. For example, as MathJax is starting up, it loads external files such as its configuration files and the various input and output :term:`jax` that are used on the @@ -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 work, because the listener will receive the ready signal even if it 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. 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 using signals. This example lists all the signals that occur while 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 file (from the same directory as the web page). Since it returns diff --git a/docs/html/_sources/start.txt b/docs/html/_sources/start.txt index 7dc528c6d..2490cb6ef 100644 --- a/docs/html/_sources/start.txt +++ b/docs/html/_sources/start.txt @@ -47,7 +47,7 @@ that, and otherwise use HTML-with-CSS to display the mathematics. This is the most general configuration, and should suffice for most people's needs. Other configurations are available, however, and you can also provide additional configuration parameters to taylor one of -the confiogurations to your needs. More details can be found in the +the configurations to your needs. More details can be found in the :ref:`Loading and Configuring MathJax ` instructions. The use of ``cdn.mathjax.org`` is governed by its `terms of service @@ -123,7 +123,7 @@ Configuring your copy of MathJax When you include MathJax into your web pages as described below, it will load the file ``config/TeX-AMS-MML_HTMLorMML.js`` (i.e., the file named ``TeX-AMS-MML_HTMLorMML.js`` in the ``config`` folder of the -main ``MathJax`` folder). This file preloads all the most comply-used +main ``MathJax`` folder). This file preloads all the most commonly-used components of MathJax, allowing it to process mathematics that is in the TeX or LaTeX format, or in MathML notation. It will produce output in MathML form if the user's browser supports that, and will use @@ -138,7 +138,7 @@ described more fully in :ref:`Common Configurations Note: The configuration process has changed in MathJax v1.1, so if you have existing pages that use MathJax, you may need to modify the tag that -loads MathJax so that is conforms with the new configuration process. +loads MathJax so that it conforms with the new configuration process. See :ref:`Installing and Configuring MathJax ` for more details. @@ -227,13 +227,13 @@ math mode, you must enable that explicitly in your configuration: tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]} }); - + See the ``config/default.js`` file, or the :ref:`tex2jax configuration options ` page, for additional configuration parameters that you can specify for the `tex2jax` preprocessor, which is the component of MathJax that identifies TeX notation within -the page). See the :ref:`TeX and LaTeX ` page for +the page. See the :ref:`TeX and LaTeX ` page for more on MathJax's support for TeX. Here is a complete sample page containing TeX mathematics (also available diff --git a/docs/html/_sources/startup.txt b/docs/html/_sources/startup.txt index eb25d8253..c157d0fd6 100644 --- a/docs/html/_sources/startup.txt +++ b/docs/html/_sources/startup.txt @@ -154,7 +154,7 @@ are requested simultaneously, so they load concurrently. That means they can load in any order, and that the begin and end signals for the jax and extensions can be intermixed. (In general, you will get `Begin Jax` followed by `Begin Extensions`, but the order of `End Jax` and `End -Extensions` will depend on the file sbeing loaded.) Both 5 and 6 must +Extensions` will depend on the files being loaded.) Both 5 and 6 must complete, however, before 7 will be performed. -See the ``test/sample-signals.html`` file to see the signals in action. \ No newline at end of file +See the ``test/sample-signals.html`` file to see the signals in action. diff --git a/docs/html/_sources/synchronize.txt b/docs/html/_sources/synchronize.txt index a285f2a7d..2f707c695 100644 --- a/docs/html/_sources/synchronize.txt +++ b/docs/html/_sources/synchronize.txt @@ -22,14 +22,14 @@ initiates an action, waits for it to complete, and then goes on, you break the function into two parts: a first part that sets up and initiates the action, and a second that runs after the action is finished. Callbacks are similar to event handlers that you attach to -DOM elements, and are called when an certain action occurs. See the +DOM elements, and are called when a certain action occurs. See the :ref:`Callback Object ` reference page for details of how to specify a callback. **Queues** are MathJax's means of synchronizing actions that must be performed sequentially, even when they involve asynchronous events 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 next. MathJax maintains a master queue that you can use to synchronize with MathJax, but you can also create your own private @@ -47,7 +47,7 @@ will call your code. 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 "memory", meaning that if you register an interest in a particular 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 +told about the past occurrences as well as any future ones. See the :ref:`Signal Object ` reference page for more details. See also the ``test/sample-signals.html`` file in the MathJax ``test`` directory for a working example of using signals. diff --git a/docs/html/_sources/tex.txt b/docs/html/_sources/tex.txt index 7f09b4ca9..d70aaa760 100644 --- a/docs/html/_sources/tex.txt +++ b/docs/html/_sources/tex.txt @@ -39,7 +39,7 @@ you need a LaTeX-to-HTML converter, you should consider `other options TeX and LaTeX math delimiters ============================= -By default, the `tex2jax` preprocesor defines the LaTeX math delimiters, +By default, the `tex2jax` preprocessor defines the LaTeX math delimiters, which are ``\(...\)`` for in-line math, and ``\[...\]`` for displayed equations. It also defines the TeX delimiters ``$$...$$`` for displayed equations, but it does **not** define ``$...$`` as in-line math @@ -72,7 +72,7 @@ See the ``config/default.js`` file, or the :ref:`tex2jax configuration options ` page, for additional configuration parameters that you can specify for the `tex2jax` preprocessor, which is the component of MathJax that identifies TeX notation within -the page). +the page. TeX and LaTeX in HTML documents @@ -86,7 +86,7 @@ Also, since the mathematics is initially given as text on the page, you need to be careful that your mathematics doesn't look like HTML tags to the browser (which parses the page before MathJax gets to see it). In particular, that means that you have to be careful about -things like less-than and greater-than signs (``<``and ``>``), and +things like less-than and greater-than signs (``<`` and ``>``), and ampersands (``&``), which have special meaning to the browsers. For example, @@ -99,10 +99,10 @@ 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 to the next ``>`` in the document (typically the end of the next 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 -have ...`` will not be displayed because the browser thinks it is +part of the text of the document. In the example above, the "``we +have ...``" will not be displayed because the browser thinks it is part of the tag starting at ```` element, or even a MathJax math -`` -to first load the main configuraiton, then the local modifications. You -can also load MathJax from the CDN and a local configuration from your own -server: +to first load the main configuration, then the local modifications. + +You can also load MathJax from the MathJax CDN server but use a configuration from +your own local server: .. code-block:: html @@ -271,6 +280,24 @@ server: src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML,http://myserver.com/MathJax/config/local/local.js"> +Because the ``local.js`` file is not on the CDN server, you must give +the complete URL to the local configuration file. Note that you also +have to edit the :meth:`loadComplete()` call that is at the bottom of +the configuration file to change it from +``[MathJax]/config/local/local.js`` to the complete URL as you give it +in the ``config`` parameter: + +.. code-block:: javascript + + MathJax.Ajax.loadComplete("http://myserver.com/MathJax/config/local/local.js"); + +That is because the ``[MathJax]`` in the original URL refers to the +root directory where ``MathJax.js`` was loaded, which is on the CDN, +not your local server, and so you need to tell MathJax the actual +location of your configuration file. + + +.. _inline-config: Using in-line configuration options =================================== @@ -315,7 +342,7 @@ For instance, This example includes the `tex2jax` preprocessor and configures it to use both the standard :term:`TeX` and :term:`LaTeX` math delimiters. It uses the `TeX` input processor and the `HTML-CSS` output processor, and forces the -HTML-CSS processor to use the TeX fonts rather that other locally installed +HTML-CSS processor to use the TeX fonts rather than other locally installed fonts (e.g., :term:`STIX` fonts). See the :ref:`configuration options ` section (or the comments in the ``config/default.js`` file) for more information about the configuration options that you can @@ -323,9 +350,9 @@ include in the :meth:`MathJax.Hub.Config()` call. Note that this configuration does **not** load any pre-defined configuration file. Note that you can combine in-line configuration with file-based -configuration, simply include ``text/x-mathjax-config`` scripts as above, +configuration; simply include ``text/x-mathjax-config`` scripts as above, but also include ``config=filename`` when you load the ``MathJax.js`` -file. For example, the `tex2jax` preprocessor does **not** the TeX +file. For example, the `tex2jax` preprocessor does **not** enable the TeX single-dollar in-line math delimiters by default. You can load one of the pre-defined configuration files that include the TeX preprocessor, and use an in-line configuration block to enable the single-dollar signs: @@ -376,11 +403,12 @@ used a combined configuration file, however, it already includes all the main files that MathJax needs, so there is not much loss in delaying the startup.) -You can set ``delayStartupUntil=configured`` in order to delay the startup -configuration until the :meth:`MathJax.Hub.Configured()` method is -called. This allows you to delay startup until later on the page, but -then restart MathJax configuration process as soon as possible rather than -waiting for the entire page to load. For example, you could use +You can set ``delayStartupUntil=configured`` in order to delay the +startup configuration until the :meth:`MathJax.Hub.Configured()` +method is called. This allows you to delay startup until later on the +page, but then restart the MathJax configuration process as soon as +possible rather than waiting for the entire page to load. For +example, you could use .. code-block:: html @@ -398,7 +426,7 @@ in your theme's header file, and in its footer, so that MathJax will delay setting up until the footer is reached, but will not have to wait until images and other files are -laoded. If you have ``text/x-mathjax-config`` script tags within the main +loaded. If you have ``text/x-mathjax-config`` script tags within the main body of the document, MathJax will read and process those before continuing its startup. In this way you can use a default configuration that can be modified on a page-by-page basis. diff --git a/docs/source/dynamic.rst b/docs/source/dynamic.rst index 349830c31..24b565fe4 100644 --- a/docs/source/dynamic.rst +++ b/docs/source/dynamic.rst @@ -45,7 +45,7 @@ Here is an example of how to load and configure MathJax dynamically: You can adjust the ``config`` variable to your needs, but be careful to get the commas right. The ``window.opera`` test is because some versions of -Opera doesn't handle setting ``script.text`` properly, while Internet +Opera don't handle setting ``script.text`` properly, while Internet Explorer doesn't handle setting the ``innerHTML`` of a script tag. Here is a version that uses the ``config=filename`` method to @@ -97,9 +97,9 @@ server-based copy. The MathJax CDN works nicely for this. ---- Here is a script that runs MathJax in any document that contains -MathML (whether its includes MathJax or not). That allows +MathML (whether it includes MathJax or not). That allows 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. .. code-block:: javascript diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 30a3d082a..14e18cc93 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -29,7 +29,7 @@ Glossary particular message is sent along the signal channel. 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. jax diff --git a/docs/source/installation.rst b/docs/source/installation.rst index eb4af110f..97b518c6b 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -50,7 +50,7 @@ date or out of date). If MathJax needs updating, use cd MathJax git pull origin -to udpate your copy of MathJax to the current release version. If you +to update your copy of MathJax to the current release version. If you keep MathJax updated in this way, you will be sure that you have the latest bug fixes and new features as they become available. @@ -86,15 +86,15 @@ there is a crucial change that needs to be made). If you want to use the patched version of a release, then check out the branch rather than the tag. Use -.. code-block::sh +.. code-block:: sh cd MathJax git branch -to get a list of the available branches. There be separate branches +to get a list of the available branches. There are separate branches for the main releases, but with ``-latest`` appended. These contain all the patches for that particular release. You can check out one of -the branchs just as you would a tagged copy. For example, the branch +the branches just as you would a tagged copy. For example, the branch for the ``v1.1`` tagged release is ``v1.1-latest``. To get this release, use @@ -144,7 +144,7 @@ use cd MathJax svn update -to udpate your copy of MathJax to the current release version. If you +to update your copy of MathJax to the current release version. If you keep MathJax updated in this way, you will be sure that you have the latest bug fixes and new features as they become available. @@ -162,7 +162,7 @@ described below. You can use to check out revision number `nnn`, but it is not easy to tell what svn revision number is associated with a particular release. GitHub's -``svn`` service doesn't appear to allow you to sepecify a particular +``svn`` service doesn't appear to allow you to specify a particular tagged version. @@ -194,13 +194,13 @@ right), you can also select the ``Download .tar.gz`` or ``Download MathJax that contains all the latest changes and bug-fixes. You can also get older tagged versions (if there are any). -If a packaged release recevies any important updates, then those +If a packaged release receives any important updates, then those updates will be part of the `branch` for that version. The link to the ``.zip`` file in the download list will be the original release version, not the patched version. To obtain the patched version, use the `Branches` drop down menu (at the far left of the menus within the page) to select the release branch that you want (for example -``v1.1-latest``), and then use the downlaod button and the ``Downlaod +``v1.1-latest``), and then use the download button and the ``Download .tar.gz`` or ``Download .zip`` button to get the latest patched version of that release. @@ -240,7 +240,7 @@ a different site. For example, a departmental server at ``www.math.yourcollege.edu`` might like to use a college-wide installation at ``www.yourcollege.edu`` rather than installing a 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 and IE9's same-origin security policy for cross-domain scripting. Firefox's interpretation of the same-origin policy is more strict than most @@ -259,7 +259,7 @@ mode`, so it exhibits this same behavior. There is a solution to this, however, if you manage the server where MathJax is installed, and if that server is running the `Apache web server `_. In the remote server's -``MathJax/fonts/HTML-CSS/TeX/otf`` folder, create a file called +``MathJax/fonts/`` folder, create a file called ``.htaccess`` that contains the following lines: :: @@ -302,7 +302,7 @@ from your hard disk. Firefox's interpretation of the same-origin policy for local files is that the "same domain" for a page is the directory where that page exists, or any of its subdirectories. So if you use MathJax in a page with a ``file://`` URL, and if MathJax is -loaded from a diretory other than the one containing the original +loaded from a directory other than the one containing the original page, then MathJax will not be able to access the web-based fonts in Firefox. In that case, MathJax will fall back on image fonts to display the mathematics. diff --git a/docs/source/mathjax.rst b/docs/source/mathjax.rst index 70d3b3b51..c9dae62b2 100644 --- a/docs/source/mathjax.rst +++ b/docs/source/mathjax.rst @@ -22,10 +22,10 @@ image-based, and so it is available for search engines, meaning that your equations can be searchable, just like the text of your pages. MathJax allows page authors to write formulas using TeX and LaTeX notation, or `MathML `_, a World Wide -Web Constortium standard for representing mathematics in XML format. +Web Consortium standard for representing mathematics in XML format. MathJax will even convert TeX notation into MathML, so that it can be rendered more quickly by those browsers that support MathML natively, -or so that you can copy and past it into other programs. +or so that you can copy and paste it into other programs. MathJax is modular, so it loads components only when necessary, and can be extended to include new capabilities as needed. MathJax is diff --git a/docs/source/mathml.rst b/docs/source/mathml.rst index b14eb201c..8bcc40f79 100644 --- a/docs/source/mathml.rst +++ b/docs/source/mathml.rst @@ -16,7 +16,7 @@ Because of MathJax's modular design, you do not need to use all three of these components. For example, you could use the `tex2jax` preprocessor and the TeX input processor, but the NativeMML output processor, so that your mathematics is entered in TeX format, but -displayed as MathML. Or you could use the `mml2jax` reprocessor and +displayed as MathML. Or you could use the `mml2jax` preprocessor and MathML input processor with the HTML-CSS output processor to make MathML available in browsers that don't have native MathML support. It is also possible to have MathJax select the output processor for @@ -42,7 +42,7 @@ even with a pure MathML workflow. MathML in HTML pages ==================== -For MathML that is handled via the pre-processor, you should not use +For MathML that is handled via the preprocessor, you should not use the named MathML entities, but rather use the numeric entities like ``√`` or unicode characters embedded in the page itself. The reason is that entities are replaced by the browser before MathJax @@ -87,7 +87,7 @@ The deficiencies include: ``msgroup``, ``msrow``, ``mscarries``, and ``mscarry``. - Limited support for line breaking (they are only allowed in direct - children of ``mrow`` or implied ``mrow`` elements. + children of ``mrow`` or implied ``mrow`` elements). - No support for alignment groups in table. diff --git a/docs/source/model.rst b/docs/source/model.rst index 1eaf6b670..4bfd6c428 100644 --- a/docs/source/model.rst +++ b/docs/source/model.rst @@ -38,7 +38,7 @@ preprocessors for :ref:`TeX notation `, :ref:`MathML notation `, and the :ref:`jsMath notation ` that uses `span` and `div` tags. -For pages that are constructed programatically, such as HTML +For pages that are constructed programmatically, such as HTML pages that result from running a processor on text in some other format (e.g., pages produced from Markdown documents, or via programs like `tex4ht`), it would be best to use MathJax's special tags @@ -46,7 +46,7 @@ directly, as described below, rather than having MathJax run another preprocessor. This will speed up the final display of the mathematics, since the extra preprocessing step would not be needed, 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 an HTML special character (that starts an HTML tag). @@ -192,21 +192,21 @@ by MathJax (called an `element jax`). This internal format is essentially MathML (represented as JavaScript objects), so an input jax acts as a translator into MathML. -**Output jax** convert that internal element jax format into a specific -output format. For example, the NativeMML output jax inserts MathML -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 -that it can be displayed even in browsers that dont understand -MathML. Output jax could be produced that render the mathematics -using SVG, for example, or that speak an equation for the blind -users. The MathJax contextual menu can be used to switch between the -output jax that are available. +**Output jax** convert that internal element jax format into a +specific output format. For example, the NativeMML output jax inserts +MathML 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 that it can be displayed even in browsers that don't +understand MathML. Output jax could be produced that render the +mathematics using SVG, for example, or that speak an equation for +blind users. The MathJax contextual menu can be used to switch +between the output jax that are available. Each input and output jax has a small configuration file that is loaded when that input jax is included in the `jax` array in the MathJax configuration, and a larger file that implements the core functionality of that particular jax. The latter file is loaded -when the first time the jax is needed by MathJax to process some +the first time the jax is needed by MathJax to process some mathematics. The **MathJax Hub** keeps track of the internal representations of the diff --git a/docs/source/options/FontWarnings.rst b/docs/source/options/FontWarnings.rst index f0dba6ffa..e1682f1e8 100644 --- a/docs/source/options/FontWarnings.rst +++ b/docs/source/options/FontWarnings.rst @@ -23,76 +23,76 @@ would set the ``fadeoutTime`` option to 2000 milliseconds (2 seconds). .. describe:: messageStyle: { ... } - This sets the CSS styles to be used for the font warning message - window. See the ``extensions/FontWarnings.js`` file for details of - what are set by default. See the :ref:`CSS style objects - ` for details about how to specify CSS styles - via javascript objects. + This sets the CSS styles to be used for the font warning message + window. See the ``extensions/FontWarnings.js`` file for details of + what are set by default. See the :ref:`CSS style objects + ` for details about how to specify CSS styles + via javascript objects. .. describe:: Message: { ... } - This block contains HTML snippets to be used for the various - messages that the FontWarning extension can produce. There are - three messages that you can redefine to suit your needs: + This block contains HTML snippets to be used for the various + messages that the FontWarning extension can produce. There are + three messages that you can redefine to suit your needs: - .. describe:: webFont: [ ... ] + .. describe:: webFont: [ ... ] - The message used for when MathJax uses web-based fonts (rather - than local fonts installed on the user's system). + The message used for when MathJax uses web-based fonts (rather + than local fonts installed on the user's system). - .. describe:: imageFonts: [ ... ] + .. describe:: imageFonts: [ ... ] - The message used for when MathJax must use image fonts rather - than local or web-based fonts (for those browsers that don't - handle the ``@font-face`` CSS directive). + The message used for when MathJax must use image fonts rather + than local or web-based fonts (for those browsers that don't + handle the ``@font-face`` CSS directive). - .. describe:: noFonts: [ ... ] + .. describe:: noFonts: [ ... ] - The message used when MathJax is unable to find any font to use - (i.e., neither local nor web-based nor image-based fonts are - available). + The message used when MathJax is unable to find any font to use + (i.e., neither local nor web-based nor image-based fonts are + available). - Any message that is set to ``null`` rather than an HTML snippet - array will not be presented to the user, so you can set, for - example, the ``webFont`` message to ``null`` in order to have the - ``imageFonts`` and ``noFonts`` messages, but no message if MathJax - uses web-based fonts. + Any message that is set to ``null`` rather than an HTML snippet + array will not be presented to the user, so you can set, for + example, the ``webFont`` message to ``null`` in order to have the + ``imageFonts`` and ``noFonts`` messages, but no message if MathJax + uses web-based fonts. - See the description of :ref:`HTML snippets ` for - details about how to describe the messages using HTML snippets. - Note that in addition to the usual rules for defining such - snippets, the FontWarnings snippets can include references to - pre-defined snippets (that represent elements common to all three - messages). These are defined below in the ``HTML`` block, and are - referenced using ``["name"]`` within the snippet, where `name` is - the name of one of the snippets defined in the ``HTML`` - configuration block. For example + See the description of :ref:`HTML snippets ` for + details about how to describe the messages using HTML snippets. + Note that in addition to the usual rules for defining such + snippets, the FontWarnings snippets can include references to + pre-defined snippets (that represent elements common to all three + messages). These are defined below in the ``HTML`` block, and are + referenced using ``["name"]`` within the snippet, where `name` is + the name of one of the snippets defined in the ``HTML`` + configuration block. For example - .. code-block:: javascript + .. code-block:: javascript - Message: { - noFonts: [ - ["closeBox"], - "MathJax is unable to locate a font to use to display ", - "its mathematics, and image fonts are not available, so it ", - "is falling back on generic unicode characters in hopes that ", - "your browser will be able to display them. Some characters ", - "may not show up properly, or possibly not at all.", - ["fonts"], - ["webfonts"] - ] - } + Message: { + noFonts: [ + ["closeBox"], + "MathJax is unable to locate a font to use to display ", + "its mathematics, and image fonts are not available, so it ", + "is falling back on generic unicode characters in hopes that ", + "your browser will be able to display them. Some characters ", + "may not show up properly, or possibly not at all.", + ["fonts"], + ["webfonts"] + ] + } - refers to the ``closeBox``, ``fonts`` and ``webfonts`` snippets in + refers to the ``closeBox``, ``fonts`` and ``webfonts`` snippets declared in the ``HTML`` section. .. describe:: HTML: { ... } This object defines HTML snippets that are common to more than one - message in the ``Message`` section above. They can be called in - by using ``["name"]`` in an HTML snippet, where `name` refers to - the name of the snippet in the ``HTML`` block. The pre-defined - snippets are: + message in the ``Message`` section above. They can be included in + other HTML snippets by by using ``["name"]`` in an HTML snippet, + where `name` refers to the name of the snippet in the ``HTML`` + block. The pre-defined snippets are: .. describe:: closeBox diff --git a/docs/source/options/HTML-CSS.rst b/docs/source/options/HTML-CSS.rst index 6dc40c86a..b350953f8 100644 --- a/docs/source/options/HTML-CSS.rst +++ b/docs/source/options/HTML-CSS.rst @@ -32,7 +32,7 @@ would set the ``preferredFont`` option to the :term:`STIX` fonts. .. describe:: minScaleAdjust: 50 - This gives a minimum scale (as a percent) for the scaling used my + This gives a minimum scale (as a percent) for the scaling used by MathJax to match the equation to the surrounding text. This will prevent MathJax from making the mathematics too small. @@ -57,7 +57,7 @@ would set the ``preferredFont`` option to the :term:`STIX` fonts. This is the web-based font to use when none of the fonts listed above are available on the user's computer. Note that currently only the `TeX` font is available in a web-based form (they are - stored in the ``fonts/HTML-CSS`` folder in the MathJax directory. + stored in the ``fonts/HTML-CSS`` folder in the MathJax directory). Set this to ``null`` to disable web fonts. .. describe:: imageFont: "TeX" @@ -65,7 +65,7 @@ would set the ``preferredFont`` option to the :term:`STIX` fonts. This is the font to use for image fallback mode (when none of the fonts listed above are available and the browser doesn't support web-fonts via the ``@font-face`` CSS directive). Note that currently - only the TeX font is available as an image font (they are stores + only the TeX font is available as an image font (they are stored in the ``fonts/HTML-CSS`` directory). Set this to ``null`` if you want to prevent the use of image fonts diff --git a/docs/source/options/MMLorHTML.rst b/docs/source/options/MMLorHTML.rst index f61eced30..023de9461 100644 --- a/docs/source/options/MMLorHTML.rst +++ b/docs/source/options/MMLorHTML.rst @@ -20,7 +20,7 @@ in your :meth:`MathJax.Hub.Config()` call. For example } }); -would set the ``prefer`` option so that Opera browser would prefer +would set the ``prefer`` option so that the Opera browser would prefer MathML to HTML-CSS output (while leaving the settings for other browsers unchanged). diff --git a/docs/source/options/MathMenu.rst b/docs/source/options/MathMenu.rst index 67abacdb5..03ea8e31b 100644 --- a/docs/source/options/MathMenu.rst +++ b/docs/source/options/MathMenu.rst @@ -35,7 +35,7 @@ would set the ``delay`` option to 600 milliseconds. .. describe:: showRenderer: true This controls whether the "Math Renderer" item will be displayed in - the the "Settings" submenu of the mathematics contextual menu. It + the "Settings" submenu of the mathematics contextual menu. It allows the user to change between the `HTML-CSS` and `NativeMML` output processors for the mathematics on the page. Set to ``false`` to prevent this menu item from showing. @@ -43,9 +43,9 @@ would set the ``delay`` option to 600 milliseconds. .. describe:: showContext: false This controls whether the "Contextual Menu" item will be displayed - in the the "Settings" submenu of the mathematics contextual menu. + in the "Settings" submenu of the mathematics contextual menu. It allows the user to decide whether the MathJax menu or the - browser's default contextual manu will be shown when the context + browser's default contextual menu will be shown when the context menu click occurs over mathematics typeset by MathJax. (The main reason to allow pass-through to the browser's menu is to gain access to the MathPlayer contextual menu when the NativeMML output @@ -56,7 +56,7 @@ would set the ``delay`` option to 600 milliseconds. .. describe:: showFontMenu: false This controls whether the "Font Preference" item will be displayed - in the the "Settings" submenu of the mathematics contextual menu. + in the "Settings" submenu of the mathematics contextual menu. This submenu lets the user select what font to use in the mathematics produced by the `HTML-CSS` output processor. Note that changing the selection in the font menu will cause the page to diff --git a/docs/source/options/NativeMML.rst b/docs/source/options/NativeMML.rst index 478dd63fa..ef2b12e55 100644 --- a/docs/source/options/NativeMML.rst +++ b/docs/source/options/NativeMML.rst @@ -18,13 +18,13 @@ in your :meth:`MathJax.Hub.Config()` call. For example } }); -would set the ``sale`` option to 105 percent. +would set the ``scale`` option to 105 percent. .. describe:: scale: 100 The scaling factor (as a percentage) of math with respect to the surrounding text. Since the `NativeMML` output relies on the - browser's natiove MathML support, MathJax does not control the + browser's native MathML support, MathJax does not control the font size used in the mathematics. You may need to set this value to compensate for the size selected by the browser. The user can also adjust this value using the contextual menu item associated @@ -49,7 +49,7 @@ would set the ``sale`` option to 105 percent. There is a separate menu setting for MSIE since the code to handle that is a bit delicate; if it turns out to have unexpected - consequences, you can turn it off without turing off other the + consequences, you can turn it off without turning off the menu support in other browsers. .. describe:: styles: {} diff --git a/docs/source/options/TeX.rst b/docs/source/options/TeX.rst index 38793247a..19471fff6 100644 --- a/docs/source/options/TeX.rst +++ b/docs/source/options/TeX.rst @@ -47,7 +47,7 @@ to be defined within the TeX input processor. This lists macros to define before the TeX input processor begins. These are name:value pairs where the `name` gives the name of the TeX macro to be defined, and `value` gives the replacement text for the - macro. The `value` canbe an array of the form `[value,n]`, where + macro. The `value` can be an array of the form `[value,n]`, where `value` is the replacement text and `n` is the number of parameters for the macro. Note that since the `value` is a javascript string, backslashes in the replacement text must be doubled to prevent them @@ -64,12 +64,12 @@ to be defined within the TeX input processor. would ask the TeX processor to define two new macros: ``\RR``, which produces a bold-face "R", and ``\bold{...}``, which takes one - parameter and set it in the bold-face font. + parameter and sets it in the bold-face font. .. describe:: MAXMACROS: 10000 Because a definition of the form ``\def\x{\x} \x`` would cause MathJax - to loop infinitely, the `MAXMACROS` constant will limit the nuber of + to loop infinitely, the `MAXMACROS` constant will limit the number of macro substitutions allowed in any expression processed by MathJax. .. describe:: MAXBUFFER: 5*1024 @@ -78,4 +78,4 @@ to be defined within the TeX input processor. infinitely, and at the same time stack up lots of a's in MathJax's equation buffer, the `MAXBUFFER` constant is used to limit the size of the string being processed by MathJax. It is set to 5KB, which should - be sufficient for any reasonable equation. \ No newline at end of file + be sufficient for any reasonable equation. diff --git a/docs/source/options/hub.rst b/docs/source/options/hub.rst index 364a749e2..4c9e4d9c4 100644 --- a/docs/source/options/hub.rst +++ b/docs/source/options/hub.rst @@ -52,11 +52,11 @@ behavior of MathJax. They are given with their default values. are not using one of the preprocessors, you need to insert something extra into your HTML file in order to avoid a bug in Internet Explorer. IE removes spaces from the DOM that it thinks - are redundent, and since a `` - to load MathJax from our distributed netowrk service. + to load MathJax from our distributed network service. .. image:: ../images/mt_head.png 5. Save the file. This will enable MathJax with both TeX and MathML input, so you should be able to start adding mathematical content to - your pages. If you need to adjust the configuraiton, see + your pages. If you need to adjust the configuration, see :ref:`Configuring MathJax ` for more details. diff --git a/docs/source/platforms/wordpress.rst b/docs/source/platforms/wordpress.rst index ef3df88c6..25b380f2e 100644 --- a/docs/source/platforms/wordpress.rst +++ b/docs/source/platforms/wordpress.rst @@ -38,5 +38,5 @@ better choice than editing the theme directly. 4. Save the file. This will enable MathJax with both TeX and MathML input, so you should be able to start adding mathematical content to - your pages. If you need to adjust the configuraiton, see + your pages. If you need to adjust the configuration, see :ref:`Configuring MathJax ` for more details. diff --git a/docs/source/queues.rst b/docs/source/queues.rst index d85fa50d0..289118049 100644 --- a/docs/source/queues.rst +++ b/docs/source/queues.rst @@ -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 javascript code that you may write as part of dynamic web pages. 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 `MathJax.Callback.Queue` object provides that mechanism. @@ -69,11 +69,11 @@ that could operate asynchronously. For example: [f, 2] ); -Here, the command ``MathJax.Ajax.require("extensions/AMSmath.js")`` is -queued between two calls to ``f``. The first call to ``f(1)`` will be -made immediately, then the :meth:`MathJax.Ajax.Require` statement will -be performed. Since the ``Require`` method loads a file, it operates -asynchronously, and its return value is a `MathJax.Callback` +Here, the command ``MathJax.Ajax.Require("[MathJax]/extensions/AMSmath.js")`` +is queued between two calls to ``f``. The first call to ``f(1)`` will +be made immediately, then the :meth:`MathJax.Ajax.Require` statement +will be performed. Since the ``Require`` method loads a file, it +operates asynchronously, and its return value is a `MathJax.Callback` object that will be called when the file is loaded. The call to ``f(2)`` will not be made until that callback is performed, effectively synchronizing the second call to ``f`` with the completion @@ -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 commands can cause the typesetting process to be suspended while the file is loaded, and then restarted when the extension has become -evailable. +available. As a result, any call to :meth:`MathJax.Hub.Typeset()` (or :meth:`MathJax.Hub.Process()`, or :meth:`MathJax.Hub.Update()`, etc.) could return long before the mathematics is actually typeset, and the 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 synchronized with the typesetting via the MathJax queue. diff --git a/docs/source/signals.rst b/docs/source/signals.rst index 418248c3b..7b385c884 100644 --- a/docs/source/signals.rst +++ b/docs/source/signals.rst @@ -5,7 +5,7 @@ Using Signals ************* Because much of MathJax operates asynchronously, it is important for -MathJax to be able to indicated to other components operating on the +MathJax to be able to indicate to other components operating on the page that certain actions have been taken. For example, as MathJax is starting up, it loads external files such as its configuration files and the various input and output :term:`jax` that are used on the @@ -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 work, because the listener will receive the ready signal even if it 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. 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 using signals. This example lists all the signals that occur while 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 file (from the same directory as the web page). Since it returns diff --git a/docs/source/start.rst b/docs/source/start.rst index 7dc528c6d..2490cb6ef 100644 --- a/docs/source/start.rst +++ b/docs/source/start.rst @@ -47,7 +47,7 @@ that, and otherwise use HTML-with-CSS to display the mathematics. This is the most general configuration, and should suffice for most people's needs. Other configurations are available, however, and you can also provide additional configuration parameters to taylor one of -the confiogurations to your needs. More details can be found in the +the configurations to your needs. More details can be found in the :ref:`Loading and Configuring MathJax ` instructions. The use of ``cdn.mathjax.org`` is governed by its `terms of service @@ -123,7 +123,7 @@ Configuring your copy of MathJax When you include MathJax into your web pages as described below, it will load the file ``config/TeX-AMS-MML_HTMLorMML.js`` (i.e., the file named ``TeX-AMS-MML_HTMLorMML.js`` in the ``config`` folder of the -main ``MathJax`` folder). This file preloads all the most comply-used +main ``MathJax`` folder). This file preloads all the most commonly-used components of MathJax, allowing it to process mathematics that is in the TeX or LaTeX format, or in MathML notation. It will produce output in MathML form if the user's browser supports that, and will use @@ -138,7 +138,7 @@ described more fully in :ref:`Common Configurations Note: The configuration process has changed in MathJax v1.1, so if you have existing pages that use MathJax, you may need to modify the tag that -loads MathJax so that is conforms with the new configuration process. +loads MathJax so that it conforms with the new configuration process. See :ref:`Installing and Configuring MathJax ` for more details. @@ -227,13 +227,13 @@ math mode, you must enable that explicitly in your configuration: tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]} }); - + See the ``config/default.js`` file, or the :ref:`tex2jax configuration options ` page, for additional configuration parameters that you can specify for the `tex2jax` preprocessor, which is the component of MathJax that identifies TeX notation within -the page). See the :ref:`TeX and LaTeX ` page for +the page. See the :ref:`TeX and LaTeX ` page for more on MathJax's support for TeX. Here is a complete sample page containing TeX mathematics (also available diff --git a/docs/source/startup.rst b/docs/source/startup.rst index eb25d8253..c157d0fd6 100644 --- a/docs/source/startup.rst +++ b/docs/source/startup.rst @@ -154,7 +154,7 @@ are requested simultaneously, so they load concurrently. That means they can load in any order, and that the begin and end signals for the jax and extensions can be intermixed. (In general, you will get `Begin Jax` followed by `Begin Extensions`, but the order of `End Jax` and `End -Extensions` will depend on the file sbeing loaded.) Both 5 and 6 must +Extensions` will depend on the files being loaded.) Both 5 and 6 must complete, however, before 7 will be performed. -See the ``test/sample-signals.html`` file to see the signals in action. \ No newline at end of file +See the ``test/sample-signals.html`` file to see the signals in action. diff --git a/docs/source/synchronize.rst b/docs/source/synchronize.rst index a285f2a7d..2f707c695 100644 --- a/docs/source/synchronize.rst +++ b/docs/source/synchronize.rst @@ -22,14 +22,14 @@ initiates an action, waits for it to complete, and then goes on, you break the function into two parts: a first part that sets up and initiates the action, and a second that runs after the action is finished. Callbacks are similar to event handlers that you attach to -DOM elements, and are called when an certain action occurs. See the +DOM elements, and are called when a certain action occurs. See the :ref:`Callback Object ` reference page for details of how to specify a callback. **Queues** are MathJax's means of synchronizing actions that must be performed sequentially, even when they involve asynchronous events 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 next. MathJax maintains a master queue that you can use to synchronize with MathJax, but you can also create your own private @@ -47,7 +47,7 @@ will call your code. 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 "memory", meaning that if you register an interest in a particular 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 +told about the past occurrences as well as any future ones. See the :ref:`Signal Object ` reference page for more details. See also the ``test/sample-signals.html`` file in the MathJax ``test`` directory for a working example of using signals. diff --git a/docs/source/tex.rst b/docs/source/tex.rst index 7f09b4ca9..d70aaa760 100644 --- a/docs/source/tex.rst +++ b/docs/source/tex.rst @@ -39,7 +39,7 @@ you need a LaTeX-to-HTML converter, you should consider `other options TeX and LaTeX math delimiters ============================= -By default, the `tex2jax` preprocesor defines the LaTeX math delimiters, +By default, the `tex2jax` preprocessor defines the LaTeX math delimiters, which are ``\(...\)`` for in-line math, and ``\[...\]`` for displayed equations. It also defines the TeX delimiters ``$$...$$`` for displayed equations, but it does **not** define ``$...$`` as in-line math @@ -72,7 +72,7 @@ See the ``config/default.js`` file, or the :ref:`tex2jax configuration options ` page, for additional configuration parameters that you can specify for the `tex2jax` preprocessor, which is the component of MathJax that identifies TeX notation within -the page). +the page. TeX and LaTeX in HTML documents @@ -86,7 +86,7 @@ Also, since the mathematics is initially given as text on the page, you need to be careful that your mathematics doesn't look like HTML tags to the browser (which parses the page before MathJax gets to see it). In particular, that means that you have to be careful about -things like less-than and greater-than signs (``<``and ``>``), and +things like less-than and greater-than signs (``<`` and ``>``), and ampersands (``&``), which have special meaning to the browsers. For example, @@ -99,10 +99,10 @@ 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 to the next ``>`` in the document (typically the end of the next 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 -have ...`` will not be displayed because the browser thinks it is +part of the text of the document. In the example above, the "``we +have ...``" will not be displayed because the browser thinks it is part of the tag starting at ```` element, or even a MathJax math -`` @@ -74,7 +74,7 @@ input {margin-top: .7em}

-Type some $\rm\TeX$ code and press RETURN:
+Type some \(\rm\TeX\) code and press RETURN: