RubyGems - gollum - Versions diffs - 1.1.1 → 1.2.0 - Mend

gollum 1.1.1 → 1.2.0

Potentially problematic release.

This version of gollum might be problematic. Click here for more details.

Files changed (765) hide show

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

@@ -0,0 +1,60 @@
+*********************
+The MathJax Community
+*********************
+If you are an active MathJax user, you may wish to become involved in
+the wider community of MathJax users.  The MathJax project maintains
+forums where users can ask questions about how to use MathJax, make
+suggestions about future features for MathJax, and present their own
+solutions to problems that they have faced.  There is also a
+bug-traking system where you can report errors that you have found
+with MathJax in your environment.
+.. _community-forums:
+Forums
+======
+If you want to discuss MathJax development, or if you need help, or if
+you have solutions you want to share, our `forums at SourceForge
+<http://sourceforge.net/projects/mathjax/forums>`_ give you that
+opportunity.  We try hard to answer questions quickly, and users can
+help with that as well.  Also, users can post code snippets showing
+how they have used MathJax, so it may be a good place to find the
+examples you are looking for.
+The community is only as good as the users who participate, so if
+you have something to offer, please take time to make a post on one of
+our forums.
+.. _community-tracker:
+Issue tracking
+==============
+Have you found a bug or want to suggest an improvement?  Post it to
+our `bug tracker
+<http://sourceforge.net/tracker/?group_id=261188&atid=1240827>`_.  We
+monitor the bug tracker closely, and work hard to respond to problems
+quickly.
+Before you create a new ticket, however, please `search the forums
+<http://sourceforge.net/search/?group_id=261188&type_of_search=forums>`_
+and `existing tickets
+<http://sourceforge.net/search/?group_id=261188&type_of_search=artifact>`_
+first to see if it has already been reported.
+You could also be using an outdated version of MathJax, so be sure to
+:ref:`upgrade your copy <getting-mathjax-svn>` to verify that the
+problem persists in the lastest version.
+.. _badge:
+"Powered by MathJax"
+====================
+If you are using MathJax and want to show your support, please
+consider using our `"Powered by MathJax" badge
+<http://www.mathjax.org/community/mathjax-badge>`_.

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

