View source for Template:NumBlk/doc

{{documentation subpage}}
This template creates a numbered block which is usually used to number mathematical formulae. This template can be used together with {{tl|EquationRef}} and {{tl|EquationNote}} to produce nicely formatted numbered equations if a back reference to an equation is wanted.

== Parameters ==
Command: <nowiki>{{NumBlk|<1>|<2>|<3>|RawN=<>|LnSty=<>|Border=<>}}</nowiki>

Parameters <nowiki>{{{1}}}</nowiki>, <nowiki>{{{2}}}</nowiki>, and <nowiki>{{{3}}}</nowiki> of this template are required.  In addition, there are three optional parameters <nowiki>{{{RawN}}}</nowiki>, <nowiki>{{{LnSty}}}</nowiki> and <nowiki>{{{Border}}}</nowiki>.
:'''<nowiki>{{{1}}}</nowiki>''': 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.
:'''<nowiki>{{{2}}}</nowiki>''': The body or content of the block.
:'''<nowiki>{{{3}}}</nowiki>''': Specify the block number.
:'''<nowiki>{{{RawN}}}</nowiki>''': If a non-empty non-whitespace value, no extra formatting will be applied to the block number.
:'''<nowiki>{{{LnSty}}}</nowiki>''': Specify the line style.
:'''<nowiki>{{{Border}}}</nowiki>''': If set, put a box around the equation. (Experimental.)

