From a067ac95d311257396b00e472c84f8c8d069db02 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 14 Mar 2016 21:24:09 +0000 Subject: acro (14mar16) git-svn-id: svn://tug.org/texlive/trunk@40022 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/acro/README | 4 +- Master/texmf-dist/doc/latex/acro/acro_en.pdf | Bin 555909 -> 544763 bytes Master/texmf-dist/doc/latex/acro/acro_en.tex | 143 +++++++++++++++++---------- 3 files changed, 93 insertions(+), 54 deletions(-) (limited to 'Master/texmf-dist/doc/latex/acro') diff --git a/Master/texmf-dist/doc/latex/acro/README b/Master/texmf-dist/doc/latex/acro/README index baf376efc9f..d20ee643b21 100644 --- a/Master/texmf-dist/doc/latex/acro/README +++ b/Master/texmf-dist/doc/latex/acro/README @@ -1,9 +1,9 @@ -------------------------------------------------------------------------- -the ACRO package v2.2c +the ACRO package v2.3 Typeset Acronyms -2016/02/02 +2016/03/14 -------------------------------------------------------------------------- Clemens Niederberger Web: http://www.mychemistry.eu/forums/forum/acro/ diff --git a/Master/texmf-dist/doc/latex/acro/acro_en.pdf b/Master/texmf-dist/doc/latex/acro/acro_en.pdf index 181eeec0cc3..5012ce361e9 100644 Binary files a/Master/texmf-dist/doc/latex/acro/acro_en.pdf and b/Master/texmf-dist/doc/latex/acro/acro_en.pdf differ diff --git a/Master/texmf-dist/doc/latex/acro/acro_en.tex b/Master/texmf-dist/doc/latex/acro/acro_en.tex index f6ea1e12ee5..102da540681 100644 --- a/Master/texmf-dist/doc/latex/acro/acro_en.tex +++ b/Master/texmf-dist/doc/latex/acro/acro_en.tex @@ -1,8 +1,8 @@ % arara: pdflatex -% !arara: biber +% arara: biber +% arara: pdflatex % arara: pdflatex % arara: pdflatex -% !arara: pdflatex % -------------------------------------------------------------------------- % the ACRO package % @@ -187,7 +187,8 @@ { short = ECU , long = Steuerger\"at , - foreign = Electronic Control Unit + foreign = Electronic Control Unit , + foreign-lang = english } \DeclareAcronym{id} { @@ -308,46 +309,46 @@ \pkg{zref-abspage}\footnote{\CTANurl{oberdiek}} and \needpackage{translations}~\cite{pkg:translations}. -\section{About} -\begin{cnltxquote}[\cite{wikipedia}] - Acronyms and initialisms are abbreviations formed from the initial - components in a phrase or a word. These components may be individual - letters (as in CEO) or parts of words (as in Benelux and Ameslan). There is - no universal agreement on the precise definition of the various terms nor on - written usage. -\end{cnltxquote} -After \wikipedia{} told us what acronyms are and we won't confuse them with -units or other kinds of abbreviations -- why would we need another package for -them? There are several already: \pkg{acronym}~\cite{pkg:acronym}, -\pkg{acromake}~\cite{pkg:acromake}, \pkg{acroterm}~\cite{pkg:acroterm}, the -abbreviations package \pkg{abbrevs}~\cite{pkg:abbrevs} (the current version -1.4 has a bug\footnote{see \url{http://tex.stackexchange.com/q/59840/5049} for - solutions.}, though), the nomenclature package -\pkg{nomencl}~\cite{pkg:nomencl}, and of course the mighty -\pkg{glossaries}~\cite{pkg:glossaries}. So there is really no \emph{need} for -a new package. - -On the other hand \pkg{acronym}, the best of the acronym specific packages, -has one or two shortcomings and sometimes using \pkg{glossaries} seems a bit -of an overkill (or simply inconvenient as one has to run -\code{makeglossaries}, \code{makeindex} or \code{xindy}, then\footnote{Rumour - has it there is going to be a version that can be used without running an - external program}). So \acro\ stands somewhere in between (but closer to -\pkg{acronym}). - -The main reason for the existance of \acro\ is a question on \acs{tex.sx}% -\footnote{\url{http://tex.stackexchange.com/q/59449/5049}} which intrigued me -and in consequence led to \acro\ and it's option \option{single}. - -\acro\ has many similarities with the \pkg{acronym} package. In fact, quite -some macros have the same name and meaning\footnote{\emph{Not} in the sense of - \cs*{meaning}!}. - -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 \pkg{glossaries}, then. Are you planning to add a nomenclature? You -may want to choose \pkg{nomencl} (or again: \pkg{glossaries}) and so on. -\acro\ does a good job for lists of abbreviations. +% \section{About} +% \begin{cnltxquote}[\cite{wikipedia}] +% Acronyms and initialisms are abbreviations formed from the initial +% components in a phrase or a word. These components may be individual +% letters (as in CEO) or parts of words (as in Benelux and Ameslan). There is +% no universal agreement on the precise definition of the various terms nor on +% written usage. +% \end{cnltxquote} +% After \wikipedia{} told us what acronyms are and we won't confuse them with +% units or other kinds of abbreviations -- why would we need another package for +% them? There are several already: \pkg{acronym}~\cite{pkg:acronym}, +% \pkg{acromake}~\cite{pkg:acromake}, \pkg{acroterm}~\cite{pkg:acroterm}, the +% abbreviations package \pkg{abbrevs}~\cite{pkg:abbrevs} (the current version +% 1.4 has a bug\footnote{see \url{http://tex.stackexchange.com/q/59840/5049} for +% solutions.}, though), the nomenclature package +% \pkg{nomencl}~\cite{pkg:nomencl}, and of course the mighty +% \pkg{glossaries}~\cite{pkg:glossaries}. So there is really no \emph{need} for +% a new package. + +% On the other hand \pkg{acronym}, the best of the acronym specific packages, +% has one or two shortcomings and sometimes using \pkg{glossaries} seems a bit +% of an overkill (or simply inconvenient as one has to run +% \code{makeglossaries}, \code{makeindex} or \code{xindy}, then\footnote{Rumour +% has it there is going to be a version that can be used without running an +% external program}). So \acro\ stands somewhere in between (but closer to +% \pkg{acronym}). + +% The main reason for the existance of \acro\ is a question on \acs{tex.sx}% +% \footnote{\url{http://tex.stackexchange.com/q/59449/5049}} which intrigued me +% and in consequence led to \acro\ and it's option \option{single}. + +% \acro\ has many similarities with the \pkg{acronym} package. In fact, quite +% some macros have the same name and meaning\footnote{\emph{Not} in the sense of +% \cs*{meaning}!}. + +% 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 \pkg{glossaries}, then. Are you planning to add a nomenclature? You +% may want to choose \pkg{nomencl} (or again: \pkg{glossaries}) and so on. +% \acro\ does a good job for lists of abbreviations. \section{Basics} \subsection{Creating New Acronyms} @@ -423,6 +424,19 @@ documentation. \keyval{foreign}{original long form} \sinceversion{1.3}can be useful when dealing with acronyms in foreign languages, see section~\vref{ssec:foreign} for details. + %% foreign-lang + \keyval{foreign-lang}{language} + \sinceversion{2.3}the \pkg{babel}~\cite{pkg:babel} or + \pkg{polyglossia}~\cite{pkg:polyglossia} language of the foreign form. + This language is used to wrap the entry with + \cs*{foreignlanguage}\marg{language} if either \pkg{babel} or + \pkg{polyglossia} is loaded. You'll need to take care that the + corresponding language is loaded by \pkg{babel} or \pkg{polyglossia}. + %% single + \keyval{single}{text} + \sinceversion{2.3}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 + \keyis{single}{true} is active. %% sort \keyval{sort}{text} if used the acronym will be sorted according to this key instead of its @@ -444,6 +458,15 @@ documentation. \keyval{first-long-format}{\TeX{} code} the format used for the first long form of the acronym as set with \cs{ac}, \cs{acf} or \cs{acflike} and their uppercase, plural and indefinite forms. + %% single-format + \keyval{single-format}{\TeX{} code} + \sinceversion{2.3}the format used for the acronym if the acronym is only + used a single time. + %% first-style + \keychoice{first-style}{default,plain,empty,square,short,reversed,plain-reversed,% + footnote,sidenote} + \sinceversion{2.3}the style of the first appearance of the acronym, see + also section~\ref{sec:opti-regard-acronyms}. %% pdfstring \keylit{pdfstring}{\Marg{\meta{text}/\meta{plural ending}}} used as \acs{pdf} string replacement in bookmarks when used together with the @@ -703,11 +726,16 @@ document: \ac{ecu}\\ \ac{ecu} \end{example} -That's why I decided to add the following key: +That's why I decided to add the following properties: \begin{options} \keyval{foreign}{original long form} A description for an acronym originating in another language than the document language. + \keyval{foreign-lang}{language} + \sinceversion{2.3}The \pkg{babel}~\cite{pkg:babel} or + \pkg{polyglossia}~\cite{pkg:polyglossia} language of the foreign form. + This language is used to wrap the entry with + \cs*{foreignlanguage}\marg{language}. \end{options} Here is the definition of the above mentioned \ac{ecu} acronym: @@ -715,7 +743,8 @@ Here is the definition of the above mentioned \ac{ecu} acronym: \DeclareAcronym{ecu}{ short = ECU , long = Steuerger\"at , - foreign = Electronic Control Unit + foreign = Electronic Control Unit , + foreign-lang = english } \end{sourcecode} As you have seen this adds the \option{foreign} entry to the first appearance @@ -1154,7 +1183,7 @@ options or via the setup command: we could have used these before: \nato, \ny \end{example} -\subsection{Options Regarding Acronyms} +\subsection{Options Regarding Acronyms}\label{sec:opti-regard-acronyms} The options described in this section all influence the layout of one of the possible output forms of the acronyms. \begin{options} @@ -1172,6 +1201,11 @@ possible output forms of the acronyms. The format for the \option{foreign} entry when it appears as part of the first appearance of an acronym. %% + \keyval{single-format}{format}\Default + \sinceversion{2.3}% + The format for the acronym when it is used only once. If not specified + the formatting according to \option{single-form} is used. + %% \keyval{first-long-format}{format}\Default \sinceversion{1.2}% The format for the long form on first usage (with \cs{ac}, \cs{acf} or @@ -1182,6 +1216,10 @@ possible output forms of the acronyms. not used this is the same as \option{short-format}. Please be aware that a call of \option{short-format} after this one will overwrite it again. %% + \keyval{list-short-width}{dim}\Default{3em} + \sinceversion{2.1}This option controls the width reserved for the short + forms of the acronyms in the \code{lof} list style. + %% \keyval{list-long-format}{format}\Default An extra format for the long entries in the list. If not used this is the same as \option{long-format}. Please be aware that a call of @@ -1418,12 +1456,13 @@ written to the \code{aux} file and only read in during the next run. \section{Language Support} -\acro\ detects if packages \pkg*{babel} or \pkg*{polyglossia} are being loaded -and tries to adapt certain strings to match the chosen language. However, due -to my limited language knowledge only a few translations are provided. I'll -show how the English translations are defined so you can add the translations -to your preamble if needed. Even better would be you'd send me a short email -at \href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu} with the +\acro\ detects if packages \pkg{babel}~\cite{pkg:babel} or +\pkg{polyglossia}~\cite{pkg:babel} are being loaded and tries to adapt certain +strings to match the chosen language. However, due to my limited language +knowledge only a few translations are provided. I'll show how the English +translations are defined so you can add the translations to your preamble if +needed. Even better would be you'd send me a short email at +\href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu} with the appropriate translations for your language and I'll add them to \acro. \begin{sourcecode} -- cgit v1.2.3