summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/assoccnt
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2014-08-22 00:17:27 +0000
committerKarl Berry <karl@freefriends.org>2014-08-22 00:17:27 +0000
commit5d2b9323781e86126ca48a5d182002e28b387825 (patch)
tree847d5789d7bb02a4ea3fc7b868fe1c2ac3abf72e /Master/texmf-dist/doc/latex/assoccnt
parent38894824ac4e578bd39276dced905a30a0aece75 (diff)
assoccnt (21aug14)
git-svn-id: svn://tug.org/texlive/trunk@35003 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/assoccnt')
-rw-r--r--Master/texmf-dist/doc/latex/assoccnt/README20
-rw-r--r--Master/texmf-dist/doc/latex/assoccnt/assoccnt_example.pdfbin97388 -> 49574 bytes
-rw-r--r--Master/texmf-dist/doc/latex/assoccnt/assoccnt_example.tex88
-rw-r--r--Master/texmf-dist/doc/latex/assoccnt/assoccntdoc.pdfbin171849 -> 198651 bytes
-rw-r--r--Master/texmf-dist/doc/latex/assoccnt/assoccntdoc.tex379
5 files changed, 405 insertions, 82 deletions
diff --git a/Master/texmf-dist/doc/latex/assoccnt/README b/Master/texmf-dist/doc/latex/assoccnt/README
index dc2c1117648..28aa89f3723 100644
--- a/Master/texmf-dist/doc/latex/assoccnt/README
+++ b/Master/texmf-dist/doc/latex/assoccnt/README
@@ -1,4 +1,4 @@
-%% LaTeX package assoccnt - version 0.2 (2014/08/13)
+%% LaTeX package assoccnt - version 0.3 (2014/08/21)
%%
%% -------------------------------------------------------------------------------------------
%% Copyright (c) 2014 by Dr. Christian Hupfer <christian dot hupfer at siebenfelsen dot de>
@@ -25,15 +25,13 @@ can be used without it too.
Further improvements will follow
-Directory listing:
-
- assoccntdoc.pdf 171849 08/13/14 18:50:12
- assoccntdoc.tex 9313 08/13/14 18:50:09
-assoccnt_example.pdf 97388 08/11/14 16:15:40
-assoccnt_example.tex 2687 08/11/14 14:01:03
- assoccnt.sty 4907 08/13/14 22:58:31
+This version provides some new routines for queries on the properties of counters
+whether they are drivers or associated counters and a better documentation.
-Installation:
-
-Unpack assoccnt.zip to your local Tex distribution tree.
+Directory listing:
+ assoccntdoc.pdf 198651 08/21/14 18:33:30
+ assoccntdoc.tex 20011 08/21/14 18:33:30
+assoccnt_example.pdf 49574 08/21/14 18:33:30
+assoccnt_example.tex 2681 08/21/14 18:33:25
+ assoccnt.sty 8774 08/21/14 18:33:25
diff --git a/Master/texmf-dist/doc/latex/assoccnt/assoccnt_example.pdf b/Master/texmf-dist/doc/latex/assoccnt/assoccnt_example.pdf
index af901043e68..1ba1f89e91e 100644
--- a/Master/texmf-dist/doc/latex/assoccnt/assoccnt_example.pdf
+++ b/Master/texmf-dist/doc/latex/assoccnt/assoccnt_example.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/assoccnt/assoccnt_example.tex b/Master/texmf-dist/doc/latex/assoccnt/assoccnt_example.tex
index af6e1ddd295..8d58612b262 100644
--- a/Master/texmf-dist/doc/latex/assoccnt/assoccnt_example.tex
+++ b/Master/texmf-dist/doc/latex/assoccnt/assoccnt_example.tex
@@ -1,12 +1,27 @@
-\documentclass{book}%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+%
+% $Date: 2014-08-21 18:12:22 +0200 (Thu, 21 Aug 2014) $
+%
+% $Revision: 55 $
+%
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\documentclass[a4paper,12pt]{book}%
-\usepackage{totcount}%
-\usepackage{assoccnt}%
% Some packages only for output and dummy pages
\usepackage{blindtext}%
\usepackage{forloop}%
-\usepackage{xcolor}%
+\usepackage[svgnames]{xcolor}%
+\usepackage{tcolorbox}
+
+\usepackage{totcount}%
+\usepackage{assoccnt}%
+
+
+
+
\newcounter{loopcounter}%
@@ -16,11 +31,11 @@
& & & \tabularnewline
& \multicolumn{3}{c}{totcount page values} \tabularnewline
Page & \textcolor{red}{#1} & \textcolor{blue}{#2} & \textcolor{gray}{#3} \tabularnewline
-\thepage & \textcolor{red}{\number\totvalue{#1}} & \textcolor{blue}{\number\totvalue{#2}} & \textcolor{gray}{\number\totvalue{#3}} \tabularnewline
+\thepage & \textcolor{red}{\number\totvalue{#1}} & \textcolor{blue}{\number\value{#2}} & \textcolor{gray}{\number\value{#3}} \tabularnewline
& & & \tabularnewline
- & \multicolumn{3}{c}{totcount section values} \tabularnewline
-Section & \textcolor{red}{#4} & \textcolor{blue}{#5} \tabularnewline
-\thesection & \textcolor{red}{\number\totvalue{#4}} & \textcolor{blue}{\number\totvalue{#5}} & \tabularnewline
+% & \multicolumn{3}{c}{totcount section values} \tabularnewline
+%Section & \textcolor{red}{#4} & \textcolor{blue}{#5} \tabularnewline
+%\thesection & \textcolor{red}{\number\totvalue{#4}} & \textcolor{blue}{\number\totvalue{#5}} & \tabularnewline
& & & \tabularnewline
\end{tabular}
\end{center}%
@@ -37,61 +52,56 @@ Section & \textcolor{red}{#4} & \textcolor{blue}{#5} \tabularnewline
}%
}%
+\newcounter{totalpages}
+\newtotcounter{totalsections}%
+\newcounter{anotherpagescounter}%
-
-\begin{document}
\regtotcounter{page} % Register a total value counter --> this will be the driver counter
-\newtotcounter{totalpages}% 1st driven counter
-\newtotcounter{anotherpagescounter}% 2nd driven counter
\newtotcounter{yetanotherpagescounter}% 3rd driven counter
-\regtotcounter{section}%
-\newtotcounter{totalsections}
+\DeclareAssociatedCounters{page}{totalpages,anotherpagescounter,totalpages}% Register the driver and the driven counters
+\DeclareAssociatedCounters{totalpages}{anotherpagescounter}% Register the driver and the driven counters
+\DeclareAssociatedCounters{section}{totalsections}%
+
-\DeclareAssociatedCounters{page}{totalpages,anotherpagescounter}% Register the driver and the driven counters
-\DeclareAssociatedCounters{section}{section,totalsections}% Register the driver and the driven counters for sections%
-\DeclareAssociatedCounters{page}{yetanotherpagescounter}% Register the driver and the driven counters
+
+\begin{document}
+\tableofcontents%
+\chapter{Chapter one}
-\pagenumbering{Roman}%
+\section{First}
-\chapter{The first chapter}%
+\QuickOutput{10}
-\section{My first section}%
-% Generate dummy output
-\QuickOutput{10}%
+\section{Query routines}%
+\IsAssociatedCounter{totalsections}{Yes, it's associated}{Nope, it's not associated}
-\section{My second section}%
+\IsAssociatedCounter{anotherpagescounter}{Yes, it's associated}{Nope, it's not associated}
-\QuickOutput{10}%
-\pagenumbering{arabic}% -> pagenumber reset to zero
+\AssociationStatistics%
-\appendix
+\IsDriverCounter{section}{Yes, it's a driver counter}{No, it does not have this feature}%
-\chapter{First Appendix chapter}%
+\ClearAssociatedCountersList{section}
-\section{My (only) appendix section}%
+\IsDriverCounter{section}{Yes, it's a driver counter}{No, it does not have this feature}%
-% Generate dummy output, again ;-)
-\QuickOutput{10}%
+\AssociationStatistics%
-% Clear the list of counters associated to page
-\ClearAssociatedCountersList{page}%
+Clearing the counters:
-% Not necessary, only for removing some counters from list
-\RemoveAssociatedCounters{page}{totalpages,anotherpagescounter}%
-% Readd the counter totalpages to the list --> in this context,
-% It acts, as if it has not been removed at all
-\DeclareAssociatedCounters{page}{totalpages}
+\ClearDriverCountersList
-\QuickOutput{20}%
+Show Statistics%
+\AssociationStatistics%
+\end{document}
-\end{document} \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/assoccnt/assoccntdoc.pdf b/Master/texmf-dist/doc/latex/assoccnt/assoccntdoc.pdf
index ce125147dcc..292b4b322a9 100644
--- a/Master/texmf-dist/doc/latex/assoccnt/assoccntdoc.pdf
+++ b/Master/texmf-dist/doc/latex/assoccnt/assoccntdoc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/assoccnt/assoccntdoc.tex b/Master/texmf-dist/doc/latex/assoccnt/assoccntdoc.tex
index d0a78675538..7d848fd1088 100644
--- a/Master/texmf-dist/doc/latex/assoccnt/assoccntdoc.tex
+++ b/Master/texmf-dist/doc/latex/assoccnt/assoccntdoc.tex
@@ -1,45 +1,52 @@
\documentclass[12pt,paper=a4]{ltxdoc}
\usepackage[lmargin=2cm,rmargin=2cm]{geometry}
-\usepackage{totcount}%
-\usepackage{assoccnt}%
\usepackage{blindtext}%
\usepackage{xcolor}
\usepackage{imakeidx}%
\usepackage{tcolorbox}
+
\usepackage{datetime}%
+
\usepackage{scrpage2}%
+
+\usepackage{enumitem}%
+
+
\tcbuselibrary{listings}%
\tcbuselibrary{documentation}%
\usepackage{array}%
+
+
\usepackage{amsmath}%
\usepackage{amsthm}%
+\usepackage{totcount}%
+\usepackage{assoccnt}%
+
+\usepackage{bookmark}%
+
\newcommand{\MarkupPackageName}[2][lightgray]{%
\colorbox{#1}{\textcolor{black}{#2}}%
}%
-\newcommand{\MarkupMacroName}[2][cyan]{%
-\colorbox{#1}{\(\backslash\)\textcolor{black}{#2}}%
-}%
-
\newcommand{\MarkupCounterName}[2][yellow]{%
\colorbox{#1}{\textcolor{black}{\texttt{#2}}}%
}%
-\def\packageversion{0.2}%
+
+\newtcolorbox{docCommandArgs}[1]{colbacktitle={blue},coltitle={white},title={Description of arguments of command \cs{#1}}}
+
+
+\def\packageversion{0.3}%
\makeindex
\newcommand{\PackageDocName}{assoccnt.sty}%
-\begin{document}
-\mmddyyyydate
-
-\setlength{\parindent}{0pt}
\newtotcounter{totalpages}%
\newtotcounter{anothertotalpages}%
@@ -50,7 +57,15 @@
\DeclareAssociatedCounters{proof}{totalproofs}
-\DeclareAssociatedCounters{page}{anothertotalpages,totalpages}
+\DeclareAssociatedCounters{page}{totalpages,anothertotalpages}%
+
+
+
+\begin{document}
+\mmddyyyydate
+
+
+\setlength{\parindent}{0pt}
\thispagestyle{empty}%
@@ -67,13 +82,16 @@ Version \packageversion \tabularnewline
\tabularnewline
\today \tabularnewline
\tabularnewline
-Author: Christian Hupfer\footnote{\makeatletter christian.hupfer@siebenfelsen.de}
+\addtocounter{footnote}{2}
+Author: Christian Hupfer\(^\mathrm{\fnsymbol{footnote}}\)% }{\makeatletter christian.hupfer@siebenfelsen.de}
\tabularnewline
\end{tabular}
\end{center}
-
\end{tcolorbox}
-
+\makeatletter
+\renewcommand{\thefootnote}{\fnsymbol{footnote}}%
+\footnotetext{christian.hupfer@siebenfelsen.de}%
+\makeatother
\end{center}
@@ -85,6 +103,8 @@ Author: Christian Hupfer\footnote{\makeatletter christian.hupfer@siebenfelsen.de
\pagestyle{scrheadings}%
\setheadsepline{2pt}[\color{blue}]
+\setcounter{footnote}{0}
+
\section{Introduction}
@@ -108,29 +128,54 @@ Internally, the associated counters are stored in one list per counter -- it is
+
+
+
\section{Documentation of Macros}
\tcbset{color command={blue}}
All macros have the general rule, that the driver counter is specified as 1st argument to the macro.
-\begin{docCommand}{DeclareAssociatedCounters}{\marg{driver counter}\marg{associated counters list}}
+\subsection{Associated counters commands}
+
+\begin{docCommand}{DeclareAssociatedCounters}{\oarg{options}\marg{driver counter}\marg{associated counters list}}
This command is the main macro of the package. It declares the counter names being specified in comma - separated - list (CSV) which should be stepped simultaneously when the driver counter is increased by \cs{stepcounter}.
+\begin{docCommandArgs}{DeclareAssociatedCounters}
-Note, that this command should be used as early as possible, i.e. in the preamble of the document, since the driven counters are not increased as long as they are not associated to the driver counter. On the hand, it is possible, to control the starting point of the association at any position in the body of the document, when the association should start later on.
+\begin{enumerate}[label={\textcolor{blue}{\#\arabic*}}]
+ \item \oarg{options}: As of \packageversion, the optional argument \oarg{options} is not used so far, but is reserved for later purposes.
+ \item \marg{driver counter}
+
+ Holds the name of the driver counter to which the list of counters should be associated
+\item \marg{associated counters list}
+
+ A comma separated list of counter names that should be associated to the driver counter
+\end{enumerate}
+\end{docCommandArgs}
+
+
+\begin{itemize}
+\item This command will be a preamble command in future
+\item This command should be used as early as possible, i.e. in the preamble of the document, since the driven counters are not increased as long as they are not associated to the driver counter. On the hand, it is possible, to control the starting point of the association at any position in the body of the document, when the association should start later on.
+\end{itemize}
+
+
+% Relax for documentation purposes
+\let\DeclareAssociatedCountersOrig\DeclareAssociatedCounters
+\renewcommand{\DeclareAssociatedCounters}[3][]{\relax}%
\begin{dispExample}
%%%% The association of anothertotalpages in this example just takes place here, so the stepping of the counter will start from here and providing a 'wrong' value.
%%%%
-\DeclareAssociatedCounters{page}{totalpages,anothertotalpages}
+\DeclareAssociatedCounters{page}{totalpages,anothertotalpages}%
This document has \number\totvalue{totalpages} (note: \number\totvalue{anothertotalpages}) pages.
\end{dispExample}
-
-
+\let\DeclareAssociatedCounters\DeclareAssociatedCountersOrig%
\begin{itemize}
\item Current version state:
\begin{itemize}
- \item No checking whether the 1st and 2nd arguments hold counter names is applied.
+ \item No checking whether the 2nd and 3rd arguments hold counter names is applied.
\item No check is done whether two (or more) associated counters are mutually associated.
\end{itemize}
\item A self-association of the driver counter to itself is ignored internally as this would lead to inconsistent counter values.
@@ -141,6 +186,29 @@ This document has \number\totvalue{totalpages} (note: \number\totvalue{anotherto
\end{docCommand}
+\begin{docCommand}{AddAssociatedCounters}{\oarg{options}\marg{driver counter}\marg{associated counters list}}
+This command adds some counters to the associated counter list for a specific driver counter -- if this list does not exists, the \LaTeX{} run will be stopped. You have to use \refCom{DeclareAssociatedCounters} first, to set up the driver counter hook.
+
+
+\begin{docCommandArgs}{AddAssociatedCounters}
+
+\begin{enumerate}[label={\textcolor{blue}{\#\arabic*}}]
+ \item \oarg{options}: As of \packageversion, the optional argument \oarg{options} is not used so far, but is reserved for later purposes.
+
+ \item \marg{driver counter}
+
+ Holds the name of the driver counter to which the list of counters should be associated
+\item \marg{associated counters list}
+
+ A comma separated list of counter names that should be associated to the driver counter
+\end{enumerate}
+\end{docCommandArgs}
+
+
+% macro of the package. It declares the counter names being specified in comma - separated - list (CSV) which should be stepped simultaneously when the driver counter is increased by \cs{stepcounter}.
+
+\end{docCommand}%
+
\begin{docCommand}{RemoveAssociatedCounter}{\marg{driver counter}\marg{associated counter}}
This command removes a counter from the existing list for a driver counter, i.e. the counter will not be increased any longer by \cs{stepcounter}. It can be increased however manually, of course.
\end{docCommand}
@@ -163,19 +231,262 @@ and{}\linebreak \refCom{RemoveAssociatedCounter}
This command clears the internal list for all counters associated to the \marg{driver counter}. The counters will not be increased automatically.
\end{docCommand}
-\begin{docCommand}{IfIsAssociatedCounter}{\marg{driver counter}\marg{associated counter}\marg{True branch}\marg{False branch}}
-This macro checks, whether a counter is associated to the driver counter and expands the corresponding branch. If the internal driver counter list does not exist, the false branch will be used, since this also means, that the possibly associated counter is not associated at all.
+
+\clearpage
+
+
+\subsection{Driver counter commands}
+
+
+\begin{docCommand}{AddDriverCounter}{\oarg{options}\marg{driver counter name}}
+
+\begin{docCommandArgs}{AddDriverCounter}%
+
+\begin{enumerate}[label={\textcolor{blue}{\#\arabic*}}]
+\item \oarg{options}: As of \packageversion, the optional argument \oarg{options} is not used so far, but is reserved for later purposes.
+
+ \item \marg{driver counter name}
+
+ Holds the name of the driver counter that should be added to the list of driver counters.
+\end{enumerate}
+
+\end{docCommandArgs}
+
+\end{docCommand}%
+
+
+\begin{docCommand}{ClearDriverCounter}{\oarg{options}}%
+
+This clears completely the list of driver counters, such that no counters are regarded as being associated -- i.e. no driver is hold as being a driver counter.
+
+The optional argument is not used as of version \packageversion.
+
+\end{docCommand}
+
+
+\subsection{Commands for queries}
+
+Sometimes it might be necessary to get information, whether a counter is regarded as a driver or as an associated counter. This section describes some query macros in order to obtain this information.
+
+
+
+\begin{docCommand}{IsAssociatedToCounter}{\marg{driver counter}\marg{associated counter}\marg{True branch}\marg{False branch}}
+This macro checks, whether a counter is associated to a particular given driver counter and expands the corresponding branch. If the internal driver counter list does not exist, the false branch will be used, since this also means, that the possibly associated counter is not associated at all.
+
+
+
+\begin{docCommandArgs}{IsAssociatedToCounter}%
+
+\begin{enumerate}[label={\textcolor{blue}{\#\arabic*}}]
+ \item \marg{driver counter}
+
+ Holds the name of the driver counter to which \marg{associated counter} the could possibly be associated.
+\item \marg{associated counter}
+
+ Contains the name of the possibly associated counter.
+
+\item \marg{True branch}
+
+ This code is expanded if the counter is associated to the driver, otherwise it is ignored.
+
+\item \marg{True branch}
+
+ This code is expanded if the counter is \textbf{not} associated to the driver, otherwise it is ignored.
+
+\end{enumerate}
+\end{docCommandArgs}
+
\begin{dispExample}
% Remove associated counter first for demonstration purposes
\RemoveAssociatedCounter{page}{anothertotalpages}
-\IfIsAssociatedCounter{page}{totalpages}{Yes, totalpages is associated}{No, totalpages is not associated}
+\IsAssociatedToCounter{page}{totalpages}{Yes, totalpages is associated}{No, totalpages is not associated}
-\IfIsAssociatedCounter{page}{anothertotalpages}{Yes, anothertotalpages is associated}{No, anotherpages is not associated}
+\IsAssociatedToCounter{page}{anothertotalpages}{Yes, anothertotalpages is associated}{No, anotherpages is not associated}
\end{dispExample}
+
+See also
+
+\begin{itemize}
+ \item \refCom{IsAssociatedCounter} for checking whether a counter is associated
+ \item \refCom{IsDriverCounter} in order to check whether a counter is a driver.
+ \item \refCom{GetDriverCounter} returns the driver counter name for a given associated counter name
+\end{itemize}
+
+
\end{docCommand}
-\clearpage
+
+\begin{docCommand}{GetDriverCounter}{\marg{counter name}}%
+
+This commands returns the driver counter to which the counter name of the first argument is connected to. If the counter is not defined, the macro returns nothing.
+
+\begin{itemize}
+ \item No check whether the counter name is defined is performed
+ \item No check whether the counter is associated at all is performed. Usage of this command in conjunction with \refCom{IsAssociatedCounter} is strongly encouraged.
+\end{itemize}
+
+
+\begin{dispExample}%
+totalpages is associated to the \textcolor{blue}{\textbf{\GetDriverCounter{totalpages}}} counter.
+% Try with an undefined counter name
+humptydumpty is associated to the \textcolor{blue}{\textbf{\GetDriverCounter{humptydumpty}}} counter.
+
+\end{dispExample}%
+
+\end{docCommand}%
+
+
+\begin{docCommand}{IsAssociatedCounter}{\marg{counter name}\marg{True branch}\marg{False branch}}%
+
+This commands tests, whether a given counter name is an associated counter and expands correspondingly the true or the false branch. The command does not tell to which driver the counter it is associated -- this information can be obtained by \refCom{GetDriverCounter}.
+
+\begin{docCommandArgs}{IfAssociatedCounter}%
+
+\begin{enumerate}[label={\textcolor{blue}{\#\arabic*}}]
+\item \marg{counter name}%
+
+ Contains the name of the possibly associated counter
+
+\item \marg{True branch}
+
+ This code is expanded if the counter is associated to a driver, otherwise it is ignored
+
+\item \marg{True branch}
+
+ This code is expanded if the counter is \textbf{not} associated a driver, otherwise it is ignored
+
+\end{enumerate}
+\end{docCommandArgs}
+
+
+\begin{dispExample}
+\IsAssociatedCounter{section}{Yes, section is an associated counter}{No, section counter does not have the associated counter properties}
+\IsAssociatedCounter{totalpages}{Yes, totalpages is an associated counter}{No, totalpages counter does not have the associated counter properties}
+\end{dispExample}
+
+\end{docCommand}%
+
+
+
+\begin{docCommand}{IsDriverCounter}{\marg{driver counter name}\marg{True branch}\marg{False branch}}%
+
+This commands tests, whether a given counter name is a driver counter and expands correspondingly the true or the false branch.
+
+\begin{docCommandArgs}{IfDriverCounter}%
+
+\begin{enumerate}[label={\textcolor{blue}{\#\arabic*}}]
+\item \marg{driver counter name}%
+
+ Contains the name of the possible driver counter
+
+\item \marg{True branch}
+
+ This code is expanded if the counter is a driver, otherwise it is ignored
+
+\item \marg{True branch}
+
+ This code is expanded if the counter is \textbf{not} a driver, otherwise it is ignored
+
+\end{enumerate}
+\end{docCommandArgs}
+
+
+\begin{dispExample}
+\IsDriverCounter{section}{Yes, section is a driver counter}{No, section counter does not have driver properties}
+\end{dispExample}
+
+\end{docCommand}%
+
+
+\section{Internals commands}
+
+Basically spoken, all internal commands use \cs{@@assoccnt@@} as prefix and are designed to be used only within the package. There is no need to call them in a document directly. Nevertheless, the macros are described for completeness. The direct usage is discouraged, however, if needed, they have to included in a \cs{makeatletter} \ldots \cs{makeatother} pair\footnote{Well, \cs{makeatother} could be omitted, but it is not advised to do so}.
+
+\begin{docCommand}{@@assoccnt@@removefromlist}{\marg{list name}\marg{entry name}}
+
+This command removes an entry (i.e. a counter name) from a general list -- it is not connected to the associated counter features at all.
+\begin{docCommandArgs}{@@assoccnt@@removefromlist}%
+\begin{enumerate}[label={\textcolor{blue}{\#\arabic*}}]
+\item \marg{list command sequence name}%
+
+ Contains the name of the list
+
+\item \marg{entry name}
+
+ This argument should contain the name to be removed from the list. If this name is not present, the original list is maintained unchanged.
+
+\end{enumerate}
+\end{docCommandArgs}
+
+\end{docCommand}%
+
+
+\begin{docCommand}{@@assoccnt@@generateboundtocounterslist}{\marg{associated counter name}}
+
+This command generates a list for each associated counter, holding the counter names to which this counter is associated to. As of version \packageversion~this list can contain only \textbf{one} entry, since a counter cannot not be associated to multiple driver counters.
+
+The only argument \marg{associated counter name} holds the name of the associated counter name. The list name is managed internally and should not be redefined.
+
+\makeatletter
+\begin{dispExample}
+\@@assoccnt@@generateboundtocounterslist{totalpages}%
+\end{dispExample}%
+\makeatother
+
+\end{docCommand}%
+
+
+\begin{docCommand}{@@assoccnt@@addassociatedcounter}{\oarg{option}\marg{associated counters list name}\marg{associated counter name}}
+
+This is the low level command, that
+\begin{enumerate}
+ \item adds a single counter as an associated one to the appropiate list and prevents a multiple addition to this list
+ \item adds a driver counter to the list of driver counters
+ \item prevents multiple addition of the associated counter to other lists
+\end{enumerate}
+
+Use the wrapper command \cs{AddAssociatedCounter} for proper usage.
+
+\begin{docCommandArgs}{@@assoccnt@@addassociatedcounter}%
+\begin{enumerate}[label={\textcolor{blue}{\#\arabic*}}]
+\item \oarg{driver counter name}
+
+ Contains the name of driver counter
+
+\item \marg{associated counters list name}
+
+ This argument should contain the list name for the per driver counter list of associated counters, i.e. use \cs{@@assoccnt@@generatelistname} for this argument
+
+\item \marg{associated counter name}
+
+ The name of the counter to be associated.
+
+\end{enumerate}
+\end{docCommandArgs}
+
+\end{docCommand}
+
+
+
+\begin{docCommand}{@@assoccnt@@associatedcounterslistsuffix}{}
+This command holds the name of the suffix for the associated counters list. It should not be redefined.
+\end{docCommand}
+
+
+\begin{docCommand}{@@assoccnt@@generatelistname}{\marg{driver counter name}}
+
+This macro generates a list from the driver counter name and the driver counter list suffix (see \refCom{@@assoccnt@@associatedcounterslistsuffix})
+
+\makeatletter
+\begin{dispExample}
+ \@@assoccnt@@generatelistname{page}
+\end{dispExample}
+\makeatother
+
+\end{docCommand}
+
+
\section{To do list}
@@ -187,8 +498,6 @@ This macro checks, whether a counter is associated to the driver counter and exp
\clearpage
-
-
\section{Acknowledgments}
I would like to express my gratitudes to the developpers of fine \LaTeX{} packages and of course
@@ -209,8 +518,12 @@ write this documentation.
\clearpage
-\appendix
-\section{Example: Total number of sections}
+\phantomsection
+\appendix\label{examplesappendix}
+
+
+
+\section[Total number of sections]{Example: Total number of sections}
In this example, all sections of this document are counted, i.e. the current one as well as all following ones.
\begin{dispExample}
\DeclareAssociatedCounters{section}{totalsections}%
@@ -218,7 +531,8 @@ This document has \number\totvalue{totalsections} section(s)%
\end{dispExample}
-\section{Example: Total number of subsections with suspension}
+
+\section[Subsection with suspension]{Example: Total number of subsections with suspension}
In this example, the subsections of this document are counted but later on, the associatedcounter is removed from the list, so it is frozen.
@@ -239,7 +553,7 @@ SubSection counter: \thesubsection~-- \number\totvalue{totalsubsections}
-\section{Example: Total number of proofs}
+\section[Total number of proofs]{Example: Total number of proofs}
\begin{dispExample}
@@ -268,6 +582,7 @@ This document has \number\totvalue{totalproofs} proofs %
\end{dispExample}
+
\clearpage
%%%% Index of commands