diff options
author | Karl Berry <karl@freefriends.org> | 2016-11-18 23:20:01 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2016-11-18 23:20:01 +0000 |
commit | 721b1dbe9754ce2f222164010982be4e784f05f3 (patch) | |
tree | 864b50996dec726f8fa79d3a2b8be79fa2bc799a /Master/texmf-dist/doc/generic/listofitems/listofitems-en.tex | |
parent | d7711554f1e7c2b8a7dfb9324494e705539c48b2 (diff) |
listofitems (18nov16)
git-svn-id: svn://tug.org/texlive/trunk@42530 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/generic/listofitems/listofitems-en.tex')
-rw-r--r-- | Master/texmf-dist/doc/generic/listofitems/listofitems-en.tex | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/Master/texmf-dist/doc/generic/listofitems/listofitems-en.tex b/Master/texmf-dist/doc/generic/listofitems/listofitems-en.tex index 2f4b2d5449b..72f24c410df 100644 --- a/Master/texmf-dist/doc/generic/listofitems/listofitems-en.tex +++ b/Master/texmf-dist/doc/generic/listofitems/listofitems-en.tex @@ -119,7 +119,7 @@ \vskip2cm \leftskip=.2\linewidth \rightskip=.2\linewidth \small This simple package is designed to read a list of items whose - parsing character may be selected by the user. + parsing separator may be selected by the user. Once the list is read, its items are stored in a structure that behaves as a dimensioned array. As such, it becomes very easy to access an item @@ -145,27 +145,27 @@ and under (pdf)(Xe)(Lua)\TeX {} by way of \code|\input listofitems.tex| \section{Read a Simple List} -\paragraph{Set the parsing character} -The default parsing character is the comma and if we want change it, we must do so +\paragraph{Set the parsing separator} +The default parsing separator is the comma and if we want change it, we must do so before reading a list of items, with the definition - \verb|\setsepchar{<parse-character>}|. -A \verb|<parse-character>| is a set of tokens which possess catcodes different from + \verb|\setsepchar{<parsing-separator>}|. +A \verb|<parsing-separator>| is a set of tokens which possess catcodes different from 1 and 2 (the opening and closing braces), 14 (usually \verb|%|) and 15. The token of catcode 6 (usually \verb|#|) is accepted only if it is followed by an integer, denoting the argument of a macro; -In no case should this token be provided alone as the \verb|<parse-character>|. +In no case should this token be provided alone as the \verb|<parsing-separator>|. Commands can be included in this set of tokens, including the \TeX{} primitive \verb|\par|.% \smallbreak -The parsing-character \verb|<delimiter>| ``\verb-/-'' is reserved by default +The parsing-separator \verb|<delimiter>| ``\verb-/-'' is reserved by default for nested lists (see page 3). %\ref{nested.list.delimiters}). It is therefore not proper to write "\verb-\setsepchar{/}-" because the \listofitems{} package would misunderstand that you want to read a nested list. -To set ``\verb-/-'' as the \verb|<parse-character>| for a simple list, +To set ``\verb-/-'' as the \verb|<parsing-separator>| for a simple list, it is necessary, using the optional argument, to choose - a different parsing-character \verb|<delimiter>| for nested lists, + a different parsing-separator \verb|<delimiter>| for nested lists, for example ``\verb|.|'', and write ``\verb+\setsepchar[.]{/}+''. \medbreak @@ -220,13 +220,13 @@ Otherwise, a compilation error occurs. If the index is empty, \verb|\foo[]| produces the complete \verb|<list>|. The macro \verb|\foosep| is created. It is used with the syntax - \verb|\foosep[<index>]| and allows access to the parse-character that follows the + \verb|\foosep[<index>]| and allows access to the parsing-separator that follows the item of rank \verb|<index>|. -The last parse-character (the one following the last item) is implicitly +The last parsing-separator (the one following the last item) is implicitly defined by \listofitems. If the \verb|<index>| is empty, \verb|\foosep[]| is empty. -\paragraph{Select several possible parsing characters} +\paragraph{Select several possible parsing separators} To specify several possible separators, use the \textbf{OR} operator, denoted ``\verb-||-''. One can use this feature, for example, to isolate the terms in an @@ -234,10 +234,10 @@ One can use this feature, for example, to isolate the terms in an \exemple/\setsepchar{+||-} \readlist\term{17-8+4-11} -1) \term[1] (parse character = \termsep[1])\par -2) \term[2] (parse character = \termsep[2])\par -3) \term[3] (parse character = \termsep[3])\par -4) \term[4] (parse character = \termsep[4])/ +1) \term[1] (parsing separator = \termsep[1])\par +2) \term[2] (parsing separator = \termsep[2])\par +3) \term[3] (parsing separator = \termsep[3])\par +4) \term[4] (parsing separator = \termsep[4])/ \paragraph{Number of items} If we write \verb|\readlist<macro-list>{<list>}|, then the macro \verb|<macro-list>len| @@ -314,7 +314,7 @@ The \verb|<variable>| is a macro chosen by the user that will loop over the valu The macro \verb|<variable>cnt| represents the sequence number of the item in \verb|<variable>|. -\exemple|\setsepchar{ }% parse-character = space +\exemple|\setsepchar{ }% parsing-separator = space \readlist\phrase{One phrase to test.} \foreachitem\word\in\phrase{List item number \wordcnt{}: \word\par}| @@ -324,7 +324,7 @@ The \verb|\itemtomacro<macro-list>[index]<macro>| assigns to the \verb|<macro>| The \verb|<macro>| thus defined is purely expandable provided that the tokens in the items are expandable. -\exemple|\setsepchar{ }% parse-character = space +\exemple|\setsepchar{ }% parsing-separator = space \readlist\phrase{One phrase to test.} \itemtomacro\phrase[2]\aword \meaning\aword\par @@ -334,24 +334,24 @@ The \verb|<macro>| thus defined is purely expandable provided that the tokens \section{Nested Lists} We speak of a list being ``nested'' when asking \listofitems to read a list where the items are, in turn, understood as being a list (implying a parsing - character different from the top-tier list). + separator different from the top-tier list). The nesting depth is not limited, but in practice, a depth of 2 or 3 will usually suffice. -\paragraph{Defining the parsing characters}\label{nested.list.delimiters} +\paragraph{Defining the parsing separators}\label{nested.list.delimiters} To indicate that a list will be nested, so that the list parsing will be performed recursively, one must specify multiple - parsing characters, each corresponding to the particular tier of nesting. -This list of parsing characters is itself given as a delimited list to + parsing separators, each corresponding to the particular tier of nesting. +This list of parsing separators is itself given as a delimited list to the macro \verb|\setsepchar|, with the syntax - \verb|\setsepchar[<delimiter>]{<delimited-list-of-parse-characters>}|. + \verb|\setsepchar[<delimiter>]{<delimited-list-of-parsing-separators>}|. By default, the \verb|<delimiter>| is ``\texttt{/}''. Thus, writing \code|\setsepchar{\\/,/ }| -indicates a recursive depth of 3, with the parsing-character list delimiter defaulting +indicates a recursive depth of 3, with the parsing-separator list delimiter defaulting to ``\texttt{/}'': \begin{itemize}[itemsep=0pt,topsep=0pt,partopsep=0pt,parsep=0pt,label=---] @@ -444,10 +444,10 @@ g) \showitems\baz[3,5]| \paragraph{Empty items and extreme (leading/trailing) spaces} The removal of empty items and/or leading/\allowbreak trailing spaces will occur in \emph{all} the items, regardless of the degree of nesting. -It is clear that a space, ``\verb*| |'', is useless as a parsing character if you want +It is clear that a space, ``\verb*| |'', is useless as a parsing separator if you want to use \verb|\readlist*|. Therefore, in the following example, ``\verb|*|'' is instead selected as the (3rd-tier) - parsing character. + parsing separator. Further, we remove only the extreme spaces, but retain empty items. |