diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/l3kernel/l3seq.dtx')
-rw-r--r-- | Master/texmf-dist/source/latex/l3kernel/l3seq.dtx | 326 |
1 files changed, 163 insertions, 163 deletions
diff --git a/Master/texmf-dist/source/latex/l3kernel/l3seq.dtx b/Master/texmf-dist/source/latex/l3kernel/l3seq.dtx index 601083909e5..3044da987cd 100644 --- a/Master/texmf-dist/source/latex/l3kernel/l3seq.dtx +++ b/Master/texmf-dist/source/latex/l3kernel/l3seq.dtx @@ -43,7 +43,7 @@ % }^^A % } % -% \date{Released 2023-05-15} +% \date{Released 2023-05-22} % % \maketitle % @@ -61,29 +61,29 @@ % % \begin{function}{\seq_new:N, \seq_new:c} % \begin{syntax} -% \cs{seq_new:N} \meta{sequence} +% \cs{seq_new:N} \meta{seq~var} % \end{syntax} -% Creates a new \meta{sequence} or raises an error if the name is -% already taken. The declaration is global. The \meta{sequence} +% Creates a new \meta{seq~var} or raises an error if the name is +% already taken. The declaration is global. The \meta{seq~var} % initially contains no items. % \end{function} % % \begin{function}{\seq_clear:N, \seq_clear:c, \seq_gclear:N, \seq_gclear:c} % \begin{syntax} -% \cs{seq_clear:N} \meta{sequence} +% \cs{seq_clear:N} \meta{seq~var} % \end{syntax} -% Clears all items from the \meta{sequence}. +% Clears all items from the \meta{seq~var}. % \end{function} % % \begin{function} % {\seq_clear_new:N, \seq_clear_new:c, \seq_gclear_new:N, \seq_gclear_new:c} % \begin{syntax} -% \cs{seq_clear_new:N} \meta{sequence} +% \cs{seq_clear_new:N} \meta{seq~var} % \end{syntax} -% Ensures that the \meta{sequence} exists globally by applying +% Ensures that the \meta{seq~var} exists globally by applying % \cs{seq_new:N} if necessary, then applies % \cs[index=seq_clear:N]{seq_(g)clear:N} to leave -% the \meta{sequence} empty. +% the \meta{seq~var} empty. % \end{function} % % \begin{function} @@ -92,10 +92,10 @@ % \seq_gset_eq:NN, \seq_gset_eq:cN, \seq_gset_eq:Nc, \seq_gset_eq:cc % } % \begin{syntax} -% \cs{seq_set_eq:NN} \meta{sequence_1} \meta{sequence_2} +% \cs{seq_set_eq:NN} \meta{seq~var_1} \meta{seq~var_2} % \end{syntax} -% Sets the content of \meta{sequence_1} equal to that of -% \meta{sequence_2}. +% Sets the content of \meta{seq~var_1} equal to that of +% \meta{seq~var_2}. % \end{function} % % \begin{function}[added = 2014-07-17] @@ -108,9 +108,9 @@ % \seq_gset_from_clist:Nn, \seq_gset_from_clist:cn % } % \begin{syntax} -% \cs{seq_set_from_clist:NN} \meta{sequence} \meta{comma-list} +% \cs{seq_set_from_clist:NN} \meta{seq~var} \meta{comma-list} % \end{syntax} -% Converts the data in the \meta{comma list} into a \meta{sequence}: +% Converts the data in the \meta{comma list} into a \meta{seq~var}: % the original \meta{comma list} is unchanged. % \end{function} % @@ -130,16 +130,16 @@ % \seq_gset_split:Nnn, \seq_gset_split:NnV % } % \begin{syntax} -% \cs{seq_set_split:Nnn} \meta{sequence} \Arg{delimiter} \Arg{token list} +% \cs{seq_set_split:Nnn} \meta{seq~var} \Arg{delimiter} \Arg{token list} % \end{syntax} % Splits the \meta{token list} into \meta{items} separated -% by \meta{delimiter}, and assigns the result to the \meta{sequence}. +% by \meta{delimiter}, and assigns the result to the \meta{seq~var}. % Spaces on both sides of each \meta{item} are ignored, % then one set of outer braces is removed (if any); % this space trimming behaviour is identical to that of % \pkg{l3clist} functions. Empty \meta{items} are preserved by % \cs{seq_set_split:Nnn}, and can be removed afterwards using -% \cs{seq_remove_all:Nn} \meta{sequence} |{}|. +% \cs{seq_remove_all:Nn} \meta{seq~var} |{}|. % The \meta{delimiter} may not contain |{|, |}| or |#| % (assuming \TeX{}'s normal category code r\'egime). % If the \meta{delimiter} is empty, the \meta{token list} is split @@ -153,15 +153,15 @@ % \seq_gset_split_keep_spaces:Nnn, \seq_gset_split_keep_spaces:NnV % } % \begin{syntax} -% \cs{seq_set_split_keep_spaces:Nnn} \meta{sequence} \Arg{delimiter} \Arg{token list} +% \cs{seq_set_split_keep_spaces:Nnn} \meta{seq~var} \Arg{delimiter} \Arg{token list} % \end{syntax} % Splits the \meta{token list} into \meta{items} separated -% by \meta{delimiter}, and assigns the result to the \meta{sequence}. +% by \meta{delimiter}, and assigns the result to the \meta{seq~var}. % One set of outer braces is removed (if any) but any surrounding spaces % are retained: any braces \emph{inside} one or more spaces are % therefore kept. Empty \meta{items} are preserved by % \cs{seq_set_split_keep_spaces:Nnn}, and can be removed afterwards using -% \cs{seq_remove_all:Nn} \meta{sequence} |{}|. +% \cs{seq_remove_all:Nn} \meta{seq~var} |{}|. % The \meta{delimiter} may not contain |{|, |}| or |#| % (assuming \TeX{}'s normal category code r\'egime). % If the \meta{delimiter} is empty, the \meta{token list} is split @@ -172,21 +172,21 @@ % \begin{function} % {\seq_concat:NNN, \seq_concat:ccc, \seq_gconcat:NNN, \seq_gconcat:ccc} % \begin{syntax} -% \cs{seq_concat:NNN} \meta{sequence_1} \meta{sequence_2} \meta{sequence_3} +% \cs{seq_concat:NNN} \meta{seq~var_1} \meta{seq~var_2} \meta{seq~var_3} % \end{syntax} -% Concatenates the content of \meta{sequence_2} and \meta{sequence_3} -% together and saves the result in \meta{sequence_1}. The items in -% \meta{sequence_2} are placed at the left side of the new sequence. +% Concatenates the content of \meta{seq~var_2} and \meta{seq~var_3} +% together and saves the result in \meta{seq~var_1}. The items in +% \meta{seq~var_2} are placed at the left side of the new sequence. % \end{function} % % \begin{function}[EXP, pTF, added=2012-03-03] % {\seq_if_exist:N, \seq_if_exist:c} % \begin{syntax} -% \cs{seq_if_exist_p:N} \meta{sequence} -% \cs{seq_if_exist:NTF} \meta{sequence} \Arg{true code} \Arg{false code} +% \cs{seq_if_exist_p:N} \meta{seq~var} +% \cs{seq_if_exist:NTF} \meta{seq~var} \Arg{true code} \Arg{false code} % \end{syntax} -% Tests whether the \meta{sequence} is currently defined. This does not -% check that the \meta{sequence} really is a sequence variable. +% Tests whether the \meta{seq~var} is currently defined. This does not +% check that the \meta{seq~var} really is a sequence variable. % \end{function} % % \section{Appending data to sequences} @@ -202,9 +202,9 @@ % \seq_gput_left:co, \seq_gput_left:cx % } % \begin{syntax} -% \cs{seq_put_left:Nn} \meta{sequence} \Arg{item} +% \cs{seq_put_left:Nn} \meta{seq~var} \Arg{item} % \end{syntax} -% Appends the \meta{item} to the left of the \meta{sequence}. +% Appends the \meta{item} to the left of the \meta{seq~var}. % \end{function} % % \begin{function}{ @@ -218,9 +218,9 @@ % \seq_gput_right:co, \seq_gput_right:cx % } % \begin{syntax} -% \cs{seq_put_right:Nn} \meta{sequence} \Arg{item} +% \cs{seq_put_right:Nn} \meta{seq~var} \Arg{item} % \end{syntax} -% Appends the \meta{item} to the right of the \meta{sequence}. +% Appends the \meta{item} to the right of the \meta{seq~var}. % \end{function} % % \section{Recovering items from sequences} @@ -234,86 +234,86 @@ % % \begin{function}[updated = 2012-05-14]{\seq_get_left:NN, \seq_get_left:cN} % \begin{syntax} -% \cs{seq_get_left:NN} \meta{sequence} \meta{token list variable} +% \cs{seq_get_left:NN} \meta{seq~var} \meta{token list variable} % \end{syntax} -% Stores the left-most item from a \meta{sequence} in the +% Stores the left-most item from a \meta{seq~var} in the % \meta{token list variable} without removing it from the -% \meta{sequence}. The \meta{token list variable} is assigned locally. -% If \meta{sequence} is empty the \meta{token list variable} +% \meta{seq~var}. The \meta{token list variable} is assigned locally. +% If \meta{seq~var} is empty the \meta{token list variable} % is set to the special marker \cs{q_no_value}. % \end{function} % % \begin{function}[updated = 2012-05-19]{\seq_get_right:NN, \seq_get_right:cN} % \begin{syntax} -% \cs{seq_get_right:NN} \meta{sequence} \meta{token list variable} +% \cs{seq_get_right:NN} \meta{seq~var} \meta{token list variable} % \end{syntax} -% Stores the right-most item from a \meta{sequence} in the +% Stores the right-most item from a \meta{seq~var} in the % \meta{token list variable} without removing it from the -% \meta{sequence}. The \meta{token list variable} is assigned locally. -% If \meta{sequence} is empty the \meta{token list variable} +% \meta{seq~var}. The \meta{token list variable} is assigned locally. +% If \meta{seq~var} is empty the \meta{token list variable} % is set to the special marker \cs{q_no_value}. % \end{function} % % \begin{function}[updated = 2012-05-14]{\seq_pop_left:NN, \seq_pop_left:cN} % \begin{syntax} -% \cs{seq_pop_left:NN} \meta{sequence} \meta{token list variable} +% \cs{seq_pop_left:NN} \meta{seq~var} \meta{token list variable} % \end{syntax} -% Pops the left-most item from a \meta{sequence} into the +% Pops the left-most item from a \meta{seq~var} into the % \meta{token list variable}, \emph{i.e.}~removes the item from the % sequence and stores it in the \meta{token list variable}. -% Both of the variables are assigned locally. If \meta{sequence} is +% Both of the variables are assigned locally. If \meta{seq~var} is % empty the \meta{token list variable} is set to % the special marker \cs{q_no_value}. % \end{function} % % \begin{function}[updated = 2012-05-14]{\seq_gpop_left:NN, \seq_gpop_left:cN} % \begin{syntax} -% \cs{seq_gpop_left:NN} \meta{sequence} \meta{token list variable} +% \cs{seq_gpop_left:NN} \meta{seq~var} \meta{token list variable} % \end{syntax} -% Pops the left-most item from a \meta{sequence} into the +% Pops the left-most item from a \meta{seq~var} into the % \meta{token list variable}, \emph{i.e.}~removes the item from the % sequence and stores it in the \meta{token list variable}. -% The \meta{sequence} is modified globally, while the assignment of +% The \meta{seq~var} is modified globally, while the assignment of % the \meta{token list variable} is local. -% If \meta{sequence} is empty the \meta{token list variable} is set to +% If \meta{seq~var} is empty the \meta{token list variable} is set to % the special marker \cs{q_no_value}. % \end{function} % % \begin{function}[updated = 2012-05-19]{\seq_pop_right:NN, \seq_pop_right:cN} % \begin{syntax} -% \cs{seq_pop_right:NN} \meta{sequence} \meta{token list variable} +% \cs{seq_pop_right:NN} \meta{seq~var} \meta{token list variable} % \end{syntax} -% Pops the right-most item from a \meta{sequence} into the +% Pops the right-most item from a \meta{seq~var} into the % \meta{token list variable}, \emph{i.e.}~removes the item from the % sequence and stores it in the \meta{token list variable}. -% Both of the variables are assigned locally. If \meta{sequence} is +% Both of the variables are assigned locally. If \meta{seq~var} is % empty the \meta{token list variable} is set to % the special marker \cs{q_no_value}. % \end{function} % % \begin{function}[updated = 2012-05-19]{\seq_gpop_right:NN, \seq_gpop_right:cN} % \begin{syntax} -% \cs{seq_gpop_right:NN} \meta{sequence} \meta{token list variable} +% \cs{seq_gpop_right:NN} \meta{seq~var} \meta{token list variable} % \end{syntax} -% Pops the right-most item from a \meta{sequence} into the +% Pops the right-most item from a \meta{seq~var} into the % \meta{token list variable}, \emph{i.e.}~removes the item from the % sequence and stores it in the \meta{token list variable}. -% The \meta{sequence} is modified globally, while the assignment of +% The \meta{seq~var} is modified globally, while the assignment of % the \meta{token list variable} is local. -% If \meta{sequence} is empty the \meta{token list variable} is set to +% If \meta{seq~var} is empty the \meta{token list variable} is set to % the special marker \cs{q_no_value}. % \end{function} % % \begin{function}[added = 2014-07-17, EXP]{\seq_item:Nn, \seq_item:cn} % \begin{syntax} -% \cs{seq_item:Nn} \meta{sequence} \Arg{integer expression} +% \cs{seq_item:Nn} \meta{seq~var} \Arg{integer expression} % \end{syntax} -% Indexing items in the \meta{sequence} from~$1$ at the top (left), this +% Indexing items in the \meta{seq~var} from~$1$ at the top (left), this % function evaluates the \meta{integer expression} and leaves the % appropriate item from the sequence in the input stream. If the % \meta{integer expression} is negative, indexing occurs from the % bottom (right) of the sequence. If the \meta{integer expression} -% is larger than the number of items in the \meta{sequence} (as +% is larger than the number of items in the \meta{seq~var} (as % calculated by \cs{seq_count:N}) then the function expands to % nothing. % \begin{texnote} @@ -328,8 +328,8 @@ % \begin{syntax} % \cs{seq_rand_item:N} \meta{seq~var} % \end{syntax} -% Selects a pseudo-random item of the \meta{sequence}. If the -% \meta{sequence} is empty the result is empty. +% Selects a pseudo-random item of the \meta{seq~var}. If the +% \meta{seq~var} is empty the result is empty. % This is not available in older versions of \XeTeX{}. % \begin{texnote} % The result is returned within the \tn{unexpanded} @@ -348,91 +348,91 @@ % \begin{function}[TF, added = 2012-05-14, updated = 2012-05-19] % {\seq_get_left:NN, \seq_get_left:cN} % \begin{syntax} -% \cs{seq_get_left:NNTF} \meta{sequence} \meta{token list variable} \Arg{true code} \Arg{false code} +% \cs{seq_get_left:NNTF} \meta{seq~var} \meta{token list variable} \Arg{true code} \Arg{false code} % \end{syntax} -% If the \meta{sequence} is empty, leaves the \meta{false code} in the +% If the \meta{seq~var} is empty, leaves the \meta{false code} in the % input stream. The value of the \meta{token list variable} is % not defined in this case and should not be relied upon. If the -% \meta{sequence} is non-empty, stores the left-most item from the -% \meta{sequence} +% \meta{seq~var} is non-empty, stores the left-most item from the +% \meta{seq~var} % in the \meta{token list variable} without removing it from the -% \meta{sequence}, then leaves the \meta{true code} in the input stream. +% \meta{seq~var}, then leaves the \meta{true code} in the input stream. % The \meta{token list variable} is assigned locally. % \end{function} % % \begin{function}[TF, added = 2012-05-19] % {\seq_get_right:NN, \seq_get_right:cN} % \begin{syntax} -% \cs{seq_get_right:NNTF} \meta{sequence} \meta{token list variable} \Arg{true code} \Arg{false code} +% \cs{seq_get_right:NNTF} \meta{seq~var} \meta{token list variable} \Arg{true code} \Arg{false code} % \end{syntax} -% If the \meta{sequence} is empty, leaves the \meta{false code} in the +% If the \meta{seq~var} is empty, leaves the \meta{false code} in the % input stream. The value of the \meta{token list variable} is % not defined in this case and should not be relied upon. If the -% \meta{sequence} is non-empty, stores the right-most item from the -% \meta{sequence} +% \meta{seq~var} is non-empty, stores the right-most item from the +% \meta{seq~var} % in the \meta{token list variable} without removing it from the -% \meta{sequence}, then leaves the \meta{true code} in the input stream. +% \meta{seq~var}, then leaves the \meta{true code} in the input stream. % The \meta{token list variable} is assigned locally. % \end{function} % % \begin{function}[TF, added = 2012-05-14, updated = 2012-05-19] % {\seq_pop_left:NN, \seq_pop_left:cN} % \begin{syntax} -% \cs{seq_pop_left:NNTF} \meta{sequence} \meta{token list variable} \Arg{true code} \Arg{false code} +% \cs{seq_pop_left:NNTF} \meta{seq~var} \meta{token list variable} \Arg{true code} \Arg{false code} % \end{syntax} -% If the \meta{sequence} is empty, leaves the \meta{false code} in the +% If the \meta{seq~var} is empty, leaves the \meta{false code} in the % input stream. The value of the \meta{token list variable} is % not defined in this case and should not be relied upon. If the -% \meta{sequence} is non-empty, pops the left-most item from the -% \meta{sequence} +% \meta{seq~var} is non-empty, pops the left-most item from the +% \meta{seq~var} % in the \meta{token list variable}, \emph{i.e.}~removes the item from the -% \meta{sequence}, then leaves the \meta{true code} in the input stream. -% Both the \meta{sequence} and the \meta{token list variable} are assigned +% \meta{seq~var}, then leaves the \meta{true code} in the input stream. +% Both the \meta{seq~var} and the \meta{token list variable} are assigned % locally. % \end{function} % % \begin{function}[TF, added = 2012-05-14, updated = 2012-05-19] % {\seq_gpop_left:NN, \seq_gpop_left:cN} % \begin{syntax} -% \cs{seq_gpop_left:NNTF} \meta{sequence} \meta{token list variable} \Arg{true code} \Arg{false code} +% \cs{seq_gpop_left:NNTF} \meta{seq~var} \meta{token list variable} \Arg{true code} \Arg{false code} % \end{syntax} -% If the \meta{sequence} is empty, leaves the \meta{false code} in the +% If the \meta{seq~var} is empty, leaves the \meta{false code} in the % input stream. The value of the \meta{token list variable} is % not defined in this case and should not be relied upon. If the -% \meta{sequence} is non-empty, pops the left-most item from the \meta{sequence} +% \meta{seq~var} is non-empty, pops the left-most item from the \meta{seq~var} % in the \meta{token list variable}, \emph{i.e.}~removes the item from the -% \meta{sequence}, then leaves the \meta{true code} in the input stream. -% The \meta{sequence} is modified globally, while the \meta{token list variable} +% \meta{seq~var}, then leaves the \meta{true code} in the input stream. +% The \meta{seq~var} is modified globally, while the \meta{token list variable} % is assigned locally. % \end{function} % % \begin{function}[TF, added = 2012-05-19] % {\seq_pop_right:NN, \seq_pop_right:cN} % \begin{syntax} -% \cs{seq_pop_right:NNTF} \meta{sequence} \meta{token list variable} \Arg{true code} \Arg{false code} +% \cs{seq_pop_right:NNTF} \meta{seq~var} \meta{token list variable} \Arg{true code} \Arg{false code} % \end{syntax} -% If the \meta{sequence} is empty, leaves the \meta{false code} in the +% If the \meta{seq~var} is empty, leaves the \meta{false code} in the % input stream. The value of the \meta{token list variable} is % not defined in this case and should not be relied upon. If the -% \meta{sequence} is non-empty, pops the right-most item from the \meta{sequence} +% \meta{seq~var} is non-empty, pops the right-most item from the \meta{seq~var} % in the \meta{token list variable}, \emph{i.e.}~removes the item from the -% \meta{sequence}, then leaves the \meta{true code} in the input stream. -% Both the \meta{sequence} and the \meta{token list variable} are assigned +% \meta{seq~var}, then leaves the \meta{true code} in the input stream. +% Both the \meta{seq~var} and the \meta{token list variable} are assigned % locally. % \end{function} % % \begin{function}[TF, added = 2012-05-19] % {\seq_gpop_right:NN, \seq_gpop_right:cN} % \begin{syntax} -% \cs{seq_gpop_right:NNTF} \meta{sequence} \meta{token list variable} \Arg{true code} \Arg{false code} +% \cs{seq_gpop_right:NNTF} \meta{seq~var} \meta{token list variable} \Arg{true code} \Arg{false code} % \end{syntax} -% If the \meta{sequence} is empty, leaves the \meta{false code} in the +% If the \meta{seq~var} is empty, leaves the \meta{false code} in the % input stream. The value of the \meta{token list variable} is % not defined in this case and should not be relied upon. If the -% \meta{sequence} is non-empty, pops the right-most item from the \meta{sequence} +% \meta{seq~var} is non-empty, pops the right-most item from the \meta{seq~var} % in the \meta{token list variable}, \emph{i.e.}~removes the item from the -% \meta{sequence}, then leaves the \meta{true code} in the input stream. -% The \meta{sequence} is modified globally, while the +% \meta{seq~var}, then leaves the \meta{true code} in the input stream. +% The \meta{seq~var} is modified globally, while the % \meta{token list variable} is assigned locally. % \end{function} % @@ -449,13 +449,13 @@ % \seq_gremove_duplicates:N, \seq_gremove_duplicates:c % } % \begin{syntax} -% \cs{seq_remove_duplicates:N} \meta{sequence} +% \cs{seq_remove_duplicates:N} \meta{seq~var} % \end{syntax} -% Removes duplicate items from the \meta{sequence}, leaving the -% left most copy of each item in the \meta{sequence}. The \meta{item} +% Removes duplicate items from the \meta{seq~var}, leaving the +% left most copy of each item in the \meta{seq~var}. The \meta{item} % comparison takes place on a token basis, as for \cs{tl_if_eq:nnTF}. % \begin{texnote} -% This function iterates through every item in the \meta{sequence} and +% This function iterates through every item in the \meta{seq~var} and % does a comparison with the \meta{items} already checked. It is therefore % relatively slow with large sequences. % \end{texnote} @@ -467,9 +467,9 @@ % \seq_gremove_all:Nn, \seq_gremove_all:cn % } % \begin{syntax} -% \cs{seq_remove_all:Nn} \meta{sequence} \Arg{item} +% \cs{seq_remove_all:Nn} \meta{seq~var} \Arg{item} % \end{syntax} -% Removes every occurrence of \meta{item} from the \meta{sequence}. +% Removes every occurrence of \meta{item} from the \meta{seq~var}. % The \meta{item} comparison takes place on a token basis, as for % \cs{tl_if_eq:nnTF}. % \end{function} @@ -480,12 +480,12 @@ % \cs{seq_set_item:Nnn} \meta{seq~var} \Arg{int expr} \Arg{item} % \cs{seq_set_item:NnnTF} \meta{seq~var} \Arg{int expr} \Arg{item} \Arg{true code} \Arg{false code} % \end{syntax} -% Removes the item of \meta{sequence} at the position given by +% Removes the item of \meta{seq~var} at the position given by % evaluating the \meta{int expr} and replaces it by % \meta{item}. Items are indexed from $1$ on the left/top of the -% \meta{sequence}, or from $-1$ on the right/bottom. If the +% \meta{seq~var}, or from $-1$ on the right/bottom. If the % \meta{int expr} is zero or is larger (in absolute value) -% than the number of items in the sequence, the \meta{sequence} is not +% than the number of items in the sequence, the \meta{seq~var} is not % modified. In these cases, \cs{seq_set_item:Nnn} raises an error % while \cs{seq_set_item:NnnTF} runs the \meta{false code}. In cases % where the assignment was successful, \meta{true code} is run @@ -498,19 +498,19 @@ % \seq_greverse:N, \seq_greverse:c % } % \begin{syntax} -% \cs{seq_reverse:N} \meta{sequence} +% \cs{seq_reverse:N} \meta{seq~var} % \end{syntax} -% Reverses the order of the items stored in the \meta{sequence}. +% Reverses the order of the items stored in the \meta{seq~var}. % \end{function} % % \begin{function}[added = 2017-02-06] % {\seq_sort:Nn, \seq_sort:cn, \seq_gsort:Nn, \seq_gsort:cn} % \begin{syntax} -% \cs{seq_sort:Nn} \meta{sequence} \Arg{comparison code} +% \cs{seq_sort:Nn} \meta{seq~var} \Arg{comparison code} % \end{syntax} -% Sorts the items in the \meta{sequence} according to the +% Sorts the items in the \meta{seq~var} according to the % \meta{comparison code}, and assigns the result to -% \meta{sequence}. The details of sorting comparison are +% \meta{seq~var}. The details of sorting comparison are % described in Section~\ref{sec:l3sort:mech}. % \end{function} % @@ -536,10 +536,10 @@ % % \begin{function}[EXP,pTF]{\seq_if_empty:N, \seq_if_empty:c} % \begin{syntax} -% \cs{seq_if_empty_p:N} \meta{sequence} -% \cs{seq_if_empty:NTF} \meta{sequence} \Arg{true code} \Arg{false code} +% \cs{seq_if_empty_p:N} \meta{seq~var} +% \cs{seq_if_empty:NTF} \meta{seq~var} \Arg{true code} \Arg{false code} % \end{syntax} -% Tests if the \meta{sequence} is empty (containing no items). +% Tests if the \meta{seq~var} is empty (containing no items). % \end{function} % % \begin{function}[TF] @@ -548,9 +548,9 @@ % \seq_if_in:cn, \seq_if_in:cV, \seq_if_in:cv, \seq_if_in:co, \seq_if_in:cx % } % \begin{syntax} -% \cs{seq_if_in:NnTF} \meta{sequence} \Arg{item} \Arg{true code} \Arg{false code} +% \cs{seq_if_in:NnTF} \meta{seq~var} \Arg{item} \Arg{true code} \Arg{false code} % \end{syntax} -% Tests if the \meta{item} is present in the \meta{sequence}. +% Tests if the \meta{item} is present in the \meta{seq~var}. % \end{function} % % \section{Mapping over sequences} @@ -562,10 +562,10 @@ % \begin{function}[rEXP, updated = 2012-06-29] % {\seq_map_function:NN, \seq_map_function:cN} % \begin{syntax} -% \cs{seq_map_function:NN} \meta{sequence} \meta{function} +% \cs{seq_map_function:NN} \meta{seq~var} \meta{function} % \end{syntax} % Applies \meta{function} to every \meta{item} stored in the -% \meta{sequence}. The \meta{function} will receive one argument for +% \meta{seq~var}. The \meta{function} will receive one argument for % each iteration. The \meta{items} are returned from left to right. % To pass further arguments to the \meta{function}, see % \cs{seq_map_tokens:Nn}. @@ -577,10 +577,10 @@ % \begin{function}[updated = 2012-06-29] % {\seq_map_inline:Nn, \seq_map_inline:cn} % \begin{syntax} -% \cs{seq_map_inline:Nn} \meta{sequence} \Arg{inline function} +% \cs{seq_map_inline:Nn} \meta{seq~var} \Arg{inline function} % \end{syntax} % Applies \meta{inline function} to every \meta{item} stored -% within the \meta{sequence}. The \meta{inline function} should +% within the \meta{seq~var}. The \meta{inline function} should % consist of code which will receive the \meta{item} as |#1|. % The \meta{items} are returned from left to right. % \end{function} @@ -588,15 +588,15 @@ % \begin{function}[rEXP, added = 2019-08-30] % {\seq_map_tokens:Nn, \seq_map_tokens:cn} % \begin{syntax} -% \cs{seq_map_tokens:Nn} \meta{sequence} \Arg{code} +% \cs{seq_map_tokens:Nn} \meta{seq~var} \Arg{code} % \end{syntax} % Analogue of \cs{seq_map_function:NN} which maps several tokens % instead of a single function. The \meta{code} receives each item in -% the \meta{sequence} as a trailing brace group. For instance, +% the \meta{seq~var} as a trailing brace group. For instance, % \begin{verbatim} % \seq_map_tokens:Nn \l_my_seq { \prg_replicate:nn { 2 } } % \end{verbatim} -% expands to twice each item in the \meta{sequence}: for each item in +% expands to twice each item in the \meta{seq~var}: for each item in % |\l_my_seq| the function \cs{prg_replicate:nn} receives |2| and % \meta{item} as its two arguments. The function % \cs{seq_map_inline:Nn} is typically faster but it is not expandable. @@ -608,14 +608,14 @@ % \seq_map_variable:cNn, \seq_map_variable:ccn % } % \begin{syntax} -% \cs{seq_map_variable:NNn} \meta{sequence} \meta{variable} \Arg{code} +% \cs{seq_map_variable:NNn} \meta{seq~var} \meta{variable} \Arg{code} % \end{syntax} -% Stores each \meta{item} of the \meta{sequence} in turn in the (token +% Stores each \meta{item} of the \meta{seq~var} in turn in the (token % list) \meta{variable} and applies the \meta{code}. The \meta{code} % will usually make use of the \meta{variable}, but this is not % enforced. The assignments to the \meta{variable} are local. Its -% value after the loop is the last \meta{item} in the \meta{sequence}, -% or its original value if the \meta{sequence} is empty. The +% value after the loop is the last \meta{item} in the \meta{seq~var}, +% or its original value if the \meta{seq~var} is empty. The % \meta{items} are returned from left to right. % \end{function} % @@ -662,7 +662,7 @@ % \cs{seq_map_break:} % \end{syntax} % Used to terminate a \cs[no-index]{seq_map_\ldots} function before all -% entries in the \meta{sequence} have been processed. This +% entries in the \meta{seq~var} have been processed. This % normally takes place within a conditional statement, for example % \begin{verbatim} % \seq_map_inline:Nn \l_my_seq @@ -689,7 +689,7 @@ % \cs{seq_map_break:n} \Arg{code} % \end{syntax} % Used to terminate a \cs[no-index]{seq_map_\ldots} function before all -% entries in the \meta{sequence} have been processed, inserting +% entries in the \meta{seq~var} have been processed, inserting % the \meta{code} after the mapping has ended. This % normally takes place within a conditional statement, for example % \begin{verbatim} @@ -715,13 +715,13 @@ % \begin{function}[added = 2011-12-22, updated = 2020-07-16] % {\seq_set_map:NNn, \seq_gset_map:NNn} % \begin{syntax} -% \cs{seq_set_map:NNn} \meta{sequence_1} \meta{sequence_2} \Arg{inline function} +% \cs{seq_set_map:NNn} \meta{seq~var_1} \meta{seq~var_2} \Arg{inline function} % \end{syntax} % Applies \meta{inline function} to every \meta{item} stored -% within the \meta{sequence_2}. The \meta{inline function} should +% within the \meta{seq~var_2}. The \meta{inline function} should % consist of code which will receive the \meta{item} as |#1|. % The sequence resulting applying \meta{inline function} to each -% \meta{item} is assigned to \meta{sequence_1}. +% \meta{item} is assigned to \meta{seq~var_1}. % \begin{texnote} % Contrarily to other mapping functions, \cs{seq_map_break:} cannot % be used in this function, and would lead to low-level \TeX{} errors. @@ -731,14 +731,14 @@ % \begin{function}[added = 2020-07-16] % {\seq_set_map_x:NNn, \seq_gset_map_x:NNn} % \begin{syntax} -% \cs{seq_set_map_x:NNn} \meta{sequence_1} \meta{sequence_2} \Arg{inline function} +% \cs{seq_set_map_x:NNn} \meta{seq~var_1} \meta{seq~var_2} \Arg{inline function} % \end{syntax} % Applies \meta{inline function} to every \meta{item} stored -% within the \meta{sequence_2}. The \meta{inline function} should +% within the \meta{seq~var_2}. The \meta{inline function} should % consist of code which will receive the \meta{item} as |#1|. % The sequence resulting from \texttt{x}-expanding % \meta{inline function} applied to each \meta{item} -% is assigned to \meta{sequence_1}. As such, the code +% is assigned to \meta{seq~var_1}. As such, the code % in \meta{inline function} should be expandable. % \begin{texnote} % Contrarily to other mapping functions, \cs{seq_map_break:} cannot @@ -748,12 +748,12 @@ % % \begin{function}[EXP, added = 2012-07-13]{\seq_count:N, \seq_count:c} % \begin{syntax} -% \cs{seq_count:N} \meta{sequence} +% \cs{seq_count:N} \meta{seq~var} % \end{syntax} -% Leaves the number of items in the \meta{sequence} in the input +% Leaves the number of items in the \meta{seq~var} in the input % stream as an \meta{integer denotation}. The total number of items -% in a \meta{sequence} includes those which are empty and duplicates, -% \emph{i.e.}~every item in a \meta{sequence} is unique. +% in a \meta{seq~var} includes those which are empty and duplicates, +% \emph{i.e.}~every item in a \meta{seq~var} is unique. % \end{function} % % \section{Using the content of sequences directly} @@ -825,71 +825,71 @@ % % \begin{function}[updated = 2012-05-14]{\seq_get:NN, \seq_get:cN} % \begin{syntax} -% \cs{seq_get:NN} \meta{sequence} \meta{token list variable} +% \cs{seq_get:NN} \meta{seq~var} \meta{token list variable} % \end{syntax} -% Reads the top item from a \meta{sequence} into the +% Reads the top item from a \meta{seq~var} into the % \meta{token list variable} without removing it from the -% \meta{sequence}. The \meta{token list variable} is assigned locally. -% If \meta{sequence} is empty the \meta{token list variable} is set to +% \meta{seq~var}. The \meta{token list variable} is assigned locally. +% If \meta{seq~var} is empty the \meta{token list variable} is set to % the special marker \cs{q_no_value}. % \end{function} % % \begin{function}[updated = 2012-05-14]{\seq_pop:NN, \seq_pop:cN} % \begin{syntax} -% \cs{seq_pop:NN} \meta{sequence} \meta{token list variable} +% \cs{seq_pop:NN} \meta{seq~var} \meta{token list variable} % \end{syntax} -% Pops the top item from a \meta{sequence} into the +% Pops the top item from a \meta{seq~var} into the % \meta{token list variable}. Both of the variables are assigned -% locally. If \meta{sequence} is empty the \meta{token list variable} +% locally. If \meta{seq~var} is empty the \meta{token list variable} % is set to the special marker \cs{q_no_value}. % \end{function} % % \begin{function}[updated = 2012-05-14]{\seq_gpop:NN, \seq_gpop:cN} % \begin{syntax} -% \cs{seq_gpop:NN} \meta{sequence} \meta{token list variable} +% \cs{seq_gpop:NN} \meta{seq~var} \meta{token list variable} % \end{syntax} -% Pops the top item from a \meta{sequence} into the -% \meta{token list variable}. The \meta{sequence} is modified globally, +% Pops the top item from a \meta{seq~var} into the +% \meta{token list variable}. The \meta{seq~var} is modified globally, % while the \meta{token list variable} is assigned locally. If -% \meta{sequence} is empty the \meta{token list variable} is set to +% \meta{seq~var} is empty the \meta{token list variable} is set to % the special marker \cs{q_no_value}. % \end{function} % % \begin{function}[TF, added = 2012-05-14, updated = 2012-05-19]{\seq_get:NN, \seq_get:cN} % \begin{syntax} -% \cs{seq_get:NNTF} \meta{sequence} \meta{token list variable} \Arg{true code} \Arg{false code} +% \cs{seq_get:NNTF} \meta{seq~var} \meta{token list variable} \Arg{true code} \Arg{false code} % \end{syntax} -% If the \meta{sequence} is empty, leaves the \meta{false code} in the +% If the \meta{seq~var} is empty, leaves the \meta{false code} in the % input stream. The value of the \meta{token list variable} is % not defined in this case and should not be relied upon. If the -% \meta{sequence} is non-empty, stores the top item from a -% \meta{sequence} in the \meta{token list variable} without removing it from -% the \meta{sequence}. The \meta{token list variable} is assigned locally. +% \meta{seq~var} is non-empty, stores the top item from a +% \meta{seq~var} in the \meta{token list variable} without removing it from +% the \meta{seq~var}. The \meta{token list variable} is assigned locally. % \end{function} % % \begin{function}[TF, added = 2012-05-14, updated = 2012-05-19]{\seq_pop:NN, \seq_pop:cN} % \begin{syntax} -% \cs{seq_pop:NNTF} \meta{sequence} \meta{token list variable} \Arg{true code} \Arg{false code} +% \cs{seq_pop:NNTF} \meta{seq~var} \meta{token list variable} \Arg{true code} \Arg{false code} % \end{syntax} -% If the \meta{sequence} is empty, leaves the \meta{false code} in the +% If the \meta{seq~var} is empty, leaves the \meta{false code} in the % input stream. The value of the \meta{token list variable} is % not defined in this case and should not be relied upon. If the -% \meta{sequence} is non-empty, pops the top item from the -% \meta{sequence} in the \meta{token list variable}, \emph{i.e.}~removes the -% item from the \meta{sequence}. Both the \meta{sequence} and the +% \meta{seq~var} is non-empty, pops the top item from the +% \meta{seq~var} in the \meta{token list variable}, \emph{i.e.}~removes the +% item from the \meta{seq~var}. Both the \meta{seq~var} and the % \meta{token list variable} are assigned locally. % \end{function} % % \begin{function}[TF, added = 2012-05-14, updated = 2012-05-19]{\seq_gpop:NN, \seq_gpop:cN} % \begin{syntax} -% \cs{seq_gpop:NNTF} \meta{sequence} \meta{token list variable} \Arg{true code} \Arg{false code} +% \cs{seq_gpop:NNTF} \meta{seq~var} \meta{token list variable} \Arg{true code} \Arg{false code} % \end{syntax} -% If the \meta{sequence} is empty, leaves the \meta{false code} in the +% If the \meta{seq~var} is empty, leaves the \meta{false code} in the % input stream. The value of the \meta{token list variable} is % not defined in this case and should not be relied upon. If the -% \meta{sequence} is non-empty, pops the top item from the \meta{sequence} +% \meta{seq~var} is non-empty, pops the top item from the \meta{seq~var} % in the \meta{token list variable}, \emph{i.e.}~removes the item from the -% \meta{sequence}. The \meta{sequence} is modified globally, while the +% \meta{seq~var}. The \meta{seq~var} is modified globally, while the % \meta{token list variable} is assigned locally. % \end{function} % @@ -903,9 +903,9 @@ % \seq_gpush:co, \seq_gpush:cx % } % \begin{syntax} -% \cs{seq_push:Nn} \meta{sequence} \Arg{item} +% \cs{seq_push:Nn} \meta{seq~var} \Arg{item} % \end{syntax} -% Adds the \Arg{item} to the top of the \meta{sequence}. +% Adds the \Arg{item} to the top of the \meta{seq~var}. % \end{function} % % \section{Sequences as sets} @@ -1026,16 +1026,16 @@ % % \begin{function}[updated = 2021-04-29]{\seq_show:N, \seq_show:c} % \begin{syntax} -% \cs{seq_show:N} \meta{sequence} +% \cs{seq_show:N} \meta{seq~var} % \end{syntax} -% Displays the entries in the \meta{sequence} in the terminal. +% Displays the entries in the \meta{seq~var} in the terminal. % \end{function} % % \begin{function}[added = 2014-08-12, updated = 2021-04-29]{\seq_log:N, \seq_log:c} % \begin{syntax} -% \cs{seq_log:N} \meta{sequence} +% \cs{seq_log:N} \meta{seq~var} % \end{syntax} -% Writes the entries in the \meta{sequence} in the log file. +% Writes the entries in the \meta{seq~var} in the log file. % \end{function} % % \end{documentation} |