Difference between revisions of "Template:CodeDescriptionRow"

From Terminals
Jump to: navigation, search
m (don't center description)
m (whitespace)
Line 5: Line 5:
 
! style="padding: 1ex;" | Description
 
! style="padding: 1ex;" | Description
 
! style="padding: 1ex;" | Parameters
 
! style="padding: 1ex;" | Parameters
</noinclude>
+
</noinclude>{{!}}-
{{!}}-
 
 
{{!}} style="padding: 1ex; text-align: center;" {{!}} <span id="{{{2}}}">{{{1}}}</span>
 
{{!}} style="padding: 1ex; text-align: center;" {{!}} <span id="{{{2}}}">{{{1}}}</span>
 
{{!}} style="padding: 1ex;" {{!}} {{{3}}}
 
{{!}} style="padding: 1ex;" {{!}} {{{3}}}
{{!}} style="padding: 1ex;" {{!}} {{#if:{{{4|}}}|{{{4}}}|''none''}}
+
{{!}} style="padding: 1ex;" {{!}} {{#if:{{{4|}}}|{{{4}}}|''none''}}<noinclude>
<noinclude>|}
+
|}
 
{{Documentation}}
 
{{Documentation}}
 
</noinclude>
 
</noinclude>

Revision as of 05:15, 13 February 2013

Template

Prefix Description Parameters
{{{1}}} {{{3}}} none
[edit] [history] [purge] Documentation icon Template documentation

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.