summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/acro/acro-manual.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/acro/acro-manual.tex')
-rw-r--r--macros/latex/contrib/acro/acro-manual.tex50
1 files changed, 30 insertions, 20 deletions
diff --git a/macros/latex/contrib/acro/acro-manual.tex b/macros/latex/contrib/acro/acro-manual.tex
index 49ea2727da..357d3b2d94 100644
--- a/macros/latex/contrib/acro/acro-manual.tex
+++ b/macros/latex/contrib/acro/acro-manual.tex
@@ -18,7 +18,7 @@
% and version 1.3c or later is part of all distributions of LaTeX
% version 2008/05/04 or later.
%
-% This work has nce status `maintained'.
+% This work has the LPPL maintenance status `maintained'.
%
% The Current Maintainer of this work is Clemens Niederberger.
% --------------------------------------------------------------------------
@@ -499,9 +499,9 @@ the same. In that case you can use
\propval{foreign-format}{code}\Default
The format used for the foreign form of the acronym.
%% single-format
- \propval{single-format}{code}\Default={long-format}
- The format used for the acronym if the acronym is only used a single
- time.
+ % \propval{single-format}{code}\Default={long-format}
+ % The format used for the acronym if the acronym is only used a single
+ % time.
%% list-format
\propval{list-format}{code}\Default={long-format}
The format used for the long form of the acronym in the list if the list
@@ -762,13 +762,15 @@ The single appearance of an acronym is determined by this option:
If you like you can also set the single appearance of an acronym individually:
\begin{properties}
- \propval{single}{text}\Default={long}
- If provided \meta{text} will be used instead of the long form if the
- acronym is only used a single time \emph{and} the option
- \option{single} has been set.
- \propval{single-format}{code}\Default={long-format}
- The format used for the acronym if the acronym is only used a single
- time.
+ \propval{single}{text}\Default
+ If provided \meta{text} will be used instead of whatever template
+ (\enquote{style}) has been set for the single appearance if the acronym is
+ only used a single time \emph{and} the option \option{single} has been
+ set\footnote{Actually the template \template{single} is used which
+ typesets the \property{single} property.}.
+ % \propval{single-format}{code}\Default={long-format}
+ % The format used for the acronym if the acronym is only used a single
+ % time.
\propchoice{single-style}{long-short,short-long,short,long,footnote}\Default
The style of the single appearance of the acronym.
\end{properties}
@@ -874,6 +876,11 @@ the list of acronym you can use these options:
\keybool{name}\Module{pages}\Default{false}
If set to true the page numbers are preceded with p.\ or pp.
\end{options}
+Additionally\sinceversion{3.3} to setting these options with \cs{acsetup} they
+can be set as options to \cs{printacronyms}:
+\begin{sourcecode}
+ \printacronyms[pages={display=all,seq/use=false}]
+\end{sourcecode}
\subsection{Filter lists using tags}\label{sec:lists-tags}
With the property \property{tag} you can assign one or more tags to an
@@ -1018,11 +1025,12 @@ also give each acronym its own formatting individually:
The style of a single appearance of the acronym, see also
section~\vref{sec:single-appe-an}.
\end{properties}
-Per default the individual formatting instructions are \emph{additive} to the
-global ones. This can be changed through the option
+Per\changedversion{3.3} default the individual formatting instructions
+\emph{replace} the global ones. This can be changed through the option
\begin{options}
- \keybool{replace}\Module{format}\Default{false}
- With this option active local options will \emph{replace} the global ones.
+ \keybool{replace}\Module{format}\Default{true}
+ With this option active local options will \emph{replace} the global
+ ones.
\end{options}
Let's see an example:
@@ -1036,7 +1044,7 @@ Let's see an example:
\begin{example}
\acsetup{format = \itshape}
\acf{pdf} \par
- \acsetup{format/replace=true}
+ \acsetup{format/replace=false}
\acf{pdf}
\end{example}
@@ -1381,6 +1389,8 @@ This manual is an example for the indexing feature. Each acronym from
section~\vref{sec:acronyms} that has been used in this manual is also listed
in the index.
+%% TODO: document the label property
+
\section{Barriers}\label{sec:barriers}
The main purpose of the concept of barriers is to be able to have \emph{local}
lists of acronyms. This concept does a little bit more than that, though,
@@ -1815,15 +1825,15 @@ to defines own such objects:
\tmpl{long-short}
A template for the first appearance where the long form is printed and the
short form follows in parentheses.
- \tmpl{first}
- This is a \emph{pseudo} template which always displays what is
- set through the \option{single-style} or the property
- \property{single-style}.
\tmpl{short}
Display the short form of an acronym.
\tmpl{short-long}
A template for the first appearance where the short form is printed and the
long form follows in parentheses.
+ \tmpl{single}
+ A template which is used when the property \property{single} has been set
+ \emph{and} the option \option{single} has been set \emph{and} if the
+ acronym is only used a single time.
\tmpl{show}
A template which writes all properties of an acronym into the log file.
\end{templates}