gollum 1.1.1 → 1.2.0

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

@@ -0,0 +1,75 @@
+.. _glossary:
+
+********
+Glossary
+********
+
+.. if you add new entries, keep the alphabetical sorting!
+
+.. glossary::
+
+    Callback
+        A JavaScript function that is used to perform actions that
+        must wait for other actions to complete before they are
+        performed.
+    
+    Callback Queue
+        MathJax uses `Queues` to synchronize its activity so that
+        actions that operate asynchronously (like loading files) will
+        be performed in the right order.  :term:`Callback` functions
+        are pushed onto the queue, and are performed in order, with
+        MathJax handling the synchronization if operations need to
+        wait for other actions to finish.
+    
+    Callback Signal
+        A JavaScript object that acts as a mailbox for MathJax events.
+        Like an event handler, but it also keeps a history of
+        messages.  Your code can register an "interest" in a signal,
+        or can register a :term:`callback` to be called when a
+        particular message is sent along the signal channel.
+    
+    HTML-CSS
+        MathJax output form that employs only on HTML and CSS 2.1,
+        allowing MathJax to remain compatible across all browsers.
+    
+    jax
+        MathJax's input and output processors are called "jax", as is
+        its internal format manager.  The code for the jax are in the
+        ``MathJax/jax`` directory.
+
+    LaTeX
+        LaTeX is a variant of :term:`TeX` that is now the dominant TeX style.
+        
+        .. seealso::
+            
+            `LaTeX Wikipedia entry <http://en.wikipedia.org/wiki/LaTeX>`_
+    
+    MathML
+        An XML specification created to describe mathematical
+        notations and capture both its structure and content. MathML
+        is much more verbose than :term:`TeX`, but is much more
+        machine-readable.
+        
+        .. seealso::
+            
+            `MathML Wikipedia entry <http://en.wikipedia.org/wiki/MathML>`_
+    
+    STIX
+        The Scientific and Technical Information Exchange font
+        package. A comprehensive set of scientific glyphs.
+        
+        .. seealso::
+            
+            `STIX project <http://stixfonts.org/>`_
+    
+    TeX
+        A document markup language with robust math markup commands
+        developed by Donald Knuth in the late 1970's, but still in
+        extensive use today.  It became the industry standard for
+        typesetting of mathematics, and is one of the most common
+        formats for mathematical journals, articles, and books.
+        
+        .. seealso::
+            
+            `TeX Wikipedia entry <http://en.wikipedia.org/wiki/TeX>`_
+    

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

@@ -0,0 +1,71 @@
+#####################
+MathJax Documentation
+#####################
+
+MathJax is an open-source JavaScript display engine for LaTeX and
+MathML that works in all modern browsers.
+
+Basic Usage
+===========
+
+.. toctree::
+    :maxdepth: 1
+
+    What is MathJax? <mathjax>
+    Getting Started with MathJax <start>
+    Installing and Testing MathJax <installation>
+    Loading and Configuring MathJax <configuration>
+    Using MathJax in Web Platforms <platforms/index>
+
+.. toctree::
+    :maxdepth: 1
+
+    MathJax TeX and LaTeX Support <tex>
+    MathJax MathML Support <mathml>
+    MathJax Output Formats <output>
+
+.. toctree::
+    :maxdepth: 1
+
+    The MathJax Community <community>
+
+
+.. _advanced-topics:
+
+Advanced Topics
+===============
+
+.. toctree::
+    :maxdepth: 1
+
+    The MathJax Processing Model <model>
+    The MathJax Startup Sequence <startup>
+    Synchronizing Your Code with MathJax <synchronize>
+    Loading MathJax Dynamically <dynamic>
+    Modifying Math on the Page <typeset>
+
+.. toctree::
+    :maxdepth: 1
+
+    Details of the MathJax API<api/index>
+
+.. toctree::
+    :maxdepth: 1
+
+    Converting to MathJax from jsMath <jsMath>
+
+Reference Pages
+===============
+
+.. toctree::
+    :maxdepth: 1
+
+    HTML snippets <HTML-snippets>
+    CSS style objects <CSS-styles>
+    Glossary <glossary>
+
+* :ref:`Search <search>`
+
+--------
+
+This version of the documentation was built |today|.

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

