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/rst/dynamic.rst 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>`_

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/glossary.rst ADDED

@@ -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/rst/images/mt_head.png ADDED

Binary file

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/images/mt_menu.png ADDED

Binary file

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/images/mt_templates.png ADDED

Binary file

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/images/wp_menu.png ADDED

Binary file

data/lib/gollum/frontend/public/javascript/MathJax/docs/rst/images/wp_templates.png ADDED

Binary file

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

@@ -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/rst/installation.rst ADDED

@@ -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.