File: variable.html

package info (click to toggle)
mathjax 1.1-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 128,884 kB
  • sloc: makefile: 118; python: 21
file content (218 lines) | stat: -rw-r--r-- 8,442 bytes parent folder | download
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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>The MathJax variable &mdash; MathJax v1.1 documentation</title>
    <link rel="stylesheet" href="../_static/mj.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </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="../../../MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>-->
    <link rel="top" title="MathJax v1.1 documentation" href="../index.html" />
    <link rel="up" title="The MathJax API" href="index.html" />
    <link rel="next" title="The MathJax.Hub Object" href="hub.html" />
    <link rel="prev" title="The MathJax API" href="index.html" /> 
  </head>
  <body>
    
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="hub.html" title="The MathJax.Hub Object"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="The MathJax API"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">MathJax v1.1 documentation</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">The MathJax API</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="the-mathjax-variable">
<h1>The MathJax variable<a class="headerlink" href="#the-mathjax-variable" title="Permalink to this headline">¶</a></h1>
<p>MathJax has a single global variable, <tt class="docutils literal"><span class="pre">MathJax</span></tt>, in which all its
data, and the data for loaded components, are stored.  The MathJax
variable is a nested structure, with its top-level properties being
objects themselves.</p>
<div class="section" id="main-mathjax-components">
<h2>Main MathJax Components<a class="headerlink" href="#main-mathjax-components" title="Permalink to this headline">¶</a></h2>
<dl class="describe">
<dt>
<tt class="descname">MathJax.Hub</tt></dt>
<dd><p>Contains the MathJax hub code and variables, including the startup
code, the onload handler, the browser data, and so forth.</p>
</dd></dl>

<dl class="describe">
<dt>
<tt class="descname">MathJax.Ajax</tt></dt>
<dd><p>Contains the code for loading external modules and creating
stylesheets.  Most of the code that causes most of MathJax to
operate asynchronously is handled here.</p>
</dd></dl>

<dl class="describe">
<dt>
<tt class="descname">MathJax.Message</tt></dt>
<dd><p>Contains the code to handle the intermittant message window that
periodically appears in the lower left-hand corner of the window.</p>
</dd></dl>

<dl class="describe">
<dt>
<tt class="descname">MathJax.HTML</tt></dt>
<dd><p>Contains support code for creating HTML elements dynamically from
descriptions stored in JavaScript objects.</p>
</dd></dl>

<dl class="describe">
<dt>
<tt class="descname">MathJax.CallBack</tt></dt>
<dd><p>Contains the code for managing MathJax callbacks, queues and
signals.</p>
</dd></dl>

<dl class="describe">
<dt>
<tt class="descname">MathJax.Extensions</tt></dt>
<dd><p>Initially empty, this is where extensions can load their code.
For example, the <cite>tex2jax</cite> preprocessor creates
<tt class="docutils literal"><span class="pre">MathJax.Extensions.tex2jax</span></tt> for its code and variables.</p>
</dd></dl>

<dl class="describe">
<dt>
<tt class="descname">MathJax.Object</tt></dt>
<dd><p>Contains the code for the MathJax object-oriented programming model.</p>
</dd></dl>

<dl class="describe">
<dt>
<tt class="descname">MathJax.InputJax</tt></dt>
<dd><p>The base class for all input <cite>jax</cite> objects.  Subclasses for
specific input jax are created as sub-objects of
<tt class="docutils literal"><span class="pre">MathJax.InputJax</span></tt>. For example, the TeX input jax loads itself
as <tt class="docutils literal"><span class="pre">MathJax.InputJax.TeX</span></tt>.</p>
</dd></dl>

<dl class="describe">
<dt>
<tt class="descname">MathJax.OutputJax</tt></dt>
<dd><p>The base class for all output <cite>jax</cite> objects.  Subclasses for
specific output jax are created as sub-objects of
<tt class="docutils literal"><span class="pre">MathJax.OutputJax</span></tt>.  For example, the HTML-CSS output jax loads
itself as <tt class="docutils literal"><span class="pre">MathJax.OutputJax[&quot;HTML-CSS&quot;]</span></tt>.</p>
</dd></dl>

<dl class="describe">
<dt>
<tt class="descname">MathJax.ElementJax</tt></dt>
<dd><p>The base class for all element <cite>jax</cite> objects.  Subclasses for
specific element jax are creates as sub-objects of
<tt class="docutils literal"><span class="pre">MathJax.ElementJax</span></tt>.  For example, the mml element jax loads
itself as <tt class="docutils literal"><span class="pre">MathJax.ElementJax.mml</span></tt>.</p>
</dd></dl>

</div>
<div class="section" id="properties">
<h2>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h2>
<dl class="describe">
<dt>
<tt class="descname">MathJax.version</tt></dt>
<dd><p>The version number of the MathJax library.</p>
</dd></dl>

<dl class="describe">
<dt>
<tt class="descname">MathJax.isReady</tt></dt>
<dd><p>This is set to <tt class="docutils literal"><span class="pre">true</span></tt> when MathJax is set up and ready to
perform typesetting actions (and is <tt class="docutils literal"><span class="pre">null</span></tt> otherwise).</p>
</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">The MathJax variable</a><ul>
<li><a class="reference internal" href="#main-mathjax-components">Main MathJax Components</a></li>
<li><a class="reference internal" href="#properties">Properties</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="index.html"
                        title="previous chapter">The MathJax API</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="hub.html"
                        title="next chapter">The MathJax.Hub Object</a></p>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="hub.html" title="The MathJax.Hub Object"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="The MathJax API"
             >previous</a> |</li>
        <li><a href="../index.html">MathJax v1.1 documentation</a> &raquo;</li>
          <li><a href="index.html" >The MathJax API</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2011 Design Science.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    </div>
    
  </body>
</html>