summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex')
-rw-r--r--Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex48
1 files changed, 39 insertions, 9 deletions
diff --git a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
index e576ec17a65..53835e405ba 100644
--- a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
+++ b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
@@ -10,9 +10,12 @@
\usepackage{ltxdocext}%
\usepackage{marginnote}%
\usepackage[svgnames,rgb]{xcolor}%
+\usepackage{amsmath,array}%
\usepackage{jkdoc}%
\usepackage{pdfcomment}%
%
+\def\LinkExMath{\href{http://mirror.ctan.org/macros/latex/contrib/pdfcomment/doc/example_math_markup.pdf}{\texttt{example\_math\_markup.pdf}}}
+\def\LinkEx{\href{http://mirror.ctan.org/macros/latex/contrib/pdfcomment/doc/example.pdf}{\texttt{example.pdf}}}
\def\filename{pdfcomment.sty}%
\def\XeLaTeX{Xe\LaTeX}%
%
@@ -48,7 +51,7 @@
\title{\filename}%
\Subtitle{A user-friendly interface to PDF annotations}%
\author{Josef Kleber}
-\Fileversion{v1.5e}
+\Fileversion{v1.6}
\Refline{\href{mailto:pdfcomment.sty@pdfcomment.josef-kleber.de}{\texttt{pdfcomment.sty@pdfcomment.josef-kleber.de}}\\\href{http://pdfcomment.josef-kleber.de/en_index.htm}{\texttt{http://pdfcomment.josef-kleber.de/en\_index.htm}}}%
\maketitle
\Headline{Abstract}
@@ -92,6 +95,8 @@ I want to thank the following persons for contributions to the development of th
\item \textbf{Christian Feuersänger} for contributing new ideas in form of his package \package{pdfmarginpar.sty} and for solving the printing problem\footnote{see section \ref{sec:print}} of PDF annotations and popups.
+\item \textbf{Ross Moore} for contributing ideas and code for his own feature request to support \texttt{\string\pdfmarkupcomment} in math mode.
+
\item \textbf{Heiko Oberdiek} also for answering my stupid questions on d.c.t.t., as well as for the development of dozens of very usefull packages, especially \file{hyperref.sty}, \file{hycolor.sty} and \file{zref.sty}, which made this package possible.
\item \textbf{Herbert Voß} also for answering my stupid questions on d.c.t.t.
@@ -215,7 +220,7 @@ callout line & $n = 3$ \\
\end{tabular}
\end{center}}
-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 \texttt{example.tex}!
+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.
@@ -223,7 +228,7 @@ To avoid the method 'trail and error' you can load the PDF file with the Ghostsc
You can use the option \styleoption{linewidth} for defining the line width of PDF annoations.
\subsubsection[\texttt{linebegin}]{\styleoption{linebegin}}\label{sec:linebegin}
-You can use the option \styleoption{linebegin} for defining the arrow type at the line begin. The example file \texttt{example.pdf} 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)}
+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}
@@ -276,6 +281,9 @@ 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!
+
\section{Environments}\label{sec:umgebungen}
\subsection{Comment environments}\label{sec:kommentarumgebungen}
@@ -321,7 +329,7 @@ Possible \margcs{\cmd\pdfmargincomment\\\oarg{options}\marg{comment}}options: \s
\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}
+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}
\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!}
@@ -337,19 +345,41 @@ Limitations:
\item While using \XeLaTeX{} you have to make sure that page dimensions are written to the xdvi file, e.\,g. with the option \styleoption{pagesize} of the KoMa-Script classes, or as option of the package \package{typearea.sty} respectively.
\end{itemize}
+Since version v1.6, \texttt{\string\pdfmarkupcomment} is also supported in math mode. So you can also comment formula like:
+
+\definestyle{mathpopup}{author={},subject={},color=NavajoWhite,markup=Highlight}
+
+\[
+\begin{array}{c>{\displaystyle}c}
+ \text{ Bernoulli Trials: } &
+ \pdfmarkupcomment[style=mathpopup]{P(E)}{Probability of event E: Get exactly k heads in n coin flips.}%
+ =
+ \pdfmarkupcomment[style=mathpopup]{\dbinom{n}{k}}{Number of ways to get exactly k heads in n coin flips}%
+ {\pdfmarkupcomment[style=mathpopup]{p}{Probability of getting heads in one flip}%
+}^{%
+ \pdfmarkupcomment[style=mathpopup,mathstyle=\scriptstyle]{k}{Number of heads}
+ }%
+ \pdfmarkupcomment[style=mathpopup]{(1-p)}{Probability of getting tails in one flip}^{%
+ \pdfmarkupcomment[style=mathpopup,mathstyle=\scriptstyle]{n-k}{Number of tails}%
+ }%
+\end{array}
+\]
+
+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}
\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=-3.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 \texttt{example.pdf}!
+\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=-3.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!
\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}
\bigskip
-\cmd\pdfsquarecomment{} will typeset a rectangular box at the wished spot of a page (see: \texttt{example.pdf}).
+\cmd\pdfsquarecomment{} will typeset a rectangular box at the wished spot of a page (see: \LinkEx).
\subsubsection{\texorpdfstring{\cs{pdfcirclecomment}}{\textbackslash pdfcirclecomment}}
@@ -357,14 +387,14 @@ Possible \margcs{\cmd\pdfsquarecomment\\\oarg{options}\marg{comment}} options: \
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}
\bigskip
-\cmd\pdfsquarecomment{} will typeset a comment in form of a circle or ellipse at the wished spot of the page (see: \texttt{example.pdf}).
+\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}
\bigskip
-\cmd\pdflinecomment{} will typeset a comment in form of a line, polyline or polygon at the wished spot of the page (see: \texttt{example.pdf}).
+\cmd\pdflinecomment{} will typeset a comment in form of a line, polyline or polygon at the wished spot of the page (see: \LinkEx).
\subsection{Misc. commands}
@@ -414,7 +444,7 @@ With the command \cmd\defineavatar \margcs{\cmd\defineavatar\marg{name}\marg{opt
\subsubsection{\texorpdfstring{\cs{definestyle}}{\textbackslash definestyle}}
\label{sec:definestyle}
-With the command \cmd\definestyle \margcs{\cmd\definestyle\marg{name}\marg{options}} you can split up lists in personal and stylistic option lists (see \file{example.tex}). This option list can be loaded with the option \styleoption{style}.
+With the command \cmd\definestyle \margcs{\cmd\definestyle\marg{name}\marg{options}} you can split up lists in personal and stylistic option lists (see \LinkEx). This option list can be loaded with the option \styleoption{style}.
\section{Printing comments and popups}
\label{sec:print}