Difference between revisions of "Template:CodeDescriptionRow/doc"

From Terminals
Jump to: navigation, search
(create page)
 
m (mention header template)
 
Line 1: Line 1:
This template is used to provide a row in a table that describes a control sequence.  The arguments are positional and are as follows:
+
This template is used to provide a row in a table that describes a control sequence.  The header for the table should be provided with the [[:Template:CodeDescriptionHeader|CodeDescriptionHeader]] template.  The arguments are positional and are as follows:
  
 
{| class="wikitable"
 
{| class="wikitable"

Latest revision as of 06:24, 14 February 2013

This template is used to provide a row in a table that describes a control sequence. The header for the table should be provided with the CodeDescriptionHeader 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 Description of the control sequence, i.e. Cursor Position
4 Description of the parameters, i.e. Pn=1. Defaults to none if not provided.

See the associated template CodeDescriptionRowA for description rows with an associated acronym.