[latex3-commits] [git/LaTeX3-latex3-latex3] master: Put some docs back (d2f759d)

Joseph Wright joseph.wright at morningstar2.co.uk
Mon Apr 2 17:01:04 CEST 2018


Repository : https://github.com/latex3/latex3
On branch  : master
Link       : https://github.com/latex3/latex3/commit/d2f759dd2a03b2efe5c9f68ecd7b2db5ecbfa5b9

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

commit d2f759dd2a03b2efe5c9f68ecd7b2db5ecbfa5b9
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Mon Apr 2 16:01:04 2018 +0100

    Put some docs back


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

d2f759dd2a03b2efe5c9f68ecd7b2db5ecbfa5b9
 l3kernel/l3basics.dtx |   38 ++++++++++++++++++++++++++++++++++++++
 l3kernel/l3expan.dtx  |   17 +++++++++++++++++
 l3kernel/l3prop.dtx   |   48 ++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 103 insertions(+)

diff --git a/l3kernel/l3basics.dtx b/l3kernel/l3basics.dtx
index 81e63fa..9aa4444 100644
--- a/l3kernel/l3basics.dtx
+++ b/l3kernel/l3basics.dtx
@@ -1159,6 +1159,17 @@
 %   error.
 % \end{function}
 %
+% \begin{function}[EXP]{\__cs_count_signature:N, \__cs_count_signature:c}
+%   \begin{syntax}
+%     \cs{__cs_count_signature:N} \meta{function}
+%   \end{syntax}
+%   Splits the \meta{function} into the \meta{name} (\emph{i.e.}~the part
+%   before the colon) and the \meta{signature} (\emph{i.e.}~after the colon).
+%   The \meta{number} of tokens in the \meta{signature} is then left in
+%   the input stream. If there was no \meta{signature} then the result is
+%   the marker value $-1$.
+% \end{function}
+%
 % \begin{function}[EXP]{\__cs_split_function:NN}
 %   \begin{syntax}
 %     \cs{__cs_split_function:NN} \meta{function} \meta{processor}
@@ -1175,6 +1186,33 @@
 %   specification \texttt{:nnN} (plus any trailing arguments needed).
 % \end{function}
 %
+% \begin{function}[EXP]{\__cs_get_function_name:N}
+%   \begin{syntax}
+%     \cs{__cs_get_function_name:N} \meta{function}
+%   \end{syntax}
+%   Splits the \meta{function} into the \meta{name} (\emph{i.e.}~the part
+%   before the colon) and the \meta{signature} (\emph{i.e.}~after the colon).
+%   The \meta{name} is then left in the input stream without the escape
+%   character present made up of tokens with category code $12$
+%   (other).
+% \end{function}
+%
+% \begin{function}[EXP]{\__cs_get_function_signature:N}
+%   \begin{syntax}
+%     \cs{__cs_get_function_signature:N} \meta{function}
+%   \end{syntax}
+%   Splits the \meta{function} into the \meta{name} (\emph{i.e.}~the part
+%   before the colon) and the \meta{signature} (\emph{i.e.}~after the colon).
+%   The \meta{signature} is then left in the input stream made up of
+%   tokens with category code $12$ (other).
+% \end{function}
+%
+% \begin{function}{\__cs_tmp:w}
+%   Function used for various short-term usages, for instance defining
+%   functions whose definition involves tokens which are hard to insert
+%   normally (spaces, characters with category other).
+% \end{function}
+%
 % \begin{function}{\__kernel_debug:TF}
 %   \begin{syntax}
 %     \cs{__kernel_debug:TF} \Arg{true code} \Arg{false code}
diff --git a/l3kernel/l3expan.dtx b/l3kernel/l3expan.dtx
index 73bcda2..871763e 100644
--- a/l3kernel/l3expan.dtx
+++ b/l3kernel/l3expan.dtx
@@ -797,6 +797,23 @@
 %   braces will not terminate the \texttt{f}-type expansion.
 % \end{function}
 %
+% \section{Internal functions and variables}
+%
+% \begin{variable}{\l__exp_internal_tl}
+%   The |\exp_| module has its private variable to temporarily store the
+%   result of |x|-type argument expansion. This is done to avoid interference
+%   with other functions using temporary variables.
+% \end{variable}
+%
+% \begin{function}{\::n, \::N, \::p, \::c, \::o, \::f, \::x, \::v, \::V, \:::}
+%   \begin{syntax}
+%     |\cs_set:Npn \exp_args:Ncof { \::c \::o \::f \::: }|
+%   \end{syntax}
+%   Internal forms for the base expansion types. These names do \emph{not}
+%   conform to the general \LaTeX3 approach as this makes them more readily
+%   visible in the log and so forth.
+% \end{function}
+%
 % \end{documentation}
 %
 % \begin{implementation}
diff --git a/l3kernel/l3prop.dtx b/l3kernel/l3prop.dtx
index b226a40..00b9872 100644
--- a/l3kernel/l3prop.dtx
+++ b/l3kernel/l3prop.dtx
@@ -447,6 +447,54 @@
 %   A permanently-empty property list used for internal comparisons.
 % \end{variable}
 %
+% \section{Internal property list functions}
+%
+% \begin{variable}{\s__prop}
+%   The internal token used at the beginning of property lists.  This is
+%   also used after each \meta{key} (see \cs{__prop_pair:wn}).
+% \end{variable}
+%
+% \begin{variable}{\__prop_pair:wn}
+%   \begin{syntax}
+%     \cs{__prop_pair:wn} \meta{key} \cs{s__prop} \Arg{item}
+%   \end{syntax}
+%   The internal token used to begin each key--value pair in the
+%   property list.  If expanded outside of a mapping or manipulation
+%   function, an error is raised.  The definition should always be
+%   set globally.
+% \end{variable}
+%
+% \begin{variable}{\l__prop_internal_tl}
+%   Token list used to store new key--value pairs to be inserted by
+%   functions of the \cs{prop_put:Nnn} family.
+% \end{variable}
+%
+% \begin{function}[updated = 2013-01-08]{\__prop_split:NnTF}
+%   \begin{syntax}
+%     \cs{__prop_split:NnTF} \meta{property list} \Arg{key} \Arg{true code} \Arg{false code}
+%   \end{syntax}
+%   Splits the \meta{property list} at the \meta{key}, giving three
+%   token lists: the \meta{extract} of \meta{property list} before the
+%   \meta{key}, the \meta{value} associated with the \meta{key} and the
+%   \meta{extract} of the \meta{property list} after the \meta{value}.
+%   Both \meta{extracts} retain the internal structure of a property
+%   list, and the concatenation of the two \meta{extracts} is a
+%   property list.
+%   If the \meta{key} is present in the \meta{property list} then the
+%   \meta{true code} is left in the input stream, with |#1|, |#2|, and
+%   |#3| replaced by the first \meta{extract}, the \meta{value}, and the
+%   second extract.
+%   If the \meta{key} is not present in the \meta{property list} then
+%   the \meta{false code} is left in the input stream, with no trailing
+%   material.
+%   Both \meta{true code} and \meta{false code} are used in the
+%   replacement text of a macro defined internally, hence macro
+%   parameter characters should be doubled, except |#1|, |#2|, and |#3|
+%   which stand in the \meta{true code} for the three extracts from the
+%   property list.
+%   The \meta{key} comparison takes place as described for \cs{str_if_eq:nn}.
+% \end{function}
+%
 % \end{documentation}
 %
 % \begin{implementation}





More information about the latex3-commits mailing list