[latex3-commits] [git/LaTeX3-latex3-latex3] gh450: Improve interface3.pdf index by setting module for various commands (a7b2e7796)

Bruno Le Floch blflatex at gmail.com
Tue Apr 27 17:05:36 CEST 2021


Repository : https://github.com/latex3/latex3
On branch  : gh450
Link       : https://github.com/latex3/latex3/commit/a7b2e7796771154638d73ad6df3aa6c299aa9165

>---------------------------------------------------------------

commit a7b2e7796771154638d73ad6df3aa6c299aa9165
Author: Bruno Le Floch <blflatex at gmail.com>
Date:   Fri Apr 23 19:19:54 2021 +0200

    Improve interface3.pdf index by setting module for various commands


>---------------------------------------------------------------

a7b2e7796771154638d73ad6df3aa6c299aa9165
 l3kernel/doc/source3body.tex |  2 +-
 l3kernel/l3color.dtx         |  2 +-
 l3kernel/l3doc.dtx           |  2 +-
 l3kernel/l3fp.dtx            | 34 +++++++++++++++++-----------------
 l3kernel/l3int.dtx           |  6 +++---
 l3kernel/l3regex.dtx         |  8 ++++----
 l3kernel/l3str.dtx           |  2 +-
 l3kernel/l3tl-analysis.dtx   |  2 +-
 l3kernel/l3token.dtx         |  6 +++---
 9 files changed, 32 insertions(+), 32 deletions(-)

diff --git a/l3kernel/doc/source3body.tex b/l3kernel/doc/source3body.tex
index 588dba100..946f7a4ab 100644
--- a/l3kernel/doc/source3body.tex
+++ b/l3kernel/doc/source3body.tex
@@ -257,7 +257,7 @@ following argument specifiers:
     applies to delimited values (where the argument must be terminated
     by some specified string).
   \item[\texttt{D}] The \texttt{D} stands for \textbf{Do not use}.
-    All of the \TeX{} primitives are initially \cs{let} to a \texttt{D}
+    All of the \TeX{} primitives are initially \cs[no-index]{let} to a \texttt{D}
     name, and some are then given a second name.
     These functions have no standardized syntax, they are engine
     dependent and their name can change without warning, thus their
diff --git a/l3kernel/l3color.dtx b/l3kernel/l3color.dtx
index d05784a37..30cd9bbc1 100644
--- a/l3kernel/l3color.dtx
+++ b/l3kernel/l3color.dtx
@@ -299,7 +299,7 @@
 %   \meta{value(s)} for filling or stroking.
 % \end{function}
 %
-% \begin{variable}{color.sc}
+% \begin{variable}[module = color]{color.sc}
 %   When using \texttt{dvips}, this PostScript variables hold the stroke color.
 % \end{variable}
 %
diff --git a/l3kernel/l3doc.dtx b/l3kernel/l3doc.dtx
index 255bddaba..965fd8026 100644
--- a/l3kernel/l3doc.dtx
+++ b/l3kernel/l3doc.dtx
@@ -4387,7 +4387,7 @@ and all files in that bundle must be distributed together.
         \str_case:fn { \str_head:N \l_@@_index_key_tl }
           {
             { q } { \tl_set:Nn \l_@@_index_module_tl { quark } }
-            { s } { \tl_set:Nn \l_@@_index_module_tl { quark } }
+            { s } { \tl_set:Nn \l_@@_index_module_tl { scan } }
           }
         \@@_key_pop:
         \@@_key_pop:
diff --git a/l3kernel/l3fp.dtx b/l3kernel/l3fp.dtx
index 476e7a878..4be73958d 100644
--- a/l3kernel/l3fp.dtx
+++ b/l3kernel/l3fp.dtx
@@ -650,29 +650,29 @@
 %
 % \section{Some useful constants, and scratch variables}
 %
-% \begin{variable}[added = 2012-05-08]{\c_zero_fp, \c_minus_zero_fp}
+% \begin{variable}[added = 2012-05-08, module = fp]{\c_zero_fp, \c_minus_zero_fp}
 %   Zero, with either sign.
 % \end{variable}
 %
