Exibir código-fonte para Predefinição:Math/doc

{{Documentation subpage}}

This template is a wrapper for the <code><nowiki><math></nowiki></code> tag, which is implemented by the [[mw:Extension:Math|Math extension]]. It is generally preferable to use this template to display formulas as opposed to using <code><nowiki><math></nowiki></code> tags directly in wikitext. The primary purpose of this template is to change the default text rendering color so that formulas are legible on the wiki's dark background. This template provides some useful options for displaying formulas, such as indented and numbered blocks. Additionally, it allows parser functions and templates to be used inside of formulas.

__TOC__

==Usage==
Use this template anywhere you wish to display formulas, equations, mathematical symbols, etc., as you would normally do using <code><nowiki><math></nowiki></code> tags. It is preferable to use this template instead of using <code><nowiki><math></nowiki></code> tags directly in wikitext.

===Parameters===
{| class="wikitable"
! Parameter !! Optional !! Description
|- 
| <code>1</code>, <code>formula</code>
| {{no}}
| LaTeX syntax used to designate the [[#Formula|formula]]
|-
| <code>display</code>
| {{yes}}
| [[#Display options|Display option]] – Possible values are:
* <code>block</code>: Renders formula display-style and displays it in its own paragraph
* <code>inline</code>: Displays formula inline with surrounding text. Renders text-style, for a smaller vertical footprint
* Default: Displays formula inline with surrounding text. Renders display-style
|- 
| <code>indent</code>
| {{yes}}
| How many times to indent the formula display. Used only if <code>display = block</code>
|- 
| <code>ref</code>
| {{yes}}
| Label to reference the formula by. Typically used with {{tl|EquationRef}}. Requires <code>display = block</code>
|}

===Formula===
The formula is written by providing [[wikipedia:Help:Displaying a formula#LaTeX basics|LaTeX syntax]] with <code>|formula=</code> or <code>|1=</code>.

<pre>{{math|formula=E=mc^2}}</pre>

{{math|formula=E=mc^2}}

===Display options===
====Default====
The default display option has <code>|display=</code> omitted or left blank. This option displays the formula inline with the surrounding text. The formula is rendered display-style.

<pre>The sum {{math|formula=\sum_{i=0}^\infty 2^{-i} }} converges to 2.</pre>

The sum {{math|formula=\sum_{i=0}^\infty 2^{-i} }} converges to 2.

====Block====
With <code>|display=</code> set to <code>block</code>, the formula is always displayed in its own paragraph. The formula is rendered display-style.

<pre>The sum {{math|display=block|formula=\sum_{i=0}^\infty 2^{-i} }} converges to 2.</pre>

The sum {{math|display=block|formula=\sum_{i=0}^\infty 2^{-i} }} converges to 2.

Use <code>|indent=</code> to specify the number of times to indent the formula display.

<pre>{{math
|display = block
|indent = 1
|formula = u = \dfrac{1}{\sqrt{2} }(x+y)
}}</pre>

{{math
|display = block
|indent = 1
|formula = u = \dfrac{1}{\sqrt{2} }(x+y)
}}

Use <code>|ref=</code> to provide a label to reference the formula by. {{tl|EquationRef}} is typically used for this purpose in conjunction with {{tl|EquationNote}}.

<pre>{{math
|display = block
|ref = {{EquationRef|1|Eq. 1}}
|formula = x^2 + y^2 + z^2 = 1
}}

{{EquationNote|1|Equation 1}} shows the equation for a sphere centered on the origin.</pre>

{{math
|display = block
|ref = {{EquationRef|1|Eq. 1}}
|formula = x^2 + y^2 + z^2 = 1
}}

{{EquationNote|1|Equation 1}} shows the equation for a sphere centered on the origin.

====Inline====
With <code>|display=</code> set to <code>inline</code>, the formula is displayed inline with the surrounding text. The formula is also rendered text-style, which takes up less vertical space.

<pre>The sum {{math|display=inline|formula=\sum_{i=0}^\infty 2^{-i} }} converges to 2.</pre>

The sum {{math|display=inline|formula=\sum_{i=0}^\infty 2^{-i} }} converges to 2.

===Using queried data in formulas===
Formulas may contain [[mw:Help:Extension:ParserFunctions|parser functions]] and templates. It is possible to query [[Special:CargoTables|certain game data]] with [[mw:Extension:Cargo/Querying_data|Cargo]] then display it inside of a formula. Doing so can help ensure that articles stay up to date.

In the following example, the base value of the character stat <var>maximum_life_leech_rate_%_per_minute</var> is queried using {{tl|character query}} and defined as a variable called <var>life_leech_rate</var> with the <code>#vardefine</code> parser function. The value of <var>life_leech_rate</var> is used in an expression with <code>#var</code>. The expression is evaluated using <code>#expr</code>.

<pre>{{#vardefine:life_leech_rate| {{Character query|maximum_life_leech_rate_%_per_minute}} }}{{math|formula=
\begin{align}
M & = Maximum Leech Rate Per Minute / 60 \\
& = {{#var:life_leech_rate}} / 60 \\
& = {{#expr: {{#var:life_leech_rate}} / 60 }}
\end{align} }}</pre>

{{#vardefine:life_leech_rate| {{Character query|maximum_life_leech_rate_%_per_minute}} }}{{math|formula=
\begin{align}
M & = Maximum Leech Rate Per Minute / 60 \\
& = {{#var:life_leech_rate}} / 60 \\
& = {{#expr: {{#var:life_leech_rate}} / 60 }}
\end{align} }}

==Troubleshooting common problems==
There are several common problems that arise because LaTeX uses characters that are also used for transcluding templates in wikitext.

===Equals signs===
If the formula contains an equals sign (<code>=</code>), it is imperative to give the name of the formula parameter explicitly. Write <code>|1=</code> or <code>|formula=</code>.

{| class="wikitable"
! Incorrect !! Correct
|-
|
<pre>{{math|E=mc^2}}</pre>
|
<pre>{{math|1=E=mc^2}}</pre>
|-
| {{math|E=mc^2}}
| {{math|1=E=mc^2}}
|}

===Consecutive closing braces===
Multiple closing braces placed together (<code>}}</code>) are interpreted by the wikitext parser as being part of the syntax for template transclusion. If the formula syntax needs consecutive closing braces, they should be separated with a space.

{| class="wikitable"
! Incorrect !! Correct
|-
|
<pre>{{math|formula=DR(A, D_{raw}) = \frac{A}{A + 10 \times D_{raw}}}}</pre>
|
<pre>{{math|formula=DR(A, D_{raw}) = \frac{A}{A + 10 \times D_{raw} } }}</pre>
|-
| {{math|formula=DR(A, D_{raw}) = \frac{A}{A + 10 \times D_{raw}}}}
| {{math|formula=DR(A, D_{raw}) = \frac{A}{A + 10 \times D_{raw} } }}
|}

===Absolute value denotation===
The [[wikipedia:Absolute value|absolute value]] of {{math|x}} is denoted as {{math|\vert x \vert}}. The pipe character (<code>|</code>) is interpreted by the wikitext parser as being part of the syntax for template transclusion. Use <code>\vert</code> instead.

{| class="wikitable"
! Incorrect !! Correct
|-
|
<pre>{{math|formula=|x|}}</pre>
|
<pre>{{math|formula=\vert x \vert}}</pre>
|-
| {{math|formula=|x|}}
| {{math|formula=\vert x \vert}}
|}

==See also==
* [[wikipedia:Help:Displaying a formula|Help:Displaying a formula]] (A detailed guide to LaTeX markup)

{{Documentation categories|
<!-- Categories and interwikis go here. -->
[[Category:Formatting templates]]
}}