Skip to content

Commit

Permalink
second round of updates for #78: CommonHTML updates; Getting Started …
Browse files Browse the repository at this point in the history
…tweaking
  • Loading branch information
pkra committed Jan 9, 2015
1 parent 5f81a22 commit f71ebc1
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 42 deletions.
70 changes: 35 additions & 35 deletions config-files.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.. _common-configurations:

*********************
Common Configurations
*********************
***********************
Combined Configurations
***********************

MathJax comes with a number of pre-defined configuration files in the
``MathJax/config`` directory. The ``default.js`` file contains nearly all
the possible configuration options together with comments explaining them,
MathJax comes with a number of pre-defined and pre-compiled configuration files
in the ``MathJax/config`` directory. The ``default.js`` file contains nearly
all the possible configuration options together with comments explaining them,
so you can use that file to customize MathJax to your needs. Simply load
it via

Expand Down Expand Up @@ -60,8 +60,8 @@ following configuration:
MathJax.Hub.Config({
config: ["MMLorHTML.js"],
jax: ["input/TeX","input/MathML","input/AsciiMath","output/HTML-CSS","output/NativeMML"],
extensions: ["tex2jax.js","mml2jax.js","asciimath2jax.js","MathMenu.js","MathZoom.js"],
jax: ["input/TeX","input/MathML","input/AsciiMath","output/HTML-CSS","output/NativeMML", "output/CommonHTML"],
extensions: ["tex2jax.js","mml2jax.js","asciimath2jax.js","MathMenu.js","MathZoom.js", "CHTML-preview.js"],
TeX: {
extensions: ["AMSmath.js","AMSsymbols.js","noErrors.js","noUndefined.js"]
}
Expand All @@ -70,8 +70,8 @@ following configuration:
In addition, it loads the mml Element Jax, the TeX, MathML, and
AsciiMath input jax main code (not just the definition files), as well
as the `toMathML` extension, which is used by the Show Source option
in the MathJax contextual menu. The `-full` version also loads both the
HTML-CSS and NativeMML output jax main code, plus the HTML-CSS
in the MathJax contextual menu. The `-full` version also loads the HTML-CSS,
CommonHTML, and NativeMML output jax main code, plus the HTML-CSS
`mtable` extension, which is normally loaded on demand.

See the :ref:`tex2jax configuration <configure-tex2jax>` section for
Expand Down Expand Up @@ -107,8 +107,8 @@ configuration:
MathJax.Hub.Config({
config: ["MMLorHTML.js"],
jax: ["input/TeX","input/MathML","output/HTML-CSS","output/NativeMML"],
extensions: ["tex2jax.js","mml2jax.js","MathMenu.js","MathZoom.js"],
jax: ["input/TeX","input/MathML","output/HTML-CSS","output/NativeMML", "output/CommonHTML"],
extensions: ["tex2jax.js","mml2jax.js","MathMenu.js","MathZoom.js", "CHTML-preview.js"],
TeX: {
extensions: ["AMSmath.js","AMSsymbols.js","noErrors.js","noUndefined.js"]
}
Expand All @@ -117,8 +117,8 @@ configuration:
In addition, it loads the mml Element Jax, the TeX and MathML input
jax main code (not just the definition files), as well as the
`toMathML` extension, which is used by the Show Source option in the
MathJax contextual menu. The ``-full`` version also loads both the
HTML-CSS and NativeMML output jax main code, plus the HTML-CSS
MathJax contextual menu. The ``-full`` version also loads the HTML-CSS,
CommonHTML, and NativeMML output jax main code, plus the HTML-CSS
`mtable` extension, which is normally loaded on demand.

See the :ref:`tex2jax configuration <configure-tex2jax>` section for
Expand Down Expand Up @@ -153,8 +153,8 @@ extensions. It is equivalent to the following configuration:
.. code-block:: javascript
MathJax.Hub.Config({
jax: ["input/TeX","output/HTML-CSS"],
extensions: ["tex2jax.js","MathMenu.js","MathZoom.js"],
jax: ["input/TeX","output/HTML-CSS", "output/CommonHTML"],
extensions: ["tex2jax.js","MathMenu.js","MathZoom.js", "CHTML-preview.js"],
TeX: {
extensions: ["AMSmath.js","AMSsymbols.js","noErrors.js","noUndefined.js"]
}
Expand All @@ -163,8 +163,8 @@ extensions. It is equivalent to the following configuration:
In addition, it loads the mml Element Jax and the TeX input jax main code
(not just the definition file), as well as the `toMathML` extension, which
is used by the Show Source option in the MathJax contextual menu. The ``-full``
version also loads the HTML-CSS output jax main code, plus the HTML-CSS
`mtable` extension, which is normally loaded on demand.
version also loads the HTML-CSS and CommonHTML output jax main code, plus the
HTML-CSS `mtable` extension, which is normally loaded on demand.

See the :ref:`tex2jax configuration <configure-tex2jax>` section for
other configuration options for the ``tex2jax`` preprocessor, and the
Expand All @@ -191,16 +191,16 @@ and MathZoom extensions. It is equivalent to the following configuration:
MathJax.Hub.Config({
config: ["MMLorHTML.js"],
jax: ["input/MathML","output/HTML-CSS","output/NativeMML"],
extensions: ["mml2jax.js","MathMenu.js","MathZoom.js"]
jax: ["input/MathML","output/HTML-CSS","output/NativeMML", "output/CommonHTML"],
extensions: ["mml2jax.js","MathMenu.js","MathZoom.js", "CHTML-preview.js"]
});
In addition, it loads the mml Element Jax and the MathML input jax main
code (not just the definition file), as well as the `toMathML` extension,
which is used by the Show Source option in the MathJax contextual menu.
The ``-full`` version also loads both the HTML-CSS and NativeMML output jax main
code files, plus the HTML-CSS `mtable` extension, which is normally loaded
on demand.
The ``-full`` version also loads the HTML-CSS, CommonHTML, and NativeMML output
jax main code files, plus the HTML-CSS `mtable` extension, which is normally
loaded on demand.

See the :ref:`mml2jax configuration <configure-mml2jax>` section for
other configuration options for the ``mml2jax`` preprocessor, and the
Expand Down Expand Up @@ -230,15 +230,15 @@ equivalent to the following configuration:
MathJax.Hub.Config({
config: ["MMLorHTML.js"],
jax: ["input/AsciiMath","output/HTML-CSS","output/NativeMML"],
extensions: ["asciimath2jax.js","MathMenu.js","MathZoom.js"]
jax: ["input/AsciiMath","output/HTML-CSS","output/NativeMML", "output/CommonHTML"],
extensions: ["asciimath2jax.js","MathMenu.js","MathZoom.js", "CHTML-preview.js"]
});
In addition, it loads the mml Element Jax and the TeX input jax main code
(not just the definition file), as well as the `toMathML` extension, which
is used by the Show Source option in the MathJax contextual menu. The ``-full``
version also loads the HTML-CSS output jax main code, plus the HTML-CSS
`mtable` extension, which is normally loaded on demand.
version also loads the HTML-CSS and CommonHTML output jax main code, plus the
HTML-CSS `mtable` extension, which is normally loaded on demand.

See the :ref:`asciimath2jax configuration <configure-asciimath2jax>`
section for other configuration options for the ``asciimath2jax``
Expand All @@ -265,8 +265,8 @@ is equivalent to the following configuration:
.. code-block:: javascript
MathJax.Hub.Config({
jax: ["input/TeX","input/MathML","output/SVG"],
extensions: ["tex2jax.js","mml2jax.js","MathMenu.js","MathZoom.js"],
jax: ["input/TeX","input/MathML","output/SVG", "output/CommonHTML"],
extensions: ["tex2jax.js","mml2jax.js","MathMenu.js","MathZoom.js", "CHTML-preview.js"],
TeX: {
extensions: ["AMSmath.js","AMSsymbols.js","noErrors.js","noUndefined.js"]
}
Expand All @@ -275,8 +275,8 @@ is equivalent to the following configuration:
In addition, it loads the mml Element Jax, the TeX and MathML input
jax main code (not just the definition files), as well as the
`toMathML` extension, which is used by the Show Source option in the
MathJax contextual menu. The ``-full`` version also loads both the
SVG output jax main code, plus the SVG `mtable` extension, which
MathJax contextual menu. The ``-full`` version also loads the SVG and
CommonHTML output jax main code, plus the SVG `mtable` extension, which
is normally loaded on demand.

See the :ref:`tex2jax configuration <configure-tex2jax>` section for
Expand Down Expand Up @@ -311,8 +311,8 @@ The Accessible configuration is equivalent to the following:
MathJax.Hub.Config({
config: ["MMLorHTML.js"],
jax: ["input/TeX","input/MathML","output/HTML-CSS","output/NativeMML"],
extensions: ["tex2jax.js","mml2jax.js","MathMenu.js","MathZoom.js"],
jax: ["input/TeX","input/MathML","output/HTML-CSS","output/NativeMML", "output/CommonHTML"],
extensions: ["tex2jax.js","mml2jax.js","MathMenu.js","MathZoom.js", "CHTML-preview.js"],
TeX: {
extensions: ["AMSmath.js","AMSsymbols.js","noErrors.js","noUndefined.js"]
},
Expand All @@ -333,7 +333,7 @@ mathematics by double-clicking on any equation.
In addition, it loads the mml Element Jax, the TeX and MathML input jax
main code (not just the definition files), as well as the `toMathML`
extension, which is used by the Show Source option in the MathJax
contextual menu. The ``-full`` version also loads both the HTML-CSS and
NativeMML output jax main code, plus the HTML-CSS `mtable` extension, which
contextual menu. The ``-full`` version also loads the HTML-CSS, CommomHTML,
and NativeMML output jax main code, plus the HTML-CSS `mtable` extension, which
is normally loaded on demand.

2 changes: 1 addition & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Basic Usage
Getting Started with MathJax <start>
Installing and Testing MathJax <installation>
Loading and Configuring MathJax <configuration>
Common MathJax Configurations <config-files>
Combined MathJax Configurations <config-files>

.. toctree::
:maxdepth: 1
Expand Down
14 changes: 8 additions & 6 deletions start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ To jump start, you accomplish the first step by putting
.. code-block:: html

<script type="text/javascript"
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>

into the ``<head>`` block of your document. (It can also go in the
Expand All @@ -58,11 +58,13 @@ that well enough, and otherwise use HTML-with-CSS to display the
mathematics.

**Note** The ``TeX-AMS-MML_HTMLorMML`` configuration is one of the most general
(and largest) configuration files, and is listed here because it will suffice for
most people's needs and quickly get you started using MathJax.
Other :ref:`combined configuration files <config-files>` are available, however,
and you can also provide additional configuration parameters to tailor one of the
combined configurations to your needs.
(and thus largest) configuration files. We list it here because it will
quickly get you started using MathJax. It is probably not the most efficient
configuration for your purposes and other
:ref:`combined configuration files <config-files>` are available. You can
also provide additional configuration parameters to tailor one of the
combined configurations to your needs or use our development tools to generate
your own combined configuration file.

More details about the configuration process can be found in the
:ref:`Loading and Configuring MathJax <loading>` instructions.
Expand Down

0 comments on commit f71ebc1

Please sign in to comment.