summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/base/ltcounts.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/base/ltcounts.dtx')
-rw-r--r--Master/texmf-dist/source/latex/base/ltcounts.dtx434
1 files changed, 434 insertions, 0 deletions
diff --git a/Master/texmf-dist/source/latex/base/ltcounts.dtx b/Master/texmf-dist/source/latex/base/ltcounts.dtx
new file mode 100644
index 00000000000..23acbc10dee
--- /dev/null
+++ b/Master/texmf-dist/source/latex/base/ltcounts.dtx
@@ -0,0 +1,434 @@
+% \iffalse meta-comment
+%
+% Copyright 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004
+% The LaTeX3 Project and any individual authors listed elsewhere
+% 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.3
+% 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.3 or later is part of all distributions of LaTeX
+% version 2003/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
+% extension .ins) which are part of the distribution.
+%
+% \fi
+%
+% \iffalse
+%%% From File: ltcounts.dtx
+%
+%<*driver>
+% \fi
+\ProvidesFile{ltcounts.dtx}
+ [1998/05/16 v1.1g LaTeX Kernel (Counters)]
+% \iffalse
+\documentclass{ltxdoc}
+\GetFileInfo{ltcounts.dtx}
+\title{\filename}
+\date{\filedate}
+ \author{%
+ Johannes Braams\and
+ David Carlisle\and
+ Alan Jeffrey\and
+ Leslie Lamport\and
+ Frank Mittelbach\and
+ Chris Rowley\and
+ Rainer Sch\"opf}
+
+\begin{document}
+\maketitle
+ \DocInput{\filename}
+\end{document}
+%</driver>
+% \fi
+%
+% \CheckSum{256}
+%
+% \changes{v1.0c}{1994/03/29}
+% {Create file from parts of ltmiscen and ltherest.}
+% \changes{v1.1a}{1994/05/19}{Extracted file from ltcntlen.}
+% \changes{v1.1d}{1996/04/23}{Documentation improvements}
+%
+% \section{Counters and Lengths}
+% Commands for defining and using counters. This file defines:
+%
+% \DescribeMacro{\newcounter}
+% To define a new counter.
+%
+% \DescribeMacro{\setcounter}
+% To set the value of counters.
+%
+% \DescribeMacro{\addtocounter}
+% Increase the counter |#1| by the number |#2|.
+%
+% \DescribeMacro{\stepcounter}
+% Increase a counter by one.
+%
+% \DescribeMacro{\refstepcounter}
+% Increase a counter by one, also setting the value used by |\label|.
+%
+%
+% \DescribeMacro{\value}
+% For accessing the value of the counter as a \TeX\ number (as opposed
+% to |\the|\meta{counter} which expands to the \emph{printed}
+% representation of \meta{counter})
+%
+% \DescribeMacro\arabic
+% |\arabic|\marg{counter}: 1, 2, 3, \ldots
+%
+% \DescribeMacro\roman
+% |\roman|\marg{counter}: i, ii, iii, \ldots
+%
+% \DescribeMacro\Roman
+% |\Roman|\marg{counter}: I, II, III, \ldots
+%
+% \DescribeMacro\alph
+% |\alph|\marg{counter}: a, b, c, \ldots
+%
+% \DescribeMacro\Alph
+% |\Alph|\marg{counter}: A, B, C, \ldots
+%
+% \DescribeMacro\fnsymbol
+% |\fnsymbol|\marg{counter}: $*$, $\dagger$, $\ddagger$, \ldots
+%
+%
+% \StopEventually{}
+%
+% \begin{macrocode}
+%<*2ekernel>
+% \end{macrocode}
+%
+% \subsection{Environment Counter Macros}
+%
+% An environment foo has an associated counter defined by the
+% following control sequences:
+%
+% \begin{tabular}{lp{.75\textwidth}}
+% |\c@foo| & Contains the counter's numerical value.
+% It is defined by |\newcount\foocounter|.\\
+% |\thefoo| & Macro that expands to the printed value of |\foocounter|.
+% For example, if sections are numbered within chapters,
+% and section headings look like
+%
+% Section II-3. The Nature of Counters
+%
+% then |\thesection| might be defined by:\newline
+% |\def\thesection|\newline\hspace*{2em}
+% |{\@Roman{\c@chapter}-\@arabic{\c@section}}|\\
+%
+% |\p@foo| & Macro that expands to a printed `reference prefix' of
+% counter foo. Any |\ref| to a value created by counter
+% foo will produce the expansion of |\p@foo\thefoo| when
+% the |\label| command is executed. See file \texttt{ltxref.dtx}
+% for an extension of this mechanism.\\
+% |\cl@foo| & List of counters to be reset when foo stepped.
+% Has format
+% |\@elt{countera}\@elt{counterb}\@elt{counterc}|.
+% \end{tabular}
+%
+% \textbf{NOTE:}\\
+% |\thefoo| and |\p@foo| \emph{must} be defined in such a way that
+% |\edef\bar{\thefoo}| or |\edef\bar{\p@foo}|
+% defines |\bar| so that it will evaluate to the counter value at the
+% time of the |\edef|, even after |\foocounter| and any other counters
+% have been changed. This will happen if you use the standard commands
+% |\@arabic|, |\@Roman|, etc.
+%
+%
+% The following commands are used to define and modify counters.
+%
+% |\refstepcounter|\marg{foo}\\
+% Same as |\stepcounter|, but it also defines
+% |\@currentreference| so that a subsequent
+% |\label|\marg{bar} command causes |\ref|\marg{bar} to
+% generate the current value of counter \meta{foo}.
+%
+% |\@definecounter|\marg{foo}\\
+% Initializes counter \marg{foo} (with empty reset list), defines
+% |\p@foo| and |\thefoo| to be null. Also adds \meta{foo}
+% to |\cl@@ckpt| --
+% the reset list of a dummy counter |@ckpt| used for taking
+% checkpoints for the |\include| system.
+%
+% |\@addtoreset|\marg{foo}\marg{bar} :
+% Adds counter \meta{foo} to the list of counters
+% |\cl@bar| to be reset when counter \meta{bar} is stepped.
+%
+%
+% \begin{macro}{\setcounter}
+% \changes{v1.0d}{1994/04/09}
+% {\cs{@nocnterr} now has counter name argument}
+% \changes{v1.0e}{1994/04/17}
+% {Use \cs{@nocounterr} instead of \cs{@nocnterr}}
+% |\setcounter|\marg{foo}\marg{val} :
+% Globally sets |\foocounter| equal to \meta{val}.
+% \begin{macrocode}
+\def\setcounter#1#2{%
+ \@ifundefined{c@#1}%
+ {\@nocounterr{#1}}%
+ {\global\csname c@#1\endcsname#2\relax}}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\addtocounter}
+% \changes{v1.0d}{1994/04/09}
+% {\cs{@nocnterr} now has counter name argument}
+% \changes{v1.0e}{1994/04/17}
+% {Use \cs{@nocounterr} instead of \cs{@nocnterr}}
+% |\addtocounter|\marg{foo}\marg{val}
+% Globally increments |\foocounter| by \meta{val}.
+% \begin{macrocode}
+\def\addtocounter#1#2{%
+ \@ifundefined{c@#1}%
+ {\@nocounterr{#1}}%
+ {\global\advance\csname c@#1\endcsname #2\relax}}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\newcounter}
+% |\newcounter|\marg{newctr}\oarg{oldctr}
+% Defines \meta{newctr} to be a counter, which is reset when counter
+% \meta{oldctr} is stepped. If \meta{newctr} already defined
+% produces
+% `|c@newctr already defined|' error.
+% \begin{macrocode}
+\def\newcounter#1{%
+ \expandafter\@ifdefinable \csname c@#1\endcsname
+ {\@definecounter{#1}}%
+ \@ifnextchar[{\@newctr{#1}}{}}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\value}
+% |\value|\marg{ctr}
+% produces the value of counter \meta{ctr}, for use with
+% a |\setcounter| or |\addtocounter| command.
+% \begin{macrocode}
+\def\value#1{\csname c@#1\endcsname}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\@newctr}
+% \changes{v1.0d}{1994/04/09}
+% {\cs{@nocnterr} now has counter name argument}
+% \changes{v1.0e}{1994/04/17}
+% {Use \cs{@nocounterr} instead of \cs{@nocnterr}}
+% \begin{macrocode}
+\def\@newctr#1[#2]{%
+ \@ifundefined{c@#2}{\@nocounterr{#2}}{\@addtoreset{#1}{#2}}}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\stepcounter}
+% \changes{LaTeX209}{1992/11/23}{Replaced \{\} in \cs{stepcounter} by
+% \cs{begingroup} \cs{endgroup} to avoid adding an empty ord in
+% math mode}
+% \changes{v1.0d}{1994/04/09}
+% {Use \cs{addtocounter} to have name checked}
+% |\stepcounter|{foo}
+% Globally increments counter |\c@FOO|
+% and resets all subsidiary counters.
+% \begin{macrocode}
+\def\stepcounter#1{%
+ \addtocounter{#1}\@ne
+ \begingroup
+ \let\@elt\@stpelt
+ \csname cl@#1\endcsname
+ \endgroup}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\@stpelt}
+% \begin{macrocode}
+\def\@stpelt#1{\global\csname c@#1\endcsname \z@}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\cl@@ckpt}
+% \begin{macrocode}
+\def\cl@@ckpt{\@elt{page}}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\@definecounter}
+% \changes{v1.1b}{1995/05/20}{Streamlined code}
+% \changes{v1.1c}{1995/05/20}{And do it right}
+%
+% \begin{macrocode}
+\def\@definecounter#1{\expandafter\newcount\csname c@#1\endcsname
+ \setcounter{#1}\z@
+ \global\expandafter\let\csname cl@#1\endcsname\@empty
+ \@addtoreset{#1}{@ckpt}%
+ \global\expandafter\let\csname p@#1\endcsname\@empty
+ \expandafter
+ \gdef\csname the#1\expandafter\endcsname\expandafter
+ {\expandafter\@arabic\csname c@#1\endcsname}}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\@addtoreset}
+% \begin{macrocode}
+\def\@addtoreset#1#2{\expandafter\@cons\csname cl@#2\endcsname {{#1}}}
+% \end{macrocode}
+% \end{macro}
+%
+%
+% Numbering commands for definitions of |\theCOUNTER| and |\list|
+% arguments.
+%
+% All commands can now be used in text and math mode.
+%
+% \begin{macro}{\arabic}
+% Representation of\meta{counter} as arabic numerals.
+% Changed 29 Apr 86 to make it print the obvious thing
+% it COUNTER not positive.
+% \begin{macrocode}
+\def\arabic#1{\expandafter\@arabic\csname c@#1\endcsname}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\roman}
+% Representation of \meta{counter} as lower-case
+% Roman numerals.
+% \begin{macrocode}
+\def\roman#1{\expandafter\@roman\csname c@#1\endcsname}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\Roman}
+% Representation of \meta{counter} as upper-case
+% Roman numerals.
+% \begin{macrocode}
+\def\Roman#1{\expandafter\@Roman\csname c@#1\endcsname}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\alph}
+% Representation of \meta{counter} as a lower-case
+% letter: 1 = a, 2 = b, etc.
+% \begin{macrocode}
+\def\alph#1{\expandafter\@alph\csname c@#1\endcsname}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\Alph}
+% Representation of \meta{counter} as an upper-case
+% letter: 1 = A, 2 = B, etc.
+% \begin{macrocode}
+\def\Alph#1{\expandafter\@Alph\csname c@#1\endcsname}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\fnsymbol}
+% \changes{v1.1b}{1995/05/20}{Streamlined code}
+% \changes{v1.1e}{1997/03/21}
+% {Use \cs{mathsection} and \cs{mathparagraph}. latex/2445}
+%
+% Representation of \meta{COUNTER} as a footnote
+% symbol: 1 = $*$, 2 = $\dagger$, etc.
+% \begin{macrocode}
+\def\fnsymbol#1{\expandafter\@fnsymbol\csname c@#1\endcsname}
+% \end{macrocode}
+% \end{macro}
+%
+% \changes{v1.0f}{1994/05/13}{Removed \cs{@ialph}}
+% \changes{v1.0f}{1994/05/13}{Removed \cs{@Ialph}}
+%
+% \begin{macro}{\@arabic}
+% |\@arabic\FOOcounter|
+% Representation of |\FOOcounter| as arabic numerals.
+% \begin{macrocode}
+\def\@arabic#1{\number #1} %% changed 29 Apr 86
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\@roman}
+% |\@roman\FOOcounter|
+% Representation of |\FOOcounter| as lower-case
+% Roman numerals.
+% \begin{macrocode}
+\def\@roman#1{\romannumeral #1}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\@Roman}
+% |\@Roman\FOOcounter|
+% Representation of |\FOOcounter| as upper-case
+% Roman numerals.
+
+% \changes{v1.1f}{1997/10/06}{Change \cs{@Roman} to be fully
+% expandable, so that the result is written properly to files.}
+% \begin{macrocode}
+\def\@Roman#1{\expandafter\@slowromancap\romannumeral #1@}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\@slowromancap}
+% \changes{v1.1f}{1997/10/06}{Macro added.}
+% Fully expandable macro to change a roman number to uppercase.
+% \begin{macrocode}
+\def\@slowromancap#1{\ifx @#1% then terminate
+ \else
+ \if i#1I\else\if v#1V\else\if x#1X\else\if l#1L\else\if
+ c#1C\else\if d#1D\else \if m#1M\else#1\fi\fi\fi\fi\fi\fi\fi
+ \expandafter\@slowromancap
+ \fi
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\@alph}
+% |\@alph\FOOcounter|
+% Representation of |\FOOcounter| as a lower-case
+% letter: 1 = a, 2 = b, etc.
+% \begin{macrocode}
+\def\@alph#1{%
+ \ifcase#1\or a\or b\or c\or d\or e\or f\or g\or h\or i\or j\or
+ k\or l\or m\or n\or o\or p\or q\or r\or s\or t\or u\or v\or w\or x\or
+ y\or z\else\@ctrerr\fi}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\@Alph}
+% |\@Alph\FOOcounter|
+% Representation of |\FOOcounter| as an upper-case
+% letter: 1 = A, 2 = B, etc.
+% \begin{macrocode}
+\def\@Alph#1{%
+ \ifcase#1\or A\or B\or C\or D\or E\or F\or G\or H\or I\or J\or
+ K\or L\or M\or N\or O\or P\or Q\or R\or S\or T\or U\or V\or W\or X\or
+ Y\or Z\else\@ctrerr\fi}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\@fnsymbol}
+% \changes{v1.1b}{1995/05/20}{Allowing both text and math}
+% Typesetting old fashioned footnote symbols.
+% This can be done both in text or math mode now.
+% \begin{macrocode}
+\def\@fnsymbol#1{\ensuremath{\ifcase#1\or *\or \dagger\or \ddagger\or
+ \mathsection\or \mathparagraph\or \|\or **\or \dagger\dagger
+ \or \ddagger\ddagger \else\@ctrerr\fi}}
+% \end{macrocode}
+% \end{macro}
+%
+%
+% \begin{macrocode}
+%</2ekernel>
+% \end{macrocode}
+%
+% \Finale
+%