This version of the documentation was built November 02, 2010.
+This version of the documentation was built December 31, 2010.
@@ -166,7 +166,7 @@ MathML that works in all modern browsers.The easiest way to get MathJax and keep it up to date is to use the Git version control system to access our GitHub repository. Use the commands
git clone git://github.com/mathjax/MathJax.git mathjax
-cd mathjax
-unzip fonts.zip
to obtain and set up a copy of MathJax.
+to obtain and set up a copy of MathJax. Note that there is no longer +a fonts.zip file, and that the fonts directory is now part of +the repository itself.
Whenever you want to update MathJax, you can now use
cd mathjax
-git status
+git remote show origin
to check if there are updates to MathJax. If MathJax needs updating, use
+to check if there are updates to MathJax (this will print several +lines of data, but the last line should tell you if your copy is up to +date or out of date). If MathJax needs updating, use
cd mathjax
git pull origin
-# 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.
+to udpate your copy of MathJax to the current release version. 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 git tag -l to see all versions and use git -checkout <tag_name> to checkout that version of MathJax. When you want to -upgrade to a new release, you will need to repeat this for the latest release -tag.
+“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 git tag +-l to see all versions and use git checkout <tag_name> to +checkout that version of MathJax. When you want to upgrade to a new +release, you will need to repeat this for the latest release tag.If you are more comfortable with the subversion source control system, you may want to use -our svn mirror. If you want to get the latest svn revision, use the commands
-svn co http://mathjax.svn.sourceforge.net/svnroot/mathjax/trunk/mathjax mathjax
-cd mathjax
-unzip fonts.zip
+If you are more comfortable with the subversion source control system, you may want
+to use GitHub’s svn service to obtain MathJax. If you want to get the
+latest revision using svn, use the commands
+svn checkout http://svn.github.com/mathjax/MathJax.git mathjax
-to obtain and set up a copy of MathJax. (The SourceForge development
-page also shows
-how to do this.)
+to obtain and set up a copy of MathJax. Note that there is no longer
+a fonts.zip file, and that the fonts directory is now part of
+the repository itself.
Whenever you want to update MathJax, you can now use
cd mathjax
-svn status
+svn status -u
to check if there are updates to MathJax. If MathJax needs updating,
use
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.
+to udpate your copy of MathJax to the current release version. 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
-svn co http://mathjax.svn.sourceforge.net/svnroot/mathjax/tags/mathjax-1.0.1 mathajx
-cd mathjax
-unzip fonts.zip
+“release” version. If you prefer to use one of the tagged releases
+instead, then either use git as described above, or one of the
+archive files as described below. You can use
+svn checkout http://svn.github.com/mathjax/MathJax.git@nnn mathjax
-to obtain the version 1.0.1 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.
+to check out revision number nnn, but it is not easy to tell what
+svn revision number is associated with a particular release. GitHub’s
+svn service doesn’t appear to allow you to sepecify a particular
+tagged version.
Obtaining MathJax via an archiveΒΆ
Release versions of MathJax are available in archive files from the
MathJax download page or the
-GitHub downloads (click the big download
-button on the right), where you can download the archives that you need.
-You should download the MathJax-v1.0.1.zip file, then simply unzip
-it. Once the MathJax directory is unpacked, you should move it to the
+GitHub downloads (click the
+big download button on the right), where you can download the archive
+that you need.
+You should download the v1.1 archive (which will get you a file with a
+name like mathjax-MathJax-v1.1-X-XXXXXXXX.zip, where the X’s are
+some sequence of random-looking letters and numbers), 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.
+From the MathJax GitHub download link (the big download button at the
+right), you can also select the Download .tar.gz or Download
+.zip buttons to get a copy of the current “bleeding-edge” version of
+MathJax that contains all the latest changes and bug-fixes.
Testing your installationΒΆ
@@ -286,7 +283,7 @@ for more details.
previous |
- MathJax v1.0 documentation »
+ MathJax v1.1 documentation »
@@ -117,7 +117,7 @@ configuration options section.
previous |
- MathJax v1.0 documentation »
+ MathJax v1.1 documentation »
@@ -126,7 +126,7 @@ mathematics on your web pages interactive and dynamic.
The easiest way to set up MathJax is to obtain the -MathJax-v1.0.1.zip archive from the MathJax download page. This includes both the MathJax code -and the MathJax webfonts, so this is the only file you need. (This is -different from the beta releases, which had the fonts separate from -the rest of the code).
-Unpack the MathJax-v1.0.1.zip archive and place the -resulting MathJax folder onto your web server at a convenient -location where you can include it into your web pages. For example, -making MathJax a top-level directory on your server would be -one natural way to do this. That would let you refer to the main -MathJax file via the URL /MathJax/MathJax.js from within any page -on your server.
-Note: While this is the easiest way to set up MathJax initially, there is a -better way to do it if you want to be able to keep your copy of MathJax -up-to-date easily. That uses the Git version control -system, and is described in the Installing MathJax -document. If you prefer using Subversion, we -also maintain an SVN mirror (see Installing MathJax via SVN).
+The easiest way to set up MathJax is to obtain the v1.1 archive from +the MathJax download page (you +should obtain a file names something like +mathjax-MathJax-v1.0-X-XXXXXXXX.zip, where the X’s are +random-looking letters and numbers). This archive includes both the +MathJax code and the MathJax webfonts, so it is the only file you +need. (This is different from the beta releases, which had the fonts +separate from the rest of the code).
+Unpack the archive and place the resulting MathJax folder onto your +web server at a convenient location where you can include it into your +web pages. For example, making MathJax a top-level directory on +your server would be one natural way to do this. That would let you +refer to the main MathJax file via the URL /MathJax/MathJax.js +from within any page on your server.
+Note: While this is the easiest way to set up MathJax initially, there +is a better way to do it if you want to be able to keep your copy of +MathJax up-to-date easily. That uses the Git +version control system, and is described in the Installing +MathJax document. If you prefer using +Subversion, you can also use that +to get a copy of MathJax (see Installing MathJax via SVN).
Once you have MathJax set up on your server, you can test it using the files in the MathJax/test directory. Load them in your browser using its web address rather than opening them locally (i.e., use an @@ -365,7 +368,7 @@ MathJax, you could visit the previous | -