summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/base/doc.dtx
diff options
context:
space:
mode:
authorNorbert Preining <preining@logic.at>2014-05-08 05:45:04 +0000
committerNorbert Preining <preining@logic.at>2014-05-08 05:45:04 +0000
commitf8a7af47d643e11841911d1d6d7bcfad29af5a87 (patch)
tree254bbe12bb0c851f2dfb85aa2449b5fa176652a1 /Master/texmf-dist/source/latex/base/doc.dtx
parent4775c8ca9e258cf67c7c0bd7bce8234d12e7b449 (diff)
latex 2e release (7May)
git-svn-id: svn://tug.org/texlive/trunk@33913 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/base/doc.dtx')
-rw-r--r--Master/texmf-dist/source/latex/base/doc.dtx252
1 files changed, 126 insertions, 126 deletions
diff --git a/Master/texmf-dist/source/latex/base/doc.dtx b/Master/texmf-dist/source/latex/base/doc.dtx
index 15b6719427b..2b98a6b0e71 100644
--- a/Master/texmf-dist/source/latex/base/doc.dtx
+++ b/Master/texmf-dist/source/latex/base/doc.dtx
@@ -3,29 +3,29 @@
% Copyright 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
% 2006 2007 2008 2009 2010
% The LaTeX3 Project and any individual authors listed elsewhere
-% in this file.
-%
+% in this file.
+%
% This file is part of the LaTeX base system.
% -------------------------------------------
-%
+%
% It may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3c
% of this license or (at your option) any later version.
% The latest version of this license is in
% http://www.latex-project.org/lppl.txt
-% and version 1.3c or later is part of all distributions of LaTeX
+% and version 1.3c or later is part of all distributions of LaTeX
% version 2005/12/01 or later.
-%
+%
% This file has the LPPL maintenance status "maintained".
-%
+%
% The list of all files belonging to the LaTeX base distribution is
% given in the file `manifest.txt'. See also `legal.txt' for additional
% information.
-%
-% The list of derived (unpacked) files belonging to the distribution
-% and covered by LPPL is defined by the unpacking scripts (with
+%
+% The list of derived (unpacked) files belonging to the distribution
+% and covered by LPPL is defined by the unpacking scripts (with
% extension .ins) which are part of the distribution.
-%
+%
% \fi
% ^^A -*-LaTeX-*-
%
@@ -61,7 +61,7 @@
% Everything up to the next `\ fi' (without a blank) will
% be ignored. This is necessary because `%' may no longer
% be a comment mark when this file is read in.
-%
+%
%
%% Package `doc' to use with LaTeX 2e
%% Copyright (C) 1989-1999 Frank Mittelbach, all rights reserved.
@@ -92,7 +92,7 @@
%
%
% \hyphenation{make-index}
-%
+%
% \DoNotIndex{\@,\@@par,\@beginparpenalty,\@empty}
% \DoNotIndex{\@flushglue,\@gobble,\@input}
% \DoNotIndex{\@makefnmark,\@makeother,\@maketitle}
@@ -201,24 +201,24 @@
% since the last published version \cite{art:doc} but which have been
% present in distributed versions of \texttt{doc.sty} for some time. It
% also integrates the (undocumented) features of the distributed
-% \texttt{newdoc.sty}.
+% \texttt{newdoc.sty}.
%
% The following changes and additions have been made to the user
% interface since the published version~\cite{art:doc}. See
-% \S\ref{sec:interface} for more details.
+% \S\ref{sec:interface} for more details.
% \begin{description}
% \item[Driver mechanism] "\DocInput" is now used in the driver file
% to input possibly multiple independent \DOC{} files and \DOC{} no
% longer has to be the last package. "\IndexListing" is replaced
-% by "\IndexInput";
+% by "\IndexInput";
% \item[Indexing] is controlled by "\PageIndex" and "\CodelineIndex",
% one of which must be specified to produce an index---there is no
-% longer a "\makeindex" in the default "\DocstyleParms";
+% longer a "\makeindex" in the default "\DocstyleParms";
% \item[The \texttt{macro} environment] now takes as argument the
% macro name {\em with\/} the backslash;
% \item[Verbatim text] Newlines are now forbidden inside "\verb" and
% commands "\MakeShortVerb" and "\DeleteShortVerb" are provided for
-% verbatim shorthand;
+% verbatim shorthand;
% \item[\texttt{\bslash par}] can now be used in "\DoNotIndex";
% \item[Checksum/character table support] for ensuring the integrity
% of distributions is added;
@@ -277,7 +277,7 @@
%
% \ifmulticols
% \end{multicols}
-%
+%
% \begin{multicols}{2}[\medskip \rule{\textwidth}{.3pt}
% \section{Introduction}]
% \else
@@ -357,7 +357,7 @@
% package one has to prepare a special driver file which produces the
% formatted document. This driver file has the following
% characteristics:
-%
+%
% \noindent |\documentclass[|\meta{options}]^^A
% |{|\meta{document-class}|}|\\[1pt]
% |\usepackage{doc}|\\[3pt]
@@ -368,7 +368,7 @@
%
% The \meta{document-class} might be any document class, I normally
% use \texttt{article}.
-%
+%
% In the \meta{preamble} one should place declarations which
% manipulate the behavior of the \DOC{} package like
% |\DisableCrossrefs| or |\OnlyDescription|.
@@ -377,24 +377,24 @@
% Finally the \meta{special input commands} part should contain one or
% more |\DocInput|\meta{file name} and/or
% |\IndexInput|\meta{file name} commands. The
-% |\DocInput| command is used for files prepared for the
+% |\DocInput| command is used for files prepared for the
% \DOC{} package whereas |\IndexInput| can be used for all kinds of
% macro files. See page \pageref{..Input} for more details of
% "\IndexInput". Multiple "\DocInput"s can be used with a
% number of included files which are each self-contained
% self-documenting packages---for instance, each containing
-% "\maketitle".
+% "\maketitle".
%
% As an example, the driver file for the \DOC{} package itself is
% the following text surrounded by "%<*driver>" and "%</driver>".
% To produce the documentation you can simply run the \texttt{.dtx}
% file through \LaTeX{} in which case this code will be executed
% (loading the document class \texttt{ltxdoc}, etc.) or you can
-% extract this into a separate file by using
+% extract this into a separate file by using
% the \texttt{docstrip} program.
% The line numbers below are added by
-% \DOC{}'s formatting.
-% Note that the class \textsf{ltxdoc} has the \DOC{} package
+% \DOC{}'s formatting.
+% Note that the class \textsf{ltxdoc} has the \DOC{} package
% preloaded.
% \changes{v1.7a}{1992/03/06}{Added
% docstrip-derivable driver file as example.}
@@ -402,7 +402,7 @@
% \begin{macrocode}
%<*driver>
\documentclass{ltxdoc}
-\EnableCrossrefs
+\EnableCrossrefs
%\DisableCrossrefs % Say \DisableCrossrefs if index is ready
\CodelineIndex
\RecordChanges % Gather update information
@@ -495,7 +495,7 @@
% \changes{v1.7a}{1992/02/26}{Documented \cs{verb} change.}
% \DescribeMacro\verb
% The "\verb" command is re-implemented to give an error report if a
-% newline appears in its argument.
+% newline appears in its argument.
% The \textsf{verbatim} and \textsf{verbatim$*$} environments set text
% in the style defined by "\MacroFont"~(\S\ref{sec:macrofont}).
%
@@ -509,7 +509,7 @@
% macro.\footnote{This is a change to the style design I described in
% ^^A \TUB ^^A removed in case ltugboat.sty not used
% \textsl{TUGboat\/}\ 10\#1 (Jan.~89). We finally decided
-% that it would
+% that it would
% be better to use the macro name {\em with\/} the
% backslash as an argument.}
% This argument is also used to print the name in the margin and to
@@ -521,7 +521,7 @@
% \changes{v1.7a}{1992/02/26}{Note on need for some text in macro env.}
% There should be some text---even if it's just an empty
% "\mbox{}"---in this environment before "\begin{macrocode}" or the
-% marginal label won't print in the right place.
+% marginal label won't print in the right place.
%
% \DescribeMacro\MacrocodeTopsep
% \DescribeMacro\MacroTopsep
@@ -535,7 +535,7 @@
% |\MacroFont| holds the font and a possible size change command
% for the code lines, the "verbatim"["*"] environment and the macro
% names printed in the margin. If you want
-% to change their default values in a
+% to change their default values in a
% class file (like \texttt{ltugboat.cls}) use the |\DocstyleParms|
% command described below. Starting with release 2.0a it can now
% be changed directly as long as the redefinition happens before
@@ -584,7 +584,7 @@
% |\SpecialEscapechar| is a single-letter control sequence, that
% is, one has to use "\|" for example to denote that `\verb+|+'
% is used as an escape character. |\SpecialEscapechar| only
-% changes the behavior of the next \textsf{macrocode} or
+% changes the behavior of the next \textsf{macrocode} or
% \textsf{macrocode$*$} environment.
%
% The actual index entries created will all be printed with |\|
@@ -636,11 +636,11 @@
% "\theCodelineNo". Its default definition is to use scriptsize
% arabic numerals; a user-supplied definition won't be overwritten.
%
-% \DescribeMacro\CodelineNumbered
+% \DescribeMacro\CodelineNumbered
% When you don't wish to get an index but want your code lines
% numbered use "\CodelineNumbered" instead of "\CodelineIndex". This
% prevents the generation of an unnecessary ".idx" file.
-%
+%
%
% \subsection{Producing the actual index entries}
%
@@ -651,7 +651,7 @@
%
% But this isn't built in: one has only to redefine some of the
% following macros to be able to use any other index program. All
-% macros which are installation
+% macros which are installation
% dependent are defined in such a way that they won't overwrite a
% previous definition. Therefore it is safe to put the changed
% versions in a package file which might be read in before the doc
@@ -692,7 +692,7 @@
% \textsf{macro} environment.} may be used. It is called `special'
% because it has to print its argument verbatim.
% A similar macro, called |\SpecialMainEnvIndex| is used for indexing
-% the main definition point of an
+% the main definition point of an
% environment.\footnote{This macro is called by the
% \textsf{environment} environment.}
% \DescribeMacro\SpecialIndex
@@ -738,7 +738,7 @@
%
% \DescribeMacro\OldMakeindex
% Versions of \textsf{makeindex} prior to 2.9 had some bugs affecting
-% \DOC{}. One of these,
+% \DOC{}. One of these,
% pertaining to the "%" character doesn't have a work-around
% appropriate for versions with and without the
% bug.\label{makeindex:version} If
@@ -808,11 +808,11 @@
% |\parindent| & \IndexParms \the\parindent &
% |\columnsep| & \IndexParms \the\columnsep \\
% |\parskip| & \IndexParms \the\parskip &
-% |\rightskip| & \IndexParms
+% |\rightskip| & \IndexParms
% \expandafter\dimenvalue\the\rightskip \\
% |\mathsurround| & \IndexParms \the\mathsurround &
-% |\parfillskip| & \IndexParms
-% \expandafter\dimenvalue\the\parfillskip
+% |\parfillskip| & \IndexParms
+% \expandafter\dimenvalue\the\parfillskip
% \end{tabular}
% \end{center}
% \DescribeMacro{\@idxitem}
@@ -855,7 +855,7 @@
% |\MacroIndent| & \the\MacroIndent \\
% |\marginparpush| & \the\marginparpush &
% |\MacrocodeTopsep| & \the\MacrocodeTopsep \\
-% |\tolerance| & \the\tolerance
+% |\tolerance| & \the\tolerance
% \end{tabular}
% \end{center}
%
@@ -864,7 +864,7 @@
%
% \DescribeMacro\MakeShortVerb
% \DescribeMacro{\MakeShortVerb*} \DescribeMacro\DeleteShortVerb It is
-% awkward to have to type, say, "\verb|"\ldots"|" continually when
+% awkward to have to type, say, "\verb|"\ldots"|" continually when
% quoting
% verbatim bits (like macro names) in the text, so an abbreviation
% mechanism is provided. Pick a character \meta{c}---one which
@@ -987,7 +987,7 @@
% and using up valuable characters in the entry with old \textsf{makeindex}
% versions.
%
-% \changes{v1.7a}{1992/02/26}{Description of \cs{RecordChanges} etc.
+% \changes{v1.7a}{1992/02/26}{Description of \cs{RecordChanges} etc.
% added
% to interface section.} \DescribeMacro\RecordChanges To cause the
% change information to be written out, include "\RecordChanges" in
@@ -1010,7 +1010,7 @@
%
% \label{sec:checksum}
% \DescribeMacro\CharacterTable
-% \DescribeMacro\CheckSum
+% \DescribeMacro\CheckSum
% To overcome some of the problems of sending files over the networks
% we developed two macros which should detect corrupted files. If one
% places the lines
@@ -1023,7 +1023,7 @@
%"%% Lower-case "
%"\a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z"\\
%"%% Digits \0\1\2\3\4\5\6\7\8\9"\\
-%"%% Exclamation \! Double quote "\verb=\"=
+%"%% Exclamation \! Double quote "\verb=\"=
%" Hash (number) \#"\\
%"%% Dollar \$ Percent \% Ampersand \&"\\
%"%% Acute accent \' Left paren \( Right paren \)"\\
@@ -1127,7 +1127,7 @@
% it out.}
%
% To sum up, the basic structure of a \texttt{.dtx} file without any
-% refinements is like this:
+% refinements is like this:
% \begin{verse}\small
% "% "\meta{waffle}\ldots\\
% \quad\ldots \\
@@ -1146,7 +1146,7 @@
% "% \Finale \PrintIndex \PrintChanges"
% \end{verse}
% For examples of the use of most---if not all---of the features
-% described above consult the \texttt{doc.dtx} source itself.
+% described above consult the \texttt{doc.dtx} source itself.
%
% \subsection{Acknowledgements}
%
@@ -1172,7 +1172,7 @@
% \newblock London, 1786 \& 1788.
% \bibitem{art:Knuthliterat} \textsc{D. E. Knuth}.
% \newblock Literate Programming.
-% \newblock Computer Journal, Vol.~27, \textit{pp}.~97--111,
+% \newblock Computer Journal, Vol.~27, \textit{pp}.~97--111,
% May 1984.
% \bibitem{book:KnuthA} \textsc{D. E. Knuth}.
% \newblock Computers \& Typesetting (The \TeX book).
@@ -1188,7 +1188,7 @@
% \newblock \textsl{TUGboat}, Vol.~10(2), \textit{pp}.~245--273,
% July 1989.
% \bibitem{art:docstrip} \textsc{Frank Mittelbach, Denys Duchier and
-% Johannes Braams}.
+% Johannes Braams}.
% \newblock \texttt{docstrip.dtx} (to appear).
% \newblock The file is part of the DOC package.
% \bibitem{book:Raspe} \textsc{R. E. Raspe} (*1737, \dag 1797).
@@ -1206,7 +1206,7 @@
% \ifmulticols
% \addtocontents{toc}{\protect\end{multicols}}
% \fi
-%
+%
% } ^^A end \StopEventually
%
%
@@ -1247,7 +1247,7 @@
% The first thing that we do next is to get ourselves a new comment
% sign. Because all sensible signs are already occupied, we will
% choose one that can only be entered indirectly:
-% {\DoNotIndex{\^}^^A avoid misinterpretion !!!!! VERIFY
+% {\DoNotIndex{\^}^^A avoid misinterpretion !!!!! VERIFY
% \begin{macrocode}
\catcode`\^^A=14
% \end{macrocode}
@@ -1278,7 +1278,7 @@
% Parts of the macro definition will be surrounded by the
% environment \textsf{macrocode}. Put more precisely, they will be
% enclosed by a macro whose argument (the text to be set
-% `verbatim') is terminated by the string
+% `verbatim') is terminated by the string
% \verb*+% \end{macrocode}+. Carefully note the number of spaces.
% |\macrocode| is defined completely analogously to
% |\verbatim|, but because a few small changes were carried
@@ -1353,7 +1353,7 @@
% \changes{v1.5l}{1989/09/10}{Code line numbers supported.}
% \changes{v1.5t}{1989/11/07}{Call \cs{leavevmode} to get \cs{everypar}
% on blank lines.}
-% \changes{v1.7c}{1992/3/24}{Added \cs{interlinepenalty} to
+% \changes{v1.7c}{1992/3/24}{Added \cs{interlinepenalty} to
% \cs{par} from
% verbatim.sty}
% \begin{macrocode}
@@ -1510,7 +1510,7 @@
% To allow changing the "\MacroFont" in the preamble we defer
% defining the internally used "\macro@font" until after the
% preamble.
-% \changes{v2.0a}{1998/05/16}{Support changing \cs{MacroFont} in
+% \changes{v2.0a}{1998/05/16}{Support changing \cs{MacroFont} in
% preamble}
% \begin{macrocode}
\AtBeginDocument{\let\macro@font\MacroFont}
@@ -1527,7 +1527,7 @@
% start of the line and \meta{switch} comprises names with various
% possible separators and a possible leading "+", "-", "*" or "/"
% \cite{art:docstrip}. All that concerns us here is what the first
-% character of \meta{switch} is.) First it checks the "pm@module"
+% character of \meta{switch} is.) First it checks the "pm@module"
% flag in case the previous line had a non-block module
% directive i.e., not "%<*" or "%</"; if it did we need to close the
% group it started and unset the flag. "\check@module" looks ahead at
@@ -1583,7 +1583,7 @@
% \end{macro}
% \begin{macro}{\ch@angle}
% \changes{v1.7a}{1992/03/12}{Added.}
-% \changes{v1.9k}{1994/02/22}{Have \texttt{<} active}
+% \changes{v1.9k}{1994/02/22}{Have \texttt{<} active}
% If the current lookahead token is "<" we are defined to be
% processing a module directive can go on to look for "+" etc.;
% otherwise we must put back the gobbled "%". With \LaTeXe{}
@@ -1592,7 +1592,7 @@
\begingroup
\catcode`\<\active
\gdef\ch@angle{\ifx<\next
- \expandafter\ch@plus@etc
+ \expandafter\ch@plus@etc
\else \percentchar \fi}
% \end{macrocode}
% \end{macro}
@@ -1653,7 +1653,7 @@
\catcode`\~=\active
\lccode`\~=`\>
\lowercase{\gdef\pm@module#1~}{\pm@moduletrue
- \Module{#1}\begingroup
+ \Module{#1}\begingroup
% \end{macrocode}
% We switch to a special font as soon the nesting is higher than
% the current value of "\c@StandardModuleDepth". We do a local
@@ -1749,8 +1749,8 @@
% \end{macro}
%
% \begin{macro}{\mod@math@codes}
-% \changes{v1.7c}{1992/03/26}{Added.}
-% \changes{v2.1e}{2010/02/04}{Added mathcodes for +,-,:, and = (pr/4096)}
+% \changes{v1.7c}{1992/03/26}{Added.}
+% \changes{v2.1e}{2010/02/04}{Added mathcodes for +,-,:, and = (pr/4096)}
% As well as `words', the module
% directive text might contain any of the characters "*/+-,&|!()"
% for the current version of \textsf{docstrip}. We only need
@@ -1760,7 +1760,7 @@
% will not have a special catcode when it's encountered.
% \begin{macrocode}
\def\mod@math@codes{\mathcode`\|="226A \mathcode`\&="2026
- \mathcode`\-="702D \mathcode`\+="702B
+ \mathcode`\-="702D \mathcode`\+="702B
\mathcode`\:="703A \mathcode`\=="703D }
% \end{macrocode}
% \end{macro}
@@ -1772,7 +1772,7 @@
% \changes{v1.8c}{1993/10/25}{NFSS standard}
% If NFSS is in use we need a new math alphabet which uses a sans serif
% font. To support both the release one and two of NFSS the alphabet
-% was renamed to "\mathsf" which is defined in NFSS2.
+% was renamed to "\mathsf" which is defined in NFSS2.
% \begin{macrocode}
%\ifx\selectfont\undefined
%\else
@@ -1795,7 +1795,7 @@
% avoid unnecessary fontwarning.}
% \begin{macrocode}
\newskip\MacrocodeTopsep \MacrocodeTopsep = 3pt plus 1.2pt minus 1pt
-\newdimen\MacroIndent
+\newdimen\MacroIndent
\settowidth\MacroIndent{\rmfamily\scriptsize 00\ }
% \end{macrocode}
% \end{macro}
@@ -1821,7 +1821,7 @@
% around the problem with an additional comment character. But now
% back to |\macrocode*|. We start with the macro |\macro@code|
% which prepares everything and then call the macro |\sxmacro@code|
-% whose argument is terminated by the string
+% whose argument is terminated by the string
%\verb*+% \end{macrocode*}+.
% \begin{macrocode}
\@namedef{macrocode*}{\macro@code\sxmacro@code}
@@ -1962,7 +1962,7 @@
% \end{macrocode}
% To put the labels in the left margin we have to use the
% |\reversemarginpar| declaration. (This means that the
-% \texttt{doc.sty} can't be used with all classes or packages.)
+% \texttt{doc.sty} can't be used with all classes or packages.)
% We also
% make the |\marginparpush| zero and |\marginparwidth| suitably
% wide.
@@ -2074,7 +2074,7 @@
% The omission of this token once caused a funny error.
% \changes{v1.5u}{1989/11/14}{equal sign added.}
% \begin{macrocode}
-{\catcode`\%=12
+{\catcode`\%=12
\long\gdef\check@percent#1{\ifx #1%\let\next\@empty \else
\let\next=#1\fi \next}}
% \end{macrocode}
@@ -2168,17 +2168,17 @@
% depth, we use a counter. We also need a counter to count the
% number of nested \textsf{macro} environments.
% \changes{v1.5k}{1989/08/17}{Fix for save stack problem.}
-% \changes{v1.9k}{1994/02/22}{Fix probably no longer necessary}
+% \changes{v1.9k}{1994/02/22}{Fix probably no longer necessary}
% \begin{macrocode}
\newcount\macro@cnt \macro@cnt=0
% \end{macrocode}
% The environment takes an argument---the macro name to be
% described. Since this name may contain special `letters' we have
% to re-|\catcode| them before scanning the argument. This is done
-% by the |\MakePrivateLetters| macro.
+% by the |\MakePrivateLetters| macro.
% \changes{v1.5k}{1989/08/17}{Fix for save stack problem.}
% \changes{v1.7a}{1992/02/26}{Catcode backslash to other (from newdoc).}
-% \changes{v1.9k}{1994/02/22}{Don't omit extra group}
+% \changes{v1.9k}{1994/02/22}{Don't omit extra group}
% \begin{macrocode}
\def\macro{\begingroup
\catcode`\\12
@@ -2204,7 +2204,7 @@
% \changes{v1.5f}{1989/5/07}{MacroTopsep parameter added.}
% \changes{v1.5k}{1989/08/17}{Fix for save stack problem.}
% \changes{v1.8c}{1993/10/25}{Support ``environment'' env}
-% \changes{v1.9k}{1994/02/22}{Remove \cs{macro@level}}
+% \changes{v1.9k}{1994/02/22}{Remove \cs{macro@level}}
% \begin{macrocode}
\long\def\m@cro@#1#2{\endgroup \topsep\MacroTopsep \trivlist
% \end{macrocode}
@@ -2315,7 +2315,7 @@
% index program in use (note the definition of
% |\SpecialMainIndex| for our installation).
% \changes{v1.5s}{1989/11/05}{Support for code line no. (Undoc)}
-% \changes{v1.9u}{1995/08/06}{Removed brace group which
+% \changes{v1.9u}{1995/08/06}{Removed brace group which
% killed \cs{DoNotIndex}}
% We advance the current codeline number and after producing an
% index entry revert to the original value
@@ -2362,7 +2362,7 @@
% \textsf{environment} environments are mixed, therefore we now
% use a simpler approach.
% \changes{v1.5k}{1989/08/17}{Fix for save stack problem.}
-% \changes{v1.9k}{1994/02/22}{Don't checkfor nesting}
+% \changes{v1.9k}{1994/02/22}{Don't checkfor nesting}
% \begin{macrocode}
\let\endmacro \endtrivlist
\let\endenvironment\endmacro
@@ -2741,8 +2741,8 @@
% mustn't be stored with a special category code or exclusion from
% the index won't work, so we employ the case-changing trick used
% elsewhere. Since the argument might be an active character,
-% |\string| is used to normalize it.
-% \changes{v2.0e}{1998/12/28}{Correctly use the case-changing trick.}
+% |\string| is used to normalize it.
+% \changes{v2.0e}{1998/12/28}{Correctly use the case-changing trick.}
% \begin{macrocode}
\begingroup
\catcode`\&=12
@@ -2841,7 +2841,7 @@
% The next three branches are needed because of bugs in
% our \textsf{makeindex} program. You can't produce unbalanced index
% entries\footnote{This is possible for \TeX{} if you use
-% \texttt{\string{$_{12}$ \rmfamily or
+% \texttt{\string{$_{12}$ \rmfamily or
% \ttfamily\string}$_{12}$},
% but \textsf{makeindex} will complain.}
% and you have to double a percent character. To get around these
@@ -2850,7 +2850,7 @@
% all three
% bugs. When they've found their way through all
% installations,
-% the lines above will be removed. See
+% the lines above will be removed. See
% page~\pageref{bug:fixes} if you already have them.
% (I'm not sure which versions incorporate these, but
% 2.11 is OK. See also
@@ -2967,7 +2967,7 @@
% where \meta{macro name} is a macro name like
% $"\"_{12}"p"{_{11}}"@"_{11}$ or $"\"_{12}"$"_{11}$. Note that the "\"
% has category `other' and the other characters in the name are all
-% `letter', regardless of their normal category.
+% `letter', regardless of their normal category.
%
% \begin{macro}{\DoNotIndex}
% This macro is used to suppress macro names in the index. It
@@ -2989,7 +2989,7 @@
%
% \begin{macro}{\do@not@index}
% We make the |\do@not@index| macro |\long|
-% since the user might want to exclude the |\par|
+% since the user might want to exclude the |\par|
% macro.
% \begin{macrocode}
\long\def\do@not@index#1{%
@@ -2999,7 +2999,7 @@
% \changes{v1.7a}{1992/02/26}{Replaced with newdoc version.}
% \begin{macrocode}
\endgroup
- \addto@hook\index@excludelist{#1,}}
+ \addto@hook\index@excludelist{#1,}}
% \end{macrocode}
% \end{macro}
%
@@ -3143,7 +3143,7 @@
%<+gind|gglo>%% doc.sty. The commands for MAKEINDEX like `level'
%<+gind|gglo>%% `item_x1' are described in `` Makeindex, A General
%<+gind|gglo>%% Purpose, Formatter-Independent Index Processor'' by
-%<+gind|gglo>%% Pehong Chen.
+%<+gind|gglo>%% Pehong Chen.
%<+gind|gglo>
% \end{macrocode}
%
@@ -3232,7 +3232,7 @@
%
% \begin{macro}{\SpecialIndex@}
% \changes{v2.0c}{1998/08/22}{Macro added.}
-% \changes{v2.0f}{1999/02/27}{Temp fix to allow strange code in arg 1
+% \changes{v2.0f}{1999/02/27}{Temp fix to allow strange code in arg 1
% (PR 2968)}
% The macro |\SpecialIndex@| does the real work for |\SpecialMainIndex|
% and |\SpecialUsageIndex|. It takes two arguments: the macro to be
@@ -3241,19 +3241,19 @@
% \changes{v2.0g}{1999/03/22}{Correct so-called temp fix. I'm not going to
% explain this.}
% \begin{macrocode}
-\begingroup
- \catcode`\|=0
- \catcode`\\=12
- |gdef|@SpecialIndexHelper@#1#2|@nil{%
- |if |noexpand#1\%
- |gdef|@gtempa{#2}%
- |else
- |begingroup
- |escapechar|m@ne
+\begingroup
+ \catcode`\|=0
+ \catcode`\\=12
+ |gdef|@SpecialIndexHelper@#1#2|@nil{%
+ |if |noexpand#1\%
+ |gdef|@gtempa{#2}%
+ |else
+ |begingroup
+ |escapechar|m@ne
|expandafter|gdef|expandafter|@gtempa|expandafter{|string#1#2}%
- |endgroup
- |fi}
-|endgroup
+ |endgroup
+ |fi}
+|endgroup
\def\SpecialIndex@#1#2{%
% \end{macrocode}
% The first thing it does is to convert the macro into a list of
@@ -3332,11 +3332,11 @@
% \begin{macrocode}
\def\SpecialMainEnvIndex#1{\@bsphack\special@index{%
#1\actualchar
- {\string\ttfamily\space#1}
+ {\string\ttfamily\space#1}
(environment)%
\encapchar main}%
\special@index{environments:\levelchar#1\actualchar{%
- \string\ttfamily\space#1}\encapchar
+ \string\ttfamily\space#1}\encapchar
main}\@esphack}
% \end{macrocode}
% The |\SpecialUsageIndex| is similar to |\SpecialMainIndex|, except
@@ -3366,15 +3366,15 @@
% First we sort the environment under its own name stating in the
% actual entry that this is an environment.
% \begin{macrocode}
- \index{#1\actualchar{\protect\ttfamily#1}
+ \index{#1\actualchar{\protect\ttfamily#1}
(environment)\encapchar usage}%
% \end{macrocode}
% The second entry is sorted as a subitem under the key
-% `environments:'.
+% `environments:'.
% \changes{v2.1b}{2004/02/09}{environment names incorrectly sorted in
% index (pr/3615)}
% \begin{macrocode}
- \index{environments:\levelchar#1\actualchar{\protect\ttfamily#1}\encapchar
+ \index{environments:\levelchar#1\actualchar{\protect\ttfamily#1}\encapchar
usage}\@esphack}
% \end{macrocode}
% Because both entries correspond to `descriptions' of the
@@ -3596,13 +3596,13 @@
\@ifundefined{index@prologue}
{\def\index@prologue{\section*{Index}%
\markboth{Index}{Index}%
- Numbers written in italic refer to the page
+ Numbers written in italic refer to the page
where the corresponding entry is described;
- numbers underlined refer to the
+ numbers underlined refer to the
\ifcodeline@index
code line of the
\fi
- definition; numbers in roman refer to the
+ definition; numbers in roman refer to the
\ifcodeline@index
code lines
\else
@@ -3763,7 +3763,7 @@
%\def\printindex{\typeout{\string\printindex\space is obsolete!}%
% \typeout{Please use \string\PrintIndex\space
% if you are a macro implementor^^J
-% or get a newer version of the documented
+% or get a newer version of the documented
% software if you are a user}%
% \PrintIndex}
% \end{macrocode}
@@ -3916,7 +3916,7 @@
% \end{macro}
% \end{macro}
%
-%
+%
% \begin{macro}{\GlossaryMin}
% \changes{BHK}{1989/04/26}{Added to support
% \texttt{\protect\bslash changes}.}
@@ -3979,7 +3979,7 @@
%<+gglo>"\n\n \\end{theglossary}\n"
% \end{macrocode}
% This difference from \texttt{gind.ist} is necessary if you have an
-% up-to-date \LaTeX.
+% up-to-date \LaTeX.
% \begin{macrocode}
%<+gglo>keyword "\\glossaryentry"
%<*package>
@@ -4044,7 +4044,7 @@
% \end{macrocode}
% \end{macro}
%
-%
+%
%
%
%
@@ -4058,7 +4058,7 @@
% \begin{macro}{\AlsoImplementation}
% \changes{v1.9w}{1995/12/27}{Macro added}
% \begin{macro}{\OnlyDescription}
-% If |\AlsoImplementation| is in force the whole documentation
+% If |\AlsoImplementation| is in force the whole documentation
% including the code part will be typeset. This is the default.
% \begin{macrocode}
\newcommand\AlsoImplementation{%
@@ -4073,14 +4073,14 @@
% But |\Finale| will be called at the very end of a file. This
% is exactly the point were we want to know if the file is
% uncorrupted. Therefore we also call |\check@checksum| at this
-% point.
+% point.
% \begin{macrocode}
\check@checksum}%
% \end{macrocode}
% On the other hand: |\StopEventually| is more or less a
% dividing point between description and code. So we start to look
% for the check-sum of the documented file by calling
-% |\init@checksum|.
+% |\init@checksum|.
% \begin{macrocode}
\init@checksum
\@esphack}%
@@ -4139,7 +4139,7 @@
\newlanguage\l@nohyphenation
\fi
% \end{macrocode}
-%
+%
% \begin{macrocode}
\DeclareRobustCommand\meta[1]{%
% \end{macrocode}
@@ -4205,7 +4205,7 @@
% \end{macrocode}
% Then it only remains to read in the specified file, and finish
% off the |\trivlist|.
-% \changes{v1.5t}{1989/11/07}{Call \cs{endmacrocode} instead
+% \changes{v1.5t}{1989/11/07}{Call \cs{endmacrocode} instead
% of \cs{endtrivlist}.}
% \begin{macrocode}
\input{#1}\endmacrocode
@@ -4278,7 +4278,7 @@
% \meta{c}\meta{text}\meta{c} is equivalent to
% "\verb"\meta{c}\meta{text}\meta{c}.\footnote{Warning:
% the commentary in the rest of this section was written by Dave
-% Love.} In addition, the fact
+% Love.} In addition, the fact
% that \meta{c} is made active is recorded for the benefit of the
% \textsf{verbatim} and \textsf{macrocode} environments.
% Note particularly that the definitions below are global.
@@ -4363,10 +4363,10 @@
% region where you need to use the character outside a verbatim
% environment. It arranges for "\dospecials" and "\@sanitize" to be
% altered appropriately, restores the saved catcode and, if necessary,
-% the character's meaning (as stored by
+% the character's meaning (as stored by
% "\MakeShortVerb"). If the catcode wasn't stored in
% "\cc\"\meta{c} (by "\MakeShortVerb") the command is silently
-% ignored.
+% ignored.
% \changes{v1.7a}{1992/02/28}{Check for previous matched
% \cs{MakeShortVerb}
% to avoid error.}
@@ -4454,7 +4454,7 @@
\xdef\dospecials{\dospecials}%
% \end{macrocode}
% Fixing "\@sanitize" is the same except that we need to re-define
-% "\@makeother" which obviously needs to be done in a group.
+% "\@makeother" which obviously needs to be done in a group.
% \begin{macrocode}
\begingroup
\def\@makeother##1{%
@@ -4485,11 +4485,11 @@
% \footnotetext{Warning: the commentary in this section was
% written by Dave Love. }
%
-%
+%
% \begin{macro}{\init@checksum}
% The checksum mechanism works by counting backslashes in the
% macrocode. This initialises the count (when called from
-% "\StopEventually").
+% "\StopEventually").
% \changes{v1.5k}{1989/09/04}{Macro added to support checksum.}
% \begin{macrocode}
\def\init@checksum{\relax
@@ -4502,7 +4502,7 @@
% \changes{v1.5k}{1989/09/04}{Macro added to support checksum.}
% This reports the sum compared with the value ("\bslash@cnt") the
% file advertises. It's called from "\Finale" (if that hasn't been
-% re-defined).
+% re-defined).
% \begin{macrocode}
\def\check@checksum{\relax
\ifnum\check@sum=\z@
@@ -4516,7 +4516,7 @@
\typeout{* Checksum passed *}%
\typeout{*******************}%
\else
- \PackageError{doc}{Checksum not passed
+ \PackageError{doc}{Checksum not passed
(\the\check@sum<>\the\bslash@cnt)}%
{The file currently documented seems to be wrong.^^J%
Try to get a correct version.}%
@@ -4555,7 +4555,7 @@
% \begin{macro}{\step@checksum}
% \changes{v1.5k}{1989/09/04}{Macro added to support checksum.}
% This advances the count when a backslash is encountered in the
-% macrocode.
+% macrocode.
% \begin{macrocode}
\def\step@checksum{\global\advance\bslash@cnt\@ne}
% \end{macrocode}
@@ -4643,7 +4643,7 @@
% \end{macrocode}
% \end{macro}
% \let\MakePrivateLetters=\makeatletter
-%
+%
% \begin{macro}{\wrong@table}
% \changes{v1.7a}{1992/02/28}{Moved to where the catcodes are right
% so it works.}
@@ -4664,8 +4664,8 @@
% The code in this section allows index entries to refer to code line
% numbers---the number of the first line of macrocode in the
% \textsf{macro} environment.
-%
-%
+%
+%
% \begin{macro}{\codeline@index}
% Indexing by code line is controlled by the "codeline@index" switch.
% \changes{v1.5s}{1989/11/05}{Support for code line no. (Undoc)}
@@ -4702,9 +4702,9 @@
% \cs{CodelineIndex} (Undoc)}
% This switches on use of the index file with "\makeindex", sets the
% switch to indicate code line numbering and defines "\special@index"
-% appropriately.
+% appropriately.
% \begin{macrocode}
-\def\CodelineIndex{\makeindex
+\def\CodelineIndex{\makeindex
\codeline@indextrue
\let\special@index\codeline@wrindex}
% \end{macrocode}
@@ -4712,7 +4712,7 @@
% \begin{macro}{\PageIndex}
% "\PageIndex" is similar.
% \begin{macrocode}
-\def\PageIndex{\makeindex
+\def\PageIndex{\makeindex
\codeline@indexfalse
\let\special@index\index}
% \end{macrocode}
@@ -4765,7 +4765,7 @@
%
% The following |\mathcode| definitions allow the characters
% `|\|'
-% and `\texttt{@}' to appear in |\ttfamily| font when invoked in math
+% and `\texttt{@}' to appear in |\ttfamily| font when invoked in math
% mode;\footnote{You may wonder why the definitions state that both
% characters belong to the {\em variable family\/}
% (i.e.\ the number 7 in front). The reason is this:
@@ -4775,7 +4775,7 @@
% math family number 7 which is the typewriter family in
% standard \LaTeX.
% But this file should not depend on this specific
-% setting, so I changed these
+% setting, so I changed these
% \texttt{\bslash mathcode}$\,$s
% to work with any family assignments. For an example
% see the article about the new font selection scheme.}