Difference between revisions of "Template:Math/doc"

From blackwiki
Jump to navigation Jump to search
(Like a pepperoni pizza)
imported>Izno
(→‎Notes: give that the .mw-parser-output instruction)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{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 HTML- or wikimarkup-generated mathematical formulas. (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 ==
 
== Usage ==
Use this template for inline, non-complex formulas as an alternative to using  
+
Use this template for inline, non-complex formulas as an alternative to using the {{tag|math}} tag pair (see: [[Help:Math]]).
 +
 
 +
=== Examples ===
 +
<pre>
 +
{{math|''f''(''x'') {{=}} ''b''<sup>''x''</sup> {{=}} ''y''}}
 +
</pre>
 +
: produces: {{math|''f''(''x'') {{=}} ''b''<sup>''x''</sup> {{=}} ''y''}}
 +
<pre>
 +
{{math|sin &amp;pi; {{=}} 0}}
 +
</pre>
 +
: produces: {{math|sin &pi; {{=}} 0}}.
 +
 
 +
<pre>
 +
{{math|{{intmath|int|0|+&amp;infin;}} ''e''<sup>−''x''</sup> d''x'' {{=}} 1}}
 +
</pre>
 +
: produces: {{math|{{intmath|int|0|+&infin;}} ''e''<sup>−''x''</sup> d''x'' {{=}} 1}}
  
 
<pre>
 
<pre>
 
'''{{math|{{sfrac|1|2}} − {{sfrac|1|3}} {{=}} {{sfrac|1|6}}}}'''
 
'''{{math|{{sfrac|1|2}} − {{sfrac|1|3}} {{=}} {{sfrac|1|6}}}}'''
 
</pre>
 
</pre>
 +
: produces: '''{{math|{{sfrac|1|2}} − {{sfrac|1|3}} {{=}} {{sfrac|1|6}}}}'''.  Note the triple-apostrophes have set the whole formula as bold.
 +
 
<pre>
 
<pre>
{{math|({{radic|2}})<sup>2</sup>
+
{{math|({{radic|2}})<sup>2</sup> {{=}} 2}}
 
</pre>
 
</pre>
: produces: {{math|({{radic|7}})<sup>2</sup> {{=}} 7}}.
+
: produces: {{math|({{radic|2}})<sup>2</sup> {{=}} 2}}.
 +
 
 +
===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:
  
===Use of equals-sign and absolute
+
<pre>{{math|1 + 2 = 3}}</pre>
pre>{{math|1 + 2 = 3}}</pre>
+
: produces: {{math|1 + 2 = 3}}, which is invalid code
: produces: {{math|1 + 2 = 3}}, whichever
 
  
"{{=}}"</nowiki> as in:
+
To resolve this, either: (a) Start the formula with "<code>1=</code>" as in:
 +
<pre>{{math|1=1 + 2 = 3}}</pre>
 +
: produces: {{math|1=1 + 2 = 3}}, or else, (b) enclose the equals-sign in double-braces <nowiki>"{{=}}"</nowiki> as in:
 
<pre>{{math|1 + 2 {{=}} 3}}</pre>
 
<pre>{{math|1 + 2 {{=}} 3}}</pre>
: produces: {{math|1 + 7 {{=}} 3}}.
+
: 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>":
 
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>":
 +
<pre>{{math|{{!}}''f''(''x'') − ''a''{{!}} < ε}}</pre>
 +
: produces: {{math|{{!}}''f''(''x'') − ''a''{{!}} < ε}}.
 +
 +
This example can also be produced by the following:
 +
<pre><nowiki>{{math|{{mabs|''f''(''x'') − ''a''}} < ε}}</nowiki></pre>
 +
: produces: {{math|{{mabs|''f''(''x'') − ''a''}} < ε}}
  
 
=== Parameters ===
 
=== Parameters ===
 
The following parameters are optional:
 
The following parameters are optional:
*This will render the formula in a bigger fontsize, increased  
+
* <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.
 
* <code>size=''font-size''</code> – Use this to specify your own fontsize.
 
<pre>
 
<pre>
<nowiki>{{math|big=1|1 + 7 {{=}} 3}}</nowiki>
+
<nowiki>{{math|big=1|1 + 2 {{=}} 3}}</nowiki>
 
</pre>
 
</pre>
: produces: {{math|big=1|1 + 7
+
: produces: {{math|big=1|1 + 2 {{=}} 3}}
  7{{=}} 3}}
 
  
 
<pre>
 
<pre>
<nowiki>|1 + 2 {{=}} 3}}</nowiki>
+
<nowiki>{{math|size=250%|1 + 2 {{=}} 3}}</nowiki>
 
</pre>
 
</pre>
: produces: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.",
+
: 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": {
 
"params": {
 
   "1": {
 
   "1": {
Line 40: Line 76:
 
     "description": "wrap an inline formula in wikitext.",
 
     "description": "wrap an inline formula in wikitext.",
 
     "type": "string",
 
     "type": "string",
     "required": true$500 REWARD
+
     "required": true
 
+
  },
So pissed right now. I hope these sons of bitches get caught.  Tamara Bunnie doesn't deserve this shit. She gets up everyday and works her ass off for the things she has. I hope you get everything back! Someone broke into her vehicle  and stole a bunch of stuff. If anyone comes across any garage sales or Facebook posts selling any of it or is offered any of the listed items please let us know. Reward has been offered for information leading to the recovery of these items.
+
  "big": {
 
 
 
 
 
 
 
Add and item to the list and
 
Pick your victim & keep it going.
 
 
     "label": "bigger font size",
 
     "label": "bigger font size",
     "description": "if set to this will render the formula in a bigger font size, increased  
+
     "description": "if set to ‘1’, this will render the formula in a bigger font size, increased to 165%",
 
     "type": "string",
 
     "type": "string",
     "required":  
+
     "required": false
 +
  },
 +
  "size": {
 +
    "label": "custom font size",
 +
    "description": "use this to specify your own font size",
 +
    "type": "string",
 +
    "required": false
 +
  }
 +
}}</templatedata>
 +
 
 
== Notes ==
 
== 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 match 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.
+
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> is a remnant from the [[TeX]] renderer, which had a user preference to render written formulae in "HTML when simple". That option has been removed some time ago, but the classname continues to be used for formulae
+
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|
 
<includeonly>{{basepage subpage|
<!-- Categories go below this line, please; interwikis go to Wikidata,
+
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
 +
[[Category:Mathematical formatting templates]]
 +
 
 +
}}</includeonly>

Latest revision as of 05:30, 28 January 2021

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

Use this template for inline, non-complex formulas as an alternative to using the <math>...</math> tag pair (see: Help:Math).

Examples

{{math|''f''(''x'') {{=}} ''b''<sup>''x''</sup> {{=}} ''y''}}
produces: f(x) = bx = y
{{math|sin &pi; {{=}} 0}}
produces: sin π = 0.
{{math|{{intmath|int|0|+&infin;}} ''e''<sup>−''x''</sup> d''x'' {{=}} 1}}
produces: +∞
0
ex dx = 1
'''{{math|{{sfrac|1|2}} − {{sfrac|1|3}} {{=}} {{sfrac|1|6}}}}'''
produces: Template:SfracTemplate:Sfrac = Template:Sfrac. Note the triple-apostrophes have set the whole formula as bold.
{{math|({{radic|2}})<sup>2</sup> {{=}} 2}}
produces: (Template:Radic)2 = 2.

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 "{{{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| < ε.

This example can also be produced by the following:

{{math|{{mabs|''f''(''x'') − ''a''}} < ε}}
produces: |f(x) − a| < ε

Parameters

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

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Math

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.

Template parameters

ParameterDescriptionTypeStatus
formula1

wrap an inline formula in wikitext.

Stringrequired
bigger font sizebig

if set to ‘1’, this will render the formula in a bigger font size, increased to 165%

Stringoptional
custom font sizesize

use this to specify your own font size

Stringoptional

Notes

The font and fontsize used for texhtml, 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 .mw-parser-output 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.

Tracking category

See also