Difference between revisions of "Template:Cmd/doc"

From Wiki
Jump to navigation Jump to search
(Update documentation to reflect new link=no parameter)
(non-breaking space prevents ugly break)
Line 3: Line 3:
 
Link to a ConTeXt command in the [[:Category:Commands|command reference]]. You can mention some parameters while you're at it; and you can mention the command without linking to it by specifying {{code|1=link=no}}.
 
Link to a ConTeXt command in the [[:Category:Commands|command reference]]. You can mention some parameters while you're at it; and you can mention the command without linking to it by specifying {{code|1=link=no}}.
  
When the text passed to one of the template parameters contains an equals sign, you must explicitly address that template parameter by name or number. This will usually happen with template parameter 2, which is used to specify the ConTeXt parameters.
+
When the text passed to one of the template parameters contains an equals sign, you must explicitly address that template parameter by name or number. This will usually happen with template parameter 2, which is used to specify the ConTeXt parameters.
  
 
Usage:
 
Usage:

Revision as of 13:39, 20 July 2012

Link to a ConTeXt command in the command reference. You can mention some parameters while you're at it; and you can mention the command without linking to it by specifying link=no.

When the text passed to one of the template parameters contains an equals sign, you must explicitly address that template parameter by name or number. This will usually happen with template parameter 2, which is used to specify the ConTeXt parameters.

Usage:

   {{cmd|framed}}
   {{cmd|framed|{text}}}
   {{cmd|framed|2=[width=2em]{text}}}
   {{cmd|framed|link=no}}
   {{cmd|framed|2=[width=2em]{text}|link=no}}
   {{cmd|framed|2=[width=2em]{text}|link=stuff}}

Result:

   <tt>[[Command/framed|\framed]]</tt>
   <tt>[[Command/framed|\framed]]{text}</tt>
   <tt>[[Command/framed|\framed]][width=2em]{text}</tt>
   <tt>\framed</tt>
   <tt>\framed[width=2em]{text}</tt>
   (A warning)

Display:

  • \framed
  • \framed{text}
  • \framed[width=2em]{text}
  • \framed
  • \framed[width=2em]{text}
  • Error in {{cmd}} template: the only valid values for link are yes, no, or leaving it unspecified.