@@ -0,0 +1,184 @@
+.. _installation:
+
+******************************
+Installing and Testing MathJax
+******************************
+
+MathJax can be loaded from a public web server or privately from your
+hard drive or other local media.  To use MathJax in either way, you
+will need to obtain a copy of MathJax and its font package.  There are
+two main ways to do this:  via ``svn`` or via a pre-packaged archive.
+We recommend the former, as it is easier to keep your installation up
+to date using ``svn``.
+
+
+.. _getting-mathjax-svn:
+
+Obtaining MathJax via SVN
+=========================
+
+The easiest way to get MathJax and keep it up to date is to use the
+`subversion <http://subversion.apache.org/>`_  source control system,
+``svn``.  Use the commands
+
+.. code-block:: sh
+
+    svn co http://mathjax.svn.sourceforge.net/svnroot/mathjax/trunk/mathjax mathjax
+    cd mathjax
+    unzip fonts.zip
+
+to obtain and set up a copy of MathJax.  (The `SourceForge development
+page <http://sourceforge.net/projects/mathjax/develop>`_ also shows
+how to do this.)
+
+Whenever you want to update MathJax, you can now use
+
+.. code-block:: sh
+
+    cd mathjax
+    svn status
+
+to check if there are updates to MathJax.  If MathJax needs updating,
+use
+
+.. code-block:: sh
+
+    cd mathjax
+    svn update
+    #  if fonts.zip is updated, do the following as well:
+    rm -rf fonts
+    unzip fonts.zip
+
+to udpate your copy of MathJax to the current release version.  If the
+``fonts.zip`` file has been updated, you will need to remove the old
+fonts directory and unpack the new one bring your installation up to
+date.  If you keep MathJax updated in this way, you will be sure that
+you have the latest bug fixes and new features as they become
+available.
+
+This gets you the current development copy of MathJax, which is the
+"bleeding-edge" version that contains all the latest changes to
+MathJax.  At times, however, these may be less stable than the
+"release" version.  If you prefer to use the most stable version (that
+may not include all the latest patches and features), use
+
+.. code-block:: sh
+
+    svn co http://mathjax.svn.sourcesforge.net/svnroot/mathjax/tags/mathjax-1.0 mathajx
+    cd mathjax
+    unzip fonts.zip
+
+to obtain the version 1.0 release.  When you wish to update to a new
+release, you will need to check out a new copy of MathJax with the new
+release number.
+
+
+.. _getting-mathjax-zip:
+
+Obtaining MathJax via an archive
+================================
+
+Release versions of MathJax are available in archive files from the
+`MathJax download page <http://www.mathjax.org/download/>`_ or the
+`SourceForge files page
+<http://sourceforge.net/projects/mathjax/files/>`_, where you can
+download the archives that you need. 
+
+You should download the ``MathJax-v1.0.zip`` file, then simply unzip
+it. Once the MathJax directory is unpacked, you should move it to the
+desired location on your server (or your hard disk, if you are using
+it locally rather then through a web server).  One natural location is
+to put it at the top level of your web server's hierarchy.  That would
+let you refer to the main MathJax file as ``/MathJax/MathJax.js`` from
+within any page on your server.
+
+
+Testing your installation
+=========================
+
+Use the HTML files in the ``test`` directory to see if your
+installation is working properly::
+
+    test/
+        index.html          # Tests default configuration
+        index-images.html   # Tests image-font fallback display
+        sample.html         # Sample page with lots of pretty equations
+
+Open these files in your browser to see that they appear to be working
+properly.  If you have installed MathJax on a server, use the web
+address for those files rather than opening them locally.  When you
+view the ``index.html`` file, you should see (after a few moments) a
+message that MathJax appears to be working.  If not, you should check
+that the files have been transferred to the server completely, that
+the fonts archive has been unpacked in the correct location, and that
+the permissions allow the server to access the files and folders that
+are part of the MathJax directory (be sure to verify the MathJax
+folder's permissions as well).  Checking the server logs may help
+locate problems with the installation.
+
+
+.. _cross-domain-linking:
+
+Notes about shared installations
+================================
+
+Typically, you want to have MathJax installed on the same server as
+your web pages that use MathJax.  There are times, however, when that
+may be impractical, or when you want to use a MathJax installation at
+a different site.  For example, a departmental server at
+``www.math.yourcollege.edu`` might like to use a college-wide
+installation at ``www.yourcollege.edu`` rather than installing a
+separate copy on the departmental machine.  MathJax can certainly
+be loaded from another server, but there is one imporant caveat ---
+Firefox's same-origin security policy for cross-domain scripting.
+
+Firefox’s interpretation of the same-origin policy is more strict than
+most other browsers, and it affects how fonts are loaded with the
+`@font-face` CSS directive.  MathJax uses this directory to load
+web-based math fonts into a page when the user doesn't have them
+installed locally on their own computer.  Firefox's security policy,
+however, only allows this when the fonts come from the same server as
+the web page itself, so if you load MathJax (and hence its web fonts)
+from a different server, Firefox won't be able to access those web
+fonts.  In this case, MathJax will pause while waiting for the font to
+download (which will never happen) and will time out after about 15
+seconds for each font it tries to access.  Typically that is three or
+four fonts, so your Foirefox users will experience a minute or so
+delay before mathematics is displayed, and then it will probably
+display incorrectly because the browser doesn't have access to the
+correct fonts.
+
+There is a solution to this, however, if you manage the server where
+MathJax is installed, and if that server is running the `Apache web
+server <http://www.apache.org/>`_.  In the remote server's
+``MathJax/fonts/HTML-CSS/TeX/otf`` folder, create a file called
+``.htaccess`` that contains the following lines: ::
+
+   <FilesMatch "\.(ttf|otf|eot)$">
+   <IfModule mod_headers.c>
+   Header set Access-Control-Allow-Origin "*"
+   </IfModule>
+   </FilesMatch>
+
+and make sure the permissions allow the server to read this file.
+(The file's name starts with a period, which causes it to be an
+"invisible" file on unix-based operating systems.  Some systems,
+particularly graphic user interfaces, may not allow you to create such
+files, so you might need to use the command-line interface to
+accomplish this.)
+
+This file should make it possible for pages at other sites to load
+MathJax from this server in such a way that Firefox will be able to
+download the web-based fonts.  If you want to restrict the sites that
+can access the web fonts, change the ``Access-Control-Allow-Origin``
+line to something like::
+
+   Header set Access-Control-Allow-Origin "http://www.math.yourcollege.edu"
+
+so that only pages at ``www.math.yourcollege.edu`` will be able to
+download the fonts from this site.  See the open font library
+discussion of `web-font linking
+<http://openfontlibrary.org/wiki/Web_Font_linking_and_Cross-Origin_Resource_Sharing>`_
+for more details.
+
+

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

@@ -0,0 +1,31 @@
+.. _jsMath-support:
+
+*********************************
+Converting to MathJax from jsMath
+*********************************
+
+MathJax is the successor to the popular `jsMath
+<http://www.math.union.edu/locate/jsMath/>`_ package for rendering
+mathematics in web pages.  Like jsMath, MathJax works by locating and
+processing the mathematics within the webpage once it has been loaded
+in the browser by a user viewing your web pages.  If you are using
+jsMath with its ``tex2math`` preprocessor, then switching to MathJax
+should be easy, and is simply a matter of configuring MathJax
+appropriately.  See the section on :ref:`Configuring MathJax
+<configuration>` for details about loading and configuring MathJax.
+
+On the other hand, if you are using jsMath's ``<span
+class="math">...</span>`` and ``<div class="math">...</div>`` tags to
+mark the mathematics in your document, then you should use MathJax's
+``jsMath2jax`` preprocessor when you switch to MathJax.  To do this,
+include ``"jsMath2jax.js"`` in the `extensions` array of your
+configuration, with the `jax` array set to include ``"input/TeX"``.
+
+.. code-block:: javascript
+
+    extensions: ["jsMath2jax.js"],
+    jax: ["input/TeX", ...]
+
+There are a few configuration options for ``jsMath2jax``, which you
+can find in the ``config/MathJax.js`` file, or in the :ref:`jsMath
+configuration options <configure-jsMath2jax>` section.

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

@@ -0,0 +1,36 @@
+****************
+What is MathJax?
+****************
+
+MathJax is an open-source JavaScript display engine for LaTeX and
+MathML that works in all modern browsers.  It was designed with the
+goal of consolidating the recent advances in web technologies into a
+single, definitive, math-on-the-web platform supporting the major
+browsers and operating systems.  It requires no setup on the part of
+the user (no plugins to downlaod or software to install), so the page
+author can write web documents that include mathematics and be
+confident that users will be able to view it naturally and easily.
+One simply includes MathJax and some mathematics in a web page, and
+MathJax does the rest.
+
+MathJax uses web-based fonts (in those browsers that support it) to
+produce high-quality typesetting that scales and prints at full
+resolution (unlike mathematics included as images).  MathJax can be
+used with screen readers, providing accessibility for the visually
+impaired.  With MathJax, mathematics is text-based rather than
+image-based, and so it is available for search engines, meaning that
+your equations can be searchable, just like the text of your pages.
+MathJax allows page authors to write formulas using TeX and LaTeX
+notation, or `MathML <http://www.w3.org/TR/MathML3>`_, a World Wide
+Web Constortium standard for representing mathematics in XML format.
+MathJax will even convert TeX notation into MathML, so that it can be
+rendered more quickly by those browsers that support MathML natively,
+or so that you can copy and past it into other programs.
+
+MathJax is modular, so it loads components only when necessary, and
+can be extended to include new capabilities as needed.  MathJax is
+highly configurable, allowing authors to customize it for the special
+requirements of their web sites.  Finally, MathJax has a rich
+application programming interface (API) that can be used to make the
+mathematics on your web pages interactive and dynamic.
+

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

@@ -0,0 +1,97 @@
+.. _MathML-support:
+
+**********************
+MathJax MathML Support
+**********************
+
+The support for :term:`MathML` in MathJax consists of three parts:  the
+`mml2jax` preprocessor, the MathML input processor, and the NativeMML
+output processor.  The first of these looks for ``<math>`` tags within
+your document and marks them for later processing by MathJax.  The
+second converts the MathML to the internal format used by MathJax, and
+the third turns the internal format into MathML within the page so
+that it can be displayed by the browser's native MathML support.
+
+Because of MathJax's modular design, you do not need to use all three
+of these components.  For example, you could use the `tex2jax`
+preprocessor and the TeX input processor, but the NativeMML output
+processor, so that your mathematics is entered in TeX format, but
+displayed as MathML.  Or you could use the `mml2jax` reprocessor and
+MathML input processor with the HTML-CSS output processor to make
+MathML available in browsers that don't have native MathML support.
+It is also possible to have MathJax select the output processor for
+you so that MathML is used in those browsers that support it, while
+HTML-CSS is used for those that don't.  See the :ref:`common
+configurations <common-configurations>` section for details and
+examples.
+
+Of course it is also possible to use all three components together.
+It may seem strange to go through an internal format just to return to
+MathML in the end, but this is actually what makes it possible to view
+MathML within an HTML page (rather than an XHTML page), without
+the complications of handling special MIME-types for the document, or
+any of the other setup issues that make using native MathML
+difficult.  MathJax handles the setup and properly marks the
+mathematics so that the browser will render it as MathML.  In
+addition, MathJax provides its contextual menu for the MathML, which
+lets the user zoom the mathematics for easier reading, get the copy
+the source markup, and so on, so there is added value to using MathJax
+even whith a pure MathML workflow.
+
+
+MathML in HTML pages
+====================
+
+For MathML that is handled via the pre-processor, you should not use
+the named MathML entities, but rather use the numeric entities like
+``&#x221A;`` or unicode characters embedded in the page itself.  The
+reason is that entities are replaced by the browser before MathJax
+runs, and some browsers report errors for unknown entities.  For
+browsers that are not MathML-aware, that will cause errors to be
+displayed for the MathML entities.  While that might not occur in the
+browser you are using to compose your pages, it can happen with other
+browsers, so you should avoid the named entities whenever possible.
+If you must use named entities, you may need to declare them in the
+`DOCTYPE` declaration by hand.
+
+When you use MathML in an HTML document rather than an XHTML one
+(MathJax will work woth both), you should not use the "self-closing"
+form for tags with no content, but should use separate open and close
+tags.  That is, use
+
+.. code-block:: html
+
+    <mspace width="thinmathspace"></mspace>
+
+rather than ``<mspace width="thinmathspace />``.  This is because HTML
+does not have self-closing tags, and some browsers will get the
+nesting of tags wrong if you attempt to use them.  For example, with
+``<mspace width="1em" />``, since there is no closing tag, the rest of
+the mathematics will become the content of the ``<mspace>`` tag; but
+since ``<mspace>`` should have no content, the rest of the mathematics
+will not be displayed.  This is a common error that should be avoided.
+
+
+Supported MathML commands
+=========================
+
+MathJax supports the `MathML3.0 <http://www.w3.org/TR/MathML3/>`_
+presentation mathematics tags, with some limitations.  The MathML
+support is still under active development, so some tags are not yet
+implemented, and some features are not fully developed, but are
+coming.
+
+The deficiencies include:
+
+- No support for the elementary math tags: ``mstack``, ``mlongdiv``,
+  ``msgroup``, ``msrow``, ``mscarries``, and ``mscarry``.
+
+- Limited support for line breaking (they are only allowed in direct
+  children of ``mrow`` or implied ``mrow`` elements.
+
+- No support for alignment groups in table.
+
+- No support for right-to-left rendering.
+
+See the `results of the MathML3.0 test suite
+<http://www.w3.org/Math/testsuite/results/tests.html>`_ for details.