Difference between revisions of "Description"

From ConTeXt wiki
(Some header-level changing (for consistency with other pages); added "multi-paragraph item" section (with Howto? in place of answer).)
(Added empty line after paragraph delimited descriptions.)
 
(24 intermediate revisions by 17 users not shown)
Line 1: Line 1:
< [[From LaTeX to ConTeXt]] >
+
< [[From LaTeX to ConTeXt]] | [[Structurals]] >
  
 
= Basic Description Lists =
 
= Basic Description Lists =
Line 5: Line 5:
 
== 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 <tt>\item</tt> 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.
+
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 11:
 
\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 24:
 
== 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 <cmd>setupdescription</cmd> or <cmd>definedescription</cmd>.  The <cmd>definedescription</cmd> 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 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.
  
<texcode>
+
<context source=yes>
 
\definedescription[latexdesc][
 
\definedescription[latexdesc][
  headstyle=bold,style=normal,align=left,location=hanging,
+
    headstyle=bold, style=normal, align=flushleft, alternative=hanging,  
  width=broad,margin=1cm]
+
    width=broad, margin=1cm]
 
 
\starttext
 
\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
+
\latexdesc{Short} This is a shorter item label, and some text that
text is not started a specified distance in -- unlike with other lists -- but
+
    talks about it. The text is wrapped into a paragraph, with  
is spaced a fixed distance from the end of the label.
+
    successive lines indented.
  
\stoptext
+
\latexdesc{Rather longer label} This is a longer item label. As you
</texcode>
+
    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.
  
<context>
 
\definedescription[latexdesc][
 
  headstyle=bold,style=normal,align=left,location=hanging,
 
  width=broad,margin=1cm]
 
 
\starttext
 
\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.
 
 
\stoptext
 
 
</context>
 
</context>
  
The empty lines (or <cmd>par</cmd>) after each description (here, <tt>\latexdesc</tt>) line are required.
+
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 90: Line 77:
 
== ConTeXt ==
 
== ConTeXt ==
  
{{Howto}}
+
Multiple paragraphs (without first line indenting) can be created as follows:
 +
 
 +
<context source=yes>
 +
\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
 +
</context>
  
  
Line 105: Line 114:
 
\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.
+
    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
  text is not started a specified distance in -- unlike with other lists -- but
+
    paragraph simply starts 6em in.
  is spaced a fixed distance from the end of the label.
 
 
\end{basedescript}
 
\end{basedescript}
 
\end{document}
 
\end{document}
 
</texcode>
 
</texcode>
 
  
 
== ConTeXt ==
 
== ConTeXt ==
Line 119: Line 126:
 
sets the label to 5em:
 
sets the label to 5em:
  
<texcode>
+
<context source=yes>
 
\definedescription[notation][
 
\definedescription[notation][
   headstyle=bold,style=normal,align=left,location=hanging,
+
   headstyle=bold, style=normal, align=flushleft, alternative=hanging,  
 
   width=5em]
 
   width=5em]
</texcode>
 
  
<context>
+
\notation{Short} This is a shorter item label, and some text that talks
\definedescription[notation][
+
    about it. The text is wrapped into a paragraph, with successive
  headstyle=bold,style=normal,align=left,location=hanging,
+
    lines indented.
  width=5em]
+
 
 +
\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]
  
\starttext
+
\Desc{Short} This item's short label is set above the paragraph. The
\notation{Short} This is a shorter item label, and some text that talks about it.
+
    paragraph starts 1cm in.
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
+
\Desc{Rather longer label} This item's rather longer label is also set
text is not started a specified distance in -- unlike with other lists -- but
+
    above the paragraph. The paragraph starts 1cm in.
is spaced a fixed distance from the end of the label.
 
  
\stoptext
 
 
</context>
 
</context>
 +
 +
== See also ==
 +
* {{cmd|definedescription}}
 +
* {{cmd|startdescription}}

Latest revision as of 00:42, 16 January 2018

< From LaTeX to ConTeXt | Structurals >

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.

See also