summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/acro
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-09-06 23:19:31 +0000
committerKarl Berry <karl@freefriends.org>2015-09-06 23:19:31 +0000
commit1b2ecd77871ef20cc07ab3df20ccbce3660456d8 (patch)
treeda997d2518099d6084b6aea406cfa6d64eff2c8c /Master/texmf-dist/doc/latex/acro
parent3cb4e75696df6c7abebf17fbc606ca86dcdfb520 (diff)
acro (6sep15)
git-svn-id: svn://tug.org/texlive/trunk@38306 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/acro')
-rw-r--r--Master/texmf-dist/doc/latex/acro/README6
-rw-r--r--Master/texmf-dist/doc/latex/acro/acro_en.pdfbin541464 -> 547227 bytes
-rw-r--r--Master/texmf-dist/doc/latex/acro/acro_en.tex108
3 files changed, 84 insertions, 30 deletions
diff --git a/Master/texmf-dist/doc/latex/acro/README b/Master/texmf-dist/doc/latex/acro/README
index 2dc30b17092..ad3168fceb1 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.0b
+the ACRO package v2.1
Typeset Acronyms
-2015/08/29
+2015/09/05
--------------------------------------------------------------------------
Clemens Niederberger
Web: http://www.mychemistry.eu/forums/forum/acro/
@@ -24,7 +24,7 @@ This work has the LPPL maintenance status `maintained'.
The Current Maintainer of this work is Clemens Niederberger.
--------------------------------------------------------------------------
The acro package consists of the files
- - acro.sty, acro0.def, acro1.def, acro_en.tex, acro_en.pdf, README
+ - acro.sty, acro_en.tex, acro_en.pdf, README
--------------------------------------------------------------------------
If you have any ideas, questions, suggestions or bugs to report, please
feel free to contact me.
diff --git a/Master/texmf-dist/doc/latex/acro/acro_en.pdf b/Master/texmf-dist/doc/latex/acro/acro_en.pdf
index ceb64feccad..ee81c0b7230 100644
--- a/Master/texmf-dist/doc/latex/acro/acro_en.pdf
+++ b/Master/texmf-dist/doc/latex/acro/acro_en.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/acro/acro_en.tex b/Master/texmf-dist/doc/latex/acro/acro_en.tex
index 387af88c967..e0f90fe47a0 100644
--- a/Master/texmf-dist/doc/latex/acro/acro_en.tex
+++ b/Master/texmf-dist/doc/latex/acro/acro_en.tex
@@ -398,6 +398,12 @@ documentation.
\keyval{accsupp}{text}
sets the \code{ActualText} key as presented by the \pkg{accsupp} package
for the acronym.
+ %% tooltip
+ \keyval{tooltip}{text}
+ \sinceversion{2.1}sets the tooltip description for an acronym. For
+ actually getting tooltips you also need an appropriate setting of the
+ \option{tooltip-cmd} option or to set the package option
+ \option{tooltip}.
%% index-sort
\keyval{index-sort}{text}
\sinceversion{1.1}If you use the package option \option{index} every
@@ -410,7 +416,7 @@ documentation.
\sinceversion{1.1}This key allows to overwrite the automatic index entry
with an arbitrary one. See section~\ref{ssec:index} for details.
%% index-cmd
- \keyval{index-cmd}{text}
+ \keyval{index-cmd}{control sequence}
\sinceversion{1.1}This key let's you set an individual index creating
command for this acronym. It should be a command that takes one mandatory
argument. See section~\ref{ssec:index} for details.
@@ -794,18 +800,20 @@ used:
\sinceversion{0.6a}Mark all acronyms as used.
\end{commands}
-\subsection{\cs*{ac} and Friends in \acs*{pdf} Bookmarks}
-\noindent\sinceversion{0.5}\acro's commands usually are not expandable which
-means they'd leave unallowed tokens in \acs{pdf} bookmarks. \pkg{hyperref}
-offers \cs*{texorpdfstring} to circumvent that issue manually but that isn't
-really a nice solution. What's the point of having macros to get output for
-you if you have to specify it manually after all?
-
-That is why \acro\ offers a preliminary solution for this. In a bookmark
-every \cs{ac} like command falls back to a simple text string typesetting what
-\cs{acs} would do (or \cs{acsp} for plural forms). These text strings both
-can accessed manually and can be modified to an output reserved for \acs{pdf}
-bookmarks.
+\subsection{\cs*{ac} and Friends in \acs*{pdf} Bookmarks, Accessibility
+ Support, Tooltips}
+\subsubsection{\acs*{pdf} Bookmarks}
+\acro's commands usually are not expandable which means they'd leave unallowed
+tokens in \acs{pdf} bookmarks. \pkg{hyperref} offers \cs*{texorpdfstring} to
+circumvent that issue manually but that isn't really a nice solution. What's
+the point of having macros to get output for you if you have to specify it
+manually after all?
+
+That is why \acro\ offers\sinceversion{0.5} a preliminary solution for this.
+In a bookmark every \cs{ac} like command falls back to a simple text string
+typesetting what \cs{acs} would do (or \cs{acsp} for plural forms). These
+text strings both can accessed manually and can be modified to an output
+reserved for \acs{pdf} bookmarks.
\begin{commands}
\command{acpdfstring}[\marg{id}]
@@ -817,13 +825,8 @@ bookmarks.
\keylit{pdfstring}{\Marg{\meta{pdfstring}/\meta{plural ending}}}
Key for \cs{DeclareAcronym} to declare a custom text string for \acs{pdf}
bookmarks. The plural ending can be set optionally.
- \keyval{accsupp}{text}
- \sinceversion{1.0}Key for \cs{DeclareAcronym} to set the \code{ActualText}
- property of \cs*{BeginAccSupp} (see \pkg{accsupp}'s documentation for
- details) to be used for an acronym. It only has an effect when the
- package option \option{accsupp} is used, too.
\end{options}
-
+
For example the \acs{pdf} acronym used in the title for this section is defined
as follows:
\begin{sourcecode}
@@ -835,14 +838,56 @@ as follows:
accsupp = PDF
}
\end{sourcecode}
-
-This also demonstrates the \option{accsupp} key. For this to work you need to
-use the \emph{package option} \option{accsupp}, too, which will load the
-package \pkg{accsupp}. Then the key \option{accsupp} will set the
-\code{ActualText} property of \cs*{BeginAccSupp}. Please refer to
-\pkg{accsupp}'s documentation for details. To see its effect copy \ac{pdf}
-and paste it into a text file. You should get uppercase letters instead of
-lowercase ones.
+
+\subsubsection{Accessibility Support}
+
+The last example also demonstrates the \option{accsupp} key. The idea is to
+have something different visible in the \acs{pdf} file compared to what you
+get when you select and copy the corresponding string. In the example visible
+string is a lowercase \code{pdf} in small caps while the string copied is an
+uppercase \code{PDF}.
+
+For this to work you need to use the \emph{package option} \option{accsupp},
+too, which will load the package \pkg{accsupp} if it isn't loaded by the user
+already. Then the key \option{accsupp} will set the \code{ActualText}
+property of \cs*{BeginAccSupp}. Please refer to \pkg{accsupp}'s documentation
+for details. To see its effect copy \ac{pdf} and paste it into a text file.
+You should get uppercase letters instead of lowercase ones.
+
+\begin{options}
+ \keyval{accsupp}{text}
+ \sinceversion{1.0}Key for \cs{DeclareAcronym} to set the \code{ActualText}
+ property of \cs*{BeginAccSupp} (see \pkg{accsupp}'s documentation for
+ details) to be used for an acronym. It only has an effect when the
+ package option \option{accsupp} is used, too.
+\end{options}
+
+\subsubsection{Tooltips}
+
+The idea of a tooltip is to have some text shown when you hover with the
+mouse over the short form of an acronym. This is only available in some
+\acs{pdf} viewers, though. On possibility for such tooltips is loading the
+\pkg{pdfcomment} package~\cite{pkg:pdfcomment} and using its \cs*{pdftooltip}
+macro.
+
+\begin{options}
+ \keybool{tooltip}\Default{false}
+ This\sinceversion{2.1} options loads the \pkg{pdfcomment} package and sets
+ the command for creating tooltips to \cs*{pdftooltip}.
+ \keyval{tooltip-cmd}{control sequence}\Default{\cs*{@firstoftwo}}
+ This\sinceversion{2.1} allows users using another macro for tooltips --
+ maybe one provided by another package or some own macro. It needs to be a
+ macro with two mandatory arguments, the first being the string typeset in
+ the \acs{pdf}, the second being the tooltip description text.
+\end{options}
+
+For using this with acronyms they have a property \option{tooltip} which can
+be used inside \cs{DeclareAcronym} for specifying the description text of the
+tooltip. If the \option{tooltip} package option is used but the property is
+not set for an acronym then the \option{long} property is used instead.
+
+If an acronym is used inside of another acronym then the tooltips of the
+``inner'' acronyms are disabled.
\subsection{Adding Acronyms to the Index}\label{ssec:index}
\noindent\sinceversion{1.1}\acro\ has the package option \option{index}. If it is
@@ -1025,6 +1070,15 @@ There are a few options which change the general behaviour of \acro.
\sinceversion{1.0}Activates the access support as provided by the
\pkg{accsupp} package.
%%
+ \keybool{tooltip}\Default{false}
+ \sinceversion{2.1}Activates tooltip support for \acro\ using the
+ \pkg{pdfcomment} package.
+ %%
+ \keyval{tooltip-cmd}{control sequence}\Default{\cs*{@firstoftwo}}
+ \sinceversion{2.1}A macro taking two mandatory arguments, the first being
+ the short form of the acronym and the second being some tooltip
+ description.
+ %%
\keyval{uc-cmd}{control sequence}\Default{\cs{acfirstupper}}
The command that is used to capitalize the first word in the \cs{Ac} and
the like commands. You can change it to another one like for example