Difference between revisions of "Template:Cmd"

From ConTeXt wiki
m (Make examples consistent.)
(Move documentation to /doc page)
Line 1: Line 1:
<onlyinclude><tt>[[Command/{{{1}}}|\{{{1}}}]]{{{2|}}}</tt></onlyinclude>
+
<onlyinclude><tt>[[Command/{{{1}}}|\{{{1}}}]]{{{2|}}}</tt></onlyinclude><noinclude>
 
 
 
----
 
----
 
+
{{documentation}}
Link to a command; any text in the second template parameter is comes right after the command, in typewriter font. Passing parameters is optional.
+
</noinclude>
 
 
Usage:
 
 
 
    <nowiki>{{cmd|startalignment}}</nowiki>
 
    <nowiki>{{cmd|startalignment|[middle]}}</nowiki>
 
    <nowiki>{{cmd|section|{First section}}}</nowiki>
 
 
 
Result:
 
 
 
    <nowiki><tt>[[Command/startalignment|\startalignment]]</tt></nowiki>
 
    <nowiki><tt>[[Command/startalignment|\startalignment]][middle]</tt></nowiki>
 
    <nowiki><tt>[[Command/startalignment|\startalignment]]{First section}</tt></nowiki>
 
 
 
 
 
Display:
 
 
 
* {{cmd|startalignment}}
 
* {{cmd|startalignment|[middle]}}
 
* {{cmd|section|{First section}}}
 

Revision as of 12:32, 20 July 2012

[[Command/{{{1}}}|\{{{1}}}]]


[edit] [history] [purge] Documentation icon Template documentation

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.