pdfcomment update (15dec08)

git-svn-id: svn://tug.org/texlive/trunk@11636 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 42 insertions, 21 deletions

diff --git a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
index ecd540bc574..aaa72f4bb8b 100644
--- a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
+++ b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex
@@ -9,21 +9,17 @@
 \usepackage{url}%
 \usepackage{attachfile}%
 \usepackage{marginnote}%
-\usepackage{tabularx}
-\usepackage{makeidx}
-\usepackage{moredefs,lips}
-\usepackage{footmisc}
 \usepackage{natbib}
-\usepackage{multicol}
-\usepackage{listings}
 \usepackage[svgnames]{xcolor}
 \usepackage{ltxdocext}%
 \usepackage{hyperref}
 \usepackage{pdfcomment}
+\def\fileversion{v1.1}
+\def\filename{pdfcomment.sty}
+\def\XeLaTeX{Xe\LaTeX}
 %\usepackage{acrofont}%
 \CodelineIndex
 %\EnableCrossrefs
-%\setfnsymbol{wiley}
 %\makeatletter
 %\def\tableofcontents{\@starttoc{toc}}
 %\makeatother
@@ -57,24 +53,28 @@
 \makeatletter
 \renewcommand\@biblabel[1]{\makebox[1.5cm][l]{[#1]}}
 \makeatother
-\hypersetup{pdfauthor={Josef Kleber},pdftitle={A user-friendly interface to pdf annotations},pdfsubject={Documentation for LaTeX style pdfcomment.sty}}
+\hypersetup{pdfauthor={Josef Kleber},pdftitle={A user-friendly interface to pdf annotations},pdfsubject={Documentation for LaTeX style \filename}}
 \begin{document}
 \bibliographystyle{alphadin}
-\title{\substyle{pdfcomment.sty} v1.0\footnote{\protect\href{mailto:pdfcomment.sty@pdfcomment.josef-kleber.de}{\texttt{pdfcomment.sty@pdfcomment.josef-kleber.de}}}\\A user-friendly interface to pdf annotations\footnote{\protect\href{http://pdfcomment.josef-kleber.de}{\texttt{http://pdfcomment.josef-kleber.de}}}}
+\title{\substyle{\filename} \fileversion\footnote{\protect\href{mailto:pdfcomment.sty@pdfcomment.josef-kleber.de}{\texttt{pdfcomment.sty@pdfcomment.josef-kleber.de}}}\\A user-friendly interface to pdf annotations\footnote{\protect\href{http://pdfcomment.josef-kleber.de}{\texttt{http://pdfcomment.josef-kleber.de}}}}
 \author{Josef Kleber\footnote{\protect\href{mailto:josef.kleber@gmx.de}{\texttt{josef.kleber@gmx.de}}}}
 \date{\today}
 \maketitle
 \begin{abstract}
-For a long time \texttt{pdflatex}\footnote{Please note that this package is only applicable using \texttt{pdflatex}}\index{pdflatex} offers the command \cmd\pdfannot{} for inserting arbitrary pdf annotations. However, in a form where additional knowledge of the pdf reference is indispensable. \substyle{pdfcomment.sty} is an answer to the -- from time to time -- emerging questions in newsgroups, how one could use the comment function of \texttt{Adobe Reader}. At least out of the \LaTeX{} code \substyle{pdfcomment.sty} offers a convenient and user-friendly possibility to use pdf annotations in pdf files.
+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: 
 
-Unfortunately the support of pdf annotations by pdf viewers is only partly available to nonexistent. The reference viewer for the development of this package is \texttt{Adobe Reader}.
+\medskip
+\noindent\hfill\texttt{\LaTeX{} $\rightarrow$ \texttt{dvips} $\rightarrow$ \texttt{ps2pdf}, \LaTeX{} $\rightarrow$ \texttt{dvipdfmx}\footnote{only with style option \texttt{dvipdfmx}} and \XeLaTeX}.\hfill
+\medskip
+
+Unfortunately, support of PDF annotations by PDF viewers is sparse to nonexistent. The reference viewer for the development of this package is \texttt{Adobe Reader}.
 
 If you can't see this annotation \pdfcomment[author={Josef Kleber},subject={Test annotation},color=lime,hspace=18pt]{This is an annotation} you are definitely using the wrong pdf viewer!
 \end{abstract}
 \vfill
 \begin{center}
-\subsubsection*{Required packages for using \substyle{pdfcomment.sty}}
-\fbox{\parbox[t]{.8\linewidth}{\small \package{hyperref}, \package{xkeyval}, \package{ifpdf}, \package{marginnote} and the packages loaded by them.}}
+\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.}}
 \end{center}
 \vfill
 \clearpage
@@ -86,19 +86,40 @@ If you can't see this annotation \pdfcomment[author={Josef Kleber},subject={Test
 %\end{multicols}
 \tableofcontents
 \clearpage
-\section{Options}
-The following options are useable as style options as well as options for the commands presented in section \ref{sec:befehle}. As style options they have global effect, whereas they have only local effect when used in commands. Furthermore global options are not overwritten. 
+\section*{Acknowledgment}
+I want to thank the following persons for contributions to the development of this package:
+
+\begin{itemize}
+\item \textbf{Alexander Grahn} for contributing a patch for other drivers
 
-\subsection[\texttt{subject}]{\styleoption{subject}}\label{sec:subject}
+\medskip
+\noindent\hfill\texttt{\LaTeX{} $\rightarrow$ \texttt{dvips} $\rightarrow$ \texttt{ps2pdf}, \LaTeX{} $\rightarrow$ \texttt{dvipdfmx} und \XeLaTeX}.\hfill
+\medskip
+
+\item \textbf{Gabriel Cardona} for pointing out problems with older versions of \texttt{hyperref} (v6.76a [2007/04/09])
+\end{itemize}
+\clearpage
+\section{Options}
+\subsection{Global options}
+\subsubsection[\texttt{final}]{\styleoption{final}}\label{sec:final}
+The option \styleoption{final} will set the package to final mode. The pdf annotations will not be typeset and will not influence line breaking.
+\subsubsection[\texttt{draft}]{\styleoption{draft}}\label{sec:draft}
+The option \styleoption{draft} (default) will set the package to draft mode. Therefore, the pdf annotations will be typeset.
+\subsubsection[\texttt{dvipdfmx}]{\styleoption{dvipdfmx}}\label{sec:dvipdfmx}
+If you want to use the driver \texttt{dvipdfmx} for creating your documents, you have to use the option \styleoption{dvipdfmx}. The other drivers are recognized automatically.
+\subsection{Local options}
+The following options are useable as options for the commands presented in section \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{subject}]{\styleoption{subject}}\label{sec:subject}
 You can use the option \styleoption{subject} for defining the subject of the pdf popup annotations.
 
-\subsection[\texttt{author}]{\styleoption{author}}\label{sec:author}
+\subsubsection[\texttt{author}]{\styleoption{author}}\label{sec:author}
 You can use the option \styleoption{author} for defining the author of the pdf popup annotations.
 
-\subsection[\texttt{color}]{\styleoption{color}}\label{sec:color}
+\subsubsection[\texttt{color}]{\styleoption{color}}\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.
 
-\subsection[\texttt{icon}]{\styleoption{icon}}\label{sec:icon}
+\subsubsection[\texttt{icon}]{\styleoption{icon}}\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:
 
 \bigskip\pdfcommentsetup{author={Josef Kleber},subject={Icon overview}}
@@ -125,10 +146,10 @@ Furthermore the following icons are also supported by \texttt{Adobe Reader} and
 
 \bigskip
 
-\subsection[\texttt{open}]{\styleoption{open}}\label{sec:open}
+\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).
 
-\subsection[\texttt{hspace}]{\styleoption{hspace}}\label{sec:hspace}
+\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.
 
 \section{Commands}\label{sec:befehle}