summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-06-11 23:06:44 +0000
committerKarl Berry <karl@freefriends.org>2016-06-11 23:06:44 +0000
commit876b86d0b964599f049d2ae7d670b73308961d4a (patch)
treeb0fd38e2e0f32c2797b76e3e26fbab924adcc712 /Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
parenta880c715c123c4ecf8da826a5283895cec739b42 (diff)
xassoccnt (11jun16)
git-svn-id: svn://tug.org/texlive/trunk@41371 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex')
-rw-r--r--Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex141
1 files changed, 121 insertions, 20 deletions
diff --git a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
index c0ff88c6290..f67c6ecab59 100644
--- a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
+++ b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
@@ -1,5 +1,5 @@
-%% LaTeX package xassoccnt - version 0.7 (2016/05/10 -- 00/41/54)
-%% Documentation file for xassoccnt.sty
+%% LaTeX package xassoccnt - version 0.8 (2016/06/10 -- 23/28/27)
+%% Documentation file for xassoccnt.sty
%%
%%
%% -------------------------------------------------------------------------------------------
@@ -51,6 +51,7 @@
\newlist{codeoptionsenum}{enumerate}{1}
\setlist[codeoptionsenum,1]{label={\textcolor{blue}{\#\arabic*}}}
+\renewcommand{\rmdefault}{\sfdefault}
\newcolumntype{C}[1]{>{\centering\arraybackslash}p{#1}}
@@ -67,10 +68,31 @@
\def\KVchdocfilepurpose{#1}%
}
+
+\newcommand{\chdocextractversion}[1]{%
+ \@nameuse{#1}%
+}
+
+
+
+\@namedef{xassoccntversion0.4}{v0.4 2016-01-26}
+
+\@namedef{xassoccntversion0.5}{v0.5 2016-02-27}
+
+\@namedef{xassoccntversion0.6}{v0.6 2016-03-05}
+
+\@namedef{xassoccntversion0.7}{v0.7 2016-05-10}
+
+\@namedef{xassoccntversion0.8}{v0.8 2016-05-16}
+
+
\makeatother
+
+
+
\fancypagestyle{plain}{%
\fancyfoot[L]{\begin{tabular}[t]{l}\PackageDocName\ \packageversion \tabularnewline \textcopyright\ Dr. Christian Hupfer\end{tabular}}%
\fancyfoot[C]{\thepage}%
@@ -84,6 +106,7 @@
}
+
\newtcolorbox{CHPackageTitleBox}[1][]{%
enhanced jigsaw,
drop lifted shadow,
@@ -287,8 +310,9 @@
\newcommand{\versionzerofourdate}{v0.4 2016-01-26}
\newcommand{\versionzerofivedate}{v0.5 2016-02-27}
\newcommand{\versionzerosixdate}{v0.6 2016-03-05}
-\newcommand{\currentversiondate}{2016-05-10}
-\newcommand{\versionzerosevendate}{v0.7 \currentversiondate}
+\newcommand{\versionzerosevendate}{v0.7 2016-05-10}
+\newcommand{\currentversiondate}{2016-06-10}
+\newcommand{\versionzeroeightdate}{v0.8 \currentversiondate}
\begin{document}
\mmddyyyydate
@@ -398,7 +422,8 @@ For potential problems see \cref{subsection:incompatibilities}
\begin{marker}
-\tcbdocmarginnote{\tcbdocupdated{\versionzerosevendate}}
+%\tcbdocmarginnote{\tcbdocupdated{\versionzerosevendate}}
+\tcbdocmarginnote{\tcbdocupdated{\chdocextractversion{xassoccntversion0.7}}}
Of course any package other that loads \CHDocPackage{calc} must be loaded before \PackageDocName, i.e. \CHDocPackage{mathtools}.
\end{marker}
@@ -836,6 +861,32 @@ This command sequence tests whether the counter \meta{reset counter} is not in t
See the related commands \refCom{IfInResetListTF} and \refCom{IfInResetListT} as well.
\end{docCommand}
+\begin{docCommand}{DisplayResetList}{\oarg{separator={,}}\marg{resetting counter}}\tcbdocmarginnote{\tcbdocnew{\chdocextractversion{xassoccntversion0.8}}}
+
+This command displays the reset list of a counter as a separated list. If the counter has no resetting list, nothing is shown.
+
+\begin{docCommandArgs}{DisplayResetList}%
+
+\begin{codeoptionsenum}
+\item \oarg{separator}%
+ This separator is used for display, it defaults to a comma character.
+
+\item \marg{resetting counter}%
+
+ Contains the name of counter whose resetting list should be displayed.
+\end{codeoptionsenum}
+\end{docCommandArgs}
+
+\end{docCommand}
+
+\begin{docCommand}{ShowResetList}{\marg{resetting counter}}\tcbdocmarginnote{\tcbdocnew{\chdocextractversion{xassoccntversion0.8}}}
+
+This command displays the reset list of a counter on the terminal as the \cs{show} command would do. This is rather useful for debugging purposes only.
+\end{docCommand}
+
+
+
+
\subsection[Information macros]{Information on counters} \label{subsection::informationcmds}
On occasions it might be important to have some information which counter has been changed last. Since there are four commands manipulating counter values, there are four corresponding routines for this:
@@ -939,15 +990,45 @@ Please note, that all of this commands are only working in the current run of co
\section[Suspending and Resuming]{Suspending and resuming (associated) counters}\label{section::suspendedresumedcounters}
+
+
Rather than removing an associated counter from the list, it is possible to suspend the automatic stepping for a while and then resume it (or completely drop it), for example, if the value of a counter should not be stepped within a specific chapter etc.
+\tcbdocmarginnote{\tcbdocnew{\chdocextractversion{xassoccntversion0.8}}}
+\begin{marker}
+ Suspension and resuming counters can cause wrong hyper links if \CHDocPackage{hyperref} is used.
+\end{marker}
+
\begin{docCommand}{SuspendCounters}{\oarg{options}\marg{counters list}}%
\begin{docCommandArgs}{SuspendCounters}%
\begin{codeoptionsenum}
\item \oarg{options}%
+
+ Not used so far, reserved for later usage.
+
+\item \marg{counters list}%
- Not used so far, reserved for later usages
+ Contains the name of counters to be suspended, separated by commas (CSV - list)
+\end{codeoptionsenum}
+\end{docCommandArgs}
+\end{docCommand}%
+
+\begin{docCommand}{CascadeSuspendCounters}{\oarg{options}\marg{counters list}}\tcbdocmarginnote{\tcbdocnew{\chdocextractversion{xassoccntversion0.8}}}
+
+This macro is more powerful than \refCom{SuspendCounters}, since it tries to detect whether a counter has a reset list and 'mutes' the counters on this list as well and checks whether those counters themselves have reset lists and cascades down to the final state.
+
+\begin{marker}
+ Stated differently: All counters anyhow connected to a counter named \CHDocCounter{foo} will be suspended, e.g. for the \CHDocClass{book} class and \CHDocCounter{chapter}, this means in a standard setup, that \CHDocCounter*{section,figure,table,equation,footnote} will be suspended, as well as in consequence \CHDocCounter*{subsection,subsubsection,paragraph,subparagraph}, assuming hereby no other counters have been added to the reset lists.
+\end{marker}
+
+
+\begin{docCommandArgs}{CascadeSuspendCounters}%
+
+\begin{codeoptionsenum}
+\item \oarg{options}%
+
+ Not used so far, reserved for later usage.
\item \marg{counters list}%
@@ -956,10 +1037,17 @@ Rather than removing an associated counter from the list, it is possible to susp
\end{docCommandArgs}
\end{docCommand}%
+
\begin{docCommand}{ResumeSuspendedCounters}{\oarg{options}\marg{counters list}}
+ As of version \packageversion\ the optional argument is not used and reserved for later purposes.
This command revokes the suspension of the counters in the \marg{counters} list.
\end{docCommand}
+\begin{docCommand}{ResumeAllSuspendedCounters}{\oarg{options}} \tcbdocmarginnote{\tcbdocnew{\chdocextractversion{xassoccntversion0.8}}}
+ As of version \packageversion\ the optional argument is not used and reserved for later purposes.
+ This command revokes all suspended counters.
+\end{docCommand}
+
\begin{marker}
If a driver counter is suspended, all counters associated to it are suspended too!
@@ -1132,7 +1220,7 @@ This macro swaps the values of the counters given in arguments 2 and 3
\begin{docCommand}{SyncCounters}{\oarg{options}\marg{driver counter}}
-This document synchronizes the driver counter value to the associated values. It has the some options as \refCom{SetDocumentCounter}. If the given counter is no driver counter, nothing is done.
+This document synchronizes the driver counter value to the associated values. It has the same options as \refCom{SetDocumentCounter}. If the given counter is no driver counter, nothing is done.
\begin{docCommandArgs}{SyncCounters}%
@@ -1732,7 +1820,7 @@ to the users at tex.stackexchange.com, especially to
\item Enrico Gregorio
\item Joseph Wright
\item David Carlisle
- \item Werner
+ \item Werner Grundlingh
\item Gonzalo Medina
\item Cosmo Huber (for providing the bug report with the \CHDocPackage{calc} package.)
\end{itemize}
@@ -1750,21 +1838,34 @@ write this documentation.
\section{Version history}
\begin{itemize}
-\item
-Version 0.7
-
-\begin{itemize}[label={$\checkmark$}]
-\item Fixed a small bug in the \CHDocPackage{\PackageDocName} version of \cs{stepcounter}
-\item Added some macros that support the output of binary, octal or hexadecimal (both lower/uppercase) values of counters. \tcbdocmarginnote{\tcbdocnew{\versionzerosevendate}}
- \item Added the \cs{Loop...Counters} macros that performs an action in loop on all given counter names. \tcbdocmarginnote{\tcbdocnew{\versionzerosixdate}}
-\end{itemize}
\item
-Version 0.6
-
+Version 0.8
\begin{itemize}[label={$\checkmark$}]
- \item The coupled counters allow to specify a counter group to which all relevant counters belong, this allows several coupled counter groups then \tcbdocmarginnote{\tcbdocnew{\versionzerosixdate}}
- \item Fixed a small bug within backup counter support -- the resetting was not done any more \tcbdocmarginnote{\tcbdocnew{\versionzerosixdate}}
+\item Fixed the \refCom{SuspendCounters} and \refCom{ResumeSuspendedCounters} macros -- the comma separated list of counters was not used (contrary to the purpose and the documentation description). \tcbdocmarginnote{\tcbdocupdated{\chdocextractversion{xassoccntversion0.8}}}
+ \item Additions of commands\tcbdocmarginnote{\tcbdocnew{\chdocextractversion{xassoccntversion0.8}}}
+ \begin{itemize}[label={$\triangleright$}]
+ \item \refCom{ResumeAllSuspendedCounters}
+ \item \refCom{CascadeSuspendCounters}
+ \item \refCom{DisplayResetList}
+ \item \refCom{ShowResetList}
+ \end{itemize}
+ \end{itemize}
+\item
+ Version 0.7
+
+ \begin{itemize}[label={$\checkmark$}]
+ \item Fixed a small bug in the \CHDocPackage{\PackageDocName} version of \cs{stepcounter}
+ \item Added some macros that support the output of binary, octal or hexadecimal (both lower/uppercase) values of counters. \tcbdocmarginnote{\tcbdocnew{\versionzerosevendate}}
+ \item Added the \cs{Loop...Counters} macros that performs an action in loop on all given counter names. \tcbdocmarginnote{\tcbdocnew{\versionzerosevendate}}
+ \end{itemize}
+
+ \item
+ Version 0.6
+
+ \begin{itemize}[label={$\checkmark$}]
+ \item The coupled counters allow to specify a counter group to which all relevant counters belong, this allows several coupled counter groups then \tcbdocmarginnote{\tcbdocnew{\versionzerosixdate}}
+ \item Fixed a small bug within backup counter support -- the resetting was not done any more \tcbdocmarginnote{\tcbdocnew{\versionzerosixdate}}
\item Added the \CHDocKey{nonumberofruns}\ package option.
\end{itemize}
\item