Template:Numbered block/doc

Template:Documentation subpage Template:Tsh Template:Uses TemplateStyles Template:Lua This template creates a numbered block which is usually used to number mathematical and chemical formulae. This template can be used together with Template:Tl and Template:Tl to produce formatted numbered equations if a back reference to an equation is wanted. Alternatively, Template:Tl can also be used directly—a template that combines the main functionalities of both Template:Tl and Template:Tl.

Parameters

Parameters Template:Para, Template:Para, and Template:Para of this template are required. In addition, there are five optional parameters Template:Para, Template:Para, Template:Para, Template:Para and Template:Para.

• Template:Para

  Specify indentation. The more colons : you put, the further indented the block will be, up to a limit of 20. This parameter can be empty if no indentation is needed.

• Template:Para: The body or content of the block.
• Template:Para: Specify the block number.
• Template:Para

  If a non-empty non-whitespace value, no extra formatting will be applied to the block number.

• Template:Para: Specify the line style.
• Template:Para: If set, put a box around the equation. (Experimental.)
• Template:Para

  The value of this parameter will be added to the class attribute of the outermost element of the template. Therefore, this parameter must conform to the syntax of the class attribute, which is a space-separated list of classes.

• Template:Para

  Specify the attributes of the outermost element of the template. Default is style="margin-left: {{#expr:1.6 * indentation_level}}em;" where indentation_level is derived from Template:Para. Thus, this parameter determines the indentation of the template by default. When specifying the attributes of the outermost element of the template through this parameter, it is recommended to assign an appropriate value to this parameter to replace the original role of the default value and obtain the expected indentation effect. Besides, since the class attribute is already used internally by the template, specifying the class attribute directly in this parameter may cause problems. The class attribute should be set by assigning a value to Template:Para instead. (for wrapper templates)

Examples

