LaTex Plugin
This page demonstrates the LaTeX Plugin syntax and parameters used in Codebeamer.
 |
Since Codebeamer release 20.11-LTS.
|
Supported LaTeX Commands
The plugin renders the LaTeX commands with MathJax 2.7.7.For the supported LaTeX commands, see https://docs.mathjax.org/en/v2.7-latest/tex.html#supported-latex-commands
.
.LaTeX Plugin Syntax
Inline and display math modes can be used, and both support LaTeX commands:
[{Latex title='some text' width='500'
The well known Pythagorean theorem \(x^2 + y^2 = z^2\) was
proved to be invalid for other exponents.
Meaning the next equation has no integer solutions:
\[ x^n + y^n = z^n \]
}]
The well known Pythagorean theorem \(x^2 + y^2 = z^2\) was
proved to be invalid for other exponents.
Meaning the next equation has no integer solutions:
\[ x^n + y^n = z^n \]
}]
Document commands are not processed but accepted for backwards compatibility. Only the in-between text \begin{document} ... \end{document}}} is processed.
[{Latex title='some text' width='500'
\documentclass{article}
\pagestyle{empty}
\begin{document}
The well known Pythagorean theorem \(x^2 + y^2 = z^2\) was
proved to be invalid for other exponents.
Meaning the next equation has no integer solutions:
\[ x^n + y^n = z^n \]
\end{document}
}]
\documentclass{article}
\pagestyle{empty}
\begin{document}
The well known Pythagorean theorem \(x^2 + y^2 = z^2\) was
proved to be invalid for other exponents.
Meaning the next equation has no integer solutions:
\[ x^n + y^n = z^n \]
\end{document}
}]
LaTeX Plugin Parameters
Parameters:
• width='400' - The width is dynamic below 400 px, however, it can be exceeded to get wider images
• title='optional tooltip for the rendered image' - Title of the rendered image
• cache='false' - True or false parameter to turn cache on or off. The default value is true
• id='artifact Id which contains the formula or LaTeX text' - Documents can be linked with ids from the Documents page of the relevant project
• src='source URL or attachment name' - Alternative location of the LaTeX text or formula
• text='alternatively you can put the text here'. - Not recommended; exists only for backwards compatibility
| | Since Codebeamer release 20.11-SP2. The font size for the LaTeX plugin can be modified globally in the [Application configuration]. "latexPlugin" : { "defaultFontSizePx" : 24 } • The default, as well as the minimum, value for defaultFontSizePx is 12. Individual font size settings on the plugin markup level override the global setting, therefore, the size can be less than 12 px. |
Loading Text from a File
Files in .txt format can be uploaded to the Documents page of the relevant project and linked with their ids to the LaTeX plugin.
[{Latex id='12345'
}]
}]