[latex3-commits] [l3svn] r6685 - Omit fake control sequences from the index
noreply at latex-project.org
noreply at latex-project.org
Fri Aug 19 18:26:52 CEST 2016
Author: bruno
Date: 2016-08-19 18:26:52 +0200 (Fri, 19 Aug 2016)
New Revision: 6685
Modified:
trunk/l3kernel/l3basics.dtx
trunk/l3kernel/l3box.dtx
trunk/l3kernel/l3candidates.dtx
trunk/l3kernel/l3clist.dtx
trunk/l3kernel/l3coffins.dtx
trunk/l3kernel/l3file.dtx
trunk/l3kernel/l3fp-aux.dtx
trunk/l3kernel/l3fp-parse.dtx
trunk/l3kernel/l3fp.dtx
trunk/l3kernel/l3int.dtx
trunk/l3kernel/l3keys.dtx
trunk/l3kernel/l3names.dtx
trunk/l3kernel/l3prop.dtx
trunk/l3kernel/l3quark.dtx
trunk/l3kernel/l3seq.dtx
trunk/l3kernel/l3skip.dtx
trunk/l3kernel/l3str.dtx
trunk/l3kernel/l3tl.dtx
trunk/l3kernel/l3token.dtx
Log:
Omit fake control sequences from the index
It makes no sense to index "\cs_new_..." for instance
Modified: trunk/l3kernel/l3basics.dtx
===================================================================
--- trunk/l3kernel/l3basics.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3basics.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -147,7 +147,7 @@
% Declaring a function before setting up the code means that the name
% chosen will be checked and an error raised if it is already in use.
% The name of a function can be checked at the point of definition using
-% the \cs{cs_new\ldots} functions: this is recommended for all
+% the \cs[no-index]{cs_new\ldots} functions: this is recommended for all
% functions which are defined for the first time.
%
% There are three ways to define new functions.
@@ -1306,7 +1306,7 @@
% These will be defined as needed in the appropriate modules, but
% do a few now, just to get started.\footnote{This renaming gets expensive
% in terms of csname usage, an alternative scheme would be to just use
-% the \cs{tex\ldots:D} name in the cases where no good alternative exists.}
+% the \cs[no-index]{tex_\ldots:D} name in the cases where no good alternative exists.}
%
% \begin{macro}[EXP]
% {
@@ -2255,7 +2255,8 @@
% {\cs_if_exist_use:N, \cs_if_exist_use:c}
% \begin{macro}[EXP,added=2011-10-10]
% {\cs_if_exist_use:N, \cs_if_exist_use:c}
-% The \cs{cs_if_exist_use:\ldots{}} functions cannot be implemented
+% The \cs[index=cs_if_exist_use:N]{cs_if_exist_use:\ldots{}}
+% functions cannot be implemented
% as conditionals because the true branch must leave both the control
% sequence itself and the true code in the input stream.
% For the \texttt{c} variants, we are careful not to put the control
Modified: trunk/l3kernel/l3box.dtx
===================================================================
--- trunk/l3kernel/l3box.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3box.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -97,7 +97,8 @@
% \cs{box_clear_new:N} \meta{box}
% \end{syntax}
% Ensures that the \meta{box} exists globally by applying
-% \cs{box_new:N} if necessary, then applies \cs{box_(g)clear:N} to leave
+% \cs{box_new:N} if necessary, then applies
+% \cs[index=box_clear:N]{box_(g)clear:N} to leave
% the \meta{box} empty.
% \end{function}
%
Modified: trunk/l3kernel/l3candidates.dtx
===================================================================
--- trunk/l3kernel/l3candidates.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3candidates.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -405,7 +405,7 @@
% \begin{syntax}
% \cs{ior_map_break:}
% \end{syntax}
-% Used to terminate a \cs{ior_map_\ldots} function before all
+% Used to terminate a \cs[no-index]{ior_map_\ldots} function before all
% lines from the \meta{stream} have been processed. This will
% normally take place within a conditional statement, for example
% \begin{verbatim}
@@ -418,7 +418,7 @@
% }
% }
% \end{verbatim}
-% Use outside of a \cs{ior_map_\ldots} scenario will lead to low
+% Use outside of a \cs[no-index]{ior_map_\ldots} scenario will lead to low
% level \TeX{} errors.
% \begin{texnote}
% When the mapping is broken, additional tokens may be inserted by the
@@ -432,7 +432,7 @@
% \begin{syntax}
% \cs{ior_map_break:n} \Arg{tokens}
% \end{syntax}
-% Used to terminate a \cs{ior_map_\ldots} function before all
+% Used to terminate a \cs[no-index]{ior_map_\ldots} function before all
% lines in the \meta{stream} have been processed, inserting
% the \meta{tokens} after the mapping has ended. This will
% normally take place within a conditional statement, for example
@@ -446,7 +446,7 @@
% }
% }
% \end{verbatim}
-% Use outside of a \cs{ior_map_\ldots} scenario will lead to low
+% Use outside of a \cs[no-index]{ior_map_\ldots} scenario will lead to low
% level \TeX{} errors.
% \begin{texnote}
% When the mapping is broken, additional tokens may be inserted by the
@@ -949,7 +949,8 @@
% case. However, the process is more complex than this as there are some
% situations where a single lower case character maps to a special form, for
% example \texttt{ij} in Dutch which becomes \texttt{IJ}. As such,
-% \cs{tl_mixed_case:n(n)} implement a more sophisticated mapping which accounts
+% \cs[index=tl_mixed_case:n]{tl_mixed_case:n(n)}
+% implement a more sophisticated mapping which accounts
% for this and for modifying accents on the first letter. Spaces at the start
% of the \meta{tokens} are ignored when finding the first \enquote{letter} for
% conversion.
Modified: trunk/l3kernel/l3clist.dtx
===================================================================
--- trunk/l3kernel/l3clist.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3clist.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -135,7 +135,8 @@
% \cs{clist_clear_new:N} \meta{comma list}
% \end{syntax}
% Ensures that the \meta{comma list} exists globally by applying
-% \cs{clist_new:N} if necessary, then applies \cs{clist_(g)clear:N} to leave
+% \cs{clist_new:N} if necessary, then applies
+% \cs[index=clist_clear:N]{clist_(g)clear:N} to leave
% the list empty.
% \end{function}
%
Modified: trunk/l3kernel/l3coffins.dtx
===================================================================
--- trunk/l3kernel/l3coffins.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3coffins.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -518,7 +518,7 @@
% Creating a new coffin means making the underlying box and adding the
% data structures. These are created globally, as there is a need to
% avoid any strange effects if the coffin is created inside a group.
-% This means that the usual rule about \cs{l_\ldots} variables has
+% This means that the usual rule about \cs[no-index]{l_\ldots} variables has
% to be broken.
% \begin{macrocode}
\cs_new_protected:Npn \coffin_new:N #1
Modified: trunk/l3kernel/l3file.dtx
===================================================================
--- trunk/l3kernel/l3file.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3file.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -528,7 +528,7 @@
%
% \begin{variable}{\l__file_internal_name_tl}
% Used to return the full name of a file for internal use. This is
-% set by \cs{file_if_exist:n(TF)} and \cs{__file_if_exist:nT}, and
+% set by \cs{file_if_exist:nTF} and \cs{__file_if_exist:nT}, and
% the value may then be used to load a file directly provided no
% further operations intervene.
% \end{variable}
Modified: trunk/l3kernel/l3fp-aux.dtx
===================================================================
--- trunk/l3kernel/l3fp-aux.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3fp-aux.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -125,9 +125,9 @@
%
% Special floating point numbers have the form
% \begin{quote}
-% \cs{s_@@} \cs{@@_chk:w} \meta{case} \meta{sign} \cs{s_@@_...} |;|
+% \cs{s_@@} \cs{@@_chk:w} \meta{case} \meta{sign} \cs[no-index]{s_@@_\ldots} |;|
% \end{quote}
-% where \cs{s_@@_...} is a scan mark carrying information about how the
+% where \cs[no-index]{s_@@_\ldots} is a scan mark carrying information about how the
% number was formed (useful for debugging).
%
% Normal floating point numbers ($\meta{case} = 1$) have the form
@@ -156,16 +156,16 @@
% \toprule
% \multicolumn{1}{c}{Representation} & Meaning \\
% \midrule
-% 0 0 \cs{s_@@_...} \texttt{;} & Positive zero. \\
-% 0 2 \cs{s_@@_...} \texttt{;} & Negative zero. \\
+% 0 0 \cs[no-index]{s_@@_\ldots} \texttt{;} & Positive zero. \\
+% 0 2 \cs[no-index]{s_@@_\ldots} \texttt{;} & Negative zero. \\
% 1 0 \Arg{exponent} \Arg{X_1} \Arg{X_2} \Arg{X_3} \Arg{X_4} \texttt{;}
% & Positive floating point. \\
% 1 2 \Arg{exponent} \Arg{X_1} \Arg{X_2} \Arg{X_3} \Arg{X_4} \texttt{;}
% & Negative floating point. \\
-% 2 0 \cs{s_@@_...} \texttt{;} & Positive infinity. \\
-% 2 2 \cs{s_@@_...} \texttt{;} & Negative infinity. \\
-% 3 1 \cs{s_@@_...} \texttt{;} & Quiet \texttt{nan}. \\
-% 3 1 \cs{s_@@_...} \texttt{;} & Signalling \texttt{nan}. \\
+% 2 0 \cs[no-index]{s_@@_\ldots} \texttt{;} & Positive infinity. \\
+% 2 2 \cs[no-index]{s_@@_\ldots} \texttt{;} & Negative infinity. \\
+% 3 1 \cs[no-index]{s_@@_\ldots} \texttt{;} & Quiet \texttt{nan}. \\
+% 3 1 \cs[no-index]{s_@@_\ldots} \texttt{;} & Signalling \texttt{nan}. \\
% \bottomrule
% \end{tabular}
% \end{table}
@@ -300,9 +300,9 @@
% {\c_zero_fp, \c_minus_zero_fp, \c_inf_fp, \c_minus_inf_fp, \c_nan_fp}
% The special floating points. All of them have the form
% \begin{quote}
-% \cs{s_@@} \cs{@@_chk:w} \meta{case} \meta{sign} \cs{s_@@_...} |;|
+% \cs{s_@@} \cs{@@_chk:w} \meta{case} \meta{sign} \cs[no-index]{s_@@_\ldots} |;|
% \end{quote}
-% where the dots in \cs{s_@@_...} are one of \texttt{invalid},
+% where the dots in \cs[no-index]{s_@@_\ldots} are one of \texttt{invalid},
% \texttt{underflow}, \texttt{overflow}, \texttt{division},
% \texttt{exact}, describing how the floating point was created. We
% define the floating points here as \enquote{exact}.
Modified: trunk/l3kernel/l3fp-parse.dtx
===================================================================
--- trunk/l3kernel/l3fp-parse.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3fp-parse.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -195,7 +195,7 @@
% \cs{exp_after:wN}~|;| expanded what follows once, we need |\add:ww|
% to do the calculation, and in the process to expand the following
% once. This is also true in our real application: all the functions of
-% the form \cs{@@_..._o:ww} expand what follows once. This comes at the
+% the form \cs[no-index]{@@_\ldots_o:ww} expand what follows once. This comes at the
% cost of leaving tokens in the input stack, and we will need to be
% careful not to waste this memory. All of our discussion above is nice
% but simplistic, as operations should not simply be performed in the
Modified: trunk/l3kernel/l3fp.dtx
===================================================================
--- trunk/l3kernel/l3fp.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3fp.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -193,7 +193,7 @@
% \end{syntax}
% Ensures that the \meta{fp~var} exists globally
% by applying \cs{fp_new:N} if necessary, then applies
-% \cs{fp_(g)zero:N} to leave the \meta{fp~var} set to~$+0$.
+% \cs[index=fp_zero:N]{fp_(g)zero:N} to leave the \meta{fp~var} set to~$+0$.
% \end{function}
%
% \section{Setting floating point variables}
Modified: trunk/l3kernel/l3int.dtx
===================================================================
--- trunk/l3kernel/l3int.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3int.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -205,7 +205,8 @@
% \cs{int_zero_new:N} \meta{integer}
% \end{syntax}
% Ensures that the \meta{integer} exists globally by applying
-% \cs{int_new:N} if necessary, then applies \cs{int_(g)zero:N} to leave
+% \cs{int_new:N} if necessary, then applies
+% \cs[index=int_zero:N]{int_(g)zero:N} to leave
% the \meta{integer} set to zero.
% \end{function}
%
@@ -949,7 +950,7 @@
% \cs{__prg_compare_error:}
% \cs{__prg_compare_error:Nw} \meta{token}
% \end{syntax}
-% These are used within \cs{int_compare:n(TF)}, \cs{dim_compare:n(TF)}
+% These are used within \cs{int_compare:nTF}, \cs{dim_compare:nTF}
% and so on to recover correctly if the \texttt{n}-type argument does not
% contain a properly-formed relation.
% \end{function}
Modified: trunk/l3kernel/l3keys.dtx
===================================================================
--- trunk/l3kernel/l3keys.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3keys.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -2330,7 +2330,7 @@
% \end{macro}
%
% \begin{macro}[EXP,pTF]{\keys_if_choice_exist:nnn}
-% Just an alternative view on \cs{keys_if_exist:nn(TF)}.
+% Just an alternative view on \cs{keys_if_exist:nnTF}.
% \begin{macrocode}
\prg_new_conditional:Npnn \keys_if_choice_exist:nnn #1#2#3
{ p , T , F , TF }
Modified: trunk/l3kernel/l3names.dtx
===================================================================
--- trunk/l3kernel/l3names.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3names.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -564,7 +564,7 @@
% based on those also available in \LuaTeX{} or used in \pkg{expl3}.
% In the case of the \pdfTeX{} primitives, we retain |pdf| at the start
% of the names \emph{only} for directly PDF-related primitives, as
-% there are a lot of \pdfTeX{} primitives that start \cs{pdf\ldots} but
+% there are a lot of \pdfTeX{} primitives that start \cs[no-index]{pdf\ldots} but
% are not related to PDF output. These ones related to PDF output or only
% work in PDF mode.
% \begin{macrocode}
@@ -1130,7 +1130,7 @@
\tex_let:D \tex_italiccorrection:D \@@italiccorr
\tex_let:D \tex_underline:D \@@underline
% \end{macrocode}
-% Some tidying up is needed for \tn{(pdf)tracingfonts}. Newer \LuaTeX{} has
+% Some tidying up is needed for \tn[index=tracingfonts]{(pdf)tracingfonts}. Newer \LuaTeX{} has
% this simply as \tn{tracingfonts}, but that will have been overwritten by
% the \LaTeXe{} kernel. So any spurious definition has to be removed, then
% the real version saved either from the \pdfTeX{} name or from \LuaTeX{}.
Modified: trunk/l3kernel/l3prop.dtx
===================================================================
--- trunk/l3kernel/l3prop.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3prop.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -112,7 +112,8 @@
% \cs{prop_clear_new:N} \meta{property list}
% \end{syntax}
% Ensures that the \meta{property list} exists globally by applying
-% \cs{prop_new:N} if necessary, then applies \cs{prop_(g)clear:N} to leave
+% \cs{prop_new:N} if necessary, then applies
+% \cs[index=prop_clear:N]{prop_(g)clear:N} to leave
% the list empty.
% \end{function}
%
@@ -378,7 +379,7 @@
% \begin{syntax}
% \cs{prop_map_break:}
% \end{syntax}
-% Used to terminate a \cs{prop_map_\ldots} function before all
+% Used to terminate a \cs[no-index]{prop_map_\ldots} function before all
% entries in the \meta{property list} have been processed. This will
% normally take place within a conditional statement, for example
% \begin{verbatim}
@@ -391,7 +392,7 @@
% }
% }
% \end{verbatim}
-% Use outside of a \cs{prop_map_\ldots} scenario will lead to low
+% Use outside of a \cs[no-index]{prop_map_\ldots} scenario will lead to low
% level \TeX{} errors.
% \end{function}
%
@@ -399,7 +400,7 @@
% \begin{syntax}
% \cs{prop_map_break:n} \Arg{tokens}
% \end{syntax}
-% Used to terminate a \cs{prop_map_\ldots} function before all
+% Used to terminate a \cs[no-index]{prop_map_\ldots} function before all
% entries in the \meta{property list} have been processed, inserting
% the \meta{tokens} after the mapping has ended. This will
% normally take place within a conditional statement, for example
@@ -413,7 +414,7 @@
% }
% }
% \end{verbatim}
-% Use outside of a \cs{prop_map_\ldots} scenario will lead to low
+% Use outside of a \cs[no-index]{prop_map_\ldots} scenario will lead to low
% level \TeX{} errors.
% \end{function}
%
Modified: trunk/l3kernel/l3quark.dtx
===================================================================
--- trunk/l3kernel/l3quark.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3quark.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -487,7 +487,8 @@
%
% \begin{macro}{\__quark_if_recursion_tail_break:NN}
% \begin{macro}{\__quark_if_recursion_tail_break:nN}
-% Analogs of the \cs{quark_if_recursion_tail_stop\ldots{}} functions.
+% Analogs of the \cs[index=quark_if_recursion_tail_stop:n]
+% {quark_if_recursion_tail_stop\ldots{}} functions.
% Break the mapping using |#2|.
% \begin{macrocode}
\cs_new:Npn \__quark_if_recursion_tail_break:NN #1#2
Modified: trunk/l3kernel/l3seq.dtx
===================================================================
--- trunk/l3kernel/l3seq.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3seq.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -100,7 +100,8 @@
% \cs{seq_clear_new:N} \meta{sequence}
% \end{syntax}
% Ensures that the \meta{sequence} exists globally by applying
-% \cs{seq_new:N} if necessary, then applies \cs{seq_(g)clear:N} to leave
+% \cs{seq_new:N} if necessary, then applies
+% \cs[index=seq_clear:N]{seq_(g)clear:N} to leave
% the \meta{sequence} empty.
% \end{function}
%
@@ -422,7 +423,7 @@
% \end{syntax}
% Removes duplicate items from the \meta{sequence}, leaving the
% left most copy of each item in the \meta{sequence}. The \meta{item}
-% comparison takes place on a token basis, as for \cs{tl_if_eq:nn(TF)}.
+% 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
% does a comparison with the \meta{items} already checked. It is therefore
@@ -440,7 +441,7 @@
% \end{syntax}
% Removes every occurrence of \meta{item} from the \meta{sequence}.
% The \meta{item} comparison takes place on a token basis, as for
-% \cs{tl_if_eq:nn(TF)}.
+% \cs{tl_if_eq:nnTF}.
% \end{function}
%
%
@@ -524,7 +525,7 @@
% \begin{syntax}
% \cs{seq_map_break:}
% \end{syntax}
-% Used to terminate a \cs{seq_map_\ldots} function before all
+% Used to terminate a \cs[no-index]{seq_map_\ldots} function before all
% entries in the \meta{sequence} have been processed. This will
% normally take place within a conditional statement, for example
% \begin{verbatim}
@@ -537,7 +538,7 @@
% }
% }
% \end{verbatim}
-% Use outside of a \cs{seq_map_\ldots} scenario will lead to low
+% Use outside of a \cs[no-index]{seq_map_\ldots} scenario will lead to low
% level \TeX{} errors.
% \begin{texnote}
% When the mapping is broken, additional tokens may be inserted by the
@@ -551,7 +552,7 @@
% \begin{syntax}
% \cs{seq_map_break:n} \Arg{tokens}
% \end{syntax}
-% Used to terminate a \cs{seq_map_\ldots} function before all
+% Used to terminate a \cs[no-index]{seq_map_\ldots} function before all
% entries in the \meta{sequence} have been processed, inserting
% the \meta{tokens} after the mapping has ended. This will
% normally take place within a conditional statement, for example
@@ -565,7 +566,7 @@
% }
% }
% \end{verbatim}
-% Use outside of a \cs{seq_map_\ldots} scenario will lead to low
+% Use outside of a \cs[no-index]{seq_map_\ldots} scenario will lead to low
% level \TeX{} errors.
% \begin{texnote}
% When the mapping is broken, additional tokens may be inserted by the
@@ -755,7 +756,7 @@
%
% Some operations on a set \meta{seq~var} are straightforward. For
% instance, \cs{seq_count:N} \meta{seq~var} expands to the number of
-% items, while \cs{seq_if_in:Nn(TF)} \meta{seq~var} \Arg{item} tests if
+% items, while \cs{seq_if_in:NnTF} \meta{seq~var} \Arg{item} tests if
% the \meta{item} is in the set.
%
% Adding an \meta{item} to a set \meta{seq~var} can be done by appending
Modified: trunk/l3kernel/l3skip.dtx
===================================================================
--- trunk/l3kernel/l3skip.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3skip.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -112,7 +112,8 @@
% \cs{dim_zero_new:N} \meta{dimension}
% \end{syntax}
% Ensures that the \meta{dimension} exists globally by applying
-% \cs{dim_new:N} if necessary, then applies \cs{dim_(g)zero:N} to leave
+% \cs{dim_new:N} if necessary, then applies
+% \cs[index=dim_zero:N]{dim_(g)zero:N} to leave
% the \meta{dimension} set to zero.
% \end{function}
%
@@ -598,7 +599,8 @@
% \cs{skip_zero_new:N} \meta{skip}
% \end{syntax}
% Ensures that the \meta{skip} exists globally by applying
-% \cs{skip_new:N} if necessary, then applies \cs{skip_(g)zero:N} to leave
+% \cs{skip_new:N} if necessary, then applies
+% \cs[index=skip_zero:N]{skip_(g)zero:N} to leave
% the \meta{skip} set to zero.
% \end{function}
%
@@ -816,7 +818,8 @@
% \cs{muskip_zero_new:N} \meta{muskip}
% \end{syntax}
% Ensures that the \meta{muskip} exists globally by applying
-% \cs{muskip_new:N} if necessary, then applies \cs{muskip_(g)zero:N}
+% \cs{muskip_new:N} if necessary, then applies
+% \cs[index=muskip_zero:N]{muskip_(g)zero:N}
% to leave the \meta{muskip} set to zero.
% \end{function}
%
@@ -1274,7 +1277,7 @@
% \begin{macro}[aux]{\@@_case:nw, \@@_case_end:nw}
% For dimension cases, the first task to fully expand the check
% condition. The over all idea is then much the same as for
-% \cs{str_case:nn(TF)} as described in \pkg{l3basics}.
+% \cs[index=str_case:nnTF]{str_case:nn(TF)} as described in \pkg{l3basics}.
% \begin{macrocode}
\cs_new:Npn \dim_case:nnTF #1
{
Modified: trunk/l3kernel/l3str.dtx
===================================================================
--- trunk/l3kernel/l3str.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3str.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -91,8 +91,8 @@
% representation differently.
%
% Note that as string variables are a special case of token list variables
-% the coverage of \cs{str_\ldots{}:N} functions is somewhat smaller than
-% \cs{tl_\ldots{}:N}.
+% the coverage of \cs[no-index]{str_\ldots{}:N} functions is somewhat smaller than
+% \cs[no-index]{tl_\ldots{}:N}.
%
% The functions \cs{cs_to_str:N}, \cs{tl_to_str:n}, \cs{tl_to_str:N} and
% \cs{token_to_str:N} (and variants) will generate strings from the appropriate
@@ -101,11 +101,11 @@
%
% Most expandable functions in this module come in three flavours:
% \begin{itemize}
-% \item \cs{str_...:N}, which expect a token list or string
+% \item \cs[no-index]{str_\ldots{}:N}, which expect a token list or string
% variable as their argument;
-% \item \cs{str_...:n}, taking any token list (or string) as an
+% \item \cs[no-index]{str_\ldots{}:n}, taking any token list (or string) as an
% argument;
-% \item \cs{str_..._ignore_spaces:n}, which ignores any space
+% \item \cs[no-index]{str_\ldots{}_ignore_spaces:n}, which ignores any space
% encountered during the operation: these functions are typically
% faster than those which take care of escaping spaces
% appropriately.
@@ -145,7 +145,8 @@
% \cs{str_clear_new:N} \meta{str~var}
% \end{syntax}
% Ensures that the \meta{str~var} exists globally by applying
-% \cs{str_new:N} if necessary, then applies \cs{str_(g)clear:N} to leave
+% \cs{str_new:N} if necessary, then applies
+% \cs[index=str_clear:N]{str_(g)clear:N} to leave
% the \meta{str~var} empty.
% \end{function}
%
@@ -478,8 +479,10 @@
% \begin{itemize}
% \item Caseless comparisons: use \cs{str_fold_case:n} for this
% situation (case folding is district from lower casing).
-% \item Case changing text for typesetting: see the \cs{tl_lower_case:n(n)},
-% \cs{tl_upper_case:n(n)} and \cs{tl_mixed_case:n(n)} functions which
+% \item Case changing text for typesetting: see the
+% \cs[index=tl_lower_case:n]{tl_lower_case:n(n)},
+% \cs[index=tl_upper_case:n]{tl_upper_case:n(n)} and
+% \cs[index=tl_mixed_case:n]{tl_mixed_case:n(n)} functions which
% correctly deal with context-dependence and other factors appropriate
% to text case changing.
% \end{itemize}
@@ -608,7 +611,7 @@
% character basis, and is \texttt{true} if the two lists contain the same
% characters in the same order. Either \cs{prg_return_true:} or
% \cs{prg_return_false:} is then left in the input stream. This is a version
-% of \cs{str_if_eq_x:nn(TF)} coded for speed.
+% of \cs{str_if_eq_x:nnTF} coded for speed.
% \end{function}
%
% \begin{function}[EXP]{\__str_to_other:n}
@@ -879,8 +882,8 @@
% \begin{macro}[EXP, aux]{\@@_case:nnTF, \@@_case_x:nnTF}
% \begin{macro}[aux, EXP]
% {\@@_case:nw, \@@_case_x:nw, \@@_case_end:nw}
-% Much the same as \cs{tl_case:nn(TF)} here: just a change in the internal
-% comparison.
+% Much the same as \cs[index=tl_case:nn]{tl_case:nn(TF)} here:
+% just a change in the internal comparison.
% \begin{macrocode}
\cs_new:Npn \str_case:nn #1#2
{
Modified: trunk/l3kernel/l3tl.dtx
===================================================================
--- trunk/l3kernel/l3tl.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3tl.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -139,7 +139,7 @@
% \cs{tl_clear_new:N} \meta{tl~var}
% \end{syntax}
% Ensures that the \meta{tl~var} exists globally by applying
-% \cs{tl_new:N} if necessary, then applies \cs{tl_(g)clear:N} to leave
+% \cs{tl_new:N} if necessary, then applies \cs[index=tl_clear:N]{tl_(g)clear:N} to leave
% the \meta{tl~var} empty.
% \end{function}
%
@@ -577,7 +577,7 @@
% \begin{syntax}
% \cs{tl_map_break:}
% \end{syntax}
-% Used to terminate a \cs{tl_map_\ldots} function before all
+% Used to terminate a \cs[no-index]{tl_map_\ldots} function before all
% entries in the \meta{token list variable} have been processed. This
% will normally take place within a conditional statement, for example
% \begin{verbatim}
@@ -588,7 +588,7 @@
% }
% \end{verbatim}
% See also \cs{tl_map_break:n}.
-% Use outside of a \cs{tl_map_\ldots} scenario will lead to low
+% Use outside of a \cs[no-index]{tl_map_\ldots} scenario will lead to low
% level \TeX{} errors.
% \begin{texnote}
% When the mapping is broken, additional tokens may be inserted by the
@@ -602,7 +602,7 @@
% \begin{syntax}
% \cs{tl_map_break:n} \Arg{tokens}
% \end{syntax}
-% Used to terminate a \cs{tl_map_\ldots} function before all
+% Used to terminate a \cs[no-index]{tl_map_\ldots} function before all
% entries in the \meta{token list variable} have been processed, inserting
% the \meta{tokens} after the mapping has ended. This will
% normally take place within a conditional statement, for example
@@ -614,7 +614,7 @@
% % Do something useful
% }
% \end{verbatim}
-% Use outside of a \cs{tl_map_\ldots} scenario will lead to low
+% Use outside of a \cs[no-index]{tl_map_\ldots} scenario will lead to low
% level \TeX{} errors.
% \begin{texnote}
% When the mapping is broken, additional tokens may be inserted by the
@@ -1310,7 +1310,7 @@
% check definitions exist. This part of the process is done now, so that
% variable types based on |tl| (for example |clist|, |seq| and |prop|) will
% inherit the appropriate definitions.
-% No \cs{tl_map_\ldots} yet as the mechanisms are not fully in place. Thus
+% No \cs[no-index]{tl_map_\ldots} yet as the mechanisms are not fully in place. Thus
% instead do a more low level set up for a mapping, as in \pkg{l3basics}.
% \begin{macrocode}
%<*package>
@@ -1931,7 +1931,7 @@
% in various token list conditionals which reduce to testing
% if a given token list is empty after applying a simple function
% to it.
-% The test for emptiness is based on \cs{tl_if_empty:n(TF)}, but
+% The test for emptiness is based on \cs{tl_if_empty:nTF}, but
% the expansion is hard-coded for efficiency, as this auxiliary
% function is used in many places.
% Note that this works because \cs{etex_detokenize:D} expands tokens
@@ -1995,8 +1995,8 @@
% \end{macro}
%
% \begin{macro}[TF]{\tl_if_in:Nn, \tl_if_in:cn}
-% See \cs{tl_if_in:nn(TF)} for further comments. Here we simply
-% expand the token list variable and pass it to \cs{tl_if_in:nn(TF)}.
+% See \cs{tl_if_in:nnTF} for further comments. Here we simply
+% expand the token list variable and pass it to \cs{tl_if_in:nnTF}.
% \begin{macrocode}
\cs_new_protected:Npn \tl_if_in:NnT { \exp_args:No \tl_if_in:nnT }
\cs_new_protected:Npn \tl_if_in:NnF { \exp_args:No \tl_if_in:nnF }
@@ -2012,7 +2012,7 @@
% The function \cs{@@_tmp:w} removes tokens until the first occurrence
% of |#2|. If this does not appear in |#1|, then the final |#2| is removed,
% leaving an empty token list. Otherwise some tokens remain, and the
-% test is \texttt{false}. See \cs{tl_if_empty:n(TF)} for details on
+% test is \texttt{false}. See \cs{tl_if_empty:nTF} for details on
% the emptiness test.
%
% Treating correctly cases like
Modified: trunk/l3kernel/l3token.dtx
===================================================================
--- trunk/l3kernel/l3token.dtx 2016-08-19 15:21:49 UTC (rev 6684)
+++ trunk/l3kernel/l3token.dtx 2016-08-19 16:26:52 UTC (rev 6685)
@@ -1857,7 +1857,7 @@
% When a token is a macro, \cs{token_to_meaning:N} will always output
% something like |\long macro:#1->#1| so we could naively check to
% see if the meaning contains |->|. However, this can fail the five
-% \tn{...mark} primitives, whose meaning has the form
+% \tn[no-index]{...mark} primitives, whose meaning has the form
% |...mark:|\meta{user material}. The problem is that the
% \meta{user material} can contain |->|.
%
More information about the latex3-commits
mailing list