Difference between revisions of "Command/ description"
< Command
Jump to navigation
Jump to search
(Created page with "Documentation for \<i>description</i>") |
|||
Line 1: | Line 1: | ||
− | |||
− | |||
<cd:commandgroup generated="yes" name="description" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807"> | <cd:commandgroup generated="yes" name="description" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807"> | ||
− | <cd:shortdesc> | + | <cd:shortdesc><!-- a short command summary goes here --> |
− | <!-- a short command summary goes here --> | + | The instances of <tt>\<i>description</i></tt> are defined by {{cmd|definedescription}} |
− | The instances of <tt>\<i>description</i></tt> are | ||
</cd:shortdesc> | </cd:shortdesc> | ||
<cd:sequence> | <cd:sequence> | ||
Line 28: | Line 25: | ||
</cd:command> | </cd:command> | ||
</cd:variants> | </cd:variants> | ||
− | <cd:description> | + | <cd:description>Actually there is no predefined command <tt>\description</tt>. Instead, you can use {{cmd|definedescription}} to define a command (whose name is arbitrary) to typeset a headword as distinct from its description. |
− | < | + | |
+ | Note: You can use <tt>\par</tt> to separate the items, but a better idea is to use the {{gen|startdescription}} form of the defined instance. | ||
+ | |||
</cd:description> | </cd:description> | ||
− | <cd:examples> | + | <cd:examples><cd:example title=""><context source="yes"> |
− | + | \definedescription[description][location=top,headstyle=bold] | |
− | <cd:example title=""> | + | \description{icon} |
− | < | + | An icon is a representation of an action or the name of a computer |
− | + | program. Icons are frequently used in operating systems on several | |
− | </ | + | computer platforms. \par |
− | <cd: | + | </context></cd:example></cd:examples> |
− | + | <cd:notes></cd:notes> | |
− | <cd: | ||
− | < | ||
− | |||
− | </cd:notes> | ||
<cd:seealso> | <cd:seealso> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<cd:commandref name="_startdescription" originator="system"></cd:commandref> | <cd:commandref name="_startdescription" originator="system"></cd:commandref> | ||
<cd:commandref name="definedescription" originator="system"></cd:commandref> | <cd:commandref name="definedescription" originator="system"></cd:commandref> | ||
<cd:commandref name="setupdescription" originator="system"></cd:commandref> | <cd:commandref name="setupdescription" originator="system"></cd:commandref> | ||
− | <cd:source file="strc-des.mkvi" originator="system"></cd:source> | + | <cd:source file="strc-des.mkvi" originator="system"></cd:source> |
− | <cd:wikipage originator="system" page="Category:Structure"></cd:wikipage> | + | <cd:wikipage originator="system" page="Category:Structure"></cd:wikipage></cd:seealso> |
− | </cd:seealso> | ||
</cd:commandgroup> | </cd:commandgroup> |
Latest revision as of 11:42, 30 August 2020
Contents
\description
Summary
The instances of \description are defined by \definedescription
Settings example
Description
Actually there is no predefined command \description. Instead, you can use \definedescription to define a command (whose name is arbitrary) to typeset a headword as distinct from its description.
Note: You can use \par to separate the items, but a better idea is to use the startdescription form of the defined instance.
Examples
Example 1
\definedescription[description][location=top,headstyle=bold] \description{icon} An icon is a representation of an action or the name of a computer program. Icons are frequently used in operating systems on several computer platforms. \par