\HeaderA{format}{Format Unordered and Ordered Lists}{format}
\aliasA{formatOL}{format}{formatOL}
\aliasA{formatUL}{format}{formatUL}
\keyword{print}{format}
\begin{Description}\relax
Format unordered (itemize) and ordered (enumerate) lists.
\end{Description}
\begin{Usage}
\begin{verbatim}
formatUL(x, label = "*", offset = 0,
         width = 0.9 * getOption("width"))
formatOL(x, type = "arabic", offset = 0, start = 1,
         width = 0.9 * getOption("width"))
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{x}] a character vector of list items.
\item[\code{label}] a character string used for labelling the items.
\item[\code{offset}] a non-negative integer giving the offset (indentation)
of the list.
\item[\code{width}] a positive integer giving the target column for wrapping
lines in the output.
\item[\code{type}] a character string specifying the \sQuote{type} of the
labels in the ordered list.  If \code{"arabic"} (default), arabic
numerals are used.  For \code{"Alph"} or \code{"alph"}, single upper
or lower case letters are employed (in this case, the number of the
last item must not exceed 26.  Finally, for \code{"Roman"} or
\code{"roman"}, the labels are given as upper or lower case roman
numerals (with the number of the last item maximally 3899).
\code{type} can be given as a unique abbreviation of the above, or
as one of the \acronym{HTML} style tokens \code{"1"} (arabic),
\code{"A"}/\code{"a"} (alphabetic), or \code{"I"}/\code{"i"}
(roman), respectively.
\item[\code{start}] a positive integer specifying the starting number of the
first item in an ordered list.
\end{ldescription}
\end{Arguments}
\begin{Value}
A character vector with the formatted entries.
\end{Value}
\begin{SeeAlso}\relax
\code{\LinkA{formatDL}{formatDL}} for formatting description lists.
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
## A simpler recipe.
x <- c("Mix dry ingredients thoroughly.",
       "Pour in wet ingredients.",
       "Mix for 10 minutes.",
       "Bake for one hour at 300 degrees.")
## Format and output as an unordered list.
writeLines(formatUL(x))
## Format and output as an ordered list.
writeLines(formatOL(x))
## Ordered list using lower case roman numerals.
writeLines(formatOL(x, type = "i"))
## Ordered list using upper case letters and some offset.
writeLines(formatOL(x, type = "A", offset = 5))
\end{ExampleCode}
\end{Examples}

