gollum 1.1.1 → 1.2.0

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

@@ -0,0 +1,53 @@
+.. _configure-jsMath2jax:
+
+***************************
+The jsMath2jax Preprocessor
+***************************
+
+The options below control the operation of the `jsMath2jax`
+preprocessor that is run when you include ``"jsMath2jax.js"`` in the
+`extensions` array of your configuration.  They are listed with their
+default values.  To set any of these options, include a ``jsMath2jax``
+section in your :meth:`MathJax.Hub.Config()` call.  For example
+
+.. code-block:: javascript
+
+    MathJax.Hub.Config({
+      jsMath2jax: {
+        preview: "none"
+      }
+    });
+
+would set the ``preview`` parameter to ``"none"``.
+
+
+.. describe:: element: null
+
+    The id name of the element that should be processed by `jsMath2jax`.
+    The default is the whole document.
+
+.. describe:: preview: "TeX"
+
+    This controls whether `jsMath2jax` inserts ``MathJax_Preview`` spans
+    to make a preview available, and what preview to use, when it
+    locates in-line or display mathematics in the page.  The default
+    is ``"TeX"``, which means use the TeX code as the preview (which
+    will be visible until it is processed by MathJax).  Set to
+    ``"none"`` to prevent previews from being inserted (the math
+    will simply disappear until it is typeset).  Set to an array
+    containing the description of an HTML snippet in order to use the
+    same preview for all equations on the page.
+
+    Examples:
+
+    .. code-block:: javascript
+
+        preview: ["[math]"],     //  insert the text "[math]" as the preview
+
+    .. code-block:: javascript
+
+        preview: [["img",{src: "/images/mypic.jpg"}]],  // insert an image as the preview
+
+    See the :ref:`description of HTML snippets <html-snippets>` for
+    details on how to represent HTML code in this way.
+

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

@@ -0,0 +1,53 @@
+.. _configure-mml2jax:
+
+************************
+The mml2jax Preprocessor
+************************
+
+The options below control the operation of the `mml2jax` preprocessor
+that is run when you include ``"mml2jax.js"`` in the `extensions` array
+of your configuration.  They are listed with their default values.  To
+set any of these options, include a ``mml2jax`` section in your
+:meth:`MathJax.Hub.Config()` call.  For example
+
+.. code-block:: javascript
+
+    MathJax.Hub.Config({
+      mml2jax: {
+        preview: "none"
+      }
+    });
+
+would set the ``preview`` parameter to ``"none"``.
+
+.. describe:: element: null
+
+    The id name of the element that should be processed by `mml2jax`.
+    The default is the whole document.
+
+.. describe:: preview: "alttext"
+
+    This controls whether `mml2jax` inserts ``MathJax_Preview`` spans
+    to make a preview available, and what preview to use, when it
+    locates mathematics on the page.  The default is ``"alttext"``,
+    which means use the ``<math>`` tag's ``alttext`` attribute as the
+    preview (visible until it is processed by MathJax), if the tag has
+    one.  Set it to ``"none"`` to prevent the previews from being
+    inserted (the math will simply disappear until it is typeset).
+    Set it to an array containing the description of an HTML snippet
+    in order to use the same preview for all equations on the page.
+
+    Examples:
+
+    .. code-block:: javascript
+
+        preview: ["[math]"],     //  insert the text "[math]" as the preview
+
+    .. code-block:: javascript
+
+        preview: [["img",{src: "/images/mypic.jpg"}]],  // insert an image as the preview
+
+    See the :ref:`description of HTML snippets <html-snippets>` for
+    details on how to represent HTML code in this way.
+
+

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

