summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex')
-rw-r--r--Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex297
1 files changed, 278 insertions, 19 deletions
diff --git a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
index f2d7dfc8798..9734efed27b 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 1.3 (2017/03/05 -- 18:08:47)
+%% LaTeX package xassoccnt - version 1.4 (2017/04/30 -- 00:47:05)
%% Documentation file for xassoccnt.sty
%%
%%
@@ -101,6 +101,8 @@
\@namedef{xassoccntversion1.3}{v1.3 2017-03-04}
+\@namedef{xassoccntversion1.4}{v1.4 2017-04-07}
+
\newcommand{\authorname}{Autor}
@@ -321,6 +323,7 @@
}
+\usepackage[T1]{fontenc}
\usepackage{graphicx}%
\usepackage[autodefinecounters=true]{xassoccnt}
\usepackage{amsmath}
@@ -352,6 +355,7 @@
\renewcommand{\rmdefault}{\sfdefault}
+\newcounter{foobar}
\newtotcounter{totalpages}%
\newtotcounter{anothertotalpages}%
@@ -374,7 +378,7 @@
\DeclareAssociatedCounters{proof}{totalproofs}
\DeclareAssociatedCounters{page}{totalpages,anothertotalpages}%
-\NewTotalDocumentCounter{foototal}%
+\DeclareTotalDocumentCounter{foototal}%
\RegisterTotalDocumentCounter{section}%
@@ -562,7 +566,9 @@ As of version \packageversion\ \CHDocPackage{\PackageDocName} supports the packa
Enables the redefinition of the \refCom{label} command and takes care of the optional argument of \refCom{label} if \CHDocPackage{cleveref} is used. This will provide \refCom{label} with a final optional argument that can be used to allow labels for associated counters (either all or only a specified list of counters), for more on this see \refCom{label} in \namecref{subsec::associated_counters_experimental} \nameref{subsec::associated_counters_experimental}.
\end{docKey}
-
+\begin{docKey}{standardcounterformats}{=\meta{choice=on/off}}{initially \meta{on}}\CHDocNew{1.4}
+This key enables (\meta{on}) or disables (\meta{off}) the definition of the standard counter formats to be used in the macro \refCom{CounterFormat}.
+\end{docKey}
\clearpage
\part{Tools for counters}
@@ -903,23 +909,36 @@ The package \CHDocPackage{chngcntr} offers the possibility of add or remove coun
\subsection[Addition and Removal]{Addition and Removal of counters from the reset list}\CHDocNew{1.0}
-\begin{docCommand}[before={\CHDocNew{1.0}}\par]{RemoveFromReset}{\marg{counter name}\marg{driver counter name}}
-This macro removes the counter given in the first argument from the reset list of the driver counter given in the 2nd argument.
+\begin{docCommand}[before={\CHDocNew{1.0}\CHDocUpdate{1.4}}\par]{RemoveFromReset}{\marg{counter name1, counter name2,\dots}\marg{driver counter name}}
+This macro removes the counters given in the comma separated list in the first argument from the reset list of the driver counter given in the 2nd argument.
If the 2nd argument does not point to a \LaTeXe\ counter name an error message is shipped and the compilation fails.
\end{docCommand}
-\begin{docCommand}[before={\CHDocNew{1.0}}]{RemoveFromFullReset}{\marg{counter name}\marg{driver counter name}}
-This macro removes the counter given in the first argument and all of its own reset list from the reset list of the driver counter given in the 2nd argument.
+\begin{docCommand}[before={\CHDocNew{1.0},\CHDocUpdate{1.4}}\par]{RemoveFromFullReset}{\marg{counter name1, counter name2,\dots}\marg{driver counter name}}
+This macro removes the counters given in the comma separated list in the first argument and all of its own reset list from the reset list of the driver counter given in the 2nd argument.
If the 2nd argument does not point to a \LaTeXe\ counter name an error message is shipped and the compilation fails.
\end{docCommand}
-\begin{docCommand}[before={\CHDocNew{1.0}}]{AddToReset}{\marg{counter name}\marg{driver counter name}}
-This macro adds the counter given in the first argument to the reset list of the driver counter given in the 2nd argument.
+\begin{docCommand}[before={\CHDocNew{1.4}}]{ClearCounterResetList}{\marg{driver counter name}}
+This macro removes all counters of the given driver counter reset list. The individual counter formatting macros \cs{theX} are reset both for the driver counter as well as the counters in the reset list to use the \cs{arabic} standard output macro. \texttt{X} means some arbitray \LaTeX2e\ counter name.
+
+If the resetting shall not be applied, use \refCom{ClearCounterResetList*} instead.
+\end{docCommand}
+
+\begin{docCommand}[before={\CHDocNew{1.4}}]{ClearCounterResetList*}{\marg{driver counter name}}
+ This behaves like \refCom{ClearCounterResetList} but does \textbf{not} reset the relevant \cs{theX} macros.
+\end{docCommand}
+
+
+\begin{docCommand}[before={\CHDocNew{1.0}\CHDocUpdate{1.4}}]{AddToReset}{\marg{counter name1, counter name2,\dots}\marg{driver counter name}}
+This macro adds the counters given in the comma separated list in the first argument to the reset list of the driver counter given in the 2nd argument.
If the 2nd argument does not point to a \LaTeXe\ counter name an error message is shipped and the compilation fails.
+
+An accidental specificiation of the driver counter to be added to its own reset list is ignored internally.
\end{docCommand}
@@ -1139,6 +1158,14 @@ The 2nd argument value should hold a macro with any number of arguments, but the
\end{dispExample}
+\begin{docCommand}[before={\CHDocNew{1.4}}\par]{LoopCounterResetList}{\marg{counter name}\marg{counter operation macro}}
+This macro will perform the same action on the reset list of a the counter name given as first argument, the action is a control sequence name specified by the in the second mandatory argument. The loop provides all counters on the reset list of a counter.
+
+As of version \packageversion\ the counter operation macro must have two mandatory arguments, the second one is meant for the current counter in the loop.
+
+Do not confuse this command with \refCom{LoopFullCounterResetList} which tracks all counters recursively on the reset list, so \refCom{LoopCounterResetList} steeps only level down in the reset list hierarchy.
+\end{docCommand}
+
\begin{docCommand}[before={\CHDocNew{1.0}}\par]{LoopFullCounterResetList}{\marg{counter name}\marg{counter operation macro}}
This macro determines the full reset list of a counter, i.e. it cascades down the reset list and tracks the reset lists of all 'sub'-counters too and performs the counter operation macro on this.
\begin{codeoptionsenum}
@@ -1154,14 +1181,63 @@ See the macro \refCom{CounterFullResetList} for more information about the inter
\end{docCommand}
+
+\begin{docCommand}[before={\CHDocNew{1.4}}\par]{CounterWithin}{\marg{counter nameA, counter nameB,\dots}\marg{drivercounter}}
+ This macro sets all counters nameA, nameB, \dots to the reset list of the \marg{drivercounter} and redefines the corresponding macros \cs{thenameA}, etc. to be prepended with \cs{thedrivercounter}, i.e. \verb!\CounterWithin{equation}{section}! would mean that \verb!\theequation! expands to \verb!\thesection.\arabic{section}!
+
+ The default format for the counter output is arabic numbers, i.e. \cs{arabic} will be used.
+
+If the macros \cs{thenameA} etc. should not be changed, use the starred version of this command: \refCom{CounterWithin*}.
+
+ \begin{marker}
+ Please note that the redefinition of \cs{thenameA} etc. is only local, i.e. it is group safe.
+ \end{marker}
+\end{docCommand}
+
+\begin{docCommand}[before={\CHDocNew{1.4}}\par]{CounterWithin*}{\marg{counter nameA, counter nameB,\dots}\marg{drivercounter}}
+ This macro sets all counters nameA, nameB, \dots to the reset list of the \marg{drivercounter}, but does not change the corresponding macros \cs{thenameA}, etc. at all.
+
+ The default format for the counter output is arabic numbers, i.e. \cs{arabic} will be used.
+
+ If the macros \cs{thenameA} etc. should be changed, use non-starred version of this command: \refCom{CounterWithin}.
+
+\end{docCommand}
+
+
+\begin{docCommand}[before={\CHDocNew{1.4}}\par]{CounterWithout}{\marg{counter nameA, counter nameB,\dots}\marg{drivercounter}}
+ This macro removes all counters nameA, nameB, \dots from the reset list of the \marg{drivercounter} and redefines the corresponding macros \cs{thenameA}, etc. without \cs{thedrivercounter}, i.e. \verb!\CounterWithout{equation}{section}! would mean that \verb!\theequation! expand to \verb!\arabic{section!
+
+ The default format for the counter output is arabic numbers, i.e. \cs{arabic} will be used.
+
+ If the macros \cs{thenameA} etc. should not be changed, use the starred version of this command: \refCom{CounterWithout*}.
+
+ \begin{marker}
+ Please note that the redefinition of \cs{thenameA} etc. is only local, i.e. it is group safe.
+ \end{marker}
+
+\end{docCommand}
+
+\begin{docCommand}[before={\CHDocNew{1.4}}\par]{CounterWithout*}{\marg{counter nameA, counter nameB,\dots}\marg{drivercounter}}
+ This macro removes all counters nameA, nameB, \dots from the reset list of the \marg{drivercounter}, but does not redefine the corresponding macros \cs{thenameA}, etc.
+
+ If the macros \cs{thenameA} etc. should be changed, use the non-starred version of this command: \refCom{CounterWithout}.
+\end{docCommand}
+
+
+
+
+
\section{Counter output}\CHDocNew{0.7}
-Once in a while it might be necessary to provide counter output not only as integer numbers, letters or Roman figures but also using binary, octal or hexdecimal number output. The \CHDocPackage{fmtcount} package has support for this already -- here are some alternatives
+Once in a while it might be necessary to provide counter output not only as integer numbers, letters or Roman figures but also using binary, octal or hexdecimal number output. The \CHDocPackage{fmtcount} package has support for this already -- here are some alternatives.
+
+\subsection{Extra counter output types}
+
\begin{marker}
None of the commands checks whether the argument refers to counter name.
\end{marker}
-\begin{docCommand}[doc new={\chdocextractversion{xassoccntversion0.7}}]{BinaryValue}{\marg{counter name}}% \CHDocNew{0.7}
+\begin{docCommand}[doc new={\chdocextractversion{xassoccntversion0.7}}]{BinaryValue}{\marg{counter name}}
This command will print the value of the counter using binary digits.
@@ -1186,6 +1262,162 @@ This command will print the value of the counter using octal digits.
\end{docCommand}
+\begin{docCommand}{xalphalph}{\marg{counter name}}\CHDocNew{1.4}
+This is allows to use more than 26 characters for the usual alphabet and prints the counter value with style \texttt{aa} etc. in the same manner as the \CHDocPackage{alphalph} does, but with the \cs{int\_to\_alph:n} macro from the \CHDocPackage{expl3} bundle. For usage with uppercase characters see \refCom{xAlphAlph}.
+\end{docCommand}
+
+\begin{docCommand}{xAlphAlph}{\marg{counter name}}\CHDocNew{1.4}
+This is allows to use more than 26 characters for the usual alphabet and prints the counter value with style \texttt{AA} etc. in the same manner as the \CHDocPackage{alphalph} does, but with the \cs{int\_to\_Alph:n} macro from the \CHDocPackage{expl3} bundle. For usage with uppercase characters see \refCom{xalphalph}.
+\end{docCommand}
+
+\subsection{Quick counter output changes}\CHDocNew{1.4}
+
+
+\begin{docCommand}{CounterFormat}{\oarg{options}\marg{counter1!formatname1,counter2!formatname2,\dots }}\CHDocNew{1.4}
+
+\begin{marker}
+ This macro needs the package option \refKey{standardcounterformats} to be activated with \meta{standardcounterformats=on}, which is the default.
+\end{marker}
+
+\begin{codeoptionsenum}
+\item \oarg{options}
+ \begin{docKey}[][]{recursive}{=\meta{true/false}}{default: false}
+ If this key is set, the same counter format is used for the relevant counter and its resetting counters, i.e. the macro will pursue the reset counter list chain and recursively adds \cs{the...} to the output format of \cs{thenameA} etc.
+ \begin{marker}
+ Since the \meta{recursive} option needs information on the parent counters, the macro \refCom{GetAllResetLists} must have been called before \refCom{CounterFormat} with this option can be applied. In order to provide the most recent information (which includes recently added counters or changed resetting levels), use \refCom{GetAllResetLists} just before \refCom{CounterFormat}.
+ \end{marker}
+ \end{docKey}
+ \begin{docKey}[][]{separator}{=\meta{separator character/string}}{default: !}
+ Specifies the separator that is used to split the counter name from the format, e.g. \meta{chapter!R} where \meta{chapter} is the counter name and \meta{R} will be recognized as a counter format, meaning \cs{Roman} here, see \cref{table--predefined-counter-formats} for a list of predefined counter formats.
+
+ \begin{marker}
+ The chosen separator must be the same for all counters in the given list of the 2nd argument (see below) and mustn't occur in the counter name itself\footnote{It is not recommended to use counter names with non alphabetic characters anyway.}.
+ \end{marker}
+ \end{docKey}
+ \item \marg{counter1!formatname1,counter2!formatname2,\dots}
+ A comma separated list of counters with a given format name, each separated with a separator charactor, default is \meta{!}. If the format is omitted, the default format is \cs{arabic}, i.e. arabic numbers are used.
+ \end{codeoptionsenum}
+
+\end{docCommand}
+
+\begin{table}[htpb]
+Currently following counter formats shorthands and their output macros are stored in \cs{AtBeginDocument} if the package option \refKey{standardcounterformats} is set to on, which is the default behaviour of the package.
+
+\centering
+\begin{tabular}{ll}
+ a & \cs{alph} \tabularnewline
+ A & \cs{Alph} \tabularnewline
+ aa & \refCom{xalphalph} \tabularnewline
+ AA & \refCom{xAlphAlph} \tabularnewline
+ b & \refCom{BinaryValue} \tabularnewline
+ h & \refCom{hexValue} \tabularnewline
+ H & \refCom{HexValue} \tabularnewline
+ n & \cs{arabic} \tabularnewline
+ o & \refCom{OctalValue} \tabularnewline
+ r & \cs{roman} \tabularnewline
+ R & \cs{Roman} \tabularnewline
+\end{tabular}
+\caption[List of predefined counter formats]{List of predefined counter format shorthands -- please note that \meta{n} has been used in order to allow \meta{a} to be used for output with lowercase characters.}\label{table--predefined-counter-formats}
+\end{table}
+
+\begin{dispExample*}{title=Simple usages of \refCom{CounterFormat},breakable}
+% Assume foobar is a defined counter
+\setcounter{foobar}{17}
+
+\CounterFormat{foobar!b}
+\thefoobar
+
+\CounterFormat{foobar!h}
+\thefoobar
+
+
+\CounterFormat{foobar!H}
+\thefoobar
+
+\CounterFormat{foobar!R}
+\thefoobar
+
+\setcounter{foobar}{30}
+
+\CounterFormat{foobar!aa}
+\thefoobar
+
+\CounterFormat{foobar!o}
+\thefoobar
+
+\CounterFormat{foobar!AA}
+\thefoobar
+
+
+\end{dispExample*}
+
+\begin{dispExample*}{title={Showing the \meta{recursive} option of \refCom{CounterFormat}},breakable}
+% All counters are using \arabic by default from \newcounter or \NewDocumentCounter
+\NewDocumentCounter{foolevelzero}
+\NewDocumentCounter{foolevelone}[foolevelzero]
+\NewDocumentCounter{fooleveltwo}[foolevelone]
+
+% Get the current reset lists! (Important}
+
+\GetAllResetLists
+
+% Now change to Hex format (!H) for all counters in the hierarchy.
+\CounterFormat[recursive]{fooleveltwo!H}
+
+\setcounter{foolevelzero}{20}% Should be 14
+\setcounter{foolevelone}{15}% Should be F
+\setcounter{fooleveltwo}{10}% Should be A
+
+\thefoolevelzero % -> 14
+
+\thefoolevelone % 14.F
+
+\thefooleveltwo % 14.F.A
+
+\end{dispExample*}
+
+
+\begin{docCommand}{StoreCounterFormats}{\oarg{options}\marg{formatshorthandA!formatmacroA,formatshorthandB!formatmacroB,\dots}}\CHDocNew{1.4}
+ Stores the counter formats separated by the separator charactor as given in the option to the global list. Existing formats will be overwritten if the format shorthand already exists. There is no warning about this!
+ The only handled option is \refKey{separator} and has the same meaning as in \refCom{CounterFormat}.
+
+ The formatmacro must be a command sequence with exactly one mandatory argument, which may not be specified in the format storage process.
+
+\begin{marker}
+ This macro will become a preamble-only command most likely.
+\end{marker}
+\end{docCommand}
+
+\begin{dispExample}
+ \StoreCounterFormats{foo!\Roman,foobarnice!\OctalValue}
+ \setcounter{foobar}{17}
+ \CounterFormat{foobar!foo}
+ \thefoobar
+
+ \CounterFormat{foobar!foobarnice}
+ \thefoobar
+\end{dispExample}
+
+
+
+
+\begin{docCommand}{AddCounterFormats}{\oarg{options}\marg{formatshorthandA!formatmacroA,formatshorthandB!formatmacroB,\dots}}\CHDocNew{1.4}
+ Adds the counter formats separated by the separator charactor as given in the option to the global list, similar to \refCom{StoreCounterFormats}. Existing formats will be overwritten if the format shorthand already exists. There is no warning about this!
+ The only handled option is \refKey{separator} and has the same meaning as in \refCom{CounterFormat}.
+
+ The formatmacro must be a command sequence with exactly one mandatory argument, which may not be specified in the format storage process.
+\end{docCommand}
+
+\begin{docCommand}{RemoveCounterFormats}{\oarg{options}\marg{formatshorthandA,formatshorthandB,\dots}}\CHDocNew{1.4}
+ Removes the given counter formats from the global list.
+
+ The optional argument is ignored as of version \packageversion.
+\end{docCommand}
+
+
+
+
+
\clearpage
\part{Features}
@@ -1521,7 +1753,6 @@ This commands tests, whether a given counter name is a driver counter and expand
-
\section[Counter backup/restoration]{Backup and restore of counter values}\CHDocNew{1.0}\label{section::new_backuprestore}
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.
@@ -1593,6 +1824,7 @@ There is a default counter group for backup named "scratch", if no specific coun
\end{itemize}
\end{itemize}
+
\subsubsection{Core backup/restore macros}
\begin{docCommand}[before={\CHDocNew{1.0}}]{BackupCounterGroup}{\oarg{options}\marg{counter group name}}
@@ -1674,6 +1906,7 @@ It might be necessary to remove a certain backup state, i.e. a collection of cou
+
\subsubsection[Clearing backup groups]{Clearing and deleting backup counter groups}\label{subsubsec::clearingdeletingbackupcountergroups}
From time to time it might be necessary to remove counters from a group or to clear the whole group or remove even the whole group. Those operations can be achieved with \refCom{RemoveCountersFromBackupGroup}, \refCom{ClearBackupCounterGroups} and \refCom{DeleteBackupCounterGroups}. All macros remove at least all stored values belonging to a counter group. A \refCom{RestoreBackupCounterGroup} call does nothing after any of the mentioned macros have been issued.
@@ -1981,6 +2214,7 @@ This macro tests if a counter is under the administration of the periodic counte
\end{docCommand}
+
\section[Suspending and Resuming]{Suspending and resuming (associated) counters}\label{section::suspendedresumedcounters}
@@ -2123,7 +2357,9 @@ There are \number\totvalue{totalequations}~equations in here!
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.
-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.
+The declaration of a total counter is a preamble - only event and \refCom{DeclareTotalDocumentCounter} 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.
+
+Use \refCom{NewTotalDocumentCounter} only in rare cases, if a total counter must be defined within the document body.
\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)
@@ -2183,6 +2419,7 @@ This macro tests if a counter is under the administration of the total counter c
+
\begin{docCommand}{IsTotalCounterT}{\marg{counter name}\marg{true branch}}
This macro checks if a counter is under the administration of the total counter commands and expands to the code in the second argument if this is true.
\end{docCommand}
@@ -2207,6 +2444,8 @@ This macro checks if a counter is under the administration of the total counter
The features of using other \CHDocFiles{aux} files or a different external file as provided by \CHDocPackage{totcount} is not (yet) support as of version \packageversion.
\end{marker}
+
+
\section{Super total counters}\label{section:supertotalcounters} \tcbdocmarginnote{\tcbdocnew{2015-11-25}}
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.
@@ -2219,9 +2458,14 @@ This macro defines a new counter (which mustn't exist before of course) and puts
\refKey{supertotal} -- this has the same meaning as in \refCom{RegisterTotalDocumentCounter} and defaults to \texttt{false}.
- \item \marg{total counter name1, total counter name2,\dots}: The names of the total counter, separated by a comma. 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}
+ \item \marg{total counter name1, total counter name2,\dots}: The names of the total counter, separated by a comma. 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{totcount}.
+ \end{codeoptionsenum}
+
+\end{docCommand}
+\begin{docCommand}{DeclareTotalDocumentCounter}{\oarg{options}\marg{total counter name1, total counter name2,\dots}}
+
+This is the preamble - only version of \refCom{NewTotalDocumentCounter} and should be preferred in most cases over that command.
If an already existing counter should be tracked with total counter features,
use \refCom{RegisterTotalDocumentCounter} instead.
@@ -2239,6 +2483,7 @@ This macro tests if a counter is under the administration of the super total cou
+
\begin{docCommand}{IsSuperTotalCounterT}{\marg{counter name}\marg{true branch}}
This macro checks if a counter is under the administration of the super total counter commands and expands to the code in the second argument if this is true.
\end{docCommand}
@@ -2262,6 +2507,7 @@ 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}. Use the \refKey{nonumberofruns} package option to prevent the definition of this counter.
+
\section{Experimental features}\label{subsec::associated_counters_experimental}
@@ -2332,7 +2578,7 @@ This feature is experimental and only realized for the modified \refCom{label} c
This macro declares a possible list of hooks (commands) that should be executed \textbf{before} the traditional \cs{label} command is applied. If the hook name refers to some unknown macro, nothing is done.
-The hook names must be given with the \textbackslash as command sequence indicator, i.e. \cs{zlabel}, more than one macro name is possible by using comma as separator.
+The hook names must be given with the \textbackslash\ as command sequence indicator, i.e. \cs{zlabel}, more than one macro name is possible by using comma as separator.
As of version \packageversion\ the hook macro does not allow more than one argument, which is automatically used from the surrounding \cs{label} call and is the usual label name.
@@ -2343,7 +2589,7 @@ As of version \packageversion\ the hook macro does not allow more than one argum
This macro declares a possible list of hooks (commands) that should be executed after the traditional \cs{label} command is applied. If the hook name refers to some unknown macro, nothing is done.
-The hook names must be given with the \textbackslash as command sequence indicator, i.e. \cs{zlabel}, more than one macro name is possible by using comma as separator.
+The hook names must be given with the \textbackslash\ as command sequence indicator, i.e. \cs{zlabel}, more than one macro name is possible by using comma as separator.
As of version \packageversion\ the hook macro does not allow more than one argument, which is automatically used from the surrounding \cs{label} call and is the usual label name.
@@ -2424,6 +2670,20 @@ write this documentation.
\begin{itemize}[itemsep=15pt]
+\item \CHDocFullVersion{1.4}
+
+\begin{itemize}
+ \item Improved the core macros \cs{refstepcounter} and \cs{stepcounter} in order to fit the \CHDocPackage{expl3} and \CHDocPackage{xparse} changes of Februar - April 2017.
+ \item Added following experimental features:
+ \item \refCom{CounterFormat} with quick and possible recursive change of the counter output
+ \item \refCom{StoreCounterFormats}, \refCom{AddCounterFormats} and \refCom{RemoveCounterFormats} for defining own short hand counter formats.
+ \item Provided the macros \refCom{xalphalph} and \refCom{xAlphAlph} in order to allow counter output in the same manner as the \CHDocPackage{alphalph} does.
+ \item Added the macros \refCom{CounterWithin}, \refCom{CounterWithin*}, \refCom{CounterWithout} and \refCom{CounterWithout*} which provides a quicker access to add or remove counters from the reset list and changing the corresponding \cs{the...} macros.
+ \item Provided the \refCom{LoopCounterResetList} to perform the same action on all counters being in the reset list of a given counter.
+ \item New macros \refCom{ClearCounterResetList} and \refCom{ClearCounterResetList*} to remove all counters on first level of a driver counter.
+ \item Added the explanation (missing in previous versions) to the documentation that the \refCom{AddToReset}, \refCom{RemoveFromReset} and \refCom{RemoveFromFullReset} macros actually support a comma separated list of counter names for the first argument.
+\end{itemize}
+
\item \CHDocFullVersion{1.3}
\begin{itemize}
\item Provided the \refCom{LaTeXLabel} macro to access the non-xassoccnt version of the \refCom{label} command.
@@ -2510,7 +2770,6 @@ Improved \cs{stepcounter} to remove some incompatibilities with the \CHDocPackag
\item
\CHDocFullVersion{0.1}
-%Version: 0.1 \CHDocNew{0.1}
A major bug fixed due to some error in usage together with \CHDocPackage{calc} when the driven counters are not stepped any longer.
The culprit was in \CHDocPackage{assoccnt} that the counter reset list was not really disabled.
@@ -2527,7 +2786,7 @@ Improved \cs{stepcounter} to remove some incompatibilities with the \CHDocPackag
\renewcommand{\theHsection}{appendix.\thesection}
\renewcommand{\thesection}{\Alph{section}}
-Note: The \cs{DeclareAssociatedCounters} command have to be used in the preamble of the document. It's missing here for the sake of a compact example.
+Note: The \cs{DeclareAssociatedCounters} command has to be used in the preamble of the document. It's missing here for the sake of a compact example.