View source for Template:Math/doc

{{Documentation subpage}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{high-use| 6640 }}
:{{for|basic mathematical functions|Module:Math}}
The '''math''' template formats mathematical formulas generated using [[HTML]] or [[Help:Wikitext|wiki markup]]. (It does not accept the [[AMS-LaTeX]] markup that <nowiki><math></nowiki> does.) The template uses the <code>texhtml</code> 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 ==
Use this template for inline, non-complex formulas as an alternative to using the {{tag|math}} tag pair (see: [[Help:Math]]).

=== Examples ===
<syntaxhighlight lang="wikitext">
{{math|''f''(''x'') {{=}} ''b''<sup>''x''</sup> {{=}} ''y''}}
</syntaxhighlight>
: produces: {{math|''f''(''x'') {{=}} ''b''<sup>''x''</sup> {{=}} ''y''}}
<syntaxhighlight lang="wikitext">
{{math|sin &amp;pi; {{=}} 0}}
</syntaxhighlight>
: produces: {{math|sin &pi; {{=}} 0}}.

<syntaxhighlight lang="wikitext">
{{math|{{intmath|int|0|+&amp;infin;}} ''e''<sup>−''x''</sup> d''x'' {{=}} 1}}
</syntaxhighlight>
: produces: {{math|{{intmath|int|0|+&infin;}} ''e''<sup>−''x''</sup> d''x'' {{=}} 1}}

<syntaxhighlight lang="wikitext">
'''{{math|{{sfrac|1|2}} − {{sfrac|1|3}} {{=}} {{sfrac|1|6}}}}'''
</syntaxhighlight>
: produces: '''{{math|{{sfrac|1|2}} − {{sfrac|1|3}} {{=}} {{sfrac|1|6}}}}'''.  Note the triple-apostrophes have set the whole formula as bold.

{{tag|math}} should be used for expressions with the radical symbol (√); see [[MOS:RADICAL]].

===Use of equals-sign and absolute value bars===
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 "<nowiki>{{{1}}}</nowiki>". For example, the following template-coding would be invalid:

<syntaxhighlight lang="wikitext">{{math|1 + 2 = 3}}</syntaxhighlight>
: produces: {{math|1 + 2 = 3}}, which is invalid code

To resolve this, either: (a) Start the formula with "<code>1=</code>" as in:
<syntaxhighlight lang="wikitext">{{math|1=1 + 2 = 3}}</syntaxhighlight>
: produces: {{math|1=1 + 2 = 3}}, or else, (b) enclose the equals-sign in double-braces <nowiki>"{{=}}"</nowiki> as in:
<syntaxhighlight lang="wikitext">{{math|1 + 2 {{=}} 3}}</syntaxhighlight>
: produces: {{math|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 "<nowiki>{{!}}</nowiki>":
<syntaxhighlight lang="wikitext">{{math|{{!}}''f''(''x'') − ''a''{{!}} < ε}}</syntaxhighlight>
: produces: {{math|{{!}}''f''(''x'') − ''a''{{!}} < ε}}.

This example can also be produced by the following:
<syntaxhighlight lang="wikitext">{{math|{{mabs|''f''(''x'') − ''a''}} < ε}}</syntaxhighlight>
: produces: {{math|{{mabs|''f''(''x'') − ''a''}} < ε}}

=== Parameters ===
The following parameters are optional:
* <code>big=1</code> – This will render the formula in a bigger fontsize, increased to 165%.
* <code>size=''font-size''</code> – Use this to specify your own fontsize.
<syntaxhighlight lang="wikitext">
{{math|big=1|1 + 2 {{=}} 3}}
</syntaxhighlight>
: produces: {{math|big=1|1 + 2 {{=}} 3}}

<syntaxhighlight lang="wikitext">
{{math|size=250%|1 + 2 {{=}} 3}}
</syntaxhighlight>
: produces: {{math|size=250%|1 + 2 {{=}} 3}}

=== TemplateData ===
{{TemplateData header}}
<templatedata>{
"description": "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.",
"params": {
  "1": {
    "label": "formula",
    "description": "wrap an inline formula in wikitext.",
    "type": "string",
    "required": true
  },
  "big": {
    "label": "bigger font size",
    "description": "if set to ‘1’, this will render the formula in a bigger font size, increased to 165%",
    "type": "string",
    "required": false
  },
  "size": {
    "label": "custom font size",
    "description": "use this to specify your own font size",
    "type": "string",
    "required": false
  }
}}</templatedata>

== Notes ==
The font and fontsize used for <code>texhtml</code>, as defined in [[MediaWiki:Common.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 <code>.mw-parser-output span.texhtml { font-size: 100%; }</code> will restore proper display.

The <code>texhtml</code> 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.

===Tracking category===
* Articles with unknown parameters are listed in {{clc|Category:Pages using Math with unknown parameters}}.
**These same errors are notes in a {{button|Preview}} warning.

== See also ==
* [[Help:Displaying a formula]]
* [[Wikipedia:Rendering math]], a comparison of different representation of mathematical expressions
{{Math templates|notation}}

<includeonly>{{basepage subpage|
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Mathematical formatting templates]]

}}</includeonly>