/usr/share/doc/libjs-mathjax-doc/html/options/preprocessors/asciimath2jax.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 | <!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 asciimath2jax Preprocessor — 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="Preprocessor options" href="index.html"/>
<link rel="next" title="The jsMath2jax Preprocessor" href="jsMath2jax.html"/>
<link rel="prev" title="The mml2jax Preprocessor" href="mml2jax.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"><a class="reference internal" href="../hub.html">The core options</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Preprocessor options</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="tex2jax.html">The tex2jax preprocessor options</a></li>
<li class="toctree-l3"><a class="reference internal" href="mml2jax.html">The mml2jax preprocessor options</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">The asciimath2jax preprocessor options</a></li>
<li class="toctree-l3"><a class="reference internal" href="jsMath2jax.html">The jsMath2jax preprocessor options</a></li>
</ul>
</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><a href="index.html">Preprocessor options</a> »</li>
<li>The asciimath2jax Preprocessor</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/options/preprocessors/asciimath2jax.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-asciimath2jax-preprocessor">
<span id="configure-asciimath2jax"></span><h1>The asciimath2jax Preprocessor<a class="headerlink" href="#the-asciimath2jax-preprocessor" title="Permalink to this headline">¶</a></h1>
<p>The options below control the operation of the <cite>asciimath2jax</cite> preprocessor
that is run when you include <code class="docutils literal"><span class="pre">"asciimath2jax.js"</span></code> in the <cite>extensions</cite> array
of your configuration. They are listed with their default values. To
set any of these options, include a <code class="docutils literal"><span class="pre">asciimath2jax</span></code> section in your
<code class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></code> call. For example</p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Hub</span><span class="p">.</span><span class="nx">Config</span><span class="p">({</span>
<span class="nx">asciimath2jax</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">delimiters</span><span class="o">:</span> <span class="p">[[</span><span class="s1">'`'</span><span class="p">,</span><span class="s1">'`'</span><span class="p">],</span> <span class="p">[</span><span class="s1">'$'</span><span class="p">,</span><span class="s1">'$'</span><span class="p">]]</span>
<span class="p">}</span>
<span class="p">});</span>
</pre></div>
</div>
<p>would set the ASCIIMath delimiters for the <cite>asciimath2jax</cite>
preprocessor to include dollar signs as well as back-ticks.</p>
<dl class="describe">
<dt>
<code class="descname">delimiters: [['`','`']]</code></dt>
<dd><p>Array of pairs of strings that are to be used as math
delimiters. The first in each pair is the initial delimiter and
the second is the terminal delimiter. You can have as many pairs
as you want. For example,</p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="nx">delimiters</span><span class="o">:</span> <span class="p">[</span> <span class="p">[</span><span class="s1">'$'</span><span class="p">,</span><span class="s1">'$'</span><span class="p">],</span> <span class="p">[</span><span class="s1">'`'</span><span class="p">,</span><span class="s1">'`'</span><span class="p">]</span> <span class="p">]</span>
</pre></div>
</div>
<p>would cause <cite>asciimath2jax</cite> to look for <code class="docutils literal"><span class="pre">$...$</span></code> and <code class="docutils literal"><span class="pre">`...`</span></code> as
delimiters for inline mathematics. (Note that the single dollar
signs are not enabled by default because they are used too
frequently in normal text, so if you want to use them for math
delimiters, you must specify them explicitly.)</p>
<p>Note that the delimiters can’t look like HTML tags (i.e., can’t
include the less-than sign), as these would be turned into tags by
the browser before MathJax has the chance to run. You can only
include text, not tags, as your math delimiters.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">preview: "AsciiMath"</code></dt>
<dd><p>This controls whether <cite>asciimath2jax</cite> inserts <code class="docutils literal"><span class="pre">MathJax_Preview</span></code>
spans to make a preview available, and what preview to use, when
it locates in-line or display mathematics in the page. The
default is <code class="docutils literal"><span class="pre">"AsciiMath"</span></code>, which means use the ASCIIMath code as
the preview (which will be visible until it is processed by
MathJax). Set to <code class="docutils literal"><span class="pre">"none"</span></code> to prevent previews from being
inserted (the math will simply disappear until it is typeset).
Set to an array containing the description of an HTML snippet in
order to use the same preview for all equations on the page.</p>
<p>Examples:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="nx">preview</span><span class="o">:</span> <span class="p">[</span><span class="s2">"[math]"</span><span class="p">],</span> <span class="c1">// insert the text "[math]" as the preview</span>
</pre></div>
</div>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="nx">preview</span><span class="o">:</span> <span class="p">[[</span><span class="s2">"img"</span><span class="p">,{</span><span class="nx">src</span><span class="o">:</span> <span class="s2">"/images/mypic.jpg"</span><span class="p">}]],</span> <span class="c1">// insert an image as the preview</span>
</pre></div>
</div>
<p>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">skipTags: ["script","noscript","style","textarea","pre","code"]</code></dt>
<dd><p>This array lists the names of the tags whose contents should not
be processed by <cite>asciimath2jax</cite> (other than to look for
ignore/process classes as listed below). You can add to (or
remove from) this list to prevent MathJax from processing
mathematics in specific contexts.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">ignoreClass: "asciimath2jax_ignore"</code></dt>
<dd><p>This is the class name used to mark elements whose contents should
not be processed by asciimath2jax (other than to look for the
<code class="docutils literal"><span class="pre">processClass</span></code> pattern below). Note that this is a regular
expression, and so you need to be sure to quote any <cite>regexp</cite>
special characters. The pattern is inserted into one that
requires your pattern to match a complete word, so setting
<code class="docutils literal"><span class="pre">ignoreClass:</span> <span class="pre">"class2"</span></code> would cause it to match an element with
<code class="docutils literal"><span class="pre">class="class1</span> <span class="pre">class2</span> <span class="pre">class3"</span></code> but not <code class="docutils literal"><span class="pre">class="myclass2"</span></code>.
Note that you can assign several classes by separating them by the
vertical line character (<code class="docutils literal"><span class="pre">|</span></code>). For instance, with
<code class="docutils literal"><span class="pre">ignoreClass:</span> <span class="pre">"class1|class2"</span></code> any element assigned a class of
either <code class="docutils literal"><span class="pre">class1</span></code> or <code class="docutils literal"><span class="pre">class2</span></code> will be skipped.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">processClass: "asciimath2jax_process"</code></dt>
<dd><p>This is the class name used to mark elements whose contents
<em>should</em> be processed by <cite>asciimath2jax</cite>. This is used to restart
processing within tags that have been marked as ignored via the
<code class="docutils literal"><span class="pre">ignoreClass</span></code> or to cause a tag that appears in the <code class="docutils literal"><span class="pre">skipTags</span></code>
list to be processed rather than skipped. Note that this is a
regular expression, and so you need to be sure to quote any
<cite>regexp</cite> special characters. The pattern is inserted into one
that requires your pattern to match a complete word, so setting
<code class="docutils literal"><span class="pre">processClass:</span> <span class="pre">"class2"</span></code> would cause it to match an element with
<code class="docutils literal"><span class="pre">class="class1</span> <span class="pre">class2</span> <span class="pre">class3"</span></code> but not <code class="docutils literal"><span class="pre">class="myclass2"</span></code>.
Note that you can assign several classes by separating them by the
vertical line character (<code class="docutils literal"><span class="pre">|</span></code>). For instance, with
<code class="docutils literal"><span class="pre">processClass:</span> <span class="pre">"class1|class2"</span></code> any element assigned a class of
either <code class="docutils literal"><span class="pre">class1</span></code> or <code class="docutils literal"><span class="pre">class2</span></code> will have its contents processed.</p>
</dd></dl>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="jsMath2jax.html" class="btn btn-neutral float-right" title="The jsMath2jax Preprocessor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="mml2jax.html" class="btn btn-neutral" title="The mml2jax Preprocessor" 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>
|