acro (6may13)

git-svn-id: svn://tug.org/texlive/trunk@30248 c570f23f-e606-0410-a88d-b1316a301751

3 files changed, 107 insertions, 49 deletions

diff --git a/Master/texmf-dist/doc/latex/acro/README b/Master/texmf-dist/doc/latex/acro/README
index 7c6ef9d0199..6ea84b6b0fb 100644
--- a/Master/texmf-dist/doc/latex/acro/README
+++ b/Master/texmf-dist/doc/latex/acro/README
@@ -1,9 +1,9 @@
 --------------------------------------------------------------------------
-the ACRO package v1.2a
+the ACRO package v1.3
 
   Typeset Acronyms
 
-2013/04/04
+2013/05/06
 --------------------------------------------------------------------------
 Clemens Niederberger
 Web:    https://bitbucket.org/cgnieder/acro/
diff --git a/Master/texmf-dist/doc/latex/acro/acro_en.pdf b/Master/texmf-dist/doc/latex/acro/acro_en.pdf
index 8a9aab7756e..ea5ff1f0aaa 100644
--- a/Master/texmf-dist/doc/latex/acro/acro_en.pdf
+++ b/Master/texmf-dist/doc/latex/acro/acro_en.pdf
diff --git a/Master/texmf-dist/doc/latex/acro/acro_en.tex b/Master/texmf-dist/doc/latex/acro/acro_en.tex
index 28d3f2aa069..905ba1c3b3c 100644
--- a/Master/texmf-dist/doc/latex/acro/acro_en.tex
+++ b/Master/texmf-dist/doc/latex/acro/acro_en.tex
@@ -38,6 +38,7 @@
 %    https://bitbucket.org/cgnieder/cnpkgdoc/
 % the class is licensed LPPL 1.3 or later
 %
