Template:NumBlk/doc

This template is copied from w:Template:NumBlk and is not meant for independent development.

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

Parameters
Command:

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

Examples
{|class="wikitable" width="96%" !colspan="2"|

Equations may render HTML

 * width="55%"|
 * width="55%"|
 * width="45%"|





!colspan="2"|

Indentation








!colspan="2"|

Formatting of equation number














!colspan="2"|

Line style














!colspan="2"|

Border



 * }

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 clear-like template.

To illustrate, consider the example:

If it is desirable for the numbered block to span the entire line, a clear should be placed before it.

Table caveat
Because NumBlk is implemented as a table, putting NumBlk within a table yields a nested table. Due to a bug in MediaWiki's handling of nested tables, NumBlk must be used carefully in this case. In particular, when indentation for the outer table is desired, use explicit  tags for indentation instead of a leading colon.

For example,

which shows how the outer  tags give the same indentation as a single colon preceding the table should.

For another example, which uses two sets of explicit tags to give the same indentation as two colons.