| Info |
|---|
In order to make this add-on available for recent versions of Confluence, ownership has been taken on by ([~javahollic]) and my 1.3 branch has been published as v1.3. The reference to Stepstone remains to give kudos to the original authors. |
| Tip |
|---|
This plug-in can be installed and updated via Confluence's built-in Find new add-ons section under Confluence Administration, or via the LaTeX Plugin listing on the Atlassian Marketplace website. |
Description/Features
| Excerpt |
|---|
A plug-in for displaying LaTeX in Confluence. It requires TeX to be installed separately on the server to function. |
Prerequisites
- You must have a working version of TeX installed on your Confluence server
- The commands
latexanddvipngmust be reachable by the $PATH system environment variable.
...
Installation
Linux/Ubuntu
| No Format |
|---|
sudo apt-get install dvipng
sudo apt-get install texlive-latex-base
sudo apt-get install texlive-extra-utils
sudo apt-get install texlive-math-extra
sudo apt-get install mimetex |
...
| No Format |
|---|
latex simple.tex
dvipng simple.dvi |
...
Windows
Some Windows users have had difficulty getting dvipng to work. In response to this problem, James Matheson has graciously contributed a [mimetex-based version of the plug-in|LaTeX Plugin^mimetex-plugin.zip]. Thanks, James! Note that to use the mimetex version, you will need to ensure that you have a copy of mimetex.exe in the system path. You can find a copy of mimetex.exe in the Mimetex download package at http://www.forkosh.com/mimetex.exe/windows/mimetex.zip.
Installation
Once you've tested your TeX installation as above, follow these steps to install the LaTeX plug-in. (Note that CONFLUENCE_HOME_DIR should be replaced with the directory specified in your confluence-init.properties file).
...
- [LaTeX Plugin^latex.properties]
- [LaTeX Plugin^latexheader.tex]
- [LaTeX Plugin^latexfooter.tex]
...
Usage
| Note |
|---|
Do not use the 'Rich Text' editor to write LaTeX markup. The rich text editor escapes some of the LaTeX characters, generating unpredictable output. |
In your wiki mark-up, use the parameter-free macro to wrap your LaTeX code. For example, to generate the same equation you saw in the [LaTeX Plugin^simple.tex] test above, your wiki mark-up would look like:{latex}
| No Format |
|---|
{latex}
\( E=mc^{2} \)
{latex} |
...
Configuration
...
| Note |
|---|
Please do not specify an output file for the |
Common problems
...
| No Format |
|---|
Error formatting macro: latex: java.lang.NullPointerException
( E=mc^
Unknown macro: {2}
) |
Logging
To turn logging on, add the following text to CONFLUENCE_INSTALL_DIR/confluence/WEB-INF/classes/log4j.properties (replace CONFLUENCE_INSTALL_DIR with your actual installation directory):
| No Format |
|---|
####
# LaTeX debug messages
####
log4j.logger.com.stepstonetech.confluence.plugins.latex=DEBUG,confluencelog
log4j.additivity.com.stepstonetech.confluence.plugins.latex=false |
...
Compatibility
Please see the complete version history for a complete picture of compatibility with Confluence: https://marketplace.atlassian.com/plugins/com.tensixtwo.conf.latexmath/versions.
Tips & Tricks
...
Welcome
Latex is an app for Atlassian Confluence that allows to render and display complex mathematical notation in web browsers. Our native Latex add-on had only one availability to render the macro by using the TEX - typesetting system. Latex plugin is using native binaries hosted on your instance. It gives the output as a png image. Since the Latex 1.6.0 version, it has an additional feature which is calling MathJax, which is an open-source JavaScript display engine for LaTeX, MathML, and AsciiMath notation that works in all modern browsers.
About how-to configure Latex and MathaJax, please review the following pages:
| Tip |
|---|
This plug-in can be installed and updated via Confluence's built-in Find new add-ons section under Confluence Administration, or via the LaTeX Plugin listing on the Atlassian Marketplace website. |
| Info |
|---|
In order to make this add-on available for current versions of Confluence, ownership has been taken on by The Plugin People. The reference to Stepstone remains to give kudos to the original authors. |