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.tex174
1 files changed, 100 insertions, 74 deletions
diff --git a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
index 955eb7aed63..9e398d173f7 100644
--- a/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
+++ b/Master/texmf-dist/doc/latex/xassoccnt/xassoccnt_doc.tex
@@ -1,6 +1,5 @@
-%% LaTeX package assoccnt - version 0.1 (2015/11/07)
-%% Documentation for assoccnt.sty
-%%
+%% LaTeX package xassoccnt - version 0.2 (2015/11/14 -- 16/08/33)
+%% Documentation file for xassoccnt.sty
%%
%%
%% -------------------------------------------------------------------------------------------
@@ -15,27 +14,71 @@
%% and version 1.3 or later is part of all distributions of LaTeX
%% version 2005/12/01 or later.
%%
-%% This work has the LPPL maintenance status `author-maintained'.
%%
-%% This work consists of all files listed in README
+%% This work has the LPPL maintenance status `author-maintained`
+%%
%%
-
\documentclass[12pt,paper=a4]{article}
+
+
\usepackage[lmargin=2cm,rmargin=2cm,headheight=15pt]{geometry}
-\usepackage{savesym}%
-\usepackage{bbding}%
-\savesymbol{Cross}%
+\usepackage{savesym}
+\usepackage{bbding}
+\savesymbol{Cross}
+
+\usepackage{blindtext}
+\usepackage[x11names]{xcolor}
+\usepackage{imakeidx}
+
+\usepackage[most,documentation]{tcolorbox}
+
+
+
+\usepackage[tikz]{bclogo}
+\usepackage{marginnote}
+\usepackage{fancyhdr}
+\usepackage{datetime}
+\usepackage{array}
+
+
+
+\usepackage{totcount}
+\usepackage{enumitem}%
+\usepackage{microtype}
+\usepackage[scaled=0.92]{helvet}
+
+\newlist{codeoptionsenum}{enumerate}{1}
+\setlist[codeoptionsenum,1]{label={\textcolor{blue}{\#\arabic*}}}
+
+
+\newcommand{\packagename}[1]{\fbox{\textcolor{blue}{\textbf{\ding{41}~#1}}}\index{Package!#1}}%
+\newcommand{\classname}[1]{\fbox{\textcolor{brown}{\textbf{\Writinghand~#1}}}\index{Class!#1}}%
+\newcommand{\handrightnote}{\tcbdocmarginnote{\ding{43}}}
+
+
+\fancypagestyle{plain}{%
+\fancyfoot[L]{\begin{tabular}[t]{l}\PackageDocName\ \packageversion \tabularnewline \textcopyright\ Dr. Christian Hupfer\end{tabular}}%
+\fancyfoot[C]{\thepage}%
+\fancyfoot[R]{\today}%
+\renewcommand{\headrule}{{\color{blue}%
+\hrule width\headwidth height\headrulewidth \vskip-\headrulewidth}}
+\renewcommand{\footrule}{{\color{blue}\vskip-\footruleskip\vskip-\footrulewidth
+\hrule width\headwidth height\footrulewidth\vskip\footruleskip}}
+\renewcommand{\footrulewidth}{2pt}
+\renewcommand{\headrulewidth}{2pt}
+}
+
+
+\newtcolorbox{docCommandArgs}[1]{colbacktitle={blue},coltitle={white},title={Description of arguments of command \cs{#1}}}
-\usepackage{blindtext}%
-\usepackage[x11names]{xcolor}%
-\usepackage{imakeidx}%
-\usepackage[all]{tcolorbox}
+\newcommand{\tcolorboxdoclink}{http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf}
% 'Stolen' from tcolorbox documentation ;-)
+
\newtcolorbox{marker}[1][]{enhanced,
before skip=2mm,after skip=3mm,
boxrule=0.4pt,left=5mm,right=2mm,top=1mm,bottom=1mm,
@@ -50,69 +93,31 @@
drop fuzzy shadow,#1}
+\usepackage[autodefinecounters=true]{xassoccnt}
-\usepackage[tikz]{bclogo}
-\usepackage{marginnote}
-\usepackage{fancyhdr}
-\usepackage{datetime}%
-
-
-\usepackage{array}%
-
-
-
-\usepackage{amsmath}%
-\usepackage{amsthm}%
-
-\usepackage{calc} % Only for testing
-\usepackage{totcount}%
-\usepackage{enumitem}%
-\usepackage{microtype}
-\usepackage[scaled=0.92]{helvet}
-\usepackage[autodefinecounters=true]{xassoccnt}%
-
-\hypersetup{breaklinks=true,
- pdftitle={xassoccnt_doc.pdf},
- pdfauthor={Dr. Christian Hupfer},
- pdfsubject={Documentation of xassoccnt package},
- pdfkeywords={LaTeX, counters}
-}
-\usepackage{bookmark}%
+\usepackage{bookmark}
\usepackage{cleveref}
-\newlist{codeoptionsenum}{enumerate}{1}
-\setlist[codeoptionsenum,1]{label={\textcolor{blue}{\#\arabic*}}}
+\newcommand{\PackageDocName}{xassoccnt}%
-\renewcommand{\rmdefault}{\sfdefault}
-\newcommand{\packagename}[1]{\textcolor{blue}{\textbf{\Envelope~#1}}\index{Package!#1}}%
\newcommand{\mymailtoaddress}{%
christian.hupfer@yahoo.de
}
-\newcommand{\MarkupPackageName}[2][lightgray]{%
-\colorbox{#1}{\textcolor{black}{#2}}%
-}%
-
-\newcommand{\MarkupCounterName}[2][yellow]{%
-\colorbox{#1}{\textcolor{black}{\texttt{#2}}}%
-}%
-
-
-\let\DeclareAssociatedCountersOrig\DeclareAssociatedCounters
-
-\newtcolorbox{docCommandArgs}[1]{colbacktitle={blue},coltitle={white},title={Description of arguments of command \cs{#1}}}
+\let\DeclareAssociatedCountersOrig\DeclareAssociatedCounters % -> for use in examples only
\def\packageversion{\xassoccntpackageversion}%
-
\makeindex[intoc]
-\newcommand{\PackageDocName}{xassoccnt}%
+
+\renewcommand{\rmdefault}{\sfdefault}
+
\newtotcounter{totalpages}%
@@ -134,6 +139,15 @@
\DeclareAssociatedCounters{page}{totalpages,anothertotalpages}%
+\hypersetup{breaklinks=true,
+ pdftitle={\jobname.pdf -- version \packageversion},
+ pdfauthor={Dr. Christian Hupfer},
+ pdfsubject={Documentation of \PackageDocName\ package},
+ pdfkeywords={LaTeX, counters},
+ pdfcreator={LaTeX}
+}
+
+
\begin{document}
\mmddyyyydate
@@ -148,7 +162,7 @@
\large \bfseries%
\begin{center}%
\begin{tabular}{c}%
-\textsc{\PackageDocName} \tabularnewline
+\scshape \PackageDocName \tabularnewline
\tabularnewline
Associated counters stepping simultaneously \tabularnewline
\tabularnewline
@@ -175,17 +189,6 @@ Author: Christian Hupfer\(^\mathrm{\fnsymbol{footnote}}\)
-\fancypagestyle{plain}{%
-\fancyfoot[L]{\begin{tabular}[t]{l}\PackageDocName\ \packageversion \tabularnewline \textcopyright\ Dr. Christian Hupfer\end{tabular}}%
-\fancyfoot[C]{\thepage}%
-\fancyfoot[R]{\today}%
-\renewcommand{\headrule}{{\color{blue}%
-\hrule width\headwidth height\headrulewidth \vskip-\headrulewidth}}
-\renewcommand{\footrule}{{\color{blue}\vskip-\footruleskip\vskip-\footrulewidth
-\hrule width\headwidth height\footrulewidth\vskip\footruleskip}}
-\renewcommand{\footrulewidth}{2pt}
-\renewcommand{\headrulewidth}{2pt}
-}
\pagestyle{plain}
@@ -194,10 +197,10 @@ Author: Christian Hupfer\(^\mathrm{\fnsymbol{footnote}}\)
\section*{Preface}
-This package is the successor and a complete rewrite of \packagename{assoccnt}. Not all features of that package are implemented yet -- if some functionality of your document depends on \packagename{assoccnt}, continue using the older version and shift gradually to \packagename{xassoccnt} please.
+This package is the successor and a complete rewrite of \packagename{assoccnt}. Not all features of that package are implemented yet -- if some functionality of your document depends on \packagename{assoccnt}, continue using the older version and shift gradually to \packagename{\PackageDocName} please.
\begin{marker}
-Most times class and package authors will benefit of this package, but there might be usual documents that need the features of |xassoccnt|
+Most times class and package authors will benefit of this package, but there might be usual documents that need the features of |\PackageDocName||
\end{marker}
\section{Introduction}
@@ -239,7 +242,20 @@ Please note, that this package does not provide means for simultaneous stepping
\begin{itemize}
-\item This package does not work really well with the \packagename{calc} package if that one is loaded after \packagename{\PackageDocName}. Load \packagename{calc} \textbf{before} \packagename{\PackageDocName}! \marginnote{\bcbombe}
+\item This package does not work really well with the \packagename{calc} package if that one is loaded after \packagename{\PackageDocName}. Load \packagename{calc} \textbf{before} \packagename{\PackageDocName}!
+
+\begin{marker}
+\tcbdocmarginnote{\bcbombe\tcbdocupdated{2015-11-10}}
+ As of version \packageversion\ \packagename{\PackageDocName} will abort compilation if \packagename{calc} is loaded after this package, but will issue a warning only if \packagename{calc} is loaded first.
+\end{marker}
+\item \packagename{\PackageDocName} and \packagename{perpage} are not compatible completely. As of version \packageversion\ it is not possible to use the command \cs{AddAbsoluteCounter} from \packagename{perpage} -- this feature is provided already by this package.
+\tcbdocmarginnote{\tcbdocnew{2015-11-10}}
+
+\begin{marker}
+ It is not recommended to use counters under control of \packagename{perpage} with the association method!
+\end{marker}
+
+% is somewhat similar to \refCom{AddAssociatedCounters} from this package but unless changed manually, the values of and \texttt{perpage} - absolute counter and an associated counter by this package differ by one, since \cs{AddAbsoluteCounter} initializes the counter value to the value of 1.
%\item This package does not work together when the Package \packagename{xifthen} is included. As of version \packageversion~I could not figure out, where the strange behaviour comes in. It's most likely an incompatibility between \packagename{etoolbox} and \packagename{xifthen}
%\marginnote{\bcbombe}
\end{itemize}
@@ -990,6 +1006,16 @@ write this documentation.
\section{Version history}
+\begin{itemize}
+
+\item
+Version 0.2
+
+Improved \cs{stepcounter} to remove some incompatibilities with the \packagename{perpage}. This is only partially managed so far.
+
+
+\item
+
Version: 0.1
A major bug fixed due to some error in usage together with \packagename{calc} when the driven counters are not stepped any longer.
@@ -999,7 +1025,7 @@ Version: 0.1
This however lead to some internal inconsistencies and it was decided to rewrite \packagename{assoccnt} with \packagename{expl3} and the features of the new \LaTeX\ 3 - Syntax.
-
+\end{itemize}
\clearpage
\phantomsection
\appendix\label{examplesappendix}