From 21021668fee1d53809ff3c690d0adf04e3353145 Mon Sep 17 00:00:00 2001
From: Karl Berry <karl@freefriends.org>
Date: Sun, 18 Mar 2007 23:45:07 +0000
Subject: enumitem 2.0 (12mar07)

git-svn-id: svn://tug.org/texlive/trunk@4055 c570f23f-e606-0410-a88d-b1316a301751
---
 Master/texmf-dist/doc/latex/enumitem/enumitem.tex | 165 ++++++++++++++++++----
 1 file changed, 140 insertions(+), 25 deletions(-)

(limited to 'Master/texmf-dist/doc/latex/enumitem/enumitem.tex')

diff --git a/Master/texmf-dist/doc/latex/enumitem/enumitem.tex b/Master/texmf-dist/doc/latex/enumitem/enumitem.tex
index 9a638da77c8..d183f61329d 100644
--- a/Master/texmf-dist/doc/latex/enumitem/enumitem.tex
+++ b/Master/texmf-dist/doc/latex/enumitem/enumitem.tex
@@ -1,19 +1,42 @@
+% +--------------------------------------------------+
+% | Typeset this file to document enumitem.sty       |
+% +--------------------------------------------------+
+%
+% Copyright (c) 2003-2007 by Javier Bezos.
+% All Rights Reserved.
+%
+% This file is part of the enumitem distribution release 2.0
+% -----------------------------------------------------------
+% 
+% It may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either version 1.3
+% of this license or (at your option) any later version.
+% The latest version of this license is in
+%   http://www.latex-project.org/lppl.txt
+% and version 1.3 or later is part of all distributions of LaTeX
+% version 2003/12/01 or later.
+% 
+% This work has the LPPL maintenance status "maintained".
+% 
+% The Current Maintainer of this work is Javier Bezos.
+
 \documentclass{article}
 
 \usepackage{hyperref}
 
