gollum 1.1.1 → 1.2.0

data/lib/gollum/frontend/public/javascript/MathJax/docs/html/_sources/model.txt

@@ -0,0 +1,224 @@
+****************************
+The MathJax Processing Model
+****************************
+
+The purpose of MathJax is to bring the ability to include mathematics
+easily in web pages to as wide a range of browsers as possible.
+Authors can specify mathematics in a variety of formats (e.g.,
+:term:`MathML` or :term:`LaTeX`), and MathJax provides high-quality
+mathematical typesetting even in those browsers that do not have
+native MathML support.  This all happens without the need for special
+downloads or plugins, but rendering will be enhanced if high-quality
+math fonts (e.g., :term:`STIX`) are available to the browser.
+
+MathJax is broken into several different kinds of components: page
+preprocessors, input processors, output processors, and the MathJax
+Hub that organizes and connects the others.  The input and output
+processors are called :term:`jax`, and are described in more detail
+below.
+
+When MathJax runs, it looks through the page for special tags that
+hold mathematics; for each such tag, it locates an appropriate input
+jax which it uses to convert the mathematics into an internal form
+(called an element jax), and then calls an output jax to transform the
+internal format into HTML content that displays the mathematics within
+the page.  The page author configures MathJax by indicating which
+input and output jax are to be used.
+
+Often, and especially with pages that are authored by hand, the
+mathematics is not stored (initially) within the special tags needed
+by MathJax, as that would require more notation than the average page
+author is willing to type.  Instead, it is entered in a form that is
+more natural to the page author, for example, using the standard TeX
+math delimiters ``$...$`` and ``$$...$$`` to indicate what part of the
+document is to be typeset as mathematics.  In this case, MathJax can
+run a preprocessor to locate the math delimiters and replace them by
+the special tags that it uses to mark the formulas.  There are
+preprocessors for :ref:`TeX notation <TeX-support>`, :ref:`MathML
+notation <MathML-support>`, and the :ref:`jsMath notation
+<jsMath-support>` that uses `span` and `div` tags.
+
+For pages that are constructed programatically, such as HTML
+pages that result from running a processor on text in some other
+format (e.g., pages produced from Markdown documents, or via programs
+like `tex4ht`), it would be best to use MathJax's special tags
+directly, as described below, rather than having MathJax run
+another preprocessor.  This will speed up the final display of the
+mathematics, since the extra preprocessing step would not be needed,
+and it also avoids the conflict between the use of the less-than sign,
+``<``, in mathematics and asn an HTML special character (that starts
+an HTML tag).
+
+
+How mathematics is stored in the page
+=====================================
+
+In order to identify mathematics in the page, MathJax uses special
+``<script>`` tags to enclose the mathematics.  This is done because
+such tags can be located easily, and because their content is not
+further processed by the browser; for example, less-than signs can be
+used as they are in mathematics, without worrying about them being
+mistaken for the beginnings of HTML tags.  One may also consider the
+math notation as a form of "script" for the mathematics, so a
+``<script>`` tag makes at least some sense for storing the math.
+
+Each ``<script>`` tag has a ``type`` attribute that identifies the
+kind of script that the tag contains.  The usual (and default) value
+is ``type="text/javascript"``, and when a script has this type, the
+browser executes the script as a javascript program.  MathJax,
+however, uses the type `math/tex` to identify mathematics in the TeX
+and LaTeX notation, and `math/mml` for mathematics in MathML
+notation.  When the `tex2jax` or `mml2jax` preprocessors run, they
+create ``<script>`` tags with these types so that MathJax can process
+them when it runs its main typesetting pass.
+
+For example, 
+
+.. code-block:: html
+
+    <script type="math/tex">x+\sqrt{1-x^2}</script>
+
+represents an in-line equation in TeX notation, and 
+
+.. code-block:: html
+
+    <script type="math/tex; mode=display">
+      \sum_{n=1}^\infty {1\over n^2} = {\pi^2\over 6}
+    </script>
+
+is a displayed TeX equation.
+
+Alternatively, using MathML notation, you could use
+
+.. code-block:: html
+
+    <script type="math/mml">
+      <math>
+        <mi>x</mi>
+        <mo>+</mo>
+        <msqrt>
+          <mn>1</mn>
+          <mo>&#x2212;<!-- − --></mo>
+          <msup>
+            <mi>x</mi>
+            <mn>2</mn>
+          </msup>
+        </msqrt>
+      </math>
+    </script>
+
+for in-line math, or
+
+.. code-block:: html
+
+    <script type="math/mml">
+      <math display="block">
+        <mrow>
+          <munderover>
+            <mo>&#x2211;<!-- ∑ --></mo>
+            <mrow>
+              <mi>n</mi>
+              <mo>=</mo>
+              <mn>1</mn>
+            </mrow>
+            <mi mathvariant="normal">&#x221E;<!-- ∞ --></mi>
+          </munderover>
+        </mrow>
+        <mrow>
+          <mfrac>
+            <mn>1</mn>
+            <msup>
+              <mi>n</mi>
+              <mn>2</mn>
+            </msup>
+          </mfrac>
+        </mrow>
+        <mo>=</mo>
+        <mrow>
+          <mfrac>
+            <msup>
+              <mi>&#x03C0;<!-- π --></mi>
+              <mn>2</mn>
+            </msup>
+            <mn>6</mn>
+          </mfrac>
+        </mrow>
+      </math>
+    </script>
+
+for displayed equations in MathML notation.
+As other input jax are created, they will use other types to identify
+the mathematics they can process.
+
+Page authors can use one of MathJax's preprocessors to convert from
+math delimiters that are more natural for the author to type (e.g.,
+TeX math delimiters like ``$$...$$``) to MathJax's ``<script>``
+format.  Blog and wiki software could extend from their own markup
+languages to include math delimiters, which they could convert to
+MathJax's ``<script>`` format automatically.
+
+Note, however, that Internet Explorer has a bug that causes it to
+remove the space before a ``<script>`` tag if there is also a space
+after it, which can cause serious spacing problems with in-line math
+in Internet Explorer.  There are three possible solutions to this in
+MathJax.  The recommended way is to use a math preview (an element
+with class ``MathJax_Preview``) that is non-empty and comes right
+before the ``<script>`` tag.  Its contents can be just the word
+``[math]``, so it does not have to be specific to the mathematics
+script that follows; it just has to be non-empty (though it could have
+its style set to ``display:none``).  See also the ``preJax`` and
+``postJax`` options in the :ref:`Core Configuration Options
+<configure-hub>` document for another approach.
+
+
+The components of MathJax
+=========================
+
+The main components of MathJax are its preprocessors, its input and
+output jax, and the MathJax Hub, which coordinates the actions of the
+other components.
+
+**Input jax** are associated with the different script types (like
+:mimetype:`math/tex` or :mimetype:`math/mml`) and the mapping of a
+particular type to a particular jax is made when the various jax
+register their abilities with the MathJax Hub at configuration time.
+For example, the MathML input jax registers the :mimetype:`math/mml`
+type, so MathJax will know to call the MathML input jax when it sees
+math elements of that type.  The role of the input jax is to convert
+the math notation entered by the author into the internal format used
+by MathJax (called an `element jax`).  This internal format is
+essentially MathML (represented as JavaScript objects), so an input
+jax acts as a translator into MathML.
+
+**Output jax** convert that internal element jax format into a specific
+output format.  For example, the NativeMML output jax inserts MathML
+tags into the page to represent the mathematics, while the HTML-CSS
+output jax uses HTML with CSS styling to lay out the mathematics so
+that it can be displayed even in browsers that dont understand
+MathML.  Output jax could be produced that render the mathematics
+using SVG, for example, or that speak an equation for the blind
+users.  The MathJax contextual menu can be used to switch between the
+output jax that are available.
+
+Each input and output jax has a small configuration file that is
+loaded when that input jax is included in the `jax` array in the
+MathJax configuration, and a larger file that implements the core
+functionality of that particular jax.  The latter file is loaded
+when the first time the jax is needed by MathJax to process some
+mathematics.
+
+The **MathJax Hub** keeps track of the internal representations of the
+various mathematical equations on the page, and can be queried to
+obtain information about those equations.  For example, one can obtain
+a list of all the math elements on the page, or look up a particular
+one, or find all the elements with a given input format, and so on.
+In a dynamically generated web page, an equation where the source
+mathematics has changed can be asked to re-render itself, or if a new
+paragraph is generated that might include mathematics, MathJax can be
+asked to process the equations it contains.
+
+The Hub also manages issues concerning mouse events and other user
+interaction with the equation itself.  Parts of equations can be made
+active so that mouse clicks cause event handlers to run, or activate
+hyperlinks to other pages, and so on, making the mathematics as
+dynamic as the rest of the page.

