summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/acro
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-01-04 22:27:40 +0000
committerKarl Berry <karl@freefriends.org>2022-01-04 22:27:40 +0000
commit13355ac3b8b66a661b20f355d5d6a5da4ea21c87 (patch)
tree6bb1922d2d21c560fc76236ad572707ccec96d44 /Master/texmf-dist/doc/latex/acro
parentc8f183597c1e8036a2111089484e2055ba9e89c3 (diff)
acro (4jan22)
git-svn-id: svn://tug.org/texlive/trunk@61488 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/acro')
-rw-r--r--Master/texmf-dist/doc/latex/acro/README4
-rw-r--r--Master/texmf-dist/doc/latex/acro/acro-manual.pdfbin889312 -> 907817 bytes
-rw-r--r--Master/texmf-dist/doc/latex/acro/acro-manual.tex48
3 files changed, 30 insertions, 22 deletions
diff --git a/Master/texmf-dist/doc/latex/acro/README b/Master/texmf-dist/doc/latex/acro/README
index b0382e13026..a4d9244e72c 100644
--- a/Master/texmf-dist/doc/latex/acro/README
+++ b/Master/texmf-dist/doc/latex/acro/README
@@ -1,5 +1,5 @@
#--------------------------------------------------------------------------
-the ACRO package v3.5 2021/01/16
+the ACRO package v3.6 2022/01/04
Typeset Acronyms
@@ -8,7 +8,7 @@ Clemens Niederberger
Web: https://github.com/cgnieder/acro
E-Mail: contact@mychemistry.eu
--------------------------------------------------------------------------
-Copyright 2012--2021 Clemens Niederberger
+Copyright 2012--2022 Clemens Niederberger
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3c
diff --git a/Master/texmf-dist/doc/latex/acro/acro-manual.pdf b/Master/texmf-dist/doc/latex/acro/acro-manual.pdf
index 54c8b151c6d..71f8b0a0067 100644
--- a/Master/texmf-dist/doc/latex/acro/acro-manual.pdf
+++ b/Master/texmf-dist/doc/latex/acro/acro-manual.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/acro/acro-manual.tex b/Master/texmf-dist/doc/latex/acro/acro-manual.tex
index b8288eb6ca7..5ccd7d2df3b 100644
--- a/Master/texmf-dist/doc/latex/acro/acro-manual.tex
+++ b/Master/texmf-dist/doc/latex/acro/acro-manual.tex
@@ -10,7 +10,7 @@
% Web: https://github.com/cgnieder/acro/
% E-Mail: contact@mychemistry.eu
% --------------------------------------------------------------------------
-% Copyright 2011--2021 Clemens Niederberger
+% Copyright 2011--2022 Clemens Niederberger
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3c
@@ -295,12 +295,11 @@ argument to \cs*{usepackage}:
The option allows you to use the last version prior to the update to
version~3. This may help if you don't have the time to fix issues after
upgrading to the new version.
- \keybool{upgrade}\Default{true}
+ \keybool{upgrade}\Default{false}
When this option is used \acro\ tries to give as much helpful and
meaningful warning or error messages when a deprecated or removed command,
property, or option is used. This is especially useful if you are
- upgrading from version~2. The option will initially be true for a few
- months after the upgrade to version~3.
+ upgrading from version~2.
\end{options}
\subsection{Setup command}\label{sec:setup-command}
@@ -355,10 +354,12 @@ following sections. This is a comprehensive overview over the existing
properties. Many properties are also explained in more detail in later
sections of this manual.
\begin{options}
- \keybool{case-sensitive}\Default{false}
+ \keybool{case-sensitive}\Default{true}
When this is set you can write the \ac{id} of the acronym upper- or lower-
or mixed case and it is recognized by \acro\ as the same. This might be
useful when the acronym appears in the page header, for example.
+ \keybool{case-insensitive}\Default{false}
+ \sinceversion{3.6}The inverse of the option \option{case-sensitive}.
\end{options}
\begin{bewareofthedog}
@@ -595,7 +596,7 @@ the same. In that case you can use
%% preset
\propval{preset}{set name}\Default
\sinceversion{3.5}Enables to load a set of properties that has been
- defined earlier with \cs{NewAcroPreset}, siehe
+ defined earlier with \cs{NewAcroPreset}, see
section~\vref{sec:presets}.
%% uselist
\propval{uselist}{csv list of acronym ids}\Default
@@ -786,7 +787,7 @@ single appearance of the acronym is printed\footnote{This usually requires at
The single appearance of an acronym is determined by this option:
\begin{options}
\keychoice{single}{\default{true},false,\meta{number}}\Default{false}
- This option determines wether a single appearance of an acronym counts as
+ This option determines whether a single appearance of an acronym counts as
\emph{usage}. It might be desirable in such cases that an acronym is
simply printed as long form and not added to the list of acronym. This is
what this option does. With \meta{number} the minimal number of usages
@@ -843,15 +844,15 @@ The main idea is simple: just place
\end{commands}
The options controlling the list are these:
\begin{options}
- \keychoice{template}{description,table,longtable,lof,toc}%
+ \keychoice{template}{description,tabular,longtable,supertabular,lof,toc}%
\Module{list}\Default{description}
Choose the template to create the list with. See more on this in
sections~\vref{sec:templates} and~\vref{sec:examples}.
\keybool{sort}\Module{list}\Default{true}
- Decide wether to sort the list of acronyms alphabetically or to print it
+ Decide whether to sort the list of acronyms alphabetically or to print it
in order of definition.
\keychoice{display}{all,used}\Module{list}\Default{used}
- Decide wether to print only the acronyms actually used in the document or
+ Decide whether to print only the acronyms actually used in the document or
all acronyms which have been declared in the preamble.
\keyval{exclude}{csv list of tags}\Module{list}\Default
Set a list of tags to exclude from the list. Only acronyms not
@@ -879,7 +880,7 @@ The options controlling the list are these:
This only has an effect if the list template supports it. All pre-defined
templates \emph{do} support it.
\keybool{display}\Module{list,locale}\Default{false}
- This options determines wether the language of the foreign form is printed
+ This options determines whether the language of the foreign form is printed
or not.
This only has an effect if the list template supports foreign forms. All
@@ -900,9 +901,10 @@ If you want to include the page numbers where the acronyms have been used in
the list of acronym you can use these options:
\begin{options}
\keychoice{display}{first,all,none}\Module{pages}\Default{none}
- Decide wether to include page numbers in the list of acroynms and wether
- to add the first page or every page. When you choose \code{first} and
- have \pkg{hyperref} loaded you will also get a backlink to that page.
+ Decide whether to include page numbers in the list of acroynms and
+ whether to add the first page or every page. When you choose
+ \code{first} and have \pkg{hyperref} loaded you will also get a
+ backlink to that page.
\keybool{use}\Module{pages,seq}\Default{true}
Turns a two-page range into \meta{num}\,f.\ (\latin{sequens}) and a
three-page range into \meta{num}\,ff.\ (\latin{sequentes}) when set to
@@ -1236,12 +1238,12 @@ properties for such cases:
There are also some options:
\begin{options}
\keybool{display}\Module{foreign}\Default{true}
- Determine wether to hide or display the foreign form.
+ Determine whether to hide or display the foreign form.
\keybool{display}\Module{list,foreign}\Default{true}
- \sinceversion{3.2}Determine wether to hide or display the foreign form in
+ \sinceversion{3.2}Determine whether to hide or display the foreign form in
the list of acronyms.
\keybool{display}\Module{locale}\Default{false}
- This options determines wether the language of the foreign form is printed
+ This options determines whether the language of the foreign form is printed
or not when the full form of the acronym is printed.
\keybool{display}\Module{list,locale}\Default{false}
The same but for the list of acronyms.
@@ -1368,11 +1370,11 @@ like these \acro\ offers a number of options:\acuse{ny}
\keyval{cmd}{citation command}\Module{cite}\Default{\cs*{cite}}
Choose the command with which citations ar printed.
\keybool{group}\Module{cite}\Default{false}
- Decide wether to group citations with the short form in the parentheses.
+ Decide whether to group citations with the short form in the parentheses.
The template must support this. \acro's pre-defined templates \emph{do}
support it.
\keychoice{display}{first,all,none}\Module{cite}\Default{first}
- Decide wether to output the citation in the first/full usage only or
+ Decide whether to output the citation in the first/full usage only or
always or never.
\keyval{pre}{text}\Module{cite}\Default{\cs*{nobreakspace}}
Arbitrary code directly output before the citation.
@@ -1931,8 +1933,14 @@ to defines own such objects:
\tmpl{addchap}
Only defined in a \KOMAScript\ class and if \cs*{chapter} is defined. Uses
\cs*{addchap} for the heading.
+ \tmpl{addchap*}
+ \sinceversion{3.6}Only defined in a \KOMAScript\ class and if
+ \cs*{chapter} is defined. Uses \cs*{addchap*} for the heading.
\tmpl{addsec}
Only defined in a \KOMAScript\ class. Uses \cs*{addsec} for the heading.
+ \tmpl{addsec*}
+ \sinceversion{3.6}Only defined in a \KOMAScript\ class. Uses \cs*{addsec*}
+ for the heading.
\tmpl{chapter}
Only defined if \cs*{chapter} is defined. Uses \cs*{chapter} for the heading.
\tmpl{chapter*}
@@ -1953,7 +1961,7 @@ For the definition of templates these commends are available:
which inserts \meta{code} when used. A template of type \meta{type} with
name \meta{name} must not exist. The default type is \code{acronym}.
\command{RenewAcroTemplate}[\oarg{type}\marg{name}\marg{code}]
- This re-defines a template of type \meta{type} woth the name \meta{name}
+ This re-defines a template of type \meta{type} with the name \meta{name}
which inserts \meta{code} when used. A template of type \meta{type} with
name \meta{name} must exist. The default type is \code{acronym}.
\command{SetupAcroTemplate}[\oarg{type}\marg{name}\marg{code}]