@@ -0,0 +1,375 @@
+.. _loading:
+*******************************
+Loading and Configuring MathJax
+*******************************
+You load MathJax into a web page by including its main JavaScript file
+into the page.  That is done via a ``<script>`` tag that links to the
+``MathJax.js`` file.  Place the following line in the ``<head>``
+section of your document:
+.. code-block:: html
+    <script type="text/javascript" src="path-to-MathJax/MathJax.js"></script>
+where ``path-to-MathJax`` is replaced by the URL of the MathJax
+directory on your server, or (if you are using MathJax locally rather
+than through a server) the location of that directory on your hard
+disk.  For example, if the MathJax directory is at the top level of
+your web server's directory hierarchy, you might use
+.. code-block:: html
+    <script type="text/javascript" src="/MathJax/MathJax.js"></script>
+to load MathJax.
+Although it is possible to load MathJax from a site other than your
+own web server, there are issues involved in doing so that you need to
+take into consideration.  See the :ref:`Notes About Shared Servers
+<cross-domain-linking>` for more details.  Please do **not** link to
+the copy of MathJax at ``www.mathjax.org``, as we do not have the
+resources to act as a web service for all the sites on the web that
+would like to display mathematics.  If you are able to run MathJax
+from your own server, please do so (this will probably give you better
+response time in any case).
+It is best to load MathJax in the document's ``<head>`` block, but it
+is also possible to load MathJax into the ``<body>`` section, if
+needed.  If you do this, load it as early as possible, as
+MathJax will begin to load its components as soon as it is included in
+the page, and that will help speed up the processing of the
+mathematics on your page.  MathJax does expect there to be a
+``<head>`` section to the document, however, so be sure there is one
+if you are loading MathJax in the ``<body>``.
+It is also possible to load MathJax dynamically after the page has
+been prepared, for example, via a `GreaseMonkey
+<http://www.greasespot.net/>`_ script, or using a specially prepared
+`bookmarklet <http://en.wikipedia.org/wiki/Bookmarklet>`_.  This is an
+advanced topic, however; see :ref:`Loading MathJax Dynamically
+<ajax-mathjax>` for more details.
+Configuring MathJax
+===================
+There are several ways to configure MathJax, but the easiest is to use
+the ``config/MathJax.js`` file that comes with MathJax.  See the
+comments in that file, or the :ref:`configuration details
+<configuration>` section, for explanations of the meanings of the various
+configuration options.  You can edit the ``config/MathJax.js`` file to
+change any of the settings that you want to customize.  When you
+include MathJax in your page via
+.. code-block:: html
+    <script type="text/javascript" src="path-to-MathJax/MathJax.js"></script>
+it will load ``config/MathJax.js`` automatically as one of its
+first actions.
+Alternatively, you can configure MathJax efficiently by calling
+:meth:`MathJax.Hub.Config()` when you include MathJax in your page, as
+follows:
+.. code-block:: html
+    <script type="text/javascript" src="path-to-MathJax/MathJax.js">
+        MathJax.Hub.Config({
+            extensions: ["tex2jax.js"],
+            jax: ["input/TeX", "output/HTML-CSS"],
+            tex2jax: {
+                inlineMath: [ ['$','$'], ["\\(","\\)"] ],
+                displayMath: [ ['$$','$$'], ["\\[","\\]"] ],
+            },
+            "HTML-CSS": { availableFonts: ["TeX"] }
+        });
+    </script>
+This example includes the ``tex2jax`` preprocessor and configures it
+to use both the standard TeX and LaTeX math delimiters.  It uses the
+TeX input processor and the HTML-CSS output processor, and forces the
+HTML-CSS processor to use the TeX fonts rather that other locally
+installed fonts (e.g., :term:`STIX` fonts).  See the
+:ref:`configuration options <configuration>` section (or the comments
+in the ``config/MathJax.js`` file) for more information about the
+configuration options that you can include in the
+:meth:`MathJax.Hub.Config()` call.  Note that if you configure MathJax
+using this in-line approach, the ``config/MathJax.js`` file is **not**
+loaded.
+Finally, if you would like to use several different configuration
+files (like ``config/MathJax.js``, but with different settings in each
+one), you can copy ``config/MathJax.js`` to ``config/MathJax-2.js``,
+or some other convenient name, and use
+.. code-block:: html
+    <script type="text/javascript" src="path-to-MathJax/MathJax.js">
+        MathJax.Hub.Config({ config: "MathJax-2.js" });
+    </script>
+to load the alternative configuration file ``config/MathJax-2.js``
+from the MathJax ``config`` directory.  In this way, you can have as
+many distinct configuration files as you need.
+.. _common-configurations:
+Common Configurations
+=====================
+The following examples show configurations that are useful for some
+common situations.  This is certainly not an exhaustive list, and
+there are variations possible for any of them.  Again, the comments in
+the ``config/MathJax.js`` file can help you decide what settings to
+include, even if you are using the in-line configuration method.
+The TeX setup
+-------------
+This example calls the ``tex2jax`` preprocessor to identify
+mathematics in the page by looking for TeX and LaTeX math delimiters.
+It uses ``$...$`` and ``\(...\)`` for in-line mathematics, while
+``$$...$$`` and ``\[...\]`` mark displayed equations.  Because dollar
+signs are used to mark mathematics, if you want to produce an actual
+dollar sign in your document, you must "escape" it using a slash:
+``\$``.  This configuration also loads the ``AMSmath`` and
+``AMSsymbols`` extensions so that the macros and environments they
+provide are defined for use on the page.
+.. code-block:: javascript
+    MathJax.Hub.config({
+        extensions: ["tex2jax.js","TeX/AMSmath.js","TeX/AMSsymbols.js"],
+        jax: ["input/TeX","output/HTML-CSS"],
+        tex2jax: {
+            inlineMath: [['$','$'],["\\(","\\)"]],
+            processEscapes: true,
+        },
+    });
+Other extensions that you may consider adding to the `extensions`
+array include:  ``TeX/noErrors.js``, which shows the original TeX code
+if an error occurs while processing the mathematics (rather than an
+error message), ``TeX/noUndefined.js``, which shows undefined
+macros names in red (rather than producing an error), and
+``TeX/autobold.js``, which automatically inserts ``\boldsymbol{...}``
+around your mathematics when it appears in a section of your page that
+is in bold.  Most of the other TeX extensions are loaded automatically
+when needed, and so do not need to be included explicitly in your
+`extensions` array.
+See the :ref:`tex2jax configuration <configure-tex2jax>` section for
+other configuration options for the ``tex2jax`` preprocessor, and the
+:ref:`TeX input jax configuration <configure-TeX>` section for options
+that control the TeX input processor.
+The MathML setup
+----------------
+This example calls the ``mml2jax`` preprocessor to identify
+mathematics in the page that is in :term:`MathML` format, which uses
+``<math display="block">`` to indicate displayed equations, and
+``<math display="inline">`` or simply ``<math>`` to mark in-line
+formulas.
+.. code-block:: javascript
+    MathJax.Hub.config({
+        extensions: ["mml2jax.js"],
+        jax: ["input/MathML","output/HTML-CSS"]
+    });
+Note that this will work in HTML files, not just XHTML files (MathJax
+works with both), and that the web page need not be served with any
+special MIME-type.  Also note that, unless you are using XHTML rather
+than HTML, you should not include a namespace prefix for your
+``<math>`` tags; for example, you should not use ``<m:math>`` except
+in a file where you have tied the ``m`` namespace to the MathML DTD.
+See the :ref:`mml2jax configuration <configure-mml2jax>` section for
+other configuration options for the ``mml2jax`` preprocessor, and the
+:ref:`MathML input jax configuration <configure-MathML>` section for
+options that control the MathML input processor.
+Both TeX and MathML
+-------------------
+This example provides for both TeX and MathML input in the same file.
+It calls on both the ``tex2jax`` and ``mml2jax`` preprocessors and the
+TeX and MathML input jax to do the job.
+.. code-block:: javascript
+    MathJax.Hub.config({
+        extensions: ["tex2jax.js", "mml2jax.js"],
+        jax: ["input/TeX", "input/MathML", "output/HTML-CSS"],
+    });
+Notice that no ``tex2jax`` configuration section is included, so it
+uses its default options (no single dollar signs for in-line math).
+The majority of the code for the TeX and MathML input processors are
+not loaded until they are actually needed by the mathematics on the
+page, so if this configuration is used on a page that include only
+MathML, the TeX input processor will not be loaded.  Thus it is
+reasonably efficient to specify both input processors even if only one
+(or neither one) is used.
+TeX input with MathML output
+----------------------------
+This example configures MathJax to use the ``tex2jax`` preprocessor
+and TeX input processor, but the choice of output format is determined
+by MathJax depending on the capabilities of the users's browser.  The
+is performed by the ``MMLorHTML.js`` configuration file that is loaded
+in the `config`` array.
+.. code-block:: javascript
+    MathJax.Hub.Config({
+        config: ["MMLorHTML.js"],
+        extensions: ["tex2jax.js"],
+        jax: ["input/TeX"]
+    });
+With this setup, Firefox or Internet Explorer with the `MathPlayer
+plugin <http://www.dessci.com/en/products/mathplayer/>`_ installed
+will use the NativeMML output processor, while all other browsers will
+use the HTML-CSS output processor.  Since native MathML support is
+faster than MathJax's HTML-CSS processor, this will mean that the web
+pages will display faster for Firefox and IE than they woudl
+otherwise.  This speed comes at the cost, however, as you are now
+relying on the native MathML support to render the mathematics, and
+that is outside of MathJax's control.  There may be spacing or other
+display differences (compared to MathJax's HTML-CSS output) when the
+NativeMML output processor is used.
+See :ref:`MathJax Output Formats <output-formats>` for more
+information on the NativeMML and HTML-CSS output processors.  See the
+:ref:`MMLorHTML configuration <configure-MMLorHTML>` section for
+details on the options that control the ``MMLorHTML`` configuration.
+MathML input and output in all browsers
+---------------------------------------
+This example configures MathJax to look for MathML within your page,
+and to display it using the browser's native MathML support, if
+possible, or its HTML-CSS output if not.
+.. code-block:: javascript
+    MathJax.Hub.Config({
+        config: ["MMLorHTML.js"],
+        extensions: ["mml2jax.js"],
+        jax: ["input/MathML"]
+    });
+Using this configuration, MathJax finally makes MathML available in
+all modern browsers.
+See the :ref:`MMLorHTML configuration <configure-MMLorHTML>` section
+for details on the options that control the ``MMLorHTML``
+configuration file, the :ref:`MathML configuration <configure-MathML>`
+section for the options that control the MathML output processor, and
+the :ref:`mml2jax configuration <configure-mml2jax>` section for the
+options that control the ``mml2jax`` preprocessor.
+.. _configuration:
+Configuration Objects
+=====================
+The various components of MathJax, including its input and output
+processors, its preprocessors, its extensions, and the MathJax core,
+all can be configured through the ``config/MathJax.js`` file, or via a
+:meth:`MathJax.Hub.Config()` call (indeed, if you look closely, you
+will see that ``config/MathJax.js`` is itself one big call to
+:meth:`MathJax.Hub.Config()`).  Anything that is in
+``config/MathJax.js`` can be included in-line to configure MathJax.
+The structure that you pass to :meth:`MathJax.Hub.Config()` is a
+JavaScript object that includes name-value pairs giving the names of
+parameters and their values, with pairs separated by commas.  Be
+careful not to include a comma after the last value, however, as some
+browsers (namely Internet Explorer) will fail to process the
+configuration if you do.
+The MathJax components, like the TeX input processor, have their own
+sections in the configuration object, labeled by the component name,
+and using an configuration object as its value.  The object is itself
+a configuration object made up of name-value pairs that give the
+configuration options for the component.
+For example,
+.. code-block:: javascript
+    MathJax.Hub.Config({
+      showProcessingMessages: false,
+      jax: ["input/TeX", "output/HTML-CSS"],
+      TeX: {
+        TagSide: "left",
+        Macros: {
+	  RR: '{\\bf R}',
+	  bold: ['{\\bf #1}',1]
+	}
+      }
+    });
+is a configration that includes two settings for the MathJax Hub (one
+for `showProcessingMessages` and one of the `jax` array), and a
+configuration object for the TeX input processor.  The latter includes
+a setting for the TeX input processor's `TagSide` option (to set tags
+on the left rather than the right) and a setting for `Macros`, which
+defines new TeX macros (in this case, two macros, one called ``\RR``
+that produces a bold "R", and one called ``\bold`` that puts is
+argument in bold face).
+The ``config/MathJax.js`` file is another example that shows nearly
+all the configuration options for all of MathJax's components.
+Configuration Options by Component
+==================================
+The individual options are explained in the following sections, which
+are categorized by the component they affect.
+.. toctree::
+    :maxdepth: 1
+    The core options <options/hub>
+.. toctree::
+    :maxdepth: 1
+    The tex2jax preprocessor options <options/tex2jax>
+    The mml2jax preprocessor options <options/mml2jax>
+    The jsMath2jax preprocessor options <options/jsMath2jax>
+.. toctree::
+    :maxdepth: 1
+    The TeX input processor options <options/TeX>
+    The MathML input processor options <options/MathML>
+    The HTML-CSS output processor options <options/HTML-CSS>
+    The NativeMML output processor options <options/NativeMML>
+    The MMLorHTML configuration options <options/MMLorHTML>
+.. toctree::
+    :maxdepth: 1
+    The MathMenu options <options/MathMenu>
+    The MathZoom options <options/MathZoom>
+    The FontWarnings options <options/FontWarnings>

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