+\PassOptionsToPackage{supstfm=libertinesups}{superiors}
 \documentclass[DIV10,toc=index,toc=bib,hyperfootnotes=false]{cnpkgdoc}
 \docsetup{
   pkg = {[single,macros,accsupp,index]acro} ,
@@ -53,6 +54,7 @@
 
 \acsetup{hyperref}
 \cnpkgusecolorscheme{friendly}
+\usepackage{libertinehologopatch}
 \usepackage{fnpct}
 \renewcommand*\othersectionlevelsformat[3]{%
   \textcolor{main}{#3\autodot}\enskip}
@@ -154,7 +156,7 @@
  suffix_3p "\\nohyperpage{\\,ff.}"
 \end{filecontents*}
 \indexsetup{noclearpage,othercode=\footnotesize}
-\makeindex[options={-s \jobname.ist},intoc,columns=3]
+\makeindex[options={-s \jobname.ist},intoc,columns=3,columnsep=1em]
 
 \TitlePicture{\parbox{.75\linewidth}{%
   \acro not only allows you to create acronyms in a simple way but also lets you
@@ -192,6 +194,12 @@
     long         = Compact Disc ,
     short-format = \scshape
   }
+\DeclareAcronym{ecu}
+  {
+    short   = ECU ,
+    long    = Steuergerät ,
+    foreign = Electronic Control Unit
+  }
 \DeclareAcronym{id}
   {
     short        = id ,
@@ -304,8 +312,8 @@ terms of the \LaTeX{} Project Public License, version 1.3 or later
 
 \acro loads and needs the following packages: \paket*{expl3}\footnote{\CTANurl{l3kernel}},
 \paket*{xparse}, \paket*{xtemplate}, \paket*{l3keys2e}\footnote{All three part of
-the \CTANlink{l3packages} bundle} and \paket*{translations}\footnote{Part of the
-\CTANlink{exsheets} bundle.}.
+the \CTANlink{l3packages} bundle}, \paket{zref-abspage} and \paket*{translations}%
+\footnote{Part of the \CTANlink{exsheets} bundle.}.
 
 \section{About}
 \begin{zitat}[\cite{wikipedia}]
@@ -342,7 +350,8 @@ some macros have the same name and meaning\footnote{\emph{Not} in the sense of
 Please take a minute to think and decide which package will suit your needs
 best. Are you planning to add a glossary to your book? You should probably go
 with \paket{glossaries}, then. Are you planning to add a nomenclature? You
-may want to choose \paket{nomencl} and so on\ldots
+may want to choose \paket{nomencl} (or again: \paket{glossaries}) and so on.
+\acro does a good job for lists of abbreviations.
 
 
 \section{Updating from Version~0.\versionstar}
@@ -355,7 +364,7 @@ Versions~0.\versionstar{} also set labels when an acronym was used the first tim
 version~1.0 doesn't do that any more. \key{version}{0} sets them as expected.
 
 Note that \key{version}{0} \emph{does not and will not} support new features of
-any kind.
+any kind, at least not explicitly.
 
 With version~1.0 acronyms are declared with a key/value syntax similar to the
 way in package \paket{glossaries} glossary entries are defined. This was made
@@ -417,6 +426,11 @@ are not described immediately but at appropriate places in the documentation.
  %% extra
  \Option{extra}{<text>}\newline
    extra information to be added in the list of acronyms.
+ %% foreign
+ \Option{foreign}{<original long form>}\newline
+   \sinceversion{1.3}%
+   can be useful when dealing with acronyms in foreign languages, see
+   section~\ref{ssec:foreign} for details.
  %% sort
  \Option{sort}{<text>}\newline
    if used the acronym will be sorted according to this key instead of its \acs{id}.
@@ -666,6 +680,40 @@ for the impact of the following example.
  across North America and Europe, the newest of which, Albania and
  Croatia, joined in April 2009.
 \end{beispiel}
+
+\subsection{Foreign Language Acronyms}\secidx[foreign language acronyms]{Basics}\label{ssec:foreign}
+\noindent\sinceversion{1.3}I repeatedly read the wish for being able to add
+translations to acronyms when the acronyms stem from another language than
+the document language, \textit{i.e.}, something like the following in a German
+document:
+\begin{beispiel}
+ \ac{ecu}\\
+ \ac{ecu}
+\end{beispiel}
+That's why I decided to add the following key:
+\begin{beschreibung}
+ \Option{foreign}{<original long form>}
+\end{beschreibung}
+
+Here is the definition of the above mentioned \ac{ecu} acronym:
+\begin{beispiel}[code only]
+ \DeclareAcronym{ecu}
+   {
+     short   = ECU ,
+     long    = Steuergerät ,
+     foreign = Electronic Control Unit
+   }
+\end{beispiel}
+As you have seen this adds the \key{foreign} entry to the first appearance of
+an acronym. It is also added in parentheses to the list of acronyms after the
+\key{long} entry. Actually the entry there is the argument to the following
+command:
+\begin{beschreibung}
+ \Befehl{acroenparen}{<arg>}\newline
+   Places \code{<arg>} in parentheses: \cmd{acroenparen}{example}:
+   \acroenparen{example}. See page~\pageref{key:list-foreign-format} for a way
+   to customize this other than redefining it.
+\end{beschreibung}
 \secidx*{Basics}
 
 \section{Additional Commands and Possibilities}\secidx{Additional Commands}
@@ -815,10 +863,10 @@ should get uppercase letters instead of lowercase ones.
 \noindent\sinceversion{1.1}\acro has the package option \key{index}. If it is
 used an index entry will be recorded every time an \emph{unstarred} acronym
 command is used. The index entry will be \code{<id>@<short>}, \code{<sort>@<short>}
-if the \key{sort} key has been set, \code{<index-sort>@<short>}if the
+if the \key{sort} key has been set, \code{<index-sort>@<short>} if the
 \key{index-sort} has been set, or \code{<index>} if the key \key{index} has been
-set for the specific acronym. The short version appearing there are formatted
-according to the chosen format, of course.
+set for the specific acronym. The short versions appearing there are formatted
+according to the chosen format of the corresponding acronym, of course.
 
 This document demonstrates the feature. You can find every acronym that has been
 declared in the index. In order to allow flexibility the indexing command can be
@@ -847,8 +895,10 @@ The commands takes a few options, namely the following ones:
    be in the list.
  \Option{name}{<name of the list>}\newline
    sets the name for the list.
- \Option{header}{<sectioning command without leading backslash>}\Default{section*}
-   sets the sectioning command for the header of the list.
+ \Option{heading}{<sectioning command without leading backslash>}\Default{section*}
+   \changedversion{1.3}sets the sectioning command for the heading of the list.
+ \Option{sort}{\default{true}|false}\Default{true}
+   \sinceversion{1.3}set sorting for the list only.
 \end{beschreibung}
 \begin{beispiel}[code only]
  \acsetup{extra-style=comma}
@@ -881,7 +931,7 @@ There are a few options which change the general behaviour of \acro.
    prior to v1.0.
  %%
  \Option{single}{\default{true}|false}\Default{false}
-   If set to \code{true} an acronym that's used only once '(with \cmd{ac}) in a
+   If set to \code{true} an acronym that's used only once (with \cmd{ac}) in a
    document will only print the long form and will not be printed in the list.
  %%
  \Option{hyperref}{\default{true}|false}\Default{false}
@@ -890,8 +940,8 @@ There are a few options which change the general behaviour of \acro.
  %%
  \Option{record-pages}{\default{true}|false}\Default{true}
    Since \acro can handle arabic, roman and Roman page numbers but \emph{not}
-   any other kind of numbering this option enables to turn the page number
-   recording of for these cases as it would lead to errors else. This affects
+   any other kind of numbering this option allows to turn the page number
+   recording off for these cases as it would lead to errors else. This affects
    the whole document and can only be set in the preamble! It means you cannot
    have page numbers in the list of acronyms in this case.
  %%
@@ -986,6 +1036,11 @@ possible output forms of the acronyms.
  \Option{long-format}{<format>}\Default
    The same for the long forms.
  %%
+ \Option{foreign-format}{<format>}\Default
+   \sinceversion{1.3}%
+   The format for the \key{foreign} entry when it appears as part of the first
+   appearance of an acronym.
+ %%
  \Option{first-long-format}{<format>}\Default
    \sinceversion{1.2}%
    The format for the long form on first usage (with \cmd{ac}, \cmd{acf} or
@@ -1001,6 +1056,10 @@ possible output forms of the acronyms.
    as \key{long-format}. Please be aware that a call of \key{long-format} after
    this one will overwrite it again.
  %%
+ \Option{list-foreign-format}{<format>}\Default{\cmd{acroenparen}}
+   The format for the \key{foreign} entry as it appears in the list. This may be
+   code that ends with a macro that takes a mandatory argument.
+ %%
  \Option{extra-format}{<format>}\Default
    The same for the extra information.
  %%
@@ -1055,18 +1114,24 @@ possible output forms of the acronyms.
    time being there are many translations missing, yet. Please notify me if you
    find your language missing.
  %%
- \Option{page-ranges}{\default{true}|false}\Default{true}
-   \sinceversion{1.0}If set to \code{false} ranges will be set by appending
-   \code{f} or \code{ff}, respectively.
+ \Option{following-page}{\default{true}|false}\Default{false}
+   \sinceversion{1.3}If set to \code{true} a page range in the list of acronyms
+   that consists of two pages will be written by the first page and an appended
+   \code{f}. This depends on the option \key{next-page}.
+ %%
+ \Option{following-pages}{\default{true}|false}\Default{false}
+   \sinceversion{1.3}If set to \code{true} a page range in the list of acronyms
+   that set consists of more than two pages will be written by the first page
+   and an appended \code{ff}. This depends on the option \key{next-pages}.
  %%
  \Option{next-page}{<text>}\Default{\cmd*{,}f.\cmd*{@}}
-   \sinceversion{1.0}Appended to a page number when \key{page-ranges} is set to
+   \sinceversion{1.0}Appended to a page number when \key{following-page} is set to
    \code{false} and the range is only 2 pages long. This is automatically
    translated to the active language. However, for the time being there are many
    translations missing, yet. Please notify me if you find your language missing.
  %%
  \Option{next-pages}{<text>}\Default{\cmd*{,}ff.\cmd*{@}}
-   \sinceversion{1.0}Appended to a page number when \key{page-ranges} is set to
+   \sinceversion{1.0}Appended to a page number when \key{following-pages} is set to
    \code{false} and the range is more than 2 pages long. This is automatically
    translated to the active language. However, for the time being there are many
    translations missing, yet. Please notify me if you find your language missing.
@@ -1084,13 +1149,13 @@ possible output forms of the acronyms.
    The values \code{extra-longtable} and \code{extra-longtable-rev} put the extra
    information in a column of its own.
  %%
- \Option{list-header}{chapter|chapter*|section|section*|subsection|subsection*|\\
+ \Option{list-heading}{chapter|chapter*|section|section*|subsection|subsection*|\\
    addchap|addsec}\Default{section*}
-   \changedversion{1.1}The header type of the list. The last two only work with
+   \changedversion{1.3}The heading type of the list. The last two only work with
    a \KOMAScript{} class that also defines the appropriate command.
  %%
  \Option{list-name}{<list name>}\Default{Acronyms}
-   The name of the list. This is what's written in the list-header. This is
+   The name of the list. This is what's written in the list-heading. This is
    automatically translated to the active language. However, for the time being
    there are many translations missing, yet. Please notify me if you find your
    language missing.
@@ -1131,18 +1196,11 @@ pages an acronym appeared on. With \paket{hyperref} the pages are referenced
 using \cmd*{hyperpage}.
 
 There are some options that control how this list will be typeset, e.g.,
-\key{page-ranges}, \key{next-pages} or the option \key{page-ref} itself. It is
-important to mention that the page list will always take two compilation runs
-until changes in the options or the actual page numbers affect it. This is due to
-the fact that the updated sequence is first written to the \code{aux} file and
-only read in during the next run.
-
-There is another important fact: \acro can only handle arabic and lowercase and
-uppercase roman page numbering. If you happen to choose a different numbering
-style you either have to use the package option \key{record-pages}{false} which
-means you will have to pass on page numbers in the list of acronyms, or you need
-to make sure that you only use the \emph{starred} versions of the \cmd{ac} commands
-on these pages so acronyms don't count as used there!
+\key{following-page}, \key{next-pages} or the option \key{page-ref} itself. It is
+important to mention that the page list will always take at least two compilation
+runs until changes in the options or the actual page numbers affect it. This is
+due to the fact that the updated sequence is first written to the \code{aux} file
+and only read in during the next run.
 \secidx*{About Page Ranges}
 
 \section{Language Support}\secidx{Language Support}
@@ -1200,29 +1258,29 @@ description ask me for the documentation to version~0.6a.
 \section{All Acronyms Used in this Documentation}\label{sec:documentation_acronyms}
 \begin{beispiel}[code only]
  \acsetup{
-   list-type   = table,
-   list-style  = longtable,
-   list-header = subsection*,
-   extra-style = comma,
-   page-ref    = comma
+   list-type    = table,
+   list-style   = longtable,
+   list-heading = subsection*,
+   extra-style  = comma,
+   page-ref     = comma
  }
  \printacronyms[name=All Acronyms]
 \end{beispiel}
 \acsetup{
-  list-type   = table,
-  list-style  = longtable,
-  list-header = subsection*,
-  extra-style = comma,
-  page-ref    = comma
+  list-type    = table,
+  list-style   = longtable,
+  list-heading = subsection*,
+  extra-style  = comma,
+  page-ref     = comma
 }
 \printacronyms[name=All Acronyms]
 
 \begin{beispiel}[code only]
  \acsetup{
-   list-type   = table,
-   list-style  = longtable,
-   list-header = subsection*,
-   page-ref    = comma
+   list-type    = table,
+   list-style   = longtable,
+   list-heading = subsection*,
+   page-ref     = comma
  }
  \printacronyms[include-classes=city,name=City Acronyms]
 \end{beispiel}