Template:Tmath/doc
This is a documentation subpage for Template:Tmath. It may contain usage information, categories and other content that is not part of the original template page. |
This template wraps a math expression written in TeX code between <math>...</math>
tags using the {{#tag:}}
parser function magic word.
It further helps to avoid wrapping points at either end of expression that normally occurs with <math>...</math>
, so avoiding being split from punctuation as would be normal for text.
Neither display="inline"
nor TeX math mode \textstyle
is set by this template.
Usage
[edit]{{tmath|expression}}
Examples
[edit]{{tmath|a}}
gives {{tmath|\pi}}
gives {{tmath|x_0}}
gives
The template is intended to be used for short LaTeX mathematical expressions like variables, and is useful for limiting awkward wrapping points. It is more cumbersome to use for equations or other expressions containing special signs that must be escaped or replaced, like the equal sign =
with {{=}}
and the vertical pipe |
with \vert
, \mid
or {{!}}
, and \|
with \Vert
:
{{tmath|E {{=}} mc^2}}
gives {{tmath|x {{=}} {{!}} \vec x {{!}} }}
gives {{tmath|1= x = \Vert \vec x \Vert }}
gives
Use braces { and } with caution
[edit]Apart from using the {{(}}
and {{)}}
templates to get {
and }
, you may use the braces {
and }
as long as {
is not preceded or followed by another {
, and }
is not preceded or followed by another }
, e.g.
{{tmath|1= \zeta(2) = \frac{\pi^2}{6} }}
parses (you added that space!) to {{tmath|1= \zeta(2) = \frac{\pi^2}{6}}}
fails to parse (you forgot that space!), v.g. Failed to parse (syntax error): {\displaystyle \zeta(2) = \frac{\pi^2}{6} }{{tmath|\frac{1}{ x^{2n+1} } }}
parses (you added all those spaces!) to {{tmath|\frac{1}{x^{2n+1}} }}
fails to parse (you forgot some of those spaces!), v.g. Failed to parse (syntax error): {\displaystyle \frac{1}{x^{2n+1} }}
Uniform compatible formatting guideline
[edit]When converting between <math>...</math>
and {{tmath|...}}
, first adjusting the expression to be compatible with both can help. A guideline for such formatting is:
- Do not use templates internally, such as
{{=}}
,{{!}}
,{{(}}
, etc. - Replace all pipe characters:
|
by\vert
or\mid
, and\|
by\Vert
. - Introduce a space between adjacent identical braces: replace all occurrences of
{{
by{ {
and}}
by} }
- Ensure a space at the end – this removes the possibility that a trailing
}
will adjoin the closing braces of the{{tmath|...}}
- Replace a
display="inline"
parameter with a leading\textstyle
. - With these adjustments, it should be possible to interchange the tags
<math>...</math>
and a template{{tmath|1=...}}
. Note the use of the parameter number1=
to avoid a problem with an equals sign in the expression. Any text, such as punctuation, that does not naturally form part of the expression should be moved out of the{{tmath|...}}
.
See also
[edit]