/usr/share/doc/libjs-mathjax-doc/html/options/extensions/fast-preview.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 | <!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 fast-preview extension — 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="Extension options" href="index.html"/>
<link rel="next" title="The Content MathML extension" href="Content-MathML.html"/>
<link rel="prev" title="The AssistiveMML.js extension" href="assistive-mml.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"><a class="reference internal" href="../output-processors/index.html">Output processor options</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Extension options</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="a11y-extensions.html">The Accessibility Extensions options</a></li>
<li class="toctree-l3"><a class="reference internal" href="assistive-mml.html">The AssistiveMML options</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">The fast-preview options</a></li>
<li class="toctree-l3"><a class="reference internal" href="Content-MathML.html">The Content MathML options</a></li>
<li class="toctree-l3"><a class="reference internal" href="handle-floats.html">The HTML-CSS floats extension</a></li>
<li class="toctree-l3"><a class="reference internal" href="MML3.html">The experimental MML3 extension</a></li>
<li class="toctree-l3"><a class="reference internal" href="CHTML-preview.html">The CHTML-preview options [Deprecated]</a></li>
</ul>
</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">Extension options</a> »</li>
<li>The fast-preview extension</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/options/extensions/fast-preview.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-fast-preview-extension">
<span id="configure-fast-preview"></span><h1>The fast-preview extension<a class="headerlink" href="#the-fast-preview-extension" title="Permalink to this headline">¶</a></h1>
<p>The options below control the operation of the <cite>fast-preview</cite>
extension that is run when you include <code class="docutils literal"><span class="pre">"fast-preview.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">fast-preview</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="s2">"fast-preview"</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">Chunks</span><span class="o">:</span> <span class="p">{</span><span class="nx">EqnChunk</span><span class="o">:</span> <span class="mi">10000</span><span class="p">,</span> <span class="nx">EqnChunkFactor</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span> <span class="nx">EqnChunkDelay</span><span class="o">:</span> <span class="mi">0</span><span class="p">},</span>
<span class="nx">color</span><span class="o">:</span> <span class="s2">"inherit!important"</span><span class="p">,</span>
<span class="nx">updateTime</span><span class="o">:</span> <span class="mi">30</span><span class="p">,</span> <span class="nx">updateDelay</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span>
<span class="nx">messageStyle</span><span class="o">:</span> <span class="s2">"none"</span><span class="p">,</span>
<span class="nx">disabled</span><span class="o">:</span> <span class="kc">false</span>
<span class="p">}</span>
<span class="p">});</span>
</pre></div>
</div>
<p>would ask for the PreviewHTML output to run as a preview (<cite>disabled: false</cite>),
force inheritance of the surrounding text color, and set the <cite>updateTime</cite> and
<cite>updateDelay</cite> to low values (30ms / 6ms) to speed up
the preview pass. Furthermore, it configures the second pass to set the
chunking (<cite>Chunks</cite>) to a reflow every 10,000 equations and disables the
progress messages (<cite>messageStyle</cite>).</p>
<p>This extension provides a two-pass rendering mode. A <strong>first</strong>, fast-but-rough
rendering is genereated as a preview, using the
<a class="reference internal" href="../output-processors/PreviewHTML.html#configure-previewhtml"><span class="std std-ref">The PreviewHTML output processor</span></a>, then a <strong>second</strong> pass using the
configured output jax runs to update the preview output.</p>
<p>This two-pass mode will provide the reader with a quick, decent rendering to
start reading immediately, while silently updating that rendering with the
high quality layout later.</p>
<dl class="describe">
<dt>
<code class="descname">EqnChunk: 10000</code></dt>
<dt>
<code class="descname">EqnChunkFactor: 1</code></dt>
<dt>
<code class="descname">EqnChunkDelay: 0</code></dt>
<dd><p>These values control how “chunky” the <strong>second</strong> pass will be. For more
information see <a class="reference internal" href="../output-processors/HTML-CSS.html#configure-html-css"><span class="std std-ref">The HTML-CSS output processor</span></a> and <a class="reference internal" href="../output-processors/SVG.html#configure-svg"><span class="std std-ref">The SVG output processor</span></a>.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">color: "inherit!important"</code></dt>
<dd><p>This value allows you to choose a text color for the <strong>first</strong> passs.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">updateTime: 30</code></dt>
<dt>
<code class="descname">updateDelay: 6</code></dt>
<dd><p>These values control how often the <strong>second</strong> pass will pause to allow user
interaction (e.g., scrolling).</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">messageStyle: "none"</code></dt>
<dd><p>This value controls the verbosity of the processing messages during the
the <strong>second</strong> pass; see <a class="reference internal" href="../hub.html#configure-hub"><span class="std std-ref">The Core Configuration Options</span></a> for more information.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">disabled:false</code></dt>
<dd><p>This value enables or disables the preview mode. In particular,
it allows overriding a combined configuration file, cf.
<a class="reference internal" href="../../config-files.html#common-configurations"><span class="std std-ref">Combined Configurations</span></a>. The user can independently enable or disable
the fast preview via the MathJax Menu.</p>
</dd></dl>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Content-MathML.html" class="btn btn-neutral float-right" title="The Content MathML extension" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="assistive-mml.html" class="btn btn-neutral" title="The AssistiveMML.js extension" 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>
|