summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-05-23 22:06:07 +0000
committerKarl Berry <karl@freefriends.org>2011-05-23 22:06:07 +0000
commit0a05c759165972d30c5dd9c0ca35718b191361a9 (patch)
tree61831a17d9b73e638c94b884b2f9cc4abf1414ed /Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
parentba328cf8b03f2dd645a56a95d904f42a9f10628e (diff)
pdfcomment (23may11)
git-svn-id: svn://tug.org/texlive/trunk@22590 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex')
-rw-r--r--Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex228
1 files changed, 158 insertions, 70 deletions
diff --git a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
index 93d5055ca78..6bcda5aca8a 100644
--- a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
+++ b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
@@ -12,6 +12,7 @@
\usepackage[svgnames,rgb]{xcolor}%
\usepackage{amsmath,array}%
\usepackage{tikz}%
+\usetikzlibrary{calc}%
\usepackage{ragged2e}%
\usepackage{url}%
\usepackage[automark,nouppercase]{scrpage2}
@@ -137,7 +138,7 @@
\title{\filename}%
\Subtitle{A user-friendly interface to PDF annotations}%
\author{Josef Kleber}
-\Fileversion{v2.1}
+\Fileversion{v2.2}
\Refline{\href{mailto:kleberj@users.berlios.de}{\texttt{kleberj@users.berlios.de}}\\\href{http://pdfcomment.berlios.de}{\texttt{http://pdfcomment.berlios.de}}}
\maketitle
\Headline{Abstract}
@@ -188,9 +189,7 @@ I want to thank the following persons for contributions to the development of th
\item \textbf{Herbert Voß} also for answering my stupid questions on d.c.t.t.
\end{itemize}
-I also want to thank the following persons for bug reports, feature requests, ...:
-
-Jannis von Buttlar, Gabriel Cardona, Jin-Hwan Cho, Thomas König, Marc-André Michel, Guillaume Millet, Fritz Moore, Michael Niedermair, Stefan Pinnow
+I also want to thank the following persons for bug reports, feature requests, ...: Jannis von Buttlar, Gabriel Cardona, Jin-Hwan Cho, Marcel Dausend, Max Funk, Zvi Gilboa, Thomas König, Marc-André Michel, Guillaume Millet, Fritz Moore, Michael Niedermair, Stefan Pinnow
\clearpage
\section{Options}
\subsection{Global options}
@@ -203,7 +202,7 @@ If you want to use the driver \texttt{dvipdfmx} for creating your documents, you
\subsubsection[\texttt{version}]{\styleoption{version}}\label{sec:version}
Version v2.0 of \texttt{pdfcomment.sty} introduced a bugfix that removes unwanted whitespace before the comment commands. This may also change the reference point for options like \styleoption{hoffset}. If you want to preserve the old behavior for older documents simply use \texttt{version=1}. Otherwise \texttt{version=2} is used by default!
\subsection{Local options}
-The following options are useable as options for the commands presented in sections \ref{sec:kommentarumgebungen} and \ref{sec:kommentarbefehle}, as well as style options. As style options they have global effect, whereas they have only local effect when used in commands. Furthermore global options are not overwritten.
+The following options are useable as options for the commands presented in sections \ref{sec:umgebungen} and \ref{sec:befehle}, as well as style options. As style options they have global effect, whereas they have only local effect when used in commands. Furthermore global options are not overwritten.
\subsubsection[\texttt{id}]{\styleoption{id}}\label{sec:id}
You can use the option \styleoption{id} to define a unique ID for referencing in a PDF reply (see \ref{sec:pdfreply}).
@@ -214,23 +213,23 @@ You can use the option \styleoption{subject} for defining the subject of the PDF
\subsubsection[\texttt{author}]{\styleoption{author}}\label{sec:author}
You can use the option \styleoption{author} for defining the author of the PDF popup annotations.
-\subsubsection[\texttt{opacity}]{\styleoption{opacity}}\label{sec:opacity}
-You can use the option \styleoption{opacity} for defining the opacity of PDF annotations with values between 0 (transparent) and 1 (not transparent, default). If you want to print PDF popup annotations with transparency you will have to use the option \styleoption{open} = \texttt{true}.
+\subsubsection[\texttt{opacity}]{\styleoption{opacity} (\underline{\texttt{1.0}})}\label{sec:opacity}
+You can use the option \styleoption{opacity} for defining the opacity of PDF annotations with values between 0 (transparent) and 1 (not transparent). If you want to print PDF popup annotations with transparency you will have to use the option \styleoption{open}\texttt{=true}.
-\subsubsection[\texttt{icon}]{\styleoption{icon}}\label{sec:icon}
+\subsubsection[\texttt{icon}]{\styleoption{icon} (\underline{\texttt{Comment}})}\label{sec:icon}
You can use the option \styleoption{icon} for defining the graphic used for the PDF text annotations. The following icons are defined as mandatory by the PDF reference:
\pdfcommentsetup{author={Josef Kleber},subject={Icon Übersicht},width=17mm}
{\renewcommand{\arraystretch}{2.5}
\begin{center}
\begin{tabular}{rlrlrl}
-\texttt{Comment} & \pdfcomment[icon=Comment,color=Ivory,hspace=1.5cm]{Optionen: icon=Comment,color=Ivory} &
-\texttt{Key} & \pdfcomment[icon=Key,color=Khaki,hspace=1.5cm]{Optionen: icon=Key,color=Khaki} &
-\texttt{Note} & \pdfcomment[icon=Note,color=LavenderBlush,hspace=1.5cm]{Optionen: icon=Note,color=LavenderBlush}\\
-\texttt{Help} & \pdfcomment[icon=Help,color=CornflowerBlue,hspace=1.5cm]{Optionen: icon=Help,color=CornflowerBlue} &
-\texttt{NewParagraph} & \pdfcomment[icon=NewParagraph,color=SkyBlue,hspace=1.5cm]{Optionen: icon=NewParagraph,color=SkyBlue}\\
-\texttt{Paragraph} & \pdfcomment[icon=Paragraph,color=SpringGreen,hspace=1.5cm]{Optionen: icon=Paragraph,color=SpringGreen} &
-\texttt{Insert} & \pdfcomment[icon=Insert,color=PaleTurquoise,hspace=1.5cm]{Optionen: Insert,color=PaleTurquoise} &
+\texttt{Comment} & \pdfcomment[icon=Comment,color=Ivory,hspace=1.5cm]{options: icon=Comment,color=Ivory} &
+\texttt{Key} & \pdfcomment[icon=Key,color=Khaki,hspace=1.5cm]{options: icon=Key,color=Khaki} &
+\texttt{Note} & \pdfcomment[icon=Note,color=LavenderBlush,hspace=1.5cm]{options: icon=Note,color=LavenderBlush}\\
+\texttt{Help} & \pdfcomment[icon=Help,color=CornflowerBlue,hspace=1.5cm]{options: icon=Help,color=CornflowerBlue} &
+\texttt{NewParagraph} & \pdfcomment[icon=NewParagraph,color=SkyBlue,hspace=1.5cm]{options: icon=NewParagraph,color=SkyBlue}\\
+\texttt{Paragraph} & \pdfcomment[icon=Paragraph,color=SpringGreen,hspace=1.5cm]{options: icon=Paragraph,color=SpringGreen} &
+\texttt{Insert} & \pdfcomment[icon=Insert,color=PaleTurquoise,hspace=1.5cm]{options: Insert,color=PaleTurquoise} &
& \\
\end{tabular}
\end{center}
@@ -242,15 +241,15 @@ Furthermore the following icons are also supported by \texttt{Adobe Reader} and
{\renewcommand{\arraystretch}{2.5}
\begin{center}
\begin{tabular}{rlrlrl}
-\texttt{Check} & \pdfcomment[icon=Check,color=Orchid,hspace=1cm]{Optionen: icon=Check,color=Orchid} &
-\texttt{Circle} & \pdfcomment[icon=Circle,color=LightCyan,hspace=1cm]{Optionen: icon=Circle,color=LightCyan} &
-\texttt{Cross} & \pdfcomment[icon=Cross,color=Bisque,hspace=1cm]{Optionen: icon=Cross,color=Bisque}\\
-\texttt{Star} & \pdfcomment[icon=Star,color=Aquamarine,hspace=1cm]{Optionen: icon=Star,color=Aquamarine} &
-\texttt{RightArrow} & \pdfcomment[icon=RightArrow,color=Gainsboro,hspace=1cm]{Optionen: icon=RightArrow,color=Gainsboro} &
-\texttt{RightPointer} & \pdfcomment[icon=RightPointer,color=Salmon,hspace=1cm]{Optionen: icon=RightPointer,color=Salmon}\\
-\texttt{UpArrow} & \pdfcomment[icon=UpArrow,color=Teal,hspace=1cm]{Optionen: icon=UpArrow,color=Teal} &
-\texttt{UpLeftArrow} & \pdfcomment[icon=UpLeftArrow,color=Magenta,hspace=1cm]{Optionen: icon=UpLeftArrow,color=Magenta} &
-\texttt{CrossHairs (AR X)} & \pdfcomment[icon=CrossHairs,color=green,hspace=1cm]{Optionen: icon=CrossHairs,color=green}
+\texttt{Check} & \pdfcomment[icon=Check,color=Orchid,hspace=1cm]{options: icon=Check,color=Orchid} &
+\texttt{Circle} & \pdfcomment[icon=Circle,color=LightCyan,hspace=1cm]{options: icon=Circle,color=LightCyan} &
+\texttt{Cross} & \pdfcomment[icon=Cross,color=Bisque,hspace=1cm]{options: icon=Cross,color=Bisque}\\
+\texttt{Star} & \pdfcomment[icon=Star,color=Aquamarine,hspace=1cm]{options: icon=Star,color=Aquamarine} &
+\texttt{RightArrow} & \pdfcomment[icon=RightArrow,color=Gainsboro,hspace=1cm]{options: icon=RightArrow,color=Gainsboro} &
+\texttt{RightPointer} & \pdfcomment[icon=RightPointer,color=Salmon,hspace=1cm]{options: icon=RightPointer,color=Salmon}\\
+\texttt{UpArrow} & \pdfcomment[icon=UpArrow,color=Teal,hspace=1cm]{options: icon=UpArrow,color=Teal} &
+\texttt{UpLeftArrow} & \pdfcomment[icon=UpLeftArrow,color=Magenta,hspace=1cm]{options: icon=UpLeftArrow,color=Magenta} &
+\texttt{CrossHairs (AR X)} & \pdfcomment[icon=CrossHairs,color=green,hspace=1cm]{options: icon=CrossHairs,color=green}
\end{tabular}
\end{center}
}
@@ -259,7 +258,7 @@ Furthermore the following icons are also supported by \texttt{Adobe Reader} and
\subsubsection[\texttt{deadline}]{\styleoption{deadline}}\label{sec:deadline}
You can use the option \styleoption{deadline} for defining a time limit until a problem has to be solved. The deadline will be added at the end of the comment, as well as in the list of comments, if an appropriate list style is chosen.
-\subsubsection[\texttt{color}]{\styleoption{color}}\label{sec:color}
+\subsubsection[\texttt{color}]{\styleoption{color} (\underline{\texttt{\lbrack 0 0 1\rbrack}} (blue))}\label{sec:color}
You can use the option \styleoption{color} for defining the color of PDF annotations in the form \{0.34 0.56 0.12\} (RGB). If you are using the additional package \package{xcolor} you can use predefined color names, as well as the available optional color names. Furthermore you can use the command \cmd\definecolor{} to define your own named colors. Please take a look at the attached example \file{example.tex}.\marginnote{\attachfile[author={Josef Kleber},subject={example.tex},description={source code: example.tex} ,mimetype={text/plain}, icon={Tag}]{example.tex}} It shows the different possibilities of defining colors.
By definition the PDF specification allows four different color spaces with different numbers of color values:
@@ -278,12 +277,12 @@ By definition the PDF specification allows four different color spaces with diff
\subsubsection[\texttt{icolor}]{\styleoption{icolor}}\label{sec:icolor}
You can use the option \styleoption{icolor} for defining the so called 'inner color', which is used by some PDF annotations, like arrowheads or the inner area of PDF circle annotation. For the rest, the provisions of the option \styleoption{color} shall apply.
-\subsubsection[\texttt{open}]{\styleoption{open}}\label{sec:open}
-You can use the option \styleoption{open} for defining the opening status of the PDF popup annotations. Possible values are \texttt{true} or \texttt{false} (default).
+\subsubsection[\texttt{open}]{\styleoption{open} (\texttt{true},\underline{\texttt{false}})}\label{sec:open}
+You can use the option \styleoption{open} for defining the opening status of the PDF popup annotations.
-If you want to print the PDF popup annotations (with transparency) you will have to use the option \styleoption{open} = \texttt{true}.
+If you want to print the PDF popup annotations (with transparency) you will have to use the option \styleoption{open}\texttt{=true}.
-\subsubsection[\texttt{hspace}]{\styleoption{hspace}}\label{sec:hspace}
+\subsubsection[\texttt{hspace}]{\styleoption{hspace} (\underline{\texttt{0pt}})}\label{sec:hspace}
You can use the option \styleoption{hspace} for defining the horizontal space after the PDF text annotations, otherwise the PDF text annoations will overlay the text.
\subsubsection[\texttt{type}]{\styleoption{type}}\label{sec:type}
@@ -294,19 +293,19 @@ You can use the option \styleoption{type} for defining the type of PDF annotatio
\begin{tabular}{ll}
\multicolumn{1}{c}{comment command} & \multicolumn{1}{c}{possible types}\\
\hline
-\cs{pdffreetextcomment} & freetext, callout, typewriter \\
-\cs{pdflinecomment} & line, polyline, polygon \\
+\cs{pdffreetextcomment} & \underline{freetext}, callout, typewriter \\
+\cs{pdflinecomment} & \underline{line}, polyline, polygon \\
\end{tabular}
\end{center}}
-\subsubsection[\texttt{font}]{\styleoption{font}}\label{sec:font}
+\subsubsection[\texttt{font}]{\styleoption{font} (\underline{\texttt{Helv}})}\label{sec:font}
You can use the option \styleoption{font} for defining the font of PDF freetext annotations, like all fonts installed in the system, which don't contain a space in their name. Although \texttt{Adobe Reader} shows these fonts as embedded, they are not embedded in reality, but the PDF file just contains a reference\footnote{Adobe Acrobat offers the possibility to embed the fonts in the PS $\rightarrow$ PDF conversion} to the font (default: Helvetica)! Therefore you should use this option quite carefully. In the case of document exchange between several authors you should just use fonts, which are available on all computer systems, like the so called 'standard 14 fonts'. \pdfcomment[icon=Help,color=blue,open=true,subject={standard 14 fonts}]{Times-Roman (TiRo), Times-Bold (TiBo), Times-Italic (TiIt), Times-BoldItalic (TiBI), Helvetica (Helv), Helvetica-Bold (HeBo), Helvetica-Oblique (HeOb), Helvetica-BoldOblique (HeBO), Courier (Cour), Courier-Bold (CoBo), Courier-Oblique (CoOb), Courier-BoldOblique (CoBO), ZapfDingbats (ZaDb), Symbol (Symb)}
-\subsubsection[\texttt{fontsize}]{\styleoption{fontsize}}\label{sec:fontsize}
+\subsubsection[\texttt{fontsize}]{\styleoption{fontsize} (\underline{\texttt{12bp}})}\label{sec:fontsize}
You can use the option \styleoption{fontsize} for defining the fontsize of PDF freetext annotations.
-\subsubsection[\texttt{fontcolor}]{\styleoption{fontcolor}}\label{sec:fontcolor}
+\subsubsection[\texttt{fontcolor}]{\styleoption{fontcolor} (\underline{\texttt{\lbrack 0 0 0\rbrack}} (black))}\label{sec:fontcolor}
You can use the option \styleoption{fontcolor} for defining the font color in PDF freetext annotations, which must be a RGB color.
\subsubsection[\texttt{line}]{\styleoption{line}}\label{sec:line}
@@ -325,60 +324,60 @@ callout line & $n = 3$ \\
In general, the points must be given from line begin to line end. For callout lines the points must be given from line end to line begin. Please note the example file \LinkEx!
-To avoid the method 'trail and error' you can load the PDF file with the Ghostscript viewer, which is capable of showing the cursor position in it's status line.
+To avoid the method 'trail and error' you can load the PDF file with the Ghostscript viewer, which is capable of showing the cursor position in its status line.
-\subsubsection[\texttt{linewidth}]{\styleoption{linewidth}}\label{sec:linewidth}
+\subsubsection[\texttt{linewidth}]{\styleoption{linewidth} (\underline{\texttt{1bp}})}\label{sec:linewidth}
You can use the option \styleoption{linewidth} for defining the line width of PDF annoations.
-\subsubsection[\texttt{linebegin}]{\styleoption{linebegin}}\label{sec:linebegin}
+\subsubsection[\texttt{linebegin}]{\styleoption{linebegin} (\underline{\texttt{/None})}}\label{sec:linebegin}
You can use the option \styleoption{linebegin} for defining the arrow type at the line begin. The example file \LinkEx{} shows all possible types of arrows. \pdfcomment[icon=Help,color=blue,open=true,subject={arrow types}]{/None, /Square, /Circle, /Diamond, /OpenArrow, /ClosedArrow, /Butt (PDF1.5), /ROpenArrow (PDF1.5), /RClosedArrow (PDF1.5), /Slash (PDF1.6)}
-\subsubsection[\texttt{lineend}]{\styleoption{lineend}}\label{sec:lineend}
+\subsubsection[\texttt{lineend}]{\styleoption{lineend} (\underline{\texttt{/OpenArrow}})}\label{sec:lineend}
You can use the option \styleoption{lineend} for defining the arrow type at the line end.
-\subsubsection[\texttt{linesep}]{\styleoption{linesep}}\label{sec:linesep}
+\subsubsection[\texttt{linesep}]{\styleoption{linesep} (\underline{\texttt{0.5cm}})}\label{sec:linesep}
You can use the option \styleoption{linesep} for defining the horizontal space between text and line in the command \cs{pdfsidelinecomment}.
-\subsubsection[\texttt{borderstyle}]{\styleoption{borderstyle}}\label{sec:borderstyle}
-You can use the option \styleoption{borderstyle} for defining the line style.Possible values are: \styleoption{solid} (default) and \styleoption{dashed}
+\subsubsection[\texttt{borderstyle}]{\styleoption{borderstyle} (\underline{\texttt{solid}},\texttt{dashed})}\label{sec:borderstyle}
+You can use the option \styleoption{borderstyle} for defining the line style.
-\subsubsection[\texttt{dashstyle}]{\styleoption{dashstyle}}\label{sec:dashstyle}
+\subsubsection[\texttt{dashstyle}]{\styleoption{dashstyle} (\underline{\texttt{\{3 3\}}})}\label{sec:dashstyle}
You can use the option \styleoption{dashstyle} for defining the dash style, e.\,g. \{5 3\} (5 points line, 3 points space).
-\subsubsection[\texttt{bse}]{\styleoption{bse}}\label{sec:bse}
-You can use the option \styleoption{bse} for defining the 'border style effect'. Possible values are: \styleoption{none} (default) and \styleoption{cloudy}
+\subsubsection[\texttt{bse}]{\styleoption{bse} (\underline{\texttt{none}},\texttt{cloudy})}\label{sec:bse}
+You can use the option \styleoption{bse} for defining the 'border style effect'.
-\subsubsection[\texttt{bsei}]{\styleoption{bsei}}\label{sec:bsei}
+\subsubsection[\texttt{bsei}]{\styleoption{bsei} (\underline{\texttt{1}})}\label{sec:bsei}
You can use the option \styleoption{bsei} for defining the 'border style effect intensity' (size of cloud elements). The PDF reference suggests values between 1 and 2.
-\subsubsection[\texttt{caption}]{\styleoption{caption}}\label{sec:caption}
-You can use the option \styleoption{caption} for defining the caption type of lines. Possible values are: none, inline (default), top
+\subsubsection[\texttt{caption}]{\styleoption{caption} (\texttt{none},\underline{\texttt{inline}},\texttt{top})}\label{sec:caption}
+You can use the option \styleoption{caption} for defining the caption type of lines.
The options \styleoption{inline} and \styleoption{top} shows the comment 'inline' and on top of the line. While using \styleoption{none} the comment will be shown in a PDF popup annotation.
-\subsubsection[\texttt{captionhoffset}]{\styleoption{captionhoffset}}\label{sec:captionhoffset}
+\subsubsection[\texttt{captionhoffset}]{\styleoption{captionhoffset} (\underline{\texttt{0pt}})}\label{sec:captionhoffset}
You can use the option \styleoption{captionhoffset} for defining a horizontal offset, that is a horizontal shift of the line caption.
-\subsubsection[\texttt{captionvoffset}]{\styleoption{captionvoffset}}\label{sec:captionvoffset}
+\subsubsection[\texttt{captionvoffset}]{\styleoption{captionvoffset} (\underline{\texttt{0pt}})}\label{sec:captionvoffset}
You can use the option \styleoption{captionvoffset} for definig a vertical offset of the line caption.
-\subsubsection[\texttt{voffset}]{\styleoption{voffset}}\label{sec:voffset}
+\subsubsection[\texttt{voffset}]{\styleoption{voffset} (\underline{\texttt{0pt}})}\label{sec:voffset}
You can use the option \styleoption{voffset} for defining a vertical offset of the PDF annotations, that is a vertical shift for the given length.
-\subsubsection[\texttt{hoffset}]{\styleoption{hoffset}}\label{sec:hoffset}
+\subsubsection[\texttt{hoffset}]{\styleoption{hoffset} (\underline{\texttt{0pt}})}\label{sec:hoffset}
You can use the option \styleoption{hoffset} for defining a horizontal offset of the PDF annotations.
-\subsubsection[\texttt{width}]{\styleoption{width}}\label{sec:width}
+\subsubsection[\texttt{width}]{\styleoption{width} (\underline{\texttt{0pt}})}\label{sec:width}
You can use the option \styleoption{width} for defining the width of PDF annotations, e.\,g. the width of FreeText annotations. PDF text annatations have a width of 0pt by definition.
-\subsubsection[\texttt{height}]{\styleoption{height}}\label{sec:height}
+\subsubsection[\texttt{height}]{\styleoption{height} (\underline{\texttt{0pt}})}\label{sec:height}
You can use the option \styleoption{height} for definig the height of PDF annotations. PDF text annatations have a height of \cmd\baselineskip{} by definition.
-\subsubsection[\texttt{markup}]{\styleoption{markup}}\label{sec:markup}
-You can use the option \styleoption{markup} for defining the type of the PDF text markup annotation. Possible values are: Highlight, Underline, Squiggly und StrikeOut.
+\subsubsection[\texttt{markup}]{\styleoption{markup} (\underline{\texttt{Highlight}},\texttt{Underline},\texttt{Squiggly},\texttt{StrikeOut})}\label{sec:markup}
+You can use the option \styleoption{markup} for defining the type of the PDF text markup annotation.
-\subsubsection[\texttt{disable}]{\styleoption{disable}}\label{sec:disable}
+\subsubsection[\texttt{disable}]{\styleoption{disable} (\underline{\texttt{true}},\texttt{false})}\label{sec:disable}
You can use the option \styleoption{disable} for switching off single PDF annotation. For switching off all PDF annotations use the global option \styleoption{final}.
\subsubsection[\texttt{date}]{\styleoption{date}}\label{sec:date}
@@ -391,7 +390,7 @@ D:20101224153657+01'00'
\end{tabular}
\end{center}
-\subsubsection[\texttt{timezone}]{\styleoption{timezone}}\label{sec:timezone}
+\subsubsection[\texttt{timezone}]{\styleoption{timezone} (\underline{\texttt{+00'00'}})}\label{sec:timezone}
You only have to use the option \styleoption{timezone}, if you are using automatic date setting and \XeLaTeX\ or \texttt{pdflatex} < v1.30.0. Otherwise the \texttt{pdflatex} command \string\pdfcreationdate\ will be used. \styleoption{timezone}=+01'00' sets the timezone to middle european time (default: +00'00' (GMT)).
\subsubsection[\texttt{avatar}]{\styleoption{avatar}}\label{sec:avatar}
@@ -400,8 +399,11 @@ With the option \styleoption{avatar} you can load the option lists, that were pr
\subsubsection[\texttt{style}]{\styleoption{style}}\label{sec:style}
With the option \styleoption{style} you can also load predefined option lists for spliting personal and stylistic options, e.\,g. \texttt{avatar=Josef, style=MyComment}.
-\subsubsection[\texttt{mathstyle}]{\styleoption{mathstyle}}\label{sec:mathstyle}
-With the option \styleoption{mathstyle} you can correct the wrong size of PDF annotations produced with \texttt{\string\pdfmarkupcomment} in math mode by setting the math style to \texttt{\string\textstyle}, \texttt{\string\displaystyle}, \texttt{\string\scriptstyle} or \texttt{\string\scriptscriptstyle}. This option is only defined for \texttt{\string\pdfmarkupcomment}, so you can not set it globally!
+\subsubsection[\texttt{mathstyle}]{\styleoption{mathstyle} (\underline{\texttt{\string\textstyle}})}\label{sec:mathstyle}
+With the option \styleoption{mathstyle} you can correct the wrong size of PDF annotations produced with \texttt{\string\pdfmarkupcomment} or \texttt{\string\pdftooltip} in math mode by setting the math style to \texttt{\string\textstyle}, \texttt{\string\displaystyle}, \texttt{\string\scriptstyle} or \texttt{\string\scriptscriptstyle}. This option is only defined for \texttt{\string\pdfmarkupcomment} and \texttt{\string\pdftooltip}, so you can not set it globally!
+
+\subsubsection[\texttt{printSOfinal}]{\styleoption{printSOfinal} (\underline{\texttt{true}},\texttt{false})}\label{sec:printSOfinal}
+With the option \styleoption{printSOfinal} you can automatically delete PDF StrikeOut markup annotations including the text while using one of the options \styleoption{final} or \styleoption{disable}.
\section{Environments}\label{sec:umgebungen}
@@ -409,7 +411,7 @@ With the option \styleoption{mathstyle} you can correct the wrong size of PDF an
\subsubsection{\texorpdfstring{\cs{pdfsidelinecomment}}{\textbackslash pdfsidelinecomment}}
\label{sec:sidelinecomment}
-Possible \marginnote{\raggedleft\scriptsize\envb{pdfsidelinecomment}\\\oarg{options}\marg{comment}\\\dots\\\enve{pdfsidelinecomment}}options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{color}, \styleoption{icolor}, \styleoption{opacity}, \styleoption{linewidth}, \styleoption{linebegin}, \styleoption{lineend}, \styleoption{linesep}, \styleoption{borderstyle}, \styleoption{dashstyle}, \styleoption{caption}, \styleoption{captionhoffset}, \styleoption{captionvoffset}
+Possible \marginnote{\raggedleft\scriptsize\envb{pdfsidelinecomment}\\\oarg{options}\marg{comment}\\\dots\\\enve{pdfsidelinecomment}}options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{color}, \styleoption{icolor}, \styleoption{opacity}, \styleoption{linewidth}, \styleoption{linebegin}, \styleoption{lineend}, \styleoption{linesep}, \styleoption{borderstyle}, \styleoption{dashstyle}, \styleoption{caption}, \styleoption{captionhoffset}, \styleoption{captionvoffset}, \styleoption{disable}, \styleoption{date}, \styleoption{timezone}
\bigskip
With the environment \env{pdfsidelinecomment} you can comment complete parts of a page in the form of two lines in the margins.
@@ -433,21 +435,33 @@ You can use the following commands for commenting your documents.
\subsubsection{\texorpdfstring{\cs{pdfcomment}}{\textbackslash pdfcomment}}
\label{sec:pdfcomment}
-Possible \margcs{\cmd\pdfcomment\\\oarg{options}\marg{comment}}options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{icon}, \styleoption{color}, \styleoption{opacity}, \styleoption{open}, \styleoption{hspace}, \styleoption{voffset}, \styleoption{hoffset}
+Possible \margcs{\cmd\pdfcomment\\\oarg{options}\marg{comment}}options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{icon}, \styleoption{color}, \styleoption{opacity}, \styleoption{open}, \styleoption{hspace}, \styleoption{voffset}, \styleoption{hoffset}, \styleoption{disable}, \styleoption{date}, \styleoption{timezone}
\bigskip
\cmd\pdfcomment{} will typeset an annotation into the text at the current \pdfcommentsetup{subject={\textbackslash pdfcomment test},hspace=18pt}\pdfcomment[icon=Star,color=YellowGreen]{This is a comment in the text} position.
+Internally, the argument \marg{comment} needs to be converted to PDFDocEncoding/PDFUnicode\footnote{\cmd\hypersetup\{unicode\}}. Some chars with special meaning in \LaTeX{} (\texttt{\&}, \texttt{\%,} ...) must be escaped or replaced with their command form, e.\,g. \texttt{\string\_} or \texttt{\string\textunderscore} \cite[6.2 Definition of \texttt{\string\pdfstringdef}]{bib:hyperref}. Furthermore there are some commands for formatting:
+
+\begin{center}
+\begin{tabular}{cl}
+\hline
+\cmd\textHT & horizontal tab \\
+\cmd\textLF & line feed \\
+\cmd\textCR & carriage return \\
+\hline
+\end{tabular}
+\end{center}
+
\subsubsection{\texorpdfstring{\cs{pdfmargincomment}}{\textbackslash pdfmargincomment}}
\label{sec:pdfmargincomment}
-Possible \margcs{\cmd\pdfmargincomment\\\oarg{options}\marg{comment}}options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{icon}, \styleoption{color}, \styleoption{opacity}, \styleoption{open}, \styleoption{hspace}, \styleoption{voffset}, \styleoption{hoffset}
+Possible \margcs{\cmd\pdfmargincomment\\\oarg{options}\marg{comment}}options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{icon}, \styleoption{color}, \styleoption{opacity}, \styleoption{open}, \styleoption{hspace}, \styleoption{voffset}, \styleoption{hoffset}, \styleoption{disable}, \styleoption{date}, \styleoption{timezone}
\bigskip
\cmd\pdfmargincomment{} will typeset an annotation into the margin. Please note the positioning of the annotation in this example. This documentation was written with the \LaTeX{} class \texttt{ltxdoc}\pdfcommentsetup{subject={\textbackslash pdfmargincomment test}}\pdfmargincomment[icon=Help,color=DeepPink,hspace=-30pt]{This is a comment in the margin}. Therefore the annotation is typeset into the left margin.
\subsubsection{\texorpdfstring{\cs{pdfmarkupcomment}}{\textbackslash pdfmarkupcomment}}
\label{sec:pdfmarkupcomment}
-Possible \margcs{\cmd\pdfmarkupcomment\oarg{options}\\\marg{markup text}\marg{comment}}options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{color}, \styleoption{opacity}, \styleoption{markup}, \styleoption{mathstyle}
+Possible \margcs{\cmd\pdfmarkupcomment\oarg{options}\\\marg{markup text}\marg{comment}}options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{color}, \styleoption{opacity}, \styleoption{markup}, \styleoption{mathstyle}, \styleoption{disable}, \styleoption{date}, \styleoption{timezone}
\bigskip
\cmd\pdfmarkupcomment{} will typeset so called PDF text markup annotations over the text specified in the argument \marg{markup text}. Possible types for the option \styleoption{markup} are: \pdfcommentsetup{subject={\textbackslash pdfmarkupcomment test}}\pdfmarkupcomment[color=yellow,markup=Highlight]{Highlight}{This is a Highlight markup annotation!}, \pdfmarkupcomment[color=red,markup=Underline]{Underline}{This is a Underline markup annotation!}, \pdfmarkupcomment[color=Teal,markup=Squiggly]{Squiggly}{This is a Squiggly markup annotation!} and \pdfmarkupcomment[color=red,markup=StrikeOut]{StrikeOut}{This is a StrikeOut markup annotation!}
@@ -487,14 +501,14 @@ Also see \LinkExMath{} for a more detailed explanation of the possibilities!
\subsubsection{\texorpdfstring{\cs{pdffreetextcomment}}{\textbackslash pdffreetextcomment}}
\label{sec:pdffreetextcomment}
-Possible \margcs{\cmd\pdffreetextcomment\\\oarg{options}\marg{comment}} options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{color}, \styleoption{font}, \styleoption{fontsize}, \styleoption{fontcolor}, \styleoption{opacity}, \styleoption{line}, \styleoption{linewidth}, \styleoption{lineend}, \styleoption{borderstyle}, \styleoption{dashstyle}, \styleoption{bse}, \styleoption{bsei}, \styleoption{type}, \styleoption{height}, \styleoption{width}, \styleoption{voffset}, \styleoption{hoffset}
+Possible \margcs{\cmd\pdffreetextcomment\\\oarg{options}\marg{comment}} options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{color}, \styleoption{font}, \styleoption{fontsize}, \styleoption{fontcolor}, \styleoption{opacity}, \styleoption{line}, \styleoption{linewidth}, \styleoption{lineend}, \styleoption{borderstyle}, \styleoption{dashstyle}, \styleoption{bse}, \styleoption{bsei}, \styleoption{type}, \styleoption{height}, \styleoption{width}, \styleoption{voffset}, \styleoption{hoffset}, \styleoption{disable}, \styleoption{date}, \styleoption{timezone}
\bigskip
-\cmd\pdffreetextcomment{} (type=freetext) will typeset a comment in form of a freely positioned box on the wished spot of the page.\pdffreetextcomment[subject={\textbackslash pdffreetextcomment Test},height=1.2cm,width=4cm,voffset=-4.7cm,hoffset=-1.2cm,opacity=0.5,color=yellow]{This is a FreeText annotation} By using the option \styleoption{type} = \texttt{callout} the box will have an additional so called callout line, to bind the box to a certain element of the page. With the option \styleoption{type} = \texttt{typewriter} you can write a comment everywhere on the page with a virtual 'typewriter'. These PDF freetext annotation do have no frame and a transparent background for 'overwriting' arbitrary parts of the page. Please note the example file \LinkEx!
+\cmd\pdffreetextcomment{} (\texttt{type=freetext}) will typeset a comment in form of a freely positioned box on the wished spot of the page.\pdffreetextcomment[subject={\textbackslash pdffreetextcomment Test},height=1.2cm,width=4cm,voffset=-3.7cm,hoffset=-2.2cm,opacity=0.5,color=yellow]{This is a FreeText annotation} By using the option \styleoption{type}\texttt{=callout} the box will have an additional so called callout line, to bind the box to a certain element of the page. With the option \styleoption{type}\texttt{=typewriter} you can write a comment everywhere on the page with a virtual 'typewriter'. These PDF freetext annotation do have no frame and a transparent background for 'overwriting' arbitrary parts of the page. Please note the example file \LinkEx!
\subsubsection{\texorpdfstring{\cs{pdfsquarecomment}}{\textbackslash pdfsquarecomment}}
\label{sec:pdfsquarecomment}
-Possible \margcs{\cmd\pdfsquarecomment\\\oarg{options}\marg{comment}} options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{color}, \styleoption{icolor}, \styleoption{opacity}, \styleoption{linewidth}, \styleoption{borderstyle}, \styleoption{dashstyle}, \styleoption{bse}, \styleoption{bsei}, \styleoption{height}, \styleoption{width}, \styleoption{voffset}, \styleoption{hoffset}
+Possible \margcs{\cmd\pdfsquarecomment\\\oarg{options}\marg{comment}} options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{color}, \styleoption{icolor}, \styleoption{opacity}, \styleoption{linewidth}, \styleoption{borderstyle}, \styleoption{dashstyle}, \styleoption{bse}, \styleoption{bsei}, \styleoption{height}, \styleoption{width}, \styleoption{voffset}, \styleoption{hoffset}, \styleoption{disable}, \styleoption{date}, \styleoption{timezone}
\bigskip
\cmd\pdfsquarecomment{} will typeset a rectangular box at the wished spot of a page (see: \LinkEx).
@@ -502,23 +516,24 @@ Possible \margcs{\cmd\pdfsquarecomment\\\oarg{options}\marg{comment}} options: \
\subsubsection{\texorpdfstring{\cs{pdfcirclecomment}}{\textbackslash pdfcirclecomment}}
\label{sec:pdfcirclecomment}
-Possible \margcs{\cmd\pdfcirclecomment\\\oarg{options}\marg{comment}} options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{color}, \styleoption{icolor}, \styleoption{opacity}, \styleoption{linewidth}, \styleoption{borderstyle}, \styleoption{dashstyle}, \styleoption{bse}, \styleoption{bsei}, \styleoption{height}, \styleoption{width}, \styleoption{voffset}, \styleoption{hoffset}
+Possible \margcs{\cmd\pdfcirclecomment\\\oarg{options}\marg{comment}} options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{color}, \styleoption{icolor}, \styleoption{opacity}, \styleoption{linewidth}, \styleoption{borderstyle}, \styleoption{dashstyle}, \styleoption{bse}, \styleoption{bsei}, \styleoption{height}, \styleoption{width}, \styleoption{voffset}, \styleoption{hoffset}, \styleoption{disable}, \styleoption{date}, \styleoption{timezone}
\bigskip
\cmd\pdfsquarecomment{} will typeset a comment in form of a circle or ellipse at the wished spot of the page (see: \LinkEx).
\subsubsection{\texorpdfstring{\cs{pdflinecomment}}{\textbackslash pdflinecomment}}
\label{sec:pdflinecomment}
-Possible \margcs{\cmd\pdfsidelinecomment\\\oarg{options}\marg{comment}}options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{type}, \styleoption{color}, \styleoption{icolor}, \styleoption{opacity}, \styleoption{caption}, \styleoption{captionhoffset}, \styleoption{captionvoffset}, \styleoption{linewidth}, \styleoption{linebegin}, \styleoption{lineend}, \styleoption{line}, \styleoption{borderstyle}, \styleoption{dashstyle}
+Possible \margcs{\cmd\pdfsidelinecomment\\\oarg{options}\marg{comment}}options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{type}, \styleoption{color}, \styleoption{icolor}, \styleoption{opacity}, \styleoption{caption}, \styleoption{captionhoffset}, \styleoption{captionvoffset}, \styleoption{linewidth}, \styleoption{linebegin}, \styleoption{lineend}, \styleoption{line}, \styleoption{borderstyle}, \styleoption{dashstyle}, \styleoption{disable}, \styleoption{date}, \styleoption{timezone}
\bigskip
\cmd\pdflinecomment{} will typeset a comment in form of a line, polyline or polygon at the wished spot of the page (see: \LinkEx).
-\subsection{Reply command}
+\clearpage
+\subsection{Replys}
\subsubsection{\texorpdfstring{\cs{pdfreply}}{\textbackslash pdfreply}}
\label{sec:pdfreply}
-Possible \margcs{\cmd\pdfreply\\\oarg{options}\marg{comment}}options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{id}, \styleoption{replyto}, \styleoption{color}
+Possible \margcs{\cmd\pdfreply\\\oarg{options}\marg{comment}}options: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{id}, \styleoption{replyto}, \styleoption{color}, \styleoption{disable}, \styleoption{date}, \styleoption{timezone}
\bigskip
\defineavatar{Joe}{author=Joe,color=yellow}
@@ -530,6 +545,79 @@ With the command \cmd\pdfreply{} you can compose replys to comments. The option
\pdfreply[id=4,avatar=Bob,replyto=1,date=D:20101213095512+01'00']{Just another reply}
Furthermore the command can not support page breaks (\string\pdfmarkupcomment, \string\pdfsidelinecomment). The replys will only appear in the PDF annotations on the second page. Replys to comments without page break work smoothly!
+\subsection{Tooltips}
+
+\subsubsection{\texorpdfstring{\cs{pdftooltip}}{\textbackslash pdftooltip}}
+\label{sec:pdftooltip}
+Possible \margcs{\cmd\pdftooltip\oarg{Optionen}\\\marg{Objekt}\marg{Kommentar}}options: \styleoption{disable}, \styleoption{mathstyle}
+
+\bigskip
+With the command \cmd\pdftooltip{} you can annotate any object with a tooltip - provided the the object can be set into a box to measure its size. Therefore you can smoothly use tooltips with \pdftooltip{\textcolor{red}{words}}{This is a tooltip!} or in a chemical notation: $\pdftooltip{H_{2}SO_{4}}{Sulfuric acid}$
+
+Of course, it also works in equations: \[\pdftooltip[mathstyle=\displaystyle]{\sum_{i=1}^{n}i=\frac{1}{2}n\cdot(n+1)}{little Gauß}\]
+
+Please notice the comments about usage in math mode in section \ref{sec:pdfmarkupcomment}.
+
+If you want to annotate parts of a graphic with tooltips, special methods are needed, because \cmd\pdftooltip{} can not measure the size (see: \LinkEx).
+
+\bigskip
+\begin{tikzpicture}
+ \draw [<->,thick] (0,2) node (yaxis) [above] {$y$}
+ |- (3,0) node (xaxis) [right] {$x$};
+ \draw (0,0) coordinate (a_1) -- (2,1.8) coordinate (a_2);
+ \draw (0,1.5) coordinate (b_1) -- (2.5,0) coordinate (b_2);
+ \coordinate (c) at (intersection of a_1--a_2 and b_1--b_2);
+ \draw[dashed] (yaxis |- c) node[left] {$y'$}
+ -| (xaxis -| c) node[below] {$x'$};
+ %
+ \fill[red] (0,0) circle (2pt);
+ \draw (0,0) node {\pdftooltip{\rule{0pt}{0.5cm}\rule{0.5cm}{0pt}}{Origin}};
+ %
+ \draw[red] (1.5,2) node {\pdftooltip{\textbullet}{1.5,2.0}};
+ %
+ \fill[red] (c) circle (2pt)
+ let
+ \p1 = (current path bounding box.south west),
+ \p2 = (current path bounding box.north east)
+ in
+ node at (current path bounding box)
+ {\pdftooltip{\rule{\dimexpr\x2-\x1\relax}{0pt}\rule{0pt}{\dimexpr\y2-\y1\relax}}%
+ {This is the intersection point\textCR of the two lines!}};
+\end{tikzpicture}
+\hspace{1cm}
+\begin{tikzpicture}
+ \draw (1.5,0) node[below] {countries};
+ \draw (0,1) node[left] {\pdftooltip{SCI}{Sausage Consumption Index}};
+ \fill[blue] (0.5,0) rectangle (1,1.2)
+ let
+ \p1 = (current path bounding box.south west),
+ \p2 = (current path bounding box.north east)
+ in
+ node at (current path bounding box)
+ % these calculations are based on scale factor 1 otherwise use:
+ % \dimexpr(scale factor)\dimexpr\x2-\x1\relax\relax
+ {\pdftooltip{\rule{\dimexpr\x2-\x1\relax}{0pt}\rule{0pt}{\dimexpr\y2-\y1\relax}}%
+ {USA: 120}};
+ \fill[red] (1.5,0) rectangle (2,1.8)
+ let
+ \p1 = (current path bounding box.south west),
+ \p2 = (current path bounding box.north east)
+ in
+ node at (current path bounding box)
+ {\pdftooltip{\rule{\dimexpr\x2-\x1\relax}{0pt}\rule{0pt}{\dimexpr\y2-\y1\relax}}%
+ {Germany: 180}};
+ \fill[green] (2.5,0) rectangle (3,0.65)
+ let
+ \p1 = (current path bounding box.south west),
+ \p2 = (current path bounding box.north east)
+ in
+ node at (current path bounding box)
+ {\pdftooltip{\rule{\dimexpr\x2-\x1\relax}{0pt}\rule{0pt}{\dimexpr\y2-\y1\relax}}%
+ {South Africa: 65}};
+ \draw [<->,thick] (0,2) node (yaxis) [above] {$y$}
+ |- (3.5,0) node (xaxis) [right] {$x$};
+\end{tikzpicture}
+
\subsection{Misc. commands}
\subsubsection{\texorpdfstring{\cs{pdfcommentsetup}}{\textbackslash pdfcommentsetup}}