summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.tex
diff options
context:
space:
mode:
authorManuel Pégourié-Gonnard <mpg@elzevir.fr>2009-11-20 10:42:18 +0000
committerManuel Pégourié-Gonnard <mpg@elzevir.fr>2009-11-20 10:42:18 +0000
commit727025f920d13bfa0292fb04ac97117b07a02ae2 (patch)
treed67c44171e33da9ef231711e2bf4b84c65faf711 /Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.tex
parent64e6072a5dad1d9eb63e27bbb1a00ff4278e49fe (diff)
pdfmarginpar update 0.9
git-svn-id: svn://tug.org/texlive/trunk@16102 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.tex')
-rw-r--r--Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.tex91
1 files changed, 81 insertions, 10 deletions
diff --git a/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.tex b/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.tex
index d386db78475..18c101d5f4f 100644
--- a/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.tex
+++ b/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.tex
@@ -95,12 +95,12 @@
\title{
Manual for Package \PDFMRG\\
- {\small Version 0.8}}
+ {\small Version 0.9}}
\begin{document}
\maketitle
\begin{abstract}%
-\PDFMRG\ provides the |\pdfmarginpar| command which is similar in spirit to |\marginpar|. However, it creates \pdf-annotations which can be viewed with Adobe Reader instead of normal text margins: small icons\pdfmarginpar[Comment]{As they are provided by the viewer application} indicate the in-text position where the message originates, popups provide detailed messages. The advantage over |\marginpar| is that bugfixes and communication is clearly visible together with its text source and the document as such is not obscured.
+\PDFMRG\ provides the |\pdfmarginpar| command which is similar in spirit to |\marginpar|. However, it creates \pdf-annotations which can be viewed with Adobe Reader instead of normal text margins: small icons\pdfmarginpar[Comment]{The viewer application supplies the small icons} indicate the in-text position where the message originates, popups provide detailed messages. The advantage over |\marginpar| is that bugfixes and communication is clearly visible together with its text source and the document as such is not obscured.
\end{abstract}
\tableofcontents
\section{Introduction}
@@ -110,8 +110,10 @@ The package is also useful as communication device for articles written by multi
\paragraph{Hint:} View this document in Adobe Reader as it contains several annotations.
+\paragraph{Hint:} Josef Kleber has incorporated ideas of this package into his newer package |pdfcomment|. As long as the Acrobat Reader can't edit \TeX\ annotations, I won't continue development on |pdfmarginpar|.
+
\section{Installation and Requirements}
-The package is very small. In fact, it is nothing but a light-weight command which invokes the |pdflatex| primitive |\pdfannot| with a high-level user interface which encapsulates all supported \pdf\ annotation parameters with key-value options.
+The package is very small. It requires \pgfname\ 2.0 installed. In fact, it is nothing but a light-weight command which invokes the |pdflatex| primitive |\pdfannot| with a high-level user interface which encapsulates all supported \pdf\ annotation parameters with key-value options.
Simply copy |pdfmarginpar.sty| somewhere into your \TeX\ search path (or the article's directory).
@@ -148,15 +150,15 @@ All options have a key prefix, |/pdfmarginpar/|. This prefix is optional (it has
\begin{codeexample}[]
\pdfmarginparset{Open=true,color={[0.5 0.5 0.5]}}
-This is an example already opened annotations with gray color
-\pdfmarginpar{This is an example already opened annotations with gray color.}.
+This is an example of already opened annotations with gray color
+\pdfmarginpar{This is an example of already opened annotations with gray color.}.
\end{codeexample}
It is \emph{not} necessary to prefix every option with |/pdfmarginpar/|, see above.
\end{command}
-\begin{key}{/pdfmarginpar/Name=\mchoice{Comment,Key,Note,Help,NewParagraph,Paragraph,Insert} (initially Comment)}
+\begin{key}{/pdfmarginpar/Name=\mchoice{Comment,Key,Note,Help,NewParagraph,Paragraph,Insert,none} (initially Comment)}
Allows to choose a different type of annotation.
\begin{codeexample}[]
Comment Annotation\pdfmarginpar[Comment]{Comment}\end{codeexample}
@@ -176,15 +178,19 @@ Annotation\pdfmarginpar[Paragraph]{Paragraph}\end{codeexample}
Insert Annotation\pdfmarginpar[Insert]{Insert}\end{codeexample}
If |Name=| is omitted, the annotation is chosen directly -- and some more style options take place. For example, the |Comment| annotation will be raised somewhat and the |Insert| Annotation will be moved somewhat. Using |Name=Comment| will just select the |Comment| annotation without any further modifications.
+
+Use the |none| value to disable this variable in the |.pdf|. This may be necessary for types different than Sticky Notes.
\end{key}
-\begin{key}{/pdfmarginpar/Open=\mchoice{true,false} (initially false)}
+\begin{key}{/pdfmarginpar/Open=\mchoice{true,false} (initially true)}
Defines whether annotation popups shall be opened at start-up.
+
+ \paragraph{Attention:} Only opened popups will be printed!
\end{key}
\begin{keylist}{
- /pdfmarginpar/C=\oarg{\meta{R} \meta{G} \meta{B}} (initially [1 0 0]),
- /pdfmarginpar/color=\oarg{\meta{R} \meta{G} \meta{B}} (initially [1 0 0])}
+ /pdfmarginpar/C=\oarg{\meta{R} \meta{G} \meta{B}} (initially [1 1 0]),
+ /pdfmarginpar/color=\oarg{\meta{R} \meta{G} \meta{B}} (initially [1 1 0])}
Defines the annotation's color with \meta{R},\meta{G},\meta{B}$ \in [0,1]$.
\end{keylist}
@@ -208,8 +214,73 @@ If |Name=| is omitted, the annotation is chosen directly -- and some more style
\end{key}
\begin{key}{/pdfmarginpar/Subtype=\marg{Type} (initially Text)}
- This option is here for future developments. I intended only |Text| (although it should be possible to use any other supported |Subtype| as found in the pdf reference).
+ Currently, only |Text| is accepted.
+
+ Use
+
+ |\pdfmarginpar[Subtype/Other=|\meta{pdf name}|]|\marg{$\dotsc$}
+
+ to supply unsupported sub types.\pdfmarginpar[Name=none,Subtype=FreeText]{ZEUG!}
+\end{key}
+
+\begin{key}{/pdfmarginpar/caption=\marg{text caption} (initially Author's Note)}
+ Sets a caption.
+\end{key}
+
+\begin{key}{/pdfmarginpar/width=\marg{dimen} (initially empty)}
+ Defines a width for an annotation. This is not necessary for sticky notes.
+\begin{codeexample}[width=2cm]
+\pdfmarginpar[Subtype=FreeText,width=4cm,height=0.5cm]
+ {A free text.}
+\end{codeexample}
+ Please note that the |\pdfmarginpar| won't occupy any space in the final document -- |width| refers only to the appearance of the annotation.
+
+ Use can use |hoffset| and |voffset| to move the annotation around (relative to the occurance of |\pdfmarginpar| in the document). However, it may be better to use the |textpos| package for absolute positioning on the page.
+\begin{codeexample}[width=2cm]
+\pdfmarginpar[Subtype=FreeText,width=4cm,height=2cm,hoffset=9cm,voffset=-5cm]
+ {A free text, shifted relatively to the occurance of pdfmarginpar.}
+Here comes the marginpar!
+\end{codeexample}
+\end{key}
+
+\begin{key}{/pdfmarginpar/height=\marg{dimen} (initially empty)}
+ Defines a height for an annotation. See |width|.
\end{key}
+\begin{key}{/pdfmarginpar/depth=\marg{dimen} (initially empty)}
+ Defines a depth for an annotation. See |width|.
+\end{key}
+
+
+\subsection{Printing Popups and Comments}
+Adobe Reader \emph{can} print both free texts and popups. The feature can be accesses using ``File $\gg$ Print: Comments and Forms = Document and Markups''.
+
+To print popups, you need to configure Adobe Reader using ``Edit $\gg$ Preferences $\gg$ Commenting'' where the corresponding option needs to be set. Unfortunately, this option does not exist in many reader versions.
+
+If it does not exist, the only possibility to activate it is to patch the configuration of Adobe Reader.
+
+\begin{description}
+ \item[For Windows,]
+ the registry need to be changed. Please note that this is at your own risk.
+
+For Reader 6 or 7, open the registry editor and browse to the following key:
+
+|HKEY_CURRENT_USER\Software\ADOBE\Acrobat Reader\6.0| (or |7.0| or |8.0|)|\Annots\cPrefs|
+
+Double click the |bprintCommentPopups| key and change the value to |1|.
+
+For Adobe Reader 8, the same key needs to be changed to
+
+|HKEY_CURRENT_USER\Software\Adobe\Acrobat Reader\8.0\Annots\cPrefs|
+
+|"bprintCommentPopups"=dword:00000001|.
+ \item[For Linux,]
+edit
+
+|~/.adobe/Acrobat/8.0/Preferences/reader_prefs|
+
+with a text editor and change |/printCommentPopups [/b false]| to |/printCommentPopups [/b true]|.
+\end{description}
+Please note that only opened popups will be printed.
\subsection{Implementation note}
All these variables boil down to the |pdflatex| primitive