summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-06-18 15:51:58 +0000
committerKarl Berry <karl@freefriends.org>2016-06-18 15:51:58 +0000
commitf27f4428dacf3f21f978273d4e174f3e7d27e8ea (patch)
treea96509beb824a4ba8115fa2ef137633c792ccddd /Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
parentfca717399bb79f5db531685f7e16aa0e0f40a71f (diff)
pdfcomment (15jun16)
git-svn-id: svn://tug.org/texlive/trunk@41484 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.tex25
1 files changed, 13 insertions, 12 deletions
diff --git a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
index 1179362565d..5950ab8a1d6 100644
--- a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
+++ b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
@@ -134,20 +134,21 @@
\hypersetup{pdfauthor={Josef Kleber},pdftitle={A user-friendly interface to PDF annotations},pdfsubject={Documentation for LaTeX style \filename}}%
%
\begin{document}
-\pdfcommentsetup{date=D:20101212153723+01'00'}
+%\pdfcommentsetup{date=D:20101212153723+01'00'}
+\date{2016/06/13}
\bibliographystyle{alphadin}
\title{\filename}%
\Subtitle{A user-friendly interface to PDF annotations}%
\author{Josef Kleber}
-\Fileversion{v2.3b}
-\Refline{\href{mailto:josef.kleber@gmx.de}{\texttt{josef.kleber@gmx.de}}\\\href{http://pdfcomment.jklatex.de}{\texttt{http://pdfcomment.jklatex.de}}}
+\Fileversion{v2.4}
+\Refline{\href{mailto:pdfcomment@jklatex.de}{\texttt{pdfcomment@jklatex.de}}\\\href{http://pdfcomment.jklatex.de}{\texttt{http://pdfcomment.jklatex.de}}}
\maketitle
\Headline{Abstract}
\begin{abstract}
For a long time \texttt{pdflatex} has offered the command \cmd\pdfannot{} for inserting arbitrary PDF annotations. However, the command is presented in a form where additional knowledge of the definition of the PDF format is indispensable. This package is an answer to the -- occasional -- questions in newsgroups, about how one could use the comment function of \texttt{Adobe Reader}. At least for the writer of \LaTeX{} code, the package offers a convenient and user-friendly means of using \cmd\pdfannot{} to provide comments in PDF files. Since version v1.1, \texttt{\filename{}} also supports:
\medskip
-\noindent\hfill\texttt{\LaTeX{} $\rightarrow$ \texttt{dvips} $\rightarrow$ \texttt{ps2pdf}, \LaTeX{} $\rightarrow$ \texttt{dvipdfmx}\footnote{only with style option \texttt{dvipdfmx}} \XeLaTeX and \LuaLaTeX}.\hfill
+\noindent\hfill\texttt{\LaTeX{} $\rightarrow$ \texttt{dvips} $\rightarrow$ \texttt{ps2pdf}, \LaTeX{} $\rightarrow$ \texttt{dvipdfmx}\footnote{only with style option \texttt{dvipdfmx}} \XeLaTeX\ and \LuaLaTeX}.\hfill
\medskip
Unfortunately, support of PDF annotations by PDF viewers may vary. The reference viewer for the development of this package is \texttt{Adobe Reader}.
@@ -157,7 +158,7 @@ If you can't see this annotation \pdfcomment[author={Josef Kleber},subject={Test
\vfill
\begin{center}
\subsubsection*{Required packages for using \substyle{\filename}}
-\fbox{\parbox[t]{.8\linewidth}{\small \package{hyperref} (v6.76a [2007/04/09]), \package{zref} (v1.8 [2007/04/22]), \package{xkeyval}, \package{ifpdf}, \package{ifthen}, \package{calc}, \package{marginnote}, \package{datetime}, \package{refcount}, \package{soulpos} and the packages loaded by them.}}
+\fbox{\parbox[t]{.8\linewidth}{\small \package{hyperref} (v6.76a [2007/04/09]), \package{zref} (v1.8 [2007/04/22]), \package{xkeyval}, \package{etoolbox}, \package{luatex85}, \package{ifpdf}, \package{ifthen}, \package{calc}, \package{marginnote}, \package{datetime2}, \package{refcount}, \package{soulpos} and the packages loaded by them.}}
\end{center}
\vfill
\clearpage
@@ -181,7 +182,7 @@ I want to thank the following persons for contributions to the development of th
\noindent\hfill\texttt{\LaTeX{} $\rightarrow$ \texttt{dvips} $\rightarrow$ \texttt{ps2pdf}, \LaTeX{} $\rightarrow$ \texttt{dvipdfmx} and \XeLaTeX}.\hfill
\medskip
-\item \textbf{Ulrike Fischer} for answering my stupid questions on d.c.t.t. for making possible the avatar and style system and much more.
+\item \textbf{Ulrike Fischer} for answering my stupid questions on d.c.t.t. for making the avatar and style system possible and much more.
\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.
@@ -205,7 +206,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: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.
+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.
\subsubsection[\texttt{subject}]{\styleoption{subject}}\label{sec:subject}
You can use the option \styleoption{subject} for defining the subject of the PDF popup annotations.
@@ -372,7 +373,7 @@ You can use the option \styleoption{hoffset} for defining a horizontal offset of
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} (\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.
+You can use the option \styleoption{height} for definig the height of PDF annotations. PDF text annatations have a height of \cmd\normalbaselineskip{} by definition.
\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.
@@ -385,13 +386,13 @@ You can use the option \styleoption{date} to assign a date to PDF annotations. I
\begin{center}
\begin{tabular}{l}
-D:YYYYMMDDhhmmss+TZ\\
-D:20101224153657+01'00'
+\texttt{D:YYYYMMDDhhmmss+TZ}\\
+\texttt{D:20101224153657+01'00'}
\end{tabular}
\end{center}
\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)).
+You only have to use the option \styleoption{timezone}, if you are using automatic date setting and \XeLaTeX. Otherwise the \texttt{pdflatex} primitive \string\pdfcreationdate\ will be used. \styleoption{timezone}=+01'00' sets the timezone to central european time CET (default: +00'00' (GMT)).
\subsubsection[\texttt{avatar}]{\styleoption{avatar}}\label{sec:avatar}
With the option \styleoption{avatar} you can load the option lists, that were predefined with the command \cmd\defineavatar{} to avoid annoying typing.
@@ -504,7 +505,7 @@ Also see \LinkExMath{} for a more detailed explanation of the possibilities!
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{} (\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!
+\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 don't have a frame but 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}