From 39b78b1477b3ac56e8e0bc2efc6684806d9c9795 Mon Sep 17 00:00:00 2001
From: "Davide P. Cervone"
Date: Mon, 20 Feb 2012 18:01:27 -0500
Subject: [PATCH] Updated configuration options documentaiton and added SVG and
MathEvents documentation
---
docs/html/_sources/options/AsciiMath.txt | 9 +-
docs/html/_sources/options/HTML-CSS.txt | 93 ++++--
docs/html/_sources/options/MMLorHTML.txt | 32 +-
docs/html/_sources/options/MathEvents.txt | 37 +++
docs/html/_sources/options/MathML.txt | 3 +-
docs/html/_sources/options/MathMenu.txt | 46 +--
docs/html/_sources/options/MathZoom.txt | 19 +-
docs/html/_sources/options/NativeMML.txt | 49 ++--
docs/html/_sources/options/SVG.txt | 162 +++++++++++
docs/html/_sources/options/TeX.txt | 104 +++++--
docs/html/_sources/options/asciimath2jax.txt | 20 +-
docs/html/_sources/options/hub.txt | 72 ++++-
docs/html/_sources/options/index.txt | 8 +-
docs/html/_sources/options/tex2jax.txt | 35 ++-
docs/html/_sources/output.txt | 35 ++-
docs/html/options/AsciiMath.html | 9 +-
docs/html/options/FontWarnings.html | 10 +-
docs/html/options/HTML-CSS.html | 98 +++++--
docs/html/options/MMLorHTML.html | 48 ++-
docs/html/options/MathEvents.html | 141 +++++++++
docs/html/options/MathML.html | 3 +-
docs/html/options/MathMenu.html | 50 ++--
docs/html/options/MathZoom.html | 29 +-
docs/html/options/NativeMML.html | 58 ++--
docs/html/options/SVG.html | 291 +++++++++++++++++++
docs/html/options/TeX.html | 78 ++++-
docs/html/options/asciimath2jax.html | 20 +-
docs/html/options/hub.html | 72 ++++-
docs/html/options/index.html | 8 +-
docs/html/options/tex2jax.html | 35 ++-
docs/html/output.html | 30 +-
docs/html/searchindex.js | 2 +-
docs/source/options/AsciiMath.rst | 9 +-
docs/source/options/HTML-CSS.rst | 93 ++++--
docs/source/options/MMLorHTML.rst | 32 +-
docs/source/options/MathEvents.rst | 37 +++
docs/source/options/MathML.rst | 3 +-
docs/source/options/MathMenu.rst | 46 +--
docs/source/options/MathZoom.rst | 19 +-
docs/source/options/NativeMML.rst | 49 ++--
docs/source/options/SVG.rst | 162 +++++++++++
docs/source/options/TeX.rst | 104 +++++--
docs/source/options/asciimath2jax.rst | 20 +-
docs/source/options/hub.rst | 72 ++++-
docs/source/options/index.rst | 8 +-
docs/source/options/tex2jax.rst | 35 ++-
docs/source/output.rst | 35 ++-
47 files changed, 1981 insertions(+), 449 deletions(-)
create mode 100644 docs/html/_sources/options/MathEvents.txt
create mode 100644 docs/html/_sources/options/SVG.txt
create mode 100644 docs/html/options/MathEvents.html
create mode 100644 docs/html/options/SVG.html
create mode 100644 docs/source/options/MathEvents.rst
create mode 100644 docs/source/options/SVG.rst
diff --git a/docs/html/_sources/options/AsciiMath.txt b/docs/html/_sources/options/AsciiMath.txt
index 981815b72..ed766ee1a 100644
--- a/docs/html/_sources/options/AsciiMath.txt
+++ b/docs/html/_sources/options/AsciiMath.txt
@@ -6,10 +6,11 @@ The AsciiMath input processor
The options below control the operation of the AsciiMath input
processor that is run when you include ``"input/AsciiMath"`` in the
-`jax` array of your configuration or use a combined configuration file
-that includes AsciiMath input. They are listed with their default
-values. To set any of these options, include a ``AsciiMath`` section
-in your :meth:`MathJax.Hub.Config()` call. For example
+`jax` array of your configuration or load a combined configuration
+file that includes the AsciiMath input jax. They are listed with
+their default values. To set any of these options, include a
+``AsciiMath`` section in your :meth:`MathJax.Hub.Config()` call. For
+example
.. code-block:: javascript
diff --git a/docs/html/_sources/options/HTML-CSS.txt b/docs/html/_sources/options/HTML-CSS.txt
index f8cb0fd2e..b52339823 100644
--- a/docs/html/_sources/options/HTML-CSS.txt
+++ b/docs/html/_sources/options/HTML-CSS.txt
@@ -6,10 +6,12 @@ The HTML-CSS output processor
The options below control the operation of the HTML-CSS output
processor that is run when you include ``"output/HTML-CSS"`` in the
-`jax` array of your configuration. They are listed with their default
-values. To set any of these options, include a ``"HTML-CSS"`` section
-in your :meth:`MathJax.Hub.Config()` call. Note that, because of the
-dash, you need to enclose the name in quotes. For example
+`jax` array of your configuration or load a combined configuration
+file that includes the HTML-CSS output jax. They are listed with
+their default values. To set any of these options, include a
+``"HTML-CSS"`` section in your :meth:`MathJax.Hub.Config()` call.
+Note that, because of the dash, you need to enclose the name in
+quotes. For example
.. code-block:: javascript
@@ -25,7 +27,7 @@ would set the ``preferredFont`` option to the :term:`STIX` fonts.
The scaling factor (as a percentage) of math with respect to the
surrounding text. The `HTML-CSS` output processor tries to match
- the en-size of the mathematics with that of the text where it is
+ the ex-size of the mathematics with that of the text where it is
placed, but you may want to adjust the results using this scaling
factor. The user can also adjust this value using the contextual
menu item associated with the typeset mathematics.
@@ -86,6 +88,68 @@ would set the ``preferredFont`` option to the :term:`STIX` fonts.
(even if it doesn't contain the needed character), so order these
carefully.
+.. describe:: mtextFontInherit: false
+
+ This setting controls whether ```` elements will be typeset
+ using the math fonts or the font of the surrounding text. When
+ ``false``, the font for ``mathvariant="normal"`` will be used;
+ when ``true``, the font will be inherited from the surrounding
+ paragraph.
+
+.. describe:: EqnChunk: 50
+ EqnChunkFactor: 1.5
+ EqnChunkDelay: 100
+
+ These values control how "chunky" the display of mathematical
+ expressions will be; that is, how often the equations will be
+ updated as they are processed.
+
+ ``EqnChunk`` is the number of equations that will be typeset before
+ they appear on screen. Larger values make for less visual flicker
+ as the equations are drawn, but also mean longer delays before the
+ reader sees anything.
+
+ ``EqChunkFactor`` is the factor by which the ``EqnChunk`` will
+ grow after each chunk is displayed.
+
+ ``EqChunkDelay`` is the time (in milliseconds) to delay between
+ chunks (to allow the browser to respond to other user
+ interaction).
+
+ Set ``EqnChunk`` to 1, ``EqnChunkFactor`` to 1, and
+ ``EqnChunkDelay`` to 10 to get the behavior from MathJax v1.1 and
+ below.
+
+.. describe:: linebreaks: {}
+
+ This is an object that configures automatic linebreaking in the
+ HTML-CSS output. In order to be backward compatible with earlier
+ versions of MathJax, only explicit line breaks are performed by
+ default, so you must enable line breaks if you want automatic
+ ones. The object contains the following values:
+
+ .. describe:: automatic: false
+
+ This controls the automatic breaking of expressions: when
+ ``false``, only ``linebreak="newline"`` is processed; when
+ ``true``, line breaks are inserted automatically in long
+ expressions.
+
+ .. describe:: width: "container"
+
+ This controls how wide the lines of mathematics can be.
+
+ Use an explicit width like ``"30em"`` for a fixed width.
+ Use ``"container"`` to compute the size from the containing
+ element.
+ Use ``"nn% container"`` for a portion of the container.
+ Use ``"nn%"`` for a portion of the window size.
+
+ The container-based widths may be slower, and may not produce
+ the expected results if the layout width changes due to the
+ removal of previews or inclusion of mathematics during
+ typesetting.
+
.. describe:: styles: {}
This is a list of CSS declarations for styling the HTML-CSS
@@ -96,18 +160,10 @@ would set the ``preferredFont`` option to the :term:`STIX` fonts.
.. describe:: showMathMenu: true
- This controls whether the MathJax contextual menu will be
- available on the mathematics in the page. If true, then
- right-clicking (on the PC) or control-clicking (on the Mac) will
- produce a MathJax menu that allows you to get the source of the
- mathematics in various formats, change the size of the mathematics
- relative to the surrounding text, get information about
- MathJax, and configure other MathJax settings.
-
- Set this to ``false`` to disable the menu. When ``true``, the
- ``MathMenu`` configuration block determines the operation of the
- menu. See :ref:`the MathMenu options ` for
- more details.
+ This value has been moved to the core configuration block, since
+ it applies to all output jax, but it will still be honored (for
+ now) if it is set here. See the :ref:`Core configuration options
+ ` for more details.
.. describe:: tooltip: { ... }
@@ -128,7 +184,8 @@ would set the ``preferredFont`` option to the :term:`STIX` fonts.
The delay (in milliseconds) before the tooltop is cleared
after the mouse moves out of the ``maction`` element.
- .. describe:: offsetX: 10 and offsetY: 5
+ .. describe:: offsetX: 10
+ offsetY: 5
These are the offset from the mouse position (in pixels)
where the tooltip will be placed.
diff --git a/docs/html/_sources/options/MMLorHTML.txt b/docs/html/_sources/options/MMLorHTML.txt
index 023de9461..77d808a20 100644
--- a/docs/html/_sources/options/MMLorHTML.txt
+++ b/docs/html/_sources/options/MMLorHTML.txt
@@ -6,9 +6,11 @@ The MMLorHTML configuration options
The options below control the operation of the MMLorHTML configuration
file that is run when you include ``"MMLorHTML.js"`` in the `config`
-array of your configuration. They are listed with their default
-values. To set any of these options, include a ``MMLorHTML`` section
-in your :meth:`MathJax.Hub.Config()` call. For example
+array of your configuration, or when you use one of the combined
+configuration files that ends with ``_HTMLorMML``. They are listed
+with their default values. To set any of these options, include a
+``MMLorHTML`` section in your :meth:`MathJax.Hub.Config()` call. For
+example
.. code-block:: javascript
@@ -28,15 +30,29 @@ Note that if you use the ``MMLorHTML.js`` configuration file, you should
**not** specify an output processor in the `jax` array of your
configuration; `MMLorHTML` will fill that in for you.
-.. describe:: prefer: { MSIE: "MML", Firefox: "MML", Opera: "HTML", other: "HTML" }
+.. describe:: prefer: {
+ MSIE: "MML",
+ Firefox: "HTML",
+ Safari: "HTML",
+ Chrome: "HTML",
+ Opera: "HTML",
+ other: "HTML"
+ }
This lets you set the preferred renderer on a browser-by-browser
basis. You set the browser to either ``"MML"`` or ``"HTML"``
depending on whether you want to use the `NativeMML` or `HTML-CSS`
- output processor. Note that although Opera does process some MathML
- natively, its support is not sufficient to handle the more
- complicated output generated by MathJax, so its setting is
- ``"HTML"`` by default.
+ output processor. Note that although Opera and Safari do process some MathML
+ natively, their support is not sufficient to handle the more
+ complicated output generated by MathJax, so their settings are
+ ``"HTML"`` by default. Although Firefox does support a large
+ subset of MathJax, it does not implement all the features needed by
+ MathJax, and so it is also set to ``"HTML"`` by default (this is
+ new in v2.0).
+
+ Note that users can still use the MathJax contextual menu to select
+ a different renderer after the default one has been chosen by
+ ``MMLorHTML.js``.
diff --git a/docs/html/_sources/options/MathEvents.txt b/docs/html/_sources/options/MathEvents.txt
new file mode 100644
index 000000000..512b28f85
--- /dev/null
+++ b/docs/html/_sources/options/MathEvents.txt
@@ -0,0 +1,37 @@
+.. _configure-MathEvents:
+
+************************
+The MathEvents extension
+************************
+
+The options below control the operation of the MathEvents component that
+allows handles mouse and menu events attached to mathematics that is
+typeset by MathJax. They are listed with their
+default values. To set any of these options, include a ``MathEvents``
+section in your :meth:`MathJax.Hub.Config()` call. For example
+
+.. code-block:: javascript
+
+ MathJax.Hub.Config({
+ MathEvents: {
+ hover: 400
+ }
+ });
+
+would set the required delay for hovering over a math element to
+400 milliseconds.
+
+.. describe:: hover: 500
+
+ This value is the time (in milliseconds) that a user must hold the
+ mouse still over a math element before it is considered to be
+ hovering over the math.
+
+.. describe:: styles: {}
+
+ This is a list of CSS declarations for styling the zoomed
+ mathematics. See the definitions in ``extensions/MathEvents.js``
+ for details of what are defined by default. See :ref:`CSS Style
+ Objects ` for details on how to specify CSS
+ style in a JavaScript object.
+
diff --git a/docs/html/_sources/options/MathML.txt b/docs/html/_sources/options/MathML.txt
index 7624bdcbb..9038b743f 100644
--- a/docs/html/_sources/options/MathML.txt
+++ b/docs/html/_sources/options/MathML.txt
@@ -6,7 +6,8 @@ The MathML input processor
The options below control the operation of the MathML input processor
that is run when you include ``"input/MathML"`` in the `jax` array of
-your configuration. They are listed with their default values. To
+your configuration or load a combined configuration file that includes
+the MathML input jax. They are listed with their default values. To
set any of these options, include a ``MathML`` section in your
:meth:`MathJax.Hub.Config()` call. For example
diff --git a/docs/html/_sources/options/MathMenu.txt b/docs/html/_sources/options/MathMenu.txt
index 03ea8e31b..6b8529735 100644
--- a/docs/html/_sources/options/MathMenu.txt
+++ b/docs/html/_sources/options/MathMenu.txt
@@ -34,33 +34,41 @@ would set the ``delay`` option to 600 milliseconds.
.. describe:: showRenderer: true
- This controls whether the "Math Renderer" item will be displayed in
- 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.
-
-.. describe:: showContext: false
-
- This controls whether the "Contextual Menu" item will be displayed
- 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 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
- processor is used in Internet Explorer with the `MathPlayer plugin
- `_.) Set to
- ``false`` to prevent this menu item from showing.
+ This controls whether the "Math Renderer" item will be displayed
+ in the "Math Settings" submenu of the MathJax contextual menu.
+ It allows the user to change between the `HTML-CSS`, `NativeMML`,
+ and `SVG` output processors for the mathematics on the page. Set
+ to ``false`` to prevent this menu item from showing.
.. describe:: showFontMenu: false
This controls whether the "Font Preference" item will be displayed
- in the "Settings" submenu of the mathematics contextual menu.
+ in the "Math Settings" submenu of the MathJax 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
reload. Set to ``false`` to prevent this menu item from showing.
+
+.. describe:: showMathPlayer: true
+
+ This controls whether the "MathPlayer" item will be displayed in
+ the "Math Settings" submenu of the MathJax contextual menu. This
+ submenu lets the user select what events should be passed on to
+ the `MathPlayer plugin
+ `_, when it is
+ present. Mouse events can be passed on (so that clicks will be
+ processed by MathPlayer rather than MathJax), and emnu events can
+ be passed on (to allow the user access to the MathPlayer menu).
+ Set to ``false`` to prevent this menu item from showing.
+
+.. describe:: showContext: false
+
+ This controls whether the "Contextual Menu" item will be displayed
+ in the "Math Settings" submenu of the MathJax contextual menu.
+ It allows the user to decide whether the MathJax menu or the
+ browser's default contextual menu will be shown when the context
+ menu click occurs over mathematics typeset by MathJax. Set to
+ ``false`` to prevent this menu item from showing.
.. describe:: windowSettings: { ... }
diff --git a/docs/html/_sources/options/MathZoom.txt b/docs/html/_sources/options/MathZoom.txt
index 3b7ddc7bf..709ab548b 100644
--- a/docs/html/_sources/options/MathZoom.txt
+++ b/docs/html/_sources/options/MathZoom.txt
@@ -14,23 +14,28 @@ section in your :meth:`MathJax.Hub.Config()` call. For example
MathJax.Hub.Config({
MathZoom: {
- delay: 600
+ styles: {
+ "#MathJax_Zoom": {
+ "background-color": "#0000F0"
+ }
+ }
}
});
-would set the ``delay`` option to 600 milliseconds.
+would set the background color of the Zoom box to a very light blue.
Mathematics is zoomed when the user "triggers" the zoom by an action,
either clicking on the mathematics, double-clicking on it, or holding
the mouse still over it (i.e., "hovering"). Which trigger is used is
set by the user via the math contextual menu (or by the author using
-the ``menuSettings`` configuration section).
+the ``menuSettings`` configuration section of the `core configuration
+options `).
-.. describe:: delay: 400
+.. describe:: delay: 500
- This the time (in milliseconds) that the mouse must be still over a
- typeset mathematical formula before the zoomed version is displayed
- (when the zoom trigger is set to `Hover`).
+ This value is now stored as the ``hover`` parameter in the
+ :ref:`MathEvents ` configuration options, and
+ will have no effect if given here.
.. describe:: styles: {}
diff --git a/docs/html/_sources/options/NativeMML.txt b/docs/html/_sources/options/NativeMML.txt
index a25aacb3f..c2e663b7a 100644
--- a/docs/html/_sources/options/NativeMML.txt
+++ b/docs/html/_sources/options/NativeMML.txt
@@ -6,9 +6,11 @@ The NativeMML output processor
The options below control the operation of the NativeMML output
processor that is run when you include ``"output/NativeMML"`` in the
-`jax` array of your configuration. They are listed with their default
-values. To set any of these options, include a ``NativeMML`` section
-in your :meth:`MathJax.Hub.Config()` call. For example
+`jax` array of your configuration or load a combined configuration
+file taht includes the NativeMML output jax. They are listed with
+their default values. To set any of these options, include a
+``NativeMML`` section in your :meth:`MathJax.Hub.Config()` call. For
+example
.. code-block:: javascript
@@ -23,35 +25,26 @@ 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 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
- with the typeset mathematics.
+ surrounding text. The `NativeMML` output processor tries to match
+ the ex-size of the mathematics with that of the text where it is
+ placed, but you may want to adjust the results using this scaling
+ factor. The user can also adjust this value using the contextual
+ menu item associated with the typeset mathematics.
+
+.. describe:: minScaleAdjust: 50
+
+ 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.
.. describe:: showMathMath: true
+ showMathMenuMSIE: true
- This controls whether the MathJax contextual menu will be
- available on the mathematics in the page. If true, then
- right-clicking (on the PC) or control-clicking (on the Mac) will
- produce a MathJax menu that allows you to get the source of the
- mathematics in various formats, change the size of the mathematics
- relative to the surrounding text, get information about
- MathJax, and configure other MathJax settings.
-
- Set this to ``false`` to disable the menu. When ``true``, the
- ``MathMenu`` configuration block determines the operation of the
- menu. See :ref:`the MathMenu options ` for
- more details.
+ These values have been moved to the core configuration block, since
+ it applies to all output jax, but they will still be honored (for
+ now) if it is set here. See the :ref:`Core configuration options
+ ` for more details.
-.. describe:: showMathMenuMSIE: true
-
- 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 turning off the
- menu support in other browsers.
-
.. describe:: styles: {}
This is a list of CSS declarations for styling the NativeMML
diff --git a/docs/html/_sources/options/SVG.txt b/docs/html/_sources/options/SVG.txt
new file mode 100644
index 000000000..bfbe9e5db
--- /dev/null
+++ b/docs/html/_sources/options/SVG.txt
@@ -0,0 +1,162 @@
+.. _configure-SVG:
+
+************************
+The SVG output processor
+************************
+
+The options below control the operation of the SVG output
+processor that is run when you include ``"output/SVG"`` in the
+`jax` array of your configuration or load a combined configuration
+file that includes the SVG output jax. They are listed with their default
+values. To set any of these options, include an ``SVG`` section
+in your :meth:`MathJax.Hub.Config()` call. Note that, because of the
+dash, you need to enclose the name in quotes. For example
+
+.. code-block:: javascript
+
+ MathJax.Hub.Config({
+ "SVG": {
+ scale: 120
+ }
+ });
+
+would set the ``scale`` option to 120%.
+
+.. describe:: scale: 100
+
+ The scaling factor (as a percentage) of math with respect to the
+ surrounding text. The `SVG` output processor tries to match
+ the ex-size of the mathematics with that of the text where it is
+ placed, but you may want to adjust the results using this scaling
+ factor. The user can also adjust this value using the contextual
+ menu item associated with the typeset mathematics.
+
+.. describe:: minScaleAdjust: 50
+
+ 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.
+
+.. describe:: font: "TeX"
+
+ This is the font to use for rendering the mathematics. Note that
+ currently only the `TeX` font is available.
+
+.. describe:: blacker: 10
+
+ This is the stroke width to use for all character paths (1em =
+ 1000 units). This is a cheap way of getting slightly lighter or
+ darker characters, but remember that not all displays will act the
+ same, so a value that is good for you may not be good for everyone.
+
+.. describe:: undefinedFamily: "STIXGeneral, 'Arial Unicode MS', serif"
+
+ This is the font-family CSS value used for characters that are not
+ in the selected font (e.g., this is where to look for characters
+ not included in the MathJax TeX fonts). IE will stop looking
+ after the first font that exists on the system (even if it doesn't
+ contain the needed character), so order these carefully.
+
+.. describe:: mtextFontInherit: false
+
+ This setting controls whether ```` elements will be typeset
+ using the math fonts or the font of the surrounding text. When
+ ``false``, the font for ``mathvariant="normal"`` will be used;
+ when ``true``, the font will be inherited from the surrounding
+ paragraph.
+
+.. describe:: addMMLclasses: false
+
+ This controls whether the MathML structure is retained and CSS
+ classes are added to mark the original MathML elements (as in the
+ output from the `HTML-CSS` output jax). By default, the SVG
+ output jax removes unneeded nesting in order to produce a more
+ efficient markup, but if you want to use CSS to style the elements
+ as if they were MathML, you might need to set this to true.
+
+.. describe:: EqnChunk: 50
+ EqnChunkFactor: 1.5
+ EqnChunkDelay: 100
+
+ These values control how "chunky" the display of mathematical
+ expressions will be; that is, how often the equations will be
+ updated as they are processed.
+
+ ``EqnChunk`` is the number of equations that will be typeset before
+ they appear on screen. Larger values make for less visual flicker
+ as the equations are drawn, but also mean longer delays before the
+ reader sees anything.
+
+ ``EqChunkFactor`` is the factor by which the ``EqnChunk`` will
+ grow after each chunk is displayed.
+
+ ``EqChunkDelay`` is the time (in milliseconds) to delay between
+ chunks (to allow the browser to respond to other user
+ interaction).
+
+ Set ``EqnChunk`` to 1, ``EqnChunkFactor`` to 1, and
+ ``EqnChunkDelay`` to 10 to get the behavior from MathJax v1.1 and
+ below.
+
+.. describe:: linebreaks: {}
+
+ This is an object that configures automatic linebreaking in the
+ SVG output. In order to be backward compatible with earlier
+ versions of MathJax, only explicit line breaks are performed by
+ default, so you must enable line breaks if you want automatic
+ ones. The object contains the following values:
+
+ .. describe:: automatic: false
+
+ This controls the automatic breaking of expressions: when
+ ``false``, only ``linebreak="newline"`` is processed; when
+ ``true``, line breaks are inserted automatically in long
+ expressions.
+
+ .. describe:: width: "container"
+
+ This controls how wide the lines of mathematics can be.
+
+ Use an explicit width like ``"30em"`` for a fixed width.
+ Use ``"container"`` to compute the size from the containing
+ element.
+ Use ``"nn% container"`` for a portion of the container.
+ Use ``"nn%"`` for a portion of the window size.
+
+ The container-based widths may be slower, and may not produce
+ the expected results if the layout width changes due to the
+ removal of previews or inclusion of mathematics during
+ typesetting.
+
+.. describe:: styles: {}
+
+ This is a list of CSS declarations for styling the SVG output.
+ See the definitions in ``jax/output/SVG/config.js`` for some
+ examples of what are defined by default. See :ref:`CSS Style
+ Objects ` for details on how to specify CSS
+ style in a JavaScript object.
+
+.. describe:: tooltip: { ... }
+
+ This sets the configuration options for ```` elements
+ with ``actiontype="tooltip"``. (See also the ``#MathJax_Tooltip``
+ style setting in ``jax/output/SVG/config.js``, which can be
+ overridden using the ``styles`` option above.)
+
+ The ``tooltip`` section can contain the following options:
+
+ .. describe:: delayPost: 600
+
+ The delay (in milliseconds) before the tooltip is posted after
+ the mouse is moved over the ``maction`` element.
+
+ .. describe:: delayClear: 600
+
+ The delay (in milliseconds) before the tooltop is cleared
+ after the mouse moves out of the ``maction`` element.
+
+ .. describe:: offsetX: 10
+ offsetY: 5
+
+ These are the offset from the mouse position (in pixels)
+ where the tooltip will be placed.
diff --git a/docs/html/_sources/options/TeX.txt b/docs/html/_sources/options/TeX.txt
index 19471fff6..949556b5d 100644
--- a/docs/html/_sources/options/TeX.txt
+++ b/docs/html/_sources/options/TeX.txt
@@ -6,7 +6,8 @@ The TeX input processor
The options below control the operation of the TeX input processor
that is run when you include ``"input/TeX"`` in the `jax` array of
-your configuration. They are listed with their default values. To
+your configuration or load a combined configuration file that includes
+the TeX input jax. They are listed with their default values. To
set any of these options, include a ``TeX`` section in your
:meth:`MathJax.Hub.Config()` call. For example
@@ -41,41 +42,90 @@ to be defined within the TeX input processor.
either side of the equation, but if you are displaying mathematics
in a small area or a thin column of text, you might need to change
the value to leave sufficient margin for tags.
+
+.. describe:: equationNumbers: {}
+
+ This object controls the automatic equation numbering and the
+ equation referencing. It contains the following values:
+
+ .. describe:: autoNumber: "none"
+
+ This controls whether equations are numbered and how. By
+ default it is set to ``"none"`` to be compatible with earlier
+ versions of MathJax where auto-numbering was not performed (so
+ pages will not change their appearance). You can change
+ this to ``"AMS"`` for equations numbered as the `AMSmath`
+ package would do, or ``"all"`` to get an equation number for
+ every displayed equation.
+
+ .. describe:: formatNumber: function (n) {return n}
+
+ A function that tells MathJax what tag to use for equation
+ number ``n``. This could be used to have the equations labeled
+ by a sequence of symbols rather than numbers, or to use section
+ and subsection numbers instead.
+
+ .. describe:: formatTag: function (n) {return '('+n+')'}
+
+ A function that tells MathJax how to format an equation number
+ for displaying as a tag for an equation. This is what appears
+ in the margin of a tagged or numbered equation.
+
+ .. describe:: formatID: function {return 'mjx-eqn-'+String(n).replace(/[:'"<>&]/g,"")}
+
+ A function that rells MathJax what ID to use as an anchor for
+ the equation (so that it can be used in URL references).
+
+ .. describe:: formatURL: function (id) {return '#'+escape(id)}
+
+ A function that takes an equation ID and returns the URL to
+ link to it.
+
+ .. describe:: useLabelIds: true
+
+ This controls whether element ID's use the ``\label`` name or
+ the equation number. When ``true``, use the label, when
+ ``false``, use the equation number.
+
+ See the `MathJax examples page
+ `_ for
+ some examples of equation numbering.
.. describe:: Macros: {}
- 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` 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
- from acting as javascript escape characters.
+ 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` 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 from acting as javascript escape
+ characters.
- For example,
+ For example,
- .. code-block:: javascript
+ .. code-block:: javascript
+
+ Macros: {
+ RR: '{\\bf R}',
+ bold: ['{\\bf #1}', 1]
+ }
- Macros: {
- RR: '{\\bf R}',
- bold: ['{\\bf #1}', 1]
- }
-
- would ask the TeX processor to define two new macros: ``\RR``,
- which produces a bold-face "R", and ``\bold{...}``, which takes one
- parameter and sets it in the bold-face font.
+ would ask the TeX processor to define two new macros: ``\RR``,
+ which produces a bold-face "R", and ``\bold{...}``, which takes one
+ 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 number of
- macro substitutions allowed in any expression processed by MathJax.
+ Because a definition of the form ``\def\x{\x} \x`` would cause MathJax
+ to loop infinitely, the `MAXMACROS` constant will limit the number of
+ macro substitutions allowed in any expression processed by MathJax.
.. describe:: MAXBUFFER: 5*1024
- Because a definition of the form ``\def\x{\x aaa} \x`` would loop
- 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.
+ Because a definition of the form ``\def\x{\x aaa} \x`` would loop
+ 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.
diff --git a/docs/html/_sources/options/asciimath2jax.txt b/docs/html/_sources/options/asciimath2jax.txt
index cb899efa7..f408a1846 100644
--- a/docs/html/_sources/options/asciimath2jax.txt
+++ b/docs/html/_sources/options/asciimath2jax.txt
@@ -86,11 +86,11 @@ preprocessor to include dollar signs as well as back-ticks.
special characters. The pattern is inserted into one that
requires your pattern to match a complete word, so setting
``ignoreClass: "class2"`` would cause it to match an element with
- ``class="class1 class2 class3"``. Note that you can assign
- several classes by separating them by the vertical line character
- (``|``). For instance, with ``ignoreClass: "class1|class2"``
- any element assigned a class of either ``class1`` or ``class2``
- will be skipped.
+ ``class="class1 class2 class3"`` but not ``class="myclass2"``.
+ Note that you can assign several classes by separating them by the
+ vertical line character (``|``). For instance, with
+ ``ignoreClass: "class1|class2"`` any element assigned a class of
+ either ``class1`` or ``class2`` will be skipped.
.. describe:: processClass: "asciimath2jax_process"
@@ -103,8 +103,8 @@ preprocessor to include dollar signs as well as back-ticks.
`regexp` special characters. The pattern is inserted into one
that requires your pattern to match a complete word, so setting
``processClass: "class2"`` would cause it to match an element with
- ``class="class1 class2 class3"``. Note that you can assign
- several classes by separating them by the vertical line character
- (``|``). For instance, with ``processClass: "class1|class2"`` any
- element assigned a class of either ``class1`` or ``class2`` will
- have its contents processed.
+ ``class="class1 class2 class3"`` but not ``class="myclass2"``.
+ Note that you can assign several classes by separating them by the
+ vertical line character (``|``). For instance, with
+ ``processClass: "class1|class2"`` any element assigned a class of
+ either ``class1`` or ``class2`` will have its contents processed.
diff --git a/docs/html/_sources/options/hub.txt b/docs/html/_sources/options/hub.txt
index 1c86cac71..5b4e8d4c4 100644
--- a/docs/html/_sources/options/hub.txt
+++ b/docs/html/_sources/options/hub.txt
@@ -19,10 +19,7 @@ behavior of MathJax. They are given with their default values.
A comma-separated list of extensions to load at startup. The
default directory is ``MathJax/extensions``. The ``tex2jax`` and
- ``mml2jax`` preprocessors can be listed here, as well as a number
- of TeX-specific extensions (see the :ref:`TeX and LaTeX input
- ` section of the :ref:`Getting Started
- ` document for more details). There is also a
+ ``mml2jax`` preprocessors can be listed here, as well as a
``FontWarnings`` extension that you can use to inform your user
that mathematics fonts are available that they can download to
improve their experience of your site.
@@ -33,7 +30,9 @@ behavior of MathJax. They are given with their default values.
starts up, e.g., to define local macros, etc., and there is a
sample config file named ``config/local/local.js``. The default
directory is the `MathJax/config` directory. The ``MMLorHTML.js``
- configuration is the only other predefined configuration file.
+ configuration is one such configuration file, and there are a
+ number of other pre-defined configurations (see :ref:`Using a
+ configuration file ` for more details).
.. describe:: styleSheets: []
@@ -43,8 +42,9 @@ behavior of MathJax. They are given with their default values.
.. describe:: styles: {}
- CSS `selector: rules;` styles to be defined dynamically at startup
- time.
+ CSS styles to be defined dynamically at startup time. These are
+ in the form `selector:rules` (see :ref:`CSS Style Objects
+ ` for complete details).
.. describe:: preJax: null and postJax: null
@@ -149,13 +149,51 @@ behavior of MathJax. They are given with their default values.
.. describe:: elements: []
This is a list of DOM element ID's that are the ones to process for
- mathematics when any of the Hub typesetting calls (Typeset, Process,
- Update, etc.) are called with no element specified, and during
+ mathematics when any of the Hub typesetting calls (``Typeset()``, ``Process()``,
+ ``Update()``, etc.) are called with no element specified, and during
MathJax's initial typesetting run when it starts up. This lets you
restrict the processing to particular containers rather than scanning
the entire document for mathematics. If none are supplied, the complete
document is processed.
+.. describe:: positionToHash: true
+
+ Since typesetting usually changes the vertical dimensions of the
+ page, if the URL contains an anchor position, then after the page
+ is typeset, you may no longer be positioned at the correct
+ position on the page. MathJax can reposition to that location
+ after it completes its initial typesetting of the page. This
+ value controls whether MathJax will reposition the browser to the
+ ``#hash`` location from the page URL after typesetting for the page.
+
+
+.. describe:: showMathMenu: true
+ showMathMenuMSIE: true
+
+ These control whether to attach the MathJax contextual menu to the
+ expressions typeset by MathJax. Since the code for handling
+ MathPlayer in Internet Explorer is somewhat delicate, it is
+ controlled separately via ``showMathMenuMSIE``, but the latter is
+ now deprecated in favor of the MathJax contextual menu settings
+ for MathPlayer (see below).
+
+ If ``showMathMenu`` is ``true``, then right-clicking (on Windows
+ or Linux) or control-clicking (on Mac OS X) will produce a MathJax
+ menu that allows you to get the source of the mathematics in
+ various formats, change the size of the mathematics relative to
+ the surrounding text, get information about MathJax, and configure
+ other MathJax settings.
+
+ Set this to ``false`` to disable the menu. When ``true``, the
+ ``MathMenu`` configuration block determines the operation of the
+ menu. See :ref:`the MathMenu options ` for
+ more details.
+
+ These values used to be listed in the separate output jax, but
+ have been moved to this more central location since they are
+ shared by all output jax. MathJax will still honor their values
+ from their original positions, if they are set there.
+
.. describe:: menuSettings: { ... }
This block contains settings for the mathematics contextual menu
@@ -195,9 +233,19 @@ behavior of MathJax. They are given with their default values.
to ``"Browser"``, you will get the MathPlayer contextual menu
rather than the MathJax menu.
- There are also settings for ``format``, ``renderer``, and ``font``,
- but these are maintained by MathJax and should not be set by the
- page author.
+ .. describe:: texHints: true
+
+ This controls whether the "Show Source" menu item includes
+ special class names that help MathJax to typeset the
+ mathematics that was produced by the TeX input jax. If these
+ are included, then you can take the output from "Show Source"
+ and put it into a page that uses MathJax's MathML input jax
+ and expect to get the same results as the original TeX.
+ (Without this, there may be some spacing differences.)
+
+ There are also settings for ``format``, ``renderer``, ``font``,
+ ``mpContext``, and ``mpMouse``, but these are maintained by
+ MathJax and should not be set by the page author.
.. describe:: errorSettings: { ... }
diff --git a/docs/html/_sources/options/index.txt b/docs/html/_sources/options/index.txt
index f73fca1ce..3a7d42c76 100644
--- a/docs/html/_sources/options/index.txt
+++ b/docs/html/_sources/options/index.txt
@@ -13,16 +13,16 @@ will see that ``config/default.js`` is itself one big call to
``config/default.js`` can be included in-line to configure MathJax.
The structure that you pass to :meth:`MathJax.Hub.Config()` is a
-JavaScript object that includes name-value pairs giving the names of
+JavaScript object that includes `name:value` pairs giving the names of
parameters and their values, with pairs separated by commas. Be
careful not to include a comma after the last value, however, as some
browsers (namely Internet Explorer) will fail to process the
configuration if you do.
The MathJax components, like the TeX input processor, have their own
-sections in the configuration object, labeled by the component name,
+sections in the configuration object labeled by the component name,
and using an object as its value. That object is itself
-a configuration object made up of name-value pairs that give the
+a configuration object made up of `name:value` pairs that give the
configuration options for the component.
For example,
@@ -81,6 +81,7 @@ are categorized by the component they affect.
The AsciiMath input processor options
The HTML-CSS output processor options
The NativeMML output processor options
+ The SVG output processor options
The options below control the operation of the HTML-CSS output
processor that is run when you include "output/HTML-CSS" in the
-jax array of your configuration. They are listed with their default
-values. To set any of these options, include a "HTML-CSS" section
-in your MathJax.Hub.Config() call. Note that, because of the
-dash, you need to enclose the name in quotes. For example
+jax array of your configuration or load a combined configuration
+file that includes the HTML-CSS output jax. They are listed with
+their default values. To set any of these options, include a
+"HTML-CSS" section in your MathJax.Hub.Config() call.
+Note that, because of the dash, you need to enclose the name in
+quotes. For example
MathJax.Hub.Config({"HTML-CSS":{preferredFont:"STIX"
@@ -72,7 +74,7 @@ dash, you need to enclose the name in quotes. For example
scale: 100
The scaling factor (as a percentage) of math with respect to the
surrounding text. The HTML-CSS output processor tries to match
-the en-size of the mathematics with that of the text where it is
+the ex-size of the mathematics with that of the text where it is
placed, but you may want to adjust the results using this scaling
factor. The user can also adjust this value using the contextual
menu item associated with the typeset mathematics.
@@ -145,6 +147,74 @@ will stop looking after the first font that exists on the system
carefully.
+
+
+mtextFontInherit: false
+
This setting controls whether <mtext> elements will be typeset
+using the math fonts or the font of the surrounding text. When
+false, the font for mathvariant="normal" will be used;
+when true, the font will be inherited from the surrounding
+paragraph.
+
+
+
+
+EqnChunk: 50
+
+EqnChunkFactor: 1.5
+
+EqnChunkDelay: 100
+
These values control how “chunky” the display of mathematical
+expressions will be; that is, how often the equations will be
+updated as they are processed.
+
EqnChunk is the number of equations that will be typeset before
+they appear on screen. Larger values make for less visual flicker
+as the equations are drawn, but also mean longer delays before the
+reader sees anything.
+
EqChunkFactor is the factor by which the EqnChunk will
+grow after each chunk is displayed.
+
EqChunkDelay is the time (in milliseconds) to delay between
+chunks (to allow the browser to respond to other user
+interaction).
+
Set EqnChunk to 1, EqnChunkFactor to 1, and
+EqnChunkDelay to 10 to get the behavior from MathJax v1.1 and
+below.
+
+
+
+
+linebreaks: {}
+
This is an object that configures automatic linebreaking in the
+HTML-CSS output. In order to be backward compatible with earlier
+versions of MathJax, only explicit line breaks are performed by
+default, so you must enable line breaks if you want automatic
+ones. The object contains the following values:
+
+
+automatic: false
+
This controls the automatic breaking of expressions: when
+false, only linebreak="newline" is processed; when
+true, line breaks are inserted automatically in long
+expressions.
+
+
+
+
+width: "container"
+
This controls how wide the lines of mathematics can be.
+
Use an explicit width like "30em" for a fixed width.
+Use "container" to compute the size from the containing
+element.
+Use "nn%container" for a portion of the container.
+Use "nn%" for a portion of the window size.
+
The container-based widths may be slower, and may not produce
+the expected results if the layout width changes due to the
+removal of previews or inclusion of mathematics during
+typesetting.
+
+
+
+
styles: {}
@@ -158,17 +228,9 @@ CSS style in a JavaScript object.
showMathMenu: true
-
This controls whether the MathJax contextual menu will be
-available on the mathematics in the page. If true, then
-right-clicking (on the PC) or control-clicking (on the Mac) will
-produce a MathJax menu that allows you to get the source of the
-mathematics in various formats, change the size of the mathematics
-relative to the surrounding text, get information about
-MathJax, and configure other MathJax settings.
-
Set this to false to disable the menu. When true, the
-MathMenu configuration block determines the operation of the
-menu. See the MathMenu options for
-more details.
+
This value has been moved to the core configuration block, since
+it applies to all output jax, but it will still be honored (for
+now) if it is set here. See the Core configuration options for more details.
@@ -195,7 +257,9 @@ after the mouse moves out of the
-offsetX: 10 and offsetY: 5
+offsetX: 10
+
+offsetY: 5
These are the offset from the mouse position (in pixels)
where the tooltip will be placed.
The options below control the operation of the MMLorHTML configuration
file that is run when you include "MMLorHTML.js" in the config
-array of your configuration. They are listed with their default
-values. To set any of these options, include a MMLorHTML section
-in your MathJax.Hub.Config() call. For example
+array of your configuration, or when you use one of the combined
+configuration files that ends with _HTMLorMML. They are listed
+with their default values. To set any of these options, include a
+MMLorHTML section in your MathJax.Hub.Config() call. For
+example
MathJax.Hub.Config({MMLorHTML:{prefer:{
@@ -75,14 +77,34 @@ browsers unchanged).
configuration; MMLorHTML will fill that in for you.
This lets you set the preferred renderer on a browser-by-browser
basis. You set the browser to either "MML" or "HTML"
depending on whether you want to use the NativeMML or HTML-CSS
-output processor. Note that although Opera does process some MathML
-natively, its support is not sufficient to handle the more
-complicated output generated by MathJax, so its setting is
-"HTML" by default.
+output processor. Note that although Opera and Safari do process some MathML
+natively, their support is not sufficient to handle the more
+complicated output generated by MathJax, so their settings are
+"HTML" by default. Although Firefox does support a large
+subset of MathJax, it does not implement all the features needed by
+MathJax, and so it is also set to "HTML" by default (this is
+new in v2.0).
+
Note that users can still use the MathJax contextual menu to select
+a different renderer after the default one has been chosen by
+MMLorHTML.js.
@@ -94,8 +116,8 @@ complicated output generated by MathJax, so its setting is
The options below control the operation of the MathEvents component that
+allows handles mouse and menu events attached to mathematics that is
+typeset by MathJax. They are listed with their
+default values. To set any of these options, include a MathEvents
+section in your MathJax.Hub.Config() call. For example
would set the required delay for hovering over a math element to
+400 milliseconds.
+
+
+hover: 500
+
This value is the time (in milliseconds) that a user must hold the
+mouse still over a math element before it is considered to be
+hovering over the math.
+
+
+
+
+styles: {}
+
This is a list of CSS declarations for styling the zoomed
+mathematics. See the definitions in extensions/MathEvents.js
+for details of what are defined by default. See CSS Style
+Objects for details on how to specify CSS
+style in a JavaScript object.
The options below control the operation of the MathML input processor
that is run when you include "input/MathML" in the jax array of
-your configuration. They are listed with their default values. To
+your configuration or load a combined configuration file that includes
+the MathML input jax. They are listed with their default values. To
set any of these options, include a MathML section in your
MathJax.Hub.Config() call. For example
MathJax.Hub.Config({
diff --git a/docs/html/options/MathMenu.html b/docs/html/options/MathMenu.html
index 976783e2d..7a9b3cf1f 100644
--- a/docs/html/options/MathMenu.html
+++ b/docs/html/options/MathMenu.html
@@ -85,38 +85,48 @@ selects that item, the browser opens a new window with this URL.
showRenderer: true
-
This controls whether the “Math Renderer” item will be displayed in
-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.
-
-
-
-
-showContext: false
-
This controls whether the “Contextual Menu” item will be displayed
-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 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
-processor is used in Internet Explorer with the MathPlayer plugin.) Set to
-false to prevent this menu item from showing.
+
This controls whether the “Math Renderer” item will be displayed
+in the “Math Settings” submenu of the MathJax contextual menu.
+It allows the user to change between the HTML-CSS, NativeMML,
+and SVG output processors for the mathematics on the page. Set
+to false to prevent this menu item from showing.
showFontMenu: false
This controls whether the “Font Preference” item will be displayed
-in the “Settings” submenu of the mathematics contextual menu.
+in the “Math Settings” submenu of the MathJax 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
reload. Set to false to prevent this menu item from showing.
+
+
+showMathPlayer: true
+
This controls whether the “MathPlayer” item will be displayed in
+the “Math Settings” submenu of the MathJax contextual menu. This
+submenu lets the user select what events should be passed on to
+the MathPlayer plugin, when it is
+present. Mouse events can be passed on (so that clicks will be
+processed by MathPlayer rather than MathJax), and emnu events can
+be passed on (to allow the user access to the MathPlayer menu).
+Set to false to prevent this menu item from showing.
+
+
+
+
+showContext: false
+
This controls whether the “Contextual Menu” item will be displayed
+in the “Math Settings” submenu of the MathJax contextual menu.
+It allows the user to decide whether the MathJax menu or the
+browser’s default contextual menu will be shown when the context
+menu click occurs over mathematics typeset by MathJax. Set to
+false to prevent this menu item from showing.