Template:CodeDescriptionRowA/doc

From Terminals
< Template:CodeDescriptionRowA
Revision as of 04:48, 14 February 2013 by Legalize (talk | contribs) (initial page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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:

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.