Difference between revisions of "Template:CodeChart/Char/doc"

From Terminals
Jump to: navigation, search
(create page)
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
This template is used to format a character cell in a control sequence code chart.  The arguments are:
 
This template is used to format a character cell in a control sequence code chart.  The arguments are:
* The character in the cell
+
* '''Required:''' The character in the cell
* The name of the anchor on the current page, if the character is an escape sequence explained on the page.
+
* The link target for the cell.  For a character terminating an escape sequence, use an anchor target like #cursor-address and explain the escape sequence on the same page with an anchor. For a non-terminal character in the escape sequence, link to a subpage of the current page like /ESC.  Terminating characters and non-terminating characters are styled with different background colors to readily distinguish between them.
* The name of the target page, if the character is a prefix of a longer sequence explained on the target page.
 

Latest revision as of 03:26, 17 January 2013

This template is used to format a character cell in a control sequence code chart. The arguments are:

  • Required: The character in the cell
  • The link target for the cell. For a character terminating an escape sequence, use an anchor target like #cursor-address and explain the escape sequence on the same page with an anchor. For a non-terminal character in the escape sequence, link to a subpage of the current page like /ESC. Terminating characters and non-terminating characters are styled with different background colors to readily distinguish between them.