Sha256: 70ae9da7498e5d9f1c857ae14a09e385b62573bea983f105382b474643af9cfc
Contents?: true
Size: 1.71 KB
Versions: 18
Compression:
Stored size: 1.71 KB
Contents
.. _configure-mml2jax:
************************
The mml2jax Preprocessor
************************
The options below control the operation of the `mml2jax` preprocessor
that is run when you include ``"mml2jax.js"`` in the `extensions` array
of your configuration. They are listed with their default values. To
set any of these options, include a ``mml2jax`` section in your
:meth:`MathJax.Hub.Config()` call. For example
.. code-block:: javascript
MathJax.Hub.Config({
mml2jax: {
preview: "none"
}
});
would set the ``preview`` parameter to ``"none"``.
.. describe:: element: null
The id name of the element that should be processed by `mml2jax`.
The default is the whole document.
.. describe:: preview: "alttext"
This controls whether `mml2jax` inserts ``MathJax_Preview`` spans
to make a preview available, and what preview to use, when it
locates mathematics on the page. The default is ``"alttext"``,
which means use the ``<math>`` tag's ``alttext`` attribute as the
preview (visible until it is processed by MathJax), if the tag has
one. Set it to ``"none"`` to prevent the previews from being
inserted (the math will simply disappear until it is typeset).
Set it to an array containing the description of an HTML snippet
in order to use the same preview for all equations on the page.
Examples:
.. code-block:: javascript
preview: ["[math]"], // insert the text "[math]" as the preview
.. code-block:: javascript
preview: [["img",{src: "/images/mypic.jpg"}]], // insert an image as the preview
See the :ref:`description of HTML snippets <html-snippets>` for
details on how to represent HTML code in this way.
Version data entries
18 entries across 9 versions & 3 rubygems