latex2e-20160201/base/source2e.tex

   1 % \iffalse meta-comment
   2 %
   3 % Copyright 1993-2016
   4 % The LaTeX3 Project and any individual authors listed elsewhere
   5 % in this file.
   6 %
   7 % This file is part of the LaTeX base system.
   8 % -------------------------------------------
   9 %
  10 % It may be distributed and/or modified under the
  11 % conditions of the LaTeX Project Public License, either version 1.3c
  12 % of this license or (at your option) any later version.
  13 % The latest version of this license is in
  14 %    http://www.latex-project.org/lppl.txt
  15 % and version 1.3c or later is part of all distributions of LaTeX
  16 % version 2005/12/01 or later.
  17 %
  18 % This file has the LPPL maintenance status "maintained".
  19 %
  20 % The list of all files belonging to the LaTeX base distribution is
  21 % given in the file `manifest.txt'. See also `legal.txt' for additional
  22 % information.
  23 %
  24 % The list of derived (unpacked) files belonging to the distribution
  25 % and covered by LPPL is defined by the unpacking scripts (with
  26 % extension .ins) which are part of the distribution.
  27 %
  28 % \fi
  29
  30 % This document will typeset the LaTeX sources as a single document.
  31 % This will produce quite a large file (roughly 555 pages) and may
  32 % take a long time.
  33 %
  34 % Some notes on processing this document are contained at the end
  35 % of this document, after \end{document}
  36 %
  37 % DPC 1997/11/17
  38 %
  39 % First a special index style for makeindex
  40 %
  41
  42 \begin{filecontents}{source2e.ist}
  43 actual '='
  44 quote '!'
  45 level '>'
  46 preamble
  47 "\n \\begin{theindex} \n \\makeatletter\\scan@allowedfalse\n"
  48 postamble
  49 "\n\n \\end{theindex}\n"
  50 item_x1   "\\efill \n \\subitem "
  51 item_x2   "\\efill \n \\subsubitem "
  52 delim_0   "\\pfill "
  53 delim_1   "\\pfill "
  54 delim_2   "\\pfill "
  55 % The next lines will produce some warnings when
  56 % running Makeindex as they try to cover two different
  57 % versions of the program:
  58 lethead_prefix   "{\\bfseries\\hfil "
  59 lethead_suffix   "\\hfil}\\nopagebreak\n"
  60 lethead_flag       1
  61 heading_prefix   "{\\bfseries\\hfil "
  62 heading_suffix   "\\hfil}\\nopagebreak\n"
  63 headings_flag       1
  64
  65 % and just for source2e:
  66 % Remove R so I is treated in sequence I J K not I II III
  67 page_precedence "rnaA"
  68 \end{filecontents}
  69
  70
  71
  72 \documentclass{ltxdoc}
  73
  74 \listfiles
  75
  76 % Do not index some TeX primitives, and some common plain TeX commands.
  77
  78 \DoNotIndex{\def,\long,\edef,\xdef,\gdef,\let,\global}
  79 \DoNotIndex{\if,\ifnum,\ifdim,\ifcat,\ifmmode,\ifvmode,\ifhmode,%
  80             \iftrue,\iffalse,\ifvoid,\ifx,\ifeof,\ifcase,\else,\or,\fi}
  81 \DoNotIndex{\box,\copy,\setbox,\unvbox,\unhbox,\hbox,%
  82             \vbox,\vtop,\vcenter}
  83 \DoNotIndex{\@empty,\immediate,\write}
  84 \DoNotIndex{\egroup,\bgroup,\expandafter,\begingroup,\endgroup}
  85 \DoNotIndex{\divide,\advance,\multiply,\count,\dimen}
  86 \DoNotIndex{\relax,\space,\string}
  87 \DoNotIndex{\csname,\endcsname,\@spaces,\openin,\openout,%
  88             \closein,\closeout}
  89 \DoNotIndex{\catcode,\endinput}
  90 \DoNotIndex{\jobname,\message,\read,\the,\m@ne,\noexpand}
  91 \DoNotIndex{\hsize,\vsize,\hskip,\vskip,\kern,\hfil,\hfill,\hss}
  92 \DoNotIndex{\m@ne,\z@,\z@skip,\@ne,\tw@,\p@}
  93 \DoNotIndex{\dp,\wd,\ht,\vss,\unskip}
  94
  95 % Set up the Index and Change History to use \part
  96 \IndexPrologue{\part*{Index}%
  97                  \markboth{Index}{Index}%
  98                  \addcontentsline{toc}{part}{Index}%
  99                  The italic numbers denote the pages where the
 100                  corresponding entry is described,
 101                  numbers underlined point to the definition,
 102                  all others indicate the places where it is used.}
 103
 104 \GlossaryPrologue{\part*{Change History}%
 105 %                Allow control names to be hyphenated here...
 106                  {\GlossaryParms\ttfamily\hyphenchar\font=`\-}%
 107                  \markboth{Change History}{Change History}%
 108                  \addcontentsline{toc}{part}{Change History}}
 109
 110 % The standard \changes command modified slightly to better cope with
 111 % this multiple file document.
 112 \makeatletter
 113 \def\changes@#1#2#3{%
 114   \let\protect\@unexpandable@protect
 115   \edef\@tempa{\noexpand\glossary{#2\space\currentfile\space#1\levelchar
 116                                  \ifx\saved@macroname\@empty
 117                                    \space
 118                                    \actualchar
 119                                    \generalname
 120                                  \else
 121                                    \expandafter\@gobble
 122                                    \saved@macroname
 123                                    \actualchar
 124                                    \string\verb\quotechar*%
 125                                    \verbatimchar\saved@macroname
 126                                    \verbatimchar
 127                                  \fi
 128                                  :\levelchar #3}}%
 129   \@tempa\endgroup\@esphack}
 130 \makeatother
 131
 132 % Produce a Change Log and (2 column) Index.
 133 \RecordChanges
 134 \CodelineIndex
 135 \EnableCrossrefs
 136 \setcounter{IndexColumns}{2}
 137
 138 % Needed for documentation in ltoutenc.dtx
 139 \usepackage{textcomp}
 140
 141 \begin{document}
 142  \title{The \LaTeXe\ Sources}
 143  \author{%
 144   Johannes Braams\\
 145   David Carlisle\\
 146   Alan Jeffrey\\
 147   Leslie Lamport\\
 148   Frank Mittelbach\\
 149   Chris Rowley\\
 150   Rainer Sch\"opf}
 151
 152 % This command will be used to input the patch file
 153 % if that file exists.
 154 \newcommand{\includeltpatch}{%
 155   \def\currentfile{ltpatch.ltx}
 156   \part{ltpatch}
 157   {\let\ttfamily\relax
 158     \xdef\filekey{\filekey, \thepart={\ttfamily\currentfile}}}%
 159   Things we did wrong\ldots
 160   \IndexInput{ltpatch.ltx}}
 161
 162
 163
 164 % Get the date from ltvers.dtx
 165 \makeatletter
 166 \let\patchdate=\@empty
 167 \begingroup
 168    \def\ProvidesFile#1\fmtversion#2{\date{#2}\endinput}
 169    \input{ltvers.dtx}
 170 \global\let\X@date=\@date
 171
 172 % Add the patch version if available.
 173    \long\def\Xdef#1#2#3\def#4#5{%
 174     \xdef\X@date{#2}%
 175     \xdef\patchdate{#5}%
 176     \endinput}%
 177    \InputIfFileExists{ltpatch.ltx}
 178     {\let\def\Xdef}{\global\let\includeltpatch\relax}
 179 \endgroup
 180
 181 \ifx\@date\X@date
 182    \def\Xpatch{0}
 183    \ifx\patchdate\Xpatch\else
 184      \edef\@date{\@date\space Patch level \patchdate}
 185    \fi
 186 \else
 187    \@warning{ltpatch.ltx does not match ltvers.dtx!}
 188    \let\includeltpatch\relax
 189 \fi
 190 \makeatother
 191
 192  \pagenumbering{roman}
 193  \MaintainedByLaTeXTeam{latex}
 194  \maketitle
 195  \renewcommand\maketitle{}
 196
 197  \tableofcontents
 198
 199  \clearpage
 200
 201  \pagenumbering{arabic}
 202
 203 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 204
 205 % Each of the following \DocInclude lines includes a file with extension
 206 % .dtx. Each of these files may be typeset separately. For instance
 207 % latex ltboxes.dtx
 208 % will typeset the source of the LaTeX box commands.
 209 %
 210 % If this file is processed, each of these separate dtx files will be
 211 % contained as a part of a single document. Using ltxdoc.cfg you can
 212 % then optionally produce a combined index and/or change history for
 213 % the entire source of the format file. Note that such a document will
 214 % be quite large (about 555 pages).
 215 %
 216
 217  \DocInclude{ltdirchk} % System dependent initialisation
 218
 219  \DocInclude{ltplain}  % LaTeX version of Knuth's plain.tex
 220
 221  \DocInclude{ltvers}   % Current version date
 222
 223  \DocInclude{ltdefns}  % Initial definitions.
 224
 225  \DocInclude{ltalloc}  % Allocation of counters and others.
 226
 227  \DocInclude{ltcntrl}  % Program control macros.
 228
 229  \DocInclude{lterror}  % Error handling.
 230
 231  \DocInclude{ltpar}    % Paragraphs.
 232
 233  \DocInclude{ltspace}  % Spacing, line and page breaking.
 234
 235  \DocInclude{ltlogos}  % Logos.
 236
 237  \DocInclude{ltfiles}  % \input files and related commands
 238
 239  \DocInclude{ltoutenc} % Output encoding interface
 240
 241  \DocInclude{ltcounts} % Counters
 242
 243  \DocInclude{ltlength} % Lengths
 244
 245  \DocInclude{ltfssbas} % NFSS Base macros
 246
 247  \DocInclude{ltfsstrc} % NFSS Tracing (and tracefnt.sty)
 248
 249  \DocInclude{ltfsscmp} % NFSS1 Compatibility
 250
 251  \DocInclude{ltfssdcl} % NFSS Declarative interface
 252
 253  \DocInclude{ltfssini} % NFSS Initialisation
 254
 255  \DocInclude{fontdef}  % fonttext.ltx/fontmath.ltx
 256
 257  \DocInclude{preload}  % preload.ltx
 258
 259  \DocInclude{ltfntcmd} % \textrm etc
 260
 261  \DocInclude{ltpageno} % Page numbering
 262
 263  \DocInclude{ltxref}   % Cross referencing
 264
 265  \DocInclude{ltmiscen} % Miscellaneous environment definitions.
 266
 267  \DocInclude{ltmath}   % Mathematics set up.
 268
 269  \DocInclude{ltlists}  % List and related environments
 270
 271  \DocInclude{ltboxes}  % Parbox and friends
 272
 273  \DocInclude{lttab}    % Tabbing tabular and array
 274
 275  \DocInclude{ltpictur} % Picture mode
 276
 277  \DocInclude{ltthm}    % Theorem environments
 278
 279  \DocInclude{ltsect}   % Sectioning
 280
 281  \DocInclude{ltfloat}  % Floats
 282
 283  \DocInclude{ltidxglo} % Index and Glossary
 284
 285  \DocInclude{ltbibl}   % Bibliography
 286
 287  \DocInclude{ltpage}   % \pagestyle \raggedbottom \sloppy
 288
 289  \DocInclude{ltoutput} % Output routine
 290
 291  \DocInclude{ltclass}  % Package & Class interface
 292
 293  \DocInclude{lthyphen} % Hyphenation (hyphen.ltx).
 294
 295  \DocInclude{ltluatex} % Luatex support
 296
 297  \DocInclude{ltfinal}  % Last minute initialisations and dump
 298
 299  \includeltpatch       % Corrections distributed after the full release
 300
 301 % Stop here if ltxdoc.cfg says \AtEndOfClass{\OnlyDescription}
 302 \StopEventually{\end{document}}
 303
 304 \clearpage
 305 \pagestyle{headings}
 306
 307 % Make TeX shut up.
 308 \hbadness=10000
 309 \newcount\hbadness
 310 \hfuzz=\maxdimen
 311
 312 \typeout{%
 313   \string # Produce change log with^^J%
 314   makeindex -s gglo.ist -o source2e.gls source2e.glo}
 315
 316
 317 \PrintChanges
 318
 319 \clearpage
 320
 321 % makeindex needs a symbol between the parts of composite page numbers
 322 % but we dont want one, so:
 323 \typeout{%
 324   \string # Produce index with^^J%
 325   makeindex -s source2e.ist source2e.idx}
 326
 327 \begingroup
 328 \def\endash{--}
 329 \catcode`\-\active
 330 \def-{\futurelet\temp\indexdash}
 331 \def\indexdash{\ifx\temp-\endash\fi}
 332
 333 \PrintIndex
 334 \endgroup
 335
 336 % Make sure that the index is not printed twice
 337 % (ltxdoc.cfg might have a second \PrintIndex command)
 338 \let\PrintChanges\relax
 339 \let\PrintIndex\relax
 340
 341 \end{document}
 342
 343
 344 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 345
 346 To use this file to produce a fully indexed source code
 347 you need to execute the following (or equivalent) commands:
 348
 349    latex source2e.tex
 350
 351    makeindex -s source2e.ist source2e.idx
 352    makeindex -s gglo.ist -o source2e.gls source2e.glo
 353
 354    latex source2e.tex
 355    latex source2e.tex
 356
 357
 358 The makeindex style source2e.ist is used in place of the usual
 359 doc gind.ist to ensure that I is used in the sequence I J K
 360 not I II II, which would be the default makeindex behaviour.
 361
 362 The third run with latex is only required to get the table of
 363 contents entries for the change log and index. You may speed things up
 364 by using the \includeonly mechanism so as not to typeset the source
 365 files on the second run. This involves changing the file
 366 ltxdoc.cfg
 367 between the latex runs.
 368
 369 The following unix script automates this.
 370   (It could easily be ported to scripts for DOS or VMS,
 371    rm is ReMove a file, and echo "..." > file writes ... to "file".)
 372
 373
 374 After this script (after the second ==============) is a similar script
 375 that will produce the documentation for all the files in the base
 376 distribution that are *not* included in source2e.dvi. This second script
 377 was requested, but before using it, beware it will take a long time!
 378 It may however be modified as required, eg to not typeset the fdd files
 379 or whatever...
 380
 381 ==============
 382 #!/bin/sh
 383
 384 rm  -f source2e.gls source2e.ind source2e.toc
 385
 386 # First run:
 387 # Create new standard ltxdoc.cfg file
 388 # Pass the (possibly empty) list of arguments supplied on the
 389 # command line to article class.
 390 #
 391 # If you use A4 paper, running this script with argument
 392 #    a4paper
 393 # may save about 30 pages.
 394 #
 395 echo "\PassOptionsToClass{$*}{article}" > ltxdoc.cfg
 396
 397
 398 # Now LaTeX the file with this cfg file.
 399 #
 400 latex source2e.tex
 401
 402
 403 # Make the Change log and Glossary.
 404 #
 405 makeindex -s source2e.ist source2e.idx
 406 makeindex -s gglo.ist -o source2e.gls source2e.glo
 407
 408
 409 # Second run: append \includeonly{} to ltxdoc.cfg to speed up things
 410 # (this run needed only to get changes and index listed in .toc file)
 411 #
 412 # Note that the index will not be made incorrect by the insertion
 413 # of the table of contents as the front matter uses a different page
 414 # numbering scheme.
 415 #
 416 echo "\includeonly{}" >> ltxdoc.cfg
 417
 418 latex source2e.tex
 419
 420
 421 # Third and final run, to put everything together.
 422 # First restore the cfg file:
 423 #
 424 echo "\PassOptionsToClass{$*}{article}" > ltxdoc.cfg
 425 latex source2e.tex
 426
 427
 428 ==============
 429 #!/bin/sh
 430
 431 # Running this script will process all the dtx fdd and *guide.tex
 432 # and ltnews*.tex files in the LaTeX distribution, except the dtx
 433 # files included in source2e.tex.
 434 # (The shell first script in the comments of source2e.tex will
 435 #  process those.)
 436
 437 # Any command line arguments (eg a4paper) are taken as options to the
 438 # article class.
 439
 440 # This script is likely to take ages!
 441
 442 echo "\PassOptionsToClass{$*}{article}"                  > ltxdoc.cfg
 443 echo "\batchmode"                                       >> ltxdoc.cfg
 444
 445 # The next four lines produce full indexes and change logs
 446 # you may not want those.
 447 echo "\AtBeginDocument{\RecordChanges}"                 >> ltxdoc.cfg
 448 echo "\AtEndDocument{\PrintChanges}"                    >> ltxdoc.cfg
 449 echo "\AtBeginDocument{\CodelineIndex\EnableCrossrefs}" >> ltxdoc.cfg
 450 echo "\AtEndDocument{\PrintIndex}"                      >> ltxdoc.cfg
 451
 452 # If you do not want any code listings, just documentation, then instead
 453 # of the above four lines, uncomment the following:
 454 # echo "\AtBeginDocument{\OnlyDescription}"                >> ltxdoc.cfg
 455
 456 echo "\PassOptionsToClass{$*}{article}"                  > ltxguide.cfg
 457 echo "\batchmode"                                       >> ltxguide.cfg
 458
 459 cp ltxguide.cfg ltnews.cfg
 460
 461
 462 for i in *dtx *fdd *guide.tex ltnews*.tex
 463 do
 464 B=`basename $i .dtx`
 465
 466 if (grep "Include{$B}" source2e.tex >/dev/null ; )
 467 then
 468 echo In source2e: $i
 469 else
 470 echo latex $i
 471   if (latex $i > /dev/null)
 472   then
 473     echo latex $i
 474     latex $i > /dev/null
 475     echo makeindex -s gind.ist $B.idx
 476     makeindex -s gind.ist $B.idx > /dev/null 2> /dev/null
 477     echo makeindex -s gglo.ist -o $B.gls $B.glo
 478     makeindex -s gglo.ist -o $B.gls $B.glo > /dev/null 2> /dev/null
 479     echo latex $i
 480     latex $i > /dev/null
 481   else
 482     echo "!!! LaTeX ERROR: $i. (See $B.log.)"
 483   fi
 484 fi
 485
 486 done