gollum 1.1.1 → 1.2.0

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/options/MMLorHTML.rst

@@ -0,0 +1,42 @@
+.. _configure-MMLorHTML:
+
+***********************************
+The MMLorHTML configuration options
+***********************************
+
+The options below control the operation of the MMLorHTML configuration
+file that is run when you include ``"MMLorHTML.js"`` in the `config`
+array of your configuration.  They are listed with their default
+values.  To set any of these options, include a ``MMLorHTML`` section
+in your :meth:`MathJax.Hub.Config()` call.  For example
+
+.. code-block:: javascript
+
+    MathJax.Hub.Config({
+      MMLorHTML: {
+        prefer: {
+	  Opera: "MML"
+	}
+      }
+    });
+
+would set the ``prefer`` option so that Opera browser would prefer
+MathML to HTML-CSS output (while leaving the settings for other
+browsers unchanged).
+
+Note that if you use the ``MMLorHTML.js`` configuration file, you should
+**not** specify an output processor in the `jax` array of your
+configuration; `MMLorHTML` will fill that in for you.
+
+.. describe:: prefer: { MSIE: "MML", Firefox: "MML", Opera: "HTML", other: "HTML" }
+
+   This lets you set the preferred renderer on a browser-by-browser
+   basis.  You set the browser to either ``"MML"`` or ``"HTML"``
+   depending on whether you want to use the `NativeMML` or `HTML-CSS`
+   output processor.  Note that although Opera does process some MathML
+   natively, its support is not sufficient to handle the more
+   complicated output generated by MathJax, so its setting is
+   ``"HTML"`` by default.
+
+
+

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/options/MathML.rst

@@ -0,0 +1,27 @@
+.. _configure-MathML:
+
+**************************
+The MathML input processor
+**************************
+
+The options below control the operation of the MathML input processor
+that is run when you include ``"input/MathML"`` in the `jax` array of
+your configuration.  They are listed with their default values.  To
+set any of these options, include a ``MathML`` section in your
+:meth:`MathJax.Hub.Config()` call.  For example
+
+.. code-block:: javascript
+
+    MathJax.Hub.Config({
+      MathML: {
+        useMathMLspacing: true
+      }
+    });
+
+would set the ``useMathMLspacing`` option so that the MathML rules for
+spacing would be used (rather than TeX spacing rules).
+
+.. describe:: useMathMLspacing: false
+
+    Specifies whether to use TeX spacing or MathML spacing when the
+    `HTML-CSS` output jax is used.

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/options/MathMenu.rst

@@ -0,0 +1,79 @@
+.. _configure-MathMenu:
+
+**********************
+The MathMenu extension
+**********************
+
+The options below control the operation of the contextual menu that is
+available on mathematics that is typeset by MathJax.
+They are listed with their default values.  To set any of these
+options, include a ``MathMenu`` section in your
+:meth:`MathJax.Hub.Config()` call.  For example
+
+.. code-block:: javascript
+
+    MathJax.Hub.Config({
+      MathMenu: {
+        delay: 600
+      }
+    });
+
+would set the ``delay`` option to 600 milliseconds.
+
+.. describe:: delay: 400
+
+    This is the hover delay for the display (in milliseconds) for
+    submenus in the contextual menu:  when the mouse is over a submenu
+    label for this long, the menu will appear.  (The submenu also will
+    appear if you click on its label.)
+
+.. describe:: helpURL: "http://www.mathjax.org/help/user/"
+
+    This is the URL for the MathJax Help menu item.  When the user
+    selects that item, the browser opens a new window with this URL.
+
+.. describe:: showRenderer: true
+
+   This controls whether the "Math Renderer" item will be displayed in
+   the the "Settings" submenu of the mathematics contextual menu.  It
+   allows the user to change between the `HTML-CSS` and `NativeMML`
+   output processors for the mathematics on the page.  Set to
+   ``false`` to prevent this menu item from showing.
+   
+.. describe:: showContext: false
+
+   This controls whether the "Contextual Menu" item will be displayed
+   in the the "Settings" submenu of the mathematics contextual menu.
+   It allows the user to decide whether the MathJax menu or the
+   browser's default contextual manu will be shown when the context
+   menu click occurs over mathematics typeset by MathJax.  (The main
+   reason to allow pass-through to the browser's menu is to gain
+   access to the MathPlayer contextual menu when the NativeMML output
+   processor is used in Internet Explorer with the `MathPlayer plugin
+   <http://www.dessci.com/en/products/mathplayer/>`_.)  Set to
+   ``false`` to prevent this menu item from showing.
+   
+.. describe:: showFontMenu: false
+
+   This controls whether the "Font Preference" item will be displayed
+   in the the "Settings" submenu of the mathematics contextual menu.
+   This submenu lets the user select what font to use in the
+   mathematics produced by the `HTML-CSS` output processor.  Note that
+   changing the selection in the font menu will cause the page to
+   reload.  Set to ``false`` to prevent this menu item from showing.
+   
+.. describe:: windowSettings: { ... }
+
+    These are the settings for the ``window.open()`` call that
+    creates the `Show Source` window.  The initial width and height
+    will be reset after the source is shown in an attempt to make the
+    window fit the output better.
+
+.. describe:: styles: {}
+
+    This is a list of CSS declarations for styling the menu
+    components.  See the definitions in ``extensions/MathMenu.js`` for
+    details 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.
+

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/options/MathZoom.rst

