Template:Equation/doc

Purpose

This template gives an equation passed in as numbered parameter {{{1}}} a number {{{2}}}, which is displayed in the far right column. This also creates an anchor (#equation-{{{2}}}), which can be adjusted with the id parameter.

Usage

{{Equation|1=e = m c^2|2=1}}
{{Equation|1=a^2 + b^2 = c^2|2=2}}
{{Equation|1=X(t) = V_0 t + A t^2|2=3}}

results in:

<math>e = m c^2</math> (1)

<math>a^2 + b^2 = c^2</math> (2)

<math>X(t) = V_0 t + A t^2</math> (3)

Note: Wikisyntax (e.g. formatting templates like {{sub}}) doesn't work in this template, use LaTeX syntax instead.

Note: When converting from a plain <math> tag to this template, you will need to replace the pipe symbol | with {{!}} and }} with } }.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Equation in articles based on its TemplateData.

TemplateData for Equation

<templatedata> { "params": { "1": { "label": "Equation (LaTeX)",

           "description": "See Wikipedia:LaTeX for instructions if unfamiliar.",

"example": "e^{iz} = \\cos(z) + i \\sin(z)", "type": "string", "required": true }, "2": { "label": "Equation number", "description": "The number of the equation, also used to generate the anchor", "type": "string", "suggested": true }, "id": { "label": "Anchor id","type": "string", "description": "The anchor id. If you set this to \"my-eqn\" (no quotes), the link see my equation will take you to the equation.", "default": "Defaults to \"equation-\" + the equation number, if that is specified." } }, "description": "This template generates an equation (passed in LaTeX) with a number to the right. It also generates an anchor so that the equation can be linked to from other parts of the page.", "paramOrder": [ "1", "2", "id" ] } </templatedata>