@@ -0,0 +1,181 @@
+.. _ajax-mathjax:
+***************************
+Loading MathJax Dynamically
+***************************
+MathJax is designed to be included via a ``<script>`` tag in the
+``<head>`` section of your HTML document, and it does rely on being
+part of the original document in that it uses an ``onload`` event
+handler to synchronize its actions with the loading of the page.
+If you wish to insert MathJax into a document after it has
+been loaded, that will normally occur *after* the page's ``onload``
+handler has fired, and so MathJax will not be able to tell if it is
+safe for it to process the contents of the page.  Indeed, it will wait
+forever for its ``onload`` handler to fire, and so will never process
+the page.
+To solve this problem, you will need to call MathJax's ``onload``
+handler yourself, to let it know that it is OK to typeset the
+mathematics on the page.  You accomplish this by calling the
+:meth:`MathJax.Hub.Startup.onload()` method as part of your MathJax
+startup script.  To do this, you will need to give MathJax an in-line
+configuration, so you will not be able to use the
+``config/MathJax.js`` file (though you can add it to your in-line
+configuration's `config` array).
+Here is an example of how to load and configure MathJax dynamically:
+.. code-block:: javascript
+    (function () {
+      var script = document.createElement("script");
+      script.type = "text/javascript";
+      script.src = "/MathJax/MathJax.js";   // use the location of your MathJax
+      var config = 'MathJax.Hub.Config({' +
+                     'extensions: ["tex2jax.js"],' +
+                     'jax: ["input/TeX","output/HTML-CSS"]' +
+                   '});' +
+                   'MathJax.Hub.Startup.onload();';
+      if (window.opera) {script.innerHTML = config}
+                   else {script.text = config}
+      document.getElementsByTagName("head")[0].appendChild(script);
+    })();
+Be sure to set the ``src`` to the correct URL for your copy of
+MathJax.  You can adjust the ``config`` variable to your needs, but be
+careful to get the commas right.  The ``window.opera`` test is because
+Opera doesn't handle setting ``script.text`` properly, while Internet
+Explorer doesn't handle setting the ``innerHTML`` of a script tag.
+Here is a version that uses the ``config/MathJax.js`` file to
+configure MathJax:
+.. code-block:: javascript
+    (function () {
+      var script = document.createElement("script");
+      script.type = "text/javascript";
+      script.src = "/MathJax/MathJax.js";   // use the location of your MathJax
+      var config = 'MathJax.Hub.Config({ config: "MathJax.js" }); ' +
+                   'MathJax.Hub.Startup.onload();';
+      if (window.opera) {script.innerHTML = config}
+                   else {script.text = config}
+      document.getElementsByTagName("head")[0].appendChild(script);
+    })();
+Note that the **only** reliable way to configure MathJax is to use an
+in-line configuration of the type discussed above.  You should **not**
+call :meth:`MathJax.Hub.Config()` directly in your code, as it will
+not run at the correct time --- it will either run too soon, in which
+case ``MathJax`` may not be defined and the function will throw an
+error, or it will run too late, after MathJax has already finished its
+configuration process, so your changes will not have the desired
+effect.
+MathJax and GreaseMonkey
+========================
+You can use techniques like the ones discussed above to good effect in
+GreaseMonkey scripts.  There are GreaseMonkey work-alikes for all the
+major browsers:
+- Firefox: `GreaseMonkey <http://addons.mozilla.org/firefox/addon/748>`_
+- Safari: `GreaseKit <http://8-p.info/greasekit/>`_ (also requires `SIMBL <http://www.culater.net/software/SIMBL/SIMBL.php>`_)
+- Opera: Built-in (`instructions <http://www.ghacks.net/2008/08/10/greasemonkey-in-opera/>`_)
+- Internet Explorer: `IEPro7 <http://www.ie7pro.com/>`_
+- Chrome: Built-in for recent releases
+Note, however, that most browsers don't allow you to insert a script
+that loads a ``file://`` URL into a page that comes from the web (for
+security reasons).  That means that you can't have your GreaseMonkey
+script load a local copy of MathJax, so you have to refer to a
+server-based copy.  In the scripts below, you need to insert the URL
+of a copy of MathJax from your own server.
+----
+Here is a script that runs MathJax in any document that contains
+MathML (whether its includes MathJax or not).  That allows
+browsers that don't have native MathML support to view any web pages
+with MathML, even if they say it only works in Forefox and
+IE+MathPlayer.
+.. code-block:: javascript
+    // ==UserScript==
+    // @name           MathJax MathML
+    // @namespace      http://www.mathjax.org/
+    // @description    Insert MathJax into pages containing MathML
+    // @include        *
+    // ==/UserScript==
+    if ((window.unsafeWindow == null ? window : unsafeWindow).MathJax == null) {
+      if ((document.getElementsByTagName("math").length > 0) ||
+          (document.getElementsByTagNameNS == null ? false :
+          (document.getElementsByTagNameNS("http://www.w3.org/1998/Math/MathML","math").length > 0))) {
+        var script = document.createElement("script");
+        script.src = "http://www.yoursite.edu/MathJax/MathJax.js";  // put your URL here
+        var config = 'MathJax.Hub.Config({' +
+                       'extensions:["mml2jax.js"],' +
+                       'jax:["input/MathML","output/HTML-CSS"]' +
+                     '});' +
+                     'MathJax.Hub.Startup.onload()';
+        if (window.opera) {script.innerHTML = config} else {script.text = config}
+        document.getElementsByTagName("head")[0].appendChild(script);
+      }
+    }
+**Source**: `mathjax_mathml.user.js <_statis/mathjax_mathml.user.js>`_
+----
+Here is a script that runs MathJax in Wikipedia pages after first
+converting the math images to their original TeX code.
+.. code-block:: javascript
+    // ==UserScript==
+    // @name           MathJax in Wikipedia
+    // @namespace      http://www.mathjax.org/
+    // @description    Insert MathJax into Wikipedia pages
+    // @include        http://en.wikipedia.org/wiki/*
+    // ==/UserScript==
+    if ((window.unsafeWindow == null ? window : unsafeWindow).MathJax == null) {
+      //
+      //  Replace the images with MathJax scripts of type math/tex
+      //
+      var images = document.getElementsByTagName('img');
+      for (var i = images.length - 1; i >= 0; i--) {
+        var img = images[i];
+        if (img.className === "tex") {
+          var script = document.createElement("script"); script.type = "math/tex";
+          if (window.opera) {script.innerHTML = img.alt} else {script.text = img.alt}
+          img.parentNode.replaceChild(script,img);
+        }
+      }
+      //
+      //  Load MathJax and have it process the page
+      //
+      var script = document.createElement("script");
+      script.src = "http://www.yoursite.edu/MathJax/MathJax.js";  // put your URL here
+      var config = 'MathJax.Hub.Config({' +
+                     'config: ["MMLorHTML.js"],' +
+                     'extensions:["TeX/noErrors.js","TeX/noUndefined.js",' +
+                                 '"TeX/AMSmath.js","TeX/AMSsymbols.js"],' +
+                     'jax:["input/TeX"]' +
+                   '});' +
+                   'MathJax.Hub.Startup.onload()';
+      if (window.opera) {script.innerHTML = config} else {script.text = config}
+      document.getElementsByTagName("head")[0].appendChild(script);
+    }
+**Source**: `mathjax_wikipedia.user.js <_statis/mathjax_wikipedia.user.js>`_