blob: ba6acf9f80e49dbcd96708431435eaca5a3b84ac (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
% This class is buggy and needs fixing
\ProvidesClass{source2edoc}
[2021/01/14 v0.2b Quick hack to typeset source2.tex
(not usable for anything else and buggy -- will vanish again)!]
\LoadClass{l3doc}
\RemoveFromHook{begindocument}[l3doc] % drop the standard setting making " a shortverb
\AddToHook{begindocument}{\MakeShortVerb \|} % but readd | as one
%\ShowHook{begindocument}
\ExplSyntaxOn
% in 2e we have a lot of functions that have no ``user-level'' documentation so we disable
% a bogus backref in that case. Over time the sources should be clean up to have such documentation.
\cs_set_protected:Npn \__codedoc_print_documented:
{
\seq_gset_filter:NNn \g__codedoc_nested_names_seq
\g__codedoc_nested_names_seq
{ ! \__codedoc_if_macro_internal_p:n {##1} }
\seq_if_empty:NF \g__codedoc_nested_names_seq
{
% This is a crude change: we grab the first name
\__codedoc_get_hyper_target:xN
{ \seq_item:Nn \g__codedoc_nested_names_seq { 1 } }
\l__codedoc_tmpa_tl
% ... and check if it has a reference
\cs_if_exist:cT{ r@\l__codedoc_tmpa_tl }
% If it does we show it, if not we don't.
{
\int_set:Nn \l__codedoc_tmpa_int
{ \seq_count:N \g__codedoc_nested_names_seq }
\int_compare:nNnTF \l__codedoc_tmpa_int = 1 {~This~} {~These~}
\bool_if:NTF \l__codedoc_macro_var_bool {variable} {function}
\int_compare:nNnTF \l__codedoc_tmpa_int = 1 {~is~} {s~are~}
documented~on~page~
\exp_args:Nx \pageref { \l__codedoc_tmpa_tl } .
}
}
\seq_gclear:N \g__codedoc_nested_names_seq
}
% some l3doc's def are buggy (already fixed there but not distributed yet)
\RenewDocumentCommand \DocInclude { m }
{
\relax\clearpage
\docincludeaux
\IfFileExists{#1.fdd}
{ \cs_set:Npn \currentfile{#1.fdd} }
{ \cs_set:Npn \currentfile{#1.dtx} }
\int_compare:nNnTF \@auxout = \@partaux
{ \@latexerr{\string\include\space cannot~be~nested}\@eha }
{ \@docinclude {#1} } % <--- braces needed!
}
\cs_gset:Npn \@docinclude #1
{
\clearpage
\immediate\write\@mainaux{\string\@input{#1.aux}}
\@tempswatrue
\if@partsw
\@tempswafalse
\cs_set:Npx \@tempb {#1}
\clist_map_inline:Nn \@partlist
{
\if_meaning:w \@tempa \@tempb
\@tempswatrue
\fi:
}
\fi
\if@tempswa
\cs_set_eq:NN \@auxout \@partaux
\immediate\openout\@partaux #1.aux
\immediate\write\@partaux{\relax}
\cs_set_eq:NN \@ltxdoc@PrintIndex \PrintIndex
\cs_set_eq:NN \PrintIndex \relax
\cs_set_eq:NN \@ltxdoc@PrintChanges \PrintChanges
\cs_set_eq:NN \PrintChanges \relax
\cs_set_eq:NN \@ltxdoc@theglossary \theglossary
\cs_set_eq:NN \@ltxdoc@endtheglossary \endtheglossary
\part{\currentfile}
{
\cs_set_eq:NN \ttfamily\relax
\cs_gset:Npx \filekey
{ \filekey,~ \thepart = { \ttfamily \currentfile } } % <-- mising spaces considered harmful
}
\DocInput{\currentfile}
\cs_set_eq:NN \PrintIndex \@ltxdoc@PrintIndex
\cs_set_eq:NN \PrintChanges \@ltxdoc@PrintChanges
\cs_set_eq:NN \theglossary \@ltxdoc@theglossary
\cs_set_eq:NN \endtheglossary \@ltxdoc@endtheglossary
\clearpage
\@writeckpt{#1}
\immediate \closeout \@partaux
\else
\@nameuse{cp@#1}
\fi
\cs_set_eq:NN \@auxout \@mainaux
}
% change the setup here: we have a lot of long names so better run raggeded
\cs_set_protected:Npn \__codedoc_macro_end_style:n #1
{
\nobreak \noindent
{ \raggedright\hangindent1pc \footnotesize ( \emph{#1} ) \par }
}
% next two declarations should move to l3doc.cls in the l3kernel eventually
% they should be ``new'' not ``set'' but to avoid getting in timing issues
% when they will be officially defined we use ``set'' here
\cs_set_eq:NN \__codedoc_saved_detect_internals:N \__codedoc_detect_internals:N
% maybe this change should be local so that it automatically reverts on \verb=\end{macro}=
% without the need to explicitly turn it on again.
\cs_new_protected:Npn \InternalDetectionOff
{ \cs_gset_eq:NN \__codedoc_detect_internals:N \use_none:n }
\cs_new_protected:Npn \InternalDetectionOn
{ \cs_gset_eq:NN \__codedoc_detect_internals:N \__codedoc_saved_detect_internals:N }
\ExplSyntaxOff
\def\partname{File}
\gdef\codeline@wrindex#1{\if@filesw
\begingroup
\let\protect\noexpand
\immediate\write\@indexfile
{\string\indexentry{#1}%
{\filesep\number\c@CodelineNo}}%
\endgroup\fi}
\let\filesep\@empty
\def\aalph#1{\@aalph{\csname c@#1\endcsname}}
\def\@aalph#1{%
\ifcase#1\or a\or b\or c\or d\or e\or f\or g\or h\or i\or
j\or k\or l\or m\or n\or o\or p\or q\or r\or s\or
t\or u\or v\or w\or x\or y\or z\or A\or B\or C\or
D\or E\or F\or G\or H\or I\or J\or K\or L\or M\or
N\or O\or P\or Q\or R\or S\or T\or U\or V\or W\or
X\or Y\or Z\else\@ctrerr\fi}
\def\docincludeaux{%
\def\thepart{\aalph{part}}\def\filesep{\thepart-}%
\let\filekey\@gobble
\g@addto@macro\index@prologue{%
\gdef\@oddfoot{\parbox[t]{\textwidth}{\strut\footnotesize
\raggedright{\bfseries File Key:} \filekey}}%
\let\@evenfoot\@oddfoot}%
\global\let\docincludeaux\relax
\gdef\@oddfoot{%
\expandafter\ifx\csname ver@\currentfile\endcsname\relax
File \thepart: {\ttfamily\currentfile} %
\else
\GetFileInfo{\currentfile}%
File \thepart: {\ttfamily\filename} %
Date: \filedate\ %
Version \fileversion
\fi
\hfill\thepage}%
\let\@evenfoot\@oddfoot}%
\def\MaintainedBy#1{\gdef\@maintainedby{#1}}
\let\@maintainedby\@empty
\def\MaintainedByLaTeXTeam#1{%
{\gdef\@maintainedby{%
This file is maintained by the \LaTeX{} Project team.\\%
Bug reports can be opened (category \texttt{#1}) at\\%
\url{https://latex-project.org/bugs.html}.}}}
\def\@maketitle{%
\newpage
\null
\vskip 2em%
\begin{center}%
\let \footnote \thanks
{\LARGE \@title \par}%
\vskip 1.5em%
{\large
\lineskip .5em%
\begin{tabular}[t]{c}%
\@author
\end{tabular}\par}%
\vskip 1em%
{\large \@date}%
\ifx\@maintainedby\@empty
\else
\vskip 1em%
\fbox{\fbox{\begin{tabular}{@{}l@{}}\@maintainedby\end{tabular}}}%
\fi
\end{center}%
\par
\vskip 1.5em}
\providecommand\url{\texttt}
\def\task#1#2{}
\def\oc@scan#1{%
\ifx\oc@bslash#1%
\egroup\let\next\oc@bslash\else
\ifcat a\noexpand#1%
#1\let\next\oc@scan\else
\ifx\oc@percent#1%
\def\next{\char`\%\egroup}%
\else
#1\let\next\egroup
\fi\fi\fi\next}
\def\oc@bslash{\bgroup\oc@ttf\char`\\\oc@scan}%
\def\oc@verb#1{%
\catcode`#1\active
\uccode`\~`#1%
\uppercase{\def~{{\oc@ttf\char`#1}}}}
\begingroup
\obeyspaces%
\catcode`\/=\catcode`\\
/catcode`/\/active
/catcode`<=/catcode`{%
/catcode`>=/catcode`}%
/catcode`/{/active%
/catcode`/}/active%
/gdef/oldc< \end{oldcomments}>%
/gdef/begmac< \begin{macrocode}>%
/gdef/obs</def <</oc@ttf/ >>>%
/endgroup%
\begingroup
\catcode`\/=\catcode`\\
\catcode`\\=13
/catcode`/|=/catcode`/%
/catcode`/%=13
/gdef/oldcomments{|
/makeatletter
/let/do/oc@verb/dospecials
/frenchspacing/@vobeyspaces/obs
/raggedright
/oc@verb/>|
/oc@verb/<|
/let\/oc@bslash
/let%/oc@percent
/obeylines
/parindent/z@
/ttfamily/expandafter/let/expandafter/oc@ttf/the/font
/rmfamily
/textit{Historical /LaTeX/,2.09 comments (not necessarily accurate any more):}
/hfuzz/maxdimen
}
/endgroup
\begingroup
\sloppy%
\obeylines%
\gdef\oc@percent#1^^M{%
\ifvmode%
\def\commentline{#1}%
\ifx\commentline\oldc%
\textit{End of historical \LaTeX\,2.09 comments.}
\end{oldcomments}%
\else%
\ifx\commentline\begmac%
\begin{macrocode}%
\else%
\leavevmode%
#1^^M%
\fi\fi%
\else%
{\oc@ttf\char`\%}#1^^M%
\fi}%
\endgroup%
\InputIfFileExists{ltxdoc.cfg}
{\typeout{*************************************^^J%
* Local config file ltxdoc.cfg used^^J%
*************************************}}
{}
\errorstopmode
\batchmode
\endinput
|