+%\usepackage{pslatex}
+
 \title{Customizing lists\\with the\\\textsf{enumitem} package}
 
 \author{Javier Bezos\footnote{For bug reports, comments and
-suggestions go to \href{http://www.texytipografia.com/contact.php}%
-{http://www.texytipografia.com/contact.php}, or
-to my postal address: Apartado 116.035, E-28080 Madrid, Spain.
+suggestions go to \href{http://www.texytipografia.com/contact.html}%
+{http://www.texytipografia.com/contact.html}.
 English is not my strong point, so contact me when you
 find mistakes in the manual. Other packages by the same author:
 \textsf{gloss} (with Jos\'e Luis D\'{\i}az), \textsf{accents,
 tensind, esindex, dotlessi, titlesec, titletoc}.}}
 
-\date{Version 1.1\\2005/05/12}
+\date{Version 2.0\\2007/03/12}
 
 \IfFileExists{enumitem.sty}{\usepackage{enumitem}}{}
 
@@ -110,7 +133,6 @@ described below.
 The following new parameters are provided:
 \begin{itemize}
 
-
 \item \verb|font|. Sets the label font. Useful when the label is
 changed with the optional argument of \verb|\item|.
 
@@ -135,6 +157,15 @@ to illustrate what is possible; requires \textsf{color} and
                   start=172]
 \end{verbatim}
 
+\item \verb|label*| is like \verb|label| but its value is appended to 
+the current label. For example, the follollowing defines a 
+\verb|legal| list (1., 1.1., 1.1.1., and so on):
+\begin{verbatim}
+\newlist{legal}{enumerate}{10}
+\setlist[legal]{label*=\arabic*.}
+\end{verbatim}
+
+
 \item \verb|ref|. By default, \verb|label| sets also the form of cross
 references and \verb|\the...|, but you can define a
 different format. For
@@ -295,6 +326,11 @@ Text.
 \end{enumerate}
 \end{verbatim}
 
+\item \verb|resume*| is like \verb|resume| but the options from the
+previous list are used, too.  This option must be restricted to the
+optional argument in a environment (this is the only place where it
+makes sense) and further keys are not allowed.
+
 \item \verb|beginpenalty|, \verb|midpenalty| and \verb|endpenalty| set
 the penalty at the beginning of a list, between items and at the end
 of the list.  Please, refer to your \LaTeX{} or \TeX{} manual about
@@ -302,6 +338,17 @@ how penalties control page breaks. Unlike other parameters, when a
 list starts their values are not reset to the default, thus they
 apply to the enclosed lists, too.
 
+\item \verb|before| and \verb|before*| executes code before the list
+starts (more precisely, in the second argument of the \verb|list|
+environment used to define them).  The former sets the code to be
+executed, overriding any previous value, while the starred form adds
+the code to the existing one (in the setting hierarchy, see below,
+\textit{not} with relation to the enclosing list).  It can contain,
+say, rules and text, but this has not been extensively tested.
+
+\item \verb|after| and \verb|after*| is the same but just before
+the list ends.
+
 \end{itemize}
 
 A key are available in \verb|description|
@@ -385,6 +432,90 @@ No attempt has been made (yet) to discriminate the font size
 (\verb|\normalsize|, \verb|\small|\dots). Suggestions are
 most welcome.
 
+\subsection{\textsf{enumerate}-like labels}
+
+With the package option \texttt{shortlabels} you can use an
+\textsf{enumerate}-like syntax, where \verb|A|, \verb|a|, \verb|I|,
+\verb|i| and \verb|1| stand for \verb|\Alph*|, \verb|\alph*|,
+\verb|\Roman*|, \verb|\roman*| and \verb|\arabic*|.  This is intended
+mainly as a sort of compatibility mode with the \textsf{enumerate}
+package, and therefore the following special rule applies: if the very
+first option (at any level) is not recognized as a valid key, then it
+will be considered a label with the \textsf{enumerate}-like syntax.  For
+example:
+\begin{verbatim}
+\begin{enumerate}[i), labelindent=\parindent]
+...
+\end{enumerate}
+\end{verbatim}
+Although perhaps not so useful, you can omit \verb|label=| in the
+itemize environment under similar conditions, too:
+\begin{verbatim}
+\begin{itemize}[\textbullet]
+...
+\end{itemize}
+\end{verbatim}
+
+In addition, you can define new keys (or redefine them), which is
+particularly useful for enumerate to be adapted to especific
+typographical rules or to extend it for non-Latin scrips:
+\begin{verbatim}
+\SetEnumerateShortLabel{<key>}{<replacement>}
+\end{verbatim}
+where \verb|<replacement>| contains one of the starred versions of 
+counters. For example:
+\begin{verbatim}
+\SetEnumerateShortLabel{i}{\textsc{\roman*}}
+\end{verbatim}
+redefines \verb|i| so that items using this key are numbered with
+small caps roman numerals.
+
+\subsection{Cloning the three basic lists}
+
+As of version 2.0 the three lists can be cloned so that you can 
+define ``logical'' environments behaving like them. To define a
+new lists (or redefine a existing one), use \verb|\newlist| (or 
+\verb|\renewlist|), which the following syntax:
+\begin{verbatim}
+\newlist{<name>}{<type>}{<max-depth>}
+\end{verbatim}
+where \verb|<type>| is \verb|enumerate|, \verb|itemize| or 
+\verb|description|. Then you can (in fact you must, at least the 
+label) set the new list with \verb|\setlist|:
+\begin{verbatim}
+\newlist{ingredients}{itemize}{1}
+\setlist[ingredients]{label=\textbullet}
+\newlist{steps}{enumerate}{2}
+\setlist[steps,1]{label=(\arabic*)}
+\setlist[steps,2]{label=(\arabic*)}
+\end{verbatim}
+The optional argument of \verb|\setlist| has an extended
+syntax---names say which lists applies the settings to, and numbers
+the level.  Do not use this syntax in the three basic lists, but that
+above, except if you redefine them.
+
+\subsection{New counters}
+
+With
+\begin{verbatim}
+\AddEnumerateCounter{<LaTeX counter>}{<TeX count>}{<widest label>}
+\end{verbatim}
+a counter representation is ``registered'' so that \textsf{enumitem}
+recognizes it.  Intended mainly for non Latin scripts, but also useful
+in Latin scripts.  For example:
+\begin{verbatim}
+\def\ctext#1{\expandafter\@ctext\csname c@#1\endcsname}
+\def\@ctext#1{\ifcase#1\or First\or Second\or Third\or
+Fourth\or Fifth\or Sixth\fi}
+\AddEnumerateCounter{\ctext}{\@ctext}{Second}
+\end{verbatim}
+
+\subsection{Package option \texttt{loadonly}}
+
+With this package option the package is loaded but the three
+lists are not redefined. You can create your own lists, yet, or
+even redefine the existing ones.
+
 \section{Three patterns}
 
 Three list layouts could be considered very
@@ -440,7 +571,7 @@ to normal paragraphs.
 \verb|quote|, etc., even if conceptually they are not lists. 
 Unfortunately, \verb|trivlist| uses the current list settings, which 
 has the odd side effect that changing the vertical spacing of lists 
-also changes the spacing in these environments.
+also changes sometimes the spacing in these environments.
 
 This package modifies \verb|trivlist| so that the default settings for 
 the current level (ie, those set by the corresponding \verb|clo| 
@@ -680,7 +811,6 @@ noches, duelos y quebrantos los s\'{a}bados...
 \hrule
 \vskip6pt
 
-
 Same, but with \verb|multiline|. Note the text overlaps if
 the item body is too short.
 
@@ -744,25 +874,10 @@ development of this package has to take it into account.
 
 \subsection{Known issues}
 
-Description styles othen than the default one don't group
+Description styles other than the default one don't group
 labels if they are nested.
 
-\subsection{Changes in 0.2}
-
-If you were using the beta release 0.1, please note version 0.2
-introduced several modifications, which also applies to this
-first release.  The main change is a new syntax for
-\verb|calcsep| and \verb|calcmargin|, but modifying the current files
-is trivial with find and replace (if applied in the given order):
-\begin{itemize}
-\item
-\verb|calcmargin=| becomes \verb|leftmargin=*,widest=|
-\item
-\verb|calcmargin| becomes \verb|leftmargin=*|
-\item
-\verb|calcsep=| becomes \verb|labelsep=*,widest=|
-\item
-\verb|calcsep| becomes \verb|labelsep=*|
-\end{itemize}
+You must use the \LaTeX{} syntax for environments, with \verb|\begin| 
+and \verb|\end|.
 
 \end{document}
-- 
cgit v1.2.3