@@ -0,0 +1,42 @@
+.. _configure-MathZoom:
+
+**********************
+The MathZoom extension
+**********************
+
+The options below control the operation of the Math-Zoom feature that
+allows users to see an enlarged version of the mathematics when they
+click or hover over typeset mathematics.  They are listed with their
+default values.  To set any of these options, include a ``MathZoom``
+section in your :meth:`MathJax.Hub.Config()` call.  For example
+
+.. code-block:: javascript
+
+    MathJax.Hub.Config({
+      MathZoom: {
+        delay: 600
+      }
+    });
+
+would set the ``delay`` option to 600 milliseconds.
+
+Mathematics is zoomed when the user "triggers" the zoom by an action,
+either clicking on the mathematics, double-clicking on it, or holding
+the mouse still over it (i.e., "hovering").  Which trigger is used is
+set by the user via the math contextual menu (or by the author using
+the ``menuSettings`` configuration section).
+
+.. describe:: delay: 400
+
+   This the time (in milliseconds) that the mouse must be still over a
+   typeset mathematical formula before the zoomed version is displayed
+   (when the zoom trigger is set to `Hover`).
+
+.. describe:: styles: {}
+
+    This is a list of CSS declarations for styling the zoomed
+    mathematics.  See the definitions in ``extensions/MathZoom.js``
+    for details 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.
+

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/options/NativeMML.rst

@@ -0,0 +1,61 @@
+.. _configure-NativeMML:
+
+******************************
+The NativeMML output processor
+******************************
+
+The options below control the operation of the NativeMML output
+processor that is run when you include ``"output/NativeMML"`` in the
+`jax` array of your configuration.  They are listed with their default
+values.  To set any of these options, include a ``NativeMML`` section
+in your :meth:`MathJax.Hub.Config()` call.  For example
+
+.. code-block:: javascript
+
+    MathJax.Hub.Config({
+      NativeMML: {
+        scale: 105
+      }
+    });
+
+would set the ``sale`` option to 105 percent.
+
+.. describe:: scale: 100
+
+    The scaling factor (as a percentage) of math with respect to the
+    surrounding text.  Since the `NativeMML` output relies on the
+    browser's natiove MathML support, MathJax does not control the
+    font size used in the mathematics.  You may need to set this value
+    to compensate for the size selected by the browser.  The user can
+    also adjust this value using the contextual menu item associated
+    with the typeset mathematics.
+
+.. describe:: showMathMath: 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:: showMathMenuMSIE: true
+
+    There is a separate menu setting for MSIE since the code to handle
+    that is a bit delicate; if it turns out to have unexpected
+    consequences, you can turn it off without turing off other the
+    menu support in other browsers.
+   
+.. describe:: styles: {}
+
+    This is a list of CSS declarations for styling the HTML-CSS
+    output.  See the definitions in ``jax/output/NativeMML/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.

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/options/TeX.rst

@@ -0,0 +1,67 @@
+.. _configure-TeX:
+
+***********************
+The TeX input processor
+***********************
+
+The options below control the operation of the TeX input processor
+that is run when you include ``"input/TeX"`` in the `jax` array of
+your configuration.  They are listed with their default values.  To
+set any of these options, include a ``TeX`` section in your
+:meth:`MathJax.Hub.Config()` call.  For example
+
+.. code-block:: javascript
+
+    MathJax.Hub.Config({
+      TeX: {
+        Macros: {
+	  RR: '{\\bf R}',
+	  bold: ['{\\bf #1}', 1]
+	}
+      }
+    });
+
+would set the ``Macros`` configuration option to cause two new macros
+to be defined within the TeX input processor.
+
+.. describe:: TagSide: "right"
+
+    This specifies the side on which ``\tag{}`` macros will place the
+    tags.  Set it to ``"left"`` to place the tags on the left-hand side.
+
+.. describe:: TagIndent: ".8em"
+
+    This is the amount of indentation (from the right or left) for the
+    tags produced by the ``\tag{}`` macro.
+
+.. describe:: MultLineWidth: "85%"
+
+    The width to use for the `multline` environment that is part of
+    the ``AMSmath`` extension.  This width gives room for tags at
+    either side of the equation, but if you are displaying mathematics
+    in a small area or a thin column of text, you might need to change
+    the value to leave sufficient margin for tags.
+    
+.. describe:: Macros: {}
+
+   This lists macros to define before the TeX input processor begins.
+   These are name:value pairs where the `name` gives the name of the TeX
+   macro to be defined, and `value` gives the replacement text for the
+   macro.  The `value` canbe an array of the form `[value,n]`, where
+   `value` is the replacement text and `n` is the number of parameters
+   for the macro.  Note that since the `value` is a javascript string,
+   backslashes in the replacement text must be doubled to prevent them
+   from acting as javascript escape characters.
+
+   For example,
+
+   .. code-block:: javascript
+
+       Macros: {
+         RR: '{\\bf R}',
+	 bold: ['{\\bf #1}', 1]
+       }
+
+   would ask the TeX processor to define two new macros:  ``\RR``,
+   which produces a bold-face "R", and ``\bold{...}``, which takes one
+   parameter and set it in the bold-face font.

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/options/hub.rst

