Template:Math/doc
This is a documentation subpage for Template:Math. It contains usage information, categories and other content that is not part of the original template page. |
This template uses TemplateStyles: |
The math template formats HTML- or wikimarkup-generated mathematical formulas. (It does not accept the AMS-LaTeX markup that <math> does.) The template uses the texhtml
class by default for inline text style formulas, which aims to match the size of the serif font with the surrounding sans-serif font (see below). The template also prevents line-wrapping.
Usage
[edit]Use this template for inline, non-complex formulas as an alternative to using the <math>...</math>
tag pair (see: Help:Math).
Examples
[edit]{{math|''f''(''x'') {{=}} ''b''<sup>''x''</sup> {{=}} ''y''}}
- produces: f(x) = bx = y
{{math|sin π {{=}} 0}}
- produces: sin π = 0.
'''{{math|{{sfrac|1|2}} − {{sfrac|1|3}} {{=}} {{sfrac|1|6}}}}'''
- produces: 12 − 13 = 16. Note the triple-apostrophes have set the whole formula as bold.
Use of equals-sign and absolute value bars
[edit]The equals sign, =, and bar, |, are used as syntax by the wiki template system. Therefore, if a single equals-sign ("=") is used, it will fail to render, instead showing "{{{1}}}". For example, the following template-coding would be invalid:
{{math|1 + 2 = 3}}
- produces: {{{1}}}, which is invalid code
To resolve this, either: (a) Start the formula with "1=
" as in:
{{math|1=1 + 2 = 3}}
- produces: 1 + 2 = 3, or else, (b) enclose the equals-sign in double-braces "{{=}}" as in:
{{math|1 + 2 {{=}} 3}}
- produces: 1 + 2 = 3.
A similar difficulty concerns the vertical bars ("|") used to indicate absolute value, which without care would get interpreted as part of the template syntax. The solution is different than for the equals sign: such bars should be entered as "{{!}}":
{{math|{{!}}''f''(''x'') − ''a''{{!}} < ε}}
- produces: |f(x) − a| < ε.
Parameters
[edit]The following parameters are optional:
big=1
– This will render the formula in a bigger fontsize, increased to 165%.size=font-size
– Use this to specify your own fontsize.
{{math|big=1|1 + 2 {{=}} 3}}
- produces: 1 + 2 = 3
{{math|size=250%|1 + 2 {{=}} 3}}
- produces: 1 + 2 = 3
TemplateData
[edit]This template formats markup generated mathematical formulas with HTML and CSS. The template tries to match the size of the serif font with the surrounding sans-serif font. The template also prevents line-wrapping. Use this template for non-complex formulas as an alternative to using the <math> format.
Parameter | Description | Type | Status | |
---|---|---|---|---|
formula | 1 | wrap an inline formula in wikitext. | String | required |
bigger font size | big | if set to ‘1’, this will render the formula in a bigger font size, increased to 165% | String | optional |
custom font size | size | use this to specify your own font size | String | optional |
Notes
[edit]The font and fontsize used for texhtml
, as defined in Template:Math/styles.css, was determined by comparing common default fonts found on Windows, OS X and Linux and is scaled to 118% to match their x-height. However, not everyone uses the default fonts. If you find that the rendered math is not of the same size as the surrounding text, you can adjust this in your personal CSS. For instance, the DejaVu Sans and DejaVu Serif fonts do not need scaling, in which case span.texhtml { font-size: 100%; }
will restore proper display.
The texhtml
classname is a remnant from the TeX renderer, which had a user preference to render TeX-written formulae in "HTML when simple". That option has been removed some time ago, but the classname continues to be used for formulae written in HTML.