AsciiMath
Add On Name | Asciimath for Confluence |
---|---|
Compatibility | Confluence 4.3.x - 5.x |
Issues | |
Marketplace | https://marketplace.atlassian.com/plugins/ed.ac.uk.math.asciimath |
License | Commercial (but currently free to use) |
Source | not available |
This page describes how to use the \{math\} wiki markup to put mathematics on the page. \{math\} uses something called ASCIIMath to do the actual displaying of the mathematics (a client side javascript library, tested with IE6/IE7/FF3). In this guide, examples, display options, a comprehensive list of symbols and some troubleshooting tips are given.
Examples
DisplayOptions
Symbols
Troubleshooting
VersionHistory
Whenever entering maths markup in a page you are editing, you have to enter the maths environment . You do this in the same way you enter any environment - surround it with the name of the wiki markup. So enter \{math\} ... some mathematical equations ... \{math\}. There are two types of syntax you can use to type your mathematical expressions - a 'calculator-like' syntax allows you to specify things as you might on a calculator - e.g 'x/(y+1)' or 'x^4+y^5'. For those wishing more control, a TeX-like syntax can also be used. This means that you should be able to copy and past equations from LaTeX examples should you have the .tex file. You can mix and match the calculator-like and TeX-like syntaxes.
You can also find guides at:
Alternatively, search google for ASCIIMath (possibly with the word tutorial) and see what comes up.
The Math (ASCIIMath) Plugin is compatible with Confluence v2.8+. An option is available for older installations of Confluence: ASCIIMath plugin for older versions of Confluence.
Examples
Instead of giving a large tutorial, lots of examples are given. Sometimes, certain points are made clear but hopefully you should get the gist of how ASCIIMath works just by seeing it in action (see image top right). Note that it is necessary to show the examples as images instead of actual MathML renderings because the ASCIIMath plugin itself is not installed on this particular instance of Confluence. The images used are real screen captures from Firefox 3.0x using Confluence with ASCIIMath installed.
Normally when you use \{math\} markup the mathematical expressions inside will be displayed inline - that is it will be merged in with the surrounding paragraph text. You can put \{math\} in lists, in tables, in headings, can color them, etc - just as you'd expect. Sometimes you may wish to emphasize a particular piece of mathematics and/or label it so you can refer back to it.
Example text | Renders as |
---|---|
sum_(k=1)^n k = 1+2+ cdots +n=(n(n+1))/2 |
{include:ASCIIMath Display Options}
Here are all the symbols you can use and their markup. It should be pointed out that they are pretty much identical to the LaTeX markup except that latex markup are always preceeded with a \ (backslash).
Troubleshooting
This section may be useful if you are having problems authoring or displaying the mathematics.
{include:ASCIIMath Troubleshooting}
Version History
1.3 Compatibility with 4.3.x / 5.x
1.2.1 Includes a range of anti XSS measures by default, that can be disabled via plugin config page.
1.1.2 Enables administrators to configure 'download' text message, as well as improving ability to block IE6 from using external CGI, if configured to do so
1.1.1 Enables administrators to configure whether IE users should be allowed to fall-back to externally hosted CGI rendering of Math Markup, or be prompted for the installation of the Math Player plugin CASCII-1
1.1.0 Plugin released in repository, automatic download of dependant .css and .js files
EULA
This software is licensed under the provisions of the Standard EULA from the Atlassian Marketplace Terms of Use as a Marketplace Product.
The "Standard EULA" is reproduced here for convenience. In this case, the "Publisher" is The Plugin People Ltd:
(i) The Publisher is the licensor of the Marketplace Product and Atlassian is not a party to the Publisher EULA or this Standard EULA, as applicable.
(ii) If the Marketplace Product does not include a Publisher EULA that specifies Marketplace Product license rights, Publisher grants you a limited, worldwide, non-exclusive, non-transferable and non-sublicensable license to download and use the Marketplace Product only on hardware systems owned, leased or controlled by you.
(iii) Licenses granted by Publisher are granted subject to the condition that you must ensure the maximum number of Authorized Users that are able to access and use the Marketplace Product concurrently is equal to the number of User Licenses for which the necessary fees have been paid to Atlassian and/or its authorized partners (each, an "Atlassian Expert"). You may purchase additional User Licenses at any time on payment of the appropriate fees to Atlassian or an Atlassian Expert. "User License" means a license granted under this EULA to you to permit an Authorized User to use the Marketplace Product. The number of User Licenses granted to you is dependent on the fees paid by you. "Authorized User" means a person who accesses and uses a Marketplace Product under the EULA and for which the necessary fees have been paid to Atlassian and/or an Atlassian Expert.
(iv) Any information that Publisher collects from you or your device will be subject to any Publisher EULA, privacy notice, or similar terms that the Publisher provides to you, and will not be subject to the Atlassian Privacy Policy (unless Atlassian is the Publisher).
(v) You may not modify, reverse engineer, decompile or disassemble the Marketplace Product in whole or in part, or create any derivative works from or sublicense any rights in the Marketplace Product, unless otherwise expressly authorized in writing by Publisher.
(vi) The Marketplace Product is protected by copyright and other intellectual property laws and treaties. Unless otherwise expressly stated in the Publisher EULA, Publisher or its licensors own all title, copyright and other intellectual property rights in the Marketplace Product, and the Marketplace Product is licensed to you directly by the Publisher, not sold.
Additional Terms
This product is covered by the General Software Product EULA.