summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/annot_pro
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/annot_pro
Initial commit
Diffstat (limited to 'macros/latex/contrib/annot_pro')
-rw-r--r--macros/latex/contrib/annot_pro/README.md25
-rw-r--r--macros/latex/contrib/annot_pro/annot_pro.dtx1591
-rw-r--r--macros/latex/contrib/annot_pro/annot_pro.ins65
-rw-r--r--macros/latex/contrib/annot_pro/doc/annotpro_man.pdfbin0 -> 635808 bytes
-rw-r--r--macros/latex/contrib/annot_pro/doc/annotpro_man.tex1468
-rw-r--r--macros/latex/contrib/annot_pro/examples/annots.pdfbin0 -> 113442 bytes
-rw-r--r--macros/latex/contrib/annot_pro/examples/annots.tex198
-rw-r--r--macros/latex/contrib/annot_pro/examples/graphics/APB_Logo_Sphere.epsbin0 -> 354751 bytes
-rw-r--r--macros/latex/contrib/annot_pro/examples/graphics/AdobeDon.epsbin0 -> 827064 bytes
-rw-r--r--macros/latex/contrib/annot_pro/examples/graphics/AdobeDon.pdfbin0 -> 23264 bytes
-rw-r--r--macros/latex/contrib/annot_pro/examples/graphics/AeST_Logo.epsbin0 -> 298202 bytes
-rw-r--r--macros/latex/contrib/annot_pro/examples/stamps.pdfbin0 -> 459200 bytes
-rw-r--r--macros/latex/contrib/annot_pro/examples/stamps.tex140
-rw-r--r--macros/latex/contrib/annot_pro/examples/text-markup.pdfbin0 -> 52901 bytes
-rw-r--r--macros/latex/contrib/annot_pro/examples/text-markup.tex107
-rw-r--r--macros/latex/contrib/annot_pro/examples/textbox.pdfbin0 -> 48040 bytes
-rw-r--r--macros/latex/contrib/annot_pro/examples/textbox.tex62
17 files changed, 3656 insertions, 0 deletions
diff --git a/macros/latex/contrib/annot_pro/README.md b/macros/latex/contrib/annot_pro/README.md
new file mode 100644
index 0000000000..bd549a4c55
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/README.md
@@ -0,0 +1,25 @@
+annot_pro
+Dated: 2018/08/13
+Author: D. P. Story
+
+
+This package is used to create text, stamp, file attachment, and text box
+annotations using Adobe Distiller, these annotations can be viewed in
+Adobe Reader. For users of pdf(la)tex, use the pdfcomment package by Josef
+Kleber might suffice.
+
+Check out my http://www.acrotex.net/ website and my blog site as well
+at http://blog.acrotex.net/.
+
+What's New (2018/08/13) Now the package supports text markup annotations; these
+annotations can break across page boundaries with some help, by setting the crackat
+key. All supported annotations can now have rich text content.
+
+What's New (2018/04/26): Added dummy package named annot-pro to conform with
+CTAN naming.
+
+
+Now, I simply must get back to my retirement.
+
+D. P. Story
+dpstory@acrotex.net
diff --git a/macros/latex/contrib/annot_pro/annot_pro.dtx b/macros/latex/contrib/annot_pro/annot_pro.dtx
new file mode 100644
index 0000000000..e5de537c37
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/annot_pro.dtx
@@ -0,0 +1,1591 @@
+% \iffalse
+%<*copyright>
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% annot_pro package, %%
+%% Copyright (C) 2002-2018 D. P. Story %%
+%% dpstory@uakron.edu %%
+%% %%
+%% This program can redistributed and/or modified under %%
+%% the terms of the LaTeX Project Public License %%
+%% Distributed from CTAN archives in directory %%
+%% macros/latex/base/lppl.txt; either version 1 of the %%
+%% License, or (at your option) any later version. %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%</copyright>
+%<package>\NeedsTeXFormat{LaTeX2e}
+%<package>\ProvidesPackage{annot_pro}
+%<package> [2018/08/13 v1.4 Provides selected PDF annotation support (dps)]
+%<*driver>
+\documentclass{ltxdoc}
+\usepackage[fleqn]{amsmath}
+\usepackage[colorlinks,hyperindex=false]{hyperref}
+%\let\uif\textsf\let\app\textsf
+%\let\pkg\textsf\let\env\texttt
+%\def\psf#1{\textsf{\textbf{#1}}}
+%\let\opt\texttt
+%\def\texorpdfstring#1#2{#1}
+%\pdfstringdefDisableCommands{\let\\\textbackslash}
+\OnlyDescription % comment out for implementation details
+\EnableCrossrefs \CodelineIndex \RecordChanges
+\InputIfFileExists{aebdocfmt.def}{\PackageInfo{annot_pro}{Inputting aebdocfmt.def}}
+ {\def\IndexOpt{\DescribeMacro}\def\IndexKey{\DescribeMacro}\let\setupFullwidth\relax
+ \PackageInfo{annot_pro}{aebdocfmt.def cannot be found}}
+\begin{document}
+\def\CMD#1{\textbackslash#1}
+\let\pkg\textsf
+\let\env\texttt
+\let\opt\texttt
+\let\app\textsf
+\let\key\texttt
+\def\psf#1{\textsf{\textbf{#1}}}
+\def\visispace{\symbol{32}}
+\def\ameta#1{\ensuremath{\langle\textit{\texttt{#1}}\rangle}}
+\def\meta#1{\textsl{\texttt{#1}}}
+\def\SUB#1{\ensuremath{{}_{\mbox{\scriptsize\ttfamily#1}}}}
+\def\darg#1{\texttt{\char123\relax#1\char125\relax}}
+ \GetFileInfo{annot_pro.sty}
+ \title{annot\_pro: Selected PDF Annotations}
+ \author{D. P. Story\\
+ Email: \texttt{dpstory@uakron.edu}}
+ \date{processed \today}
+ \maketitle
+ \tableofcontents
+ \let\Email\texttt
+ \DocInput{annot_pro.dtx}
+\IfFileExists{\jobname.ind}{\newpage\setupFullwidth\par\PrintIndex}{\paragraph*{Index}
+The index goes here. Execute
+\begin{quote}
+ \texttt{makeindex -s gind.ist -o annot\_pro.ind annot\_pro.idx}
+\end{quote}
+ on the command line and recompile \texttt{annot\_pro.dtx}.}
+\IfFileExists{\jobname.gls}{\PrintChanges}{\paragraph*{Change History} The list
+of changes goes here. Execute
+\begin{quote}
+ \texttt{makeindex -s gglo.ist -o annot\_pro.gls annot\_pro.glo}
+\end{quote}
+ on the command line and recompile \texttt{annot\_pro.dtx}.}
+\end{document}
+%</driver>
+% \fi
+%
+% \MakeShortVerb{|}
+% \InputIfFileExists{aebdonotindex.def}{\PackageInfo{web}{Inputting aebdonotindex.def}}
+% {\PackageInfo{web}{cannot find aebdonotindex.def}}
+%
+% \section{Alternate package name: \texorpdfstring{\protect\pkg{annot-pro}}{annot-pro}}
+% CTAN lists this package (\pkg{annot\_pro}) as \pkg{annot-pro}, so we'll create
+% a dummy package by that name.
+% \changes{v1.2}{2018/04/26}{Added dummy package \string\pkg{annot-pro}}
+% \begin{macrocode}
+%<*altpkgname>
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{annot-pro}
+ [2018/04/26 v1.0 annot-pro Alt-name (dps)]
+\RequirePackage{xkeyval}
+\DeclareOptionX*{\PassOptionsToPackage{\CurrentOption}{annot_pro}}
+\ProcessOptionsX\relax
+\RequirePackage{annot_pro}
+% \end{macrocode}
+% \begin{macrocode}
+%</altpkgname>
+%<*package>
+\RequirePackage{xkeyval}
+% \end{macrocode}
+% \changes{v1.4}{2018/08/13}{All supported annotation can have rich text content}
+% \changes{v1.4}{2018/08/13}{Text markup annotations are introduced}
+% \changes{v1.3}{2018/04/26}{Allow rich text for text annotations}
+% \changes{v1.1}{2016/09/29}{Introduced Free Text annotation}
+% \changes{v1.0c}{2016/09/28}{Reformatted manual, reformatted DTX file}
+% \section{Background Information}
+%
+% The following annotation types will be supported (taken from table 8.20)
+%\begin{itemize}
+% \item \textbf{Text}: Subtype \textbf{Text}. See Table 8.23, page 621. In particular, the values
+% of the \textbf{Name} key are \textbf{Comment}, \textbf{Help}, \textbf{Insert}, \textbf{Key}, \textbf{NewParagraph},
+% \textbf{Note} (the default), and \textbf{Paragraph}. Other supported names are \textbf{Check}, \textbf{Circle}, \textbf{Cross},
+% \textbf{Star}, \textbf{RightArrow}, \textbf{RightPointer}, \textbf{UpArrow}, \textbf{UpLeftArrow}
+% \item \textbf{Stamp}: Subtype \textbf{Stamp}. See Table 8.32, page 635. The values of the \textbf{Name} key are
+% \textbf{Approved}, \textbf{AsIs}, \textbf{Confidential},
+% \textbf{Departmental}, \textbf{Draft} (the default),
+% \textbf{Experimental}, \textbf{Expired}, \textbf{Final},
+% \textbf{ForComment}, \textbf{ForPublicRelease}, \textbf{NotApproved},
+% \textbf{NotForPublicRelease}, \textbf{Sold}, \textbf{TopSecret}.
+% \item \textbf{FileAttachment}: Subtype \textbf{FileAttachment}. Table 8.35, page 638. The Name key has values
+% \textbf{Graph}, \textbf{Paperclip}, \textbf{PushPin}, and \textbf{Tag}.
+%\end{itemize}
+% The options available for any supported annotation
+%\begin{itemize}
+% \item \verb!type=text | stamp | fileattachment | textbox | highlight |!\\\null\texttt{\phantom{type=}}\unskip
+% \verb!underline | squiggly | strikeout!
+% (\texttt{text}, the default)
+% \item \texttt{Contents} will be an argument of the command \cs{annotpro}
+% \item \texttt{NM} unique name for the page, optional, if not provided,
+% one will be generated.
+% \item \texttt{color}, to color the annotation
+% \item \verb!margin! to place the annotation in the margin
+% \item \texttt{nohspace}, leave no horizontal space
+% \item \texttt{novspace}, leave no vertical space
+% \item \texttt{nospace}, leave neither vertical or horizontal space.
+%\end{itemize}
+% \section{Annotation types supported}
+% \subsection{Text Annotations}
+% The options for the text annotation (\texttt{type=text}) are
+%\begin{itemize}
+% \item \texttt{name}, one of the standard icons listed above, default: \texttt{Note}
+% \item \texttt{open}, default \texttt{false}
+%\end{itemize}
+% \subsection{Rubber Stamp Annotations}
+% The options for the text annotation (\texttt{type=stamp}) are
+%\begin{itemize}
+% \item \texttt{name}, the default is draft. If a name begins with \texttt{\#}, that signals
+% a custom appearance.
+% \item \texttt{ap}, when the name is a custom name, the \texttt{ap} is used to hold the indirect reference
+% to the appearance. If a custom name is specified, \texttt{ap} is required, and \textsf{graphicxsp} is required.
+% \item \texttt{open}, default \texttt{false}
+%\end{itemize}
+% \subsection{File Attachment Annotations}
+% The options for the text annotation (\texttt{type=fileattachement}) are
+%\begin{itemize}
+% \item \texttt{name}, the default is \texttt{PushPin}.
+% \item \texttt{file}, the file specification \textbf{FS} key
+%\end{itemize}
+% \subsection{Text Box (Free Text) Annotations}
+% The options for a text box (\texttt{textbox}) are
+% \texttt{width}, \texttt{height},
+% \texttt{bgcolor}, \texttt{bcolor}, \texttt{borderstyle}, and \texttt{borderwidth}; see
+% documentation for details.
+%
+% \subsection{Text Markup Annotation}
+% We support four text markup annotations these are
+% \begin{itemize}
+% \item \verb!type=highlight | underline | squiggly | strikeout!
+% \item Other options
+% \end{itemize}
+%
+% \section{Package options and other requirements}
+% Use the \IndexOpt{preview}\opt{preview} key to see bounding boxes. Or turn on and off using
+% \DescribeMacro{\previewOn}\cs{previewOn} and \DescribeMacro{\previewOff}\cs{previewOff}.
+% \begin{macrocode}
+\DeclareOptionX{preview}{\previewtrue}
+\@ifundefined{ifpreview}{\newif\ifpreview\previewfalse}{}
+\providecommand{\previewOn}{\previewtrue}
+\providecommand{\previewOff}{\previewfalse}
+% \end{macrocode}
+% Beginning with Acrobat 10, now a while ago, the sizes of the icons were changed.
+% \IndexOpt{useA10Icons}\opt{useA10Icons} is taken by default; use \IndexOpt{!useA10Icons}\opt{!useA10Icons}
+% when the target audience has older viewers.
+% \changes{v1.1}{2016/09/29}{Added \string\texttt{useA10Icons} and \string\texttt{useTextBox} options}
+% (2016/09/29) Added \texttt{useA10Icons} and \texttt{useTextBox} options
+% \begin{macrocode}
+\newif\ifuseAAXdim\useAAXdimtrue
+\DeclareOptionX{useA10Icons}{\useAAXdimtrue}
+\DeclareOptionX{!useA10Icons}{\useAAXdimfalse}
+% \end{macrocode}
+% If the document author wants to use rich text content, then use the \IndexOpt{useTextBox}\opt{useTextBox}
+% option; however, beginning with
+% Require \pkg{richtext}, dated 2018/08/05 or later.
+% \changes{v1.1a}{2016/10/18}{Require \string\pkg{richtext}, dated 2016/10/03 or later.}
+% \changes{v1.1b}{2016/10/18}{Corrected date specification}
+% \begin{macrocode}
+\DeclareOptionX{useTextBox}{\def\ap@requireRichTextAsNeeded{%
+ \RequirePackage{richtext}[2018/08/05]}}
+% \end{macrocode}
+% In v1.4 all content can be rich text so we deprecate the \opt{richtext} option in favor
+% of the more generic option \IndexOpt{richtext}\opt{richtext}.
+% \changes{v1.4}{2018/08/13}{Added the \string\texttt{richtext}}
+% \begin{macrocode}
+\DeclareOptionX{richtext}{\def\ap@requireRichTextAsNeeded{%
+ \RequirePackage{richtext}[2018/08/05]}}
+\let\ap@requireRichTextAsNeeded\relax
+% \end{macrocode}
+% The \IndexOpt{scandoc}\opt{scandoc} option calls some doc assembly JavaScript to scan the document
+% for stamp annotations. For stamps shipped by Adobe this is not necessary, but for any custom stamps,
+% this is needed.
+% \begin{macrocode}
+\@ifundefined{mldblevel}{\newcount\mldblevel
+ \mldblevel=0 }{}
+\define@key{annot_pro.sty}{dblevel}[0]{\mldblevel=#1 }
+\DeclareOptionX{scandoc}{\let\anp@InputScanDoc\anp@scanDoc
+ \PassOptionsToPackage{execJS}{insdljs}}
+% \end{macrocode}
+% During document development, you don't what to scan the newly created PDF after you build it to,
+% perhaps, edit the text. In this case, use the \IndexOpt{!scandoc}\opt{!scandoc} option. You want to scan the document when you build the document for the last time
+% before publishing it. Be sure to save the document using the SaveAs menu item. This saves the
+% stamp appearances (symbology in this case) as part of the document.
+% \begin{macrocode}
+\DeclareOptionX{!scandoc}{\let\anp@InputScanDoc\relax}
+% \end{macrocode}
+% The default is not to scan the document. Remember, the final document must be scanned; that is,
+% it must be build with the \opt{scandoc} option in effect.
+% \begin{macrocode}
+\let\anp@InputScanDoc\relax
+\def\anp@scanDoc{\InputIfFileExists{scandoc-anp.def}
+ {\PackageInfo{annot_pro}{Inputting the scandoc-anp.def file}}
+ {\PackageWarning{annot_pro}{Cannot find the file scandoc-anp.def}}}
+% \end{macrocode}
+% Process the package options.
+% \begin{macrocode}
+\ProcessOptionsX\relax
+\RequirePackage{trig}
+\RequirePackage{hyperref}
+\RequirePackage{calc}
+\RequirePackage{aeb_mlink}[2018/08/18] % loads eforms and insdljs
+\ifx\anp@InputScanDoc\relax\else\let\execjs=y\fi
+\RequirePackage[structure]{taborder}
+\ap@requireRichTextAsNeeded
+% \end{macrocode}
+% We see if \textsf{graphicxsp} is loaded, and set a simple switch one way or the other.
+% This switch is later used when creating a custom stamp.
+% \begin{macrocode}
+\@ifpackageloaded{graphicxsp}{%
+ \let\ap@graphicxsp=1}{\let\ap@graphicxsp=0}
+% \end{macrocode}
+% For now, we'll support setting the tab order only if the \pkg{eforms} package is loaded.
+% \begin{macrocode}
+\@ifpackageloaded{eforms}{}
+ {\newif\ifto@structOrder\to@structOrderfalse}
+% \end{macrocode}
+% \cs{csarg} from \pkg{comments} package, handy.
+% \begin{macrocode}
+\def\ap@csarg#1#2{\expandafter#1\csname#2\endcsname}
+\let\ap@YES=y \let\ap@NO=n
+\let\ap@One=1 \let\ap@Zero=0
+% \end{macrocode}
+% Definitions for creating a rectangle used to create a building box for the annot.
+% \begin{macrocode}
+\def\ap@Bbox#1#2{\edef\bbox@width{#1}\edef\bbox@height{#2}%
+ \hbox{\ifpreview\setlength\fboxrule{0.4pt}\setlength\fboxsep{0pt}%
+ \@tempdima=\bbox@width\advance\@tempdima by-\fboxrule
+ \@tempdimb=\bbox@height\advance\@tempdimb by-\fboxrule
+ \fbox{\parbox[c][\@tempdimb][c]{\@tempdima}{\hfill\vfill}}\else
+ \parbox[c][\bbox@height][c]{\bbox@width}{\hfill\vfill}\fi}%
+}
+% \end{macrocode}
+% The postscript operators \texttt{pdf@llx}, etc., are defined in \textsf{hyperref}.
+% \begin{macrocode}
+\def\ap@Rect{/Rect [pdf@llx pdf@ury pdf@urx pdf@lly]}
+\def\ap@mark{[\space}
+% \end{macrocode}
+% \begin{macro}{\defineAPath}
+% A simple macro to define path.
+% \begin{macrocode}
+\newcommand{\defineAPath}[1]{\def\ap@ctrl@Name{#1}%
+ \hyper@normalise\ap@defineAPath}
+\def\ap@defineAPath#1{\expandafter\xdef\ap@ctrl@Name{#1}}
+% \end{macrocode}
+% \end{macro}
+%
+% \section{Key-Value Pairs for \texorpdfstring{\protect\cs{annotpro}}{\textbackslash annotpro}}
+%
+% We\IndexKey{type} support eight types of annotation, text, stamp, and fileattachment.
+% \changes{v1.3}{2018/04/26}{Added highlight, underline, squiggly, and strikeout}
+% \begin{macrocode}
+\let\isstrikeout\ap@NO
+\define@choicekey+{annotpro}{type}[\val\nr]%
+ {text,stamp,fileattachment,textbox,highlight,underline,%
+ squiggly,strikeout}[text]{%
+ \edef\ap@save@type{\nr}%
+ \ifcase\nr\relax
+ \def\ap@type{Text}\or %0
+ \def\ap@type{Stamp}\or %1
+ \def\ap@type{FileAttachment}\or %2
+ \def\ap@type{FreeText}\or %3
+ \def\ap@type{Highlight}\or %4
+ \def\ap@type{Underline}\or %5
+ \def\ap@type{Squiggly}\or %6
+\let\isstrikeout\ap@YES
+ \def\ap@type{StrikeOut}\fi %7
+}{\PackageWarning{annot_pro}{Bad choice for type, permissible values
+ are text, stamp, fileattachment, textbox, highlight, underline,%
+ squiggly, strikeout. Try again}}
+\def\ap@freetext@type{3}
+\let\ap@type\@empty
+% \end{macrocode}
+% The \IndexKey{name}\key{name} key can have many different values. The permitted values
+% determined of the \key{type}.
+% \begin{macrocode}
+\define@key{annotpro}{name}[]{\def\annotpro@name{#1}}
+\let\annotpro@name\@empty
+% \end{macrocode}
+% The \IndexKey{internalID}\key{internalID} key allows you to specify the \psf{NM} entry. Must be
+% unique throughout the page. The default is \texttt{annotpro\string\the\string\ap@annot@cnt}.
+% The key is used only for the most particular of applications.
+% \changes{v1.1c}{2017/06/06}{Added \string\texttt{internalID}}
+% \begin{macrocode}
+\define@key{annotpro}{internalID}[]{\def\annotpro@internalID{#1}}
+\let\annotpro@internalID\@empty
+% \end{macrocode}
+% \textbf{Text Annotations.} For a text annotation, the following are permitted values for \key{name}:
+% \begin{macrocode}
+\define@choicekey+{annnotprotext}{name}{%
+ Comment,Key,Note,Help,NewParagraph,Paragraph,Insert,Check,%
+ Circle,Cross,Star,RightArrow,RightPointer,UpArrow,UpLeftArrow,%
+ CrossHairs}[Note]{\def\annotpro@@name{#1}}%
+ {\PackageWarning{annot_pro}{Bad choice for name, permissible values
+ are Comment, Key, Note, Help, NewParagraph, Paragraph, Insert, Check,
+ Circle, Cross, Star, RightArrow, RightPointer, UpArrow,
+ UpLeftArrow, CrossHairs. Try again}}
+\let\annotpro@@name\@empty
+% \end{macrocode}
+% \textbf{Rubber Stamp Annotations.} For a stamp annotation, the following are permitted values for \texttt{name}.
+% \begin{macrocode}
+\define@choicekey+{annnotprostamp}{name}{%
+ Approved,AsIs,Confidential,Departmental,Draft,%
+ Experimental,Expired,Final,ForComment,%
+ ForPublicRelease,NotApproved,NotForPublicRelease,Sold,%
+ TopSecret}[Draft]{\def\annotpro@@name{#1}}%
+ {\def\ap@custom@name{#1}}
+\let\ap@custom@name\@empty
+% \end{macrocode}
+% If the user enters a value other than the one listed, that value is recorded
+% in the text macro \cs{ap@custom@name}. Usually, the user would enter the
+% names of stamps that come on his system, but are not part of the PDF Specs.
+% \begin{macrocode}
+% \end{macrocode}
+% There\IndexKey{customStamp} is a third case. The user can create a custom stamp through
+% the \key{customStamp} key, with the assistance of the \pkg{graphicxsp}
+% package.
+% \begin{macrocode}
+\define@key{annotpro}{customStamp}[]{\def\ap@customstamp@name{#1}}
+\let\ap@customstamp@name\@empty
+% \end{macrocode}
+% \leavevmode\IndexKey{ap}^^A
+% When the user specifies \key{customStamp}, he must supply a custom appearance
+% for the stamp with the \key{ap} key. The \textsf{graphicxsp} package is required
+% for this option.
+% \begin{macrocode}
+\define@key{annotpro}{ap}[]{\def\annotpro@ap{#1}}
+\let\annotpro@ap\@empty
+% \end{macrocode}
+% \leavevmode
+% \IndexKey{width}^^A
+% \IndexKey{height}^^A
+% \IndexKey{rotate}^^A
+% \IndexKey{scale}^^A
+% \IndexKey{widthTo}^^A
+% \IndexKey{heightTo}^^A
+% As of this writing, these are used when the user sets the name key equal
+% to one of the many stamp names that come with Acrobat (other than ones
+% that are documented in the PDF Specs. Use the width and height to set the
+% bounding box. Normally, distiller, will place the largest stamp the box
+% will hold, and center it in that box. (I think.)
+% \begin{macrocode}
+\define@key{annotpro}{width}[]{\def\annotpro@width{#1}}
+\let\annotpro@width\@empty
+\define@key{annotpro}{height}[]{\def\annotpro@height{#1}}
+\let\annotpro@height\@empty
+\define@key{annotpro}{rotate}[]{\def\annotpro@rotate{#1}}
+\let\annotpro@rotate\@empty
+\define@key{annotpro}{scale}[]{\def\annotpro@scale{#1}}
+\let\annotpro@scale\@empty
+\define@key{annotpro}{widthTo}[]{\def\annotpro@widthTo{#1}}
+\let\annotpro@widthTo\@empty
+\define@key{annotpro}{heightTo}[]{\def\annotpro@heightTo{#1}}
+\let\annotpro@heightTo\@empty
+% \end{macrocode}
+% \textbf{File Attachment Annotations.} For a file attachment annotation, the following are permitted values for \IndexKey{name}\key{name}.
+% \begin{macrocode}
+\define@choicekey+{annnotprofileattach}{name}{%
+Graph,Paperclip,PushPin,Tag}[PushPin]{\def\annotpro@@name{#1}}
+{\PackageWarning{annot_pro}{Bad choice for name, permissible values
+are Graph,Paperclip,PushPin,Tag. Try again}}
+% \end{macrocode}
+% When\IndexKey{file} there is a file attachment, the absolute path to the file must be
+% specified using the \key{file} key. A path to the file can be defined
+% using \cs{defineAPath}.
+% \begin{macrocode}
+\define@key{annotpro}{file}[]{%
+ \edef\annotpro@file{#1}%
+ \ifx\annotpro@file\@empty\else
+ \edef\ap@exp@tmp{\noexpand\filename@parse{#1}}\ap@exp@tmp
+ \edef\ap@thisFileName{\filename@base.\filename@ext}\fi
+}
+\let\annotpro@file\@empty
+% \end{macrocode}
+% \textbf{Text Box Annotations.} Define keys for the text box annotation (free text),
+% these are \IndexKey{name}\key{name},
+% \IndexKey{defstyle}\key{defstyle}, and \IndexKey{richtext}\key{richtext}.
+% \begin{macrocode}
+\define@key{annotprofreetext}{name}[FreeText]{\def\annotpro@@name{#1}}
+\define@key{annotprofreetext}{defstyle}[]{\def\annotpro@@ds{#1}}
+\let\annotpro@@ds\@empty
+\define@key{annotprofreetext}{richtext}[]{\def\annotpro@@rt{#1}}
+\let\annotpro@@rt\@empty
+% \end{macrocode}
+% \leavevmode\IndexKey{margin}^^A
+% \IndexKey{margintext}^^A
+% \DescribeMacro{\margintextformat}
+% When margin is used, the command \cs{marginpar} is used to place the annotation
+% in the margins, this is nice for sticky notes (text annotations), small stamps,
+% and file attachments.
+%
+% You can optionally place (a small amount of) text under the icon in the margins. The
+% format for the text can be redefined using the command \cs{margintextformat}.
+% \begin{macrocode}
+\define@key{annotpro}{margin}[0]{%
+ \def\annotpro@margin{0}}
+\let\annotpro@margin\@empty
+\define@key{annotpro}{margintext}[]{%
+ \def\apmargintext{\centering\break
+ \parbox{\linewidth}{\apmargintextformat\strut#1}}}
+\let\apmargintext\@empty
+\newcommand{\margintextformat}[1]{\def\apmargintextformat{#1}}
+\margintextformat{\bfseries\tiny\color{blue}}
+% \end{macrocode}
+% Again\IndexKey{margprior}, when the \key{margin} option is taken, we can insert content just inside
+% the left brace of the \cs{marginpar} command using \key{margprior}.
+% \changes{v1.1c}{2017/06/06}{Added the key \string\texttt{margprior}}
+% \begin{macrocode}
+\define@key{annotpro}{margprior}[]{\def\anp@margprior{#1}}
+\let\anp@margprior\@empty
+% \end{macrocode}
+% \leavevmode\IndexKey{presets} A convenience key to allow the introduction of pre-defined options, for example,
+% you might like all your comment fields to be red, so you can define
+% \verb!\def\myComments{type=text,name=Comment,color=red}!, then say
+%\begin{verbatim}
+% \annotpro[presets=\myComment]{Way to go!}
+%\end{verbatim}
+% \begin{macrocode}
+\define@key{annotpro}{presets}[]{\def\annotpro@presets{#1}}
+\let\annotpro@presets\@empty
+% \end{macrocode}
+% Added 07/08/09 to support structure tab order.
+% \leavevmode\IndexKey{objdef}^^A
+% This is a \psf{pdfmark} feature that inserts a references to this COS object,
+% used with setting the tab order using the structure. Tabbing using structure
+% is supported by \pkg{eforms}.
+% \begin{macrocode}
+\define@key{annotpro}{objdef}[]{\def\eq@objdef{/_objdef {#1}}%
+ \def\eq@objdefName{#1}}
+\let\eq@objdef\@empty
+% \end{macrocode}
+% \leavevmode\IndexKey{taborder}
+% An option to set the tab order.
+% \begin{macrocode}
+\define@key{annotpro}{taborder}[]{\def\eq@taborder{#1}}
+\let\eq@taborder\@empty
+% \end{macrocode}
+% \leavevmode\IndexKey{open}^^A
+% A key to set whether the popup annotation is open or not.
+% \begin{macrocode}
+\define@choicekey+{annotpro}{open}[\val\nr]{true,false}[true]{%
+ \def\annotpro@open{#1}}{\PackageWarning{annot_pro}{Bad
+ choice for open, permissible values are true and false. Try again}}
+\def\annotpro@open{false}
+% \end{macrocode}
+% The \IndexKey{subject}\key{subject} and \IndexKey{title}\key{title} (usually the author's name) of the annotation
+% \begin{macrocode}
+\define@key{annotpro}{subject}[]{\def\annotpro@subject{#1}}
+\define@key{annotpro}{title}[]{\def\annotpro@title{#1}}
+% \end{macrocode}
+% \leavevmode\IndexKey{color}^^A
+% The color of the annotation.
+% \begin{macrocode}
+\define@key{annotpro}{color}[1 0 0]{\let\ap@isColorKey\ap@YES
+ \def\annotpro@color{#1}}
+% \end{macrocode}
+% For the Free Text annotation, we can specify background color \IndexOpt{bgcolor}\opt{bgcolor},
+% (default white) and border color \IndexOpt{bcolor}\opt{bcolor} (default black).
+% \begin{macrocode}
+\define@key{annotpro}{bgcolor}[]{\def\annotpro@bgcolor{#1}}
+\def\annotpro@bgcolor{white}
+\define@key{annotpro}{bcolor}[]{\def\annotpro@bcolor{#1}}
+\let\annotpro@bcolor\@empty
+\def\annotpro@def@bcolor{black}
+% \end{macrocode}
+% \textbf{Text Box Annotation.} The \IndexKey{borderstyle}\key{borderstyle} key.
+% \begin{macrocode}
+\def\ap@BE@i{4.08768}
+\def\ap@BE@i@calc{\ap@BE@i\space\ap@bwidthNum\space add}
+\def\ap@BE@ii{8.26857}
+\def\ap@BE@ii@calc{\ap@BE@ii\space add \ap@bwidthNum}
+\define@choicekey+{annotpro}{borderstyle}[\val\nr]{none,solid,%
+ dash1,dash2,dash3,dash4,dash5,dash6,cloud1,cloud2}[solid]{%
+ \ifcase\nr\relax
+ \def\ap@border@code{}\or
+ \def\ap@border@code{%
+ /BS <</S/S\ap@bwidth>>}\or
+ \def\ap@border@code{%
+ /BS <</D[2.0 2.0]/S/D\ap@bwidth>>}\or
+ \def\ap@border@code{%
+ /BS <</D[3.0 3.0]/S/D\ap@bwidth>>}\or
+ \def\ap@border@code{%
+ /BS <</D[4.0 4.0]/S/D\ap@bwidth>>}\or
+ \def\ap@border@code{%
+ /BS <</D[4.0 3.0 2.0 3.0]/S/D\ap@bwidth>>}\or
+ \def\ap@border@code{%
+ /BS <</D[4.0 3.0 16.0 3.0]/S/D\ap@bwidth>>}\or
+ \def\ap@border@code{%
+ /BS <</D[8.0 4.0 4.0 4.0]/S/D\ap@bwidth>>}\or
+ \def\ap@border@code{%
+ /BE<</I 1.0/S/C>>/RD[\ap@BE@i@calc\space\ap@BE@i@calc
+ \space\ap@BE@i@calc\space\ap@BE@i@calc]%
+ \ifx\ap@bwidth\@empty\else/BS <<\ap@bwidth>>\fi}\or
+ \def\ap@border@code{%
+ /BE<</I 2.0/S/C>>/RD[\ap@BE@ii@calc\space\ap@BE@ii@calc
+ \space\ap@BE@ii@calc\space\ap@BE@ii@calc]%
+ \ifx\ap@bwidth\@empty\else/BS <<\ap@bwidth>>\fi}\fi
+ \def\annotpro@border{#1}}{\PackageWarning{annot_pro}{Bad
+ choice for borderstyle,\MessageBreak permissible values are none,
+ solid, dash1, dash2, dash3,\MessageBreak dash4, dash5, dash6,
+ cloud1, cloud2. Try again}}
+\def\ap@border@code{/BS <</S/S\ap@bwidth>>}
+\define@choicekey+{annotpro}
+ {borderwidth}[\val\nr]{.5,1,2,3,4,6,8,10}[1]{%
+ \edef\ap@bwidthNum{\val}%
+ \def\ap@bwidth{/W #1}}{\PackageWarning{annot_pro}{Bad
+ choice for borderwidth,\MessageBreak permissible values are
+ .5, 1, 2,\MessageBreak 3, 4, 6, 8, 10. Try again}}
+\def\ap@bwidthNum{1}
+\let\ap@bwidth\@empty
+% \end{macrocode}
+% Set the \IndexKey{readonly}\key{readonly} to obtain an annotation
+% to readonly and can't be moved.
+% \begin{macrocode}
+\define@boolkey{annotpro}{readonly}[true]{\ifKV@annotpro@readonly
+ \def\ap@readonly{ 65 add}\else\let\ap@readonly\@empty\fi}
+\let\ap@readonly\@empty
+% \end{macrocode}
+% Added\IndexKey{hidden} the \texttt{hidden} option.
+% \changes{v1.1c}{2017/06/06}{Added \string\texttt{hidden} property}
+% \begin{macrocode}
+\define@boolkey{annotpro}{hidden}[true]{\ifKV@annotpro@hidden
+ \def\ap@hidden{ 2 add}\else\let\ap@hidden\@empty\fi}
+\let\ap@hidden\@empty
+% \end{macrocode}
+% \leavevmode\IndexKey{nohspace}\IndexKey{nohspace}\IndexKey{nospace}^^A
+% \textbf{Text Annotations.}
+% These are used only with text annotations. The position of the
+% annotation depends only on the upper-right corner. The bounding
+% box can be made to have no width or not height, or both. The upper-left
+% corner is always defined. The text annotation will take no horizontal,
+% vertical, or no space at all in {\TeX} space. The same effect can be accomplished
+% using 0pt width boxes or by smashing the bounding box.
+% \begin{macrocode}
+\define@key{annotpro}{nohspace}[]{\def\annotpro@hspace{0pt}}
+\define@key{annotpro}{novspace}[]{\def\annotpro@vspace{0pt}}
+\define@key{annotpro}{nospace}[]{\def\annotpro@hspace{0pt}%
+ \def\annotpro@vspace{0pt}}
+\let\annotpro@hspace\@empty\let\annotpro@vspace\@empty
+% \end{macrocode}
+% Set the \IndexKey{opacity}\key{opacity} of the annot, if creating a custom stamp using
+% \pkg{graphicxsp}, then the file needs to be distilled using \texttt{standard\_transparency}
+% job settings for distiller.
+% \begin{macrocode}
+\define@key{annotpro}{opacity}[]{%
+ \def\ap@add@ops{\ap@mark/ca #1 /SetTransparency pdfmark}%
+ \def\annotpro@opacity{#1}}
+\let\annotpro@opacity\@empty
+% \end{macrocode}
+% \textbf{Text Markup Annotations.} The \IndexKey{crackat}\key{crackat},
+% \IndexKey{crackinsat}\key{crackinsat},
+% \IndexKey{hyph}\key{hyph},
+% and \IndexKey{copycontent}\key{copycontent} are key-value options
+% of the \cs{annotpro} command to support text markup annotations. The default values are
+% supplied by \pkg{eforms}.
+% \begin{macrocode}
+\define@key{annotpro}{crackat}[]{\def\eq@mlcrackat{#1}} % dpsaug14
+\define@choicekey+{annotpro}{hyph}[\val\nr]{y,n}[y]{\edef\ef@arg{\val}%
+ \ifx\ef@arg\ef@y\def\eq@mlhyph{-}\else\let\eq@mlhyph\@empty\fi
+}{\PackageWarning{annot_pro}{Bad choice for hyph, permissible values
+ are y and n. Try again}}
+\define@boolkey{annotpro}{copycontent}[true]{}
+\define@key{annotpro}{crackinsat}{\def\eq@mlcrackinsat{#1}}
+\let\eq@mlcrackinsat\@empty
+% \end{macrocode}
+% \subsection{Dimensions of Standard Text Icons}
+% Using the user interface, and the dimensions of each of the standard text annotations
+% were obtained and recorded here.
+% \begin{macrocode}
+% Note in A10, text annots are not 18bp x 18bp and A10 adds CrossHairs
+\def\getargsiii#1#2#3{\def\ap@argi{#1}\def\ap@argii{#2}%
+ \def\ap@argiii{#3}}
+\ifuseAAXdim
+ \@tfor\ap@text@dimen:={{Comment}{18bp}{18bp}}%
+ {{Key}{13bp}{18bp}}{{Note}{18bp}{20bp}}{{Help}{20bp}{20bp}}%
+ {{NewParagraph}{13bp}{20bp}}{{Paragraph}{20bp}{20bp}}%
+ {{Insert}{17bp}{20bp}}{{Check}{20bp}{19bp}}%
+ {{Circle}{20bp}{20bp}}{{Cross}{20bp}{19bp}}%
+ {{Star}{20bp}{19bp}}{{RightArrow}{20bp}{20bp}}%
+ {{RightPointer}{20bp}{17bp}}{{UpArrow}{17bp}{20bp}}%
+ {{UpLeftArrow}{17bp}{17bp}}{{CrossHairs}{20bp}{20bp}}\do{%
+ \expandafter\getargsiii\ap@text@dimen
+ \ap@csarg\edef{ap@\ap@argi Width}{\ap@argii}%
+ \ap@csarg\edef{ap@\ap@argi Height}{\ap@argiii}%
+ }%
+\else
+ \@tfor\ap@text@dimen:={{Comment}{20bp}{18bp}}%
+ {{Key}{18bp}{17bp}}{{Note}{18bp}{20bp}}{{Help}{20bp}{20bp}}%
+ {{NewParagraph}{13bp}{20bp}}{{Paragraph}{11bp}{20bp}}%
+ {{Insert}{20bp}{17bp}}{{Check}{20bp}{19bp}}%
+ {{Circle}{20bp}{20bp}}{{Cross}{20bp}{20bp}}%
+ {{Star}{20bp}{19bp}}{{RightArrow}{20bp}{14bp}}%
+ {{RightPointer}{20bp}{18bp}}{{UpArrow}{19bp}{20bp}}%
+ {{UpLeftArrow}{17bp}{17bp}}{{CrossHairs}{24bp}{24bp}}\do{%
+ \expandafter\getargsiii\ap@text@dimen
+ \ap@csarg\edef{ap@\ap@argi Width}{\ap@argii}%
+ \ap@csarg\edef{ap@\ap@argi Height}{\ap@argiii}%
+ }%
+\fi
+% \end{macrocode}
+% \subsection{Dimensions of Standard File Attachment Icons}
+% Similarly, the dimensions of each of the standard file attachment annotations
+% were obtained and recorded. All these dimensions have been reduced by 2pt, so that there final
+% dimensions match what is displayed through the ui.
+% \begin{macrocode}
+\ifuseAAXdim
+ \@tfor\ap@fa@dimen:={{Graph}{20bp}{20bp}}
+ {{Paperclip}{7bp}{17bp}}{{PushPin}{14bp}{20bp}}
+ {{Tag}{20bp}{16bp}}\do{%
+ \expandafter\getargsiii\ap@fa@dimen
+ \ap@csarg\edef{ap@\ap@argi Width}{\ap@argii}%
+ \ap@csarg\edef{ap@\ap@argi Height}{\ap@argiii}%
+ }%
+\else
+ \@tfor\ap@fa@dimen:={{Graph}{18bp}{18bp}}
+ {{Paperclip}{5bp}{15bp}}{{PushPin}{12bp}{18bp}}
+ {{Tag}{18bp}{14bp}}\do{%
+ \expandafter\getargsiii\ap@fa@dimen
+ \ap@csarg\edef{ap@\ap@argi Width}{\ap@argii}%
+ \ap@csarg\edef{ap@\ap@argi Height}{\ap@argiii}%
+ }%
+\fi
+% \end{macrocode}
+% \subsection{Dimensions of Standard Stamp Appearances}
+%
+% Some default stamp dimensions, when the dimensions are not known or provided. May be
+% redefined.
+% \begin{macrocode}
+\newcommand{\defaultStampWidth}{50bp}
+\newcommand{\defaultStampHeight}{50bp}
+% \end{macrocode}
+% The dimensions of the stamp appearances in the file \texttt{Standard.pdf}
+% \begin{macrocode}
+\newcommand{\standardStampWidth}{245.38bp}
+\newcommand{\standardStampHeight}{64.53bp}
+% \end{macrocode}
+% The dimensions of the stamp appearances in the file \texttt{StandardBusiness.pdf}
+% \begin{macrocode}
+\@tfor\ap@dimen:={{SBApproved}{163.50bp}{49.50bp}}
+ {{SBCompleted}{175.87bp}{49.50bp}}
+ {{SBConfidential}{209.62bp}{49.50bp}}
+ {{SBDraft}{113.14bp}{49.75bp}}
+ {{SBFinal}{97.80bp}{49.75bp}}
+ {{SBForComment}{211.87bp}{49.50bp}}
+ {{SBForPublicRelease}{290.04bp}{49.55bp}}
+ {{SBInformationOnly}{275.00bp}{49.55bp}}
+ {{SBNotApproved}{218.62bp}{49.50bp}}
+ {{SBNotForPublicRelease}{346.04bp}{49.55bp}}
+ {{SBPreliminaryResults}{304.04bp}{49.55bp}}
+ {{SBVoid}{91.04bp}{49.75bp}}\do{%
+ \expandafter\getargsiii\ap@dimen
+ \ap@csarg\edef{ap@\ap@argi Width}{\ap@argii}%
+ \ap@csarg\edef{ap@\ap@argi Height}{\ap@argiii}%
+ }
+% \end{macrocode}
+% The dimensions of the stamp appearances in the file \texttt{SignHere.pdf}
+% \begin{macrocode}
+\@tfor\ap@dimen:={{SBRejected}{22.68bp}{22.66bp}}
+ {{SHAccepted}{23.29bp}{20.45bp}}
+ {{SHInitialHere}{99.69bp}{30.34bp}}
+ {{SHSignHere}{99.69bp}{30.34bp}}
+ {{SHWitness}{99.69bp}{30.34bp}}\do{%
+ \expandafter\getargsiii\ap@dimen
+ \ap@csarg\edef{ap@\ap@argi Width}{\ap@argii}%
+ \ap@csarg\edef{ap@\ap@argi Height}{\ap@argiii}%
+ }
+% \end{macrocode}
+% The dimensions of the stamp appearances in the file \texttt{\texttt{Dynamic.pdf}}
+% \begin{macrocode}
+\catcode`\#=11\relax
+\@tfor\ap@dimen:={{#DApproved}{255.64bp}{53.83bp}}
+{{#DConfidential}{163.28bp}{57.10bp}}
+{{#DReceived}{255.64bp}{55.11bp}}
+{{#DReviewed}{255.64bp}{55.11bp}}
+{{#DRevised}{127.47bp}{55.85bp}}\do{%
+ \expandafter\getargsiii\ap@dimen
+ \ap@csarg\edef{ap@\ap@argi Width}{\ap@argii}%
+ \ap@csarg\edef{ap@\ap@argi Height}{\ap@argiii}%
+}
+\catcode`\#=6\relax
+\newcommand{\stampWidth}[1]{\csname ap@#1Width\endcsname}
+\newcommand{\stampHeight}[1]{\csname ap@#1Height\endcsname}
+% \end{macrocode}
+% The dimensions of the stamp appearances in the file Words.pdf
+% \begin{macrocode}
+\@tfor\ap@dimen:={{WordsAGenuineFind}{120.68bp}{190.83bp}}
+ {{WordsBigSavings}{282.84bp}{117.86bp}}
+ {{WordsDeals}{345.40bp}{132.55bp}}
+ {{WordsHappyBirthday}{326.50bp}{166.32bp}}
+ {{WordsHot}{249.64bp}{176.75bp}}
+ {{WordsLookWhatsNew}{316.59bp}{229.81bp}}
+ {{WordsNeato}{171.12bp}{86.88bp}}
+ {{WordsTheBestJustGotBetter}{153.53bp}{153.53bp}}\do{%
+ \expandafter\getargsiii\ap@dimen
+ \ap@csarg\edef{ap@\ap@argi Width}{\ap@argii}%
+ \ap@csarg\edef{ap@\ap@argi Height}{\ap@argiii}%
+ }
+% \end{macrocode}
+% The dimensions of the stamp appearances in the file \texttt{Faces.pdf}
+% \begin{macrocode}
+\@tfor\ap@dimen:={{FacesEcstatic}{223.20bp}{202.80bp}}
+ {{FacesElectric}{295.80bp}{280.50bp}}
+ {{FacesGrumpy}{289.92bp}{194.64bp}}
+ {{FacesHappy}{161.65bp}{161.65bp}}
+ {{FacesHurt}{289.50bp}{285.75bp}}
+ {{FacesNeutral}{291.04bp}{279.32bp}}
+ {{FacesSmirk}{276.75bp}{292.50bp}}
+ {{FacesSurprised}{220.08bp}{215.04bp}}
+ {{FacesWorried}{298.11bp}{235.12bp}}
+ {{FacesWow}{242.32bp}{289.17bp}}
+ {{FacesZippy}{290.59bp}{263.81bp}}\do{%
+ \expandafter\getargsiii\ap@dimen
+ \ap@csarg\edef{ap@\ap@argi Width}{\ap@argii}%
+ \ap@csarg\edef{ap@\ap@argi Height}{\ap@argiii}%
+ }
+% \end{macrocode}
+% The dimensions of the stamp appearances in the file \texttt{Pointers.pdf}
+% \begin{macrocode}
+\@tfor\ap@dimen:={{PointersBogus}{128.32bp}{53.82bp}}
+ {{PointersBug}{128.32bp}{51.94bp}}
+ {{PointersDOA}{136.99bp}{51.48bp}}
+ {{PointersFYEO}{128.32bp}{48.60bp}}
+ {{PointersFix}{145.60bp}{58.11bp}}
+ {{PointersNuke}{128.32bp}{52.30bp}}
+ {{PointersOptimize}{128.32bp}{48.60bp}}
+ {{PointersRedFlag}{128.32bp}{57.12bp}}
+ {{PointersValidate}{128.32bp}{48.60bp}}
+ {{PointersWarning}{128.32bp}{57.23bp}}
+ {{PointersWhen}{128.32bp}{63.79bp}}\do{%
+ \expandafter\getargsiii\ap@dimen
+ \ap@csarg\edef{ap@\ap@argi Width}{\ap@argii}%
+ \ap@csarg\edef{ap@\ap@argi Height}{\ap@argiii}%
+ }
+% \end{macrocode}
+% \subsection{Default dimensions of Free Text annotation}
+% \begin{macrocode}
+\def\ap@FreeTextWidth{144bp}
+\def\ap@FreeTextHeight{72bp}
+% \end{macrocode}
+% \begin{macro}{\makeStamp}
+% A command to help the creation of custom stamps using graphicxsp. You've got to see it
+% to believe it.
+% \begin{macrocode}
+\newcommand{\makeStamp}[3]{%
+ \ap@csarg\def{stamp@#2}{%
+ \begin{sp@createImage}{#1}{#2\the\ap@cusstamp@cnt}
+ \ap@add@ops#3
+ \end{sp@createImage}}}
+\let\ap@add@ops\@empty
+% \end{macrocode}
+% \end{macro}
+% This command is used internal in \cs{annotpro} to generate an appearance for
+% the stamp.
+% \begin{macrocode}
+\newcommand{\ap@useStamp}[1]{%
+ \global\advance\ap@cusstamp@cnt1\relax
+ \@nameuse{stamp@#1}}
+% \end{macrocode}
+% \begin{macro}{\setAnnotOptions}
+% A command for setting global options.
+% \begin{macrocode}
+\newcommand{\setAnnotOptions}[1]{%
+ \setkeys{annotpro}{#1}%
+}
+% \end{macrocode}
+% \end{macro}
+% The following code is taken from the \textsf{datetime} package (and modified) as maintained by
+% Nicola Talbot. There is no need for the whole package, we just need
+% \cs{pdfdate}, named \cs{ap@pdfdate} in \textsf{annot\_pro}. We make all calculations in a group.
+%\changes{v1.0a}{2011/07/14}{Added \cs{ap@pdfdate}}
+% \begin{macrocode}
+\begingroup
+ \def\withoptz@#1{\ifnum#1<10 0\fi\the#1}
+ \edef\ap@pdfdate{\the\year\withoptz@\month\withoptz@\day}
+% \end{macrocode}
+% Calculate the minutes after the hour time by dividing by 60.
+% \begin{macrocode}
+ \count0=\time \count2=\count0
+% \end{macrocode}
+% Calculate the number of hours after midnight by dividing by 60
+% \begin{macrocode}
+ \divide\count2by60
+ \edef\ap@pdfdate{\ap@pdfdate\withoptz@{\count2}}
+ \multiply\count2by60 \advance\count0by-\count2
+ \xdef\ap@pdfdate{\ap@pdfdate\withoptz@{\count0}00}
+\endgroup
+% \end{macrocode}
+% \section{The main code}
+% \changes{v1.1c}{2017/06/06}{Define convenience command \string\cs{currentAnnotName}}
+% \begin{macrocode}
+\newcount\ap@annot@cnt
+\def\currentAnnotName{annotpro\the\ap@annot@cnt}
+\newcount\ap@cusstamp@cnt
+{\catcode`\#=12\gdef\ap@signalCustomAP{#}}
+\def\pStamp#1{\ap@signalCustomAP#1}
+% \end{macrocode}
+% \begin{macrocode}
+\def\ap@RV@Body{<?xml version="1.0"?><body %
+ xfa:APIVersion="Acrobat:9.5.5" %
+ xfa:contentType="text/html" %
+ xfa:spec="2.0.2" xmlns="http://www.w3.org/1999/xhtml" %
+ xmlns:xfa="http://www.xfa.org/schema/xfa-data/1.0/">}
+\def\ap@RV@endBody{<body>}
+% \end{macrocode}
+% The implementation of rich text in a FreeText annotation is a little different from
+% that of a rich text form field. We made some adjustments here for an annotation.
+% \begin{macrocode}
+\def\ap@sub#1{%
+ \rvorvstring{<span style="vertical-align:-0.0pt;">#1</span>}{#1}}%
+\def\ap@sup#1{%
+ \rvorvstring{<span style="vertical-align:+0.0pt;">#1</span>}{#1}}%
+\def\ap@uDec#1{\rt@amp\rt@hashtag#1;}
+\def\ap@uHex#1{\rt@amp\rt@hashtag x#1;}
+\def\ap@afterParaFont{%
+% \end{macrocode}
+% Cancel out certain attributes that are not used in annotation.
+% \begin{macrocode}
+ \rt@formfieldfalse
+}
+\def\ap@afterFont{\rt@formfieldfalse\let\rt@url\@empty}
+% \end{macrocode}
+% \begin{environment}{textboxpara}
+% Rich text for the Text Box annotation is enclosed within this environment, then use \cs{rtpara} to
+% format the text.
+% \begin{macrocode}
+\newenvironment{textboxpara}{%
+ \let\rt@sub\ap@sub\let\rt@sup\ap@sup
+ \let\rt@afterParaFont\ap@afterParaFont
+ \let\rt@afterFont\ap@afterFont
+ \def\rt@br{\rvorvstring{\rt@amp\rt@hashtag13;}{\string\r}}%
+ \def\rt@spc{\space}\let\uDec\ap@uDec\let\uHex\ap@uHex
+}{}
+% \end{macrocode}
+% \end{environment}
+%
+% \subsection{The \texorpdfstring{\protect\cs{annotpro}}{\textbackslash{annotpro}} command defined}
+%
+% \begin{macro}{\annotpro}
+% \leavevmode\hskip-\marginparsep\texttt{[\ameta{options}]\darg{\ameta{content}}[\darg{\ameta{text}}]}
+% \cs{annotpro} is the main command of this package, the first optional parameter
+% are key-value pairs, as defined above; the second parameter is the content
+% of the message. The third parameter (\ameta{text}) is only required when the building
+% a text markup annotation. File attachments have not popup message, so the content
+% becomes the description of the attachment in the attachments panel; hence,
+% in this case, the length of the message should be short.
+% \begin{macrocode}
+\newcommand{\annotpro}{%
+ \begingroup
+% \end{macrocode}
+% Some of the stamp names begin with \texttt{\#}, the user must use
+% \verb!\#!
+% \begin{macrocode}
+ \let\#\ap@signalCustomAP
+ \@nnotpro}
+% \end{macrocode}
+% Added a star option to \cs{annotpro}. When specified (\DescribeMacro{\annotpro*}\cs{annotpro*}),
+% the options are expanded with \cs{setkeys*}. Also new is the
+% options are expanded first before \cs{setkeys} or \cs{setkeys*} is applied.
+% \changes{v1.1c}{2017/06/06}{Added a star option to \string\cs{annotpro}}
+% \begin{macrocode}
+\def\@nnotpro{\@ifstar{\def\qr@isStar{*}\@nnotproi}
+ {\let\qr@isStar\@empty\@nnotproi}}
+% \end{macrocode}
+% \texttt{\#1=\ameta{options}}
+% \begin{macrocode}
+\newcommand{\@nnotproi}[1][]{%
+% \end{macrocode}
+% Process options after expanding them
+% \begin{macrocode}
+ \expandafter\setkeys\qr@isStar{annotpro}{#1}%
+% \end{macrocode}
+% See if there were any presets, if so, expand them, and apply
+% \cs{setkeys} again. (Note: moved up from \cs{@nn@tpro})
+% \begin{macrocode}
+ \ifx\annotpro@presets\@empty\else
+ \edef\ap@exp@tmp{\noexpand\setkeys{annotpro}{\annotpro@presets}}%
+ \ap@exp@tmp\fi
+% \end{macrocode}
+% If no type was specified, assume \texttt{Text}.
+% \cs{setkeys} again.
+% \begin{macrocode}
+ \ifx\ap@type\@empty\def\ap@type{Text}\def\ap@save@type{0}\fi
+ \ifx\annotpro@internalID\@empty
+% \end{macrocode}
+% Increment a global counter, to count the annots as we create them.
+% \begin{macrocode}
+ \global\advance\ap@annot@cnt1\relax
+ \xdef\currentAnnotName{annotpro\the\ap@annot@cnt}\else
+ \xdef\currentAnnotName{\annotpro@internalID}\fi
+ \ifnum\ap@save@type>3\relax
+% \end{macrocode}
+% Separate text markup from the others since it has a third argument
+% \begin{macrocode}
+ \expandafter\@nn@tprotm\else
+ \expandafter\@nn@tpro\fi}
+% \end{macrocode}
+% A simple command to detect whether the first eight tokens in \texttt{\#}
+% spells out the word `richtext', if yes, then this argument contains
+% the key \key{richtext}.
+% \begin{macrocode}
+\def\isrichtextkey#1#2#3#4#5#6#7#8#9\@nil{\def\@rgs{#1#2#3#4#5#6#7#8}%
+ \def\ap@rt{richtext}\ifx\@rgs\ap@rt\let\ap@richtext\ap@YES\else
+ \let\ap@richtext\ap@NO\fi}
+\let\ap@richtext\ap@NO
+% \end{macrocode}
+% \texttt{\#1=\ameta{content}}: the first argument of \cs{@nn@tpro} is the second argument
+% of \cs{annotpro}.
+% \begin{macrocode}
+\newcommand{\@nn@tpro}[1]
+{%
+% \end{macrocode}
+% Now get the value of the name parameter, permissible values depend
+% on the stated \texttt{type}.
+% \begin{macrocode}
+ \ifcase\ap@save@type\relax
+ \def\annot@subtype{annnotprotext}%
+ \ifx\annotpro@subject\@empty\def\annotpro@subject{Sticky Note}\fi
+ \ifx\annotpro@name\@empty\def\annotpro@name{Note}\fi
+ \def\ap@def@name{Note}%
+ \or
+ \ifx\annotpro@subject\@empty\def\annotpro@subject{Rubber Stamp}\fi
+ \def\annot@subtype{annnotprostamp}%
+ \def\ap@def@name{Draft}%
+ \or
+ \ifx\annotpro@subject\@empty
+ \def\annotpro@subject{File Attachment}\fi
+ \def\annot@subtype{annnotprofileattach}%
+ \def\ap@def@name{PushPin}%
+ \or
+ \ifx\annotpro@subject\@empty
+ \def\annotpro@subject{Text Box}\fi
+ \def\annot@subtype{annotprofreetext}%
+ \def\ap@def@name{FreeText}%
+ \fi
+% \end{macrocode}
+% Get the name
+% \begin{macrocode}
+ \edef\ap@exp@tmp{\noexpand
+ \setkeys{\annot@subtype}{name=\annotpro@name}}%
+ \ap@exp@tmp\xdef\ap@def@type{\ap@type}%
+% \end{macrocode}
+% Encode text for contents, title, subject, and color; here \textsf{hyperref}
+% commands are used.
+% \begin{macrocode}
+ \let\annotpro@enc@contents\@empty
+% \end{macrocode}
+% \changes{v1.0b}{2012/11/10}{Included \cs{makespecialJS}}
+% We'll use \cs{makespecialJS} here.
+% \begin{macrocode}
+ \makespecialJS
+% \end{macrocode}
+% If this is a FreeText annot, we get the rich text and default style from \texttt{\#1}.
+% Supported keys are richtext and defstyle. The values of these keys are names defined
+% by \cs{setRVVContents} and \cs{setDefaultStyle}. If \texttt{defstyle} is not specified, we
+% use \cs{useDefaultDS}.
+% \begin{macrocode}
+ \if\ap@save@type\ap@freetext@type
+ \let\eq@RV@Body\ap@RV@Body\let\eq@RV@endBody\ap@RV@endBody
+ \setkeys{annotprofreetext}{#1}%
+ \ifx\annotpro@@ds\@empty
+ \def\ap@defaultstyle{\useDefaultDS}\else
+ \edef\ap@defaultstyle{\noexpand\useDS{\annotpro@@ds}}\fi
+ \ifx\annotpro@@rt\@empty
+ \let\annotpro@RC\@empty\let\annotpro@C\@empty\else
+ \edef\annotpro@RC{\noexpand\useRVContent{\annotpro@@rt}}%
+ \edef\annotpro@C{\noexpand\useVContent{\annotpro@@rt}}\fi
+ \else
+% \end{macrocode}
+% If this is not a free text (text box), we'll check if this argument contains the \texttt{richtext}.
+% We use \cs{isrichtextkey} to determine if the \key{richtext} key is present. We do this to
+% protect \cs{setkeys} against any crazy content for its argument.
+% \begin{macrocode}
+ \isrichtextkey#1;;;;;;;;\@nil
+ \ifx\ap@richtext\ap@YES
+ \setkeys*{annotprofreetext}{#1}%
+ \ifx\XKV@rm\@empty
+ \ifx\annotpro@@ds\@empty
+ \def\ap@defaultstyle{\useDefaultDS}\else
+ \PackageWarning{annot_pro}{The defstyle key is not supported
+ for this \MessageBreak
+ annotation type. I'm ignoring it}%
+ \let\annotpro@@ds\@empty
+ \fi
+ \ifx\annotpro@@rt\@empty % dps17
+ \let\annotpro@RC\@empty\let\annotpro@C\@empty\else
+ \edef\annotpro@RC{\noexpand\useRVContent{\annotpro@@rt}}%
+ \edef\annotpro@C{\noexpand\useVContent{\annotpro@@rt}}\fi
+ \else
+ \pdfstringdef\annotpro@enc@contents{#1}\fi
+ \else
+ \pdfstringdef\annotpro@enc@contents{#1}%
+ \fi
+ \fi
+ \let\annotpro@enc@title\@empty
+ \pdfstringdef\annotpro@enc@title{\annotpro@title}%
+ \let\annotpro@enc@subject\@empty
+ \pdfstringdef\annotpro@enc@subject{\annotpro@subject}%
+% \end{macrocode}
+% Color handling for \texttt{color}, \texttt{bgcolor}, and \texttt{bcolor} via \pkg{hycolor} package
+% \begin{macrocode}
+ \HyColor@XZeroOneThreeFour{\annotpro@color}%
+ {\annotpro@enc@color}{annotpro}{color}%
+\ifx\annotpro@bgcolor\@empty\else
+ \HyColor@XZeroOneThreeFour{\annotpro@bgcolor}
+ {\annotpro@enc@bgcolor}{annotpro}{bgcolor}\fi
+\ifx\annotpro@bcolor\@empty
+ \edef\annotpro@bcolor{\annotpro@def@bcolor}\fi
+ \HyColor@FieldColor{\annotpro@bcolor}
+ {\annotpro@enc@bcolor}{annotpro}{bcolor}%
+% \end{macrocode}
+% Initialize some commands to be used later
+% \begin{macrocode}
+ \let\ap@this@AP\@empty\let\ap@this@FS\@empty\let\ap@this@CA\@empty
+ \let\ap@this@Rotate\@empty
+% \end{macrocode}
+% See if opacity is requested, and set appropriate key.
+% \begin{macrocode}
+ \ifx\annotpro@opacity\@empty\else
+ \def\ap@this@CA{/CA \annotpro@opacity}\fi
+% \end{macrocode}
+% Now, perform annotation specific tasks such as setting the
+% bounding box.
+% \begin{macrocode}
+ \ifcase\ap@save@type
+% \end{macrocode}
+% \textbf{Text annotation.} We use the pre-defined dimensions for
+% these text icons, unless the user has specified \texttt{nohspace},
+% \texttt{novspace}, and \texttt{nospace}. If the name has not been
+% specified, we use the default (\texttt{Note}).
+% \begin{macrocode}
+ \ifx\annotpro@@name\@empty\edef\annotpro@@name{\ap@def@name}\fi
+ \edef\ap@thisWidth{\ifx\annotpro@hspace\@empty
+ \@nameuse{ap@\annotpro@@name Width}\else
+ \annotpro@hspace\fi}%
+ \edef\ap@thisHeight{\ifx\annotpro@vspace\@empty
+ \@nameuse{ap@\annotpro@@name Height}\else
+ \annotpro@vspace\fi}%
+% \end{macrocode}
+% \textbf{Stamp annotation.} This is a bit trickier, there are three
+% cases: (1) the user references a standard stamp; (2) the user
+% references a non-standard stamp, one that ships with Acrobat; (3)
+% the user wants to create his own custom stamp using
+% \textsf{graphicxsp} techniques.
+% \begin{macrocode}
+ \or
+ \ifx\annotpro@@name\@empty
+ \ifx\ap@custom@name\@empty
+ \ifx\ap@customstamp@name\@empty
+% \end{macrocode}
+% Neither \texttt{name} nor \texttt{customStamp} was specified, so we assume the default.
+% \begin{macrocode}
+ \ifx\annotpro@@name\@empty
+ \edef\annotpro@@name{\ap@def@name}\fi
+ \edef\ap@thisWidth{\standardStampWidth}%
+ \edef\ap@thisHeight{\standardStampHeight}%
+ \else
+% \end{macrocode}
+% Here the user wants a stamp using \textsf{graphicxsp} techniques.
+% \begin{macrocode}
+ \if\ap@graphicxsp0\PackageError{annot_pro}%
+ {Specifying a custom name for a stamp requires
+ the graphicxsp package.}\fi
+ \ifx\annotpro@ap\@empty
+ \PackageError{annot_pro}{You must specify a value
+ for the ap key}\fi
+ \def\ap@ImageRef{\annotpro@ap\the\ap@cusstamp@cnt}%
+ \expandafter\ap@useStamp\expandafter{\annotpro@ap}%
+% \end{macrocode}
+% We do not allow custom stamps to be initially rotated.
+% \changes{v1.1c}{2017/06/06}{For custom stamps, do not allow the rotate
+% key to be nonzero.}
+% \begin{macrocode}
+ \ifx\annotpro@rotate\@empty\else
+ \PackageWarning{annot_pro}{The rotate
+ key for a custom stamp is not\MessageBreak
+ supported. Setting rotate=0}%
+ \let\annotpro@rotate\@empty
+ \fi
+% \end{macrocode}
+% After making many experiments, there seems to be a need to
+% reduce dimensions by \texttt{2bp} so that the desired dimensions
+% are displayed through the user interface. There seems to
+% be an 1bp border around all stamps.
+% \begin{macrocode}
+ \edef\ap@thisWidth{\widthOf{\ap@ImageRef}bp}%
+ \@tempdima=\ap@thisWidth\advance\@tempdima-2bp
+ \edef\ap@thisWidth{\the\@tempdima}%
+ \edef\ap@thisHeight{\heightOf{\ap@ImageRef}bp}%
+ \@tempdima=\ap@thisHeight\advance\@tempdima-2bp
+ \edef\ap@thisHeight{\the\@tempdima}%
+ \def\ap@this@AP{/AP << /N {\ap@ImageRef} >>}%
+ \edef\annotpro@@name{%
+ \ap@signalCustomAP\ap@customstamp@name}%
+ \fi
+ \else
+% \end{macrocode}
+% The command \cs{ap@custom@name} is non-empty, so the user it trying
+% to access a stamp on his own system. The user has indicated one of
+% the stamps documented in the PDF Reference, these all have the same
+% dimension
+%
+% For the bounding box, we use \cs{defaultStampWidth} by
+% \cs{defaultStampHeight} as the dimensions, unless the values of
+% \texttt{width} and/or \texttt{height} are specified.
+% \begin{macrocode}
+ \edef\annotpro@@name{\ap@custom@name}%
+ \@ifundefined{ap@\ap@custom@name Width}{%
+ \edef\ap@thisWidth{\ifx\annotpro@width\@empty
+ \defaultStampWidth\else\annotpro@width\fi}%
+ \edef\ap@thisHeight{\ifx\annotpro@height\@empty
+ \defaultStampWidth\else\annotpro@height\fi}%
+ }{%
+ \edef\ap@thisWidth{\ifx\annotpro@width\@empty
+ \@nameuse{ap@\annotpro@@name Width}\else
+ \annotpro@width\fi}%
+ \edef\ap@thisHeight{\ifx\annotpro@height\@empty
+ \@nameuse{ap@\annotpro@@name Height}\else
+ \annotpro@height\fi}%
+ }%
+ \fi
+ \else
+% \end{macrocode}
+% This is the case of specifying one of the document stamps, as
+% listed in the PDF Reference.
+% \begin{macrocode}
+ \edef\ap@thisWidth{\standardStampWidth}%
+ \edef\ap@thisHeight{\standardStampHeight}%
+ \fi
+% \end{macrocode}
+% Let's use calc to allow for calculations on dimensions,
+% with this, we can conveniently resize the box.
+% \begin{macrocode}
+ \ifx\annotpro@scale\@empty
+ \ifx\annotpro@widthTo\@empty
+ \ifx\annotpro@heightTo\@empty\else % heightTo
+ \edef\ap@thisWidth{%
+ (\ap@thisWidth)*\noexpand
+ \ratio{\annotpro@heightTo}{\ap@thisHeight}}%
+ \edef\ap@thisHeight{\annotpro@heightTo}%
+ \fi
+ \else % widthTo
+ \edef\ap@thisHeight{%
+ (\ap@thisHeight)*\noexpand
+ \ratio{\annotpro@widthTo}{\ap@thisWidth}}%
+ \edef\ap@thisWidth{\annotpro@widthTo}%
+ \fi
+ \else %scale
+ \edef\ap@thisWidth{(\ap@thisWidth)*\noexpand
+ \real{\annotpro@scale}}%
+ \edef\ap@thisHeight{(\ap@thisHeight)*\noexpand
+ \real{\annotpro@scale}}%
+ \fi
+ \setlength{\@tempdima}{\ap@thisWidth}%
+ \edef\ap@thisWidth{\the\@tempdima}%
+ \setlength{\@tempdima}{\ap@thisHeight}%
+ \edef\ap@thisHeight{\the\@tempdima}%
+ \ifx\annotpro@rotate\empty\else
+ \def\ap@this@Rotate{/Rotate \annotpro@rotate}%
+ \ap@set@Rotate@BBox
+ \fi
+ \or
+% \end{macrocode}
+% \textbf{File Attachment annotation.} There are only a few icons for
+% file attachments, and I've determined their dimensions using the user
+% interface. So, we use those.
+%
+% If a name has not been specified, we use the default (\texttt{PushPin}).
+% \begin{macrocode}
+ \ifx\annotpro@@name\@empty\edef\annotpro@@name{\ap@def@name}\fi
+ \ifx\annotpro@file\@empty\PackageError{annot_pro}%
+ {You must specify a path the file to be
+ attached using the file key.}\fi
+% \end{macrocode}
+% Set the \textbf{FS} key to specify the file.
+% \begin{macrocode}
+ \def\ap@this@FS{/FS {apEmbedFile\the\ap@annot@cnt}}%
+ \edef\ap@thisWidth{\@nameuse{ap@\annotpro@@name Width}}%
+ \edef\ap@thisHeight{\@nameuse{ap@\annotpro@@name Height}}%
+ \ap@EmbedThisFile
+ \or
+% \end{macrocode}
+% \textbf{Free text annotation.}
+% \begin{macrocode}
+ \ifx\annotpro@@name\@empty\edef\annotpro@@name{\ap@def@name}\fi
+ \ifx\annotpro@width\@empty\else
+ \setlength\@tempdima{\annotpro@width}%
+ \def\annotpro@width{\the\@tempdima}\fi
+ \edef\ap@thisWidth{\ifx\annotpro@width\@empty
+ \@nameuse{ap@\annotpro@@name Width}\else
+ \annotpro@width\fi}%
+ \ifx\annotpro@height\@empty\else
+ \setlength\@tempdima{\annotpro@height}%
+ \def\annotpro@height{\the\@tempdima}\fi
+ \edef\ap@thisHeight{\ifx\annotpro@height\@empty
+ \@nameuse{ap@\annotpro@@name Height}\else
+ \annotpro@height\fi}%
+ \fi % \ifcase
+% \end{macrocode}
+% if \texttt{margin} is specified, we insert a \cs{marginpar} here.
+% \begin{macrocode}
+ \ifx\annotpro@margin\@empty\let\apmargintext\@empty
+ \let\b@Mini\relax\let\e@Mini\relax\else
+ \def\b@Mini{\minipage[c]{\marginparwidth}}\def\e@Mini{\endminipage}%
+ \expandafter\marginpar\fi
+% \end{macrocode}
+% Set the bounding box, and layout the annotation using the \textbf{pdfmark} operator.
+% \changes{v1.1c}{2017/06/06}{added \string\cs{anp@margprior} followed by braces, so
+% \string\cs{anp@margprior} could operate on the annot as a whole.}
+% \begin{macrocode}
+ {\anp@margprior{\b@Mini
+ \pdf@rect{\ap@Bbox{\ap@thisWidth}{\ap@thisHeight}}\literalps@out{%
+ \ap@mark\eq@objdef\ap@Rect
+ /F 4\ap@hidden\ap@readonly
+ /Open \annotpro@open
+ /Title (\annotpro@enc@title)
+ /Subj (\annotpro@enc@subject)
+% \end{macrocode}
+% We have different set of keys for FreeText when for the other annotation types.
+% \begin{macrocode}
+ \if\ap@save@type\ap@freetext@type
+% \end{macrocode}
+% The definitions of \cs{eq@RV@Body} and \cs{eq@RV@endBody} come from \pkg{richtext}, originally from
+% \pkg{eforms}. The \psf{RC} and \psf{Contents} entries get their values from \cs{annotpro@RC} and
+% \cs{annotpro@C}, which are acquired from the \pkg{richtext} package.
+% \begin{macrocode}
+ /RC(\eq@RV@Body\annotpro@RC\eq@RV@endBody)
+ /Contents (\annotpro@C)
+ /DS (\ap@defaultstyle)
+ \ifx\annotpro@bgcolor\@empty\else
+ /C [\annotpro@enc@bgcolor]\fi
+ /DA (\annotpro@enc@bcolor\space/Helv 12 Tf)
+ \ap@border@code
+% \end{macrocode}
+% Not a text box; either the doc author is passing the content directly, or wants to pass
+% rich text.
+% \begin{macrocode}
+ \else
+ \ifx\annotpro@@rt\@empty
+% \end{macrocode}
+% Not rich text, need only the \texttt{/Contents} key
+% rich text.
+% \begin{macrocode}
+ /Contents (\annotpro@enc@contents)
+ \else
+% \end{macrocode}
+% Rich text, need the \texttt{/RC} key rich text.
+% \begin{macrocode}
+ /RC(\eq@RV@Body\annotpro@RC\eq@RV@endBody)
+ /Contents (\annotpro@C)
+ /DA (\annotpro@enc@bcolor\space/Helv 12 Tf)
+ \fi
+ /Open \annotpro@open
+ /Color [\annotpro@enc@color]
+ \fi
+% \end{macrocode}
+% \changes{v1.0a}{2011/07/14}{Changed the value of the \texttt{/Name} key.}
+% Changed the value of \texttt{/Name} from a name to a string
+% \begin{macrocode}
+ /Name (\annotpro@@name)
+ /Subtype/\ap@type
+ /NM (\currentAnnotName)
+ /M (D:\ap@pdfdate)
+ \ap@this@AP\ap@this@FS\ap@this@CA\ap@this@Rotate
+ /ANN pdfmark}\apmargintext\e@Mini}}%end grouping, end marginpar
+ \to@insertStrucTabOrder{Annot}\endgroup
+}
+% \end{macrocode}
+% \end{macro}
+% \textbf{Text markup annotation.} We try to leverage the code of \pkg{aeb\_mlink} to create
+% the quad points necessary for this annotation type. The key is to redefine \cs{setLinkPbox}
+% (\pkg{eforms}), which normally creates a link, to something that will generate the
+% annotation type we require (\cs{setTextM@rkup}).
+% \changes{v1.4}{2018/08/13}{Added text markup}
+% \par\medskip\noindent
+% When a text markup annotation crosses page boundaries, rather than copying the contents to
+% the cross-over annot, we insert \DescribeMacro{\apContText}\cs{apContText}.
+% \begin{macrocode}
+\newcommand{\apContText}{Continued from previous annotation}
+% \end{macrocode}
+% We use the \pkg{aeb\_mlink} package to compute the quadpoints. To do that
+% we \cs{let} \cs{setLinkPbox} (\pkg{eforms}) to \cs{setTextM@rkup}, which we define below.
+% \begin{macrocode}
+\newcommand{\setTextM@rkup}[1]{%
+ \literalps@out{%
+ bCreateLink { xoMsgB { true true and mlRectFix^^J%
+ \ap@mark\eq@objdef\pboxRect
+ /F 4\ap@hidden\ap@readonly
+ /Open \annotpro@open
+ /Title (\annotpro@enc@title)
+ /Subj (\annotpro@enc@subject)
+ \ifx\annotpro@@rt\@empty
+ /Contents
+ \ifcr@ckit
+ \ifKV@annotpro@copycontent
+ (\annotpro@enc@contents)\else
+ (\apContText)\fi
+ \else
+ (\annotpro@enc@contents)\fi
+ \else
+ \ifcr@ckit
+ \ifKV@annotpro@copycontent
+ /RC(\eq@RV@Body\annotpro@RC\eq@RV@endBody)
+ /Contents (\annotpro@C)\else
+ /Contents (\apContText)\fi
+ \else
+ /RC(\eq@RV@Body\annotpro@RC\eq@RV@endBody)
+ /Contents (\annotpro@C)\fi
+ /DA (\annotpro@enc@bcolor\space/Helv 12 Tf)
+ \fi
+ /Open \annotpro@open
+ /Color [\annotpro@enc@color]
+ /Subtype/\ap@type
+ /NM (\currentAnnotName)
+ /M (D:\ap@pdfdate)
+ #1
+ \ap@this@AP\ap@this@FS\ap@this@CA\ap@this@Rotate
+ /ANN pdfmark
+ }if}{(\ml@@nnotName\the\aeb@mLinkCnt) mlIsBldMsg}ifelse
+ }%
+}
+% \end{macrocode}
+% \DescribeMacro{\@nn@tprotm}\hskip-\marginparsep\texttt{\darg{\ameta{content}}\darg{\ameta{text}}} The continuation of \cs{annotpro}, for the case
+% of a text markup annotation. Its two arguments are
+% \texttt{\ameta{content}}, \texttt{\ameta{text}}, the options were
+% previously gathered up and passed.
+% \begin{macrocode}
+\newcommand{\@nn@tprotm}[2]{%
+% \end{macrocode}
+% Now get the value of the name parameter, permissible values depend
+% on the stated \texttt{type}. For text markups, \cs{ap@save@type} is
+% larger than 3.
+% \begin{macrocode}
+ \@tempcnta\ap@save@type\relax
+ \advance\@tempcnta-4\relax
+ \ifcase\@tempcnta
+% \end{macrocode}
+% Text markup annotation (not yet developed)
+% \changes{v1.3}{2018/04/26}{Added text markup annotation code outline}
+% \begin{macrocode}
+ \ifx\annotpro@subject\@empty
+ \def\annotpro@subject{Highlight}\fi
+ \def\ap@def@name{Highlight}%
+ \ifx\ap@isColorKey\ap@NO
+ \def\annotpro@color{1 0.81961 0}\fi
+ \or % 5
+ \ifx\annotpro@subject\@empty
+ \def\annotpro@subject{Underline}\fi
+ \def\ap@def@name{Underline}%
+ \ifx\ap@isColorKey\ap@NO
+ \def\annotpro@color{0.41568 0.85098 0.14902}\fi
+ \or % 6
+ \ifx\annotpro@subject\@empty
+ \def\annotpro@subject{Underline}\fi
+ \def\ap@def@name{Squiggly}%
+ \ifx\ap@isColorKey\ap@NO
+ \def\annotpro@color{0.41568 0.85098 0.14902}\fi
+ \or % 7
+ \ifx\annotpro@subject\@empty
+ \def\annotpro@subject{Cross-Out}\fi
+ \def\ap@def@name{StrikeOut}%
+ \ifx\ap@isColorKey\ap@NO
+ \def\annotpro@color{0.89804 0.13333 0.21568}\fi
+ \fi
+ \setkeys*{annotprofreetext}{#1}%
+ \ifx\XKV@rm\@empty
+ \ifx\annotpro@@ds\@empty
+ \def\ap@defaultstyle{\useDefaultDS}\else
+ \PackageWarning{annot_pro}{The defstyle key is not supported
+ for this \MessageBreak
+ annotation type. I'm ignoring it}%
+ \let\annotpro@@ds\@empty
+ \fi
+ \ifx\annotpro@@rt\@empty % dps17
+ \let\annotpro@RC\@empty\let\annotpro@C\@empty\else
+ \edef\annotpro@RC{\noexpand\useRVContent{\annotpro@@rt}}%
+ \edef\annotpro@C{\noexpand\useVContent{\annotpro@@rt}}\fi
+ \else
+ \pdfstringdef\annotpro@enc@contents{#1}%
+ \fi
+ \let\annotpro@enc@title\@empty
+ \pdfstringdef\annotpro@enc@title{\annotpro@title}%
+ \let\annotpro@enc@subject\@empty
+ \pdfstringdef\annotpro@enc@subject{\annotpro@subject}%
+ \HyColor@XZeroOneThreeFour{\annotpro@color}%
+ {\annotpro@enc@color}{annotpro}{color}%
+\ifx\annotpro@bgcolor\@empty\else
+ \HyColor@XZeroOneThreeFour{\annotpro@bgcolor}
+ {\annotpro@enc@bgcolor}{annotpro}{bgcolor}\fi
+\ifx\annotpro@bcolor\@empty
+ \edef\annotpro@bcolor{\annotpro@def@bcolor}\fi
+ \HyColor@FieldColor{\annotpro@bcolor}
+ {\annotpro@enc@bcolor}{annotpro}{bcolor}%
+ \let\ap@this@AP\@empty\let\ap@this@FS\@empty\let\ap@this@CA\@empty
+ \let\ap@this@Rotate\@empty
+ \ifx\annotpro@opacity\@empty\else
+ \def\ap@this@CA{/CA \annotpro@opacity}\fi
+% \end{macrocode}
+% The following definitions are directed at and implemented in the \pkg{aeb\_mlink}
+% package.
+% \begin{macrocode}
+ \def\QuadPoints##1{/QuadPoints {##1}}%
+ \def\MrkLnkLtr{A}\def\ml@@nnotName{Annot}%
+ \mlfixOn
+ \def\FixupProc{aFixup}%
+ \ifx\eq@mlcrackat\@empty
+ \let\eq@mlignore\ef@YES\fi
+ \def\mlignore##1{}%
+ \let\setLinkPbox\setTextM@rkup
+ \def\pboxRect{mlRect }%
+ \let\ef@colorthislink\normalcolor
+% \end{macrocode}
+% To obtain the \texttt{QuadPoints}, we pass through \cs{mlhypertext}, defined in the
+% \pkg{aeb\_mlink} package.
+% \begin{macrocode}
+ \mlhypertext{#2}% Get quad points
+ \to@insertStrucTabOrder{Annot}\endgroup
+}
+% \end{macrocode}
+% \textbf{Rubber Stamp Annotations.} When the user specifies the rotate key, we need to enlarge the
+% bounding box so the stamp can be rotated within that box.
+% \begin{macrocode}
+\def\ap@set@Rotate@BBox{%
+ \CalculateSin\annotpro@rotate\CalculateCos\annotpro@rotate
+ \edef\c@cos{\UseCos\annotpro@rotate}%
+ \edef\c@sin{\UseSin\annotpro@rotate}%
+% \end{macrocode}
+% Determine the quadrant i or iii versus ii or iv
+% \begin{macrocode}
+ \@tempdimb=\c@cos pt
+ \@tempdimb=\c@sin\@tempdimb
+ \let\ap@sign\@empty
+ \ifdim\@tempdimb<\z@\def\ap@sign{-}\fi
+% \end{macrocode}
+%What we are doing is calculating the \emph{smallest rectangle} whose sides are parallel
+%to the horizontal and vertical, that contained the rotated stamp. We use this computed
+%rectangle as the bounding rectangle of the rectangle.
+%
+%The basic algorithm is as follows:
+% If the angle is in the first or third quadrant, we use
+%\begin{align*}
+% \text{width} &=\text{width}'\cos(\theta)+\text{height}'\sin(\theta)\\
+% \text{height} &=\text{width}'\sin(\theta)+\text{height}'\cos(\theta)
+%\end{align*}
+%else, we use
+%\begin{align*}
+% \text{width} &=-\text{width}'\cos(\theta)+\text{height}'\sin(\theta)\\
+% \text{height}&=\text{width}'\sin(\theta)-\text{height}'\cos(\theta)
+%\end{align*}
+% where, $\text{width}'$ and $\text{height}'$ are the original width and height of the bounding rectangle,
+% and $\text{width}$ and $\text{height}$ are the new dimensions of the rectangle, after rotation through
+% an angle of $\theta$.
+% \paragraph*{Width calculation.} Width held in \cs{ap@temp@thisWidth}.
+% \begin{macrocode}
+ \@tempdima=\ap@sign\ap@thisWidth
+ \@tempdima=\c@cos\@tempdima
+ \@tempdimb=\ap@thisHeight
+ \@tempdimb=\c@sin\@tempdimb
+ \advance\@tempdima by\@tempdimb
+ \edef\ap@temp@thisWidth{\the\@tempdima}%
+% \end{macrocode}
+% \paragraph*{Height calculation.} Final height held is \cs{@tempdima}.
+% \begin{macrocode}
+ \@tempdima=\ap@thisWidth
+ \@tempdima=\c@sin\@tempdima
+ \@tempdimb=\ap@thisHeight
+ \@tempdimb=\c@cos\@tempdimb
+ \advance\@tempdima by\ap@sign\@tempdimb
+% \end{macrocode}
+% Any negative dimensions are changed to positive.
+% \begin{macrocode}
+ \@tempdimb=\ap@temp@thisWidth\relax
+ \ifdim\@tempdimb<\z@\@tempdimb=-\the\@tempdimb\fi
+ \ifdim\@tempdima<\z@\@tempdima=-\the\@tempdima\fi
+% \end{macrocode}
+% Here are the final calculations, \cs{ap@thisWidth} and \cs{ap@thisHeight}.
+% \begin{macrocode}
+ \edef\ap@thisWidth{\the\@tempdimb}%
+ \edef\ap@thisHeight{\the\@tempdima}%
+}
+% \end{macrocode}
+% \textbf{File Attachment Annotation.} Some code for embedding a file in the PDF document.
+% \begin{macrocode}
+\def\ap@EmbedThisFile{\literalps@out{%
+ \ap@mark/_objdef {apEmbedFile\the\ap@annot@cnt}/type/dict/OBJ pdfmark
+ \ap@mark{apEmbedFile\the\ap@annot@cnt} <<
+ /F (\ap@thisFileName)
+ /UF (\ap@thisFileName)
+ /EF << /F {apFileStream\the\ap@annot@cnt} >>
+ /Type/Filespec
+ >> /PUT pdfmark}%
+ \literalps@out{%
+ \ap@mark/_objdef {apFileStream\the\ap@annot@cnt}/type/stream%
+ /OBJ pdfmark
+ \ap@mark{apFileStream\the\ap@annot@cnt} (\annotpro@file)
+ (r) file /PUT pdfmark
+ \ap@mark{apFileStream\the\ap@annot@cnt} <<
+ /Type/EmbeddedFile
+ >> /PUT pdfmark
+ \ap@mark{apFileStream\the\ap@annot@cnt} /CLOSE pdfmark}%
+}
+%</package>
+%<*scandoc>
+% \end{macrocode}
+% \subsection{Document assembly}
+% The document assembly code is executed when the \texttt{scandoc} option is used. It is executed
+% then the document is first opened.
+% \begin{macrocode}
+\begin{execJS}{scan4anp}
+var aANPStamps=new Array();
+if (typeof scancomplete=="undefined") {
+ var scancomplete=false;
+ this.syncAnnotScan();
+ for (var p=0; p<this.numPages; p++) {
+ a=this.getAnnots(p);
+ if (a!=null) {
+ for (var i=0; i<a.length; i++) {
+% \end{macrocode}
+% At this time, we search only for annots of type \texttt{"Stamp"} and with AP beginning
+% with `\texttt{\#}', for these are user installed stamps or dynamic stamps.
+% \begin{macrocode}
+ if ( a[i].type=="Stamp" && a[i].AP.indexOf("\#")==0 ) {
+ aANPStamps.push(p);
+ break;
+ }
+ }
+ }
+ }
+}
+ANPscrollPage.index=0;
+function ANPscrollPage() {
+% \end{macrocode}
+% We go to the page where each stamp of the type we are interested in. Opening the page
+% causes \app{Acrobat} to populate the dynamic stamps.
+% \begin{macrocode}
+ if (ANPscrollPage.index<aANPStamps.length) {
+ this.pageNum=aANPStamps[ANPscrollPage.index];
+ ANPscrollPage.index+=1;
+ } else {
+ app.clearInterval(anpTO);
+ scancomplete=true;
+ this.pageNum=0;
+ }
+}
+if (aANPStamps.length>0)
+ var anpTO=app.setInterval("ANPscrollPage()", 5);
+\end{execJS}
+%</scandoc>
+%<*package>
+% \end{macrocode}
+% Set global options for this package.
+% \begin{macrocode}
+\setAnnotOptions{title,subject,open=false,color}
+\let\ap@isColorKey\ap@NO
+% \end{macrocode}
+% Input \texttt{scandoc-anp.def}, if required.
+% \begin{macrocode}
+\anp@InputScanDoc
+%</package>
+% \end{macrocode}
+% \Finale
+\endinput
diff --git a/macros/latex/contrib/annot_pro/annot_pro.ins b/macros/latex/contrib/annot_pro/annot_pro.ins
new file mode 100644
index 0000000000..5081907267
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/annot_pro.ins
@@ -0,0 +1,65 @@
+%%
+%% This file will generate fast loadable files and documentation
+%% driver files from the doc files in this package when run through
+%% LaTeX or TeX.
+%%
+%% Copyright 1999-2006 D. P. Story
+%%
+%% This file is part of the `AcroTeX eDucation Bundle'.
+%% -------------------------------------------
+%%
+%% It may be distributed under the conditions of the LaTeX Project Public
+%% License, either version 1.2 of this license or (at your option) any
+%% later version. The latest version of this license is in
+%% http://www.latex-project.org/lppl.txt
+%% and version 1.2 or later is part of all distributions of LaTeX
+%% version 1999/12/01 or later.
+%%
+%% --------------- start of docstrip commands ------------------
+%%
+\def\filedate{2009/02/26}
+\def\batchfile{annot_pro.ins}
+%
+% If you can assume that the target audience for the document all have
+% Acrobat Reader 5.0 or later, then chance the following switch to true,
+% else, leave it as false.
+
+\input docstrip
+\ifx\generate\undefined
+ \Msg{**********************************************}
+ \Msg{*}
+ \Msg{* This installation requires docstrip}
+ \Msg{* version 2.4 or later.}
+ \Msg{*}
+ \Msg{* An older version of docstrip has been input}
+ \Msg{*}
+ \Msg{**********************************************}
+ \errhelp{Move or rename old docstrip.tex and get a newer one.}
+ \errmessage{Old docstrip in input path}
+ \batchmode
+ \csname @@end\endcsname\end
+\fi
+
+\keepsilent
+\askforoverwritefalse
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\preamble
+\endpreamble
+
+\generate{%
+ \file{annot_pro.sty}{\from{annot_pro.dtx}{copyright,package}}
+ \file{annot-pro.sty}{\from{annot_pro.dtx}{copyright,altpkgname}}
+ \file{scandoc-anp.def}{\from{annot_pro.dtx}{copyright,scandoc}}
+}
+
+\Msg{***************************************************************}
+\Msg{*}
+\Msg{* \space To finish the installation you have to copy the files }
+\Msg{*}
+\Msg{* \space *.sty, *.cfg and *.def into a directory searched by TeX}
+\Msg{*}
+\Msg{***************************************************************}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\endinput
diff --git a/macros/latex/contrib/annot_pro/doc/annotpro_man.pdf b/macros/latex/contrib/annot_pro/doc/annotpro_man.pdf
new file mode 100644
index 0000000000..9e2526fb91
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/doc/annotpro_man.pdf
Binary files differ
diff --git a/macros/latex/contrib/annot_pro/doc/annotpro_man.tex b/macros/latex/contrib/annot_pro/doc/annotpro_man.tex
new file mode 100644
index 0000000000..948966a8fb
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/doc/annotpro_man.tex
@@ -0,0 +1,1468 @@
+%
+% http://www.adobe.com/devnet/acrobat/pdfs/PDF32000_2008.pdf
+%
+% makeindex < aebpro_man.idx > aebpro_man.ind
+\documentclass[12pt]{article}
+\usepackage[fleqn]{amsmath}
+\usepackage[
+ web={centertitlepage,designv,tight*,
+ forcolorpaper,latextoc,extended},
+ aebxmp,eforms,graphicxsp={showembeds}
+]{aeb_pro}
+\usepackage{array}
+%\usepackage{aeb_mlink}
+%\usepackage{myriadpro} %[usecmtt]
+\usepackage[altbullet]{lucidbry}
+\usepackage[dblevel=0]{annot_pro}
+\usepackage{richtext}
+
+\usepackage{xbmks}
+
+\DeclareInitView{layoutmag={navitab:UseOutlines}}
+\xbmksetup{colors={int=red},styles={intbf}}
+
+\previewOff
+
+%\DeclareInitView
+%{%
+% layoutmag={mag=100},
+%% windowoptions={fit}
+%}
+
+%\useAAXdimtrue
+
+\usepackage{makeidx}
+\makeindex
+\usepackage{acroman}
+
+\usepackage[active]{srcltx}
+
+\def\expath{../examples}
+
+\urlstyle{rm}
+\def\pkg{\textsf}
+\let\app\textsf
+\let\opt\texttt
+\let\uif\textsf
+\let\env\texttt
+\let\key\texttt
+\def\meta#1{\textit{\texttt{#1}}}
+\def\ameta#1{$\langle\textit{\texttt{#1}}\rangle$}
+\newdimen\aebdimen \aebdimen6pt %\partopsep \advance\aebdimen\partopsep
+\newcommand\bVerb[1][]{\begingroup#1\vskip\aebdimen\parindent0pt}%
+\def\eVerb{\vskip\aebdimen\endgroup\noindent}
+\def\SUB#1{\ensuremath{{}_{\text{#1}}}}
+
+\def\darg#1{\texttt{\{#1\}}}
+\def\takeMeasure{\bgroup\obeyspaces\takeMeasurei}
+\def\takeMeasurei#1{\global\setbox\webtempboxi\hbox{\ttfamily#1}\egroup}
+\def\bxSize{\wd\webtempboxi+2\fboxsep+2\fboxrule}
+\let\amtIndent\leftmargini
+\edef\amtIndent{\the\parindent}
+
+%\def\tutpath{doc/tutorial}
+%\def\tutpathi{tutorial}
+
+\DeclareDocInfo
+{
+ university={\AcroTeX.Net},
+ title={The \texorpdfstring{\textsf{annot\_pro} Package\\[1em]}{annot\textunderscore pro Package: }
+ Text, Stamp, File Attachment, Text Box, and Text Markup Annotations},
+ author={D. P. Story},
+ email={dpstory@acrotex.net},
+ subject={Documentation for annot\textunderscore pro from AcroTeX},
+ talksite={\url{www.acrotex.net}},
+ version={1.4, 2018/08/13},
+ keywords={sticky notes, stamps, file attachment text box, free text, text markup, annotations},
+ copyrightStatus=True,
+ copyrightNotice={Copyright (C) \the\year, D. P. Story},
+ copyrightInfoURL={http://www.acrotex.net}
+}
+
+\def\dps{$\hbox{$\mathfrak D$\kern-.3em\hbox{$\mathfrak P$}%
+ \kern-.6em \hbox{$\mathcal S$}}$}
+
+\universityLayout{fontsize=Large}
+\titleLayout{fontsize=LARGE}
+\authorLayout{fontsize=Large}
+\tocLayout{fontsize=Large,color=aeb}
+\sectionLayout{indent=-40pt,fontsize=large,color=aeb}
+\subsectionLayout{indent=-20pt,color=aeb}
+\subsubsectionLayout{indent=0pt,color=aeb}
+\subsubDefaultDing{\texorpdfstring{$\bullet$}{\textrm\textbullet}}
+
+\embedEPS[hiresbb,transparencyGroup]{AdobeDon}{../examples/graphics/AdobeDon}
+
+\makeStamp{0.0 0.0 20.0 20.0}{AdobeDon}{%
+ [ 20 \widthOf{AdobeDon} div 20 \widthOf{AdobeDon} div scale {AdobeDon} /SP pdfmark
+}
+
+\makeatletter
+\def\setDisplayNumber#1#2{\kern0pt
+ \setlength\abovedisplayshortskip{0pt}%
+ \setlength\belowdisplayshortskip{0pt}%
+ \setlength\abovedisplayskip{0pt}%
+ \setlength\belowdisplayskip{0pt}%
+ \begin{equation}\label{#2}\end{equation}\kern0pt
+}
+\renewenvironment{quote}[1][]
+ {\def\@rgi{#1}\ifx\@rgi\@empty
+ \let\rghtm\@empty\else\def\rghtm{\rightmargin\leftmargin}\fi
+ \list{}{\rghtm} %{\rightmargin\leftmargin}%
+ \item\relax}
+ {\endlist}
+\renewcommand*\descriptionlabel[1]{\hspace\labelsep
+ \normalfont #1}
+\setcounter{secnumdepth}{4}
+\setcounter{tocdepth}{5}
+\renewcommand*{\theparagraph}{\texorpdfstring{\protect\P\protect\ }{\textparagraph}}
+\renewcommand{\paragraph}
+ {\renewcommand{\@seccntformat}[1]{\theparagraph}%
+ \@startsection{paragraph}{4}{0pt}{6pt}{-3pt}{\color{\aeb@subsubsectioncolor}\bfseries}}
+\renewcommand*\l@paragraph{\@dottedtocline{4}{5.0em}{1em}} %{7.0em}{4.1em}}
+\def\chgCurrLblName#1{\def\@currentlabelname{#1}}
+\def\echgCurrLblName#1{\edef\@currentlabelname{#1}}
+\makeatother
+
+
+\setAnnotOptions{subject={AcroTeX Communiqu\'e},title={D.P. Story}}
+
+%\pagestyle{empty}
+%\parindent0pt\parskip\medskipamount
+
+\chngDocObjectTo{\newDO}{doc}
+\begin{docassembly}
+var titleOfManual="The annot_pro MANUAL";
+var manualfilename="Manual_BG_Print_annotpro.pdf";
+var manualtemplate="Manual_BG_Brown.pdf"; // Blue, Green, Brown
+var _pathToBlank="C:/Users/Public/Documents/ManualBGs/"+manualtemplate;
+var doc;
+var buildIt=false;
+if ( buildIt ) {
+ console.println("Creating new " + manualfilename + " file.");
+ doc = \appopenDoc({cPath: _pathToBlank, bHidden: true});
+ var _path=this.path;
+ var pos=_path.lastIndexOf("/");
+ _path=_path.substring(0,pos)+"/"+manualfilename;
+ \docSaveAs\newDO ({ cPath: _path });
+ doc.closeDoc();
+ doc = \appopenDoc({cPath: manualfilename, oDoc:this, bHidden: true});
+ f=doc.getField("ManualTitle");
+ f.value=titleOfManual;
+ doc.flattenPages();
+ \docSaveAs\newDO({ cPath: manualfilename });
+ doc.closeDoc();
+} else {
+ console.println("Using the current "+manualfilename+" file.");
+}
+var _path=this.path;
+var pos=_path.lastIndexOf("/");
+_path=_path.substring(0,pos)+"/"+manualfilename;
+\addWatermarkFromFile({
+ bOnTop:false,
+ bOnPrint:false,
+ cDIPath:_path
+});
+\executeSave();
+\end{docassembly}
+\begin{document}
+
+\maketitle
+
+\pdfbookmarkx[1]{Title Page}[action={\Named{FirstPage}}]{TitlePage}
+\pdfbookmarkx[1]{Links to AcroTeX.Net}[action={/S/GoTo/D(undefined)},%
+ color=magenta,style={bf}]{acrotex}
+\belowpdfbookmarkx{http://www.acrotex.net}[action={\URI{http://www.acrotex.net}},%
+ color=magenta,style={bf}]{home}
+\belowpdfbookmarkx{http://blog.acrotex.net}[action={\URI{http://blog.acrotex.net}},%
+ color=magenta,style={bf}]{blog}
+
+
+\selectColors{linkColor=black}
+\tableofcontents
+\selectColors{linkColor=webgreen}
+
+\section{Introduction}
+
+This package is used to create text, stamp, and file attachment
+annotations using \textbf{Adobe Distiller}, these annotations can be
+viewed in Adobe Reader. For users of \textsf{pdf(la)tex}, use the
+\textsf{pdfcomment} package by Josef Kleber.\footnote{Available at \href{http://ctan.org/pkg/pdfcomment}{ctan.org/pkg/pdfcomment}}
+
+The package primarily in support of my \href{http://www.math.uakron.edu/~dpstory}
+{{Acro\negthinspace\TeX} PDF Blog}. I plan to use sticky notes, file attachments, and
+custom stamps to make side-comments, and to provide source files.
+
+\section{Alternate package name: \texorpdfstring{\protect\pkg{annot-pro}}{annot-pro}}
+
+CTAN lists this package as \pkg{annot-pro}, so might as well have such a package by that name:
+\pkg{annot-pro} loads \pkg{annot\_pro} with the specified options.
+
+\section{Requirements}
+
+The requirements for your {\LaTeX} system, and well as any other
+software, is highlighted in this section.
+
+\subsection{{\LaTeX} Package Requirements}
+
+The following packages, in addition to the standard {\LaTeX}
+distribution, are required:
+\begin{enumerate}
+ \item The \textsf{xkeyval} package is used to set up the key-value
+ pairs of the \cs{annot\-pro} command. Get a recent version.
+ \item The \textsf{xcolor} package is strongly recommended.
+ \item The \textsf{hyperref} package, a recent version.
+ \item If you want to create custom stamps (on the fly) using the techniques
+ developed for that purpose, the \textsf{graphicxsp} Package is required.\footnote
+ {Available at \href{http://ctan.org/pkg/graphicxsp}{ctan.org/pkg/graphicxsp}}
+ \item \pkg{annot\_pro} now requires \pkg{aeb\_mlink} (2018/08/18 or later) to implement
+ text markup annotations. The \pkg{aeb\_mlink} package loads the \pkg{soul} package.
+\end{enumerate}
+The \textsf{annot\_pro} package is part of the \textcolor{blue}{AeB
+Pro} family, which means \textbf{Adobe Distiller} is required. The
+components of \textcolor{blue}{AeB} and \textcolor{blue}{AeB Pro}
+are not required.\footnote{AeB: \href{http://ctan.org/pkg/acrotex}{ctan.org/pkg/acrotex}}${}^{,}$\footnote{AeB Pro:
+\href{http://ctan.org/pkg/aeb-pro}{ctan.org/pkg/aeb-pro}}
+
+\subsection{PDF Creator Requirements}
+
+The \textsf{annot\_pro} package requires \textbf{Acrobat Distiller 5.0} (or
+later) as the PDF creator. The document author typically uses dvips (or dvipsone) to
+produce a PostScript file, which is then distilled to obtain a PDF.
+
+If you wish to use (dynamically) created stamps that have opacity less than 1,
+you need to distill using \textbf{Standard\_transparancy.joboptions} with distiller,
+in this case, \textbf{Acrobat Distiller 6.0} (or later) is required; otherwise, this
+distiller job options file is not needed.
+
+The \textbf{Standard\_transparancy.joboptions} file is supplied with the \textsf{graphicxsp}
+package; the documentation of the \textsf{graphicxsp} package includes installation instructions.
+
+\section{Installation}
+
+The installation is simple enough. Unzip \texttt{annot\_pro.zip} in a
+folder that is on your {\LaTeX} search path. Refresh your filename
+database, if appropriate.
+
+\begin{defineJS}{\winedtDist}
+Run(|"c:\\Program Files\\Adobe\\Acrobat 9.0\\Acrobat\\acrodist.exe" -F "%P\\%N.ps"|,'%P',0,0,'%N.ps - Distiller',1,1);
+\end{defineJS}
+
+\paragraph*{\textcolor{red}{Important:}} When creating a file attachment annotation,
+you must specify a path to the file to be attached, and distiller must embed
+this file. In recent versions of Acrobat,
+security restrictions have been put in place to prevent
+\textbf{Distiller} from reading files (the PostScript \textbf{file}
+operator does not work). Fortunately, Distiller has a switch that
+turns off this particular restriction. To successfully use this
+package, therefore, you need to run Distiller by using the
+\texttt{-F} command line switch.
+
+
+Those using \app{Windows OS} can create a shortcut on the desktop, for example,
+that starts \app{Distiller} with the \texttt{-F} switch. The \uif{Target} of the shortcut might read
+\begin{Verbatim}[xleftmargin=\leftmargini,fontsize=\small]
+"C:\Program Files (x86)\Adobe\
+ Acrobat 9.0\Acrobat\acrodist.exe" -F
+\end{Verbatim}
+where we have wrapped the path to the next line to fit within the margins.
+Once \app{Distiller} is started with \texttt{-F}, the switch remains in effect
+until \app{Distiller} is closed.
+
+If this package is used to create file attachment annotations without the
+\texttt{-F} switch, you typically get the following error message in
+the Distiller log file
+\begin{Verbatim}[xleftmargin=\leftmargini,fontsize=\small]
+%%[ Error: undefinedfilename; OffendingCommand: file ]%%
+\end{Verbatim}
+This tells you that either you have not started Distiller with the
+\texttt{-F} command line switch, or Distiller can't find one of the
+files that the \textbf{file} operator was trying to read.
+
+
+
+\newtopic \textbf{Mac OS Users.} The above comments on the \texttt{-F} command line switch
+is for Windows users, Mac OS users must choose the \texttt{AllowPSFileOps} user preference, this is located
+in the \texttt{plist}, possibly located at
+\begin{Verbatim}[fontsize=\small]
+/Users/[User]/Library/Preferences/com.adobe.distiller9.plist
+\end{Verbatim}
+You can also use Spotlight, the search utility on Mac, to search for the string \texttt{com.adobe.distiller};
+the result might be
+\begin{quote}
+\texttt{com.adobe.distiller9.plist}.\footnote{In the case of Adobe Distiller, version 9.0}
+\end{quote}
+Clicking on this find,
+Spotlight opens \texttt{com.adobe.distiller9.plist} in the \texttt{plist} editor, see \hyperref[plist]{Figure~\ref*{plist}}.
+If necessary, click on the arrow next to the Root to expand the
+choices, then click the up and down arrows at the far
+right in the \texttt{AllowPSFileOps} row to select Yes as the value.
+\begin{figure}[hbt]\setlength{\fboxsep}{0pt}
+\begin{center}
+\fbox{\includegraphics[width=.75\linewidth]{plistEditor}}
+\caption{com.adobe.distiller9.plist}\label{plist}
+\end{center}
+\end{figure}
+
+\section{Package Options}\label{pkgOpts}
+
+This package has several options to customize its use.
+
+\begin{itemize}
+ \item \opt{preview}: When this option is taken, the bounding rectangles
+ are visible in the typeset document. This feature can be locally
+ turned on with \cs{previewOn} and off with \cs{previewOff}.
+% \item \opt{useA10Icons} (the default) and \opt{!useA10Icons}: Beginning
+% with version 10 of \app{Acrobat} and \app{Adobe Reader} the
+% dimensions of the icons used changed. If your target audience uses
+% version~10 or later use the \opt{useA10Icons} option; if your target
+% population is using version~9 or prior, use the \opt{!useA10Icons}
+% option. This set of options are outdated, the default option is all
+% that is needed.
+ \item \opt{richtext} and \opt{useTextBox}: All annotations supported by
+ this package can now take rich text for its contents. If you use rich
+ text in your comments, the \opt{richtext} option is required. (The
+ \opt{useTextBox} option is deprecated in favor of \opt{richtext}.)
+ \item \opt{scandoc} and \opt{!scandoc}: The \opt{scandoc} option is
+ needed when using custom stamps; the \opt{!scandoc} turns off
+ scanning. The \opt{!scandoc} is a convenience option.
+ \item \opt{dblevel=\ameta{num}} Sets the level of information feedback; this option
+ is passed to the \pkg{aeb\_mlink} package.
+\end{itemize}
+
+
+
+\section{The \texorpdfstring{\protect\cs{annotpro}}{\CMD{annotpro}} Command}
+
+The main command of this package is \Com{annotpro}; the command is controlled by
+its optional parameters. The same command can create a text annotation (sticky note),
+a stamp annotation, a file attachment or a Free Text (Text Box) annotation. The syntax of this command is
+\bVerb\takeMeasure{\string\annotpro*[\ameta{KV-pairs}]\darg{\ameta{content}}}%
+\begin{minipage}{\linewidth}
+\begin{minipage}{\bxSize}
+\xdef\panelWidth{\the\linewidth}%
+\begin{Verbatim}[frame=single,commandchars=!()]
+\annotpro*[!ameta(KV-pairs)]{!ameta(content)}
+\end{Verbatim}
+\end{minipage}\hfill
+\begin{minipage}{\linewidth-\panelWidth}
+\setDisplayNumber\label{display:arbproCmd}
+\end{minipage}\end{minipage}\eVerb
+\PD The optional argument consists is one or more key-value pairs
+(\ameta{KV-pairs}) that describe the annotation; the required argument,
+\ameta{content}, is the ``content'' of the annotation; it is either text or a key-value pair.
+Use the key-value option to insert rich text content; see Section~\ref{rtContent} on page~\pageref{rtContent} for
+more information. For text and stamp annotations, \ameta{content} becomes the content of the popup annotation, for a
+file attachment annotation, which has no associated pop-up, it is the
+description of the file attachment that appears in the file attachment panel
+of \app{Adobe Reader}. In the latter case, the value of \ameta{content} should be
+rather short. The key-value pairs (\ameta{KV-pairs}) are described over the
+next few sections.
+
+Normally, \cs{annotpro} uses the \cs{setkeys} command of \pkg{xkeyval} to
+determine the options specified, when the star-option is specified, \cs{annotpro}
+uses \cs{setkeys*} to evaluate the options, refer to the \pkg{xkeyval} documentation
+for a description of \cs{setkeys} and \cs{setkeys*}.
+
+\paragraph*{\color{red}Sample files.} The sample files \texttt{annots.tex} and \texttt{textbox.tex} illustrate the features
+of the \pkg{annotpro} package.
+
+\subsection{Key-values common to all annotations}\label{s:CommonKeys}
+
+The following are key-value pairs common to all annotations.
+
+%{$\langle\textit{\texttt{#1}}\rangle$}
+
+\begin{itemize}
+ \item \texttt{type=$\langle$\upshape{text|stamp|fileattachment|textbox|highlight|}}\\
+ \texttt{underline|squiggly|strikeout$\rangle$} The key determines
+ the type of annotation to be produced. The \texttt{type} key is
+ optional, if not present, \texttt{type=text} is assumed.
+ \item \texttt{name=\ameta{name}} The name of the icon to use for the declared \texttt{type}. Permissible
+ values are dependent on the \texttt{type}, and are discussed in subsequent sections.
+ \item \texttt{title=\ameta{text}} Text to be displayed in the title bar of the annotation's pop-up window
+ when open and active. By convention, this entry identifies the user who made the annotation,
+ though any (short) text may be used. You can use \cs{setAnnotOptions} to globally set
+ the title of each annotation, perhaps using your name.
+\begin{Verbatim}[fontsize=\small]
+ \setAnnotOptions{title={D. P. Story}}
+\end{Verbatim}
+ \item \texttt{subject=\ameta{text}} Text representing a short description of the subject of the annotation.
+ You can use \cs{setAnnotOptions} to globally set the subject of each annotation,
+\begin{Verbatim}[fontsize=\small]
+ \setAnnotOptions{title={D. P. Story},
+ subject={AcroTeX Communiqu\'e}}
+\end{Verbatim}
+ \item \texttt{color}: The color of the title bar of the pop-up window of the annotation.
+ \item \texttt{readonly=\ameta{\upshape{true|false}}} Set the annotation to readonly. The user can click on the annot to
+ see the popup, but the user, if using \app{Acrobat}, cannot move the annotation around on the page.
+ The popup window can still be moved by the user. (\texttt{readonly} is the same as \texttt{readonly=true}.)
+ \item \texttt{hidden=\ameta{\upshape{true|false}}} This key sets the annotation to hidden, it is not visible
+ and does not interact with the user. (\texttt{hidden} is the same as \texttt{hidden=true}.)
+ \item \texttt{opacity=\ameta{dec}}: The opacity value ($
+ \text0\le\text{\ameta{dec}}\le\text1$) to be used in painting the (icon of
+ the) annotation, but does apply to the pop-up window. The default
+ is 1.0.
+ \item[] Adobe Distiller handles the opacity for us in all cases except when we create a (dynamic) stamp.
+ If an opacity value less than 1 is desired, special techniques are needed, and the file needs to
+ be distilled using the \textbf{Standard\_transparency} job options.
+ \item \texttt{internalID=\ameta{name}} Each annot must have an internal
+ name (or ID), \emph{unique to the page on which it appears}. The
+ \pkg{annot\_pro} package maintains an internal counter
+ (\cs{ap@annot@cnt}) and routinely assigns each annotation an internal
+ name (or ID) of
+ \begin{quote}\ttfamily
+ annotpro\string\the\string\ap@annot@cnt
+ \end{quote}
+ The \opt{internamID} key allows you to assign an alternate internal
+ name. Thus, if you assign \texttt{internalID=myCoolAnnot}, an
+ annotation is created with the name \texttt{myCoolAnnot}. The
+ internal ID can be used by JavaScript to find a particular annot on
+ the page and to get its properties. The macro \cs{currentAnnotName}
+ contains the internal name of the most recent annot created.
+\end{itemize}
+The following key-values are {\LaTeX} based concerning placement of the
+annotation in the margin.
+\begin{itemize}
+ \item \texttt{margin}: Use this key (it has no value), to declare that
+ you want the annotation to appear in the margin. The \cs{marginpar}
+ command from core {\LaTeX} is used, the placement of the annotation
+ follows the rules set down by {\LaTeX}. You can reverse the
+ placement of the annotation by using the {\LaTeX} command
+ \cs{reversemarginpar} (annots placed in the right margin, and now
+ placed in the left); you can return to the default by using
+ \cs{normalmarginpar}.
+
+ \item[] Given that you have use the \texttt{margin} key, there is an
+ associated key that can be used, as well as a command.
+ \begin{itemize}
+ \item \texttt{margintext}: The value of this key is text that
+ will be typeset just below the annotation icon.
+ \item \cs{marginpartextformat}: A {\LaTeX} command for formatting
+ the text in the margin, the default definition is\smallskip
+\begin{Verbatim}
+\margintextformat{\bfseries\tiny\color{blue}}
+\end{Verbatim}
+ \end{itemize}
+ \item[] For an annotation placed in the margin with margin text, you
+ might want to use the \texttt{readonly} key, this prevents the
+ user---even one using Acrobat---from moving the annotation away
+ from its caption.
+ \item \texttt{margprior=\ameta{\cs{cmd}}} This key allows you to
+ operate on the annotation as a whole. The value \ameta{\cs{cmd}} is
+ expected to be, but it is not a requirement, a command taking one
+ argument. (This key-value pair defines \cs{anp@margprior} which
+ expands to \ameta{\cs{cmd}}; placement of \cs{anp@margprior} is
+ \texttt{\cs{anp@margprior}\darg{\meta{the-annot-code}}}. For
+ example, declaring \texttt{marprior=\cs{fbox}} draws an frame box
+ around the annotation, or
+ \texttt{marprior=\cs{raisebox\darg{10pt}}} raises the annotation
+ 10pt.
+\end{itemize}
+The following key-value is for your convenience.
+\begin{itemize}
+ \item \texttt{presets}: A key to allow the introduction of pre-defined options, for example,
+ you might like all your comment annotations to be red, so you can define
+\begin{verbatim}
+ \def\myComments{type=text,name=Comment,color=red}
+\end{verbatim}
+then say
+\begin{verbatim}
+ \annotpro[presets=\myComment]{Way to go!}
+\end{verbatim}
+Additional options may be included,
+\begin{verbatim}
+ \annotpro[presets=\myComment,margin]{Way to go!}
+\end{verbatim}
+for example.
+
+\end{itemize}
+
+\subsection{Key-values for text annotations}
+
+The position of the annotation is determined by its bounding rectangle; for the
+text annotation, an icon is placed so that its upper left corner is at the upper
+left corner of the bounding rectangle. The icons themselves have certain dimensions
+that have been recorded within the \texttt{annot\_pro} package, so you need not worry
+about leaving space for them.
+
+An important fact about the icons used by text annotation is that they \emph{do not zoom in or out} as the page
+magnification is changed; furthermore, the graphics commands \cs{scalebox} and \cs{resizebox} do not rescale
+the icons as expected.
+
+The following are options specific to the text annotation. Recall, the text annotation
+is of \texttt{type=text}.
+\begin{itemize}
+ \item \texttt{name}: The name of the icon to use when displaying this annotation in closed form (no pop-up window visible).
+ Possible values---as specified in the \textsl{PDF Reference}---are
+ \texttt{Comment}, \texttt{Key}, \texttt{Note}, \texttt{Help},
+ \texttt{NewParagraph}, \texttt{Paragraph}, and \texttt{Insert}.
+ Additional icons that are available in recent versions of Adobe
+ Reader are
+\begin{quote}\raggedright
+ \texttt{Check}, \texttt{Circle}, \texttt{Cross}, \texttt{Star}, \texttt{RightArrow}, \texttt{RightPointer},
+ \texttt{UpArrow}, \texttt{UpLeftArrow}
+\end{quote}
+ If you are using comments in your document, and your audience have
+ older versions of Adobe Reader, it is best to use only the seven
+ listed in the \textsl{PDF Reference}.
+
+ \item \texttt{open}: A Boolean value that determines whether the pop-up
+ window is open or not. When \texttt{true} the pop-up is open. The
+ package default is \texttt{false}. You can use \cs{setAnnotOptions}
+ to set this option globally.
+
+ \item \texttt{nohspace}, \texttt{novspace}, \texttt{nospace}: The
+ presence of these commands zeroes out the dimension(s) of the
+ bounding rectangle. Specifying \texttt{nohspace} as an option
+ causes the icon to take up no horizontal space as the page is
+ latexed. Here\annotpro[nohspace]{This a sticky note with the
+ nospace option} is an example of a sticky note with the
+ \texttt{nohspace} option. Without any of these three keys, the text
+ annotation \annotpro[type=text,name=Key]{A sticky note that takes
+ up TeX space. If you put the document into 100\% magnification,
+ you'll see the note fits precisely into the allotted space.} fits
+ exactly into the allotted space at
+ \setLinkText[\A{\JS{this.zoom=100;}}\Color{0 .6 0}]{100\%
+ magnification}, try it.
+
+ When the icon takes up no {\TeX} space, it may cover content on
+ the page, as it does above. Acrobat users can move the icon
+ around, but AR users cannot move the icon. The pop-up window is
+ movable and scalable, but the icon cannot be moved. Therefore,
+ you must be careful about placement.
+
+ Additional positioning of the icons can be made using standard {\LaTeX}
+ commands such as \cs{raisebox} and \cs{smash}. For example,\smash{\raisebox{1in}{\annotpro[nospace,color=blue,opacity=.25]{I've raised this annot by 1in.
+ I've also used the nospace key, the icon does not take up any TeX space.}}} the blue icon above was created by
+\begin{Verbatim}[xleftmargin=\amtIndent,fontsize=\footnotesize]
+For example,\smash{\raisebox{1in}\raisebox{1in}{%
+ \annotpro[nospace,color=blue,
+ opacity=.25]{...clever message...}}}
+\end{Verbatim}
+Note that I've set the \texttt{opacity} to .25.
+
+\end{itemize}
+
+
+\subsection{Key-values for stamp annotations}
+
+A stamp annotation is similar to a text annotation in the sense that
+it has a pop-up window in which the contents of the message is
+displayed; however, unlike the text annotation icons, the stamp
+appearance by be re-scaled using \cs{scalebox} and \cs{resizebox} of
+the graphics package; however, the keys \texttt{scale},
+\texttt{widthTo}, and \texttt{heightTo}, as described below, are the
+recommended methods of re-scaling a stamp.
+
+The following are the key-values associated with this annotation type.
+
+\begin{itemize}
+
+\begingroup\raggedright
+
+ \item \texttt{name}: The stamps listed in the \textsl{PDF
+ Reference} are \texttt{Approved}, \texttt{AsIs},
+ \texttt{Confidential}, \texttt{Departmental}, \texttt{Draft},
+ \texttt{Experimental}, \texttt{Expired}, \texttt{Final},
+ \texttt{ForComment}, \texttt{ForPublicRelease},
+ \texttt{NotApproved}, \texttt{NotForPublicRelease},
+ \texttt{Sold}, and \texttt{TopSecret}. If \texttt{name}
+ is not specified, \texttt{Draft} is the default.\par\endgroup
+
+ \item[] There are other stamps, not listed in the \textsl{PDF
+ Reference}, but available in more recent versions of Acrobat.
+ The file \texttt{stamps.pdf} lists all the stamps that I have
+ access to. The names of these other stamps are recognized by the
+ \texttt{name} key.
+
+ \item[] The dimensions of the stamps listed above are all the
+ same, they are \texttt{150bp} width and \texttt{40bp} high.
+
+ \item[] Additional stamps are shipped by Acrobat, a listing of these
+ appears in the file \texttt{stamps.pdf} (\texttt{stamps.tex}).
+
+ \item\texttt{width}, \texttt{height}: If the value of
+ \texttt{name} key is something other than one of the stamps
+ listed above (one of the stamps listed in the file
+ \texttt{stamps.pdf}), the width and height are not known to
+ \textsf{annot\_pro}. In this case, use the \texttt{height} and \texttt{width} keys
+ to set the dimensions of the bounding box. Adobe Distiller will
+ resize the stamp to the stamp that is the largest one that can fit in
+ the bounding box, the stamp will be centered vertically and
+ horizontally within the bounding box.
+
+ \item[] Here are a couple of examples, the bounding box is should as a black \cs{fbox}.
+
+\begin{itemize}
+
+\begin{defineJS}{\annotstampi}
+Exact fit:
+\\annotpro[type=stamp,name=SBApproved,widthTo=106bp,color=webbrown]{This package just got better!}
+\end{defineJS}
+\begin{defineJS}{\annotstampii}
+Bad rectangle, but stamp fits the best it can:
+\\annotpro[type=stamp,name=SBApproved,width=50bp,height=50bp,color=webbrown]{This package just got better!}
+\end{defineJS}
+
+
+
+
+ \item This one
+ {\previewOn\annotpro[type=stamp,name=SBApproved,widthTo=106bp,color=webbrown]{This
+ package just got better!}} fits more or less exactly\annotpro[margin,readonly,margintext={\centering Good Fit}]{\annotstampi}. I
+ determined the dimensions of this stamp through some controls
+ of the user interface. Contrast this stamp
+ {\previewOn\annotpro[type=stamp,width=50bp,height=50bp,name=SBApproved,color=webbrown]{This
+ package just got better!}}\annotpro[margin,readonly,margintext={\centering Bad Fit}]{\annotstampii} obtained by setting
+ \texttt{width=50bp} and \texttt{height=50bp}. Notice the
+ ``best fit,'' and that the bounding box takes up space. We
+ can use \cs{smash} to smash its vertical height, let's see
+ how that looks
+ {\previewOn\smash{\annotpro[type=stamp,width=50bp,height=50bp,name=SBApproved,color=webbrown]{This
+ package just got better!}}}.
+
+\smallskip
+
+
+\goodbreak
+
+\previewOff
+
+% \item[] The code for producing these stamps are given in the margins.
+% \annotpro[margin,readonly,margintext={\centering Good Fit}]{\annotstampi}%
+% \annotpro[margin,readonly,margintext={\centering Bad Fit}]{\annotstampii}%
+
+\begin{defineJS}{\annotstampiii}
+Resize using \\resizebox. \\raisebox was used to lift the same up a little:
+\\raisebox{4pt}{\\resizebox{.5in}{!}{\\annotpro[type=stamp,name=SBApproved,color=webbrown]{This package just got better!}}}
+\end{defineJS}
+
+ \item[] You can resize these stamps using \cs{scalebox} and \cs{resizebox}, like so:
+ \raisebox{4pt}{\resizebox{.5in}{!}{\annotpro[type=stamp,name=SBApproved,color=webbrown]{This package just got better!}}}.
+ %\enspace
+ The code for producing this stamp are given here \annotpro{\annotstampiii}.
+
+\begin{defineJS}{\annotstampiv}
+\smash{\makebox[0pt][l]{\annotpro[type=stamp,name=Approved,color=blue]{I give my stamp of approval!}}}
+\end{defineJS}
+
+\item To create a
+ stamp\smash{\makebox[0pt][l]{\annotpro[type=stamp,name=Approved,color=blue]{I
+ give my stamp of approval!}}} that takes up no space, it is easiest
+ to use \cs{smash} and \cs{makebox[0pt][l]\darg{\ameta{contents}}}; here is one of
+ the standard stamps as listed in the \textsl{PDF Reference}. The code
+ for this stamp is given in this note \annotpro{\annotstampiv}.
+\end{itemize}
+
+\item[] Try changing the magnification of the page, you'll see that stamps are re-scaled as you zoom in or out, while
+the text annotations are not. I don't like text annotations for this reason.
+
+\begin{defineJS}{\annotstampv}
+\\annotpro[type=stamp,customStamp=MyDPSImage,ap=AdobeDon,color=webbrown]{This is the best picture of me ever taken. Akron, about 2005.}
+\end{defineJS}
+
+\item\texttt{rotate}: Stamps can be rotated, use this key to enter an angle of rotation, for example,
+ \texttt{rotate=30} rotates the stamp $\text{30}^\circ$ counter clock-wise.
+
+\item[\textcolor{red}{\ding{043}}] Do not use the \cs{rotatebox} command of \textsf{graphics} package,
+this command \emph{does not rotate} the stamp.
+
+\item \texttt{scale}: Use this key to re-scale the stamp; the value of this key is a number between
+ 0 and 1. For example, \texttt{scale=.5} reduces both width and height in half.
+\item \texttt{widthTo}: This key resizes the stamp so that the width is the value of this key; for example,
+ \texttt{widthTo=2in} re-scales the stamp to have a 2in width.
+\item\texttt{heightTo}: This key resizes the stamp so that the height is the value of this key; for example,
+ \texttt{heightTo=2in} re-scales the stamp to have a 2in height.
+
+\item[] Only one of the keys \texttt{scale}, \texttt{widthTo}, and \texttt{heightTo} are recognized
+ for any stamp annotation. If all three are specified, only \texttt{scale} is used. If
+ \texttt{widthTo} and \texttt{heightTo} are both specified, then \texttt{widthTo} is used.
+
+\item[\textcolor{red}{\ding{043}}] The use of these keys is the recommend way of re-scaling
+a stamp. These methods are compatible with the \texttt{rotate} key.
+
+\item \texttt{customStamp}: You can create a custom stamp from any
+ image you wish to use, here is
+ \annotpro[type=stamp,customStamp=MyDPSImage,ap=AdobeDon,color=webbrown]{This
+ is the best picture of me ever taken. Akron, about 2005.} one such
+ example. The code for the above stamp is given here
+ \annotpro{\annotstampv}.
+
+\item \texttt{ap}: When the \texttt{\texttt{customStamp}} key is
+ used, you have to supply an indirect reference to the appearance of
+ the stamp. This reference is made through the \texttt{ap} key. The
+ example above demonstrates the use of the \texttt{ap} key.
+\end{itemize}
+\textbf{\textcolor{red}{Important:}} When using the stamps of
+\app{Acrobat} always perform a \uif{SaveAs} on the file when you have finished
+building the file. This imports the appearances of the stamps into
+the document and saves them.
+
+\redpoint The creation of a custom stamp requires detailed list of steps, at
+some point I'll write a white paper on the subject.\footnote{Use the \pkg{mkstmp} package
+(\href{http://ctan.org/pkg/mkstmp}{ctan.org/pkg/mkstmp}),
+details of how to create custom stamps are included in the documentation.}
+
+\begin{defineJS}{\approvedStmp}
+\\annotpro[type=stamp,name=Approved,widthTo=2in,rotate=30]{...}
+\end{defineJS}
+
+\newtopic
+Here's an example of the keys \texttt{rotate} and \texttt{widthTo}:
+\begin{center}
+ \annotpro[type=stamp,name=Approved,widthTo=2in,rotate=30]{The source for this
+ stamp is ...\string\r\approvedStmp}
+\end{center}
+
+\subsection{Key-values file attachment annotations}
+
+The file attachment annotation has no pop-up window, the value of the required parameter is used as a description
+of the attached file, and appears in the file attachment window.
+
+The key-value pairs special to this type of annotation are as follows.
+
+\begin{itemize}
+ \item\texttt{name}: The name of the icon to use, permitted values are
+ \texttt{Graph}, \texttt{Paperclip}, \texttt{PushPin}, and \texttt{Tag}. If the value of name is not
+ specified, the default is \texttt{PushPin}. The annot\_pro package knows the dimensions of each of these
+ icons, so you need not worry about them. They can be re-scale using standard commands from the graphics package,
+ though, there may be little need of doing so.
+ \item \texttt{file}: The value of the file key is the \emph{absolute path} to the file to be attached. I've
+ devised a helper command \Com{defineAPath} that can be used to define the path to your file. For example, we can
+ define a path to wherever the files are, like so
+\begin{Verbatim}[fontsize=\footnotesize]
+ \defineAPath{\graphicsPath}
+ {C:/Users/Public/Documents/My TeX Files/%
+ tex/latex/aeb/aebpro/annot_pro/examples/graphics}
+\end{Verbatim}
+\item[] The command takes two arguments, the name of the command to be defined, and the path.
+
+\defineAPath{\graphicsPath}{C:/Users/Public/Documents/My TeX Files/tex/latex/aeb/aebpro/annot_pro/examples/graphics}
+
+\begin{defineJS}{\fa}
+\\annotpro[type=fileattachment,file={\graphicsPath/AdobeDon.pdf},name=Paperclip]{The author of annot\_pro (ho, ho).}
+\end{defineJS}
+
+\item[] We can create a file attachment
+ \annotpro[type=fileattachment,file={\graphicsPath/AdobeDon.pdf},name=Paperclip]{The
+ author of annot\_pro (ho, ho).} like so, ho, ho. Here is the code
+ for this file attachment \annotpro[name=Star]{\fa}. Clicking the
+ file attachment icon will open the file, in recent versions of
+ Acrobat, the file is listed in the file attachments panel. Open it
+ using the user interface, and you'll see the file listed, as well
+ as a description, as passed to the annot as the second argument of
+ \cs{annotpro}.
+\end{itemize}
+
+The file attachment icons can be resized using any of the graphics commands, \cs{scalebox} or \cs{resizebox}.
+
+\subsection{The \texorpdfstring{\protect\uif{Text Box}}{Text Box}
+ (\texorpdfstring{\protect\uif{Free Text}}{Free Text}) annotation}\label{s:textbox}
+
+A \uif{Text Box} annotation is a rectangular region in which the user can
+enter rich text. The annotation may be created and `pre-populated' with rich text from a
+{\LaTeX} source through the \pkg{annot\_pro} package.
+
+The \uif{Text Box} annotation, as implemented by this package, requires the
+\pkg{richtex} package, dated 2018/08/05 or later. A one simple method for
+introducing \pkg{richtext} is through the \opt{richtext} option of
+\pkg{annot\_pro}. Placing the following line in the preamble:
+\begin{Verbatim}[xleftmargin=\amtIndent]
+\usepackage[richtext]{annot_pro}
+\end{Verbatim}
+declares you are going to use \uif{Text Box} annotations. The option does
+nothing more than to execute \cs{usepackage\darg{richtext}[2018/08/05]}. The
+option is more of a convenience.
+
+To create a \uif{Text Box} (originally named \uif{Free Text}) annotation use the \cs{annotpro} command.
+\bVerb\begin{minipage}{\linewidth}
+\begin{minipage}{3.5in}
+\xdef\panelWidth{\the\linewidth}%
+\begin{Verbatim}[xleftmargin=\leftmargini,commandchars=!(),fontsize=\small]
+\annotpro[!textbf(type=textbox),!ameta(KV-pairs)]
+ {richtext=!ameta(name),defstyle=!ameta(name)}
+\end{Verbatim}
+\end{minipage}\hfill
+\begin{minipage}{\linewidth-\panelWidth}
+\setDisplayNumber\label{display:textbox}
+\end{minipage}\end{minipage}\eVerb
+Notice the second argument is not \ameta{content} as it is with the other annotations, but consists
+of key-value pairs; recognized keys are \texttt{richtext} and \texttt{defstyle}.
+
+\newtopic\noindent The sample file \texttt{textbox.tex} illustrates the features of this section.
+
+\subsubsection{Creating an empty \texorpdfstring{\protect\uif{Text Box}}{Text Box}}
+
+A common application would be to create an empty \uif{Text Box} for the
+document consumer to type in comments. Below is an example of a \uif{Free
+Text} annotation, called \uif{Text Box} by the user-interface of
+\app{Acrobat}/\app{Adobe Reader}.
+\begin{flushleft} %\previewtrue
+\begin{minipage}{2in}
+\annotpro[title=dpstory,type=textbox,subject=Empty Text Box]{}
+\end{minipage}\hfill
+\begin{minipage}{\linewidth-2in-10pt}\small
+Press \uif{Ctrl+E} (\app{Windows}) or \uif{Cmd+E} (\app{Mac OS}) to obtain
+the \uif{Properties} toolbar, now click on the text box to obtain the
+\uif{Text Box Properties} toolbar. Double clicking on the text box
+brings up the \uif{Text Box Text Properties} toolbar.
+\end{minipage}
+\end{flushleft}
+The verbatim listing of the above \uif{Text Box} is,
+\begin{Verbatim}[xleftmargin=\leftmargini]
+\annotpro[type=textbox,
+ title=dpstory,subject=Empty Text Box]{}
+\end{Verbatim}
+The required second argument is empty, which leads to an empty \uif{Text Box}.
+
+\subsubsection{Creating a non-empty \texorpdfstring{\protect\uif{Text Box}}{Text Box}}\label{ss:textbox}
+
+A much more interesting exercise is to pre-populate the \uif{Text Box} with rich text for the
+document consumer to read and/or to respond.
+
+%[Steps to create rich text content]
+
+\paragraph[Steps to create rich text content]{Steps to create rich text content.}\label{para:StepsRC}
+We briefly outline the techniques to create rich text
+for a \uif{Text Box} annotation.
+\begin{itemize}
+ \item Use the \env{textboxpara} environment and the \cs{rtpara} command
+ to declare your rich text paragraph.
+\bVerb\takeMeasure{\string\rtpara[\ameta{KV-pairs}]\darg{\ameta{name\SUB{para}}}\darg{\ameta{rich-content}}}%
+\begin{minipage}{\linewidth}
+\begin{minipage}{\bxSize}
+\xdef\panelWidth{\the\linewidth}%
+\begin{Verbatim}[frame=single,commandchars=!()]
+\begin{textboxpara}
+\rtpara[!ameta(KV-pairs)]{!ameta(name!SUB(para))}{!ameta(rich-content)}
+...
+\end{textboxpara}
+\end{Verbatim}
+\end{minipage}\hfill
+\begin{minipage}{\linewidth-\panelWidth}
+\setDisplayNumber\label{display:rtpara}
+\end{minipage}\end{minipage}\eVerb
+Details of the \cs{rtpara} command are found in the documentation manual of
+the \pkg{richtext} package. The \env{textboxpara} environment is needed for
+certain redefinitions of internals because of the different way rich text
+is supported and implemented in the \uif{Text Box} annotation verses the
+rich text field.
+
+\item Use the \cs{setRVVContent} command on your \cs{rtpara}-declared rich text and give it
+a name \ameta{name\SUB{rvvc}}.
+\bVerb\takeMeasure{\string\setRVVContent\darg{\ameta{name\SUB{rvvc}}}\darg{\ameta{name\SUB{para}}}}%
+\begin{minipage}{\linewidth}
+\begin{minipage}{\bxSize}
+\xdef\panelWidth{\the\linewidth}%
+\begin{Verbatim}[frame=single,commandchars=!()]
+\setRVVContent{!ameta(name!SUB(rvvc))}{!ameta(name!SUB(para))}
+...
+\end{Verbatim}
+\end{minipage}\hfill
+\begin{minipage}{\linewidth-\panelWidth}
+\setDisplayNumber\label{display:setRVVC}
+\end{minipage}\end{minipage}\eVerb
+This command expands the paragraph named \ameta{name\SUB{para}} and
+develops the rich text version and the plain text version. It is
+\ameta{name\SUB{rvvc}} that is used as a value for the \opt{richtext} key
+above and illustrated below. To reduce the number of names, you can use
+the same name for \ameta{name\SUB{rvvc}} as for \ameta{name\SUB{para}}
+(\cs{setRVVContent\darg{para1}\darg{para1}}).
+
+The rich text \emph{form field} supports multiple paragraphs, and richer
+formatting options than the \uif{Text Box} annotation. Of importance is
+that the \uif{Text Box} annotation only permits a \emph{single paragraph}.
+
+\item (Optional) Declare a (named) default style using \cs{setDefaultStyle}:
+\bVerb\takeMeasure{\string\setDefaultStyle\darg{\ameta{name\SUB{ds}}}\darg{\ameta{KV-pairs}}}%
+\begin{minipage}{\linewidth}
+\begin{minipage}{\bxSize}
+\xdef\panelWidth{\the\linewidth}%
+\begin{Verbatim}[frame=single,commandchars=!()]
+\setDefaultStyle{!ameta(name!SUB(ds))}{!ameta(KV-pairs)}
+...
+\end{Verbatim}
+\end{minipage}\hfill
+\begin{minipage}{\linewidth-\panelWidth}
+\setDisplayNumber\label{display:setDefStyle}
+\end{minipage}\end{minipage}\eVerb
+This default style is assignment a name that is used as the value of the
+\opt{defstyle} key mentioned earlier, and illustrated below. If a value for
+\opt{defstyle} is not provided, a standard default style is used.
+
+\end{itemize}
+Once the \cs{rtpara}-declared paragraphs have been made and their names have passed through
+\cs{setRVVContent}, you are ready to create a \uif{Text Box} annotation.
+
+\paragraph[Key-values for second argument]{Key-values for second argument.}\label{para:KV2ndArg}
+The required second argument, refer to display~\eqref{display:textbox}, has
+two keys, both of which are optional. You are encouraged to read the
+documentation for the \pkg{richtext} package for greater understanding of the
+descriptions and examples found below.
+\begin{description}
+ \item[\texttt{richtext=\ameta{name\SUB{rvvc}}}] The \opt{richtext} key
+ is the way the rich text is passed to the \uif{Text Box}. The
+ \ameta{name\SUB{rvvc}} is declared by the \cs{setRVVContent}
+ command. Use the command \cs{rtpara} within the \env{textboxpara}
+ environment to define the actual rich text paragraph. For example,
+\begin{Verbatim}[fontsize=\small,commandchars=!()]
+\begin{textboxpara}
+\rtpara{para1}{\span{color=FF0000}{Hello world},
+ this is \bf{rich text}!}
+\end{textboxpara}
+\setRVVContent{myContent}{para1}
+\annotpro[type=textbox,title=dpstory,
+ subject=Text Box]{!textbf(richtext=myContent)}
+\end{Verbatim}
+The above code produces the following \uif{Text Box}:
+\begin{quote}
+\begin{textboxpara}
+\rtpara{para1}{\span{color=FF0000}{Hello world},
+ this is \bf{rich text}!}
+\end{textboxpara}
+\setRVVContent{myContent}{para1}
+\annotpro[type=textbox,title=dpstory,
+ subject=Text Box]{richtext=myContent}
+\end{quote}
+
+ \item[\texttt{defstyle=\ameta{name\SUB{ds}}}] Through the
+ \opt{defstyle} you can define set the default style (refer to the
+ documentation of the \pkg{richtext} package. If this key does not
+ appear, then a predefined default style is provided.
+\begin{Verbatim}[fontsize=\small,commandchars=!()]
+\setDefaultStyle{myDS}{font={'Myriad Pro',sans-serif},
+ color=0000FF}
+\begin{textboxpara}
+\rtpara{para1}{\span{color=FF0000}{Hello world},
+ this is \it{rich text}!}
+\setRVVContent{para1}{para1}
+\end{textboxpara}
+\annotpro[type=textbox,title=dpstory,
+ subject=Text Box]{richtext=para1,!textbf(defstyle=myDS)}
+\end{Verbatim}
+Notice that we've used the name `\texttt{para1}' for both \cs{setRVVContent}
+and \cs{rtpara}. The above code produces the following \uif{Text Box}:
+\begin{flushleft}%\previewtrue
+\begin{minipage}{2in}
+\setDefaultStyle{myDS}{font={'Myriad Pro',sans-serif},color=0000FF}
+\begin{textboxpara}
+\rtpara{para1}{\span{color=FF0000}{Hello world},
+ this is \it{rich text}!}
+\end{textboxpara}
+\setRVVContent{para1}{para1}
+\annotpro[type=textbox,title=dpstory,
+ subject=Text Box]{richtext=para1,defstyle=myDS}
+\end{minipage}\hfill
+\begin{minipage}{\linewidth-2in-10pt}\small
+Press \uif{Ctrl+E} (\app{Windows}) or \uif{Cmd+E} (\app{Mac OS}) to
+obtain the \uif{Properties} toolbar, now double click on the text box to
+obtain the \uif{Text Box Text Properties} toolbar to verify the font used
+is indeed Myriad Pro.
+\end{minipage}
+\end{flushleft}
+\end{description}
+If you are at all interested in generating the \uif{Text Box} annotation using rich text
+strings, you are encouraged to read the documentation on \pkg{richtext},
+there you will learn about all the key-values available to format the text
+and the paragraph.
+
+The \pkg{richtext} package was written for rich text form fields, but applies
+to rich text annotations as well; however, it should be noted that there are
+differences between forms and text box annotations in how they handle rich
+text. One of the major differences is that rich text annotations (\uif{Text
+Box}) \emph{do not support} multiple paragraphs as form fields do; as a
+result, features listed in the \uif{Paragraph} and \uif{Link} tabs of the
+\uif{Form Field Text Properties} dialog box are not available for the
+\uif{Text Box}.
+
+\paragraph[Keys \& commands inherited from the \texorpdfstring{\protect\pkg{richtext}}{richtext} package]%
+{Keys \& commands inherited from the \pkg{richtext} package.}\label{para:InheritedKeys}
+The following keys are supported by the \uif{Text Box} annotation:
+\bVerb\begin{minipage}{\linewidth}
+\begin{minipage}[c]{4in}
+\xdef\panelWidth{\the\linewidth}%
+\begin{quote}\raggedright
+\opt{font}, \opt{size}, \opt{\st{raise}}, \opt{ulstyle},
+\opt{color}, \opt{\st{url}}, \opt{style}, \opt{\st{raw}}, \opt{halign}
+\end{quote}
+\end{minipage}\hfill
+\begin{minipage}[c]{\linewidth-\panelWidth}
+\setDisplayNumber\label{display:suppKeys}
+\end{minipage}\end{minipage}\eVerb
+The following commands are supported:
+\bVerb\begin{minipage}{\linewidth}
+\begin{minipage}[c]{4in}
+\xdef\panelWidth{\the\linewidth}%
+\begin{quote}\raggedright
+\cs{span}, \cs{br}, \cs{it}, \cs{bf}, \cs{sup} and \cs{sub}
+\end{quote}
+\end{minipage}\hfill
+\begin{minipage}[c]{\linewidth-\panelWidth}
+\setDisplayNumber\label{display:suppCmds}
+\end{minipage}\end{minipage}\eVerb
+The ones having an overstrike are supported in a rich text \emph{form field}, but
+not within an \uif{Text Box}. Refer to the documentation of the
+\pkg{richtext} for details of these keys and commands. In this document, we
+illustrate by example.
+
+
+\paragraph[Key-values of \texorpdfstring{\protect\cs{rtpara}}{\textbackslash{rtpara}}]{%
+Key-values of \cs{rtpara}.}\label{para:KeysPara}
+The keys of display~\eqref{display:suppKeys} -- excluding the overstrike ones
+-- may be used in the \ameta{KV-pairs} argument of \cs{rtpara} of
+display~\eqref{display:rtpara}.
+
+\paragraph[Permissible commands within \texorpdfstring{{\protect\ameta{rich-content}}}{<rich-content>}]{%
+Permissible commands within {\protect\ameta{rich-content}}.}\label{para:KeysCmdsRC}
+The \ameta{rich-content} argument of display~\eqref{display:rtpara}
+(normally) consists of Latin 1 characters, plus any markup in the form of the
+commands listed in display~\eqref{display:suppCmds}.
+\begin{itemize}
+ \item \cs{span} has two arguments, more on this command in the paragraph below
+ titled \Nameref{para:Span}.
+ \item \cs{br} is a line break, it has no argument.
+ \item \cs{it} is italic font; it has one argument, the text to be
+ placed in italics: \cs{it\darg{this is italic}}.
+ \item \cs{bf} is bold font; it has one argument, the text to be placed in bold:
+ \cs{bf\darg{this is bold}}.
+
+ \cs{it} and \cs{bf} may be nested: \cs{it\darg{\cs{bf\darg{bold and italic}}}}.
+
+ \item \cs{sup} and \cs{sub} are superscript and subscript, respectively; they each
+ have one argument, the text to be raised or lowered. For example,
+ \verb~We can \sup{raise} or we can \sub{lower} text~.
+\end{itemize}
+The above markups, with the exception of \cs{span} are illustrated below.\label{exmpl:rt}
+\begin{defineJS}{\annotextboxi}
+\\begin{textboxpara}
+\\rtpara{mypara}{\\it{This is italic}, whereas \\bf{this is bold}, but wait, we can do
+\\it{\\bf{bold and italic}}.\\br\\br Moving on, we can \\sup{raise} or we can \\sub{lower} text.}
+\\end{textboxpara}
+\\setRVVContent{mypara}{mypara}
+\\annotpro[type=textbox,width=3.5in]{richtext=mypara}
+\end{defineJS}
+\begin{quote}
+\begin{textboxpara}
+\rtpara{mypara}{\it{This is italic}, whereas \bf{this is bold}, but wait, we can do
+\it{\bf{bold and italic}}.\br\br Moving on, we can \sup{raise} or we can \sub{lower} text.}
+\end{textboxpara}
+\setRVVContent{mypara}{mypara}
+\annotpro[type=textbox,width=3.5in]{richtext=mypara}%
+\annotpro[margin,readonly,margintext={\centering The Code}]{\annotextboxi}%
+\end{quote}
+The verbatim listing for this example is in the sticky note in the margin.
+
+\paragraph[Some comments on the \texorpdfstring{\protect\cs{span}}{\textbackslash{span}}
+command]{Some comments on the \cs{span} command.}\label{para:Span}
+the \cs{span} command, defined only locally within the \ameta{rich-text} argument \cs{rtspan} is a general purpose
+command to format text. It has two argument:
+\begin{quote}
+\cs{span\darg{\ameta{KV-pairs}}\darg{\ameta{text}}}.
+\end{quote}
+The \ameta{KV-pairs} argument can be the keys of
+display~\eqref{display:suppKeys} (again excluding the overstrike keys). The \ameta{text} argument is the
+text to be made rich; experience shows that \cs{it}, \cs{bf}, \cs{sub} and \cs{sup} may be used within
+\ameta{text}. Italic and bold may be accomplished using the \opt{style} key, probably preferred over
+using \cs{it} and \cs{bf} within \ameta{text}.
+\begin{defineJS}{\annotextboxi}
+\\begin{textboxpara}
+\\rtpara{para1}{Welcome to my \\span{style={strikeit,bold}}{poor}\\span{style=bold}{rich text world}.
+We add a little color shall we try \\span{color=FF0000}{red} or \\span{color=00FF00}{green}?\\br\\br
+There are several styles of underlining \\span{ulstyle=ul}{basic underlining},
+\\span{ulstyle=2ul}{double underlining}, \\span{ulstyle=wul}{word underlining}, and
+\\span{ulstyle=2wul}{double word underlining}. Cool.}
+\\end{textboxpara}
+\\setRVVContent{para1}{para1}
+\\annotpro[type=textbox,width=4.5in,height=14bp*7]{richtext=para1}
+\end{defineJS}
+\begin{quote}
+\begin{textboxpara}
+\rtpara{para1}{Welcome to my \span{style={strikeit,bold}}{poor}\span{style=bold}{rich text world}.
+We add a little color shall we try \span{color=FF0000}{red} or \span{color=00FF00}{green}?\br\br
+There are several styles of underlining \span{ulstyle=ul}{basic underlining},
+\span{ulstyle=2ul}{double underlining}, \span{ulstyle=wul}{word underlining}, and
+\span{ulstyle=2wul}{double word underlining}. Cool.}
+\end{textboxpara}
+\setRVVContent{para1}{para1}
+\annotpro[type=textbox,width=4.5in,height=14bp*7]{richtext=para1}%
+\annotpro[margin,readonly,margintext={\centering The Code}]{\annotextboxi}%
+\end{quote}
+The verbatim listing for this example is in the sticky note in the margin.
+
+\paragraph[Key-values of \texorpdfstring{\protect\cs{setDefaultStyle}}{\textbackslash{setDefaultStyle}}]%
+{Key-values of \cs{setDefaultStyle}.}\label{para:KeysDS} The
+keys of display~\eqref{display:suppKeys} -- excluding the overstrike ones --
+may be used in the \ameta{KV-pairs} argument of \cs{setDefaultStyle} of
+display~\eqref{display:setDefStyle}; however, only the keys \opt{font},
+\opt{size}, \opt{color}, and \opt{halign} are typically used. For example,
+\begin{Verbatim}[xleftmargin=\amtIndent,fontsize=\small,commandchars=!()]
+\setDefaultStyle{myDS}{font={'Myriad Pro',sans-serif},
+ size=12.0,color=0000FF,halign=left}
+\end{Verbatim}
+The name `\opt{myDS}' may then be used as the value of \opt{defstyle} key in the second argument
+of \cs{annotpro}, see display~\eqref{display:textbox}.
+
+\subsubsection{Key-values for text box annotations}
+
+\hyperref[s:CommonKeys]{Section~\ref*{s:CommonKeys}} lists keys that are
+common to all annotations; we list the ones that make sense for the \uif{Text
+Box} annotation, and strikeout those that do not:
+\begin{quote}\raggedright
+\texttt{type}, \texttt{\st{name}}, \texttt{title}, \texttt{subject},
+\texttt{\st{color}}, \texttt{readonly}, \texttt{opacity}, \texttt{margin},
+\texttt{presets}
+\end{quote}
+In addition to these keys, there are several keys particular to the text box
+annotation. We list these and describe them in detail.
+\begin{itemize}
+ \item \texttt{width=\ameta{length}}: The width of the annotation, the
+ default is \texttt{144bp} (\texttt{2in}).
+ \item \texttt{height=\ameta{length}}: The height of the annotation, the
+ default is \texttt{72bp} (\texttt{1in}).
+ \item \texttt{bgcolor=\ameta{color}} The color to be used as the background color
+ of the text box annotation. If \opt{bgcolor} has no value, transparent color is used.
+ The default is white.
+ \item \texttt{bcolor=\ameta{color}} The color to be used as the boundary color of the
+ annotation. The default is black.
+ \item \texttt{borderstyle=\ameta{choice}}: This keys determines the
+ style of border to be used. It is a choice key, choices are
+ \texttt{none}, \texttt{solid}, \texttt{dash1}, \texttt{dash2},
+ \texttt{dash3}, \texttt{dash4}, \texttt{dash5}, \texttt{dash6},
+ \texttt{cloud1}, and \texttt{cloud2}. The default is \texttt{solid}.
+ \item \texttt{borderwidth=\ameta{choice}}: The border width of the
+ annotation, acceptable choices are \texttt{.5}, \texttt{1}, \texttt{2},
+ \texttt{3}, \texttt{4}, \texttt{6}, 8, and \texttt{10}. The default is \texttt{1}.
+\end{itemize}
+\begin{textboxpara}
+\rtpara{para1}{\cs{annotpro[type=textbox, width=\cs{linewidth}, height=14bp*2, bgcolor=cornsilk,
+bcolor=blue]{richtext=para1}}}\setRVVContent{para1}{para1}
+\rtpara{para2}{\cs{annotpro[type=textbox, width=\cs{linewidth}, height=16bp*3, bgcolor, bcolor=red,
+borderstyle=dash2, borderwidth=2]{richtext=para2}}}\setRVVContent{para2}{para2}
+\rtpara{para3}{\cs{annotpro[type=textbox, width=\cs{linewidth}, height=18bp*3, bcolor=red,
+borderstyle=cloud1]{richtext=para3}}}\setRVVContent{para3}{para3}
+\end{textboxpara}%\previewtrue
+\setDefaultStyle{myDS}{font=Courier,size=12.0,color=000000}
+\annotpro[type=textbox, width=\linewidth, height=14bp*2, bgcolor=cornsilk, bcolor=blue]{richtext=para1,defstyle=myDS}\\[6bp]
+\annotpro[type=textbox, width=\linewidth, height=16bp*3, bgcolor, bcolor=red, borderstyle=dash2, borderwidth=2]{richtext=para2,defstyle=myDS}\\[6bp]
+\annotpro[type=textbox, width=\linewidth, height=18bp*3, bcolor=red, borderstyle=cloud1]{richtext=para3,defstyle=myDS}\\[6bp]
+The second text box annotation above has transparent background color. Using your pointing device, move it around to verify
+the background is `see through', compare with the other two by moving them around, not `see through'.
+
+\subsection{The text markup annotations}
+
+We paraphrase the \textsl{PDF Reference}, version 1.7, on page~633,
+\begin{quote}
+Text markup annotations appear as highlights, underlines, strikeouts, and
+jagged (``quiggly'') underlines in the text of the document. When opened,
+they display a pop-up window the text of the associated note. The syntax
+for \cs{annotpro} is given below:
+\end{quote}
+This annotation type represents a challenge to the {\LaTeX} package developer in that
+this annotation is \annotpro[type=underline]{This first example demonstrates an underline text markup annotation.}{tied to typeset content of the document itself}.
+\bVerb\takeMeasure{\quad{type=\ameta{\upshape{highlight|underline|squiggly|strikeout}}},}%
+\begin{minipage}{\linewidth}
+\begin{minipage}{\bxSize}
+\xdef\panelWidth{\the\linewidth}%
+\begin{Verbatim}[frame=single,commandchars=!()]
+\annotpro*[% !sffamily(Syntax for text markup annotation)
+!quad(type=!ameta(!upshape(highlight|underline|squiggly|strikeout))),
+!quad!ameta(KV-pairs)]{!ameta(content)}{!ameta(text)}
+\end{Verbatim}
+\end{minipage}\hfill
+\begin{minipage}{\linewidth-\panelWidth}
+\setDisplayNumber\label{display:arbproCmdtm}
+\end{minipage}\end{minipage}\eVerb For a text markup annotation, the \texttt{type} key must be one of
+the values listed above. Notice that when creating a text markup annotation, there is a third
+required argument, \ameta{text}; compare this with the syntax of all other
+annotations, given in display~\eqref{display:arbproCmd} on
+page~\pageref{display:arbproCmd}. The \ameta{content} argument can be text or
+a key-value pair, the latter is used to create rich text content. Refer to
+Section~\ref{rtContent} for a discussion of this option.
+
+\subsubsection{Key-values for the text markup annotation}
+
+This annotation inherits many of the key-values listed earlier, and recognized a few more.
+
+The following is the list of keys common to all annotations, taken from Section~\ref{s:CommonKeys}.
+The keys that are not applicable to the text markup annotation are struck out.
+\begin{quote}
+\key{type}, \key{\st{name}}, \key{title}, \key{subject}, \key{color} (the
+color of the appearance of the annotation), \key{hidden} (a hidden
+annotation may be made visible using JavaScript), \key{readonly},
+\key{opacity}, \key{internalID}, \key{\st{margin}}, \key{\st{margintext}},
+\key{presets}
+\end{quote}
+In addition to the ones above, there are several keys for this type of annotation. These address the problem
+of text markup that crosses page boundaries. The techniques are from \pkg{aeb\_mlink}.
+\begin{itemize}
+ \item \key{crackat=\ameta{num}} Break the \ameta{text} after the \ameta{num}${}^{\text{th}}$ syllable.
+ \item \key{hyph=\ameta{\upshape{true|false}}} If \texttt{true}, a hyphen character is inserted at the break point.
+ (The default is \texttt{false}.)
+ \item \key{crackinsat={\ameta{\LaTeX-markup}}} This key inserts \ameta{\LaTeX-markup} after the
+ break in the annotation, more precisely, after the hyphen, if any.
+ \item \key{copycontent=\ameta{\upshape{true|false}}} Now here's an idea.
+ When the \key{text} of a text markup annotation is ``cracked''
+ (broken), a new annotation is created on the next page where its
+ \ameta{text} is the remaining text (following the
+ \ameta{num}${}^{\text{th}}$ syllable), We can either transfer the
+ \key{content} to the new annotation or not. If
+ \key{copycontent=true} (or just \key{copycontent}) the
+ \ameta{content} is transferred to the to the annotation on the next
+ page. The default is \key{copycontent=false}, that is, do not copy
+ the original \key{content}. The content of the annotation on the
+ next page is \cs{apContText}, the definition of which is,
+\begin{Verbatim}[fontsize=\small]
+\newcommand\apContText{Continued from previous annotation}
+\end{Verbatim}
+This command may be redefined.
+\end{itemize}
+
+\subsubsection{Text markup illustrated}
+
+In this section, the four supported text markup annotation types are
+illustrated, and the problem of breaking (or cracking) a text markup annotation
+is discussed. The examples presented in this section are available on the sample
+file \texttt{text-markup.tex}, found in the \texttt{examples} folder.
+
+\paragraph[Ordinary text markups]{Ordinary text markups.}
+These are annotations that do not cross a page boundary.
+
+\begin{itemize}\tightsettings
+\item \textbf{Highlight:} \annotpro[type=highlight]{Try to remember this,
+ it's important}{A \emph{highlight} text markup annotation: Let's extend
+ this text to cross to the next line.}
+\begin{Verbatim}[xleftmargin=\amtIndent,fontsize=\small]
+\annotpro[type=highlight]{Try to remember this, it's
+ important}{A \emph{highlight} text markup annotation:
+ Let's extend this text to cross to the next line.}
+\end{Verbatim}
+
+\item \textbf{Underline:} \annotpro[type=underline]{Memorize this
+ passage}{An \emph{underline} text \emph{markup} annotation: Let's extend this
+ text to cross to the next line.}
+\begin{Verbatim}[xleftmargin=\amtIndent,fontsize=\small]
+\annotpro[type=underline]{Memorize this passage}
+ {An \emph{underline} text \emph{markup} annotation:
+ Let's extend this text to cross to the next line.}
+\end{Verbatim}
+
+\item \textbf{Squiggly:} \annotpro[type=squiggly]{This needs revision}{An
+ \emph{squiggly underline} text markup annotation: Let's extend this
+ text to cross to the next line.}
+\begin{Verbatim}[xleftmargin=\amtIndent,fontsize=\small]
+\annotpro[type=squiggly]{This needs revision}{An
+ \emph{squiggly underline} text markup annotation:
+ Let's extend this text to cross to the next line.}
+\end{Verbatim}
+
+\item \textbf{Strike-Out:}
+ \annotpro[type=strikeout]{Nonsense!}{An \emph{strikeout} text markup annotation: Let's
+ extend this text to cross to the next line.}
+\begin{Verbatim}[xleftmargin=\amtIndent,fontsize=\small]
+\annotpro[type=strikeout]{Nonsense!}{An \emph{strikeout}
+ text markup annotation: Let's extend this text to
+ cross to the next line.}
+\end{Verbatim}
+\end{itemize}
+In all cases, the default color is used. (The default color is the same as
+the default color that \app{Adobe Acrobat} or \app{Adobe Reader} assigns.)
+
+\paragraph[Cracked text markups]{Cracked text markups.} A tricky problem unique to text markups is the
+possibility of \ameta{text} crossing over to the next page; in this circumstance, either rewrite the paragraph containing
+the annotation, or crack it up, that is, break it into two annotations, let the second one move to the next page.
+To illustrate:
+\begin{quote}\def\pb{\penalty-10 \rule{\linewidth}{.4pt}\makebox[0pt][l]{\hspace{\marginparsep}\small page break}\par\smallskip}%\turnSyllbCntOn
+\annotpro[type=underline,crackat=34,hyph,crackinsat=\pb]{Memorize this
+ passage}{An \emph{underline} text \emph{markup} annotation: Let's extend this
+ text to cross to the next line. We are not near a page boundary, so we must simulate
+ cracking up the text markup annotation.}
+\end{quote}
+If you are viewing this documentation in a PDF viewer that supports comment
+annotations (\app{Adobe Reader}), you can inspect the \ameta{content}. Prior
+to the ``page break'', \ameta{content} is ``Memorize this passage''; after
+the ``page break'', the \ameta{content} is the expansion of the command
+\cs{apContText}. The verbatim listing of is,
+\begin{Verbatim}[fontsize=\small,commandchars=!()]
+\begin{quote}
+ \def\pb{\penalty-10 \rule{\linewidth}{.4pt}\makebox[0pt][l]
+ {\hspace{\marginparsep}\small page break}\par\smallskip}%
+\annotpro[type=underline,!textbf(crackat=34),hyph,crackinsat=\pb]
+ {Memorize this passage}{An \emph{underline} text \emph{markup}
+ annotation: ... cracking up the text markup annotation.}
+\end{quote}
+\end{Verbatim}
+In the above code, \key{crackat=34} is used to break the \ameta{text} apart into two annotations of the
+same type and properties. The \key{hyph} key is used because the break point is at an hyphenated word.
+the \key{crackinst} key is used to insert additional material after the hyphen; it simulates a break
+in the page. (A \cs{pb} command is locally defined as a convenience command.)
+
+The above example is repeated, but with \key{copycontent} and another command \cs{turnSyllbCntOn}
+that can be helpful in the authoring stage.
+\begin{quote}\turnSyllbCntOn
+\def\pb{\penalty-10 \rule{\linewidth}{.4pt}\makebox[0pt][l]{\hspace{\marginparsep}\small page break}\par\smallskip}%\turnSyllbCntOn
+\annotpro[type=underline,crackat=34,hyph,copycontent,crackinsat=\pb]{Memorize this
+ passage}{An \emph{underline} text \emph{markup} annotation: Let's extend this
+ text to cross to the next line. We are not near a page boundary, so we must simulate
+ cracking up the text markup annotation.}
+\end{quote}
+If you view the \ameta{content} of annotations A8 versus A9, you''ll see they are the same; the content
+was copied between annotations, unlike the previous example. The other interesting change
+is the numbering of the syllables as the \pkg{soul} package sees them. You can now see why I chose
+\key{crackat=34}, it was the end of a line and that line ended in a hyphenated word. The notation
+A8 and A9 mark the beginning of a text markup annotation; these markups are referenced in the \app{Distiller}
+log or the \app{ps2pdf} log. The markups can be turned on and off by
+the commands \cs{mlMarksOn} and \cs{mlMarksOff}. The counting of syllables can be turned off by
+executing \cs{turnSyllbCntOff} (or by deleting or commenting out \cs{turnSyllbCntOn}).
+\begin{Verbatim}[fontsize=\small,commandchars=!()]
+\begin{quote}!textbf(\turnSyllbCntOn)
+ \def\pb{\penalty-10 \rule{\linewidth}{.4pt}\makebox[0pt][l]
+ {\hspace{\marginparsep}\small page break}\par\smallskip}%
+\annotpro[type=underline,crackat=34,hyph,!textbf(copycontent),
+ crackinsat=\pb]{Memorize this passage}{An \emph{underline}
+ text \emph{markup} annotation: ... cracking up the text
+ markup annotation.}
+\end{quote}
+\end{Verbatim}
+\textbf{Important.} You may have to compile several times to bring auxiliary
+files up to date. The {TEX} log will contain warnings on the state of the
+annotations; the \app{Distiller} or \app{ps2pdf} log contains even more
+information. You can increase the amount in information written to the logs
+by increasing the value of the \opt{dblevel}, try \opt{dblevel=1}.
+
+\section{Creating rich text contents}\label{rtContent}
+
+When the content (or comment) of an annotation is text, the syntax for the
+supported annotations are given in display~\eqref{display:arbproCmd}
+and~\eqref{display:arbproCmdtm}. An alternate syntax is implemented for
+the case of rich text content. Our comments in this section do not include the text box, which
+has already been covered in detail in Section~\ref{s:textbox}; the syntax for a text box is
+given in display~\eqref{display:textbox}.
+\begin{Verbatim}[xleftmargin=\amtIndent]
+\usepackage[richtext]{annot_pro}
+\end{Verbatim}
+As with the text box, to obtain rich text in the content of the annotation,
+the \opt{richtext} option is required. That being required, the alternate
+syntax for the (non-text box) annotations is,
+\bVerb\takeMeasure{\quad{type=\ameta{\upshape{highlight|underline|squiggly|strikeout}}},}%
+\def\1{\rule[15pt]{0pt}{0pt}}
+\begin{minipage}{\linewidth}
+\begin{minipage}{\bxSize}
+\xdef\panelWidth{\the\linewidth}%
+\begin{Verbatim}[frame=single,commandchars=!()]
+\annotpro*[% !sffamily(Syntax for text markup annotation)
+!quad(type=!ameta(!upshape(highlight|underline|squiggly|strikeout))),
+!quad!ameta(KV-pairs)]{richtext=!ameta(name)}{!ameta(text)}
+!1\annotpro*[% !sffamily(Syntax for all other annotations)
+!quad!ameta(KV-pairs)]{richtext=!ameta(name)}
+\end{Verbatim}
+\end{minipage}\hfill
+\begin{minipage}{\linewidth-\panelWidth}
+\setDisplayNumber\label{display:arbproRT}
+\end{minipage}\end{minipage}\eVerb
+In the above, \ameta{content} is replaced by \texttt{richtext=\ameta{name}}.
+
+The techniques for using rich text are described in the subsection
+`\mlnameref{ss:textbox}' on page~\pageref{ss:textbox}.
+\emph{Only} the \key{richtext} key is supported; the \key{defstyle} key is
+not supported, so \emph{do not use it}.
+
+
+\subsection{Annotations with rich text illustrated}
+
+Only two examples are presented here: firstly, a sticky note\annotpro[margin,readonly]{richtext=mypara} appears in the margins, and
+secondly, \annotpro[type=highlight]{richtext=mypara}{a text markup annotation within this current paragraph}.
+The verbatim listing of the highlight text markup is,
+\begin{Verbatim}[xleftmargin=\amtIndent,fontsize=\small,commandchars=!()]
+\annotpro[type=highlight]!textbf({richtext=mypara}){a text markup
+ annotation within this current paragraph}
+\end{Verbatim}
+where \texttt{mypara} was defined earlier in
+paragraph~\mlNameref{para:KeysCmdsRC}. (See sticky note labeled
+`\textcolor{blue}{\textbf{The Code}}' in the margins of that paragraph, on
+page~\pageref{exmpl:rt}.)
+
+\subsection{Accented glyphs and the unicode characters}
+
+There are several advantages that text box annotation have over rich text
+form fields: movability and unicode. An annotation can be moved around the
+page by the user quite easily, a form field typically cannot unless the
+document consumer is using \app{Acrobat}. Also, when it comes to using
+unicode, text box annotations are far superior to rich text form fields.
+Unicode characters may be inserted using the convenience commands
+\cs{uHex}\marginpar{\small\cs{uHex}} and
+\cs{uDec}\marginpar{\small\cs{uDec}}, where the first take a hex code as its
+argument and the second takes a non-negative integer as its argument. Latin1
+accented characters may be entered using octal notation for example,
+\verb~J\374rgen~
+\begin{defineJS}{\annotextboxi}
+\\begin{textboxpara}
+\\rtpara{para1}{J\\374rgen is a nice fellow, though I've never met him.\\br\\br
+We've communicated, J\\uHex{00FC}rgen and I, via email. J\\uDec{252}rgen where are you?}
+\\end{textboxpara}
+\\setRVVContent{para1}{para1}
+\\annotpro[type=textbox,width=4.5in,height=14bp*7]{richtext=para1}
+\end{defineJS}
+\begin{textboxpara}
+\rtpara{para1}{J\374rgen is a nice fellow, though I've never met him.\br\br
+We've communicated, J\uHex{00FC}rgen and I, via email. J\uDec{252}rgen where are you?}
+\end{textboxpara}
+\begin{quote}
+\setRVVContent{para1}{para1}
+\annotpro[type=textbox,width=4in,height=16bp*4]{richtext=para1}%
+\annotpro[margin,readonly,margintext={\centering The Code}]{\annotextboxi}%
+\end{quote}
+
+\begin{comment}
+
+But wait, we're not done. In theory, we can access any unicode character through the use
+of \cs{uHex} or \cs{uDec}. I'll randomly pick off some unicode characters.
+\begin{defineJS}{\annotextboxi}
+\\begin{textboxpara}
+\\rtpara{para1}{%
+\\uHex{01A2}, \\uHex{023E}, \\uHex{03A3}, \\uHex{0416},
+\\uHex{0583}, \\uHex{06A6}, \\uHex{263A}, \\uHex{FB21},
+\\uHex{82A0}, \\uHex{4EE4}, \\uHex{F92C}, \\uHex{5475}}
+\\end{textboxpara}
+\\setRVVContent{para1}{para1}
+\\annotpro[type=textbox,width=4in,height=14bp*2]{richtext=para1}
+\end{defineJS}
+\begin{textboxpara}
+\rtpara{para1}{%
+\uHex{01A2}, \uHex{023E}, \uHex{03A3}, \uHex{0416},
+\uHex{0583}, \uHex{06A6}, \uHex{263A}, \uHex{FB21},
+\uHex{82A0}, \uHex{4EE4}, \uHex{F92C}, \uHex{5475}}
+\end{textboxpara}
+\begin{quote}%\previewtrue
+\setRVVContent{para1}{para1}
+\annotpro[type=textbox,width=4in,height=14bp*2]{richtext=para1}%
+\annotpro[margin,readonly,margintext={\centering The Code}]{\annotextboxi}%
+\end{quote}
+Cool!
+
+\end{comment}
+
+\section{Setting Global Options with
+ \texorpdfstring{\protect\cs{setAnnotOptions}}{\CMD{setAnnotOptions}}}
+
+Global options are by using the \cs{setAnnotOptions} command.
+In the preamble of this document I placed
+\begin{Verbatim}[fontsize=\footnotesize]
+\setAnnotOptions{subject={AcroTeX Communiqu\'e},title={D.P. Story}}
+\end{Verbatim}
+That way, I didn't have to constantly type in my personal name for each example. These options can be overwritten
+by specifying options locally, if I say, \cs{annotpro[author=Don Story]\darg{Hi there!}}, the author is now my
+alter ego, Don Story.
+
+%\redpoint\textbf{\textcolor{red}{Important:}} Certain key, \texttt{name}, should not be used to set global options,
+%\cs{setAnnotOptions} tests for these, and puts them back to their default values that are expected
+%by \cs{annotpro}. These keys should only be used for passing options to \cs{annotpro} in its option list.
+
+
+\bigskip
+\noindent
+That's all for now, I simply must get back to my retirement. \dps\space\annotpro[type=stamp,
+ customStamp=MyDPSImage,ap=AdobeDon,color=webbrown]{%
+ Did I say that I had to get back to my retirement?}
+
+\end{document}
diff --git a/macros/latex/contrib/annot_pro/examples/annots.pdf b/macros/latex/contrib/annot_pro/examples/annots.pdf
new file mode 100644
index 0000000000..b0c43b389d
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/examples/annots.pdf
Binary files differ
diff --git a/macros/latex/contrib/annot_pro/examples/annots.tex b/macros/latex/contrib/annot_pro/examples/annots.tex
new file mode 100644
index 0000000000..e8fa584c56
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/examples/annots.tex
@@ -0,0 +1,198 @@
+\documentclass{article}
+\usepackage[%
+ web={tight,usesf,usetemplates},
+]{aeb_pro}
+\usepackage[scandoc]{annot_pro}
+
+\title{The \textsf{annot\_pro} Package\texorpdfstring{\\[2ex]}{: }Text, Stamp, and File Attachment Annotations}
+\author{D. P. Story}
+\university{Acro\negthinspace\TeX.Net}
+\email{dpstory@acrotex.net}
+\subject{Acrobat text, stamp, and file attachment annotations}
+\keywords{AcroTeX, AeB Pro, Acrobat annotations}
+
+\textBgColor{webyellow}
+
+\DeclareInitView
+{%
+ layoutmag={mag=100},
+ windowoptions={fit}
+}
+
+\margins{.5in}{.5in}{24pt}{.25in} % left,right,top, bottom
+\screensize{4.5in}{6in} % height, width
+
+\def\myNote{type=text,name=Note,color=webyellow}
+\newcommand{\cs}[1]{\texttt{\char`\\#1}}
+
+%
+% This needs to be set to the path to the graphics folder
+%
+\defineAPath{\graphicsPath}{C:/Users/Public/Documents/My TeX Files/%
+ tex/latex/aeb/aebpro/annot_pro/examples/graphics}
+
+\marginparsep=6pt
+\marginparwidth=.25in
+\parskip6pt
+\parindent0pt
+
+\reversemarginpar
+
+\setAnnotOptions{subject={AcroTeX Communiqu\'e},title={D.P. Story}}
+
+\begin{document}
+
+\maketitle
+
+\section{Introduction}
+
+This is a brief demo package for the \textsf{annot\_pro} package. This package uses
+Adobe Distiller to distill PostScript files created by dvips (or dvipsone) to produce
+a selection of useful annotations, the ones for text (also called sticky notes), stamps,
+and file attachments. We take up each of these annotation types in that order. The command
+to create all types of supported annotation is \cs{annotpro}. The syntax is\dots
+\begin{verbatim}
+ \annotpro[<key-values>]{<content>}
+\end{verbatim}
+There are several keys that are common to all annotations, among
+these are \texttt{title} (whose value is usually the author of the
+annotation), and \texttt{subject}. The \texttt{<content>} argument
+is the text of the pop-up window (in the case of text and stamp
+annotations), and the file attachment description (for file
+attachment annotations).For example, \annotpro[title=Don Story,subject=AcroTeX.Net]{This is the content of the sticky note.}; the code is
+\begin{verbatim}
+ \annotpro[title=Don Story,subject=AcroTeX.Net]
+ {This is the content of the sticky note.}
+\end{verbatim}
+
+See the documentation for this package, \texttt{annotpro\_man.pdf}, for details
+beyond what is presented here.
+
+\section{Text annotations}
+
+There are a number of difference text annotation icons that can be used. The default
+is the \texttt{Note} annotation \annotpro{This is a Note annotation, or sticky note.}. The
+type of annotation is selected using the \texttt{type} key, text
+annotations are \texttt{type=text} (the default). An icon is selected using the \texttt{name} key.
+The above annotation is the default \texttt{name=Note}; consequently, the syntax is very simple:
+\begin{verbatim}
+ \annotpro{This is a Note annotation, or sticky note.}
+\end{verbatim}
+The default behavior is to leave the correct vertical and horizontal space in {\TeX} space to
+place the icon. The icons of a text annotation do not re-scale, they remain the same size regardless
+of the page magnification; consequently, they look best when the magnification is at 100\%.
+
+There are keys (\texttt{nohspace}, \texttt{novspace}, and \texttt{nospace}) for removing
+space around the icon in {\TeX} space.
+
+This is a sticky note that takes that uses the \texttt{\texttt{nohspace}} key.\makebox[0pt][r]{\raisebox{10bp}{\annotpro[name=Comment,nohspace]{J\"{u}rgen is a cool guy!}}\hspace{6bp}}
+The sticky note retains vertical space. For sticky notes, there are three keys for removing space,
+\texttt{nohspace}, \texttt{novspace}, and \texttt{nospace}. Acrobat users can move these icons around
+on the page, but users of Adobe Reader cannot; therefore, if an annot is to be used, it should not cover
+any page content. You can see the additional space left between paragraphs, this space was created
+by the vertical space of the note. Here,\annotpro[name=Comment,nospace,color=blue]{J\"{u}rgen is a cool guy!} the blue note, is the same note with the \texttt{nospace} key.
+
+Annots can be placed in the margin\annotpro[presets=\myNote,margin,readonly,margintext={Hi\\Mom!}]{This one appears in the margin of the document.}
+using the \texttt{margin} key, with an optional ``caption.'' The core {\LaTeX} command \cs{marginpar} is used. This particular
+annotation uses the \texttt{presets} key, this key allows you to predefine some options. The code for the margin note is
+\begin{verbatim}
+ \annotpro[presets=\myNote,margin,readonly,margintext={Hi\\Mom!}]
+ {This one appears in the margin of the document.}
+\end{verbatim}
+
+Here is another sticky note, the \texttt{Check}
+\annotpro[color=yellowgreen,name=Check]{This is an example of a
+note.\string\n\string\n We've created a blank line and started a new
+paragraph.}.
+
+\section{Stamp Annotations}
+
+
+The \textsl{PDF Reference} lists several stamps that are guaranteed to exist, by any conforming PDF viewer.
+This stamp is one\smash{\raisebox{38pt}{\makebox[0pt][l]{\annotpro[type=stamp,name=Approved,widthTo=150bp,color=blue]{I give my stamp of approval!}}}} of
+the standard stamps. A stamp is created by by putting \texttt{type=stamp} and by setting the
+\texttt{name} key to the name of the stamp.
+
+The stamp annotation does not obey the \texttt{nospace} keys, the same effect can be obtains using
+various combinations of \cs{smash} and \cs{makebox}. The code for the stamp above is
+\begin{verbatim}
+ \smash{\makebox[0pt][l]{\raisebox{36pt}{
+ \annotpro[type=stamp,name=Approved,widthTo=150bp,
+ color=blue]{I give my stamp of approval!}}}}
+\end{verbatim}
+Did I forget to mention \cs{raisebox}? I needed that command keep the stamp from covering page content.
+The \textsf{annot\_pro} package has a \texttt{preview} option. If used, the bounding rectangles of
+the annotations can be viewed in a dvi previewer. This helped me to place the stamp through my dvi previewer.
+
+Stamps can be re-scaled using \texttt{widthTo} (for re-scaling a stamp to a specified width), \texttt{heightTo} (for re-scaling to height),
+or \texttt{scale} (for re-scaling using a re-scaling factor, for example, \texttt{scale=.5}).
+For example, here is a stamp resize to 20bp width \annotpro[type=stamp,name=WordsTheBestJustGotBetter,widthTo=20bp,color=webbrown]{This package just got better!}.
+This stamp is one of the ``extra'' stamps that are (sometimes) shipped with Acrobat, see the file \texttt{stamps.pdf} for a complete listing
+of these extra stamps that ship with Acrobat.
+
+Stamps can be placed in the margins,\annotpro[type=stamp,name=WordsTheBestJustGotBetter,margin,widthTo=20bp,color=webbrown]{This package just got better!}
+but they probably need to be re-scaled to make them smaller; there are several keys that can be used for this purpose.
+A key I've used several times already is \texttt{widthTo} (for re-scaling a stamp to a specified width), \texttt{heightTo} (for re-scaling to height),
+and \texttt{scale} (for re-scaling using a re-scaling factor, for example, \texttt{scale=.5}).
+\begin{verbatim}
+ \annotpro[type=stamp,name=WordsTheBestJustGotBetter,
+ widthTo=20bp,color=webbrown]{This package
+ just got better!}
+\end{verbatim}
+
+Stamps are shipped with Acrobat (and some with Adobe Reader) in the form of PDF files. The PDF consist of
+a series of template pages with one graphical image of a stamp per page. The standard stamps
+reside in the file \texttt{Standard.pdf}.
+
+Additional Stamps: The following stamps may be on your computer, when \textbf{Acrobat Pro} is installed. See the
+file \texttt{stamps.pdf} for a complete listing of the stamps and their names.
+
+
+\begin{itemize}
+\item \texttt{StandardBusiness.pdf}: A \annotpro[type=stamp,name=SBApproved,color=webbrown]{This package just got better!} stamp
+\item \texttt{SignHere.pdf}: A \annotpro[type=stamp,name=SHSignHere,color=webbrown]{This package just got better!} stamp
+\item \texttt{Dynamic.pdf}: A \annotpro[type=stamp,name=\#DApproved,widthTo=2in,color=webbrown]{This package just got better!} stamp
+\item \texttt{Words.pdf}: A \annotpro[type=stamp,name=WordsTheBestJustGotBetter,widthTo=30bp,color=webbrown]{This package just got better!} stamp
+\item \texttt{Faces.pdf}: A \annotpro[type=stamp,name=FacesWow,widthTo=30bp,color=webbrown]{This package just got better!} stamp
+\item \texttt{Pointers.pdf}: A \annotpro[type=stamp,name=PointersWhen,widthTo=100bp,color=webbrown]{This package just got better!} stamp
+\end{itemize}
+These stamps are representatives of the many stamps that reside in the referenced files. The dimensions of these
+stamps are known by \textsf{annot\_pro} for these stamps. These can be resized using the \texttt{widthTo}, \texttt{heightTo}, or \texttt{scale}
+keys.
+
+Note that the names in the \texttt{Dynamic.pdf} file begin with the `\texttt{\#}' symbol. To reference these stamps, use
+\verb!\#!, like so, \verb!name=\#DApproved!.
+
+The bounding rectangle for the non-standard stamps---ones whose
+dimensions are not known to this package---can be set using the
+\texttt{width} and \texttt{height} keys, there are default values if
+these keys are not specified.
+
+The stamps provided by Acrobat can be rotated using the rotate key. For example, the stamp named
+\texttt{PointersWhen} shown above, can be rotated 30 degrees, the stamp and the code are shown below.
+\smash{\makebox[0pt][l]{\put(125,-15){\annotpro[type=stamp,name=PointersWhen,widthTo=50bp,rotate=30,color=webbrown]{Here is the code for this stamp.}}}}
+\begin{verbatim}
+ \smash{\makebox[0pt][l]{\put(130,-20){%
+ \annotpro[type=stamp,name=PointersWhen,
+ widthTo=50bp,rotate=30,color=webbrown
+ ]{Here is the code for this stamp.}}}}
+\end{verbatim}
+See the file \texttt{stamps.tex} (and \texttt{stamps.pdf}) for a
+complete list of these stamps, and their names.
+
+\textbf{\textcolor{red}{Important:}} When using the stamps of
+Acrobat, always perform a \textbf{SaveAs} on the file when you have finished
+building the file. This imports the appearances of the stamps into
+the document and saves them.
+
+
+\section{File Attachment Annotations}
+
+This is a file attachment \annotpro[type=fileattachment,file={\graphicsPath/AdobeDon.pdf},name=Paperclip]{The author of annot\_pro (ho, ho).}
+which depicts the image of an average man. A file attachment is created with \texttt{type=fileattachment}; in addition,
+a value of the file key must be set, here \verb!file={\graphicsPath/AdobeDon.pdf}!, where \cs{graphicsPath} is a command
+that expands to the path to the folder holding \texttt{AdobeDon.pdf}. The definition of the path was made using
+a special command, \cs{defineAPath}, in \texttt{annot\_pro}.
+
+\end{document}
+
diff --git a/macros/latex/contrib/annot_pro/examples/graphics/APB_Logo_Sphere.eps b/macros/latex/contrib/annot_pro/examples/graphics/APB_Logo_Sphere.eps
new file mode 100644
index 0000000000..80c8438b45
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/examples/graphics/APB_Logo_Sphere.eps
Binary files differ
diff --git a/macros/latex/contrib/annot_pro/examples/graphics/AdobeDon.eps b/macros/latex/contrib/annot_pro/examples/graphics/AdobeDon.eps
new file mode 100644
index 0000000000..1f4b8ffc03
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/examples/graphics/AdobeDon.eps
Binary files differ
diff --git a/macros/latex/contrib/annot_pro/examples/graphics/AdobeDon.pdf b/macros/latex/contrib/annot_pro/examples/graphics/AdobeDon.pdf
new file mode 100644
index 0000000000..ace1d19bb1
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/examples/graphics/AdobeDon.pdf
Binary files differ
diff --git a/macros/latex/contrib/annot_pro/examples/graphics/AeST_Logo.eps b/macros/latex/contrib/annot_pro/examples/graphics/AeST_Logo.eps
new file mode 100644
index 0000000000..e885af7f28
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/examples/graphics/AeST_Logo.eps
Binary files differ
diff --git a/macros/latex/contrib/annot_pro/examples/stamps.pdf b/macros/latex/contrib/annot_pro/examples/stamps.pdf
new file mode 100644
index 0000000000..0744239553
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/examples/stamps.pdf
Binary files differ
diff --git a/macros/latex/contrib/annot_pro/examples/stamps.tex b/macros/latex/contrib/annot_pro/examples/stamps.tex
new file mode 100644
index 0000000000..08c0173024
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/examples/stamps.tex
@@ -0,0 +1,140 @@
+\documentclass[12pt]{article}
+\usepackage[forpaper]{web}
+%\usepackage{graphicx}
+\usepackage[scandoc]{annot_pro}
+\usepackage{array}
+
+\setAnnotOptions{subject={annot\_pro by AcroTeX},title={D.P. Story}}
+\useFullWidthForPaper
+
+\parindent0pt\parskip6pt
+
+%\previewtrue
+
+\def\stampW{1in}
+\def\stampH{30pt}
+\def\resizeW{1in}
+
+\newcommand{\showStamp}[2]{#1&#2&\annotpro[type=stamp,name=#1,readonly,widthTo=\resizeW]{Stamp Name: #1}}
+%\newcommand{\showStamp}[2]{#1&#2&\resizebox{\resizeW}{!}{\annotpro[type=stamp,name=#1,readonly,widthTo=\resizeW]{Stamp Name: #1}}}
+
+\begin{document}
+
+The application will insert the largest possible stamp, while
+preserving the aspect ratio. The stamp is centered in the bounding
+box.
+
+The following stamps are shipped with Acrobat in recent years.
+
+\setlength{\extrarowheight}{15pt}
+
+\begin{center}
+\begin{tabular}{>{\ttfamily}lll}
+\multicolumn{3}{>{\Large}c}{Standard.pdf}\\
+\multicolumn{1}{l}{Name (value of \texttt{name} key)} & UI name & Stamp appearance \\
+\showStamp{Approved}{Approved}\\\showStamp{AsIs}{As Is}\\\showStamp{Confidential}{Confidential}\\\showStamp{Departmental}{Departmental}\\\showStamp{Draft}{Draft}\\\showStamp{Experimental}{Experimental}\\\showStamp{Expired}{Expired}\\\showStamp{Final}{Final}\\\showStamp{ForComment}{For Comment}\\\showStamp{ForPublicRelease}{For Public Release}\\\showStamp{NotApproved}{Not Approved}\\\showStamp{NotForPublicRelease}{Not For Public Release}\\\showStamp{Sold}{Sold}\\\showStamp{TopSecret}{Top Secret}
+\end{tabular}
+\end{center}
+
+\setlength{\extrarowheight}{18pt}
+
+\begin{center}
+\begin{tabular}{>{\ttfamily}lll}
+\multicolumn{3}{>{\Large}c}{StandardBusiness.pdf}\\
+\multicolumn{1}{l}{Name (value of \texttt{name} key)} & UI name & Stamp appearance \\
+\showStamp{SBApproved}{Approved}\\\showStamp{SBCompleted}{Completed}\\\showStamp{SBConfidential}{Confidential}\\\showStamp{SBDraft}{Draft}\\\showStamp{SBFinal}{Final}\\\showStamp{SBForComment}{For Comment}\\\showStamp{SBForPublicRelease}{For Public Release}\\\showStamp{SBInformationOnly}{Information Only}\\\showStamp{SBNotApproved}{Not Approved}\\\showStamp{SBNotForPublicRelease}{Not For Public Release}\\\showStamp{SBPreliminaryResults}{Preliminary Results}\\\showStamp{SBVoid}{Void}
+\end{tabular}
+\end{center}
+
+
+\begin{center}
+\begin{tabular}{>{\ttfamily}lll}
+\multicolumn{3}{>{\Large}c}{SignHere.pdf}\\
+\multicolumn{1}{l}{Name (value of \texttt{name} key)} & UI name & Stamp appearance \\
+\showStamp{SBRejected}{Rejected}\\\showStamp{SHAccepted}{Accepted}\\\showStamp{SHInitialHere}{Initial Here}\\\showStamp{SHSignHere}{Sign Here}\\\showStamp{SHWitness}{Witness}
+\end{tabular}
+\end{center}
+
+\newpage
+
+\begin{center}
+\begin{tabular}{>{\ttfamily}lll}
+\multicolumn{3}{>{\Large}c}{Dynamic.pdf}\\
+\multicolumn{1}{l}{Name (value of \texttt{name} key)} & UI name & Stamp appearance \\
+\showStamp{\#DApproved}{Approved}\\\showStamp{\#DConfidential}{Confidential}\\\showStamp{\#DReceived}{Received}\\\showStamp{\#DReviewed}{Reviewed}\\\showStamp{\#DRevised}{Revised}
+\end{tabular}
+\end{center}
+
+
+Each stamp in the above table has a name that begins with the \texttt{\#} character. When using
+\textsf{annot\_pro}, use \verb!\#! instead of \texttt{\#}, like so,
+\verb!name=\#DApproved!.
+
+\newpage
+
+The following three sets were at one time shipped with Acrobat, you may not have some of these.
+
+\begin{center}
+\begin{tabular}{>{\ttfamily}lll}
+\multicolumn{3}{>{\Large}c}{Pointers.pdf}\\
+\multicolumn{1}{l}{Name (value of \texttt{name} key)} & UI name & Stamp appearance \\
+\showStamp{PointersBogus}{Bogus}\\\showStamp{PointersBug}{Bug}\\\showStamp{PointersDOA}{DOA}\\\showStamp{PointersFYEO}{For Your Eyes Only}\\\showStamp{PointersFix}{Fix}\\\showStamp{PointersNuke}{Nuke This}\\\showStamp{PointersOptimize}{Optimize}\\\showStamp{PointersRedFlag}{Red Flag}\\\showStamp{PointersValidate}{Validate}\\\showStamp{PointersWarning}{Warning}\\\showStamp{PointersWhen}{When?}
+\end{tabular}
+\end{center}
+
+\def\resizeW{.5in}
+
+\begin{center}
+\begin{tabular}{>{\ttfamily}lll}
+\multicolumn{3}{>{\Large}c}{Faces.pdf}\\
+\multicolumn{1}{l}{Name (value of \texttt{name} key)} & UI name & Stamp appearance \\
+\showStamp{FacesEcstatic}{Ecstatic}\\\showStamp{FacesElectric}{Electric}\\\showStamp{FacesGrumpy}{Grumpy}\\\showStamp{FacesHappy}{Happy}\\\showStamp{FacesHurt}{Hurt}\\\showStamp{FacesNeutral}{Neutral}\\\showStamp{FacesSmirk}{Smirk}\\\showStamp{FacesSurprised}{Surprised}\\\showStamp{FacesWorried}{Worried}\\\showStamp{FacesWow}{Wow}\\\showStamp{FacesZippy}{Zippy}
+\end{tabular}
+\end{center}
+
+\def\resizeW{1in}
+
+\begin{center}
+\begin{tabular}{>{\ttfamily}lll}
+\multicolumn{3}{>{\Large}c}{Words.pdf}\\
+\multicolumn{1}{l}{Name (value of \texttt{name} key)} & UI name & Stamp appearance \\
+\showStamp{WordsAGenuineFind}{A Genuine Find}\\\showStamp{WordsBigSavings}{Big Savings!}\\\showStamp{WordsDeals}{Deals}\\\showStamp{WordsHappyBirthday}{Happy Birthday}\\\showStamp{WordsHot}{Hot}\\\showStamp{WordsLookWhatsNew}{Look What's New}\\\showStamp{WordsNeato}{Neato!}\\\showStamp{WordsTheBestJustGotBetter}{The Best Just Got Better}
+\end{tabular}
+\end{center}
+
+\def\resizeW{.5in}
+
+\begin{center}
+\begin{tabular}{>{\ttfamily}lll}
+\multicolumn{3}{>{\Large}c}{CompareMarkers.pdf (Acrobat DC)}\\
+\multicolumn{1}{l}{Name (value of \texttt{name} key)} & UI name & Stamp appearance \\
+\showStamp{CompareMarkerAdd}{Marker Add}\\
+\showStamp{CompareMarkerRemove}{Marker Remove}\\
+\showStamp{CompareMarkerChange}{Marker Change}
+\end{tabular}
+\end{center}
+
+Annot: \annotpro[type=stamp,name=\#AST,widthTo=2in,rotate=45]{Annot\_pro rocks!}
+
+
+\end{document}
+
+
+\showStamp{CompareMarkerAdd}{Marker Add}
+\showStamp{CompareMarkerRemove}{Marker Remove}
+\showStamp{CompareMarkerChange}{Marker Change}
+
+tightVNC
+\begin{tooltip}[optional args]{arg1}{arg2}
+\begin{equation} \label{eq1}
+x=y
+\end{equation}
+\end{tooltip}
+
+typeset document ...
+text...
+x=y (1)
+more text....
+more...
+
+Recall equation (1) (tool tip)
diff --git a/macros/latex/contrib/annot_pro/examples/text-markup.pdf b/macros/latex/contrib/annot_pro/examples/text-markup.pdf
new file mode 100644
index 0000000000..63584f73b0
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/examples/text-markup.pdf
Binary files differ
diff --git a/macros/latex/contrib/annot_pro/examples/text-markup.tex b/macros/latex/contrib/annot_pro/examples/text-markup.tex
new file mode 100644
index 0000000000..e903602910
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/examples/text-markup.tex
@@ -0,0 +1,107 @@
+\documentclass{article}
+\usepackage[designiv,extended]{web}
+\usepackage[richtext,dblevel=1]{annot_pro}
+
+\title{text markup annotations}
+\author{D. P. Story}
+\email{dpstory@acrotex.net}
+\subject{text markup annotations}
+\keywords{highlight, underline, squiggly, strikeout, pdf annotations, AcroTeX}
+\university {Acro\TeX.NeT}
+\version{1.0}
+
+
+
+%\usepackage{lucidbry}
+
+% we increase the right margin width to accommodate a margin note
+\addtoWebWidth{.5in}
+\resetmargins{}{\incby+.5in}{}{}
+\setlength{\marginparsep}{4pt}
+
+% try uncommenting the first or second command below
+%\mlMarksOn
+%\turnSyllbCntOn
+
+\begin{textboxpara}
+\rtpara{mypara}{\it{This is italic}, whereas \bf{this is bold}, but wait, we can do
+\it{\bf{bold and italic}}. We can \sup{raise} or \sub{lower} text.
+ \br\spc\spc
+ This is a second paragraph. At your earliest convenience, go to the AcroTeX.Net web site:
+ \br\br\span{ulstyle=ul,color=0000FF}{http://www.acrotex.net} (URLs are not supported.)
+}
+\end{textboxpara}
+\setRVVContent{mypara}{mypara}
+
+\setAnnotOptions{subject={An AcroTeX Communiqu\'e},title={D. P. Story}}
+
+\parindent0pt
+\parskip4pt
+
+\begin{document}
+
+\makeinlinetitle % defined in web
+
+%\begin{center}
+% Extending \textsf{annot\_pro} to include\\
+% text markup annotations
+%\end{center}
+
+Syntax:\\
+\verb!\annotpro[type=<type>,<options>]{<content>}{<text>}!\\[3pt]
+where, \verb~type=highlight|underline|squiggly|strikeout~
+
+\textbf{Highlight:}
+ \annotpro[type=highlight]{Try to remember this, it's important}{A
+ \emph{highlight} text markup annotation: Let's extend this text to cross to
+ the next line.}
+
+\textbf{Underline:}
+ \annotpro[type=underline]{Memorize this passage}{An \emph{underline} text
+ \emph{markup} annotation: Let's extend this text to cross to the next
+ line.}
+
+\textbf{Squiggly:}
+ \annotpro[type=squiggly]{This needs revision}{An \emph{squiggly underline}
+ text markup annotation: Let's extend this text to cross to the next line.}
+
+\textbf{Strike-Out:}
+ \annotpro[type=strikeout]{Nonsense!}{An \emph{strikeout} text markup
+ annotation: Let's extend this text to cross to the next line.}
+
+% we are not breaking at an hyphenated word, too bad
+\annotpro[type=underline,crackat=37,color=blue]{Memorize this passage}{An
+\emph{underline} text \emph{markup} annotation: Let's extend this text to
+cross to the next line. We are not near a page boundary, so we must simulate
+cracking up the text markup annotation.}
+
+Here's the same example as above, but this time, we'll simulate a page break
+and use the \texttt{copycontent} option.
+
+\begingroup % make the next definition local
+\def\pb{\penalty-10 \rule{\linewidth}{.4pt}\makebox[0pt][l]{\hspace{\marginparsep}\small page break}\par\smallskip}%\turnSyllbCntOn
+\annotpro[type=underline,crackat=37,copycontent,crackinsat=\pb]{Memorize this
+ passage}{An \emph{underline} text \emph{markup} annotation: Let's extend this
+ text to cross to the next line. We are not near a page boundary, so we must simulate
+ cracking up the text markup annotation.}
+\endgroup
+
+\smallskip
+\textbf{Rich text:} We use \texttt{richtext=mypara}. \annotpro[type=squiggly]{richtext=mypara}{An \emph{squiggly underline}
+ text markup annotation: Let's extend this text to cross to the next line.}
+
+
+\smallskip
+This next example uses the \texttt{hidden} option; this will hide the comment completely
+as well as the underlining appearance. When the user presses the push button labeled `C',
+the comment becomes visible.
+
+%\textbf{Underline:}
+ \annotpro[type=underline,hidden]{Memorize this passage}{An \emph{underline}
+ text \emph{markup} annotation: Let's extend this text to cross to the next
+ line.} \pushButton[\S{S}\textSize{0}\CA{C}\TU{Press to toggle visibility of this comment}\A{\JS{% var
+ annot=this.getAnnot({nPage:this.pageNum,cName:"\currentAnnotName"});\r
+ annot.hidden=!annot.hidden;}}]{btn}{}{9bp} This button will work in
+ \textsf{Acrobat Reader} and \textsf{PDF-Exchange Viewer}.
+
+\end{document}
diff --git a/macros/latex/contrib/annot_pro/examples/textbox.pdf b/macros/latex/contrib/annot_pro/examples/textbox.pdf
new file mode 100644
index 0000000000..a32925937f
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/examples/textbox.pdf
Binary files differ
diff --git a/macros/latex/contrib/annot_pro/examples/textbox.tex b/macros/latex/contrib/annot_pro/examples/textbox.tex
new file mode 100644
index 0000000000..9c2f460078
--- /dev/null
+++ b/macros/latex/contrib/annot_pro/examples/textbox.tex
@@ -0,0 +1,62 @@
+\documentclass[12pt]{article}
+\usepackage[web={tight*,designiii}]{aeb_pro}
+\usepackage[useTextBox]{annot-pro}
+
+\title{The \textsf{annot\_pro} Package\texorpdfstring{\\[2ex]}{: }The text box annotation}
+\author{D. P. Story}
+\university{Acro\negthinspace\TeX.Net}
+\email{dpstory@acrotex.net}
+\subject{Acrobat Text Box annotation}
+\keywords{AcroTeX, AeB Pro, Acrobat annotations}
+
+\DeclareInitView
+{%
+ layoutmag={mag=100},
+ windowoptions={fit}
+}
+
+
+\newcommand{\cs}[1]{\texttt{\char`\\#1}}
+
+\parskip6pt
+\parindent0pt
+
+\reversemarginpar
+
+\convertcolorspec{named}{webbrown}{HTML}{\htmlWebBrown}
+\setAnnotOptions{subject={AcroTeX Communiqu\'e},title={D. P. Story}}
+
+\begin{textboxpara}
+\rtpara[color=\htmlWebBrown]{para1}{\spc\spc\spc\spc Now is the time for
+ \span{style={strikeit,bold},color=ff0000}{\it{\bf{J\374rgen}}} and all
+ good men to come to the aid of \it{their} \bf{country}. Now is also the
+ \sup{time} for \span{style=italic}{all good} women to do the same.\br\spc\spc\spc\spc
+ This is a second paragraph. I hope we can all go to the AcroTeX.Net website at
+ \span{ulstyle=ul,color=0000FF}{http://www.acrotex.net}.\br\br
+ \span{size=14.5,color=000000}{\uHex{4EE4}}}
+\end{textboxpara}
+\setRVVContent{demo-para}{para1}
+
+\begin{document}
+
+\maketitle
+
+The \textsf{Text Box} annotation is a rectangular region into which the user
+can type rich text content. It can be moved around easily. The \textsf{Text
+Box} can also be pre-populated with rich text using the {\LaTeX} markup
+described in the documentation of the \textsf{annot\_pro} package. The
+\textsf{Text Box} below has a transparent background (move it on top of this
+paragraph), a cloud border, and rich text including a unicode character not
+normally available to {\LaTeX} users. The annotation version does not support
+multiple paragraphs, so I `artificially' created several `paragraphs' using
+\cs{br} and indented the `paragraphs' using the \cs{spc} command; this
+paragraph simulation is, of course, optional.
+\begin{center}
+\annotpro[title=dpstory,
+ type=textbox,borderstyle=cloud1,borderwidth=1,
+ width=3in,height=16bp*9,
+ subject=Testing the Text Box (FreeText),
+ bgcolor,bcolor=red]{richtext=demo-para}
+\end{center}
+
+\end{document}