/usr/share/doc/libjs-mathjax-doc/html/options/hub.html is in libjs-mathjax-doc 2.7+20171212-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>The Core Configuration Options — MathJax 2.7 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="MathJax 2.7 documentation" href="../index.html"/>
<link rel="up" title="Configuration Objects" href="index.html"/>
<link rel="next" title="Preprocessor options" href="preprocessors/index.html"/>
<link rel="prev" title="Configuration Objects" href="index.html"/>
<script src="../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../index.html" class="icon icon-home"> MathJax
</a>
<div class="version">
2.7
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Basic Usage</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../mathjax.html">What is MathJax?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../start.html">Getting Started with MathJax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installing and Testing MathJax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration.html">Loading and Configuring MathJax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../config-files.html">Combined MathJax Configurations</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tex.html">MathJax TeX and LaTeX Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../mathml.html">MathJax MathML Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../asciimath.html">MathJax AsciiMath Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../output.html">MathJax Output Formats</a></li>
<li class="toctree-l1"><a class="reference internal" href="../font-support.html">MathJax Font Support</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../localization.html">MathJax Localization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../safe-mode.html">MathJax Safe-mode</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../community.html">The MathJax Community</a></li>
</ul>
<p class="caption"><span class="caption-text">Configuration options</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Configuration options</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">The core options</a></li>
<li class="toctree-l2"><a class="reference internal" href="preprocessors/index.html">Preprocessor options</a></li>
<li class="toctree-l2"><a class="reference internal" href="input-processors/index.html">Input processor options</a></li>
<li class="toctree-l2"><a class="reference internal" href="output-processors/index.html">Output processor options</a></li>
<li class="toctree-l2"><a class="reference internal" href="extensions/index.html">Extension options</a></li>
<li class="toctree-l2"><a class="reference internal" href="other/index.html">Other options</a></li>
<li class="toctree-l2"><a class="reference internal" href="ThirdParty.html">Third-party extensions</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Advanced topics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../advanced/model.html">The MathJax Processing Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/startup.html">The MathJax Startup Sequence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/synchronize.html">Synchronizing Your Code with MathJax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/dynamic.html">Loading MathJax Dynamically</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/typeset.html">Modifying Math on the Page</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/toMathML.html">Obtaining the MathML for an Expression</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/extension-writing.html">Writing MathJax Extensions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/debugging-tips.html">Debugging Tips</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/mathjax-node.html">MathJax on NodeJS</a></li>
</ul>
<p class="caption"><span class="caption-text">The MathJax API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/index.html">Details of the MathJax API</a></li>
</ul>
<p class="caption"><span class="caption-text">Miscellanea</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../misc/accessibility-features.html">Accessibility features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/browser-compatibility.html">Browser Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/epub.html">EPUB3 Reading Systems</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/badges.html">MathJax Badges and Logo</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/articles.html">Articles and Presentations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/platforms.html">Using MathJax in Web Platforms</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/faq.html">MathJax FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/mathjax-in-use.html">MathJax in Use</a></li>
</ul>
<p class="caption"><span class="caption-text">Upgrading MathJax</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../upgrading/index.html">Upgrading MathJax</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference Pages</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/HTML-snippets.html">HTML snippets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/CSS-styles.html">CSS style objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/localization-strings.html">Localization strings</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/glossary.html">Glossary</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">MathJax</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li><a href="index.html">Configuration Objects</a> »</li>
<li>The Core Configuration Options</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/options/hub.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="the-core-configuration-options">
<span id="configure-hub"></span><h1>The Core Configuration Options<a class="headerlink" href="#the-core-configuration-options" title="Permalink to this headline">¶</a></h1>
<p>The options below control the MathJax Hub, and so determine the code
behavior of MathJax. They are given with their default values.</p>
<dl class="describe">
<dt>
<code class="descname">jax: ["input/TeX","output/HTML-CSS"]</code></dt>
<dd><p>A comma-separated list of input and output jax to initialize at
startup. Their main code is loaded only when they are actually
used, so it is not inefficient to include jax that may not
actually be used on the page. These are found in the <code class="docutils literal"><span class="pre">MathJax/jax</span></code>
directory.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">extensions: []</code></dt>
<dd><p>A comma-separated list of extensions to load at startup. The
default directory is <code class="docutils literal"><span class="pre">MathJax/extensions</span></code>. The <code class="docutils literal"><span class="pre">tex2jax</span></code> and
<code class="docutils literal"><span class="pre">mml2jax</span></code> preprocessors can be listed here, as well as a
<code class="docutils literal"><span class="pre">FontWarnings</span></code> 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.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">config: []</code></dt>
<dd><p>A comma-separated list of configuration files to load when MathJax
starts up, e.g., to define local macros, etc., and there is a
sample config file named <code class="docutils literal"><span class="pre">config/local/local.js</span></code>. The default
directory is the <cite>MathJax/config</cite> directory. The <code class="docutils literal"><span class="pre">MMLorHTML.js</span></code>
configuration is one such configuration file, and there are a
number of other pre-defined configurations (see <a class="reference internal" href="../configuration.html#config-files"><span class="std std-ref">Using a
configuration file</span></a> for more details).</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">styleSheets: []</code></dt>
<dd><p>A comma-separated list of CSS stylesheet files to be loaded when
MathJax starts up. The default directory is the <cite>MathJax/config</cite>
directory.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">styles: {}</code></dt>
<dd><p>CSS styles to be defined dynamically at startup time. These are
in the form <cite>selector:rules</cite> (see <a class="reference internal" href="../reference/CSS-styles.html#css-style-objects"><span class="std std-ref">CSS Style Objects</span></a> for complete details).</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">preJax: null and postJax: null</code></dt>
<dd><p>Patterns to remove from before and after math script tags. If you
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 redundant, and since a <code class="docutils literal"><span class="pre"><script></span></code> tag usually doesn’t add
content to the page, if there is a space before and after a
MathJax <code class="docutils literal"><span class="pre"><script></span></code> tag, IE will remove the first space. When
MathJax inserts the typeset mathematics, this means there will be
no space before it and the preceding text. In order to avoid
this, you should include some “guard characters” before or after
the math SCRIPT tag; define the patterns you want to use below.
Note that these are used as part of a regular expression, so you
will need to quote special characters. Furthermore, since they
are javascript strings, you must quote javascript special
characters as well. So to obtain a backslash, you must use <code class="docutils literal"><span class="pre">\\</span></code>
(doubled for javascript). For example, <code class="docutils literal"><span class="pre">"\\["</span></code> represents the
pattern <code class="docutils literal"><span class="pre">\[</span></code> in the regular expression, or <code class="docutils literal"><span class="pre">[</span></code> in the text of
the web page. That means that if you want an actual backslash in
your guard characters, you need to use <code class="docutils literal"><span class="pre">"\\\\"</span></code> in order to get
<code class="docutils literal"><span class="pre">\\</span></code> in the regular expression, and <code class="docutils literal"><span class="pre">\</span></code> in the actual text.
If both <code class="docutils literal"><span class="pre">preJax</span></code> and <code class="docutils literal"><span class="pre">postJax</span></code> are defined, both must be
present in order to be removed.</p>
<p>See also the <code class="docutils literal"><span class="pre">preRemoveClass</span></code> comments below.</p>
<p>Examples:</p>
<blockquote>
<div><p><code class="docutils literal"><span class="pre">preJax:</span> <span class="pre">"\\\\\\\\\"</span></code> makes a double backslash the <code class="docutils literal"><span class="pre">preJax</span></code> text</p>
<p><code class="docutils literal"><span class="pre">preJax:</span> <span class="pre">"\\[\\[",</span> <span class="pre">postJax:</span> <span class="pre">"\\]\\]"</span></code> makes it so jax
scripts must be enclosed in double brackets.</p>
</div></blockquote>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">preRemoveClass: "MathJax_Preview"</code></dt>
<dd><p>This is the CSS class name for math previews that will be removed
preceding a MathJax SCRIPT tag. If the tag just before the
MathJax <code class="docutils literal"><span class="pre"><script></span></code> tag is of this class, its contents are
removed when MathJax processes the <code class="docutils literal"><span class="pre"><script></span></code> tag. This allows
you to include a math preview in a form that will be displayed
prior to MathJax performing its typesetting. It also avoids the
Internet Explorer space-removal bug, and can be used in place of
<code class="docutils literal"><span class="pre">preJax</span></code> and <code class="docutils literal"><span class="pre">postJax</span></code> if that is more convenient.</p>
<p>For example</p>
<div class="highlight-html"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">span</span> <span class="na">class</span><span class="o">=</span><span class="s">"MathJax_Preview"</span><span class="p">></span>[math]<span class="p"></</span><span class="nt">span</span><span class="p">><</span><span class="nt">script</span> <span class="na">type</span><span class="o">=</span><span class="s">"math/tex"</span><span class="p">>...</</span><span class="nt">script</span><span class="p">></span>
</pre></div>
</div>
<p>would display “[math]” in place of the math until MathJax is able
to typeset it.</p>
<p>See also the <code class="docutils literal"><span class="pre">preJax</span></code> and <code class="docutils literal"><span class="pre">postJax</span></code> comments above.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">showProcessingMessages: true</code></dt>
<dd><p>This value controls whether the <cite>Processing Math: nn%</cite> messages are
displayed in the lower left-hand corner. Set to <code class="docutils literal"><span class="pre">false</span></code> to
prevent those messages (though file loading and other messages
will still be shown).</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">messageStyle: "normal"</code></dt>
<dd><p>This value controls the verbosity of the messages in the lower
left-hand corner. Set it to <code class="docutils literal"><span class="pre">"none"</span></code> to eliminate all messages,
or set it to <code class="docutils literal"><span class="pre">"simple"</span></code> to show “Loading…” and “Processing…”
rather than showing the full file name or the percentage of the
mathematics processed.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">displayAlign: "center" and displayIndent: "0em"</code></dt>
<dd><p>These two parameters control the alignment and shifting of
displayed equations. The first can be <code class="docutils literal"><span class="pre">"left"</span></code>, <code class="docutils literal"><span class="pre">"center"</span></code>,
or <code class="docutils literal"><span class="pre">"right"</span></code>, and determines the alignment of displayed
equations. When the alignment is not <code class="docutils literal"><span class="pre">"center"</span></code>, the second
determines an indentation from the left or right side for the
displayed equations.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">delayStartupUntil: "none"</code></dt>
<dd><p>Normally MathJax will perform its startup commands (loading of
configuration, styles, jax, and so on) as soon as it can. If you
expect to be doing additional configuration on the page, however,
you may want to have it wait until the page’s onload handler is
called. If so, set this to <code class="docutils literal"><span class="pre">"onload"</span></code>. You can also set this to
<code class="docutils literal"><span class="pre">"configured"</span></code>, in which case, MathJax will delay its startup until
you explicitly call <code class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Configured()</span></code>. See
<a class="reference internal" href="../configuration.html#delaystartupuntil"><span class="std std-ref">Configuring MathJax after it is loaded</span></a> for more
details.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">skipStartupTypeset: false</code></dt>
<dd><p>Normally MathJax will typeset the mathematics on the page as soon
as the page is loaded. If you want to delay that process, in
which case you will need to call <code class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Typeset()</span></code>
yourself by hand, set this value to <code class="docutils literal"><span class="pre">true</span></code>.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">elements: []</code></dt>
<dd><p>This is a list of DOM element ID’s that are the ones to process for
mathematics when any of the Hub typesetting calls (<code class="docutils literal"><span class="pre">Typeset()</span></code>, <code class="docutils literal"><span class="pre">Process()</span></code>,
<code class="docutils literal"><span class="pre">Update()</span></code>, 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.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">positionToHash: true</code></dt>
<dd><p>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
<code class="docutils literal"><span class="pre">#hash</span></code> location from the page URL after typesetting for the page.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">showMathMenu: true</code></dt>
<dt>
<code class="descname">showMathMenuMSIE: true</code></dt>
<dd><p>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 <code class="docutils literal"><span class="pre">showMathMenuMSIE</span></code>, but the latter is
now deprecated in favor of the MathJax contextual menu settings
for MathPlayer (see below).</p>
<p>If <code class="docutils literal"><span class="pre">showMathMenu</span></code> is <code class="docutils literal"><span class="pre">true</span></code>, 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.</p>
<p>Set this to <code class="docutils literal"><span class="pre">false</span></code> to disable the menu. When <code class="docutils literal"><span class="pre">true</span></code>, the
<code class="docutils literal"><span class="pre">MathMenu</span></code> configuration block determines the operation of the
menu. See <a class="reference internal" href="other/MathMenu.html#configure-mathmenu"><span class="std std-ref">the MathMenu options</span></a> for
more details.</p>
<p>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.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">menuSettings: { ... }</code></dt>
<dd><p>This block contains settings for the mathematics contextual menu
that act as the defaults for the user’s settings in that menu.
The possible values are:</p>
<dl class="describe">
<dt>
<code class="descname">zoom: "None"</code></dt>
<dd><p>This indicates when typeset mathematics should be zoomed. It
can be set to <code class="docutils literal"><span class="pre">"None"</span></code>, <code class="docutils literal"><span class="pre">"Hover"</span></code>, <code class="docutils literal"><span class="pre">"Click"</span></code>, or
<code class="docutils literal"><span class="pre">"Double-Click"</span></code> to set the zoom trigger.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">CTRL: false, ALT: false, CMD: false, Shift: false</code></dt>
<dd><p>These values indicate which keys must be pressed in order for
math zoom to be triggered. For example, if <code class="docutils literal"><span class="pre">CTRL</span></code> is set to
<code class="docutils literal"><span class="pre">true</span></code> and <code class="docutils literal"><span class="pre">zoom</span></code> is <code class="docutils literal"><span class="pre">"Click"</span></code>, then math will be zoomed
only when the user control-clicks on mathematics (i.e., clicks
while holding down the <cite>CTRL</cite> key). If more than one is
<code class="docutils literal"><span class="pre">true</span></code>, then all the indicated keys must be pressed for the
zoom to occur.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">zscale: "200%"</code></dt>
<dd><p>This is the zoom scaling factor, and it can be set to any of
the values available in the <cite>Zoom Factor</cite> menu of the
<cite>Settings</cite> submenu of the contextual menu.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">context: "MathJax"</code></dt>
<dd><p>This controls what contextual menu will be presented when a
right click (on a PC) or CTRL-click (on the Mac) occurs over a
typeset equation. When set to <code class="docutils literal"><span class="pre">"MathJax"</span></code>, the MathJax
contextual menu will appear; when set to <code class="docutils literal"><span class="pre">"Browser"</span></code>, the
browser’s contextual menu will be used. For example, in
Internet Explorer with the MathPlayer plugin, if this is set
to <code class="docutils literal"><span class="pre">"Browser"</span></code>, you will get the MathPlayer contextual menu
rather than the MathJax menu.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">texHints: true</code></dt>
<dd><p>This controls whether the “Show Math as” 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 Math as”
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.)</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">inTabOrder: true</code></dt>
<dd><p>This controls whether math elements should be included in the
tabindex. If set to <code class="docutils literal"><span class="pre">true</span></code>, MathJax will add <cite>tabindex=0`to
the output. If set to ``false`</cite>, it will add
<code class="docutils literal"><span class="pre">tabindex="-1"</span></code>. Developers are <strong>strongly discouraged</strong>
from initially disabling this (by means of configuration) as
it will render the menu inaccessible.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">semantics: false</code></dt>
<dd><p>This controls whether the “Show Math as ⇒ MathML Code” menu
item includes the TeX or AsciiMath input as annotations.
If these are included, then you can take the output from
“Show Math as ⇒ MathML” and put it into a page that uses
MathJax’s MathML input jax and allow users to access
the original input via “Show Math as ⇒ Annotation”.</p>
</dd></dl>
<p>There are also settings for <code class="docutils literal"><span class="pre">format</span></code>, <code class="docutils literal"><span class="pre">renderer</span></code>, <code class="docutils literal"><span class="pre">font</span></code>,
<code class="docutils literal"><span class="pre">mpContext</span></code>, and <code class="docutils literal"><span class="pre">mpMouse</span></code>, but these are maintained by
MathJax and should not be set by the page author.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">errorSettings: { ... }</code></dt>
<dd><p>This block contains settings that control how MathJax responds to
unexpected errors while processing mathematical equations. Rather
than simply crash, MathJax can report an error and go on. The
options you can set include:</p>
<dl class="describe">
<dt>
<code class="descname">message: ["[Math Processing Error]"]</code></dt>
<dd><p>This is an HTML snippet that will be inserted at the location
of the mathematics for any formula that causes MathJax to
produce an internal error (i.e., an error in the MathJax code
itself). See the <a class="reference internal" href="../reference/HTML-snippets.html#html-snippets"><span class="std std-ref">description of HTML snippets</span></a> for details on how to represent HTML code in
this way.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">style: {color:"#CC0000", "font-style":"italic"}</code></dt>
<dd><p>This is the CSS style description to use for the error
messages produced by internal MathJax errors. See the section
on <a class="reference internal" href="../reference/CSS-styles.html#css-style-objects"><span class="std std-ref">CSS style objects</span></a> for details on
how these are specified in JavaScript.</p>
</dd></dl>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">ignoreMMLattributes: { ... }</code></dt>
<dd><p>This block contains <code class="docutils literal"><span class="pre">attributeName:</span> <span class="pre">boolean</span></code> pairs that control
which attributes should <strong>not</strong> be preserved from the
original MathML. E.g., <code class="docutils literal"><span class="pre">id:true</span></code> will be ignored, while <code class="docutils literal"><span class="pre">id:false</span></code> will
preserve all ids even if other criteria would normally prevent some ids
from being copied to the output; use false carefully.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">root: ""</code></dt>
<dd><p>This controls which URL base MathJax uses to load its components.
By default, it is empty and filled in during the initialization process
with the base URL from where <code class="docutils literal"><span class="pre">MathJax.js</span></code> was loaded.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">v1.0-compatible: true</code></dt>
<dd><p>This controls whether MathJax issues the warning about not having an
explicit configuration in the event that the <cite>jax</cite> array is empty
after configuration is complete. If you really intend that array to
be empty, set this flag to <code class="docutils literal"><span class="pre">false</span></code>. Note that setting this to false
does <strong>not</strong> cause a default configuration file to be loaded.</p>
</dd></dl>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="preprocessors/index.html" class="btn btn-neutral float-right" title="Preprocessor options" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="Configuration Objects" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017 The MathJax Consortium.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'2.7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|