Formulae may render HTML
{{Numbered block|:|<math>y=ax+b</math>|Eq. 3}}
{{Numbered block|:|<math>ax^2+bx+c=0</math>|Eq. 3}}
{{Numbered block|:|<math>\Psi(x_1,x_2)=U(x_1)V(x_2)</math>|1}}
{{Numbered block|:|Fe<sup>3+</sup> + H<sub>2</sub>O<sub>2</sub> → Fe<sup>2+</sup> + HOO<sup>•</sup> + H<sup>+</sup>|2}}
{{Numbered block|:|<chem>H+ + CO3^2- -> HCO3^-</chem>|3}}
Indentation
{{Numbered block||<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3.5}}
{{Numbered block|:|<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|1}}
{{Numbered block|::|<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|13.7}}
{{Numbered block|:::|<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|1.2}}
Formatting of equation number
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=3.5|RawN=.}}
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<3.5>|RawN=.}}
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=[3.5]|RawN=.}}
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3='''[3.5]'''|RawN=.}}
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>}}
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.}}
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<math>(3.5)</math>|RawN=.}}
Line style
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''(3.5)'''</Big>|RawN=.|LnSty=1px dashed red}}
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''(3.5)'''</Big>|RawN=.|LnSty=3px dashed #0a7392}}
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=3px solid green}}
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=5px dotted blue}}
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=0px solid green}}
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=5px none green}}
{{Numbered block|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=3px double green}}
Indentation other than using parameter Template:Para
The following equations :<math>3x+2y-z=1</math> ::<math>2x-2y+4z=-2</math> :::<math>-2x+y-2z=0</math> form a system of three equations.	The following equations $3x+2y-z=1$ $2x-2y+4z=-2$ $-2x+y-2z=0$ form a system of three equations.
The following equations :{{Numbered block||<math>3x+2y-z=1</math>|1}} ::{{Numbered block||<math>2x-2y+4z=-2</math>|2}} :::{{Numbered block||<math>-2x+y-2z=0</math>|3}} form a system of three equations.
The following equations <dl><dd> {{Numbered block||<math>3x+2y-z=1</math>|1}} <dl><dd> {{Numbered block||<math>2x-2y+4z=-2</math>|2}} <dl><dd> {{Numbered block||<math>-2x+y-2z=0</math>|3}} </dd></dl> </dd></dl> </dd></dl> form a system of three equations.	The following equations Template:Numbered block Template:Numbered block Template:Numbered block form a system of three equations.
The following equations <div style="margin-left: 1.6em;"> {{Numbered block||<math>3x+2y-z=1</math>|1}} <div style="margin-left: 1.6em;"> {{Numbered block||<math>2x-2y+4z=-2</math>|2}} <div style="margin-left: 1.6em;"> {{Numbered block||<math>-2x+y-2z=0</math>|3}} </div> </div> </div> form a system of three equations.	The following equations form a system of three equations.
The following equations <div style="margin-left: calc(1.6em * 1);"> {{Numbered block||<math>3x+2y-z=1</math>|1}} </div> <div style="margin-left: calc(1.6em * 2);"> {{Numbered block||<math>2x-2y+4z=-2</math>|2}} </div> <div style="margin-left: calc(1.6em * 3);"> {{Numbered block||<math>-2x+y-2z=0</math>|3}} </div> form a system of three equations.	The following equations form a system of three equations.
Unordered list
* <math>3x+2y-z=1</math> * <math>2x-2y+4z=-2</math> * <math>-2x+y-2z=0</math>	$3x+2y-z=1$ $2x-2y+4z=-2$ $-2x+y-2z=0$
* {{Numbered block||<math>3x+2y-z=1</math>|1}} * {{Numbered block||<math>2x-2y+4z=-2</math>|2}} * {{Numbered block||<math>-2x+y-2z=0</math>|3}}
{{Bulleted list |1=<div style="display: inline-block; width: 100%; vertical-align: middle;">{{Numbered block||<math>3x+2y-z=1</math>|Eq. 1}}</div> |2=<div style="display: inline-block; width: 100%; vertical-align: middle;">{{Numbered block||<math>2x-2y+4z=-2</math>|Eq. 2}}</div> |3=<div style="display: inline-block; width: 100%; vertical-align: middle;">{{Numbered block||<math>-2x+y-2z=0</math>|Eq. 3}}</div> }}
{{Bulleted list |1=<div style="display: inline-table; width: 100%; vertical-align: middle;">{{Numbered block||<math>3x+2y-z=1</math>|Eq. 1}}</div> |2=<div style="display: inline-table; width: 100%; vertical-align: middle;">{{Numbered block||<math>2x-2y+4z=-2</math>|Eq. 2}}</div> |3=<div style="display: inline-table; width: 100%; vertical-align: middle;">{{Numbered block||<math>-2x+y-2z=0</math>|Eq. 3}}</div> }}
Ordered list
# <math>3x+2y-z=1</math> # <math>2x-2y+4z=-2</math> # <math>-2x+y-2z=0</math>	$3x+2y-z=1$ $2x-2y+4z=-2$ $-2x+y-2z=0$
# {{Numbered block||<math>3x+2y-z=1</math>|1}} # {{Numbered block||<math>2x-2y+4z=-2</math>|2}} # {{Numbered block||<math>-2x+y-2z=0</math>|3}}
{{Ordered list |1=<div style="display: inline-block; width: 100%; vertical-align: middle;">{{Numbered block||<math>3x+2y-z=1</math>|Eq. 1}}</div> |2=<div style="display: inline-block; width: 100%; vertical-align: middle;">{{Numbered block||<math>2x-2y+4z=-2</math>|Eq. 2}}</div> |3=<div style="display: inline-block; width: 100%; vertical-align: middle;">{{Numbered block||<math>-2x+y-2z=0</math>|Eq. 3}}</div> }}
{{Ordered list |1=<div style="display: inline-table; width: 100%; vertical-align: middle;">{{Numbered block||<math>3x+2y-z=1</math>|Eq. 1}}</div> |2=<div style="display: inline-table; width: 100%; vertical-align: middle;">{{Numbered block||<math>2x-2y+4z=-2</math>|Eq. 2}}</div> |3=<div style="display: inline-table; width: 100%; vertical-align: middle;">{{Numbered block||<math>-2x+y-2z=0</math>|Eq. 3}}</div> }}
Border
<!-- LnSty is not specified. --> {{Numbered block|:|<math>y=ax+b</math>|Eq. 3|Border=1}}
<!-- LnSty is specified. --> {{Numbered block|:|<math>y=ax+b</math>|Eq. 3|LnSty=0.7em solid #e500e5|Border=1}}

When content of the blocks and block numbers are far apart

Markup	{{Numbered block|1=:|2=<math>a^2 + b^2 = (a + b i) (a - b i)</math>|3=1}} {{Numbered block|1=:|2=<math>a^2 - b^2 = (a + b) (a - b)</math>|3=2}} {{Numbered block|1=:|2=<math>e^{i x} = \cos x + i \sin x</math>|3=3}} {{Numbered block|1=:|2=<math>\sin^2 \theta + \cos^2 \theta = 1</math>|3=4}} {{Numbered block|1=:|2=<math>\sin(2 \theta) = 2 \sin \theta \cos \theta</math>|3=5}}
Renders as

Markup

{{Numbered block|1=:|2=<math>a^2 + b^2 = (a + b i) (a - b i)</math>|3=1|LnSty=0.37ex dotted Gainsboro}} {{Numbered block|1=:|2=<math>a^2 - b^2 = (a + b) (a - b)</math>|3=2|LnSty=0.37ex dotted Gainsboro}} {{Numbered block|1=:|2=<math>e^{i x} = \cos x + i \sin x</math>|3=3|LnSty=0.37ex dotted Gainsboro}} {{Numbered block|1=:|2=<math>\sin^2 \theta + \cos^2 \theta = 1</math>|3=4|LnSty=0.37ex dotted Gainsboro}} {{Numbered block|1=:|2=<math>\sin(2 \theta) = 2 \sin \theta \cos \theta</math>|3=5|LnSty=0.37ex dotted Gainsboro}}

Renders as

Markup

{{Numbered block|1=:|2=<math>a^2 + b^2 = (a + b i) (a - b i)</math>|3=1|LnSty=0.37ex dotted Gainsboro}} {{Numbered block|1=:|2=<math>a^2 - b^2 = (a + b) (a - b)</math>|3=2|LnSty=0.37ex none Gainsboro}} {{Numbered block|1=:|2=<math>e^{i x} = \cos x + i \sin x</math>|3=3|LnSty=0.37ex dotted Gainsboro}} {{Numbered block|1=:|2=<math>\sin^2 \theta + \cos^2 \theta = 1</math>|3=4|LnSty=0.37ex none Gainsboro}} {{Numbered block|1=:|2=<math>\sin(2 \theta) = 2 \sin \theta \cos \theta</math>|3=5|LnSty=0.37ex dotted Gainsboro}}

Renders as

Markup

<div style="background-color: Beige;"> {{Numbered block|1=:|2=<math>a^2 + b^2 = (a + b i) (a - b i)</math>|3=1}} </div> <div style="background-color: none;"> {{Numbered block|1=:|2=<math>a^2 - b^2 = (a + b) (a - b)</math>|3=2}} </div> <div style="background-color: Beige;"> {{Numbered block|1=:|2=<math>e^{i x} = \cos x + i \sin x</math>|3=3}} </div> <div style="background-color: none;"> {{Numbered block|1=:|2=<math>\sin^2 \theta + \cos^2 \theta = 1</math>|3=4}} </div> <div style="background-color: Beige;"> {{Numbered block|1=:|2=<math>\sin(2 \theta) = 2 \sin \theta \cos \theta</math>|3=5}} </div>

Renders as

Markup

(mouse over the row you want to highlight) {{row hover highlight}} {| class="hover-highlight" style="width: 100%; border-collapse: collapse; margin: 0; padding: 0;" |- | {{Numbered block|1=:|2=<math>a^2 + b^2 = (a + b i) (a - b i)</math>|3=1}} |- | {{Numbered block|1=:|2=<math>a^2 - b^2 = (a + b) (a - b)</math>|3=2}} |- | {{Numbered block|1=:|2=<math>e^{i x} = \cos x + i \sin x</math>|3=3}} |- | {{Numbered block|1=:|2=<math>\sin^2 \theta + \cos^2 \theta = 1</math>|3=4}} |- | {{Numbered block|1=:|2=<math>\sin(2 \theta) = 2 \sin \theta \cos \theta</math>|3=5}} |}

Renders as

(mouse over the row you want to highlight) Template:Row hover highlight Template:Numbered block Template:Numbered block Template:Numbered block Template:Numbered block Template:Numbered block

Positioning relative to surrounding images

Numbered blocks should be able to be placed around images that take up space on the left or right side of the screen. To ensure numbered block has access to the entire line, consider using a Template:Tl-like template.

To illustrate, consider the example: Template:Markupv Template:Clear If it is desirable for the numbered block to span the entire line, a Template:Tl should be placed before it. Template:Markupv

Table caveat

Because {{Numbered block}} is implemented as a table, putting {{Numbered block}} within a table yields a nested table. Due to a bug in MediaWiki's handling of nested tables, Template:Tl must be used carefully in this case. In particular, when indentation for the outer table is desired, use explicit Template:Tag tags for indentation instead of a leading colon (:).

For example, Template:Markupv which shows how the outer Template:Tag tags give the same indentation as a single colon (:) preceding the table should.

For another example,

Markup	<dl><dd> <dl><dd> {| |- |The first parameter for indentation still works when used inside table. {{Numbered block|::::|<math>ax^2+bx+c=0</math>|Level 4}} {{Numbered block|:::|<math>ax^2+bx+c=0</math>|Level 3}} {{Numbered block|::|<math>ax^2+bx+c=0</math>|Level 2}} {{Numbered block|:|<math>ax^2+bx+c=0</math>|Level 1}} {{Numbered block||<math>ax^2+bx+c=0</math>|Level 0}} |- |} </dd></dl> </dd></dl>
Renders as	The first parameter for indentation still works when used inside table.

which uses two sets of explicit tags to give the same indentation as two colons (::).