-% \begin{variable}[added = 2012-05-08]{\c_one_fp}
+% \begin{variable}[added = 2012-05-08, module = fp]{\c_one_fp}
 %   One as an \texttt{fp}: useful for comparisons in some places.
 % \end{variable}
 %
-% \begin{variable}[added = 2012-05-08]{\c_inf_fp, \c_minus_inf_fp}
+% \begin{variable}[added = 2012-05-08, module = fp]{\c_inf_fp, \c_minus_inf_fp}
 %   Infinity, with either sign.  These can be input directly in a
 %   floating point expression as \texttt{inf} and \texttt{-inf}.
 % \end{variable}
 %
-% \begin{variable}[updated = 2012-05-08]{\c_e_fp}
+% \begin{variable}[updated = 2012-05-08, module = fp]{\c_e_fp}
 %   The value of the base of the natural logarithm, $\mathrm{e} = \exp(1)$.
 % \end{variable}
 %
-% \begin{variable}[updated = 2013-11-17]{\c_pi_fp}
+% \begin{variable}[updated = 2013-11-17, module = fp]{\c_pi_fp}
 %   The value of~$\pi$.  This can be input directly in a floating point
 %   expression as~\texttt{pi}.
 % \end{variable}
 %
-% \begin{variable}[added = 2012-05-08, updated = 2013-11-17]
+% \begin{variable}[added = 2012-05-08, updated = 2013-11-17, module = fp]
 %   {\c_one_degree_fp}
 %   The value of $1^{\circ}$ in radians.  Multiply an angle given in
 %   degrees by this value to obtain a result in radians.  Note that
@@ -681,14 +681,14 @@
 %   can be accessed as \texttt{deg}.
 % \end{variable}
 %
-% \begin{variable}{\l_tmpa_fp, \l_tmpb_fp}
+% \begin{variable}[module = fp]{\l_tmpa_fp, \l_tmpb_fp}
 %   Scratch floating points for local assignment. These are never used by
 %   the kernel code, and so are safe for use with any \LaTeX3-defined
 %   function. However, they may be overwritten by other non-kernel
 %   code and so should only be used for short-term storage.
 % \end{variable}
 %
-% \begin{variable}{\g_tmpa_fp, \g_tmpb_fp}
+% \begin{variable}[module = fp]{\g_tmpa_fp, \g_tmpb_fp}
 %   Scratch floating points for global assignment. These are never used by
 %   the kernel code, and so are safe for use with any \LaTeX3-defined
 %   function. However, they may be overwritten by other non-kernel
@@ -757,7 +757,7 @@
 %   \emph{This function is experimental, and may be altered or removed.}
 % \end{function}
 %
