| 1 |
% \iffalse |
| 2 |
% |
| 3 |
% Copyright 1999, 2000 the fontinst maintenance team and any individual |
| 4 |
% authors listed elsewhere in this file. All rights reserved. |
| 5 |
% |
| 6 |
% This file is part of the fontinst system version 1.9. |
| 7 |
% ----------------------------------------------------- |
| 8 |
% |
| 9 |
% It may be distributed under the terms of the LaTeX Project Public |
| 10 |
% License, as described in lppl.txt in the base LaTeX distribution. |
| 11 |
% Either version 1.1 or, at your option, any later version. |
| 12 |
% |
| 13 |
% \fi |
| 14 |
% |
| 15 |
% \title{The \package{fisource} package} |
| 16 |
% \author{Lars Hellstr\"om} |
| 17 |
% \maketitle |
| 18 |
% |
| 19 |
% \begin{macrocode} |
| 20 |
\NeedsTeXFormat{LaTeX2e} |
| 21 |
\ProvidesPackage{fisource}% |
| 22 |
[2003/03/29 v2.16 Fontinst source documentation commands] |
| 23 |
% \end{macrocode} |
| 24 |
% |
| 25 |
% \section{Option processing} |
| 26 |
% |
| 27 |
% \begin{option}{warnfinale} |
| 28 |
% \changes{2.01}{2000/07/06}{Option added. (LH)} |
| 29 |
% Under development I find it quite a nuisance that |\Finale| raises |
| 30 |
% an error if the checksum isn't correct; a warning feels more |
| 31 |
% appropriate. Therefore the \texttt{warnfinale} option redefines |
| 32 |
% |\check@checksum| to emit a warning instead. |
| 33 |
% \begin{macrocode} |
| 34 |
\DeclareOption{warnfinale}{% |
| 35 |
\@ifpackageloaded{doc}\@firstofone\AtEndOfPackage {% |
| 36 |
\def\check@checksum{\relax |
| 37 |
\ifnum\check@sum=\z@ |
| 38 |
\typeout{**********************************}% |
| 39 |
\typeout{* This macro file has no checksum!}% |
| 40 |
\typeout{* The checksum should be \the\bslash@cnt!}% |
| 41 |
\typeout{**********************************}% |
| 42 |
\else\ifnum \check@sum=\bslash@cnt |
| 43 |
\typeout{*******************}% |
| 44 |
\typeout{* Checksum passed *}% |
| 45 |
\typeout{*******************}% |
| 46 |
\else |
| 47 |
\PackageWarning{doc}{Checksum not passed |
| 48 |
(\the\check@sum<>\the\bslash@cnt)}% |
| 49 |
\fi\fi |
| 50 |
\global\check@sum\z@ |
| 51 |
}% |
| 52 |
}% |
| 53 |
} |
| 54 |
% \end{macrocode} |
| 55 |
% \end{option} |
| 56 |
% |
| 57 |
% All other options are passed on to \package{xdoc}. |
| 58 |
% \begin{macrocode} |
| 59 |
\DeclareOption*{\PassOptionsToPackage{\CurrentOption}{xdoc2}} |
| 60 |
\ProcessOptions\relax |
| 61 |
% \end{macrocode} |
| 62 |
% |
| 63 |
% \changes{2.00}{2000/07/06}{Use \package{xdoc1}. (LH)} |
| 64 |
% \changes{2.02}{2000/07/15}{Use \package{xdoc2}. (LH)} |
| 65 |
% \changes{2.10}{2001/02/27}{Use \package{docidx2e}. (LH)} |
| 66 |
% \begin{macrocode} |
| 67 |
\RequirePackage{xdoc2,docidx2e} |
| 68 |
% \end{macrocode} |
| 69 |
% |
| 70 |
% \section{Miscellanea} |
| 71 |
% |
| 72 |
% \begin{macrocode} |
| 73 |
\CodelineIndex |
| 74 |
\setcounter{IndexColumns}{2} |
| 75 |
\setcounter{tocdepth}{2} |
| 76 |
\DeclareRobustCommand\package[1]{\textsf{#1}} |
| 77 |
\DeclareRobustCommand\eTeX{\(\varepsilon\)-\kern-.125em\TeX} |
| 78 |
% \end{macrocode} |
| 79 |
% |
| 80 |
% \begin{macro}{\AllTeX} |
| 81 |
% \changes{2.13}{2001/08/26}{Command added. (LH)} |
| 82 |
% \begin{macro}{\La} |
| 83 |
% The |\AllTeX| command is for writing `(La)TeX' (but nicer). The |
| 84 |
% definition is taken from \texttt{tugboat.dtx}. |
| 85 |
% \begin{macrocode} |
| 86 |
\newcommand{\La}{% |
| 87 |
L\kern-.36em |
| 88 |
{% |
| 89 |
\setbox0\hbox{T}% |
| 90 |
\vbox to\ht0{\hbox{% |
| 91 |
$\m@th$\csname S@\f@size\endcsname |
| 92 |
\fontsize\sf@size\z@\math@fontsfalse\selectfont |
| 93 |
A% |
| 94 |
}\vss}% |
| 95 |
}% |
| 96 |
} |
| 97 |
\DeclareRobustCommand\AllTeX{(\La\kern-.075em)\kern-.075em\TeX} |
| 98 |
% \end{macrocode} |
| 99 |
% \end{macro}\end{macro} |
| 100 |
% |
| 101 |
% \begin{macro}{\missing} |
| 102 |
% \changes{2.10}{2001/02/27}{Redefined using |
| 103 |
% \cs{NewDescribeCommand}. (LH)} |
| 104 |
% \begin{macrocode} |
| 105 |
\NewDescribeCommand\missing{% |
| 106 |
\XD@grab@marg\XD@grab@harmless@cs |
| 107 |
}{2}{% |
| 108 |
\GenericDescribePrint{\small Not in \texttt{#1}: |
| 109 |
\texttt{\Bslash#2}}% |
| 110 |
\MakeSortKey\@tempa{#2}{}% |
| 111 |
\IndexEntry{% |
| 112 |
\LevelSorted{Not in #1:}{Not in \texttt{#1}:}% |
| 113 |
\LevelSorted{\@tempa}{\texttt{\Bslash#2}}% |
| 114 |
}{usage}{\thepage}% |
| 115 |
} |
| 116 |
% \newcommand\missing[2]{% |
| 117 |
% \marginpar{% |
| 118 |
% \raggedleft\leavevmode\strut |
| 119 |
% Not in \texttt{#1}: \texttt{\string#2}\strut |
| 120 |
% \index{Not in #1\actualchar Not in \string\texttt{#1}\levelchar |
| 121 |
% \string#2\actualchar\string\verb\verbatimchar |
| 122 |
% \string#2\verbatimchar\encapchar usage}% |
| 123 |
% }% |
| 124 |
% } |
| 125 |
% \end{macrocode} |
| 126 |
% \end{macro} |
| 127 |
% |
| 128 |
% \begin{macrocode} |
| 129 |
\newcommand\ambiguity[1]{\leavevmode |
| 130 |
\textbf{#1\index{Ambiguity\encapchar usage}}% |
| 131 |
\marginpar{\raggedleft\textbf{\huge A}}% |
| 132 |
} |
| 133 |
\newcommand\question[1]{\leavevmode |
| 134 |
\textbf{#1\index{Question\encapchar usage}}% |
| 135 |
\marginpar{\raggedleft\textbf{\huge ?}}% |
| 136 |
} |
| 137 |
\AtBeginDocument{\catcode`\_=11} |
| 138 |
\def\MakePrivateLetters{\catcode`\_=11\makeatletter} |
| 139 |
|
| 140 |
% \end{macrocode} |
| 141 |
% |
| 142 |
% \multchanges{\cs{meta}}{1.30}{2000/01/02}{\cs{Meta} command (robust |
| 143 |
% wrapper around \package{doc}'s \cs{meta}) added. (LH)} |
| 144 |
% \multchanges{\cs{meta}}{1.31}{2000/02/10}{Command redefined so that |
| 145 |
% it is robust itself. \cs{Meta} removed. (LH)} |
| 146 |
% \multchanges{\cs{meta@font@select}}{1.33}{2000/02/26}{Macro added. |
| 147 |
% (LH)} |
| 148 |
% \multchanges{\cs{meta}}{1.35}{2000/03/25}{Don't make \cs{setlanguage} |
| 149 |
% whatsits in restricted horizontal mode. (LH)} |
| 150 |
% \multchanges{\cs{meta}}{2.00}{2000/07/06}{Command definition removed, |
| 151 |
% since the command is already defined by \package{doc} or |
| 152 |
% \package{xdoc}. (LH)} |
| 153 |
% |
| 154 |
% \begin{macro}{\cs} |
| 155 |
% This is \package{ltxdoc}'s normal |\cs|, but with a twist to make |
| 156 |
% |\meta| produce better results when used in the argument. |
| 157 |
% \changes{1.33}{2000/02/26}{Redefinition added. (LH)} |
| 158 |
% \changes{2.00}{2000/07/06}{Use \cs{MetaNormalfont} and |
| 159 |
% \cs{PrintVisibleChar}. (LH)} |
| 160 |
% \begin{macrocode} |
| 161 |
\DeclareRobustCommand\cs[1]{% |
| 162 |
\texttt{\MetaNormalfont\PrintVisibleChar{`\\}#1}% |
| 163 |
} |
| 164 |
% \end{macrocode} |
| 165 |
% \end{macro} |
| 166 |
% |
| 167 |
% \begin{environment}{isyntax} |
| 168 |
% |isyntax| is for ``informal'' syntax specifications, such as |
| 169 |
% \begin{quote} |
| 170 |
% A \meta{varchar command} can be one of\\ |
| 171 |
% \begin{quote} |
| 172 |
% |\vartop|\marg{glyph}\\ |
| 173 |
% |\varmid|\marg{glyph}\\ |
| 174 |
% |\varbot|\marg{glyph}\\ |
| 175 |
% |\varrep|\marg{glyph} |
| 176 |
% \end{quote} |
| 177 |
% \end{quote} |
| 178 |
% The implementation is based on that of the \texttt{verse} |
| 179 |
% environment.It usually works just as fine with \texttt{quote}, but |
| 180 |
% \texttt{isyntax} handles breaking long lines better (and more |
| 181 |
% elegantly). |
| 182 |
% \changes{1.37}{2000/05/14}{Increased \cs{rightskip} stretchability |
| 183 |
% and added setting of \cs{linepenalty}. (LH)} |
| 184 |
% \begin{macrocode} |
| 185 |
\newenvironment{isyntax}{% |
| 186 |
\let\\\@centercr |
| 187 |
\list{}{% |
| 188 |
\itemsep \z@ |
| 189 |
\itemindent -1.5em% |
| 190 |
\listparindent \itemindent |
| 191 |
\advance \leftmargin 1.5em% |
| 192 |
}% |
| 193 |
\advance \rightskip \z@\@plus0.7\linewidth \relax |
| 194 |
\linepenalty=100\relax |
| 195 |
\item\relax |
| 196 |
}{\endlist} |
| 197 |
% \end{macrocode} |
| 198 |
% \end{environment} |
| 199 |
% |
| 200 |
% \begin{environment}{obsoletemacro} |
| 201 |
% \changes{2.00}{2000/07/06}{Environment removed since obsolete. (LH)} |
| 202 |
% The \texttt{obsoletemacro} environment is for getting the right |
| 203 |
% heading on |\changes| comments that refer to macros which have been |
| 204 |
% removed. It only updates the |\saved@macroname|. |
| 205 |
% \begin{macrocode} |
| 206 |
% \newenvironment{obsoletemacro}{\begingroup |
| 207 |
% \catcode`\\12 |
| 208 |
% \MakePrivateLetters |
| 209 |
% \obsolete@macro |
| 210 |
% }{} |
| 211 |
% \def\obsolete@macro#1{\endgroup |
| 212 |
% \edef\saved@macroname{\string#1}% |
| 213 |
% } |
| 214 |
% \end{macrocode} |
| 215 |
% \end{environment} |
| 216 |
% |
| 217 |
% |
| 218 |
% \section{\texttt{macro}-like environments} |
| 219 |
% |
| 220 |
% This subsection contains the definitions of a couple of environments |
| 221 |
% that, like \package{doc}'s \texttt{environment}, are for marking up the |
| 222 |
% document (what is defined and where). The definitions of these |
| 223 |
% environments are identical to that of \texttt{environment}, except |
| 224 |
% that the index entry texts are a little different. |
| 225 |
% |
| 226 |
% This section got a lot shorter in v\,2.00 thanks to \package{xdoc}. |
| 227 |
% |
| 228 |
% \begin{environment}{fiinteger} |
| 229 |
% \begin{environment}{fistring} |
| 230 |
% \multchanges{\notcs{\texttt{fiinteger} environment}^^A |
| 231 |
% \notcs{\texttt{fistring} environment}}{2.03}{2000/07/24}^^A |
| 232 |
% {Swapped last two arguments of \cs{NewMacroEnvironment} call |
| 233 |
% since \package{xdoc} changed.} |
| 234 |
% \begin{macrocode} |
| 235 |
\NewMacroEnvironment{fiinteger}{\XD@grab@harmless\relax}{1}% |
| 236 |
{\MacroFont#1 \normalfont integer}% |
| 237 |
{\XDMainIndex{\levelsorted{#1 I}{\texttt{#1} (integer)}}% |
| 238 |
\XDMainIndex{\levelsame{integers:}\levelsorted{#1}{\texttt{#1}}}}% |
| 239 |
{{#1}{\texttt{#1} integer}}{} |
| 240 |
% \end{macrocode} |
| 241 |
% \begin{macrocode} |
| 242 |
\NewMacroEnvironment{fistring}{\XD@grab@harmless\relax}{1}% |
| 243 |
{\MacroFont#1 \normalfont string}% |
| 244 |
{\XDMainIndex{\levelsorted{#1 S}{\texttt{#1} (string)}}% |
| 245 |
\XDMainIndex{\levelsame{strings:}\levelsorted{#1}{\texttt{#1}}}}% |
| 246 |
{{#1}{\texttt{#1} string}}{} |
| 247 |
% \end{macrocode} |
| 248 |
% \end{environment}\end{environment} |
| 249 |
% |
| 250 |
% \begin{environment}{PLproperty} |
| 251 |
% \changes{2.04}{2000/11/03}{Environment added. (LH)} |
| 252 |
% \changes{2.11}{2001/03/16}{Added \cs{DoNotIndexHarmless}. (LH)} |
| 253 |
% The \texttt{PLproperty} environment is for marking up definitions |
| 254 |
% of macros for interpreting properties in (V)PL files. |
| 255 |
% \begin{macrocode} |
| 256 |
\NewMacroEnvironment{PLproperty}{\XD@grab@harmless\relax}{1}% |
| 257 |
{\MacroFont#1 \normalfont property}% |
| 258 |
{\XDMainIndex{\levelsorted{#1}{\texttt{\Bslash#1}}}% |
| 259 |
\XDMainIndex{% |
| 260 |
\levelsame{PL properties:}\levelsorted{#1}{\texttt{#1}}% |
| 261 |
}}% |
| 262 |
{{#1}{\texttt{\Bslash#1}}}% |
| 263 |
{\DoNotIndexHarmless{#1}} |
| 264 |
% \end{macrocode} |
| 265 |
% \end{environment} |
| 266 |
% |
| 267 |
% \begin{environment}{numPLproperty} |
| 268 |
% \changes{2.11}{2001/03/17}{Environment added. (LH)} |
| 269 |
% The \texttt{numPLproperty} environment is for marking up definitions |
| 270 |
% of macros that interpret a numbered family of (V)PL file properties, |
| 271 |
% such as \texttt{NUM} for \texttt{NUM1}, \texttt{NUM2}, and |
| 272 |
% \texttt{NUM3}. The syntax is |
| 273 |
% \begin{quote} |
| 274 |
% |\begin{numPLproperty}|\marg{base}\marg{num-list} |
| 275 |
% \end{quote} |
| 276 |
% In the above case the \meta{base} would be \texttt{NUM}. The |
| 277 |
% \meta{num-list} is a comma-separated list of digits (no existing |
| 278 |
% family of numbered properties have more than 5 members) that |
| 279 |
% specify what members of the family are handled by the macro being |
| 280 |
% defined. |
| 281 |
% \begin{macrocode} |
| 282 |
\NewMacroEnvironment{numPLproperty}{% |
| 283 |
\XD@grab@harmless\relax\XD@grab@marg |
| 284 |
}{2}% |
| 285 |
{\MacroFont#1$*$ \normalfont properties}% |
| 286 |
{\XDMainIndex{\levelsorted{#1}{\texttt{\Bslash#1}}}% |
| 287 |
\@for\@tempa:=#2\do{% |
| 288 |
\XDMainIndex{% |
| 289 |
\levelsame{PL properties:}% |
| 290 |
\levelsorted{#1\@tempa}{\texttt{#1\@tempa}}% |
| 291 |
}% |
| 292 |
}}% |
| 293 |
{{#1}{\texttt{\Bslash#1}}}% |
| 294 |
{\DoNotIndexHarmless{#1}} |
| 295 |
% \end{macrocode} |
| 296 |
% \end{environment} |
| 297 |
% |
| 298 |
% |
| 299 |
% \multchanges{\notcs{\texttt{switch} environment}}{2.00}{2000/07/06} |
| 300 |
% {Removed since defined in \package{xdoc}. (LH)} |
| 301 |
% |
| 302 |
% |
| 303 |
% \section{Changes of change history formating} |
| 304 |
% |
| 305 |
% \multchanges{\cs{@changes}}{2.00}{2000/07/06}{Redefinition removed |
| 306 |
% since already done in \package{xdoc}. (LH)} |
| 307 |
% |
| 308 |
% \begin{macro}{\multchanges} |
| 309 |
% \changes{1.32}{2000/02/22}{\cs{flushleftspace} between \cs{cs} |
| 310 |
% items when typeset, instead of space. (LH)} |
| 311 |
% \changes{1.34}{2000/03/11}{\cs{notcs} marker allowed in |
| 312 |
% \meta{commands}. (LH)} |
| 313 |
% \changes{2.16}{2003/03/29}{Modified macro so that it is based on |
| 314 |
% \cs{changes@}. This means it is now compatible with \cs{uintver}. |
| 315 |
% (LH)} |
| 316 |
% The |\multchanges| commands is used to record a change to several |
| 317 |
% macros. Its syntax is |
| 318 |
% \begin{quote} |
| 319 |
% |\multchanges|\marg{commands}\marg{version}\marg{date}^^A |
| 320 |
% \marg{description} |
| 321 |
% \end{quote} |
| 322 |
% The three last arguments are as the arguments of |\changes|. The |
| 323 |
% \meta{commands} should be a nonempty sequence of commands, each |
| 324 |
% command either a |\cs| or a |\notcs|, and each command with one |
| 325 |
% argument. The change history entry generated by a |
| 326 |
% |\multchanges| will be for all the macros (or whatever) listed in |
| 327 |
% the first argument. |\cs| items will be typeset in typewriter font |
| 328 |
% with a leading backslash, whereas |\notcs| items will receive no |
| 329 |
% such special formatting. |
| 330 |
% |
| 331 |
% This method may have problems with active characters (since I've |
| 332 |
% ignored some things the standard |\changes| do to accomodate these), |
| 333 |
% but luckily \package{fontinst} hardly uses active characters |
| 334 |
% anyway. Furthermore I don't think the \package{doc} way of dealing |
| 335 |
% with them would be the right way here. Perhaps an active character |
| 336 |
% should rather be entered in the \meta{commands} argument as |
| 337 |
% |\active|\marg{code} or something? |
| 338 |
% \begin{macrocode} |
| 339 |
\newcommand*\multchanges[4]{% |
| 340 |
\@bsphack |
| 341 |
\begingroup |
| 342 |
\begingroup |
| 343 |
\def\cs##1{,\space##1}% |
| 344 |
\let\notcs=\cs |
| 345 |
\protected@xdef\@gtempa{% |
| 346 |
\expandafter\@gobbletwo#1\@empty\@empty\@empty |
| 347 |
}% |
| 348 |
\edef\cs{,\noexpand\flushleftspace |
| 349 |
\noexpand\protect |
| 350 |
\expandafter\noexpand\csname cs \endcsname |
| 351 |
}% |
| 352 |
\def\notcs##1{,\noexpand\flushleftspace ##1}% |
| 353 |
\protected@xdef\@gtempa{% |
| 354 |
{\@gtempa}% |
| 355 |
{\expandafter\@gobbletwo#1\@empty\@empty\@empty}% |
| 356 |
}% |
| 357 |
\endgroup |
| 358 |
\let\saved@macroname=\@gtempa |
| 359 |
\changes@{#2}{#3}{#4}% |
| 360 |
} |
| 361 |
% \end{macrocode} |
| 362 |
% \end{macro} |
| 363 |
% |
| 364 |
% \begin{macro}{\flushleftspace} |
| 365 |
% The |\flushleftspace| command should typeset something which looks |
| 366 |
% like a space when not broken at, and as an \texttt{3em plus 1fil} |
| 367 |
% space when broken at. It also have to survive its use in |
| 368 |
% |\multchanges|. |
| 369 |
% \changes{1.32}{2000/02/22}{Command added. (LH)} |
| 370 |
% \changes{1.38}{2000/06/05}{Modified finite penalty. (LH)} |
| 371 |
% \begin{macrocode} |
| 372 |
\DeclareRobustCommand\flushleftspace{% |
| 373 |
\nobreak \hskip 3em\@plus 1fil% |
| 374 |
\penalty\@m \hskip -3em\@plus -1fil\ % |
| 375 |
} |
| 376 |
% \end{macrocode} |
| 377 |
% \end{macro} |
| 378 |
% |
| 379 |
% \begin{macro}{\labelednumber} |
| 380 |
% This \package{xdoc} macro is redefined to put a ``filbreak'' |
| 381 |
% space before every page number labelled with a macro name. |
| 382 |
% \changes{2.16}{2003/03/29}{Redefinition added. (LH)} |
| 383 |
% \begin{macrocode} |
| 384 |
\renewcommand*\labelednumber[2]{% |
| 385 |
\hskip -1em\@plus -8em% |
| 386 |
\vadjust{}\hskip 1em\@plus 8em% |
| 387 |
#2\nolinebreak[2] (#1)% |
| 388 |
} |
| 389 |
% \end{macrocode} |
| 390 |
% \end{macro} |
| 391 |
% |
| 392 |
% \begin{environment}{theglossary} |
| 393 |
% \begin{macrocode} |
| 394 |
% \ifhave@multicol |
| 395 |
% \renewenvironment{theglossary}{% |
| 396 |
% \begin{multicols}\c@GlossaryColumns |
| 397 |
% [\glossary@prologue][\GlossaryMin]% |
| 398 |
% \GlossaryParms \def\item{\@idxitem v\,}\ignorespaces}% |
| 399 |
% {\end{multicols}} |
| 400 |
% \else |
| 401 |
% \renewenvironment{theglossary}{% |
| 402 |
% \@restonecoltrue\if@twocolumn\@restonecolfalse\fi |
| 403 |
% \columnseprule \z@ \columnsep 35\p@ |
| 404 |
% \twocolumn[\glossary@prologue]% |
| 405 |
% \GlossaryParms \def\item{\@idxitem v\,}\ignorespaces} |
| 406 |
% {\if@restonecol\onecolumn\else\clearpage\fi} |
| 407 |
% \fi |
| 408 |
% \end{macrocode} |
| 409 |
% |
| 410 |
% If we want to use the glossary for some other information as well |
| 411 |
% (here I am thinking primarily on collecting |\missing| notices) then |
| 412 |
% perhaps we should insert the |v\,| in |\changes| instead. I would |
| 413 |
% guess the 64 character limit isn't at all as usual as it was when |
| 414 |
% the doc package documentation was written. |
| 415 |
% |
| 416 |
% \begin{macrocode} |
| 417 |
% \renewenvironment{theglossary}{% |
| 418 |
% % \penalty\z@\vskip\GlossaryMin\@plus\z@\@minus\GlossaryMin |
| 419 |
% % \penalty\z@\vskip-\GlossaryMin\@plus\z@\@minus-\GlossaryMin |
| 420 |
% \glossary@prologue |
| 421 |
% \GlossaryParms \let\item\@idxitem \ignorespaces |
| 422 |
% }{\par\bigskip} |
| 423 |
% \end{macrocode} |
| 424 |
% On second thoughts, the changes should be printed in one column. |
| 425 |
% They're usually very hard to linebreak in narrow columns. |
| 426 |
% \end{environment} |
| 427 |
% |
| 428 |
% \begin{macro}{\firstsubsubitem} |
| 429 |
% The idea with |\firstsubsubitem| is that it should be like |\efill| |
| 430 |
% |\subsubitem| if the paragraph is ended by a |\subsubitem| and like |
| 431 |
% \verb*"\ " if it isn't. This is achieved by grabbing the paragraph |
| 432 |
% into a macro and then prepend some suitable material to it when |
| 433 |
% typesetting. |
| 434 |
% \changes{1.36}{2000/04/10}{Grabbing paragraph as list of tokens, |
| 435 |
% rather than typeset text. (LH)} |
| 436 |
% \begin{macrocode} |
| 437 |
% \newcommand\firstsubsubitem{% |
| 438 |
% \begingroup |
| 439 |
% \let\par\@fssi@par |
| 440 |
% \let\subsubitem\@fssi@subsubitem |
| 441 |
% \protected@edef\@tempa{\iffalse}\fi |
| 442 |
% } |
| 443 |
% \end{macrocode} |
| 444 |
% \begin{macrocode} |
| 445 |
% \def\@fssi@subsubitem{% |
| 446 |
% \iffalse{\fi}% |
| 447 |
% \nobreak\hfill\vadjust{\nobreak}% |
| 448 |
% \penalty-\@M\vadjust{\penalty\@m}\nobreak\hskip -5pt\relax |
| 449 |
% \@tempa |
| 450 |
% \endgroup |
| 451 |
% \subsubitem |
| 452 |
% } |
| 453 |
% \end{macrocode} |
| 454 |
% \multchanges{\cs{@fssi@par}}{2000/06/05}{1.38}{Replaced simple space |
| 455 |
% by a more complicated sequence of penalties, vadjusts, and glue, |
| 456 |
% to make it more like \cs{flushleftspace}. (LH)} |
| 457 |
% \begin{macrocode} |
| 458 |
% \def\@fssi@par{% |
| 459 |
% \iffalse{\fi}% |
| 460 |
% \nobreak \hskip \z@ \@plus 0.4\linewidth |
| 461 |
% \vadjust{\nobreak}% |
| 462 |
% \penalty500\hskip \z@ \@plus -0.4\linewidth\hskip 5pt\relax |
| 463 |
% \penalty\z@\ \vadjust{\penalty\@m}% |
| 464 |
% \nobreak\hskip -5pt\relax |
| 465 |
% \@tempa |
| 466 |
% \endgroup |
| 467 |
% \par |
| 468 |
% } |
| 469 |
% \end{macrocode} |
| 470 |
% \end{macro} |
| 471 |
% \begin{macro}{\GlossaryParms} |
| 472 |
% \begin{macrocode} |
| 473 |
% \def\GlossaryParms{% |
| 474 |
% \parindent \z@ |
| 475 |
% \columnsep 15pt |
| 476 |
% \parskip 0pt plus 1pt |
| 477 |
% \rightskip 15pt plus 15pt |
| 478 |
% \mathsurround \z@ |
| 479 |
% \parfillskip=-\rightskip |
| 480 |
% \pretolerance=\tolerance |
| 481 |
% \small |
| 482 |
% \def\@idxitem{\par\hangindent 30pt v\,}% |
| 483 |
% \def\subitem{\par\hangindent 30pt\hspace*{15pt}}% |
| 484 |
% \def\subsubitem{\par\hangindent 30pt\hspace*{25pt}}% |
| 485 |
% \def\indexspace{\par\vspace{10pt plus 2pt minus 3pt}}% |
| 486 |
% } |
| 487 |
% \end{macrocode} |
| 488 |
% \end{macro} |
| 489 |
% |
| 490 |
% \begin{instance}{docindex}{changes} |
| 491 |
% \changes{2.10}{2001/02/27}{Redefining it. (LH)} |
| 492 |
% \changes{2.12}{2001/03/25}{Modified in the same way as the |
| 493 |
% \package{docindex} default was with v\,1.00. (LH)} |
| 494 |
% \changes{2.15}{2003/02/19}{Rewrote this redefinition. Something |
| 495 |
% was wrong with the old one, but it seems to have worked to |
| 496 |
% start again from the definition in \package{docindex}. (LH)} |
| 497 |
% \changes{2.16}{2003/03/29}{Added an insertion of `\texttt{v}\cs{,}' |
| 498 |
% to the version number headings. The way it is done is however a |
| 499 |
% hack; I should define a separate instance explicitly instead. |
| 500 |
% (LH)} |
| 501 |
% |
| 502 |
% Typesetting the list of changes is annoyingly slow. It should be |
| 503 |
% examined what takes all that time, but I suspect it is the |
| 504 |
% paragraph breaking (the parameters involved are rather absurd). I |
| 505 |
% suspect that in particular the |\multchanges| complicates things |
| 506 |
% more than they really need to. --- LH, 2004/12/15. |
| 507 |
% \begin{macrocode} |
| 508 |
\setcounter{GlossaryColumns}{1} |
| 509 |
\@namedef{TP@I{}{docindex}{changes}}#1#2{% |
| 510 |
\begingroup |
| 511 |
\def\DI@indexitem@i##1##2##3##4{% |
| 512 |
\UseInstance{indexitem}{fixed1}{##1}{##2}{v\,##3}{##4}% |
| 513 |
}% |
| 514 |
\@letinstance\DI@indexitem@ii{indexitem}{fixed-r2a-nocomma}% |
| 515 |
\@letinstance\DI@indexitem@iii{indexitem}{aloneaccept3}% |
| 516 |
\columnsep=10pt% |
| 517 |
\parskip=0pt plus 1pt% |
| 518 |
\def\DI@letter@skip{\z@skip}% |
| 519 |
\let\DI@letter@format\@gobble |
| 520 |
\def\+{-}% |
| 521 |
\IfFileExists{\jobname.gls}{% |
| 522 |
\ifnum \c@GlossaryColumns>\@ne |
| 523 |
\begin{multicols}{\c@GlossaryColumns}[#1][\GlossaryMin]% |
| 524 |
\else |
| 525 |
\enough@room{\GlossaryMin}% |
| 526 |
#1\par |
| 527 |
\addvspace\multicolsep |
| 528 |
\fi |
| 529 |
\small |
| 530 |
\makeatletter |
| 531 |
\hbadness=\@M |
| 532 |
\hfuzz=\maxdimen |
| 533 |
\pretolerance=\m@ne |
| 534 |
\tolerance=9999% |
| 535 |
\emergencystretch=5em |
| 536 |
\@nobreakfalse |
| 537 |
\DI@ind@setup |
| 538 |
\input{\jobname.gls}% |
| 539 |
\DI@item@nojoin |
| 540 |
\ifnum \c@GlossaryColumns>\@ne |
| 541 |
\end{multicols}% |
| 542 |
\else |
| 543 |
\enough@room\postmulticols |
| 544 |
\addvspace\multicolsep |
| 545 |
\fi |
| 546 |
\normalsize #2\par |
| 547 |
}{\typeout{No file \jobname.gls.}} |
| 548 |
\endgroup |
| 549 |
} |
| 550 |
% \@namedef{TP@I{}{docindex}{changes}}#1#2{% |
| 551 |
% \begingroup |
| 552 |
% \@letinstance\DI@indexitem@i{indexitem}{fixed1}% |
| 553 |
% \@letinstance\DI@indexitem@ii{indexitem}{fixed-r2a-nocomma}% |
| 554 |
% \@letinstance\DI@indexitem@iii{indexitem}{aloneaccept3}% |
| 555 |
% \columnsep=10pt% |
| 556 |
% \parskip=0pt plus 1pt% |
| 557 |
% \def\DI@letter@skip{\z@skip}% |
| 558 |
% \let\DI@letter@format\@gobble |
| 559 |
% % \ifnum \c@GlossaryColumns>\@ne |
| 560 |
% % \begin{multicols}{\c@GlossaryColumns}[#1][\GlossaryMin]% |
| 561 |
% % \else |
| 562 |
% \enough@room{\GlossaryMin}% |
| 563 |
% #1\par |
| 564 |
% \addvspace\multicolsep |
| 565 |
% % \fi |
| 566 |
% \small |
| 567 |
% \emergencystretch=5em |
| 568 |
% \@nobreakfalse |
| 569 |
% \DI@ind@setup |
| 570 |
% \@input@{\jobname.gls}% |
| 571 |
% \DI@item@nojoin |
| 572 |
% % \ifnum \c@GlossaryColumns>\@ne |
| 573 |
% % \end{multicols}% |
| 574 |
% % \else |
| 575 |
% \enough@room\postmulticols |
| 576 |
% \addvspace\multicolsep |
| 577 |
% % \fi |
| 578 |
% \normalsize #2\par |
| 579 |
% \endgroup |
| 580 |
% } |
| 581 |
% \end{macrocode} |
| 582 |
% \end{instance} |
| 583 |
% |
| 584 |
% |
| 585 |
% |
| 586 |
% \section{Hack for removing ``Marginpar moved'' warning messages} |
| 587 |
% |
| 588 |
% Check if the definition matches the known. To be on the safe |
| 589 |
% side, only the known definition will be changed. |
| 590 |
% |
| 591 |
% \begin{macrocode} |
| 592 |
\def\@tempa{\@next\@marbox\@currlist{\@cons\@freelist\@marbox |
| 593 |
\@cons\@freelist\@currbox}\@latexbug\@tempcnta\@ne |
| 594 |
\if@twocolumn |
| 595 |
\if@firstcolumn \@tempcnta\m@ne \fi |
| 596 |
\else |
| 597 |
\if@mparswitch |
| 598 |
\ifodd\c@page \else\@tempcnta\m@ne \fi |
| 599 |
\fi |
| 600 |
\if@reversemargin \@tempcnta -\@tempcnta \fi |
| 601 |
\fi |
| 602 |
\ifnum\@tempcnta <\z@ \global\setbox\@marbox\box\@currbox \fi |
| 603 |
\@tempdima\@mparbottom |
| 604 |
\advance\@tempdima -\@pageht |
| 605 |
\advance\@tempdima\ht\@marbox |
| 606 |
\ifdim\@tempdima >\z@ |
| 607 |
\@latex@warning@no@line {Marginpar on page \thepage\space moved}% |
| 608 |
\else |
| 609 |
\@tempdima\z@ |
| 610 |
\fi |
| 611 |
\global\@mparbottom\@pageht |
| 612 |
\global\advance\@mparbottom\@tempdima |
| 613 |
\global\advance\@mparbottom\dp\@marbox |
| 614 |
\global\advance\@mparbottom\marginparpush |
| 615 |
\advance\@tempdima -\ht\@marbox |
| 616 |
\global\setbox \@marbox |
| 617 |
\vbox {\vskip \@tempdima |
| 618 |
\box \@marbox}% |
| 619 |
\global \ht\@marbox \z@ |
| 620 |
\global \dp\@marbox \z@ |
| 621 |
\kern -\@pagedp |
| 622 |
\nointerlineskip |
| 623 |
\hb@xt@\columnwidth |
| 624 |
{\ifnum \@tempcnta >\z@ |
| 625 |
\hskip\columnwidth \hskip\marginparsep |
| 626 |
\else |
| 627 |
\hskip -\marginparsep \hskip -\marginparwidth |
| 628 |
\fi |
| 629 |
\box\@marbox \hss}% |
| 630 |
\nointerlineskip |
| 631 |
\hbox{\vrule \@height\z@ \@width\z@ \@depth\@pagedp}} |
| 632 |
\ifx \@addmarginpar\@tempa |
| 633 |
% \end{macrocode} |
| 634 |
% It matched. |
| 635 |
% \begin{macrocode} |
| 636 |
\def\@addmarginpar{\@next\@marbox\@currlist{\@cons\@freelist\@marbox |
| 637 |
\@cons\@freelist\@currbox}\@latexbug\@tempcnta\@ne |
| 638 |
\if@twocolumn |
| 639 |
\if@firstcolumn \@tempcnta\m@ne \fi |
| 640 |
\else |
| 641 |
\if@mparswitch |
| 642 |
\ifodd\c@page \else\@tempcnta\m@ne \fi |
| 643 |
\fi |
| 644 |
\if@reversemargin \@tempcnta -\@tempcnta \fi |
| 645 |
\fi |
| 646 |
\ifnum\@tempcnta <\z@ \global\setbox\@marbox\box\@currbox \fi |
| 647 |
\@tempdima\@mparbottom |
| 648 |
\advance\@tempdima -\@pageht |
| 649 |
\advance\@tempdima\ht\@marbox |
| 650 |
\ifdim \@tempdima<\z@ \@tempdima\z@ \fi % Modification |
| 651 |
\global\@mparbottom\@pageht |
| 652 |
\global\advance\@mparbottom\@tempdima |
| 653 |
\global\advance\@mparbottom\dp\@marbox |
| 654 |
\global\advance\@mparbottom\marginparpush |
| 655 |
\advance\@tempdima -\ht\@marbox |
| 656 |
\global\setbox \@marbox |
| 657 |
\vbox {\vskip \@tempdima |
| 658 |
\box \@marbox}% |
| 659 |
\global \ht\@marbox \z@ |
| 660 |
\global \dp\@marbox \z@ |
| 661 |
\kern -\@pagedp |
| 662 |
\nointerlineskip |
| 663 |
\hb@xt@\columnwidth |
| 664 |
{\ifnum \@tempcnta >\z@ |
| 665 |
\hskip\columnwidth \hskip\marginparsep |
| 666 |
\else |
| 667 |
\hskip -\marginparsep \hskip -\marginparwidth |
| 668 |
\fi |
| 669 |
\box\@marbox \hss}% |
| 670 |
\nointerlineskip |
| 671 |
\hbox{\vrule \@height\z@ \@width\z@ \@depth\@pagedp}} |
| 672 |
\else |
| 673 |
% \end{macrocode} |
| 674 |
% It didn't match. Inform the user of what is to come. |
| 675 |
% \begin{macrocode} |
| 676 |
\typeout{Expect a lot of ``Marginpar moved'' warnings.} |
| 677 |
\fi |
| 678 |
\let\@tempa=\relax |
| 679 |
% \end{macrocode} |
| 680 |
% |
| 681 |
% |
| 682 |
% \section{Things not to index} |
| 683 |
% |
| 684 |
% \begin{macrocode} |
| 685 |
\DoNotIndex{\def,\let,\else,\fi,\then,\x_cs,\x_relax} |
| 686 |
\DoNotIndex{\csname,\endcsname,\string,\the,\expandafter,\noexpand} |
| 687 |
\DoNotIndexBy{@@}\DoNotIndexBy{@}\DoNotIndexBy{_}\DoNotIndexBy{FD@} |
| 688 |
% \end{macrocode} |
| 689 |
% |
| 690 |
\endinput |
| 691 |
|