Template:Math/doc: Difference between revisions
>Illviljan mNo edit summary |
>TheFrz mNo edit summary |
||
Line 1: | Line 1: | ||
{{documentation subpage}} | {{documentation subpage}} | ||
The {{tlx|math}} template is a wrapper for | The {{tlx|math}} template is a wrapper for {{code|<math>}} tag which is a part of the [[mediawikiwiki:Extension:Math|Extension:Math]]. The template is mainly used to change the default rendering colors (black text on white background) to custom ones that fit the color scheme of the wiki, but also brings additional functionality such as possibility of using another templates inside of {{code|<math>}} tags and support for [[#Numbered equations|numbered equations]]. | ||
For a detailed guide to LaTeX markup see [[ | For a detailed guide to LaTeX markup see [[wikipedia:Help:Displaying a formula|Help:Displaying a formula]]. | ||
==Usage== | ==Usage== | ||
Line 15: | Line 15: | ||
| <code><nowiki>|formula=</nowiki></code> || Use it if formula contains <code>=</code> sign. | | <code><nowiki>|formula=</nowiki></code> || Use it if formula contains <code>=</code> sign. | ||
|- | |- | ||
| <code><nowiki>|display=</nowiki></code> || [ | | <code><nowiki>|display=</nowiki></code> || [[wikipedia:Help:Displaying a formula#Display attribute|Display attribute]] with possible values: | ||
* | * {{code|block}}: equation is rendered in its own paragraph and has indent | ||
* | * {{code|inline}}: there will be no new paragraph and the operators will be rendered to consume only a small amount of vertical space | ||
* not specified: no new paragraph and renders similar to | * not specified: no new paragraph and renders similar to {{code|block}} | ||
|- | |- | ||
| <code><nowiki>|nr=</nowiki></code> || Activates numbered equations. Don't forget to use unique numbers. Use {{tlx|EquationNote}} to reference the numbered equation. | | <code><nowiki>|nr=</nowiki></code> || Activates numbered equations. Don't forget to use unique numbers. Use {{tlx|EquationNote}} to reference the numbered equation. | ||
Line 63: | Line 63: | ||
Equation {{EquationNote|1}} shows the equation for an sphere centered around origo.</pre> | Equation {{EquationNote|1}} shows the equation for an sphere centered around origo.</pre> | ||
{{math|nr=1|formula=x^2 + y^2 + z^2 = 1}} | {{math|nr=1|formula=x^2 + y^2 + z^2 = 1}} | ||
Equation {{EquationNote|1}} shows the equation for a [ | Equation {{EquationNote|1}} shows the equation for a [[wikipedia:Sphere|sphere]] centered around origo. | ||
====Semantic queries==== | ====Semantic queries==== | ||
With this template it is possible to use [ | With this template it is possible to use [[smw:Help:Inline queries|inline queries]] such as the parser functions <code>#ask</code>, <code>#show</code> and other [[mediawikiwiki:Help:Extension:ParserFunctions|parser functions]] such as <code>#expr</code>. For example: | ||
<pre> | <pre> | ||
Line 124: | Line 124: | ||
===Absolute value denotation=== | ===Absolute value denotation=== | ||
====Problem==== | ====Problem==== | ||
[ | [[wikipedia:Absolute value|Absolute values]] are usually denoted |x|. However using <code>|</code> in templates will result in the following issue. | ||
{| | {| | ||
| | | | ||
Line 135: | Line 135: | ||
====Solution==== | ====Solution==== | ||
Use <code>\vert</code> or {{ | Use <code>\vert</code> or {{code|<nowiki>{{!}}</nowiki>}}: | ||
{| | {| | ||
| | | |
Revision as of 15:00, 5 November 2016
This subpage provides documentation for Template:Math.
The {{math}}
template is a wrapper for <math>
tag which is a part of the Extension:Math. The template is mainly used to change the default rendering colors (black text on white background) to custom ones that fit the color scheme of the wiki, but also brings additional functionality such as possibility of using another templates inside of <math>
tags and support for numbered equations.
For a detailed guide to LaTeX markup see Help:Displaying a formula.
Usage
Code {{math|2+3}}
renders as:
Parameters
The following parameters are available
Parameter | Description |
---|---|
|formula= |
Use it if formula contains = sign.
|
|display= |
Display attribute with possible values:
|
|nr= |
Activates numbered equations. Don't forget to use unique numbers. Use {{EquationNote}} to reference the numbered equation.
|
Basic usage
Display
default The sum {{math |formula=\sum_{i=0}^\infty 2^{-i} }} converges to 2. |
The sum converges to 2. |
block The sum {{math |display=block |formula=\sum_{i=0}^\infty 2^{-i} }} converges to 2. |
The sum |
inline The sum {{math |display=inline |formula=\sum_{i=0}^\infty 2^{-i} }} converges to 2. |
The sum converges to 2. |
Advanced usage
Numbered equations
The equations can be numbered using the nr
parameter. The equation can then be referenced with {{EquationNote}}
. For example:
{{math|nr=1|formula= x^2 + y^2 + z^2 = 1 }} Equation {{EquationNote|1}} shows the equation for an sphere centered around origo.
Equation 1 shows the equation for a sphere centered around origo.
Semantic queries
With this template it is possible to use inline queries such as the parser functions #ask
, #show
and other parser functions such as #expr
. For example:
{{math|formula= Enfeeble Base Radius - Maximum Leech Rate Per Second + Maximum Endurance Charges = {{#show: Enfeeble |?Has primary radius=}} - {{#expr:{{#ask: [[-Has subobject::Character]] [[Has stat id::maximum_life_leech_rate_%_per_minute]] |?Has stat value#= |mainlabel=- |limit=1}} /60}} + {{SMW character query|stat=max_endurance_charges}} = {{#expr: {{#show: Enfeeble |?Has primary radius=}} - {{#expr:{{#ask: [[-Has subobject::Character]] [[Has stat id::maximum_life_leech_rate_%_per_minute]] |?Has stat value#= |mainlabel=- |limit=1}} /60}} + {{SMW character query|stat=max_endurance_charges}} }} }}
yields: Failed to parse (syntax error): \color[RGB]{163,141,109} Enfeeble Radius - Maximum Leech Rate Per Second + Maximum Endurance Charges = {{#show: Enfeeble |?Has primary radius=}} - <strong class="error">Expression error: Unrecognized punctuation character "{".</strong> + [[:Template:SMW character query]] = <strong class="error">Expression error: Unrecognized punctuation character "{".</strong>
Limitations
Error with multiple braces
Problem
Placing multiple opening/closing braces together (e.g. {{
or }}
) if there are no closing/opening brackets, causes error. This happens because interpreter thinks they are a part of a template when in fact they are a part of a math markup. For example, the following code:
{{math|formula= DR(A, D_{raw}) = {A \over A + 10 \times D_{raw}} }} |
- Failed to parse (syntax error): \color[RGB]{163,141,109} DR(A, D_{raw}) = {A \over A + 10 \times D_{raw
}}
Solution
In order to prevent this either space braces:
{{math|formula= DR(A, D_{raw}) = {A \over A + 10 \times D_{raw} } }} |
|
or use the following templates:
{{math|formula= DR(A, D_{raw}) = {A \over A + 10 \times D_{raw{{))}} }} |
|
Absolute value denotation
Problem
Absolute values are usually denoted |x|. However using |
in templates will result in the following issue.
{{math|formula= |x| }} |
|
Solution
Use \vert
or {{!}}
:
{{math|formula= \vert x\vert }} |
|
{{math|formula= {{!}}x{{!}} }} |
|