Template:Control code link

Template documentation[view] [edit] [history] [purge]

Used for linking mnemonic codes for control codes, whitespace characters and format effectors, as well as any other characters requiring reference by mnemonics in the manner of control codes (such as the Wansung and N-byte Hangul fillers). The intent is to allow code charts (including Unicode block charts and more especially Unicode mapping charts) and other references to control code mnemonics to link to the destination which best explains that character, and to allow these links to be changed across the board if more detailed information is added elsewhere or if information is moved.

An optional

XML Example

internal=1

parameter may be provided, which will force the link to point to an anchor within the same article, and format the link in the style of {{Glossary link internal}}. This is appropriate if (a) the link is expected to necessarily go to an anchor in the same article (say, within C0 and C1 control codes), and (b) it isn't somewhere (such as a code chart) where a blue link would be expected in all cases. This can help avoid a "sea of blue" effect in a page documenting a large number of such characters. {{Glossary link internal}} itself cannot be used since it is constructed for a different system of anchors which uses lowercase initial letters, and the anchors used by this template (both in internal and normal mode) are block capital. There is one mandatory positional parameter, which is the mnemonic, in block capitals. When

XML Example

internal=1

is used, this is merely an anchor name within the article. When

XML Example

internal=1

is not used, it will recognise most common mnemonics for control and format characters and direct the link to a relevant article, or to a relevant anchor within an article. A few exceptions to note:

• The mnemonic
  XML Example

  FS
  

  is used for two different controls in different sets: use
  XML Example

  ASCII:FS
  

  for File Separator and
  XML Example

  EBCDIC:FS
  

  for the S/360 CPU control Field Separator.
• The mnemonic
  XML Example

  OSC
  

  is used for two different controls in different sets: use
  XML Example

  ANSI:OSC
  

  or
  XML Example

  ECMA:OSC
  

  for Operating System Command and
  XML Example

  DIN:OSC
  

  for Optional Syllabification Control.
• The mnemonic
  XML Example

  SOS
  

  is used for two different controls in different sets: use
  XML Example

  ANSI:SOS
  

  or
  XML Example

  ECMA:SOS
  

  for Start of String and
  XML Example

  EBCDIC:SOS
  

  for the S/360 CPU control Start of Significance.

The default link label is the mnemonic, with anything before the last colon removed (so, without any ASCII/ANSI/ECMA/ISO/EBCDIC prefix). This can be overridden by the optional second positional parameter, which should contain the desired link label wikitext.

The above documentation is transcluded from Template:Control code link/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.