summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/xassoccnt
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-03-01 23:37:32 +0000
committerKarl Berry <karl@freefriends.org>2016-03-01 23:37:32 +0000
commit2b89922d6cb784a0bcc5507ca4481aa0bbc82be8 (patch)
treefb33525658fe1e10295f92da6cd312e62e9310e8 /Master/texmf-dist/doc/latex/xassoccnt
parent520d48c8fa8936a7a59c6155651dd84116788842 (diff)
xassoccnt (28feb16)
git-svn-id: svn://tug.org/texlive/trunk@39911 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/xassoccnt')
-rw-r--r--Master/texmf-dist/doc/latex/xassoccnt/README6
-rw-r--r--Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.pdfbin285805 -> 384013 bytes
-rw-r--r--Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex162
-rw-r--r--Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_driver.pdfbin80771 -> 80974 bytes
-rw-r--r--Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_driver.tex4
-rw-r--r--Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_example.pdfbin68837 -> 68837 bytes
-rw-r--r--Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_example.tex2
7 files changed, 142 insertions, 32 deletions
diff --git a/Master/texmf-dist/doc/latex/xassoccnt/README b/Master/texmf-dist/doc/latex/xassoccnt/README
index be977393375..205a70c9c44 100644
--- a/Master/texmf-dist/doc/latex/xassoccnt/README
+++ b/Master/texmf-dist/doc/latex/xassoccnt/README
@@ -1,4 +1,4 @@
-%% LaTeX package xassoccnt - version 0.4 (2016/01/26 -- 10/46/26)
+%% LaTeX package xassoccnt - version 0.5 (2016/02/27 -- 19/52/22)
%% README file for xassoccnt.sty
%%
%%
@@ -26,7 +26,7 @@ the associated counters as well. This package can be regarded as a supplement
to the totcount package by Vasileios Koutavas (http://www.ctan.org/pkg/totcount), but
can be used without it too.
-As of 2016/01/26 xassoccnt does not supersede the package assoccnt by the same author, however,
-the older package isn't declared obsolete as of 2016/01/26
+As of 2016/02/27 xassoccnt does not supersede the package assoccnt by the same author, however,
+the older package isn't declared obsolete as of 2016/02/27
diff --git a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.pdf b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.pdf
index 927a086cb3a..25cc2889f78 100644
--- a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.pdf
+++ b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
index ec06144523f..2039e39d55b 100644
--- a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
+++ b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
@@ -1,4 +1,4 @@
-%% LaTeX package xassoccnt - version 0.4 (2016/01/26 -- 10/46/26)
+%% LaTeX package xassoccnt - version 0.5 (2016/02/27 -- 19/52/22)
%% Documentation file for xassoccnt.sty
%%
%%
@@ -19,7 +19,7 @@
%%
%%
-\documentclass[12pt,paper=a4]{article}
+\documentclass[12pt,a4]{article}
@@ -45,6 +45,8 @@
\usepackage{enumitem}
\usepackage{microtype}
\usepackage{caption}
+\usepackage[T1]{fontenc}
+%\usepackage{lucidabr}
\usepackage[scaled=0.92]{helvet}
\newlist{codeoptionsenum}{enumerate}{1}
@@ -236,7 +238,6 @@
\newcommand{\mymailtoaddress}{%
christian.hupfer@yahoo.de
-% christian.hupfer@yahoo.de
}
@@ -282,7 +283,9 @@
pdfcreator={LaTeX}
}
-
+\newcommand{\versionzerofourdate}{2016-01-26}
+\newcommand{\currentversiondate}{2016-02-27}
+\newcommand{\versionzerofivedate}{\currentversiondate}
\begin{document}
\mmddyyyydate
@@ -1029,7 +1032,7 @@ Some notes on \refCom{SetDocumentCounter}
\end{itemize}
\end{docCommand}%
-\begin{docCommand}{StepDownCounter}{\oarg{options}\marg{counter}}\tcbdocmarginnote{\tcbdocnew{2016-01-11}}
+\begin{docCommand}{StepDownCounter}{\oarg{options}\marg{counter}}\tcbdocmarginnote{\tcbdocnew{\versionzerofourdate}}
This macro subtracts the value of 1 from the counter and is the counterpart of \cs{stepcounter}.
@@ -1046,7 +1049,7 @@ This macro subtracts the value of 1 from the counter and is the counterpart of \
\end{docCommand}%
-\begin{docCommand}{SubtractFromCounter}{\oarg{options}\marg{counter}\marg{delta value}}\tcbdocmarginnote{\tcbdocnew{2016-01-11}}
+\begin{docCommand}{SubtractFromCounter}{\oarg{options}\marg{counter}\marg{delta value}}\tcbdocmarginnote{\tcbdocnew{\versionzerofourdate}}
This macro subtracts the (positive) delta value from the counter and is the counterpart of \cs{addtocounter}
@@ -1152,19 +1155,73 @@ This document synchronizes the driver counter value to the associated values. It
\end{itemize}
\end{dispExample}
+\section{Coupled counters}\label{sec::coupledcounters}\tcbdocmarginnote{\tcbdocnew{\versionzerofivedate}}
+
+\begin{marker}
+The features described here are very experimental and not fully implemented so far.
+\end{marker}
+
+Occasionally there are requests where the figure or table environment should use the same counter in the sense of using continued counter values, e.g figure 1 is followed by table 2, the next figure is numbered as 3 etc.
+
+This can be achieved with the concept of coupled counters. As usual, those counters belonging to a 'group' should be declared first in the preamble. In some sense coupled counters are similar to associated counters.
+
+\begin{docCommand}{DeclareCoupledCounters}{\oarg{options}\marg{counter name1, counter name2, \dots}}\tcbdocmarginnote{\tcbdocnew{\versionzerofivedate}}
+\begin{codeoptionsenum}
+ \item \oarg{options}: As of version \packageversion, this option is not used so far.
+ \item \marg{counter name 1, counter name2, \dots}: The list of counters that should should be stepped together.
+\end{codeoptionsenum}
+
+This macro is a preamble-only command.
+
+\end{docCommand}
+
+\begin{marker}
+\begin{itemize}
+\item As of version \packageversion\ only one coupled counter list is possible.
+\item There is no \cs{ClearCoupledCounterList} macro yet.
+\end{itemize}
+\end{marker}
+
+\begin{docCommand}{RemoveCoupledCounters}{\oarg{options}\marg{counter name1, counter name2, \dots}}\tcbdocmarginnote{\tcbdocnew{\versionzerofivedate}}
+
+This removes the listed counter names from the coupled counter list.
+
+The option is not used, the counter name list has the same meaning as in \refCom{DeclareCoupledCounters}.
+\end{docCommand}
+
+\begin{docCommand}{AddCoupledCounters}{\oarg{options}\marg{counter name1, counter name2, \dots}}\tcbdocmarginnote{\tcbdocnew{\versionzerofivedate}}
+
+This adds the listed counter names to coupled counter list. Please use \refCom{RemoveCoupledCounters} first, then apply \cs{AddCoupledCounters}
+
+\end{docCommand}
+
+
+
\section{Total counters}\tcbdocmarginnote{\tcbdocnew{2015-11-27}}
Similarly to the package \CHDocPackage{totcount} or the features of \CHDocPackage{totalcount} by Axel Sommerfeldt this package provides the possibility of defining a counter that stores its finally value to the auxiliary file and starts from this value then, if not set otherwise to another value.
%In order to prevent namespace pollution, the counters have a different name internally, it's possible to have a counter of the name \texttt{foo} and a total counter named \texttt{foo} under the control of the total counter macros.
-The declaration of a total counter is a preamble - only event and \refCom{NewTotalDocumentCounter} is a preamble-only command in order to prevent counter register confusion.
+The declaration of a total counter is a preamble - only event and \refCom{NewTotalDocumentCounter} is a preamble-only command in order to prevent counter register confusion. If a certain existing counter should be treated with total counter features, use \refCom{RegisterTotalDocumentCounter} instead.
\begin{marker}
\tcbdocmarginnote{\bcbombe}The standard \LaTeXe\ commands \cs{stepcounter}, \cs{addtocounter} and \cs{setcounter} support the specification of a total counter, but \cs{refstepcounter} will fail since the usage of a total counter for labelling purposes is most probably of no use (as of version \packageversion)
\end{marker}
+\begin{docCommand}{RegisterTotalDocumentCounter}{\oarg{options}\marg{total counter name}}\tcbdocmarginnote{\tcbdocnew{\versionzerofivedate}}
+\begin{codeoptionsenum}
+ \item \oarg{options}: As of version \packageversion, only this option is used
+ \begin{docKey}{supertotal}{=\meta{true,false}}{false}
+ Set this key to switch the super total counter on or off.
+ \end{docKey}
+ \item \marg{total counter name}: The name of the total counter. This must be the same like the name of an already existing counter. Internally another counter is defined which has a prefix to prevent name clashes with counter names defined by the package \CHDocPackage{totalcount}. If the counter name does not exist, the compilation exists with an error message.
+\end{codeoptionsenum}
+
+
+\end{docCommand}
+
@@ -1226,14 +1283,17 @@ This macro checks if a counter is under the administration of the total counter
In addition to the concept of a total counter, there is also the possibility of using super total counters -- those counters survive the reset at the beginning of a compilation, i.e. the value of a super total counter might be stepped in each run and as such the number of compilation runs etc. can be tracked. The values of the last run are persistent as long as the \CHDocFileExt{.aux} file isn't deleted.
\begin{docCommand}{NewTotalDocumentCounter}{\oarg{options}\marg{total counter name}}
+This macro defines a new counter (which mustn't exist before of course) and puts it under control of the total counter features.
\begin{codeoptionsenum}
\item \oarg{options}: As of version \packageversion, only this option is used
- \begin{docKey}{supertotal}{=\meta{true,false}}{false}
- Set this key to switch the super total counter on or off.
- \end{docKey}
+
+ \refKey{supertotal} -- this has the same meaning as in \refCom{RegisterTotalDocumentCounter} and defaults to \texttt{false}.
+
\item \marg{total counter name}: The name of the total counter. This must not be the same like the name of any already existing counter. Internally another counter is defined which has a prefix to prevent name clashes with counter names defined by the package \CHDocPackage{totalcount}.
\end{codeoptionsenum}
+If an already existing counter should be tracked with total counter features,
+use \refCom{RegisterTotalDocumentCounter} instead.
\end{docCommand}
@@ -1268,38 +1328,60 @@ This macro checks if a counter is under the administration of the super total co
This package adds a counter of its own: \CHDocCounter{numberofruns} which is a super total counter and is stepped each compilation run. It's added in \cs{AtBeginDocument} and can be retrieved with \refCom{TotalValue}.
-\section{Backup and restore of counter values}\tcbdocmarginnote{\tcbdocnew{2016-01-16}}
+\section[Counter backup/restoration]{Backup and restore of counter values}\tcbdocmarginnote{\tcbdocnew{\versionzerofourdate}}
It might be necessary to interrupt the current sectioning, e.g. including another document's structure (an external paper, for example) such that the counting should start again and after finishing of the external structure the old values should be restored.
-\begin{docCommand}{BackupCounterValues}{\oarg{options}\marg{counter name1, counter name2,...}}
-This macro adds counter names (separated by a comma) to a list and stores the current values of the counters to another list. The values are used from the current state where this command is used, not a previous or a later state is stored.
-
-All counters in the list will be reset to zero (after storing the values) for the next usage, unless the \refKey{resetbackup} key is set to \meta{false}.
+\subsection[Macros for backup/restoration]{Description of backup and restoring macros for counter values}
+\begin{docCommand}{BackupCounterValues}{\oarg{options}\marg{counter name1, counter name2,...}}
+ This macro adds counter names (separated by a comma) to a list and stores the current values of the counters to another list. The values are used from the current state where this command is used, not a previous or a later state is stored.
+
+ \begin{itemize}
+ \item All counters in the list will be reset to zero (after storing the values) for the next usage, unless the \refKey{resetbackup} key is set to \meta{false}.
+ \item Multiple specification of the same counter name is possible, but only the first occurence will be regarded -- consecutive occurences of the same counter name are not taken into account. \tcbdocmarginnote{\tcbdocnew{\versionzerofivedate}}
+ \end{itemize}
\begin{docKey}[][]{resetbackup}{=\meta{true/false}}{initially true}
This key decides whether \textbf{all} counters in the backup list should be reset to zero or should keep the current value. The default value is \meta{true}.
\end{docKey}
+Please note: If a name does not belong to a counter register the compilation aborts with an error message!
+
+Some remarks
+
\begin{marker}
-If a specific counter name is suffixed with an \textasteriskcentered\ at its end the resetting is disabled for this particular counter, regardless whether \refKey{resetbackup} is set to true or not.\tcbdocmarginnote{\tcbdocnew{2016-01-24}}
+If a specific counter name is suffixed with an \textasteriskcentered\ at its end the resetting is disabled for this particular counter, regardless whether \refKey{resetbackup} is set to true or not.\tcbdocmarginnote{\tcbdocnew{\versionzerofourdate}}
\end{marker}
-
-Please note: If a name does not belong to a counter register the compilation aborts with an error message!
+\begin{marker}
+ Strangely enough, a counter name like \CHDocCounter{foo*} is possible, but \cs{thefoo*} would fail. Be careful about choosing counter names for new counters -- just restrict yourself to the usual letters (and if really needed, using \makeatletter @\makeatother)
+\end{marker}
\end{docCommand}%
+\begin{docCommand}{RestoreAllCounterValues}{\oarg{options}} \tcbdocmarginnote{\tcbdocnew{\versionzerofivedate}}
+This macro restores all stored counter values corresponding to the counter names.
-\begin{docCommand}{RestoreCounterValues}{\oarg{options}}
-This macro restores the stored counter values corresponding to the counter names. Afterwards the internal backup lists are cleared.
-
-As of version \packageversion\ the optional argument isn't reserved for later purposes.
+As of version \packageversion\ the optional argument isn't used and reserved for later purposes.
The backup list is cleared after the restoring has been finished.
\end{docCommand}
+\begin{marker}
+The \refCom{RestoreAllCounterValues} was previously called \refCom{RestoreCounterValues} -- that macro is now reserved for updating only particular
+counters, not all in a row.
+\end{marker}
+
+
+
+\begin{docCommand}{RestoreCounterValues}{\oarg{options}\marg{counter name1,counter name2,...}} \tcbdocmarginnote{\tcbdocupdated{\versionzerofivedate}}
+This macro restores only the stored counter values given by the counter names.
+As of version \packageversion\ the optional argument isn't used and reserved for later purposes.
+
+%The backup list is cleared after the restoring has been finished.
+\end{docCommand}
+
\begin{dispExample}
\captionof{figure}{A dummy figure}
@@ -1319,7 +1401,7 @@ The backup list is cleared after the restoring has been finished.
Before restoring: \thefigure\ and \thetable
-\RestoreCounterValues
+\RestoreAllCounterValues
Restored the values: \thefigure\ and \thetable
@@ -1329,8 +1411,30 @@ Restored the values: \thefigure\ and \thetable
\end{dispExample}
+\begin{docCommand}{AddBackupCounter}{\oarg{options}\marg{counter name1,counter name2,...}} \tcbdocmarginnote{\tcbdocnew{\versionzerofivedate}}
+This is similar to \refCom{BackupCounterValues}, but adds the counter names to an existing global list and can be applied after \refCom{BackupCounterValues}.
+
+\end{docCommand}
+
+
+\begin{docCommand}{RemoveBackupCounters}{\oarg{options}\marg{counter name1, counter name2,...}} \tcbdocmarginnote{\tcbdocnew{\versionzerofivedate}}
+This macro removes the counters from the list of backup counters and immediately restores the counter value unless the starred version \refCom{RemoveBackupCounters*} is used.
+
+If the package \CHDocPackage{hyperref} is used, the macro \cs{theH...} (see \nameref{subsec::backup_and_hyperref} on this) is restored to the original meaning.
+
+As of version \packageversion\ the optional argument isn't used and reserved for later purposes.
-\subsection*{Some notes on the backup features}
+\end{docCommand}
+
+
+\begin{docCommand}{RemoveBackupCounters*}{\oarg{options}\marg{counter name}} \tcbdocmarginnote{\tcbdocnew{\versionzerofivedate}}
+
+This command is basically similar to \refCom{RemoveBackupCounters}, but does not restore the counter value right at the place the macro is used.
+
+As of version \packageversion\ the optional argument isn't used and reserved for later purposes.
+\end{docCommand}
+
+\subsection{Some notes on the backup features} \label{subsec::backup_and_hyperref}
Principally backing up counter values and restoring them later on is not really difficult -- with one exception: If the \packagename{hyperref} package is used, the counter values form up the hypertarget anchors, for example \texttt{chapter.1} for the first chapter. If the chapter counter is reset, there would be a chapter with number one again and as well an anchor name \texttt{chapter.1} -- \packagename{hyperref} will complain 'only' about this but it will put the wrong hyperlink as well, for example for the table of contents and the bookmarks -- this is an undesirable feature.
@@ -1393,10 +1497,16 @@ write this documentation.
\begin{itemize}
\item
+Version 0.5
+\begin{itemize}[label={$\checkmark$}]
+\item Added support (very experimental!) for coupled counters, see \cref{sec::coupledcounters} about this feature! \tcbdocmarginnote{\tcbdocnew{\versionzerofivedate}}
+\item Added \cs{RegisterTotalDocumentCounter} and improved \cs{TotalValue} support\tcbdocmarginnote{\tcbdocnew{\versionzerofivedate}}
+\end{itemize}
+\item
Version 0.4
\begin{itemize}[label={$\checkmark$}]
-\item Added \cs{BackupCounterValues} and \cs{RestoreCounterValues} support\tcbdocmarginnote{\tcbdocnew{2016-01-16}}
-\item Added \cs{StepDownCounter} and \cs{SubtractFromCounter} macros\tcbdocmarginnote{\tcbdocnew{2016-01-11}}
+\item Added \cs{BackupCounterValues} and \cs{RestoreCounterValues} support\tcbdocmarginnote{\tcbdocnew{\versionzerofourdate}}
+\item Added \cs{StepDownCounter} and \cs{SubtractFromCounter} macros\tcbdocmarginnote{\tcbdocnew{\versionzerofourdate}}
\end{itemize}
\item
Version 0.3
diff --git a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_driver.pdf b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_driver.pdf
index 79f867e5b2d..c11869a25a2 100644
--- a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_driver.pdf
+++ b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_driver.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_driver.tex b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_driver.tex
index d8faac0e3ec..477a52be0a6 100644
--- a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_driver.tex
+++ b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_driver.tex
@@ -1,4 +1,4 @@
-%% LaTeX package xassoccnt - version 0.4 (2016/01/26 -- 10/46/26)
+%% LaTeX package xassoccnt - version 0.5 (2016/02/27 -- 19/52/22)
%% Driver file for xassoccnt.sty
%%
%%
@@ -199,7 +199,7 @@ Internal name: \TotalCounterInternalName{equations}
E=mc^2
\end{equation}
-\RestoreCounterValues
+\RestoreAllCounterValues
\chapter{Another new chapter}
diff --git a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_example.pdf b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_example.pdf
index 4b00bccb27e..e82d7fe59fe 100644
--- a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_example.pdf
+++ b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_example.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_example.tex b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_example.tex
index 86453af56cf..549531744d3 100644
--- a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_example.tex
+++ b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_example.tex
@@ -1,4 +1,4 @@
-%% LaTeX package xassoccnt - version 0.4 (2016/01/26 -- 10/46/26)
+%% LaTeX package xassoccnt - version 0.5 (2016/02/27 -- 19/52/22)
%% Example file for xassoccnt.sty
%%
%%