diff options
author | Karl Berry <karl@freefriends.org> | 2009-03-11 13:56:28 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2009-03-11 13:56:28 +0000 |
commit | 6d4f314202913f300037670418ac02c1bc1513f7 (patch) | |
tree | 01edbae395798c5b88851bd2e5e86595c93ecf78 /Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex | |
parent | 801ee79a85178e4471ab02b6d6d8f1394ee0f565 (diff) |
pdfcomment update (11mar09)
git-svn-id: svn://tug.org/texlive/trunk@12366 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.tex | 45 |
1 files changed, 38 insertions, 7 deletions
diff --git a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex index c93383bc41d..1f4011f8db7 100644 --- a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex +++ b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex @@ -9,11 +9,11 @@ \usepackage{url}% \usepackage{attachfile}% \usepackage{marginnote}% -\usepackage[svgnames]{xcolor} +\usepackage[svgnames,rgb]{xcolor} \usepackage{ltxdocext}% \usepackage{hyperref} \usepackage{pdfcomment} -\def\fileversion{v1.2} +\def\fileversion{v1.3} \def\filename{pdfcomment.sty} \def\XeLaTeX{Xe\LaTeX} %\usepackage{acrofont}% @@ -74,7 +74,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{xkeyval}, \package{ifpdf}, \package{marginnote} 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{ifpdf}, \package{ifthen}, \package{calc}, \package{marginnote} and the packages loaded by them.}} \end{center} \vfill \clearpage @@ -101,6 +101,8 @@ I want to thank the following persons for contributions to the development of th \item \textbf{Ulrike Fischer} for answering my stupid questions on d.c.t.t. for making possible the avatar and style system. \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{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. \end{itemize} \clearpage \section{Options} @@ -129,7 +131,7 @@ You can use the option \styleoption{color} for defining the color of PDF annotat By definition the PDF specification allows four different color spaces with different numbers of color values: \begin{center} -\begin{tabular}{rl} +\begin{tabular}{cl} \# & color space\\ \hline 0 & transparent \\ @@ -186,6 +188,9 @@ You can use the option \styleoption{height} for definig the height of PDF annota \subsubsection[\texttt{hspace}]{\styleoption{hspace}}\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{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{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. @@ -200,15 +205,41 @@ You can use the following commands for commenting your documents. \subsubsection{\texorpdfstring{\cs{pdfcomment}}{\textbackslash pdfcomment}} \label{sec:pdfcomment} -\cmd\pdfcomment \margcs{\cmd\pdfcomment\\\oarg{options}\marg{comment}} 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. +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} + +\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. \subsubsection{\texorpdfstring{\cs{pdfmargincomment}}{\textbackslash pdfmargincomment}} \label{sec:pdfmargincomment} -\cmd\pdfmargincomment \margcs{\cmd\pdfmargincomment\\\oarg{options}\marg{comment}} 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. +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} + +\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} + +\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: \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!} + +\hspace*{0pt}\newline +Limitations: + +\begin{itemize} +\item As the name PDF text markup annotation might lead to suggest, this form of comment is suitable for text only. +\item The specified text with the argument \marg{markup text} must not be longer than one paragraph. +\item The PDF text markup annotation must not be longer than one page, otherwise the recognition of the page break will fail. +\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} \subsubsection{\texorpdfstring{\cs{pdffreetextcomment}}{\textbackslash pdffreetextcomment}} \label{sec:pdffreetextcomment} -\cmd\pdffreetextcomment \margcs{\cmd\pdffreetextcomment\\\oarg{options}\marg{comment}} will typset 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=1cm,hoffset=1.2cm,opacity=0.5,color=yellow]{This is a FreeText annotation} +Mögliche \margcs{\cmd\pdffreetextcomment\\\oarg{options}\marg{comment}}Optionen: \styleoption{avatar}, \styleoption{style}, \styleoption{subject}, \styleoption{author}, \styleoption{color}, \styleoption{opacity}, \styleoption{height}, \styleoption{width}, \styleoption{voffset}, \styleoption{hoffset} + +\bigskip +\cmd\pdffreetextcomment{} will typset 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=-1.3cm,hoffset=1.2cm,opacity=0.5,color=yellow]{This is a FreeText annotation} \subsection{Misc. commands} |