Template:dcl/doc

This is one of the family of templates used for creation of declaration lists.

dcl begin
 * starts the declaration list

dcl end
 * ends the declaration list. This template automatically adds above the item.

dcl rev begin
 * starts versioned declaration list. The parameter is optional and may be used for numbering purposes (overrides the num parameter of the  templates used within the versioned list (i.e., until ).

dcl rev end
 * ends versioned declaration list.

dcl header
 * adds explanation which header the feature comes from

dcl sep
 * adds a separator

heading
 * adds a small heading. Useful to split and describe large groups of related declarations.

declaration
 * adds an item to the declaration list. The parameter is optional and may be used to add notes about the feature. The  parameter is also optional and may be used for numbering purposes. declaration is the declaration of the feature. This template automatically adds  above the item.


 * specifies the first standard the definition appears in, specifies the first standard that does not include this definition,  either specifies the first standard that deprecated this definition, or is equal to, in which case it specifies that the definition has always been deprecated.


 * can be used in one of two ways:
 * when is specified, it specifies whether the "until" marker should be rendered as "removed in" instead, and can be either  or . If missing, defaults to  if  is specified and  otherwise.
 * when is not specified,  is equivalent to.

declaration
 * Same as dcl with additional possibility to generate an internal anchor to be a target to link to (mainly from Possible implementation sections).
 * When is specified and its value is not no, an internal HTML anchor is generated with the link name "Version anchor". Usually the value of  is equal to the value of, i.e. a number , , etc. But it can be any string, e.g.  would generate the anchor name "Version X1" (the prefix "Version " always prepends the anchor name).
 * When is not specified the dcla does generate (or does not) the anchor depending on whether the  parameter is specified. If  is specified, the anchor name is "Version num", e.g.  produces the "Version 1" anchor.

declaration
 * A convenience shorthand for combination: dcl header + dcl begin + dcl ... + dcl end when only one declaration need to be described.

...
 * single-template versioned declaration list; up to 7 versions are supported. The default for is  and the default for  is.
 * When is specified the dcl rev multi generates an internal HTML anchor with the name "Version anchor", e.g. given, the anchor name would be "Version X3". Usually, the value of  is same as the value of . The generated anchor is useful to link to it from e.g. Possible implementation section.

Example
The above results in the following:

Example
The above results in the following: