5 % Common declarations for mdwtools.dtx files
7 % (c) 1996 Mark Wooding
11 % \begin{meta-comment} <general public licence>
13 %% mdwtools common declarations
14 %% Copyright (c) 1996 Mark Wooding
16 %% This program is free software; you can redistribute it and/or modify
17 %% it under the terms of the GNU General Public License as published by
18 %% the Free Software Foundation; either version 2 of the License, or
19 %% (at your option) any later version.
21 %% This program is distributed in the hope that it will be useful,
22 %% but WITHOUT ANY WARRANTY; without even the implied warranty of
23 %% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 %% GNU General Public License for more details.
26 %% You should have received a copy of the GNU General Public License
27 %% along with this program; if not, write to the Free Software
28 %% Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
32 % \begin{meta-comment} <file preamble>
34 \ProvidesFile{mdwtools.tex
}
35 [1996/
05/
10 1.4 Shared definitions for mdwtools .dtx files
]
41 %% {Upper-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
42 %% 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
43 %% Digits \0\1\2\3\4\5\6\7\8\9
44 %% Exclamation \! Double quote \" Hash (number) \#
45 %% Dollar \$ Percent \% Ampersand \&
46 %% Acute accent \' Left paren \( Right paren \)
47 %% Asterisk \* Plus \+ Comma \,
48 %% Minus \- Point \. Solidus \/
49 %% Colon \: Semicolon \; Less than \<
50 %% Equals \= Greater than \> Question mark \?
51 %% Commercial at \@ Left bracket \[ Backslash \\
52 %% Right bracket \] Circumflex \^ Underscore \_
53 %% Grave accent \` Left brace \{ Vertical bar \|
54 %% Right brace \} Tilde \~}
57 % \section{Introduction and user guide}
59 % This file is really rather strange; it gets |\input| by other package
60 % documentation files to set up most of the environmental gubbins for them.
61 % It handles almost everything, like loading a document class, finding any
62 % packages, and building and formatting the title.
64 % It also offers an opportunity for users to customise my nice documentation,
65 % by using a |mdwtools.cfg| file (not included).
68 % \subsection{Declarations}
70 % A typical documentation file contains something like
71 % \begin{listinglist} \listingsize \obeylines
76 % The initial |\input| reads in this file and sets up the various commands
77 % which may be needed. The final |\mdwdoc| actually starts the document,
78 % inserting a title (which is automatically generated), a table of
79 % contents etc., and reads the documentation file in (using the |\DocInput|
80 % command from the \package{doc} package.
82 % \subsubsection{Describing packages}
84 % \DescribeMacro{\describespackage}
85 % \DescribeMacro{\describesclass}
86 % \DescribeMacro{\describesfile}
87 % \DescribeMacro{\describesfile*}
88 % The most important declarations are those which declare what the
89 % documentation describes. Saying \syntax{"\\describespackage{<package>}"}
90 % loads the \<package> (if necessary) and adds it to the auto-generated
91 % title, along with a footnote containing version information. Similarly,
92 % |\describesclass| adds a document class name to the title (without loading
93 % it -- the document itself must do this, with the |\documentclass| command).
94 % For files which aren't packages or classes, use the |\describesfile| or
95 % |\describesfile*| command (the $*$-version won't |\input| the file, which
96 % is handy for files like |mdwtools.tex|, which are already input).
98 % \DescribeMacro{\author}
99 % \DescribeMacro{\date}
100 % \DescribeMacro{\title}
101 % The |\author|, |\date| and |\title| declarations work slightly differently
102 % to normal -- they ensure that only the \emph{first} declaration has an
103 % effect. (Don't you play with |\author|, please, unless you're using this
104 % program to document your own packages.) Using |\title| suppresses the
105 % automatic title generation.
107 % \DescribeMacro{\docdate}
108 % The default date is worked out from the version string of the package or
109 % document class whose name is the same as that of the documentation file.
110 % You can choose a different `main' file by saying
111 % \syntax{"\\docdate{"<file>"}"}.
113 % \subsubsection{Contents handling}
115 % \DescribeMacro{\addcontents}
116 % A documentation file always has a table of contents. Other
117 % contents-like lists can be added by saying
118 % \syntax{"\\addcontents{"<extension>"}{"<command>"}"}. The \<extension>
119 % is the file extension of the contents file (e.g., \lit{lot} for the
120 % list of tables); the \<command> is the command to actually typeset the
121 % contents file (e.g., |\listoftables|).
123 % \subsubsection{Other declarations}
125 % \DescribeMacro{\implementation}
126 % The \package{doc} package wants you to say
127 % \syntax{"\\StopEventually{"<stuff>"}"}' before describing the package
128 % implementation. Using |mdwtools.tex|, you just say |\implementation|, and
129 % everything works. It will automatically read in the licence text (from
130 % |gpl.tex|, and wraps some other things up.
133 % \subsection{Other commands}
135 % The |mdwtools.tex| file includes the \package{syntax} and \package{sverb}
136 % packages so that they can be used in documentation files. It also defines
137 % some trivial commands of its own.
140 % Saying \syntax{"\\<"<text>">" is the same as "\\synt{"<text>"}"}; this
141 % is a simple abbreviation.
143 % \DescribeMacro{\smallf}
144 % Saying \syntax{"\\smallf" <number>"/"<number>} typesets a little fraction,
145 % like this: \smallf 3/4. It's useful when you want to say that the default
146 % value of a length is 2 \smallf 1/2\,pt, or something like that.
149 % \subsection{Customisation}
151 % You can customise the way that the package documentation looks by writing
152 % a file called |mdwtools.cfg|. You can redefine various commands (before
153 % they're defined here, even; |mdwtools.tex| checks most of the commands that
154 % it defines to make sure they haven't been defined already.
156 % \DescribeMacro{\indexing}
157 % If you don't want the prompt about whether to generate index files, you
158 % can define the |\indexing| command to either \lit{y} or \lit{n}. I'd
159 % recommend that you use |\providecommand| for this, to allow further
160 % customisation from the command line.
162 % \DescribeMacro{\mdwdateformat}
163 % If you don't like my date format (maybe you're American or something),
164 % you can redefine the |\mdwdateformat| command. It takes three arguments:
165 % the year, month and date, as numbers; it should expand to something which
166 % typesets the date nicely. The default format gives something like
167 % `10 May 1996'. You can produce something rather more exotic, like
168 % `10\textsuperscript{th} May \textsc{\romannumeral 1996}' by saying
170 %\newcommand{\mdwdateformat}[3]{%
171 % \number#3\textsuperscript{\numsuffix{#3}}\ %
173 % \textsc{\romannumeral #1}%
176 % \DescribeMacro{\monthname}
177 % \DescribeMacro{\numsuffix}
178 % Saying \syntax{"\\monthname{"<number>"}"} expands to the name of the
179 % numbered month (which can be useful when doing date formats). Saying
180 % \syntax{"\\numsuffix{"<number>"}"} will expand to the appropriate suffix
181 % (`th' or `rd' or whatever) for the \<number>. You'll have to superscript
182 % it yourself, if this is what you want to do. Putting the year number
183 % in roman numerals is just pretentious |;-)|.
185 % \DescribeMacro{\mdwhook}
186 % After all the declarations in |mdwtools.tex|, the command |\mdwhook| is
187 % executed, if it exists. This can be set up by the configuration file
188 % to do whatever you want.
190 % There are lots of other things you can play with; you should look at the
191 % implementation section to see what's possible.
195 % \section{Implementation}
201 % The first thing is that I'm not a \LaTeX\ package or anything official
202 % like that, so I must enable `|@|' as a letter by hand.
208 % Now input the user's configuration file, if it exists. This is fairly
212 \@input
{mdwtools.cfg
}
215 % Well, that's the easy bit done.
218 % \subsection{Initialisation}
220 % Obviously the first thing to do is to obtain a document class. Obviously,
221 % it would be silly to do this if a document class has already been loaded,
222 % either by the package documentation or by the configuration file.
224 % The only way I can think of for finding out if a document class is already
225 % loaded is by seeing if the |\documentclass| command has been redefined
226 % to raise an error. This isn't too hard, really.
228 % If my \package{strayman} document class is available, then I'd prefer to
232 \ifx\documentclass\@twoclasseserror
\else
233 \IfFileExists{strayman.cls
}
234 {\documentclass[a4paper]{strayman
}}
235 {\documentclass[a4paper]{ltxdoc
}}
236 \ifx\doneclasses\mdw@undefined
\else\doneclasses\fi
240 % If I can use better fonts, then that would be nice.
243 \usepackage[T1]{fontenc}
244 \IfFileExists{mdwfonts.sty
}
245 {\usepackage[palatino, helvetica, courier, maths=cmr
]{mdwfonts
}}{}
248 % As part of my standard environment, I'll load some of my more useful
249 % packages. If they're already loaded (possibly with different options),
250 % I'll not try to load them again.
253 \@ifpackageloaded
{doc
}{}{\usepackage{doc
}}
254 \@ifpackageloaded
{syntax
}{}{\usepackage[rounded
]{syntax
}}
255 \@ifpackageloaded
{sverb
}{}{\usepackage{sverb
}}
258 % If I'm not using the \package{ltxdoc} document class then I'll need some of
259 % its definitions. I've no idea why these aren't part of \package{doc}\ldots
261 % \begin{macro}{\cmd}
264 \def\cmd#1{\expandafter\cmd@i
\string#1\x}
265 \def\cmd@i
#1#2\x{\cs{#2}}
266 \DeclareRobustCommand\cs[1]{\texttt{\char`\\
#1}}
271 % \begin{macro}{\marg}
272 % \begin{macro}{\oarg}
273 % \begin{macro}{\parg}
275 \def\@arg
#1#2#3{\texttt{#1}\meta{#2}\texttt{#3}}
276 \def\marg#1{\@arg
{\char`\
{}{#1}{\char`\
}}}
277 \def\oarg#1{\@arg
{[}{#1}{]}}
278 \def\parg#1{\@arg
{(
}{#1}{)
}}
284 % \subsection{Some macros for interaction}
286 % I like the \LaTeX\ star-boxes, although it's a pain having to cope with
287 % \TeX's space-handling rules. I'll define a new typing-out macro which
288 % makes spaces more significant, and has a $*$-version which doesn't put
289 % a newline on the end, and interacts prettily with |\read|.
291 % First of all, I need to make spaces active, so I can define things about
295 \begingroup\obeyspaces
298 % Now to define the main macro. This is easy stuff. Spaces must be
299 % carefully rationed here, though.
301 % I'll start a group, make spaces active, and make spaces expand to ordinary
302 % space-like spaces. Then I'll look for a star, and pass either |\message|
303 % (which doesn't start a newline, and interacts with |\read| well) or
304 % |\immediate\write 16| which does a normal write well.
308 \begingroup\catcode`\
\active\let \space%
309 \@ifstar
{\mdwtype@i
{\message}}{\mdwtype@i
{\immediate\write\sixt@@n
}}%
314 % Now for the easy bit. I have the thing to do, and the thing to do it to,
315 % so do that and end the group.
318 \def\mdwtype@i
#1#2{#1{#2}\endgroup}
322 % \subsection{Decide on indexing}
324 % A configuration file can decide on indexing by defining the |\indexing|
325 % macro to either \lit{y} or \lit{n}. If it's not set, then I'll prompt
328 % First of all, I want a switch to say whether I'm indexing.
334 % Right: now I need to decide how to make progress. If the macro's not set,
335 % then I want to set it, and start a row of stars.
338 \ifx\indexing\@@undefined
339 \mdwtype{*****************************
}
344 % Now enter a loop, asking the user whether to do indexing, until I get
350 \if y
\indexing\@tempswatrue
\createindextrue\fi
351 \if Y
\indexing\@tempswatrue
\createindextrue\fi
352 \if n
\indexing\@tempswatrue
\createindexfalse\fi
353 \if N
\indexing\@tempswatrue
\createindexfalse\fi
355 \mdwtype*
{* Create index files? (y/n) *
}
356 \read\sixt@@n to
\indexing%
360 % Now, based on the results of that, display a message about the indexing.
363 \mdwtype{*****************************
}
365 \mdwtype{* Creating index files *
}
366 \mdwtype{* This may take some time *
}
368 \mdwtype{* Not creating index files *
}
370 \mdwtype{*****************************
}
373 % Now I can play with the indexing commands of the \package{doc} package
374 % to do whatever it is that the user wants.
386 % And register lots of plain \TeX\ things which shouldn't be indexed.
387 % This contains lots of |\if|\dots\ things which don't fit nicely in
388 % conditionals, which is a shame. Still, it doesn't matter that much,
392 \DoNotIndex{\def,
\long,
\edef,
\xdef,
\gdef,
\let,
\global}
393 \DoNotIndex{\if,
\ifnum,
\ifdim,
\ifcat,
\ifmmode,
\ifvmode,
\ifhmode,
%
394 \iftrue,
\iffalse,
\ifvoid,
\ifx,
\ifeof,
\ifcase,
\else,
\or,
\fi}
395 \DoNotIndex{\box,
\copy,
\setbox,
\unvbox,
\unhbox,
\hbox,
%
396 \vbox,
\vtop,
\vcenter}
397 \DoNotIndex{\@empty,
\immediate,
\write}
398 \DoNotIndex{\egroup,
\bgroup,
\expandafter,
\begingroup,
\endgroup}
399 \DoNotIndex{\divide,
\advance,
\multiply,
\count,
\dimen}
400 \DoNotIndex{\relax,
\space,
\string}
401 \DoNotIndex{\csname,
\endcsname,\@spaces,
\openin,
\openout,
%
403 \DoNotIndex{\catcode,
\endinput}
404 \DoNotIndex{\jobname,
\message,
\read,
\the,
\m@ne,
\noexpand}
405 \DoNotIndex{\hsize,
\vsize,
\hskip,
\vskip,
\kern,
\hfil,
\hfill,
\hss}
406 \DoNotIndex{\m@ne,
\z@,
\z@skip,\@ne,
\tw@,
\p@
}
407 \DoNotIndex{\dp,
\wd,
\ht,
\vss,
\unskip}
410 % Last bit of indexing stuff, for now: I'll typeset the index in two columns
411 % (the default is three, which makes them too narrow for my tastes).
414 \setcounter{IndexColumns
}{2}
418 % \subsection{Selectively defining things}
420 % I don't want to tread on anyone's toes if they redefine any of these
421 % commands and things in a configuration file. The following definitions
422 % are fairly evil, but should do the job OK.
424 % \begin{macro}{\@gobbledef}
426 % This macro eats the following |\def|inition, leaving not a trace behind.
429 \def\@gobbledef
#1#
{\@gobble
}
434 % \begin{macro}{\tdef}
435 % \begin{macro}{\tlet}
437 % The |\tdef| command is a sort of `tentative' definition -- it's like
438 % |\def| if the control sequence named doesn't already have a definition.
439 % |\tlet| does the same thing with |\let|.
444 \expandafter\def\expandafter#1%
446 \expandafter\@gobbledef
%
449 \def\tlet#1#2{\ifx#1\@@undefined
\let#1=
#2\fi}
456 % \subsection{General markup things}
458 % Now for some really simple things. I'll define how to typeset package
459 % names and environment names (both in the sans serif font, for now).
462 \tdef\package{\textsf}
466 % I'll define the |\<|\dots|>| shortcut for syntax items suggested in the
467 % \package{syntax} package.
470 \tdef\<
#1>
{\synt{#1}}
473 % And because it's used in a few places (mainly for typesetting lengths),
474 % here's a command for typesetting fractions in text.
477 \tdef\smallf#1/
#2{\ensuremath{^
{#1}\!/\!_
{#2}}}
481 % \subsection{Custom description lists}
483 % For some bizarre reason, the \LaTeX\ \env{description} environment sets
484 % |\itemindent| so that the label starts |\labelsep| into the left margin,
485 % and the default |\makelabel| must therefore contain a hack to compensate.
486 % This is fixed in the \package{strayman} document class, and by the
487 % \package{mdwlist} package in this collection. But this introduces a
488 % problem: if I want to set a \env{description} list with custom labels, how
489 % can I do this without messing up the spacing?
491 % Detection of the relevant packages is done in an awfully hacky way, because
492 % \LaTeXe\ seems to go out of its way to forget which packages have been
493 % loaded at |\begin{document}| time.
496 \def\setdescriptionlabel#1{%
497 \if1\ifx\sectindent\xxundefined% strayman?
498 \ifx\defaultdesc\xxundefined% mdwlist?
500 \def\makelabel#
#1{\hskip\labelsep\relax#1}%
502 \def\makelabel#
#1{#1}%
508 % \subsection{A table environment}
510 % \begin{environment}{tab}
512 % Most of the packages don't use the (obviously perfect) \package{mdwtab}
513 % package, because it's big, and takes a while to load. Here's an
514 % environment for typesetting centred tables. The first (optional) argument
515 % is some declarations to perform. The mandatory argument is the table
516 % preamble (obviously).
520 \newenvironment{tab
}[2][\relax]{%
535 % \subsection{Commenting out of stuff}
537 % \begin{environment}{meta-comment}
539 % Using |\iffalse|\dots|\fi| isn't much fun. I'll define a gobbling
540 % environment using the \package{sverb} stuff.
543 \ignoreenv{meta-comment
}
549 % \subsection{Float handling}
551 % This gubbins will try to avoid float pages as much as possible, and (with
552 % any luck) encourage floats to be put on the same pages as text.
555 \def\textfraction{0.1}
556 \def\topfraction{0.9}
557 \def\bottomfraction{0.9}
558 \def\floatpagefraction{0.7}
561 % Now redefine the default float-placement parameters to allow `here' floats.
564 \def\fps@figure
{htbp
}
569 % \subsection{Other bits of parameter tweaking}
571 % Make \env{grammar} environments look pretty, by indenting the left hand
572 % sides by a large amount.
578 % I don't like being told by \TeX\ that my paragraphs are hard to linebreak:
579 % I know this already. This lot should shut \TeX\ up about most problems.
587 % Also make \TeX\ shut up in the index. The \package{multicol} package
588 % irritatingly plays with |\hbadness|. This is the best hook I could find
589 % for playing with this setting.
592 \expandafter\def\expandafter\IndexParms\expandafter{%
598 % The other thing I really don't like is `Marginpar moved' warnings. This
599 % will get rid of them, and lots of other \LaTeX\ warnings at the same time.
602 \let\@latex@warning@no@line\@gobble
605 % Put some extra space between table rows, please.
608 \def\arraystretch{1.2}
611 % Most of the code is at guard level one, so typeset that in upright text.
614 \setcounter{StandardModuleDepth
}{1}
618 % \subsection{Contents handling}
620 % I use at least one contents file (the main table of contents) although
621 % I may want more. I'll keep a list of contents files which I need to
624 % There are two things I need to do to contents files here:
626 % \item I must typeset the table of contents at the beginning of the
628 % \item I want to typeset tables of contents in two columns (using the
629 % \package{multicol} package).
632 % The list consists of items of the form
633 % \syntax{"\\do{"<extension>"}{"<command>"}"}, where \<extension> is the
634 % file extension of the contents file, and \<command> is the command to
637 % \begin{macro}{\docontents}
639 % This is where I keep the list of contents files. I'll initialise it to
640 % just do the standard contents table.
643 \def\docontents{\do{toc
}{\tableofcontents}}
648 % \begin{macro}{\addcontents}
650 % By saying \syntax{"\\addcontents{"<extension>"}{"<command>"}"}, a document
651 % can register a new table of contents which gets given the two-column
652 % treatment properly. This is really easy to implement.
655 \def\addcontents#1#2{%
656 \toks@
\expandafter{\docontents\do{#1}{#2}}%
657 \edef\docontents{\the\toks@
}%
664 % \subsection{Finishing it all off}
666 % \begin{macro}{\finalstuff}
668 % The |\finalstuff| macro is a hook for doing things at the end of the
669 % document. Currently, it inputs the licence agreement as an appendix.
672 \tdef\finalstuff{\appendix\part*
{Appendix
}\input{gpl
}}
677 % \begin{macro}{\implementation}
679 % The |\implementation| macro starts typesetting the implementation of
680 % the package(s). If we're not doing the implementation, it just does
681 % this lot and ends the input file.
683 % I define a macro with arguments inside the |\StopEventually|, which causes
684 % problems, since the code gets put through an extra level of |\def|fing
685 % depending on whether the implementation stuff gets typeset or not. I'll
686 % store the code I want to do in a separate macro.
689 \def\implementation{\StopEventually{\attheend}}
692 % Now for the actual activity. First, I'll do the |\finalstuff|. Then, if
693 % \package{doc}'s managed to find the \package{multicol} package, I'll add
694 % the end of the environment to the end of each contents file in the list.
695 % Finally, I'll read the index in from its formatted |.ind| file.
701 \def\do#
#1#
#2{\addtocontents{#
#1}{\protect\end{multicols
}}}%
704 \ifx\backmatter\@@undefined
\else\backmatter\fi%
712 % \subsection{File version information}
714 % \begin{macro}{\mdwpkginfo}
716 % For setting up the automatic titles, I'll need to be able to work out
717 % file versions and things. This macro will, given a file name, extract
718 % from \LaTeX\ the version information and format it into a sensible string.
720 % First of all, I'll put the original string (direct from the
721 % |\Provides|\dots\ command). Then I'll pass it to another macro which can
722 % parse up the string into its various bits, along with the original
727 \edef\@tempa
{\csname ver@
#1\endcsname}%
728 \expandafter\mdwpkginfo@i\@tempa\@@
#1\@@
%
732 % Now for the real business. I'll store the string I build in macros called
733 % \syntax{"\\"<filename>"date", "\\"<filename>"version" and
734 % "\\"<filename>"info"}, which store the file's date, version and
735 % `information string' respectively. (Note that the file extension isn't
736 % included in the name.)
738 % This is mainly just tedious playing with |\expandafter|. The date format
739 % is defined by a separate macro, which can be modified from the
740 % configuration file.
743 \def\mdwpkginfo@i
#1/
#2/
#3 #4 #5\@@
#6.
#7\@@
{%
744 \expandafter\def\csname #6date
\endcsname%
745 {\protect\mdwdateformat{#1}{#2}{#3}}%
746 \expandafter\def\csname #6version
\endcsname{#4}%
747 \expandafter\def\csname #6info
\endcsname{#5}%
753 % \begin{macro}{\mdwdateformat}
755 % Given three arguments, a year, a month and a date (all numeric), build a
756 % pretty date string. This is fairly simple really.
759 \tdef\mdwdateformat#1#2#3{\number#3\
\monthname{#2}\
\number#1}
762 January
\or February
\or March
\or April
\or May
\or June
\or%
763 July
\or August
\or September
\or October
\or November
\or December
%
775 \fi\fi\fi\fi\fi\fi\fi%
781 % \begin{macro}{\mdwfileinfo}
783 % Saying \syntax{"\\mdwfileinfo{"<file-name>"}{"<info>"}"} extracts the
784 % wanted item of \<info> from the version information for file \<file-name>.
787 \def\mdwfileinfo#1#2{\mdwfileinfo@i
{#2}#1.\@@
}
788 \def\mdwfileinfo@i
#1#2.
#3\@@
{\csname#2#1\endcsname}
794 % \subsection{List handling}
796 % There are several other lists I need to build. These macros will do
797 % the necessary stuff.
799 % \begin{macro}{\mdw@ifitem}
801 % The macro \syntax{"\\mdw@ifitem"<item>"\\in"<list>"{"<true-text>"}"^^A
802 % "{"<false-text>"}"} does \<true-text> if the \<item> matches any item in
803 % the \<list>; otherwise it does \<false-text>.
806 \def\mdw@ifitem
#1\in#2{%
809 \def\do#
#1{\def\@tempb
{#
#1}\ifx\@tempa\@tempb\@tempswatrue
\fi}%
811 \if@tempswa
\expandafter\@firstoftwo
\else\expandafter\@secondoftwo
\fi%
817 % \begin{macro}{\mdw@append}
819 % Saying \syntax{"\\mdw@append"<item>"\\to"<list>} adds the given \<item>
820 % to the end of the given \<list>.
823 \def\mdw@append
#1\to#2{%
825 \toks\tw@
\expandafter{#2}%
826 \edef#2{\the\toks\tw@
\the\toks@
}%
832 % \begin{macro}{\mdw@prepend}
834 % Saying \syntax{"\\mdw@prepend"<item>"\\to"<list>} adds the \<item> to the
835 % beginning of the \<list>.
838 \def\mdw@prepend
#1\to#2{%
840 \toks\tw@
\expandafter{#2}%
841 \edef#2{\the\toks@
\the\toks\tw@
}%
847 % \begin{macro}{\mdw@add}
849 % Finally, saying \syntax{"\\mdw@add"<item>"\\to"<list>} adds the \<item>
850 % to the list only if it isn't there already.
853 \def\mdw@add
#1\to#2{\mdw@ifitem
#1\in#2{}{\mdw@append
#1\to#2}}
859 % \subsection{Described file handling}
861 % I'l maintain lists of packages, document classes, and other files
862 % described by the current documentation file.
864 % First of all, I'll declare the various list macros.
872 % \begin{macro}{\describespackage}
874 % A document file can declare that it describes a package by saying
875 % \syntax{"\\describespackage{"<package-name>"}"}. I add the package to
876 % my list, read the package into memory (so that the documentation can
877 % offer demonstrations of it) and read the version information.
880 \def\describespackage#1{%
881 \mdw@ifitem
#1\in\dopackages{}{%
882 \mdw@append
#1\to\dopackages%
891 % \begin{macro}{\describesclass}
893 % By saying \syntax{"\\describesclass{"<class-name>"}"}, a document file
894 % can declare that it describes a document class. I'll assume that the
895 % document class is already loaded, because it's much too late to load
899 \def\describesclass#1{\mdw@add
#1\to\doclasses\mdwpkginfo{#1.cls
}}
904 % \begin{macro}{\describesfile}
906 % Finally, other `random' files, which don't have the status of real \LaTeX\
907 % packages or document classes, can be described by saying \syntax{^^A
908 % "\\describesfile{"<file-name>"}" or "\\describesfile*{"<file-name>"}"}.
909 % The difference is that the starred version will not |\input| the file.
913 \@ifstar
{\describesfile@i\@gobble
}{\describesfile@i
\input}%
915 \def\describesfile@i
#1#2{%
916 \mdw@ifitem
#2\in\dootherfiles{}{%
917 \mdw@add
#2\to\dootherfiles%
927 % \subsection{Author and title handling}
929 % I'll redefine the |\author| and |\title| commands so that I get told
930 % whether I need to do it myself.
932 % \begin{macro}{\author}
934 % This is easy: I'll save the old meaning, and then redefine |\author| to
935 % do the old thing and redefine itself to then do nothing.
938 \let\mdw@author
\author
939 \def\author{\let\author\@gobble
\mdw@author
}
944 % \begin{macro}{\title}
946 % And oddly enough, I'll do exactly the same thing for the title, except
947 % that I'll also disable the |\mdw@buildtitle| command, which constructs
948 % the title automatically.
952 \def\title{\let\title\@gobble
\let\mdw@buildtitle
\relax\mdw@title
}
957 % \begin{macro}{\date}
959 % This works in a very similar sort of way.
962 \def\date#1{\let\date\@gobble
\def\today{#1}}
967 % \begin{macro}{\datefrom}
969 % Saying \syntax{"\\datefrom{"<file-name>"}"} sets the document date from
970 % the given filename.
974 \protected@edef\@tempa
{\noexpand\date{\csname #1date
\endcsname}}%
981 % \begin{macro}{\docfile}
983 % Saying \syntax{"\\docfile{"<file-name>"}"} sets up the file name from which
984 % documentation will be read.
988 \def\@tempa#
#1.#
#2\@@
{\def\@basefile
{#
#1.#
#2}\def\@basename
{#
#1}}%
989 \edef\@tempb
{\noexpand\@tempa
#1\noexpand\@@
}%
994 % I'll set up a default value as well.
997 \docfile{\jobname.dtx
}
1003 % \subsection{Building title strings}
1005 % This is rather tricky. For each list, I need to build a legible looking
1008 % \begin{macro}{\mdw@addtotitle}
1011 %\syntax{"\\mdw@addtotitle{"<list>"}{"<command>"}{"<singular>"}{"<plural>"}"}
1012 % I can add the contents of a list to the current title string in the
1013 % |\mdw@title| macro.
1016 \tdef\mdw@addtotitle
#1#2#3#4{%
1019 % Now to get to work. I need to keep one `lookahead' list item, and a count
1020 % of the number of items read so far. I'll keep the lookahead item in
1021 % |\@nextitem| and the counter in |\count@|. Things are even worse because
1022 % the footnote symbols should appear \emph{after} the separating punctuation,
1023 % so we need to delay those by another cycle, hence we have |\@nextnote| and
1030 % Now I'll define what to do for each list item. The |\protect| command is
1031 % already set up appropriately for playing with |\edef| commands.
1037 % The first job is to add the previous item to the title string. If this
1038 % is the first item, though, I'll just add the appropriate \lit{The } or
1039 % \lit{ and the } string to the title (this is stored in the |\@prefix|
1040 % macro). Also maintain a parallel version which doesn't have the footnotes
1041 % in: this will be suitable for a running header.
1046 \ifcase\count@\@prefix
%
1048 \else,\@prevnote\ \@nextitem
%
1051 \edef\mdw@runningtitle
{%
1053 \ifcase\count@\@prefix
%
1060 % That was rather easy. Now I'll set up the |\@previtem| and |\@nextitem|
1061 % macros for the next time around the loop.
1064 \edef\@nextitem
{\protect#2{#
#1}}%
1065 \let\@prevnote\@nextnote
1068 The
\protect#2{#
#1} #3 is currently at version
%
1069 \mdwfileinfo{#
#1}{version
}, dated
\mdwfileinfo{#
#1}{date
}.
%
1074 % Finally, I need to increment the counter.
1077 \advance\count@\@ne
%
1081 % Now execute the list.
1087 % I still have one item left over, unless the list was empty. I'll add
1094 \or\@nextitem\@nextnote
\space#3%
1095 \or\@prevnote\ and \@nextitem\@nextnote
\space#4%
1096 \else,\@prevnote\ and \@nextitem\@nextnote
\space#4%
1099 \edef\mdw@runningtitle
{%
1102 \or\@nextitem
\space#3%
1103 \or\ and \@nextitem
\space#4%
1104 \else,\ and \@nextitem
\space#4%
1109 % Finally, if $|\count@| \ne 0$, I must set |\@prefix| to \lit{ and the }.
1112 \ifnum\count@>
\z@
\def\@prefix
{ and the
}\fi%
1118 % \begin{macro}{\mdw@buildtitle}
1120 % This macro will actually do the job of building the title string.
1123 \tdef\mdw@buildtitle
{%
1126 % First of all, I'll open a group to avoid polluting the namespace with
1127 % my gubbins (although the code is now much tidier than it has been in
1128 % earlier releases).
1134 % The title building stuff makes extensive use of |\edef|. I'll set
1135 % |\protect| appropriately. (For those not in the know,
1136 % |\@unexpandable@protect| expands to `|\noexpand\protect\noexpand|',
1137 % which prevents expansion of the following macro, and inserts a |\protect|
1138 % in front of it ready for the next |\edef|.)
1141 \let\@@protect
\protect\let\protect\@unexpandable@protect
%
1144 % Set up some simple macros ready for the main code.
1148 \def\mdw@runningtitle
{}%
1152 % Now build the title. This is fun.
1155 \mdw@addtotitle
\dopackages\package{package
}{packages
}%
1156 \mdw@addtotitle
\doclasses\package{document class
}{document classes
}%
1157 \mdw@addtotitle
\dootherfiles\texttt{file
}{files
}%
1160 % Now I want to end the group and set the title from my string. The
1161 % following hacking will do this.
1166 \noexpand\title{\noexpand\mdw@titlehack
\mdw@title
}%
1167 \def\noexpand\@headertitle
{\mdw@runningtitle
}%
1175 % \begin{macro}{\mdw@titlehack}
1177 % Wait! Did you notice that |\mdw@titlehack|? What's that about?
1179 % It turns out that the default document classes hack the footnote insertion
1180 % commands to make footnote symbols take up no horizontal space in the title.
1181 % Apparently this makes author names look as if they're centred properly when
1182 % there are affiliation footnotes. Anyway, \package{doc} perpetuates this
1183 % silliness, but it makes a mess of the version markers I insert, so I must
1184 % deploy countermeasures.
1187 \def\mdw@titlehack
{\def\@makefnmark
{$
\m@th^
{\@thefnmark
}$
}}
1192 % \subsection{Starting the main document}
1194 % \begin{macro}{\mdwdoc}
1196 % Once the document preamble has done all of its stuff, it calls the
1197 % |\mdwdoc| command, which takes over and really starts the documentation
1204 % First, I'll construct the title string.
1208 \author{Mark Wooding
}%
1211 % Set up the date string based on the date of the package which shares
1212 % the same name as the current file.
1215 \datefrom\@basename
%
1218 % Set up verbatim characters after all the packages have started.
1225 % Start the document, and put the title in.
1229 \ifx\frontmatter\@@undefined
\else\frontmatter\fi%
1233 % This is nasty. It makes maths displays work properly in demo environments.
1234 % \emph{The \LaTeX\ Companion} exhibits the bug which this hack fixes. So
1238 \abovedisplayskip\z@
%
1241 % Now start the contents tables. After starting each one, I'll make it
1246 \ifhave@multicol
\addtocontents{#
#1}{%
1247 \protect\begin{multicols
}{2}%
1255 % Input the main file now.
1258 \ifx\mainmatter\@@undefined
\else\mainmatter\fi%
1259 \DocInput{\@basefile
}%
1262 % That's it. I'm done.
1272 % \subsection{And finally\dots}
1274 % Right at the end I'll put a hook for the configuration file.
1277 \ifx\mdwhook\@@undefined
\else\expandafter\mdwhook\fi
1280 % That's all the code done now. I'll change back to `user' mode, where
1281 % all the magic control sequences aren't allowed any more.
1288 % Oh, wait! What if I want to typeset this documentation? Aha. I'll cope
1289 % with that by comparing |\jobname| with my filename |mdwtools|. However,
1290 % there's some fun here, because |\jobname| contains category-12 letters,
1291 % while my letters are category-11. Time to play with |\string| in a messy
1297 \edef\@tempa
{\expandafter\@gobble
\string\mdwtools}
1298 \edef\@tempb
{\jobname}
1300 \describesfile*
{mdwtools.tex
}
1301 \docfile{mdwtools.tex
}
1311 % \hfill Mark Wooding, \today