@@ -0,0 +1,209 @@
+.. _configure-hub:
+
+******************************
+The Core Configuration Options
+******************************
+
+The options below control the MathJax Hub, and so determine the code
+behavior of MathJax.  They are given with their default values.  
+
+.. describe:: jax: ["input/TeX","output/HTML-CSS"]
+
+    A comma-separated list of input and output jax to initialize at
+    startup.  Their main code is loaded only when they are actually
+    used, so it is not inefficient to include jax that may not
+    actually be used on the page. These are found in the ``MathJax/jax``
+    directory.
+
+.. describe:: extensions: []
+
+    A comma-separated list of extensions to load at startup. The
+    default directory is ``MathJax/extensions``.  The ``tex2jax`` and
+    ``mml2jax`` preprocessors can be listed here, as well as a number
+    of TeX-specific extensions (see the :ref:`TeX and LaTeX input
+    <tex-and-latex-input>` section of the :ref:`Getting Started
+    <getting-started>` document for more details).  There is also a
+    ``FontWarnings`` extension that you can use to inform your user
+    that mathematics fonts are available that they can download to
+    improve their experience of your site.
+
+.. describe:: config: []
+
+    A comma-separated list of configuration files to load when MathJax
+    starts up, e.g., to define local macros, etc., and there is a
+    sample config file named ``config/local/local.js``.  The default
+    directory is the `MathJax/config` directory.  The ``MMLorHTML.js``
+    configuration is the only other predefined configuration file.
+
+.. describe:: styleSheets: []
+
+    A comma-separated list of CSS stylesheet files to be loaded when
+    MathJax starts up.  The default directory is the `MathJax/config`
+    directory.
+
+.. describe:: styles: {}
+
+    CSS `selector: rules;` styles to be defined dynamically at startup
+    time.
+
+.. describe:: preJax: null and postJax: null
+
+    Patterns to remove from before and after math script tags. If you
+    are not using one of the preprocessors, you need to insert
+    something extra into your HTML file in order to avoid a bug in
+    Internet Explorer.  IE removes spaces from the DOM that it thinks
+    are redundent, and since a ``<script>`` tag usually doesn't add
+    content to the page, if there is a space before and after a
+    MathJax ``<script>`` tag, IE will remove the first space.  When
+    MathJax inserts the typeset mathematics, this means there will be
+    no space before it and the preceeding text.  In order to avoid
+    this, you should include some "guard characters" before or after
+    the math SCRIPT tag; define the patterns you want to use below.
+    Note that these are used as regular expressions, so you will need
+    to quote special characters.  Furthermore, since they are
+    javascript strings, you must quote javascript special characters
+    as well.  So to obtain a backslash, you must use ``\\`` (doubled
+    for javascript).  For example, ``"\\["`` represents the pattern
+    ``\[`` in the regular expression.  That means that if you want an
+    actual backslash in your guard characters, you need to use
+    ``"\\\\"`` in order to get ``\\`` in the regular expression, and
+    ``\`` in the actual text.  If both preJax and postJax are defined,
+    both must be present in order to be removed.
+
+    See also the ``preRemoveClass`` comments below.
+
+    Examples:
+
+        ``preJax: "\\\\\\\\\"`` makes a double backslash the preJax text
+
+	``preJax: "\\[\\[", postJax: "\\]\\]"`` makes it so jax
+	scripts must be enclosed in double brackets.
+
+.. describe:: preRemoveClass: "MathJax_Preview"
+
+    The CSS class for a math preview to be removed preceeding a
+    MathJax SCRIPT tag.  If the tag just before the MathJax
+    ``<script>`` tag is of this class, its contents are removed when
+    MathJax processes the ``<script>`` tag.  This allows you to
+    include a math preview in a form that will be displayed prior to
+    MathJax performing its typesetting.  It also avoids the Internet
+    Explorer space-removal bug, and can be used in place of ``preJax``
+    and ``postJax`` if that is more convenient.
+
+    For example
+
+    .. code-block:: html
+    
+        <span class="MathJax_Preview">[math]</span><script  type="math/tex">...</script>
+  
+    would display "[math]" in place of the math until MathJax is able
+    to typeset it.
+
+    See also the ``preJax`` and ``postJax`` comments above.
+
+.. describe:: showProcessingMessages: true
+
+    This value controls whether the `Processing Math: nn%` message are
+    displayed in the lower left-hand corner. Set to ``false`` to
+    prevent those messages (though file loading and other messages
+    will still be shown).
+
+.. describe:: messageStyle: "normal"
+
+    This value controls the verbosity of the messages in the lower
+    left-hand corner.  Set it to ``"none"`` to eliminate all messages,
+    or set it to ``"simple"`` to show "Loading..." and "Processing..."
+    rather than showing the full file name or the percentage of the
+    mathematics processed.
+
+.. describe:: displayAlign: "center" and displayIndent: "0em"
+
+    These two parameters control the alignment and shifting of
+    displayed equations.  The first can be ``"left"``, ``"center"``,
+    or ``"right"``, and determines the alignment of displayed
+    equations.  When the alignment is not ``"center"``, the second
+    determines an indentation from the left or right side for the
+    displayed equations.
+
+
+.. describe:: delayStartupUntil: "none"
+
+    Normally MathJax will perform its starup commands (loading of
+    configuration, styles, jax, and so on) as soon as it can.  If you
+    expect to be doing additional configuration on the page, however,
+    you may want to have it wait until the page's onload hander is
+    called.  If so, set this to ``"onload"``.
+
+.. describe:: skipStartupTypeset: false
+
+    Normally MathJax will typeset the mathematics on the page as soon
+    as the page is loaded.  If you want to delay that process, in
+    which case you will need to call :meth:`MathJax.Hub.Typeset()`
+    yourself by hand, set this value to ``true``.
+
+.. describe:: menuSettings: { ... }
+
+    This block contains settings for the mathematics contextual menu
+    that act as the defaults for the user's settings in that menu.
+    The possible values are:
+
+    .. describe:: zoom: "none"
+
+        This indicates when typeset mathematics should be zoomed.  It
+        can be set to ``"None"``, ``"Hover"``, ``"Click"``, or
+        ``"Double-Click"`` to set the zoom trigger.
+
+    .. describe:: CTRL: false, ALT: false, CMD: false, Shift: false
+
+        These values indicate which keys must be pressed in order for
+        math zoom to be triggered.  For example, if ``CTRL`` is set to
+        ``true`` and ``zoom`` is ``"Click"``, then math will be zoomed
+        only when the user control-clicks on mathematics (i.e., clicks
+        while holding down the `CTRL` key).  If more than one is
+        ``true``, then all the indicated keys must be pressed for the
+        zoom to occur.
+
+    .. describe:: zscale: "200%"
+
+        This is the zoom scaling factor, and it can be set to any of
+	the values available in the `Zoom Factor` menu of the
+	`Settings` submenu of the contextual menu.
+
+    .. describe:: context: "MathJax"
+
+        This controls what contextual menu will be presented when a
+        right click (on a PC) or CTRL-click (on the Mac) occurs over a
+        typeset equation.  When set to ``"MathJax"``, the MathJax
+        contextual menu will appear; when set to ``"Browser"``, the
+        browser's contextual menu will be used.  For example, in
+        Internet Explorer with the MathPlayer plugin, if this is set
+        to ``"Browser"``, you will get the MathPlayer contextual menu
+        rather than the MathJax menu.
+
+    There are also settings for ``format``, ``renderer``, and ``font``,
+    but these are maintained by MathJax and should not be set by the
+    page author.
+
+.. describe:: errorSettings: { ... }
+
+    This block contains settings that control how MathJax responds to
+    unexpected errors while processing mathematical equations.  Rather
+    than simply crash, MathJax can report an error and go on.  The
+    options you can set include:
+
+    .. describe:: message: ["[Math Processing Error"]]
+
+        This is an HTML snippet that will be inserted at the location
+        of the mathematics for any formula that causes MathJax to
+        produce an internal error (i.e., an error in the MathJax code
+        itself).  See the :ref:`description of HTML snippets
+        <html-snippets>` for details on how to represent HTML code in
+        this way.
+
+    .. describe:: style: {color:"#CC0000", "font-style":"italic"}
+
+        This is the CSS style description to use for the error
+        messages produced by internal MathJax errors.  See the section
+        on :ref:`CSS style objects <css-style-objects>` for details on
+        how these are specified in JavaScript.
+