Description List

A LaTeX like environment for creating description lists. This environment can be nested to create sub lists. The term can be comprised of text, blocks of text, or images.

lists module

\begin{description}[style=cssnames]
  \item{term}{text}
     :
  \begin{item}{term}
      ...
  \end{item}
     :
\end{description}

Creates a description type list which includes a term and a description for the term. The list items are specified using one or more \item commands or one or more item environments. For the environment version, the description is provided as the enclosed content.

Key:

style

The name of one or more style classes that are appended to the class name of the list. This allows for additional styling of the default list. For example, style=medskip will add 1ex of additional vertical space between the list items. The current styles defined for a description list that style the entire list are provided below:

Value	Description
paramitems	vertically spaces the list and list items for paragraph type items.


noskip	use the standard spacing between list items.
smallskip	adds a small amount of vertical spacing between list items.
medskip	adds 1ex of vertical spacing between list items.
bigskip	adds 1.5ex of vertical spacing between list items.
largeskip	adds 2ex of vertical spacing between list items.
hugeskip	adds 3ex of vertical spacing between list items.


indent	indents the list a small amount.
bigindent	indents the list double the @@indent@@ style
wideindent	indents the list triple the @@indent@@ style


highlight	highlights the list item with a light gray background.

Styles are also provided that define the format for styling the term component of the items. These include the following:

Value	Description
plainterm	use the current font.
monoterm	use a fixed courier like font.
mathterm	use a math font.

Plugin: DescriptionList

Example

source

\begin{description}[style=monoterm]
\item{First Item}{The description for the first item.}
\item{Second Item}
{The description for the second item.}
\begin{item}{Another Term}
This is the definition of the term.
\end{item}
\end{description}

First Item: The description for the first item.
Second Item: The description for the second item.
Another Term: This is the definition of the term.

results

☰ Click for Table of Contents	BookWiki Documentation	Wiki Plugin Reference