== Examples ==
<div align="center" style="padding:0 0 0 1em;">
{|class="wikitable" width="96%"
!colspan="2"|
=== Equations may render HTML ===
|-
|width="55%"|
<source lang="tex" inline>{{NumBlk|:|<math>y=ax+b</math>|Eq. 3}}</source>
|width="45%"|
{{NumBlk|:|<math>y=ax+b</math>|Eq. 3}}
|-
|
<source lang="tex" inline>{{NumBlk|:|<math>ax^2+bx+c=0</math>|Eq. 3}}</source>
|
{{NumBlk|:|<math>ax^2+bx+c=0</math>|Eq. 3}}
|-
|
<source lang="tex" inline>{{NumBlk|:|<math>\Psi(x_1,x_2)=U(x_1)V(x_2)</math>|2}}</source>
|
{{NumBlk|:|<math>\Psi(x_1,x_2)=U(x_1)V(x_2)</math>|2}}
|-
!colspan="2"|
=== Indentation ===
|-
|
<source lang="tex" inline>{{NumBlk||<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3.5}}</source>
|
{{NumBlk||<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3.5}}
|-
|
<source lang="tex" inline>{{NumBlk|:|<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|1}}</source>
|
{{NumBlk|:|<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|1}}
|-
|
<source lang="tex" inline>{{NumBlk|::|<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|13.7}}</source>
|
{{NumBlk|::|<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|13.7}}
|-
|
<source lang="tex" inline>{{NumBlk|:::|<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|1.2}}</source>
|
{{NumBlk|:::|<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|1.2}}
|-
!colspan="2"|
=== Formatting of equation number ===
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=3.5|RawN=.}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=3.5|RawN=.}}
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<3.5>|RawN=.}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<3.5>|RawN=.}}
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=[3.5]|RawN=.}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=[3.5]|RawN=.}}
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3='''[3.5]'''|RawN=.}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3='''[3.5]'''|RawN=.}}
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>}}
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.}}
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<math>(3.5)</math>|RawN=.}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<math>(3.5) \,</math>|RawN=.}}
|-
!colspan="2"|
=== Line style ===
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''(3.5)'''</Big>|RawN=.|LnSty=1px dashed red}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''(3.5)'''</Big>|RawN=.|LnSty=1px dashed red}}
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''(3.5)'''</Big>|RawN=.|LnSty=3px dashed #0a7392}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''(3.5)'''</Big>|RawN=.|LnSty=3px dashed #0a7392}}
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=3px solid green}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=3px solid green}}
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=5px dotted blue}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=5px dotted blue}}
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=0px solid green}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=0px solid green}}
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=5px none green}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=5px none green}}
|-
|
<source lang="tex" inline>{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=3px double green}}</source>
|
{{NumBlk|1=:|2=<math>\mathbf{a}(t)=\frac{d}{dt}\mathbf{v}(t)</math>|3=<Big>'''[3.5]'''</Big>|RawN=.|LnSty=3px double #f4c300}}
|-
!colspan="2"|
=== Border ===
|-
|
<source lang="tex" inline>{{NumBlk|:|<math>y=ax+b</math>|Eq. 3|Border=1}}</source>
|
{{NumBlk|:|<math>y=ax+b</math>|Eq. 3|Border=1}}
|}
</div>
=== 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 {{tl|clear}}-like template.

To illustrate, consider the example:
{{markupv|m=<nowiki>
[[Image:Bnet_fan2.png|frame|right|Fig.1: Bayesian Network representation of Eq.(6)]]
[[Image:Bnet_fan2.png|frame|left|Fig.1: Bayesian Network representation of Eq.(6)]]
<br><br>A Bayesian network (or a belief network) is a probabilistic graphical model that represents a set of
variables and their probabilistic independencies. For example, a Bayesian network could represent the
probabilistic relationships between diseases and symptoms. Given symptoms, the network can be used to compute
the probabilities of the presence of various diseases.
{{NumBlk|1=:|2=<math>
P(a, b, \lambda) = P(a| \lambda) P(b | \lambda) P(\lambda)\,
</math>,|3='''Eq.(6)'''|RawN=.}}</nowiki>
|r=
[[Image:Bnet_fan2.png|frame|right|Fig.1: Bayesian Network representation of Eq.(6)]]
[[Image:Bnet_fan2.png|frame|left|Fig.1: Bayesian Network representation of Eq.(6)]]
<br><br>A Bayesian network (or a belief network) is a probabilistic graphical model that represents a set of
variables and their probabilistic independencies. For example, a Bayesian network could represent the
probabilistic relationships between diseases and symptoms. Given symptoms, the network can be used to compute
the probabilities of the presence of various diseases.
{{NumBlk|1=:|2=<math>
P(a, b, \lambda) = P(a| \lambda) P(b | \lambda) P(\lambda)\,
</math>,|3='''Eq.(6)'''|RawN=.}}
}}
{{clear}}
If it is desirable for the numbered block to span the entire line, a {{tl|clear}} should be placed before it.
{{markupv|m=<nowiki>
[[Image:Bnet_fan2.png|frame|right|Fig.1: Bayesian Network representation of Eq.(6)]]
[[Image:Bnet_fan2.png|frame|left|Fig.1: Bayesian Network representation of Eq.(6)]]
<br><br>A Bayesian network (or a belief network) is a probabilistic graphical model that represents a set of
variables and their probabilistic independencies. For example, a Bayesian network could represent the
probabilistic relationships between diseases and symptoms. Given symptoms, the network can be used to compute
the probabilities of the presence of various diseases.
{{clear}}
{{NumBlk|1=:|2=<math>
P(a, b, \lambda) = P(a| \lambda) P(b | \lambda) P(\lambda)\,
</math>,|3='''Eq.(6)'''|RawN=.}}</nowiki>
|r=
[[Image:Bnet_fan2.png|frame|right|Fig.1: Bayesian Network representation of Eq.(6)]]
[[Image:Bnet_fan2.png|frame|left|Fig.1: Bayesian Network representation of Eq.(6)]]
<br><br>A Bayesian network (or a belief network) is a probabilistic graphical model that represents a set of
variables and their probabilistic independencies. For example, a Bayesian network could represent the
probabilistic relationships between diseases and symptoms. Given symptoms, the network can be used to compute
the probabilities of the presence of various diseases.
{{clear}}
{{NumBlk|1=:|2=<math>
P(a, b, \lambda) = P(a| \lambda) P(b | \lambda) P(\lambda)\,
</math>,|3='''Eq.(6)'''|RawN=.}}
{{clear}}
}}

== Table caveat ==

Because {{tl|NumBlk}} is implemented as a table, putting {{tl|NumBlk}} within a table yields a [[Help:Table#Nested_tables|nested table]]. Due to a bug in [[MediaWiki]]'s handling of nested tables, {{tl|NumBlk}} must be used carefully in this case. In particular, when indentation for the outer table is desired, use explicit {{tag|dl|content={{tag|dd}}}} tags for indentation instead of a leading colon (:).

For example, 
{{markupv|m=<source lang="xml">
<dl><dd>
{|
|<math>(f * g)[n]\,</math>&nbsp; &nbsp; &nbsp; 
|{{NumBlk||<math>\stackrel{\mathrm{def}}{=}\sum_{m=-\infty}^{\infty} f[m]\cdot g[n - m]\,</math>|
3=<span style="color:darkred">'''(Eq.1)'''</span>|RawN=.}}
|-
|
|<math>= \sum_{m=-\infty}^{\infty} f[n-m]\cdot g[m].\,</math> &nbsp; &nbsp; &nbsp; ([[Convolution#Commutativity|commutativity]])
|}
</dd></dl>
</source>
|r=
<dl><dd>
{{(}}{{!}}
{{!}}<math>(f * g)[n]\,</math>&nbsp; &nbsp; &nbsp; 
{{!}}{{NumBlk||<math>\stackrel{\mathrm{def}}{=}\sum_{m=-\infty}^{\infty} f[m]\cdot g[n - m]\,</math>|
3=<span style="color:darkred">'''(Eq.1)'''</span>|RawN=.}}
{{!}}-
{{!}}
{{!}}<math>= \sum_{m=-\infty}^{\infty} f[n-m]\cdot g[m].\,</math> &nbsp; &nbsp; &nbsp; ([[Convolution#Commutativity{{!}}commutativity]])
{{!}}{{)}}
</dd></dl>
}}
which shows how the outer {{tag|dl|content={{tag|dd}}}} tags give the same indentation as a single colon (:) preceding the table should. 

For another example,
{| style="table-layout: fixed; width: 90%; border-width: medium; margin-left: 0em;"
{{#if:  | {{!}}+ ''''''}}
|-
| style="width:10%; border-width: 1px; padding: 5px; border-style: solid solid none solid; border-color: #ddd; vertical-align:text-top;" | Markup
| style="border-width: 1px; padding: 5px; border-style: solid solid none none; border-color: #ddd; vertical-align:text-top;" | {{#tag:pre|
<source lang="xml"><dl><dd>
<dl><dd>
{|
|-
|The first parameter for indentation still works when used inside table.
{{NumBlk|::::|<math>ax^2+bx+c=0</math>|Level 4}}
{{NumBlk|:::|<math>ax^2+bx+c=0</math>|Level 3}}
{{NumBlk|::|<math>ax^2+bx+c=0</math>|Level 2}}
{{NumBlk|:|<math>ax^2+bx+c=0</math>|Level 1}}
{{NumBlk||<math>ax^2+bx+c=0</math>|Level 0}}
|-
|}
</dd></dl>
</dd></dl></source>|style="border: none; margin:0; padding: 0; word-wrap: break-word; white-space: -moz-pre-wrap; white-space: -o-pre-wrap; white-space: -pre-wrap; white-space: pre-wrap"}}
|-
| style="width:10%; border-width: 1px; padding: 5px; border-style: solid; border-color: #ddd; vertical-align:top;" | Renders as
| style="border-width: 1px; padding: 5px; border-style: solid solid solid none; border-color: #ddd; vertical-align:text-top;" | <dl><dd>
<dl><dd>
{|
|-
|The first parameter for indentation still works when used inside table.
{{NumBlk|::::|<math>ax^2+bx+c=0</math>|Level 4}}
{{NumBlk|:::|<math>ax^2+bx+c=0</math>|Level 3}}
{{NumBlk|::|<math>ax^2+bx+c=0</math>|Level 2}}
{{NumBlk|:|<math>ax^2+bx+c=0</math>|Level 1}}
{{NumBlk||<math>ax^2+bx+c=0</math>|Level 0}}
|-
|}
</dd></dl>
</dd></dl>
|}
which uses two sets of explicit tags to give the same indentation as two colons (::).
<includeonly>{{basepage subpage|
[[Category:Mathematical formatting templates]]
}}</includeonly>