/usr/share/doc/libjs-mathjax-doc/html/api/jax.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 | <!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 Base Jax Class — 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="The MathJax API" href="index.html"/>
<link rel="next" title="The MathJax Object-Oriented Programming Model" href="object.html"/>
<link rel="prev" title="The MathJax.ElementJax Class" href="elementjax.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>
<li class="toctree-l1"><a class="reference internal" href="../options/index.html">Configuration options</a></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 class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Details of the MathJax API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="variable.html">The MathJax variable</a></li>
<li class="toctree-l2"><a class="reference internal" href="hub.html">The MathJax.Hub object</a></li>
<li class="toctree-l2"><a class="reference internal" href="ajax.html">The MathJax.Ajax object</a></li>
<li class="toctree-l2"><a class="reference internal" href="message.html">The MathJax.Message object</a></li>
<li class="toctree-l2"><a class="reference internal" href="html.html">The MathJax.HTML object</a></li>
<li class="toctree-l2"><a class="reference internal" href="callback.html">The MathJax.CallBack class</a></li>
<li class="toctree-l2"><a class="reference internal" href="queue.html">The MathJax.CallBack.Queue class</a></li>
<li class="toctree-l2"><a class="reference internal" href="signal.html">The MathJax.CallBack.Signal class</a></li>
<li class="toctree-l2"><a class="reference internal" href="localization.html">The MathJax.Localization object</a></li>
<li class="toctree-l2"><a class="reference internal" href="inputjax.html">The MathJax.InputJax class</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputjax.html">The MathJax.OutputJax class</a></li>
<li class="toctree-l2"><a class="reference internal" href="elementjax.html">The MathJax.ElementJax class</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">The base Jax class</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#class-properties">Class Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="#instance-properties">Instance Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="object.html">The MathJax Object-Oriented Programming Model</a></li>
</ul>
</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">The MathJax API</a> »</li>
<li>The Base Jax Class</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/jax.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-base-jax-class">
<span id="api-jax"></span><h1>The Base Jax Class<a class="headerlink" href="#the-base-jax-class" title="Permalink to this headline">¶</a></h1>
<p>The <cite>MathJax.InputJax</cite>, <cite>MathJax.OutputJax</cite> and <cite>MathJax.ElementJax</cite>
classes are all subclasses of the base <cite>Jax</cite> class in MathJax. This
is a private class that implements the methods common to all three
other jax classes.</p>
<p>Unlike most MathJax.Object classes, calling the class object creates a
<em>subclass</em> of the class, rather than an instance of the class. E.g.,</p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="nx">MathJax</span><span class="p">.</span><span class="nx">InputJax</span><span class="p">.</span><span class="nx">MyInputJax</span> <span class="o">=</span> <span class="nx">MathJax</span><span class="p">.</span><span class="nx">InputJax</span><span class="p">({</span>
<span class="nx">id</span><span class="o">:</span> <span class="s2">"MyInputJax"</span><span class="p">,</span>
<span class="nx">version</span><span class="o">:</span> <span class="s2">"1.0"</span><span class="p">,</span>
<span class="p">...</span>
<span class="p">});</span>
</pre></div>
</div>
<p>creates <code class="docutils literal"><span class="pre">MathJax.InputJax.MyInputJax</span></code> as a subclass of <code class="docutils literal"><span class="pre">MathJax.InputJax</span></code>.</p>
<div class="section" id="class-properties">
<h2>Class Properties<a class="headerlink" href="#class-properties" title="Permalink to this headline">¶</a></h2>
<dl class="describe">
<dt>
<code class="descname">directory</code></dt>
<dd><p>The name of the jax directory (usually <code class="docutils literal"><span class="pre">"[MathJax]/jax"</span></code>).
Overridden in the subclass to be the specific directory for the
class, e.g. <code class="docutils literal"><span class="pre">"[MathJax]/jax/input"</span></code>.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">extensionDir</code></dt>
<dd><p>The name of the extensions directory (usually <code class="docutils literal"><span class="pre">"[MathJax]/extensions"</span></code>).</p>
</dd></dl>
</div>
<div class="section" id="instance-properties">
<h2>Instance Properties<a class="headerlink" href="#instance-properties" title="Permalink to this headline">¶</a></h2>
<dl class="describe">
<dt>
<code class="descname">id</code></dt>
<dd><p>The name of the jax.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">version</code></dt>
<dd><p>The version number of the jax.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">directory</code></dt>
<dd><p>The directory for the jax (e.g., <code class="docutils literal"><span class="pre">"[MathJax]/jax/input/TeX"</span></code>).</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">require: null</code></dt>
<dd><p>An array of files to load before the <code class="docutils literal"><span class="pre">jax.js</span></code> file calls the
<code class="xref py py-meth docutils literal"><span class="pre">MathJax.Ajax.loadComplete()</span></code> method.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">config: {}</code></dt>
<dd><p>An object that contains the default configuration options for the
jax. These can be modified by the author by including a
configuration subsection for the specific jax in question.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">JAXFILE: "jax.js"</code></dt>
<dd><p>The name of the file that contains the main code for the jax.</p>
</dd></dl>
</div>
<div class="section" id="methods">
<h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="Translate">
<code class="descname">Translate</code><span class="sig-paren">(</span><em>script</em><span class="sig-paren">)</span><a class="headerlink" href="#Translate" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a stub for a routine that should be defined by the jax’s
<code class="docutils literal"><span class="pre">jax.js</span></code> file when it is loaded. It should perform the translation
action for the specific jax. For an input jax, it should return the
<cite>ElementJax</cite> object that it created. The <a class="reference internal" href="#Translate" title="Translate"><code class="xref py py-meth docutils literal"><span class="pre">Translate()</span></code></a> method is
never called directly by MathJax; during the <code class="docutils literal"><span class="pre">loadComplete()</span></code>
call, this function is copied to the <a class="reference internal" href="hub.html#Process" title="Process"><code class="xref py py-meth docutils literal"><span class="pre">Process()</span></code></a> method, and is
called via that name. The default <a class="reference internal" href="#Translate" title="Translate"><code class="xref py py-meth docutils literal"><span class="pre">Translate()</span></code></a> method throws an
error indicating that the <a class="reference internal" href="#Translate" title="Translate"><code class="xref py py-meth docutils literal"><span class="pre">Translate()</span></code></a> method was not
redefined. That way, if the <code class="docutils literal"><span class="pre">jax.js</span></code> file fails to load for some
reason, you will receive an error trying to process mathematics with
this jax.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>script</strong> — reference to the DOM <code class="docutils literal"><span class="pre"><script></span></code> object for
the mathematics to be translated</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">an <cite>ElementJax</cite> object, or <code class="docutils literal"><span class="pre">null</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="Register">
<code class="descname">Register</code><span class="sig-paren">(</span><em>mimetype</em><span class="sig-paren">)</span><a class="headerlink" href="#Register" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is overridden in the <cite>InputJax</cite>, <cite>OutputJax</cite> and
<cite>ElementJax</cite> subclasses to handle the registration of those
classes of jax.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>mimetype</strong> — the MIME-type to be associated with the jax</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><code class="docutils literal"><span class="pre">null</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt>
<code class="descname">Config</code><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
<dd><p>Inserts the configuration block for this jax from the author’s
configuration specification into the jax’s <code class="docutils literal"><span class="pre">config</span></code> property.
If the configuration includes an <code class="docutils literal"><span class="pre">Augment</span></code> object, that is used
to augment the jax (that is, the configuration can override the
methods of the object, as well as the data). This is called
automatically during the loading of the <code class="docutils literal"><span class="pre">jax.js</span></code> file.</p>
</dd></dl>
<dl class="method">
<dt id="Startup">
<code class="descname">Startup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Startup" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a method that can be overridden in the subclasses to
perform initialization at startup time (after the configuration
has occurred).</p>
</dd></dl>
<dl class="method">
<dt>
<code class="descname">loadComplete</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span></dt>
<dd><p>This is called by the <code class="docutils literal"><span class="pre">config.js</span></code> and <code class="docutils literal"><span class="pre">jax.js</span></code> files when they
are completely loaded and are ready to signal that fact to
MathJax. For <code class="docutils literal"><span class="pre">config.js</span></code>, this simply calls the
<code class="xref py py-meth docutils literal"><span class="pre">MathJax.Ajax.loadComplete()</span></code> method for the <code class="docutils literal"><span class="pre">config.js</span></code>
file. For <code class="docutils literal"><span class="pre">jax.js</span></code>, the actions performed here are the
following:</p>
<blockquote>
<div><ol class="arabic simple">
<li>Post the “[name] Jax Config” message to the startup signal.</li>
<li>Perform the jax’s <a class="reference internal" href="hub.html#Config" title="Config"><code class="xref py py-meth docutils literal"><span class="pre">Config()</span></code></a> method.</li>
<li>Post the “[name] Jax Require” message to the startup signal.</li>
<li>Load the files from the jax’s <code class="docutils literal"><span class="pre">require</span></code> and
<code class="docutils literal"><span class="pre">config.extensions</span></code> arrays.</li>
<li>Post the “[name] Jax Startup” message to the startup signal.</li>
<li>Perform the jax’s <a class="reference internal" href="#Startup" title="Startup"><code class="xref py py-meth docutils literal"><span class="pre">Startup()</span></code></a> method.</li>
<li>Post the “[name] Jax Ready” message to the startup signal.</li>
<li>Copy the <code class="docutils literal"><span class="pre">preTranslate</span></code>, <code class="docutils literal"><span class="pre">Translate</span></code>, and
<code class="docutils literal"><span class="pre">postTranslate</span></code> functions to <code class="docutils literal"><span class="pre">preProcess</span></code>, <code class="docutils literal"><span class="pre">Process</span></code>,
and <code class="docutils literal"><span class="pre">postProcess</span></code>.</li>
<li>Perform the <code class="xref py py-meth docutils literal"><span class="pre">MathJax.Ajax.loadComplete()</span></code> call for the
<code class="docutils literal"><span class="pre">jax.js</span></code> file.</li>
</ol>
</div></blockquote>
<p>Note that the configuration process (the <a class="reference internal" href="hub.html#Config" title="Config"><code class="xref py py-meth docutils literal"><span class="pre">Config()</span></code></a> call) can
modify the <code class="docutils literal"><span class="pre">require</span></code> or <code class="docutils literal"><span class="pre">config.extensions</span></code> arrays to add more
files that need to be loaded, and that the <a class="reference internal" href="#Startup" title="Startup"><code class="xref py py-meth docutils literal"><span class="pre">Startup()</span></code></a> method
isn’t called until those files are completely loaded.</p>
</dd></dl>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="object.html" class="btn btn-neutral float-right" title="The MathJax Object-Oriented Programming Model" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="elementjax.html" class="btn btn-neutral" title="The MathJax.ElementJax Class" 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>
|