-% \begin{variable}
+% \begin{variable}[module = fp]
 %   {
 %     flag fp_overflow,
 %     flag fp_underflow,
@@ -843,7 +843,7 @@
 % valid floating point numbers.  Note that the latter could be mistaken
 % with the difference of \enquote{\texttt{e}} and $1$.  To avoid
 % confusions, the base of natural logarithms cannot be input as |e| and
-% should be input as \texttt{exp(1)} or \cs{c_e_fp} (which is faster).
+% should be input as \texttt{exp(1)} or \cs[module = fp]{c_e_fp} (which is faster).
 %
 % Special numbers are input as follows:
 % \begin{itemize}
@@ -904,7 +904,7 @@
 % specified, providing a tuple as an argument of any other operation
 % yields the \enquote{invalid operation} exception and a \nan{} result.
 %
-% \begin{function}[tested = m3fp-logic002]{?:}
+% \begin{function}[tested = m3fp-logic002, module = {}]{?:}
 %   \begin{syntax}
 %     \cs{fp_eval:n} \{ \meta{operand_1} |?| \meta{operand_2} |:| \meta{operand_3} \}
 %   \end{syntax}
@@ -1350,16 +1350,16 @@
 %
 % \begin{variable}[tested = m3fp-parse001]{inf, nan}
 %   The special values $+\infty$, $-\infty$, and \nan{} are represented
-%   as \texttt{inf}, \texttt{-inf} and \texttt{nan} (see \cs{c_inf_fp},
-%   \cs{c_minus_inf_fp} and \cs{c_nan_fp}).
+%   as \texttt{inf}, \texttt{-inf} and \texttt{nan} (see \cs[module = fp]{c_inf_fp},
+%   \cs[module = fp]{c_minus_inf_fp} and \cs[module = fp]{c_nan_fp}).
 % \end{variable}
 %
 % \begin{variable}[tested = m3fp-parse001]{pi}
-%   The value of $\pi$ (see \cs{c_pi_fp}).
+%   The value of $\pi$ (see \cs[module = fp]{c_pi_fp}).
 % \end{variable}
 %
 % \begin{variable}[tested = m3fp-parse001]{deg}
-%   The value of $1^{\circ}$ in radians (see \cs{c_one_degree_fp}).
+%   The value of $1^{\circ}$ in radians (see \cs[module = fp]{c_one_degree_fp}).
 % \end{variable}
 %
 % \begin{variable}[tested = m3fp-parse001]
@@ -1487,8 +1487,8 @@
 %     hard-code the logarithms of $44$ small integers instead of $9$.
 %   \item Improve notations in the explanations of the division
 %     algorithm (\pkg{l3fp-basics}).
-%   \item Understand and document \cs{__fp_basics_pack_weird_low:NNNNw}
-%     and \cs{__fp_basics_pack_weird_high:NNNNNNNNw} better.  Move the
+%   \item Understand and document \cs[no-index]{__fp_basics_pack_weird_low:NNNNw}
+%     and \cs[no-index]{__fp_basics_pack_weird_high:NNNNNNNNw} better.  Move the
 %     other \texttt{basics_pack} auxiliaries to \pkg{l3fp-aux} under a
 %     better name.
 %   \item Find out if underflow can really occur for trigonometric
diff --git a/l3kernel/l3int.dtx b/l3kernel/l3int.dtx
index 1e6217db9..54a621abd 100644
--- a/l3kernel/l3int.dtx
+++ b/l3kernel/l3int.dtx
@@ -891,15 +891,15 @@
 %   literal numbers.
 % \end{variable}
 %
-% \begin{variable}{\c_max_int}
+% \begin{variable}[module = int]{\c_max_int}
 %   The maximum value that can be stored as an integer.
 % \end{variable}
 %
-% \begin{variable}{\c_max_register_int}
+% \begin{variable}[module = int]{\c_max_register_int}
 %   Maximum number of registers.
 % \end{variable}
 %
-% \begin{variable}{\c_max_char_int}
+% \begin{variable}[module = int]{\c_max_char_int}
 %   Maximum character code completely supported by the engine.
 % \end{variable}
 %
diff --git a/l3kernel/l3regex.dtx b/l3kernel/l3regex.dtx
index 24e6cfb65..594667a62 100644
--- a/l3kernel/l3regex.dtx
+++ b/l3kernel/l3regex.dtx
@@ -87,8 +87,8 @@
 % \begin{verbatim}
 %   \regex_const:Nn \c_foo_regex { \c{begin} \cB. (\c[^BE].*) \cE. }
 % \end{verbatim}
-% stores in \cs{c_foo_regex} a regular expression which matches the
-% starting marker for an environment: \cs{begin}, followed by a
+% stores in \cs[no-index]{c_foo_regex} a regular expression which matches the
+% starting marker for an environment: \cs[no-index]{begin}, followed by a
 % begin-group token (|\cB.|), then any number of tokens which are
 % neither begin-group nor end-group character tokens (|\c[^BE].*|),
 % ending with an end-group token (|\cE.|). As explained in the next
@@ -329,7 +329,7 @@
 % \begin{l3regex-syntax}
 %   \item[\\c\Arg{regex}] A control sequence whose csname matches the
 %     \meta{regex}, anchored at the beginning and end, so that |\c{begin}|
-%     matches exactly \cs{begin}, and nothing else.
+%     matches exactly \cs[no-index]{begin}, and nothing else.
 %   \item[\\cX] Applies to the next object, which can be a character,
 %     character property, class, or group, and forces this object to
 %     only match tokens with category |X| (any of |CBEMTPUDSLOA|. For
@@ -749,7 +749,7 @@
 %   \item Add tracing information.
 %   \item Detect attempts to use back-references and other
 %     non-implemented syntax.
-%   \item Test for the maximum register \cs{c_max_register_int}.
+%   \item Test for the maximum register \cs[no-index]{c_max_register_int}.
 %   \item Find out whether the fact that |\W| and friends match the
 %     end-marker leads to bugs. Possibly update \cs[no-index]{__regex_item_reverse:n}.
 %   \item The empty cs should be matched by |\c{}|, not by
diff --git a/l3kernel/l3str.dtx b/l3kernel/l3str.dtx
index 2a0b175bf..953d36646 100644
--- a/l3kernel/l3str.dtx
+++ b/l3kernel/l3str.dtx
@@ -815,7 +815,7 @@
 %
 % \section{Constant token lists}
 %
-% \begin{variable}[added = 2015-09-19,updated=2020-12-22]
+% \begin{variable}[added = 2015-09-19, updated = 2020-12-22, module = str]
 %   {
 %     \c_ampersand_str,
 %     \c_atsign_str,
diff --git a/l3kernel/l3tl-analysis.dtx b/l3kernel/l3tl-analysis.dtx
index 611e4f5b8..7fb098f5b 100644
--- a/l3kernel/l3tl-analysis.dtx
+++ b/l3kernel/l3tl-analysis.dtx
@@ -73,7 +73,7 @@
 %     writing |"|\meta{catcode}.
 % \end{itemize}
 % In addition, there is a debugging function \cs{tl_analysis_show:n},
-% very similar to the \cs{ShowTokens} macro from the \pkg{ted} package.
+% very similar to the \cs[no-index]{ShowTokens} macro from the \pkg{ted} package.
 %
 % \begin{function}[added = 2018-04-09]{\tl_analysis_show:N, \tl_analysis_show:n}
 %   \begin{syntax}
diff --git a/l3kernel/l3token.dtx b/l3kernel/l3token.dtx
index 533eee4df..daa970c05 100644
--- a/l3kernel/l3token.dtx
+++ b/l3kernel/l3token.dtx
@@ -74,7 +74,7 @@
 % tokens of different shapes with the same meaning, but not the
 % converse.
 %
-% For instance, \cs{if:w}, \cs{if_charcode:w}, and \cs{tex_if:D} are
+% For instance, \cs{if:w}, \cs{if_charcode:w}, and \cs[no-index]{tex_if:D} are
 % three names for the same internal operation of \TeX{}, namely the
 % primitive testing the next two characters for equality of their
 % character code.  They have the same meaning hence behave identically
@@ -423,7 +423,7 @@
 %
 % \section{Generic tokens}
 %
-% \begin{variable}
+% \begin{variable}[module = token]
 %   {
 %     \c_group_begin_token,
 %     \c_group_end_token,
@@ -1166,7 +1166,7 @@
 %     conditional is encountered before the conditional is evaluated.
 %   \item Expanding \tn{noexpand} \meta{token} (when the \meta{token} is
 %     expandable) results in an internal token, displayed (temporarily)
-%     as \cs{notexpanded: \meta{token}}, whose shape coincides with the
+%     as \cs[module = {}]{notexpanded: \meta{token}}, whose shape coincides with the
 %     \meta{token} and whose meaning differs from \tn{relax}.
 %   \item An |\outer endtemplate:| can be encountered when peeking ahead
 %     at the next token; this expands to another internal token,





More information about the latex3-commits mailing list.