summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/l3kernel/l3doc.dtx
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-11-14 21:07:53 +0000
committerKarl Berry <karl@freefriends.org>2017-11-14 21:07:53 +0000
commit8c82df0007c957004cc2268b49ccf3ceca914f58 (patch)
treeae29044a1727ceb31a488437f43cde1a31e6e007 /Master/texmf-dist/source/latex/l3kernel/l3doc.dtx
parent4bd2a337b834181c967e774caddf57b3f747e127 (diff)
l3 (14nov17)
git-svn-id: svn://tug.org/texlive/trunk@45802 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/l3kernel/l3doc.dtx')
-rw-r--r--Master/texmf-dist/source/latex/l3kernel/l3doc.dtx240
1 files changed, 39 insertions, 201 deletions
diff --git a/Master/texmf-dist/source/latex/l3kernel/l3doc.dtx b/Master/texmf-dist/source/latex/l3kernel/l3doc.dtx
index 7bf43aa7933..2f02cd2c37a 100644
--- a/Master/texmf-dist/source/latex/l3kernel/l3doc.dtx
+++ b/Master/texmf-dist/source/latex/l3kernel/l3doc.dtx
@@ -70,14 +70,14 @@ and all files in that bundle must be distributed together.
% This isn't included in the typeset documentation because it's a bit
% ugly:
%<*class>
-\ProvidesExplClass{l3doc}{2017/09/18}{}
+\ProvidesExplClass{l3doc}{2017/11/14}{}
{L3 Experimental documentation class}
%</class>
% \fi
%
% \title{The \cls{l3doc} class}
% \author{\Team}
-% \date{Released 2017/09/18}
+% \date{Released 2017/11/14}
% \maketitle
% \tableofcontents
%
@@ -1911,7 +1911,7 @@ and all files in that bundle must be distributed together.
{ \l_@@_index_key_tl }
{ \l_@@_index_macro_tl }
{ \l_@@_index_module_tl }
- { }
+ { usage }
\l_@@_index_internal_bool
}
}
@@ -3877,7 +3877,19 @@ and all files in that bundle must be distributed together.
% \begin{macrocode}
\tl_new:N \l_@@_index_escaped_macro_tl
\tl_new:N \l_@@_index_escaped_key_tl
+% \end{macrocode}
+%
+% \begin{macrocode}
\cs_new_protected:Npn \@@_special_index_module:nnnnN #1#2#3#4#5
+% \end{macrocode}
+% \begin{arguments}
+% \item key
+% \item macro
+% \item module
+% \item index `type' (\texttt{main}/\texttt{usage}/\emph{etc.})
+% \item boolean whether internal command
+% \end{arguments}
+% \begin{macrocode}
{
\use:x
{
@@ -3899,8 +3911,24 @@ and all files in that bundle must be distributed together.
}
{#4}
}
+% \end{macrocode}
+%
+% \begin{macrocode}
\cs_generate_variant:Nn \@@_special_index_module:nnnnN { ooo }
+% \end{macrocode}
+%
+% \begin{macrocode}
\cs_new_protected:Npn \@@_special_index_aux:nnnnnn #1#2#3#4#5#6
+% \end{macrocode}
+% \begin{arguments}
+% \item key
+% \item macro
+% \item index subheading string
+% \item index subheading text
+% \item index subheading suffix (appended to both arg 3 and 4)
+% \item index `type' (\texttt{main}/\texttt{usage}/\emph{etc.})
+% \end{arguments}
+% \begin{macrocode}
{
\tl_set:Nn \l_@@_index_escaped_key_tl {#1}
\@@_quote_special_char:N \l_@@_index_escaped_key_tl
@@ -3928,6 +3956,9 @@ and all files in that bundle must be distributed together.
hdclindex{\the\c@HD@hypercount}{#6}
}
}
+% \end{macrocode}
+%
+% \begin{macrocode}
\cs_new_protected:Npn \@@_special_index_set:Nn #1#2
{
\tl_set:Nx #1 { \tl_to_str:n {#2} }
@@ -4227,15 +4258,6 @@ and all files in that bundle must be distributed together.
}
% \end{macrocode}
%
-% \subsection{Text extras}
-%
-% \begin{macrocode}
-\DeclareDocumentCommand \ie { } { \emph{i.e.} }
-\DeclareDocumentCommand \eg { } { \emph{e.g.} }
-\DeclareDocumentCommand \Ie { } { \emph{I.e.} }
-\DeclareDocumentCommand \Eg { } { \emph{E.g.} }
-% \end{macrocode}
-%
% \subsection{Math extras}
%
% For \pkg{l3fp}.
@@ -4265,6 +4287,10 @@ and all files in that bundle must be distributed together.
%
% \subsection{Makeindex configuration}
%
+% \begin{macrocode}
+%<*docist>
+% \end{macrocode}
+%
% The makeindex style \file{l3doc.ist} is used in place of the usual
% \file{gind.ist} to ensure that |I| is used in the sequence |I J K| not
% |I II II|, which would be the default makeindex behaviour.
@@ -4275,7 +4301,6 @@ and all files in that bundle must be distributed together.
% \file{gind.ist} is used instead.
%
% \begin{macrocode}
-%<*docist>
actual '='
quote '!'
level '>'
@@ -4301,198 +4326,11 @@ headings_flag 1
% and just for source3:
% Remove R so I is treated in sequence I J K not I II III
page_precedence "rnaA"
-%</docist>
% \end{macrocode}
%
-% \section{Testing}
-%
-% \begin{function}{foo}
-% \begin{syntax}
-% |\foo| \meta{something_n} \Arg{something_1}
-% \end{syntax}
-% Does \meta{something_1} with \meta{something_n}
-% \end{function}
-%
-% \begin{function}{.bool_set:N}
-% blah
-% \end{function}
-%
-% \begin{variable}
-% {
-% \c_alignment_token,
-% }
-% \end{variable}
-%
-% \begin{function}[added=2011-09-06]{\example_foo:N, \example_foo:c}
-% \begin{syntax}
-% |\example_foo:N| <arg_1>
-% |\example_foo:c| \Arg{arg_1}
-% \end{syntax}
-% <0123456789>
-% \end{function}
-%
-% \begin{function}[added=2011-09-06]
-% {\foo, \fooo:, \foooo:n, \foooo:x, \fooooo:n, \fooooo:c, \fooooo:x}
-% \begin{syntax}
-% |\example_foo:N| \meta{arg_1}
-% \end{syntax}
-% \meta{0123456789}
-% \end{function}
-%
-% \begin{function}[TF]{\foo:N, \foo_if:c}
-% Test.
-% \end{function}
-% \begin{function}[TF,EXP]{\foo:N, \foo_if:c}
-% Test.
-% \end{function}
-%
-% \begin{function}[added=2011-09-06,EXP]{\fffoo:N}
-% Test.
-% \end{function}
-% \begin{function}[added=2011-09-06,updated=2011-09-07,EXP]{\fffoo:N}
-% Test.
-% \end{function}
-% \begin{function}[updated=2011-09-06,EXP]{\fffoo:N}
-% Test.
-% \end{function}
-% \begin{function}[TF]{\ffffoo:N}
-% Test.
-% \end{function}
-% \begin{function}[pTF]{\ffoo:N}
-% \lipsum[6]
-% \end{function}
-% \begin{function}[pTF]{\ffoo:N, \ffoo:c, \ffoo:V}
-% \lipsum[6]
-% \end{function}
-% \begin{function}[pTF]{\ffoo:N, \ffoo:c}
-% \lipsum[6]
-% \end{function}
-%
-%
-% \begin{function}[TF]{\ffffoo_with_very_very_very_long_name:N}
-% \lipsum[1]
-% \end{function}
-%
-% \begin{function}[TF]
-% {
-% \ffffoo_with_very_very_very_long_name:N,
-% \ffffoo_with_very_very_very_long_name:c,
-% \ffffoo_with_very_very_very_long_name:V
-% }
-% \lipsum[1]
-% \end{function}
-%
-% \begin{function}[TF]
-% {
-% \ffffoo_with_very_very_very_long_name:N,
-% \ffffoo_with_very_very_very_long_name:c,
-% \ffffoo_with_very_very_very_long_name:V
-% }
-% \begin{syntax}
-% this is how you use it
-% \end{syntax}
-% \lipsum[1]
-% \end{function}
-%
-% \begin{function}[TF]
-% {
-% \ffffoo_with_very_very_very_long_name:N,
-% \ffffoo_with_very_very_very_long_name:V
-% }
-% \begin{syntax}
-% this is how you use it
-% \end{syntax}
-% \lipsum[1]
-% \end{function}
-%
-% \bigskip\bigskip
-%
-% \begin{macro}[aux]{\foo_aux:}
-% Testing the \enquote{aux} option.
-% \end{macro}
-%
-% \begin{macro}[TF]{\foo_if:c}
-% Testing the \enquote{TF} option.
-% \end{macro}
-% \begin{macro}[TF]{\foo_if:c, \fooo_if:n}
-% Testing the \enquote{TF} option.
-% \end{macro}
-%
-% \begin{macro}[pTF]{ \foo_if:d }
-% Testing the \enquote{pTF} option.
-% \end{macro}
-%
-% \begin{macro}[internal]{\test_internal:}
-% Testing the \enquote{internal} option.
-% \end{macro}
-%
-% \bigskip\bigskip
-%
-% \begin{macro}{\aaaa_bbbb_cccc_dddd_eeee_ffff_gggg_hhhh}
-% Long macro names need to be printed in a shorter font.
% \begin{macrocode}
+%</docist>
% \end{macrocode}
-% \end{macro}
-%
-% \begin{function}{\::N}
-% This is (no longer) weird.
-% \end{function}
-%
-% \begin{macro}{\::N}
-% This is (no longer) weird.
-% \end{macro}
-%
-% \begin{function}[EXP]{\foo}\end{function}
-% \begin{function}[rEXP]{\foo}\end{function}
-%
-% Here is some verbatim text:
-% \begin{verbatim}
-% a & B # c
-% \end{verbatim}
-% without overriding this with \pkg{fancyvrb} there would be extraneous
-% whitespace.
-%
-% \begin{macro}
-% {
-% \c_zero,
-% \c_one,
-% \c_two,
-% \c_three,
-% \c_four,
-% \c_five,
-% \c_six,
-% \c_seven,
-% \c_eight,
-% \c_nine,
-% \c_ten,
-% \c_eleven,
-% \c_sixteen,
-% \c_thirty_two,
-% \c_hundred_one,
-% \c_two_hundred_fifty_five,
-% \c_two_hundred_fifty_six,
-% \c_thousand,
-% \c_ten_thousand,
-% \c_ten_thousand_one
-% }
-% \begin{arguments}
-% \item name
-% \item parameters
-% \end{arguments}
-% Another test.
-% \end{macro}
-%
-%
-% \subsection{Macros}
-% \raggedright
-% \ExplSyntaxOn
-% \seq_map_inline:Nn \g_doc_macros_seq { \texttt{\enquote{#1}} \quad }
-% \ExplSyntaxOff
-%
-% \subsection{Functions}
-% \ExplSyntaxOn
-% \seq_map_inline:Nn \g_doc_functions_seq { \texttt{\enquote{#1}} \quad }
-% \ExplSyntaxOff
%
% \end{implementation}
%