Difference between revisions of "Description"
(→ConTeXt: Mutli-para descriptions) |
|||
(21 intermediate revisions by 15 users not shown) | |||
Line 1: | Line 1: | ||
− | |||
− | |||
= Basic Description Lists = | = Basic Description Lists = | ||
== LaTeX == | == LaTeX == | ||
− | LaTeX provides a <tt>description</tt> environment, which works just like an itemized or enumerated list except that the item labels are specified by an (optional) argument to the | + | LaTeX provides a <tt>description</tt> environment, which works just like an itemized or enumerated list except that the item labels are specified by an (optional) argument to the {{cmd|item}} command, rather than being automatically generated. This is useful for making lists of definitions and other sorts of descriptions that are headed by a keyword. |
<texcode> | <texcode> | ||
Line 11: | Line 9: | ||
\begin{document} | \begin{document} | ||
\begin{description} | \begin{description} | ||
− | \item[Short] This is a shorter item label, and some text that talks about it. | + | \item[Short] This is a shorter item label, and some text that talks |
− | The text is wrapped into a paragraph, with successive lines indented. | + | about it. The text is wrapped into a paragraph, with successive |
− | \item[Rather longer label] This is a longer item label. As you can see, the | + | lines indented. |
− | text is not started a specified distance in -- unlike with other lists -- but | + | \item[Rather longer label] This is a longer item label. As you can |
− | is spaced a fixed distance from the end of the label. | + | see, the text is not started a specified distance in -- unlike |
+ | with other lists -- but is spaced a fixed distance from the end | ||
+ | of the label. | ||
\end{description} | \end{description} | ||
\end{document} | \end{document} | ||
Line 22: | Line 22: | ||
== ConTeXt == | == ConTeXt == | ||
− | ConTeXt provides a similar mechanism. Unlike the LaTeX version, ConTeXt's description mechanism does not enclose the items in an environment, but instead formats them independently according to formats given in | + | ConTeXt provides a similar mechanism. Unlike the LaTeX version, ConTeXt's description mechanism does not enclose the items in an environment, but instead formats them independently according to formats given in {{cmd|setupdescriptions}} or {{cmd|definedescription}}. The {{cmd|definedescription}} latter command is used to define a named description class, which can later be called using its name. This example defines a <tt>latexdesc</tt> description, with parameters that roughly approximate the LaTeX defaults. |
− | < | + | <context source=yes> |
\definedescription[latexdesc][ | \definedescription[latexdesc][ | ||
− | + | headstyle=bold, style=normal, align=flushleft, alternative=hanging, | |
− | + | width=broad, margin=1cm] | |
− | + | \latexdesc{Short} This is a shorter item label, and some text that | |
− | \latexdesc{Short} This is a shorter item label, and some text that talks about it. | + | talks about it. The text is wrapped into a paragraph, with |
− | The text is wrapped into a paragraph, with successive lines indented. | + | successive lines indented. |
− | \latexdesc{Rather longer label} This is a longer item label. | + | \latexdesc{Rather longer label} This is a longer item label. As you |
− | text is not started a specified distance in -- unlike with other lists -- but | + | can see, the text is not started a specified distance in -- unlike |
− | is spaced a fixed distance from the end of the label. | + | with other lists -- but is spaced a fixed distance from the end of |
+ | the label. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</context> | </context> | ||
− | The empty lines (or | + | The empty lines (or {{cmd|par}}) after each description (here, <tt>\latexdesc</tt>) line are required. |
The <tt>margin=<i>dimension</i></tt> key specifies the hanging indentation for lines after the first line. In addition, the separation between the label and the text can be specified using a <tt>distance=<i>dimension</i></tt> key. | The <tt>margin=<i>dimension</i></tt> key specifies the hanging indentation for lines after the first line. In addition, the separation between the label and the text can be specified using a <tt>distance=<i>dimension</i></tt> key. | ||
+ | |||
= Multi-Paragraph Descriptions = | = Multi-Paragraph Descriptions = | ||
Line 92: | Line 77: | ||
Multiple paragraphs (without first line indenting) can be created as follows: | Multiple paragraphs (without first line indenting) can be created as follows: | ||
− | < | + | <context source=yes> |
\definedescription[descr][ | \definedescription[descr][ | ||
− | headstyle=bold,style=normal,align= | + | headstyle=bold, style=normal, align=flushleft, alternative=hanging, |
− | width=broad,margin=1cm] | + | width=broad, margin=1cm] |
− | |||
\startdescr{Para} | \startdescr{Para} | ||
This is a shorter item label, and some text that talks about it. | This is a shorter item label, and some text that talks about it. | ||
Line 104: | Line 88: | ||
This is another paragraph under the "Para" item. | This is another paragraph under the "Para" item. | ||
\startdescr{Sub Item} | \startdescr{Sub Item} | ||
− | This is a description of an item which is within the | + | This is a description of an item which is within the "Para" item. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
\stopdescr | \stopdescr | ||
\startdescr{Sub Item} | \startdescr{Sub Item} | ||
Line 141: | Line 97: | ||
A short item that's not part of that really long "Para" item. | A short item that's not part of that really long "Para" item. | ||
\stopdescr | \stopdescr | ||
+ | </context> | ||
− | |||
− | |||
= Descriptions with Fixed Label Width = | = Descriptions with Fixed Label Width = | ||
Line 157: | Line 112: | ||
\begin{basedescript}{\desclabelstyle{\pushlabel}\desclabelwidth{6em}} | \begin{basedescript}{\desclabelstyle{\pushlabel}\desclabelwidth{6em}} | ||
\item[Short] This is a shorter item label, and some text that talks about it. | \item[Short] This is a shorter item label, and some text that talks about it. | ||
− | + | The text is wrapped into a paragraph, with successive lines indented. | |
\item[Rather longer label] This is a longer item label. As you can see, the | \item[Rather longer label] This is a longer item label. As you can see, the | ||
− | + | paragraph simply starts 6em in. | |
− | |||
\end{basedescript} | \end{basedescript} | ||
\end{document} | \end{document} | ||
</texcode> | </texcode> | ||
− | |||
== ConTeXt == | == ConTeXt == | ||
Line 171: | Line 124: | ||
sets the label to 5em: | sets the label to 5em: | ||
− | < | + | <context source=yes> |
\definedescription[notation][ | \definedescription[notation][ | ||
− | headstyle=bold,style=normal,align= | + | headstyle=bold, style=normal, align=flushleft, alternative=hanging, |
width=5em] | width=5em] | ||
− | |||
− | <context> | + | \notation{Short} This is a shorter item label, and some text that talks |
− | \definedescription[ | + | about it. The text is wrapped into a paragraph, with successive |
− | + | lines indented. | |
− | + | ||
+ | \notation{Rather longer label} This is a longer item label. As you can | ||
+ | see, the paragraph simply pretends the label is 5em wide. | ||
+ | |||
+ | </context> | ||
+ | |||
+ | Another example: | ||
+ | |||
+ | <context source=yes> | ||
+ | \setupcolors[state=start] | ||
+ | \definedescription[Desc][alternative=top, hang=20, | ||
+ | headstyle=bold, headcolor=blue | ||
+ | command=\hskip-1cm, margin=1cm] | ||
− | \ | + | \Desc{Short} This item's short label is set above the paragraph. The |
− | + | paragraph starts 1cm in. | |
− | |||
− | \ | + | \Desc{Rather longer label} This item's rather longer label is also set |
− | + | above the paragraph. The paragraph starts 1cm in. | |
− | |||
− | |||
</context> | </context> | ||
− | + | == See also == | |
− | + | * {{cmd|definedescription}} | |
− | + | * {{gen|startdescription}} | |
− | + | ||
− | + | ||
− | + | [[Category:Basics]] | |
− | + | ||
− | + | [[Category:From LaTeX]] | |
− | |||
− | [[ |
Latest revision as of 11:32, 30 August 2020
Contents
Basic Description Lists
LaTeX
LaTeX provides a description environment, which works just like an itemized or enumerated list except that the item labels are specified by an (optional) argument to the \item command, rather than being automatically generated. This is useful for making lists of definitions and other sorts of descriptions that are headed by a keyword.
\documentclass{article} \begin{document} \begin{description} \item[Short] This is a shorter item label, and some text that talks about it. The text is wrapped into a paragraph, with successive lines indented. \item[Rather longer label] This is a longer item label. As you can see, the text is not started a specified distance in -- unlike with other lists -- but is spaced a fixed distance from the end of the label. \end{description} \end{document}
ConTeXt
ConTeXt provides a similar mechanism. Unlike the LaTeX version, ConTeXt's description mechanism does not enclose the items in an environment, but instead formats them independently according to formats given in \setupdescriptions or \definedescription. The \definedescription latter command is used to define a named description class, which can later be called using its name. This example defines a latexdesc description, with parameters that roughly approximate the LaTeX defaults.
\definedescription[latexdesc][ headstyle=bold, style=normal, align=flushleft, alternative=hanging, width=broad, margin=1cm] \latexdesc{Short} This is a shorter item label, and some text that talks about it. The text is wrapped into a paragraph, with successive lines indented. \latexdesc{Rather longer label} This is a longer item label. As you can see, the text is not started a specified distance in -- unlike with other lists -- but is spaced a fixed distance from the end of the label.
The empty lines (or \par) after each description (here, \latexdesc) line are required.
The margin=dimension key specifies the hanging indentation for lines after the first line. In addition, the separation between the label and the text can be specified using a distance=dimension key.
Multi-Paragraph Descriptions
LaTeX
Because the LaTeX description mechanism is an environment, it is simple to include multiple paragraphs in a description environment, or even to embed sub-lists. For instance, consider the following example:
\documentclass{article} \begin{document} \begin{description} \item[Para] This is a shorter item label, and some text that talks about it. The text is wrapped into a paragraph, with successive lines indented. This is another paragraph under the "Para" item. \begin{description} \item[Sub-Item] This is a description of an item which is within the "Para" item. \item[Sub-Item] Another sub-item. \end{description} \item[Short] A short item that's not part of that really long "Para" item. \end{description} \end{document}
In this example, the code indentation has been used to illustrate the alignment of the typeset output. Everything between \item[Para]
and \item[Short]
is part of the "Para" item, and is indented by the same amount. The embedded description then embeds any following lines on the "Sub-Item"s by an additional indentation, as one would expect.
ConTeXt
Multiple paragraphs (without first line indenting) can be created as follows:
\definedescription[descr][ headstyle=bold, style=normal, align=flushleft, alternative=hanging, width=broad, margin=1cm] \startdescr{Para} This is a shorter item label, and some text that talks about it. The text is wrapped into a paragraph, with successive lines indented. This is another paragraph under the "Para" item. \startdescr{Sub Item} This is a description of an item which is within the "Para" item. \stopdescr \startdescr{Sub Item} Another Sub Item \stopdescr \stopdescr \startdescr{Short} A short item that's not part of that really long "Para" item. \stopdescr
Descriptions with Fixed Label Width
LaTeX
In LaTeX, the mdwlist package can be used to set a fixed label width.
\documentclass{article} \usepackage{mdwlist} \begin{document} \begin{basedescript}{\desclabelstyle{\pushlabel}\desclabelwidth{6em}} \item[Short] This is a shorter item label, and some text that talks about it. The text is wrapped into a paragraph, with successive lines indented. \item[Rather longer label] This is a longer item label. As you can see, the paragraph simply starts 6em in. \end{basedescript} \end{document}
ConTeXt
Using an explicit dimension as argument for the 'width' parameter sets the label to 5em:
\definedescription[notation][ headstyle=bold, style=normal, align=flushleft, alternative=hanging, width=5em] \notation{Short} This is a shorter item label, and some text that talks about it. The text is wrapped into a paragraph, with successive lines indented. \notation{Rather longer label} This is a longer item label. As you can see, the paragraph simply pretends the label is 5em wide.
Another example:
\setupcolors[state=start] \definedescription[Desc][alternative=top, hang=20, headstyle=bold, headcolor=blue command=\hskip-1cm, margin=1cm] \Desc{Short} This item's short label is set above the paragraph. The paragraph starts 1cm in. \Desc{Rather longer label} This item's rather longer label is also set above the paragraph. The paragraph starts 1cm in.