Difference between revisions of "Template:CodeDescriptionRowA/doc"

From Terminals
Jump to: navigation, search
(initial page)
 
m
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
This template is used to provide a row in a table that describes a control sequence with an associated acronym.  The arguments are positional and are as follows:
+
This template is used to provide a row in a table that describes a control sequence with an associated acronym.  The header for the table should be provided with the [[:Template:CodeDescriptionHeaderA|CodeDescriptionHeaderA]] template.  The arguments are positional and are as follows:
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 20: Line 20:
 
| style="padding: 1ex;" | Description of the parameters, i.e. ''Pn''=1.  Defaults to ''none'' if not provided.
 
| style="padding: 1ex;" | Description of the parameters, i.e. ''Pn''=1.  Defaults to ''none'' if not provided.
 
|}
 
|}
 +
 +
See the associated template [[:Template:CodeDescriptionRow|CodeDescriptionRow]] for description rows without an acronym.

Latest revision as of 06:23, 14 February 2013

This template is used to provide a row in a table that describes a control sequence with an associated acronym. The header for the table should be provided with the CodeDescriptionHeaderA template. The arguments are positional and are as follows:

Argument Description
1 Character prefix for this control sequence, such as ETX, B, b, [, etc.
2 Anchor name linked from the codechart to this description row, i.e. etx, lowera, etc.
3 Acronym for the control sequence, i.e. CUP, DECSC
4 Description of the control sequence, i.e. Cursor Position
5 Description of the parameters, i.e. Pn=1. Defaults to none if not provided.

See the associated template CodeDescriptionRow for description rows without an acronym.