@@ -0,0 +1,137 @@
+.. _configure-tex2jax:
+
+************************
+The tex2jax Preprocessor
+************************
+
+The options below control the operation of the `tex2jax` preprocessor
+that is run when you include ``"tex2jax.js"`` in the `extensions` array
+of your configuration.  They are listed with their default values.  To
+set any of these options, include a ``tex2jax`` section in your
+:meth:`MathJax.Hub.Config()` call.  For example
+
+.. code-block:: javascript
+
+    MathJax.Hub.Config({
+      tex2jax: {
+        inlineMath: [ ['$','$'], ['\\(','\\)'] ]
+      }
+    });
+
+would set the ``inlineMath`` delimiters for the `tex2jax`
+preprocessor.
+
+
+.. describe:: element: null
+
+    The id name of the element that should be processed by `tex2jax`.
+    The default is the whole document.
+
+.. describe:: inlineMath: [['\\(','\\)']]
+
+    Array of pairs of strings that are to be used as in-line math
+    delimters.  The first in each pair is the initial delimiter and
+    the second is the terminal delimiter.  You can have as many pairs
+    as you want.  For example,
+
+    .. code-block:: javascript
+
+        inlineMath: [ ['$','$'], ['\\(','\\)'] ]
+
+    would cause `tex2jax` to look for ``$...$`` and ``\(...\)`` as
+    delimiters for inline mathematics.  (Note that the single dollar
+    signs are not enabled by default because they are used too
+    frequently in normal text, so if you want to use them for math
+    delimiters, you must specify them explicitly.)
+
+    Note that the delimiters can't look like HTML tags (i.e., can't
+    include the less-than sign), as these would be turned into tags by
+    the browser before MathJax has the chance to run.  You can only
+    include text, not tags, as your math delimiters.
+
+.. describe:: displayMath: [ ['$$','$$'], ['\\[','\\]'] ]
+
+    Array of pairs of strings that are to be used as delimters for
+    displayed equations.  The first in each pair is the initial
+    delimiter and the second is the terminal delimiter.  You can have
+    as many pairs as you want.
+
+    Note that the delimiters can't look like HTML tags (i.e., can't
+    include the less-than sign), as these would be turned into tags by
+    the browser before MathJax has the chance to run.  You can only
+    include text, not tags, as your math delimiters.
+
+.. describe:: processEscapes: false
+
+    When set to ``true``, you may use ``\$`` to represent a literal
+    dollar sign, rather than using it as a math delimiter.  When
+    ``false``, ``\$`` will not be altered, and the dollar sign may be
+    considered part of a math delimiter.  Typically this is set to
+    ``true`` if you enable the ``$ ... $`` in-line delimiters, so you
+    can type ``\$`` and `tex2jax` will convert it to a regular dollar
+    sign in the rendered document.
+
+.. describe:: processEnvironments: true
+
+    When ``true``, `tex2jax` looks not only for the in-line and
+    display math delimters, but also for LaTeX environments 
+    (``\begin{something}...\end{something}``) and marks them for
+    processing by MathJax.  When ``false``, LaTeX environments will
+    not be processed outside of math mode.
+
+.. describe:: preview: "TeX"
+
+    This controls whether `tex2jax` inserts ``MathJax_Preview`` spans
+    to make a preview available, and what preview to use, when it
+    locates in-line or display mathematics in the page.  The default
+    is ``"TeX"``, which means use the TeX code as the preview (which
+    will be visible until it is processed by MathJax).  Set to
+    ``"none"`` to prevent previews from being inserted (the math
+    will simply disappear until it is typeset).  Set to an array
+    containing the description of an HTML snippet in order to use the
+    same preview for all equations on the page.
+
+    Examples:
+
+    .. code-block:: javascript
+
+        preview: ["[math]"],     //  insert the text "[math]" as the preview
+
+    .. code-block:: javascript
+
+        preview: [["img",{src: "/images/mypic.jpg"}]],  // insert an image as the preview
+
+    See the :ref:`description of HTML snippets <html-snippets>` for
+    details on how to represent HTML code in this way.
+
+.. describe:: skipTags: ["script","noscript","style","textarea","pre","code"]
+
+    This array lists the names of the tags whose contents should not
+    be processed by `tex2jax` (other than to look for ignore/process
+    classes as listed below).  You can add to (or remove from) this
+    list to prevent MathJax from processing mathematics in specific
+    contexts.
+
+.. describe:: ignoreClass: "tex2jax_ignore"
+
+    This is the class name used to mark elements whose contents should
+    not be processed by tex2jax (other than to look for the
+    ``processClass`` pattern below).  Note that this is a regular
+    expression, and so you need to be sure to quote any `regexp`
+    special characters.  The pattern is automatically preceeded by
+    ``'(^| )('`` and followed by ``')( |$)'``, so your pattern will
+    have to match full words in the class name.  Assigning an element
+    this class name will prevent `tex2jax` from processing its
+    contents.
+
+.. describe:: processClass: "tex2jax_process"
+
+    This is the class name used to mark elements whose contents
+    *should* be processed by `tex2jax`.  This is used to turn on
+    processing within tags that have been marked as ignored or skipped
+    above.  Note that this is a regular expression, and so you need to
+    be sure to quote any `regexp` special characters.  The pattern is
+    automatically preceeded by ``'(^| )('`` and followed by ``')(
+    |$)'``, so your pattern will have to match full words in the class
+    name.  Use this to restart processing within an element that has
+    been marked as ignored above.

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/output.rst

@@ -0,0 +1,126 @@
+.. _output-formats:
+
+**********************
+MathJax Output Formats
+**********************
+
+Currently, MathJax can render math in two ways:
+
+- Using HTML-with-CSS to lay out the mathematics, or
+- Using a browser's native MathML support.
+
+These are implemented by the `HTML-CSS` and `NativeMML` output
+processors.  You select which one you want to use by including either
+``"output/HTML-CSS"`` or ``"output/NativeMML"`` in the `jax` array of
+your MathJax configuration.  For example
+
+.. code-block:: javascript
+
+    jax: ["input/TeX","output/HTML-CSS"]
+
+would specify TeX input and HTML-with-CSS output for the mathematics
+in your document.
+
+The HTML-CSS output processor produces high-quality output in all
+major browsers, with results that are consistent across browsers and
+operating systems.  This is MathJax's primary output mode.  It's major
+advantage is its quality and consistency; it's drawback is that it is
+slower that the NativeMML mode at rendering the mathematics.  (The
+HTML-CSS processor has not yet been optimized for speed, so you can
+expect some improvement in the future.  Note that IE8 in "IE8
+standards mode" is an order of magnitude slower than any other browser
+when processing math through the HTML-CSS output processor; see
+:ref:`HTML-CSS with IE8 <html-css-with-ie8>` below for some strategies
+to deal with this.)
+
+The NativeMML output processor uses the browser's internal MathML support (if
+any) to render the mathematics.  Currently, Firefox has native support
+for MathML, and IE has the `MathPlayer plugin
+<http://www.dessci.com/en/products/mathplayer/>`_ for rendering
+MathML.  Opera has some built-in support for MathML that works well
+with simple equations, but fails with more complex formulas, so we
+don't recommend using the NativeMML output processor with Opera.  Safari,
+Chrome, Konqueror, and most other browsers don't support MathML
+natively.
+
+The advantage of the NativeMML output Processor is its speed, since
+native MathML support is much faster than using complicated HTML and
+CSS to lay out mathematics via an interpreted language like JavaScript
+(as the HTML-CSS output processor does).  The disadvantage is that you
+are dependent on the browser's MathML implementation for your
+rendering, and these vary in quality of output and completeness of
+implementation.  MathJax may rely on features that are not available
+in some renderers (for example, Firefox's MathML support does not
+implement some of the named widths, such as
+``negativethinmathspace``).  The results using the NativeMML output
+processor may have spacing or other rendering problems that are
+outside of MathJax's control.
+
+Automatic Selection of the Output Processor
+===========================================
+
+Since not all browsers support MathML natively, it would be unwise to
+choose the NativeMML output processor unless you are sure of your
+audience's browser capabilities.  MathJax can help with that, however,
+since there is a special configuration file that will choose between
+NativeMML and HTML-CSS depending on the browser in use.  To invoke it,
+add ``"MMLorHTML.js"`` to your configurations `config` array, and **do
+not** include an output processor in your `jax` array; MathJax will
+fill that in for you based on the abilities of your user's browser.
+
+.. code-block:: javascript
+
+   config: ["MMLorHTML.js"],
+   jax: ["input/TeX"]
+
+You can customize which choice to make on a browser-by-browser basis
+or a global basis.  See the ``config/MathJax.js`` file or the
+:ref:`Configuring MathJax <configuration>` section for futher
+details.
+
+MathJax produces MathML that models the underlying mathematics as best
+it can, rather than using complicated hacks to improve output for a
+particular MathML implementation.  When you make the choice to use the
+NativeMML output processor, you are making a trade-off: gaining speed
+at the expense of quality and reliability, a decision that should not
+be taken lightly.  Note, however, that a user can employ the MathJax
+contectual menu to select the other other renderer if he or she
+wishes.
+
+
+.. _html-css-with-ie8:
+
+HTML-CSS with IE8
+=================
+
+Internet Explorer 8 has at least eight different rendering modes in
+which can operate, and that are triggered by the `DOCTYPE` of the
+document being viewed.  It's "quirks" mode is its fasted mode, and its
+"IE8 standards" mode is its slowest.  This is the mode triggered by
+strict HTML document types, and since most modern content management
+systems now include a `DOCTYPE` that activates "standards" mode, IE8
+will operate in its slowest manner.  This is particularly apparent
+when MathJax is used, since IE8 in standards mode runs 20 to 30 times
+slower than its does in its IE7 emulation mode, and 60 times slower
+than in quirks mode.
+
+Most users find this speed reduction unacceptable when there is much
+mathematics on the page.  To overcome this problem, you may wish to
+tell IE8 to use its IE7 emulation mode rather than its IE8 standards
+mode.  You can accomplish this by including the line
+
+.. code-block:: html
+
+    <meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7">
+
+at the top of the ``<head>`` section of your HTML documents.  This
+lets you keep the strict `DOCTYPE` for validation purposes, while
+still managing to get reasonable perforance from Internext Explorer
+8.  Note that this line must come at the beginning of the ``<head>``,
+before any stylesheets or other content are loaded.
+
+Altertnatively, you can use the `MMLorHTML` configuration file
+described above to select NativeMML output when possible, and request
+that your users install the `MathPlayer plugin
+<http://www.dessci.com/en/products/mathplayer/>`_, which will render
+the mathematics much more quickly.

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/platforms/index.rst

