1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
|
% \changes{v1.01}{1995/05/02}{Date added to \cs{NeedsTeXFormat}}
% \iffalse
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
%<package>\ProvidesPackage{prelim2e}
%<package> [2001/02/17 v1.23 prelim2e Package (MS)]
%
%<*driver>
\ProvidesFile{prelim2e.drv}
[1999/06/08 v1.22 Driver for prelim2e Package (MS)]
\documentclass{ltxdoc}
\usepackage{url}
\usepackage[toc]{multitoc}
\usepackage[scrtime]{prelim2e}
\GetFileInfo{prelim2e.sty}
\setcounter{IndexColumns}{2}
\EnableCrossrefs
%%\DisableCrossrefs% Say \DisableCrossrefs if index is ready
\CodelineIndex % Index code by line number
\OnlyDescription % comment out for implementation details
%%\OldMakeIndex % use if your MakeIndex is pre-v2.9
\setcounter{IndexColumns}{2}
\setlength{\IndexMin}{40ex}
\setlength{\columnseprule}{.4pt}
\begin{document}
\DocInput{prelim2e.dtx}
\end{document}
%</driver>
%
% Copyright (C) [1995..2001] by Martin Schr\"oder. All rights reserved.
%
% This program may be redistributed and/or modified under the terms
% of the LaTeX Project Public License, either version 1.0 of this
% license, or (at your option) any later version.
% The latest version of this license is in
% CTAN:macros/latex/base/lppl.txt.
%
% Happy users are requested to send me a postcard. :-)
%
% For error reports in case of UNCHANGED versions see prelim2e.ins
%
% \fi
%
% \CheckSum{125}
%
%% \CharacterTable
%% {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
%% 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 \" Hash (number) \#
%% Dollar \$ Percent \% Ampersand \&
%% Acute accent \' Left paren \( Right paren \)
%% Asterisk \* Plus \+ Comma \,
%% Minus \- Point \. Solidus \/
%% Colon \: Semicolon \; Less than \<
%% Equals \= Greater than \> Question mark \?
%% Commercial at \@ Left bracket \[ Backslash \\
%% Right bracket \] Circumflex \^ Underscore \_
%% Grave accent \` Left brace \{ Vertical bar \|
%% Right brace \} Tilde \~}
%%
%% \iffalse meta-comment
%% ===================================================================
%% @LaTeX-package-file{
%% author = {Martin Schr\"oder},
%% version = "1.23",
%% date = "17 February 2001",
%% filename = "prelim2e.sty",
%% address = {Martin Schr\"oder
%% Cr\"usemannallee 3
%% 28213 Bremen
%% Germany},
%% telephone = "+49-421-2239425",
%% email = "martin@oneiros.de",
%% pgp-Key = "2048 bit / KeyID 292814E5",
%% pgp-fingerprint = "7E86 6EC8 97FA 2995 82C3 FEA5 2719 090E",
% checksum = "63323 610 2225 20370",
% codetable = "ISO/ASCII",
% keywords = "LaTeX2e, preliminary versions, versions",
% dependences = "everyshi, scrtime",
% supported = "yes",
%% docstring = "LaTeX package which allows the marking of
%% preliminary versions of a document.
%
% The checksum field above contains a CRC-16
% checksum as the first value, followed by
% the equivalent of the standard UNIX wc
% (word count) utility output of lines,
% words, and characters. This is produced
% by Robert Solovay's checksum utility."
%% }
%% ===================================================================
%% \fi
%
% \renewcommand{\PrelimWords}{^^A
% \package{prelim2e} package --
% Version \fileversion{} --
% Documentation \LaTeX{}ed^^A
% }
%
% \changes{v1.00}{1995/01/26}{New}
% \changes{v1.21}{1998/08/09}{Documentation improved}
% \changes{v1.22}{1999/06/08}{Moved to LPPL}
%
% \newcommand*{\option}[1]{\textnormal{\sffamily#1}}
% \newcommand*{\package}[1]{\textnormal{\sffamily#1}}
% \newcommand*{\NEWfeature}[1]{%
% \hskip 1sp \marginpar{\small\sffamily\raggedright
% New feature\\#1}}
% \newcommand*{\NEWdescription}[1]{%
% \hskip 1sp \marginpar{\small\sffamily\raggedright
% New description\\#1}}
%
% \pagestyle{headings}
%
%
% ^^A -----------------------------
%
% \title{\unskip
% The \package{prelim2e} package^^A
% \thanks{^^A
% The version number of this file is \fileversion,
% last revised \filedate.}^^A
% }
% \author{Martin Schr\"oder\\[0.5ex]
% \normalsize Cr\"usemannallee 3\\
% \normalsize 28213 Bremen\\
% \normalsize Germany\\
% \normalsize martin@oneiros.de\\
% \scriptsize \texttt{PGP-Key: 2048 bit / KeyID 292814E5}\\[-0.5em]
% \scriptsize \texttt{7E86 6EC8 97FA 2995~~82C3 FEA5 2719 090E}}
% \date{\filedate}
% \maketitle
%
% ^^A -----------------------------
%
%
% \begin{abstract}
% This package allows the marking of (preliminary) versions of a
% document on the output.
% \end{abstract}
%
% ^^A -----------------------------
%
% \tableofcontents
%
% ^^A -----------------------------
%
% \section{Introduction}
% ^^A
% This package allows the marking of (preliminary) versions of a
% document.
% This is done using the command \cs{PrelimText}, whose expansion
% is added \emph{below the footer} of every page of a document (look
% at the bottom of this page for an example).
%
% ^^A -----------------------------
%
% \section{Usage}
% ^^A
% Simply using this package via
% \mbox{\cs{usepackage\{}\package{prelim2e}\texttt{\}}} produces a
% text in the form of ``Preliminary version -- \today''.
%
% \DescribeMacro{\PrelimText}
% \DescribeMacro{\PrelimWords}
% The text is produced by the commands \cs{PrelimText} and
% \cs{PrelimWords}, which can be changed via \cs{renewcommand} or by
% using options at the \cs{usepackage} command (see
% section~\ref{sec:options}).
%
% The footer for this documentation was produced by changing
% \cs{PrelimWords} to
% \begin{quote}
%\begin{verbatim}
%\renewcommand{\PrelimWords}{%
% \textsf{prelim2e} package --
% Version \fileversion{} --
% Documentation \LaTeX{}ed%
% }
%\end{verbatim}
% \end{quote}
%
%
% ^^A -----------------------------
%
% \section{Options}
% \label{sec:options}
% ^^A
% The package has the following options:
% \nopagebreak
% \begin{description}
% \item[\normalfont\option{danish}]
% \changes{v1.23}{2001/02/17}{\option{danish} option added}
% \NEWfeature{2001/02/17}
% This sets the text to ``Forel\o{}big version''.
% It does not use the \package{babel} package.
% \item[\normalfont\option{draft}]
% If this option is used a text appears below the normal
% pagebody.
% It is the default.
% \item[\normalfont\option{final}]
% If this option is used \package{prelim2e} produces no text.
% \item[\normalfont\option{english}]
% This sets the text to ``Preliminary version''.
% It is the default.
% \item[\normalfont\option{french}]
% \changes{v1.20}{1997/05/12}{\option{french} option added}
% \NEWfeature{1997/05/12}
% This sets the text to ``Version pr\'eliminaire''.
% It does not use the \package{french} or \package{babel} package.
% \item[\normalfont\option{german}]
% This sets the text to ``Vorl\"aufige Version''.
% It does not use the \package{german} or \package{babel} package.
% \item[\normalfont\option{italian}]
% \changes{v1.23}{2001/02/17}{\option{italian} option added}
% \NEWfeature{2001/02/17}
% This sets the text to ``Versione preliminare''.
% It does not use the \package{babel} package.
% \item[\normalfont\option{time}]
% \changes{v1.10}{1996/01/01}{\option{time} option added}
% \NEWdescription{1997/05/12}
% This adds the time at the beginning of the current \LaTeX{}
% to the text.
% The time is produced using the \cs{thistime} command, which may
% be provided by the \package{scrtime} package\cite{package:scrtime}.
% If you don't use the \package{scrtime} package (e.\,g. by
% specifying the \option{scrtime} option), you must
% provide it yourself or by some other package.
% \item[\normalfont\option{scrtime}]
% \changes{v1.20}{1997/05/12}{\option{scrtime} option added}
% \NEWfeature{1997/05/12}
% This loads the \package{scrtime} package\cite{package:scrtime}
% (part of the KOMA-Script bundle), which provides the
% \cs{thistime} command used by the \option{time} option.
% The \option{scrtime} option implies the \option{time} option.
% \end{description}
% All other options are passed to the \package{scrtime} package if the
% \option{scrtime} option is selected.
%
%
% ^^A -----------------------------
%
% \section{Required packages}
% ^^A
% The package requires the following packages:
% \begin{description}
% \item[\normalfont\package{everyshi}\cite{package:everyshi}]
% It is used to implement the setting of the text below the normal
% pagebody.
% \item[\normalfont\package{scrtime}\cite{package:scrtime}]
% \changes{v1.10}{1996/01/01}{\package{scrtime} instead of
% \package{printtim}}
% \NEWdescription{1997/05/12}
% It is used to typeset the current time and is needed if the
% \option{scrtime} option is selected.
% \end{description}
%
%
% ^^A -----------------------------
%
% \section{Putting more things at the bottom}
% ^^A
% Another package you might like to use with \package{prelim2e} is
% \package{vrsion}\cite{package:vrsion}.
% This allows the definition and maintenance of a version number like
% 3.14159 \emph{within \LaTeX}, which can be put at the bottom of every
% page using \package{prelime2e}.
%
%
% ^^A -----------------------------
%
% \StopEventually{^^A
%
%
% ^^A -----------------------------
%
% \section{Acknowledgements}
% ^^A
% The idea of this package is based on
% \texttt{prelim.sty}\cite{package:prelim} for \LaTeX2.09 by Robert
% Tolksdorf (\texttt{tolk@cs.tu-berlin.de}).
% It provides nearly the same functionality as \package{prelim2e}, but
% in a very dirty way: it uses a modified output routine and does not
% work with \LaTeXe.
%
% The time functionality now uses the \package{scrtime} package by
% Markus Kohm (\texttt{markus.kohm@gmx.de}).
%
% Rowland Bartlett (\texttt{R.BARTLETT@liverpool-john-moores.ac.uk})
% brought forth the idea of separating the \option{time} option and the
% \package{scrtime} package;
% Daniel Courjon (\texttt{dcourjon@utinam.univ-fcomte.fr}) provided
% the text for the \option{french} option,
% Arne J\o{}rgensen (\texttt{arne.jorgensen@tug.dk})
% provided the text for the \option{danish} option,
% and Davide Giovanni Maria Salvetti (\texttt{salve@debian.org})
% and Riccardo Murri (\texttt{murri@phc.unipi.it})
% both provided the text for the \option{italian} option,
%
% As usual Rebecca Stiels improved the quality of this documentation.
%
%
% ^^A -----------------------------
%
% \begin{thebibliography}{1}
% \raggedright
% \bibitem{package:prelim}
% Mats Dahlgren.
% \newblock \package{vrsion} -- a \LaTeX{} Macro for version
% Numbering of Files.
% \newblock \url{CTAN: tex-archive/macros/latex/contrib/supported/vrsion/vrsion.dtx}.
% \newblock \LaTeXe{} package.
% \bibitem{package:scrtime}
% Markus Kohm.
% \newblock The \package{KOMA}-timedate-bundle.
% \newblock \url{CTAN: tex-archive/macros/latex/contrib/supported/koma-script/scrtime.dtx}.
% \newblock \LaTeXe{} package.
% \bibitem{package:everyshi}
% Martin Schr\"oder.
% \newblock The \package{everyshi} package.
% \newblock \url{CTAN: tex-archive/macros/latex/contrib/supported/ms/everyshi.dtx}.
% \newblock \LaTeXe{} package.
% \bibitem{package:vrsion}
% Robert Tolksdorf.
% \newblock Kennzeichnung von Vorversionen eines Dokuments.
% \newblock \url{CTAN: tex-archive/macros/latex209/contrib/prelim/}.
% \newblock \LaTeX2.09 package.
% \end{thebibliography}
%
% }
%
%
% ^^A -----------------------------
%
% \section{The implementation}
%
% \begin{macrocode}
%<*package>
% \end{macrocode}
%
%
% ^^A -----------------------------
%
% \subsection{Initial Code}
% ^^A
% \begin{macro}{\if@prelim@draft}
% \cs{if@prelim@draft} is used to flag the use of the \option{draft}
% or \option{final} option.
% \begin{macrocode}
\newif\if@prelim@draft
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\if@prelim@time}
% \changes{v1.10}{1996/01/01}{new}
% \cs{if@prelim@time} is used to flag the use of the \option{time}
% option.
% \begin{macrocode}
\newif\if@prelim@time
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\if@prelim@scrtime}
% \changes{v1.20}{1997/05/12}{new}
% \cs{if@prelim@scrtime} is used to flag the use of the \option{scrtime}
% option.
% \begin{macrocode}
\newif\if@prelim@scrtime
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\PrelimWords}
% \cs{PrelimWords} holds the language-dependend text used in
% \cs{PrelimText}
% \begin{macrocode}
\newcommand{\PrelimWords}{}
% \end{macrocode}
% \end{macro}
%
%
% ^^A -----------------------------
%
% \subsection{Declaration of options}
%
% ^^A -----------------------------
%
%
% \subsubsection{\option{draft} option}
% ^^A
% The \option{draft} and \option{final} option control the behavior
% of \package{prelim2e}: Only if \option{final} is used in
% \cs{documentclass} or
% \mbox{\cs{usepackage\{}\package{prelim2e}\texttt{\}}} text is
% produced.
% \begin{macrocode}
\DeclareOption{draft}{\@prelim@drafttrue}
\DeclareOption{final}{\@prelim@draftfalse}
% \end{macrocode}
%
%
% ^^A -----------------------------
%
% \subsubsection{Language options}
% ^^A
% \option{danish}, \option{english}, \option{french}, \option{german} and
% \option{italian} control the content of \cs{PrelimWords}.
% \changes{v1.20}{1997/05/12}{\option{french} option added}
% \changes{v1.23}{2001/02/17}{\option{danish} option added}
% \changes{v1.23}{2001/02/17}{\option{italian} option added}
% \begin{macrocode}
\DeclareOption{danish}{%
\renewcommand{\PrelimWords}{Forel\o{}big version}}
\DeclareOption{english}{%
\renewcommand{\PrelimWords}{Preliminary version}}
\DeclareOption{french}{%
\renewcommand{\PrelimWords}{Version pr\'eliminaire}}
\DeclareOption{german}{%
\renewcommand{\PrelimWords}{Vorl\"aufige Version}}
\DeclareOption{italian}{%
\renewcommand{\PrelimWords}{Versione preliminare}}
% \end{macrocode}
%
%
% ^^A -----------------------------
%
% \subsubsection{Time options}
% ^^A
% \changes{v1.10}{1996/01/01}{\option{time} option added}
% \option{time} controls the output of the current time at
% \cs{PrelimWords}.
% \begin{macrocode}
\DeclareOption{time}{\@prelim@timetrue}
% \end{macrocode}
%
% \changes{v1.20}{1997/05/12}{\option{scrtime} option added}
% \option{scrtime} controls the loading of the \package{scrtime}
% package.
% It implies \option{time}.
% \begin{macrocode}
\DeclareOption{scrtime}{\@prelim@scrtimetrue\@prelim@timetrue}
% \end{macrocode}
%
%
% ^^A -----------------------------
%
% \subsubsection{Other options}
% ^^A
% \changes{v1.20}{1997/05/12}{check \cs{if@prelim@scrtime}}
% \changes{v1.10}{1996/01/01}{\cs{DeclareOption*} added}
% All unused options are passed to the \package{scrtime} package if
% the \option{scrtime} option is selected.
% \begin{macrocode}
\DeclareOption*{%
\if@prelim@scrtime
\PassOptionsToPackage{\CurrentOption}{scrtime}%
\fi
}
% \end{macrocode}
%
%
% ^^A -----------------------------
%
% \subsection{Executing options}
% ^^A
% The default options are \option{draft} and \option{english}.
% \begin{macrocode}
\ExecuteOptions{draft,english}
\ProcessOptions\relax
% \end{macrocode}
%
%
% ^^A -----------------------------
%
% \subsection{Loading packages}
% ^^A
% \changes{v1.20}{1997/05/12}{check \cs{if@prelim@scrtime}}
% We need the \package{everyshi} package---and \package{scrtime}, if the
% \option{scrtime} option is specified.
% \begin{macrocode}
\RequirePackage{everyshi}[1995/01/25]
\if@prelim@scrtime
\RequirePackage{scrtime}
\fi
% \end{macrocode}
%
%
% ^^A -----------------------------
%
% \subsection{Producing the text}
% ^^A
% \begin{macro}{\PrelimText}
% \changes{v1.10}{1996/01/01}{\cs{thistime} instead of \cs{PrintTime}}
% \cs{PrelimText} produces the text which is put below the page.
% It can be changed via \cs{renewcommand}.
% The style of the text is controlled by \cs{PrelimTextStyle}.
% We first have to reset the style and size, otherwise the settings in
% effect at the point of text where \cs{ouput} is called would be used.
% \begin{macrocode}
\newcommand{\PrelimText}{%
\textnormal{%
\footnotesize%
\PrelimTextStyle%
\PrelimWords{} -- \today
\if@prelim@time
\ -- \thistime
\fi
}%
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\PrelimTextStyle}
% \cs{PrelimTextStyle} controls the style of the text produced by
% \cs{PrelimText}.
% It's default is empty.
% \begin{macrocode}
\newcommand{\PrelimTextStyle}{}
% \end{macrocode}
% \end{macro}
%
%
% ^^A -----------------------------
%
% \subsection{Putting the text below the page}
% ^^A
% We put the text below the page via \cs{EveryShipout} provided by
% the \package{everyshi} package.
% This is done by \cs{@Prelim@EveryShipout}.
%
% \begin{macro}{\@Prelim@EveryShipout}
% \changes{v1.10}{1996/01/01}{\cs{hbox to}$\rightarrow$\cs{hb@xt@}}
% \cs{@Prelim@EveryShipout} puts the text produced by \cs{PrelimText}
% below the page.
% To do this we modify \cs{box255}: We append a \cs{vbox} with height
% and depth of 0pt and the width of \cs{box255} which contains a
% \cs{hbox} with the width of \cs{box255} in which \cs{PrelimText}
% is centered.
% \begin{macrocode}
\newcommand{\@Prelim@EveryShipout}{
\bgroup
% \end{macrocode}
% First we save the dimensions of \cs{box255}: height, width and depth;
% and calculate the total height of \cs{box255}.
% \begin{macrocode}
\dimen\z@=\wd\@cclv
\dimen\@ne=\ht\@cclv
\dimen\tw@=\dp\@cclv
\dimen\thr@@=\dimen1
\advance\dimen\thr@@ by \dimen\tw@
% \end{macrocode}
% Then we set \cs{box255}:
% A \cs{vbox} to the total height of \cs{box255}.
% In this a \cs{hbox} to the width of \cs{box255} is included, in which
% \cs{box255} is set.
% \begin{macrocode}
\global\setbox\@cclv\vbox to \dimen\thr@@{%
\hb@xt@\dimen\z@{%
\box\@cclv%
\hss%
}%
% \end{macrocode}
% To this we append the text produced by \cs{PrelimText}.
% It is put in a \cs{vbox} to 0pt in which a \cs{hbox} to the width of
% \cs{box255} is included, in which \cs{PrelimText} is set.
% We have to reset \cs{protect} because it is set to \cs{noexpand} by
% the output routine.
% \begin{macrocode}
\vbox to \z@{%
\hb@xt@\dimen\z@{%
\let\protect\relax
\hfill\PrelimText\hfill%
}%
\vss%
}%
\vss%
}%
% \end{macrocode}
% Finally we set the dimensions of \cs{box255} to the values they had
% before \cs{@Prelim@EveryShipout}.
% \begin{macrocode}
\wd\@cclv=\dimen\z@
\ht\@cclv=\dimen\@ne
\dp\@cclv=\dimen\tw@
\egroup
}
% \end{macrocode}
% \end{macro}
%
%
% ^^A -----------------------------
%
% \subsection{Tieing \package{prelim2e} into the system}
% ^^A
% \cs{@Prelim@EveryShipout} is tied into the system via
% \cs{EveryShipout}.
% But only if the \option{draft} option is used.
% \begin{macrocode}
\if@prelim@draft
\EveryShipout{\@Prelim@EveryShipout}
\fi
% \end{macrocode}
%
% \begin{macrocode}
%</package>
% \end{macrocode}
%
%
% ^^A -----------------------------
%
% \Finale
|