diff options
author | Karl Berry <karl@freefriends.org> | 2010-02-23 00:23:07 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2010-02-23 00:23:07 +0000 |
commit | dcd84a2a5ac4d937ebf0d5097e59cc57ede2824d (patch) | |
tree | dd64ed7f0b621edba5a755f8a56222bb36eaaebb /Master | |
parent | a55850e18060c5dc4533e74a102faa965839b7ac (diff) |
chngcntr doc update (22feb09)
git-svn-id: svn://tug.org/texlive/trunk@17157 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
-rw-r--r-- | Master/texmf-dist/doc/latex/chngcntr/chngcntr.pdf | bin | 0 -> 240269 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/chngcntr/chngcntr.tex | 76 |
2 files changed, 76 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/chngcntr/chngcntr.pdf b/Master/texmf-dist/doc/latex/chngcntr/chngcntr.pdf Binary files differnew file mode 100644 index 00000000000..c06011586ab --- /dev/null +++ b/Master/texmf-dist/doc/latex/chngcntr/chngcntr.pdf diff --git a/Master/texmf-dist/doc/latex/chngcntr/chngcntr.tex b/Master/texmf-dist/doc/latex/chngcntr/chngcntr.tex new file mode 100644 index 00000000000..ea56df098f8 --- /dev/null +++ b/Master/texmf-dist/doc/latex/chngcntr/chngcntr.tex @@ -0,0 +1,76 @@ +\documentclass[DIV=7, pagesize=auto]{scrartcl} + +\usepackage{fixltx2e} +\usepackage{etex} +\usepackage{lmodern} +\usepackage[T1]{fontenc} +\usepackage{textcomp} +\usepackage{microtype} +\usepackage[unicode=true]{hyperref} + +\newcommand*{\pkg}[1]{\textsf{#1}} +\newcommand*{\cs}[1]{\texttt{\textbackslash#1}} +\makeatletter +\newcommand*{\cmd}[1]{\cs{\expandafter\@gobble\string#1}} +\makeatother +\newcommand*{\meta}[1]{\textlangle\textsl{#1}\textrangle} +\newcommand*{\marg}[1]{\texttt{\{}\meta{#1}\texttt{\}}} +\newcommand*{\oarg}[1]{\texttt{[}\meta{#1}\texttt{]}} +\newcommand*{\ml}[1]{\leavevmode\marginline{\small#1}\ignorespaces} + +\reversemarginpar + +\addtokomafont{title}{\rmfamily} + +\title{The \pkg{chngcntr} package\thanks{This manual corresponds to \pkg{chngcntr}~v1.0a, dated~2009/09/02.}} +\author{Author: Peter Wilson\and Maintainer: Will Robertson} +\date{2009/09/02} + + +\begin{document} + +\maketitle + +\section{Usage} + +In \LaTeX, a new counter called, say `\meta{ctr}', is created by the command +\cmd{\newcounter}\marg{ctr}\oarg{within}. If the optional \meta{within} argument is given +the the counter `\meta{ctr}' is reset to zero each time the counter `\meta{within}' +changes. The command \cmd{\the\meta{ctr}} typesets the value of the counter \meta{ctr}. +This is automatically defined by \cmd{\newcounter} and is initialised +to typeset arabic numerals. + +\ml{\cmd{\counterwithin}\\\cmd{\counterwithin*}} +It is sometimes desireable to change a counter that has been defined +by \cmd{\newcounter}\marg{ctr} to act as though it had been defined as +\cmd{\newcounter}\marg{ctr}\oarg{within}. The package provides the command +\cmd{\counterwithin}\marg{ctr}\marg{within} that accomplishes this. By default, +it also redefines the \cmd{\the\meta{ctr}} command so that it typesets values +in the style \texttt{\cmd{\the\meta{within}}.\cmd{\arabic}\marg{ctr}}. The starred version of the +command suppresses the redefinition of \cmd{\the\meta{ctr}} +(e.\,g., \cmd{\counter\-within*}\verb+{ctr}{within}+). + +\ml{\cmd{\counterwithout}\\\cmd{\counterwithout*}} +Likewise, the command \cmd{\counterwithout}\marg{ctr}\marg{within} changes a +counter that has been created by \cmd{\newcounter}\marg{ctr}\oarg{within} to act +as though it had been created by \cmd{\newcounter}\marg{ctr}. By default it +also redefines the \cmd{\the\meta{ctr}} command so that it just typesets an arabic +numeral. The starred version of the command suppresses the redefinition +of \cmd{\the\meta{ctr}}. + +Any number of \cmd{\counterwithin}\marg{ctr}\marg{\ldots} and \cmd{\counterwith\-out}\marg{ctr}\marg{\ldots} +commands can be issued for a given counter, \meta{ctr}, if you wish to toggle +between the two styles. The current value of \meta{ctr} is unaffected by +\cmd{\counterwithin} and \cmd{\counterwithout}. If you want to change the value +after one of these commands, use \cmd{\set\-counter}\marg{ctr}\marg{\ldots}, and to change +the typeseting style use \cmd{\renew\-command}\texttt{\{}\cmd{\the\meta{ctr}}\texttt{\}}\marg{\ldots}. + + +\section{Change History:} + +\begin{tabular}{@{}l@{ -- }l@{}} + v1.0a & New maintainer (Will Robertson) +\end{tabular} + +\end{document} + |