/usr/share/doc/libjs-mathjax-doc/html/options/output-processors/SVG.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 | <!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 SVG output processor — 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="Output processor options" href="index.html"/>
<link rel="next" title="The PreviewHTML output processor" href="PreviewHTML.html"/>
<link rel="prev" title="The NativeMML output processor" href="NativeMML.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"><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 current"><a class="reference internal" href="index.html">Output processor options</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="CommonHTML.html">The CommonHTML output processor options</a></li>
<li class="toctree-l3"><a class="reference internal" href="HTML-CSS.html">The HTML-CSS output processor options</a></li>
<li class="toctree-l3"><a class="reference internal" href="NativeMML.html">The NativeMML output processor options</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">The SVG output processor options</a></li>
<li class="toctree-l3"><a class="reference internal" href="PreviewHTML.html">The PreviewHTML output processor options</a></li>
<li class="toctree-l3"><a class="reference internal" href="PlainSource.html">The PlainSource output processor options</a></li>
<li class="toctree-l3"><a class="reference internal" href="MMLorHTML.html">The MMLorHTML configuration options [Deprecated]</a></li>
</ul>
</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">Output processor options</a> »</li>
<li>The SVG output processor</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/options/output-processors/SVG.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-svg-output-processor">
<span id="configure-svg"></span><h1>The SVG output processor<a class="headerlink" href="#the-svg-output-processor" title="Permalink to this headline">¶</a></h1>
<p>The options below control the operation of the SVG output
processor that is run when you include <code class="docutils literal"><span class="pre">"output/SVG"</span></code> in the
<cite>jax</cite> array of your configuration or load a combined configuration
file that includes the SVG output jax. They are listed with their default
values. To set any of these options, include an <code class="docutils literal"><span class="pre">SVG</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">SVG</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">scale</span><span class="o">:</span> <span class="mi">120</span>
<span class="p">}</span>
<span class="p">});</span>
</pre></div>
</div>
<p>would set the <code class="docutils literal"><span class="pre">scale</span></code> option to 120%.</p>
<dl class="describe">
<dt>
<code class="descname">scale: 100</code></dt>
<dd><p>The scaling factor (as a percentage) of math with respect to the
surrounding text. The <cite>SVG</cite> output processor tries to match
the ex-size of the mathematics with that of the text where it is
placed, but you may want to adjust the results using this scaling
factor. The user can also adjust this value using the contextual
menu item associated with the typeset mathematics.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">minScaleAdjust: 50</code></dt>
<dd><p>This gives a minimum scale (as a percent) for the scaling used by
MathJax to match the equation to the surrounding text. This will
prevent MathJax from making the mathematics too small.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">font: "TeX"</code></dt>
<dd><p>This is the font to use for rendering the mathematics. The
possible values are <code class="docutils literal"><span class="pre">TeX</span></code>, <code class="docutils literal"><span class="pre">STIX-Web</span></code>, <code class="docutils literal"><span class="pre">Asana-Math</span></code>,
<code class="docutils literal"><span class="pre">Neo-Euler</span></code>, <code class="docutils literal"><span class="pre">Gyre-Pagella</span></code>, <code class="docutils literal"><span class="pre">Gyre-Termes</span></code> and
<code class="docutils literal"><span class="pre">Latin-Modern</span></code>. Note that not all mathematical characters are
available in all fonts (e.g., Neo-Euler does not include italic
characters), so some mathematics may work better in some fonts
than in others. The <code class="docutils literal"><span class="pre">STIX-Web</span></code> font is the most complete.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">blacker: 1</code></dt>
<dd><p>This is the stroke width to use for all character paths (1em =
1000 units). This is a cheap way of getting slightly lighter or
darker characters, but remember that not all displays will act the
same, so a value that is good for you may not be good for everyone.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">undefinedFamily: "STIXGeneral, 'Arial Unicode MS', serif"</code></dt>
<dd><p>This is the font-family CSS value used for characters that are not
in the selected font (e.g., this is where to look for characters
not included in the MathJax TeX fonts). IE will stop looking
after the first font that exists on the system (even if it doesn’t
contain the needed character), so order these carefully.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">mtextFontInherit: false</code></dt>
<dd><p>This setting controls whether <code class="docutils literal"><span class="pre"><mtext></span></code> elements will be typeset
using the math fonts or the font of the surrounding text. When
<code class="docutils literal"><span class="pre">false</span></code>, the font for <code class="docutils literal"><span class="pre">mathvariant="normal"</span></code> will be used;
when <code class="docutils literal"><span class="pre">true</span></code>, the font will be inherited from the surrounding
paragraph.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">addMMLclasses: false</code></dt>
<dd><p>This controls whether the MathML structure is retained and CSS
classes are added to mark the original MathML elements (as in the
output from the <cite>HTML-CSS</cite> output jax). By default, the SVG
output jax removes unneeded nesting in order to produce a more
efficient markup, but if you want to use CSS to style the elements
as if they were MathML, you might need to set this to true.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">useFontCache: true</code></dt>
<dd><p>This controls whether the SVG output uses <code class="docutils literal"><span class="pre"><use></span></code> elements to re-use font paths rather than repeat paths every time. If <code class="docutils literal"><span class="pre">useGlobalCache</span></code> (see below) is set to <code class="docutils literal"><span class="pre">false</span></code>, this will still reduce duplication of paths while keeping each SVG self-contained.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">useGlobalCache: true</code></dt>
<dd><p>When set to <code class="docutils literal"><span class="pre">true</span></code> the SVG Output stores paths (corresponding to “fonts” in the SVG output) in a global SVG object using <code class="docutils literal"><span class="pre"><defs></span></code> elements so that it can re-use them in all equations via <code class="docutils literal"><span class="pre"><use></span></code> elements (much like a font file allows re-use of characters across the document). While set to <code class="docutils literal"><span class="pre">true</span></code> by default, it will have no effect if <code class="docutils literal"><span class="pre">useFontCache</span></code> is set to <code class="docutils literal"><span class="pre">false</span></code>.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">EqnChunk: 50</code></dt>
<dt>
<code class="descname">EqnChunkFactor: 1.5</code></dt>
<dt>
<code class="descname">EqnChunkDelay: 100</code></dt>
<dd><p>These values control how “chunky” the display of mathematical
expressions will be; that is, how often the equations will be
updated as they are processed.</p>
<p><code class="docutils literal"><span class="pre">EqnChunk</span></code> is the number of equations that will be typeset before
they appear on screen. Larger values make for less visual flicker
as the equations are drawn, but also mean longer delays before the
reader sees anything.</p>
<p><code class="docutils literal"><span class="pre">EqChunkFactor</span></code> is the factor by which the <code class="docutils literal"><span class="pre">EqnChunk</span></code> will
grow after each chunk is displayed.</p>
<p><code class="docutils literal"><span class="pre">EqChunkDelay</span></code> is the time (in milliseconds) to delay between
chunks (to allow the browser to respond to other user
interaction).</p>
<p>Set <code class="docutils literal"><span class="pre">EqnChunk</span></code> to 1, <code class="docutils literal"><span class="pre">EqnChunkFactor</span></code> to 1, and
<code class="docutils literal"><span class="pre">EqnChunkDelay</span></code> to 10 to get the behavior from MathJax v1.1 and
below.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">matchFontHeight: true</code></dt>
<dd><p>This option indicates whether MathJax should try to adjust the
x-height of equations to match the x-height of the surrounding text.
See the <a class="reference internal" href="../other/MatchWebFonts.html#configure-matchwebfonts"><span class="std std-ref">MatchWebFonts options</span></a> for finer
control, especially if you are using Web fonts.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">linebreaks: {}</code></dt>
<dd><p>This is an object that configures automatic linebreaking in the
SVG output. In order to be backward compatible with earlier
versions of MathJax, only explicit line breaks are performed by
default, so you must enable line breaks if you want automatic
ones. The object contains the following values:</p>
<dl class="describe">
<dt>
<code class="descname">automatic: false</code></dt>
<dd><p>This controls the automatic breaking of expressions: when
<code class="docutils literal"><span class="pre">false</span></code>, only <code class="docutils literal"><span class="pre">linebreak="newline"</span></code> is processed; when
<code class="docutils literal"><span class="pre">true</span></code>, line breaks are inserted automatically in long
expressions.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">width: "container"</code></dt>
<dd><p>This controls how wide the lines of mathematics can be.</p>
<p>Use an explicit width like <code class="docutils literal"><span class="pre">"30em"</span></code> for a fixed width.
Use <code class="docutils literal"><span class="pre">"container"</span></code> to compute the size from the containing
element.
Use <code class="docutils literal"><span class="pre">"nn%</span> <span class="pre">container"</span></code> for a portion of the container.
Use <code class="docutils literal"><span class="pre">"nn%"</span></code> for a portion of the window size.</p>
<p>The container-based widths may be slower, and may not produce
the expected results if the layout width changes due to the
removal of previews or inclusion of mathematics during
typesetting.</p>
</dd></dl>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">styles: {}</code></dt>
<dd><p>This is a list of CSS declarations for styling the SVG output.
See the definitions in <code class="docutils literal"><span class="pre">jax/output/SVG/config.js</span></code> for some
examples of what are defined by default. See <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 to specify CSS
style in a JavaScript object.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">tooltip: { ... }</code></dt>
<dd><p>This sets the configuration options for <code class="docutils literal"><span class="pre"><maction></span></code> elements
with <code class="docutils literal"><span class="pre">actiontype="tooltip"</span></code>. (See also the <code class="docutils literal"><span class="pre">#MathJax_Tooltip</span></code>
style setting in <code class="docutils literal"><span class="pre">jax/output/SVG/config.js</span></code>, which can be
overridden using the <code class="docutils literal"><span class="pre">styles</span></code> option above.)</p>
<p>The <code class="docutils literal"><span class="pre">tooltip</span></code> section can contain the following options:</p>
<dl class="describe">
<dt>
<code class="descname">delayPost: 600</code></dt>
<dd><p>The delay (in milliseconds) before the tooltip is posted after
the mouse is moved over the <code class="docutils literal"><span class="pre">maction</span></code> element.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">delayClear: 600</code></dt>
<dd><p>The delay (in milliseconds) before the tooltop is cleared
after the mouse moves out of the <code class="docutils literal"><span class="pre">maction</span></code> element.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">offsetX: 10</code></dt>
<dt>
<code class="descname">offsetY: 5</code></dt>
<dd><p>These are the offset from the mouse position (in pixels)
where the tooltip will be placed.</p>
</dd></dl>
</dd></dl>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="PreviewHTML.html" class="btn btn-neutral float-right" title="The PreviewHTML output processor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="NativeMML.html" class="btn btn-neutral" title="The NativeMML output processor" 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>
|