data/lib/gollum/frontend/public/javascript/MathJax/docs/html/_sources/options/FontWarnings.txt

@@ -0,0 +1,140 @@
+.. _configure-FontWarnings:
+
+**************************
+The FontWarnings extension
+**************************
+
+The options below control the operation of the `FontWarnings`
+extension that is run when you include ``"FontWarnings.js"`` in the
+`extensions` array of your configuration.  They are listed with their
+default values.  To set any of these options, include a
+``FontWarnings`` section in your :meth:`MathJax.Hub.Config()` call.
+For example
+
+.. code-block:: javascript
+
+    MathJax.Hub.Config({
+      FontWarnings: {
+        fadeoutTime: 2*1000
+      }
+    });
+
+would set the ``fadeoutTime`` option to 2000 milliseconds (2 seconds).
+
+.. describe:: messageStyle: { ... }
+
+   This sets the CSS styles to be used for the font warning message
+   window.  See the ``extensions/FontWarnings.js`` file for details of
+   what are set by default.  See the :ref:`CSS style objects
+   <css-style-objects>` for details about how to specify CSS styles
+   via javascript objects.
+
+.. describe:: Message: { ... }
+
+   This block contains HTML snippets to be used for the various
+   messages that the FontWarning extension can produce.  There are
+   three messages that you can redefine to suit your needs:
+
+   .. describe:: webFont: [ ... ]
+
+       The message used for when MathJax uses web-based fonts (rather
+       than local fonts installed on the user's system).
+
+   .. describe:: imageFonts: [ ... ]
+
+       The message used for when MathJax must use image fonts rather
+       than local or web-based fonts (for those browsers that don't
+       handle the ``@font-face`` CSS directive).
+
+   .. describe:: noFonts: [ ... ]
+
+       The message used when MathJax is unable to find any font to use
+       (i.e., neither local nor web-based nor image-based fonts are
+       available).
+
+   Any message that is set to ``null`` rather than an HTML snippet
+   array will not be presented to the user, so you can set, for
+   example, the ``webFont`` message to ``null`` in order to have the
+   ``imageFonts`` and ``noFonts`` messages, but no message if MathJax
+   uses web-based fonts.
+
+   See the description of :ref:`HTML snippets <html-snippets>` for
+   details about how to describe the messages using HTML snippets.
+   Note that in addition to the usual rules for defining such
+   snippets, the FontWarnings snippets can include references to
+   pre-defined snippets (that represent elements common to all three
+   messages).  These are defined below in the ``HTML`` block, and are
+   referenced using ``["name"]`` within the snippet, where `name` is
+   the name of one of the snippets defined in the ``HTML``
+   configuration block.  For example
+
+   .. code-block:: javascript
+
+       Message: {
+         noFonts: [
+           ["closeBox"],
+           "MathJax is unable to locate a font to use to display ",
+           "its mathematics, and image fonts are not available, so it ",
+           "is falling back on generic unicode characters in hopes that ",
+           "your browser will be able to display them.  Some characters ",
+           "may not show up properly, or possibly not at all.",
+           ["fonts"],
+           ["webfonts"]
+	 ]
+       }
+
+    refers to the ``closeBox``, ``fonts`` and ``webfonts`` snippets in
+    declared in the ``HTML`` section.
+
+.. describe:: HTML: { ... }
+
+    This object defines HTML snippets that are common to more than one
+    message in the ``Message`` section above.  They can be called in
+    by using ``["name"]`` in an HTML snippet, where `name` refers to
+    the name of the snippet in the ``HTML`` block.  The pre-defined
+    snippets are:
+
+    .. describe:: closeBox
+
+        The HTML for the close box in the FontWarning message.
+
+    .. describe:: webfonts
+
+        The HTML for a paragraph suggesting an upgrade to a more
+        modern browser that supports web fonts.
+
+    .. describe:: fonts
+
+        HTML that includes links to the MathJax and STIX font download
+        pages.
+
+    .. describe:: STIXfonts
+
+        HTML that gives the download link for the STIX fonts only.
+        (Used in place of `fonts` when the `HTML-CSS` option for
+        `availableFonts` only includes the :term:`STIX` fonts.)
+
+    .. describe:: TeXfonts
+
+        HTML that gives the download link for the MathJax TeX fonts
+        only.  (Used in place of `fonts` when the `HTML-CSS` option
+        for `availableFonts` only includes the `TeX` fonts.)
+
+    You can add your own pre-defined HTML snippets to this object, or
+    override the ones that are there with your own text.
+
+.. describe:: removeAfter: 12*1000
+
+    This is the amount of time to show the FontWarning message, in
+    milliseconds.  The default is 12 seconds.
+
+.. describe:: fadeoutSteps: 10
+
+    This is the number of steps to take while fading out the
+    FontWarning message.  More steps make for a smoother fade-out.
+
+.. describe:: fadeoutTime: 1.5*1000
+
+    This is the time used to perform the fade-out, in milliseconds.
+    The default is 1.5 seconds.
+

data/lib/gollum/frontend/public/javascript/MathJax/docs/html/_sources/options/HTML-CSS.txt

@@ -0,0 +1,119 @@
+.. _configure-HTML-CSS:
+
+*****************************
+The HTML-CSS output processor
+*****************************
+
+The options below control the operation of the HTML-CSS output
+processor that is run when you include ``"output/HTML-CSS"`` in the
+`jax` array of your configuration.  They are listed with their default
+values.  To set any of these options, include a ``"HTML-CSS"`` section
+in your :meth:`MathJax.Hub.Config()` call.  Note that, because of the
+dash, you need to enclose the name in quotes.  For example
+
+.. code-block:: javascript
+
+    MathJax.Hub.Config({
+      "HTML-CSS": {
+        preferredFont: "STIX"
+      }
+    });
+
+would set the ``preferredFont`` option to the :term:`STIX` fonts.
+
+.. describe:: scale: 100
+
+    The scaling factor (as a percentage) of math with respect to the
+    surrounding text.  The `HTML-CSS` output processor tries to match
+    the en-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.
+
+.. describe:: availableFonts: ["STIX","TeX"]
+
+    This is a list of the fonts to look for on a user's computer in
+    preference to using MathJax's web-based fonts.  These must
+    correspond to directories available in the
+    ``jax/output/HTML-CSS/fonts`` directory, where MathJax stores data
+    about the characters available in the fonts.  Set this to
+    ``["TeX"]``, for example, to prevent the use of the :term:`STIX`
+    fonts, or set it to an empty list, `[]`, if you want to force
+    MathJax to use web-based or image fonts.
+
+.. describe:: preferredFont: "TeX"
+
+    Which font to prefer out of the ``availableFonts`` list, when more
+    than one is available on the user's computer.
+
+.. describe:: webFont: "TeX"
+
+    This is the web-based font to use when none of the fonts listed
+    above are available on the user's computer.  Note that currently
+    only the `TeX` font is available in a web-based form (they are
+    stored in the ``fonts/HTML-CSS`` folder in the MathJax directory.
+    Set this to ``null`` to disable web fonts.
+    
+.. describe:: imageFont: "TeX"
+
+    This is the font to use for image fallback mode (when none of the
+    fonts listed above are available and the browser doesn't support
+    web-fonts via the ``@font-face`` CSS directive).  Note that currently
+    only the TeX font is available as an image font (they are stores
+    in the ``fonts/HTML-CSS`` directory).
+
+    Set this to ``null`` if you want to prevent the use of image fonts
+    (e.g., you have deleted or not installed the image fonts on your
+    server).  In this case, only browsers that support web-based fonts
+    will be able to view your pages without having the fonts installed
+    on the client computer.  The browsers that support web-based fonts
+    include: IE6 and later, Chrome, Safari3.1 and above, Firefox3.5
+    and later, and Opera10 and later.  Note that Firefox3.0 is **not**
+    on this list.
+
+.. describe:: styles: {}
+
+    This is a list of CSS declarations for styling the HTML-CSS
+    output.  See the definitions in ``jax/output/HTML-CSS/config.js``
+    for some examples of what are defined by default.  See :ref:`CSS
+    Style Objects <css-style-objects>` for details on how to specify
+    CSS style in a JavaScript object.
+
+.. describe:: showMathMenu: true
+
+    This controls whether the MathJax contextual menu will be
+    available on the mathematics in the page.  If true, then
+    right-clicking (on the PC) or control-clicking (on the Mac) will
+    produce a MathJax menu that allows you to get the source of the
+    mathematics in various formats, change the size of the mathematics
+    relative to the surrounding text, get information about
+    MathJax, and configure other MathJax settings.
+     
+    Set this to ``false`` to disable the menu.  When ``true``, the
+    ``MathMenu`` configuration block determines the operation of the
+    menu.  See :ref:`the MathMenu options <configure-MathMenu>` for
+    more details.
+
+.. describe:: tooltip: { ... }
+
+    This sets the configuration options for ``<maction>`` elements
+    with ``actiontype="tooltip"``.  (See also the ``#MathJax_Tooltip``
+    style setting in ``jax/output/HTML-CSS/config.js``, which can be
+    overridden using the ``styles`` option above.)
+
+    The ``tooltip`` section can contain the following options:
+
+    .. describe:: delayPost: 600
+
+        The delay (in milliseconds) before the tooltip is posted after
+        the mouse is moved over the ``maction`` element.
+
+    .. describe:: delayClear: 600
+
+        The delay (in milliseconds) before the tooltop is cleared
+        after the mouse moves out of the ``maction`` element.
+
+    .. describe:: offsetX: 10 and offsetY: 5
+
+        These are the offset from the mouse position (in pixels) 
+	where the tooltip will be placed.