@@ -0,0 +1,65 @@
+.. _platforms:
+
+======================================
+Using MathJax in popular web platforms
+======================================
+
+Most web-based content-management systems include a theme or template
+layer that determines how the pages look, and that loads information
+common to all pages.  Such theme files provide one popular way to
+include MathJax in your web templates in the absense of
+MathJax-specific plugins for the system you are using.  To take
+advantage of this approach, you will need access to your theme files,
+which probably means you need to be an administrator for the site; if
+you are not, you may need to have an administrator do these steps for
+you.
+
+To enable MathJax in your web platform, add the line::
+
+    <script type="text/javascript" src="path-to-MathJax/MathJax.js"></script>
+
+(where ``path-to-MathJax`` is the web-address of the main MathJax
+directory for your server) either just before the ``</head>`` tag in
+your theme file, or at the end of the file if it contains no
+``</head>``.
+
+The theme files for various popular platforms are:
+
+    `WordPress <http://wordpress.org/>`_
+        ``wp-content/themes/[current_theme]/header.php``
+
+    `Movable Type <http://www.movabletype.org/>`_
+        ``[current_theme_templates]/html_head.mhtml``
+
+    `Drupal <http://drupal.org/>`_
+        ``themes/[current_theme]/page.tpl.php``
+
+    `Joomla <http://www.joomla.org/>`_
+        ``templates/[current_theme]/index.php``
+
+    `MediaWiki <http://www.mediawiki.org/>`_
+        ``skins/[current_skin].php``
+
+    `TiddlyWiki <http://www.tiddlywiki.com/>`_
+        ``*.php`` (Whatever you call your TiddlyWiki php file)
+
+    `Moodle <http://moodle.org/>`_
+        ``theme/[current_theme]/header.html``
+
+Keep in mind that this will enable MathJax for your current
+theme/template only.  If you change themes or update your theme, you
+will have to repeat these steps.
+
+
+Insructions for Specific Platforms
+==================================
+
+Some programs, such as WordPress and Moveable Type, allow you to edit
+template files from inside their administrator interfaces.  Specific
+instructions for these are given via the links below.
+
+.. toctree::
+    :maxdepth: 1
+
+    Wordpress <wordpress>
+    Movable Type <movable-type>

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/platforms/movable-type.rst

@@ -0,0 +1,41 @@
+.. _platform-movable-type:
+
+==========================
+Using MathJax in WordPress
+==========================
+
+These instructions assume you already have placed the MathJax files on
+your server (see :ref:`Installing and Testing MathJax <installation>`).
+
+1. Open Moveable Type Admin interface for the site on which you want to enable
+   MathJax.
+
+2. In the dashboard menu on the left, open up the Design menu. This
+   should show you the templates you are currently using on the site.
+ 
+     .. image:: ../images/mt_menu.png
+ 
+
+3. Scroll down to the Template Modules section in the template list
+   and open the `HTML Head` template.
+ 
+     .. image:: ../images/mt_templates.png
+ 
+4. At the end of the file, insert
+
+   .. code-block:: html
+
+       <script type="text/javascript"  src="path-to-MathJax/MathJax.js"></script>
+
+   where ``path-to-MathJax`` is replaced by the web-address of the
+   main MathJax dorectory on your server.
+ 
+     .. image:: ../images/mt_head.png
+
+5. Save the file.  This should enable MathJax, so you should be able
+   to start adding mathematical content to your pages.  Use the
+   ``config/MathJas.js`` file in the MathJax directory to configure
+   MathJax to your needs (see :ref:`Configuring MathJax
+   <configuration>` for details).
+
+