From 1cf1c3209317d0ab235e9d974e446e7487b63296 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 9 Dec 2008 01:48:56 +0000 Subject: new latex package pdfcomment (8dec08) git-svn-id: svn://tug.org/texlive/trunk@11561 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/pdfcomment/CHANGES | 6 + Master/texmf-dist/doc/latex/pdfcomment/INSTALL | 15 ++ Master/texmf-dist/doc/latex/pdfcomment/README | 12 + Master/texmf-dist/doc/latex/pdfcomment/example.pdf | Bin 0 -> 64442 bytes Master/texmf-dist/doc/latex/pdfcomment/example.tex | 49 ++++ .../texmf-dist/doc/latex/pdfcomment/manifest.txt | 24 ++ .../texmf-dist/doc/latex/pdfcomment/pdfcomment.pdf | Bin 0 -> 72457 bytes .../texmf-dist/doc/latex/pdfcomment/pdfcomment.tex | 164 +++++++++++++ .../doc/latex/pdfcomment/pdfcomment_de.pdf | Bin 0 -> 75151 bytes .../doc/latex/pdfcomment/pdfcomment_de.tex | 164 +++++++++++++ .../texmf-dist/tex/latex/pdfcomment/pdfcomment.sty | 258 +++++++++++++++++++++ Master/tlpkg/bin/tlpkg-ctan-check | 2 +- Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc | 1 + Master/tlpkg/tlpsrc/pdfcomment.tlpsrc | 2 + 14 files changed, 696 insertions(+), 1 deletion(-) create mode 100644 Master/texmf-dist/doc/latex/pdfcomment/CHANGES create mode 100644 Master/texmf-dist/doc/latex/pdfcomment/INSTALL create mode 100644 Master/texmf-dist/doc/latex/pdfcomment/README create mode 100644 Master/texmf-dist/doc/latex/pdfcomment/example.pdf create mode 100644 Master/texmf-dist/doc/latex/pdfcomment/example.tex create mode 100644 Master/texmf-dist/doc/latex/pdfcomment/manifest.txt create mode 100644 Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.pdf create mode 100644 Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex create mode 100644 Master/texmf-dist/doc/latex/pdfcomment/pdfcomment_de.pdf create mode 100644 Master/texmf-dist/doc/latex/pdfcomment/pdfcomment_de.tex create mode 100644 Master/texmf-dist/tex/latex/pdfcomment/pdfcomment.sty create mode 100644 Master/tlpkg/tlpsrc/pdfcomment.tlpsrc (limited to 'Master') diff --git a/Master/texmf-dist/doc/latex/pdfcomment/CHANGES b/Master/texmf-dist/doc/latex/pdfcomment/CHANGES new file mode 100644 index 00000000000..1529323e863 --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfcomment/CHANGES @@ -0,0 +1,6 @@ +=== pdfcomment bundle === + +-- pdfcomment bundle -- + +2008/12/07 IPO of pdfcomment on CTAN + diff --git a/Master/texmf-dist/doc/latex/pdfcomment/INSTALL b/Master/texmf-dist/doc/latex/pdfcomment/INSTALL new file mode 100644 index 00000000000..1813399186f --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfcomment/INSTALL @@ -0,0 +1,15 @@ + pdfcomment.sty -- INSTALL +============================ + +All the files ending with .sty have to be installed where TeX can +find them. Please refer to your TeX distribution's manual for how +to install additional packages. + +According to the TeX Directory Standard (TDS), the files should be +installed in your local texmf/ tree as follows: + +-- *.sty -> localtexmf/tex/latex/pdfcomment/ +-- *.pdf -> localtexmf/doc/latex/pdfcomment/ +-- *.tex -> localtexmf/doc/latex/pdfcomment/ + +Don't forget to update your FNDB (Filename database). (see: manual) \ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/pdfcomment/README b/Master/texmf-dist/doc/latex/pdfcomment/README new file mode 100644 index 00000000000..8324e232434 --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfcomment/README @@ -0,0 +1,12 @@ +For a long time pdflatex offers the command \pdfannot for inserting +arbitrary pdf annotations. However, in a form where additional knowledge +of the pdf reference is indispensable. pdfcomment.sty is an answer to +the – from time to time – emerging questions in newsgroups, how one could +use the comment function of Adobe Reader. At least out of the LaTeX code +pdfcomment.sty offers a convenient and user-friendly possibility to use +pdf annotations in pdf files. +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 Adobe Reader. + +License: LPPL diff --git a/Master/texmf-dist/doc/latex/pdfcomment/example.pdf b/Master/texmf-dist/doc/latex/pdfcomment/example.pdf new file mode 100644 index 00000000000..8883c5b8dc5 Binary files /dev/null and b/Master/texmf-dist/doc/latex/pdfcomment/example.pdf differ diff --git a/Master/texmf-dist/doc/latex/pdfcomment/example.tex b/Master/texmf-dist/doc/latex/pdfcomment/example.tex new file mode 100644 index 00000000000..900a26f1645 --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfcomment/example.tex @@ -0,0 +1,49 @@ +\documentclass{scrartcl} +\usepackage[german]{babel} +\usepackage[latin1]{inputenc} +\usepackage[T1]{fontenc} +\usepackage[svgnames]{xcolor} +\usepackage{tikz} +\usepackage[subject={Top1},author={\AA{}nsgar Lund}]{pdfcomment} +\begin{document} +\definecolor{MyBlue}{rgb}{0.045,0.278,0.643} +A \pdfcomment[subject={Top2},author={Daisy Duck},color={0.234 0.867 0.211}]{This is a comment.} little Test! \pdfcomment[color=MyBlue,icon=Note,open=true,hspace=100pt]{This is another comment.} test the hspace! \pdfcomment[color=Gold,icon=Star,author={Captain Jack}]{It's enough now!} + +\colorlet{KernFarbe}{red} +\colorlet{HuelleFarbe}{blue} +\vspace{35mm} +\begin{tikzpicture}[ + Huelle/.style = {ball color=HuelleFarbe!25}, + Kern/.style = {ball color=KernFarbe!25}, + Proton/.style = {ball color=HuelleFarbe!80}, + Elektron/.style = {ball color=KernFarbe!80}, + ] + + \shade[Huelle] (8,0) circle (2cm); + \shade[Kern] (8,0) circle (.7cm); + + % Elektronen + \foreach \cx/\cy in {8/0,8/.3,8/-.3,8.2/.25,8.2/-.25,% + 8.3/.09,8.3/-.09,7.8/.25,7.8/.-.25,7.7/.09,% + 7.7/-.09,7.5/.09,8.5/-.09,7.6/-.3,8/-.5,8/.5,8.4/.4}{ + \shade[Elektron] (\cx,\cy) circle (.6mm); + } + % Protonen + \foreach \cx/\cy in {6.9/-.1,7.4/1.2,7/.7,7.9/1.5,9.2/0.2,% + 9/1,7.5/-1.2,7/-0.8,9/-0.8,8.7/-1.2,7.7/-1.5,8.9/.5, %8.6,-1 + 7/1.3,6.6/.4,9.6/-.31,9.6/.6,8.3/1.2}{ + \shade[Proton] (\cx,\cy) circle (.6mm); + } + + \draw[<-] (8.25,.55) -- +(1.4,1.4) node[above] {Atomkern}; + \draw[<-] (7,.4) -- +(-1.3,1) node[above] {Atomhülle}; + \draw[<-] (6.8,-.085) -- +(-1.6,.4) node[above] {Elektron}; + \draw[<-] (7.5,-.35) -- +(-2,-.7) node[below] {Proton}; +\end{tikzpicture} +\pdfcomment[color=lime,subject={Top2},icon=Check,author={Dr. Albertus Newton}]{Wow, that's nice!}\pdfcommentsetup{color=NavyBlue,subject={Top1},icon=Circle,author={Prof. Dolittle}}\pdfmargincomment{Yeah nice, but stolen from the pgf-Users mailing list!} + +\vspace{2cm} +For a long time \texttt{pdflatex} offers the command \texttt{\textbackslash pdfannot} for inserting arbitrary pdf annotations. However, in a form where additional knowledge of the pdf reference is indispensable. \texttt{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 \texttt{pdfcomment.sty} offers a convenient and user-friendly possibility to use pdf annotations in pdf files. \pdfmargincomment{Holy moly! Can anybody transfer that to real english!} + +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}. +\end{document} \ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/pdfcomment/manifest.txt b/Master/texmf-dist/doc/latex/pdfcomment/manifest.txt new file mode 100644 index 00000000000..2b69404563a --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfcomment/manifest.txt @@ -0,0 +1,24 @@ +This work consists of the following files: + + +-- Styles -- + +pdfcomment.sty + + +-- Documentation -- + +pdfcomment.pdf +pdfcomment.tex +pdfcomment_de.pdf +pdfcomment_de.tex +example.tex +example.pdf + + +-- Misc. Files -- + +README +manifest.txt +INSTALL +CHANGES \ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.pdf b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.pdf new file mode 100644 index 00000000000..0cd4ca3198f Binary files /dev/null and b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.pdf differ diff --git a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex new file mode 100644 index 00000000000..ecd540bc574 --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment.tex @@ -0,0 +1,164 @@ +\documentclass[a4paper]{ltxdoc} + +\usepackage[english]{babel}% +\usepackage[latin1]{inputenc}% +\usepackage[T1]{fontenc}% +\usepackage{textcomp}% +\usepackage{bera}% +\usepackage{microtype} +\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} +%\usepackage{acrofont}% +\CodelineIndex +%\EnableCrossrefs +%\setfnsymbol{wiley} +%\makeatletter +%\def\tableofcontents{\@starttoc{toc}} +%\makeatother +\renewcommand{\arg}[1]{% + {\ttfamily\string{}\meta{#1}{\ttfamily\string}}% + \index{#1=\string\ttt{#1}, Argument}\index{Argument>#1=\string\ttt{#1}}% +}% +\renewcommand{\oarg}[1]{% + {\ttfamily[%] + }\meta{#1}{\ttfamily%[ + ]}% + \index{#1=\string\ttt{#1}, optionales Argument}% + \index{Argument, optional>#1=\string\ttt{#1}}% +}% +\renewcommand\env{\name@idx{Umgebung}}% +\renewcommand*{\file}[1]{% + {\ttfamily#1}% + \index{#1=\string\ttt{#1}}\index{Datei>#1=\string\ttt{#1}}% +}% +\newcommand\styleoption{\name@idx{Styleoption}}% +\newcommand\stylename{\name@idx{Dokumentenstyle}}% +\def\name@idx#1#2{% + {\ttfamily#2}% + \index{#2\space#1=\string\ttt{#2}\space#1}\index{#1>#2=\string\ttt{#2}}% +}% + +\newcommand*\margcs[1]{\marginnote{\raggedleft\scriptsize #1}} +\newcommand*\package[1]{\texttt{#1}\index{#1=\string\ttt{#1}}} +\newcommand*\mco[1]{\mbox{\LANGLE\itshape#1\RANGLE}\index{#1, Klassenoptionwert}\index{Klassenoptionwert>#1}} +\setlength\parindent{0pt} +\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}} +\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}}}} +\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. + +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}. + +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.}} +\end{center} +\vfill +\clearpage +%\begin{multicols}{2} +%[\section*{Inhaltsverzeichnis} +%\setlength{\columnseprule}{.4pt} +%\setlength{\columnsep}{18pt}] +%\tableofcontents +%\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. + +\subsection[\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} +You can use the option \styleoption{author} for defining the author of the pdf popup annotations. + +\subsection[\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} +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}} +\texttt{Comment} \hspace{1em} \pdfcomment[icon=Comment,color=Ivory]{Options: icon=Comment,color=Ivory} \hfill \texttt{Key} \hspace{1em} \pdfcomment[icon=Key,color=Khaki]{Options: icon=Key,color=Khaki} \hfill \texttt{Note} \hspace{1em} \pdfcomment[icon=Note,color=LavenderBlush]{Options: icon=Note,color=LavenderBlush} \hfill \texttt{Help} \hspace{1em} \pdfcomment[icon=Help,color=CornflowerBlue]{Options: icon=Help,color=CornflowerBlue} + +\bigskip + +\hspace*{1cm}\texttt{NewParagraph} \hspace{1em} \pdfcomment[icon=NewParagraph,color=SkyBlue]{Options: icon=NewParagraph,color=SkyBlue} \hfill \texttt{Paragraph} \hspace{1em} \pdfcomment[icon=Paragraph,color=SpringGreen]{Options: icon=Paragraph,color=SpringGreen} \hfill \texttt{Insert} \hspace{1em} \pdfcomment[icon=Insert,color=PaleTurquoise]{Options: Insert,color=PaleTurquoise}\hspace{0pt}\hspace*{1cm} + +\bigskip +Furthermore the following icons are also supported by \texttt{Adobe Reader} and some other pdf viewers: + +\bigskip + +\texttt{Check} \hspace{1em} \pdfcomment[icon=Check,color=Orchid]{Options: icon=Check,color=Orchid} \hfill \texttt{Circle} \hspace{1em} \pdfcomment[icon=Circle,color=LightCyan]{Options: icon=Circle,color=LightCyan} \hfill \texttt{Cross} \hspace{1em} \pdfcomment[icon=Cross,color=Bisque]{Options: icon=Cross,color=Bisque} + +\bigskip + +\hspace*{1cm}\texttt{Star} \hspace{1em} \pdfcomment[icon=Star,color=Aquamarine]{Options: icon=Star,color=Aquamarine} \hfill \texttt{RightArrow} \hspace{1em} \pdfcomment[icon=RightArrow,color=Gainsboro]{Options: icon=RightArrow,color=Gainsboro} \hfill \texttt{RightPointer} \hspace{1em} \pdfcomment[icon=RightPointer,color=Salmon]{Options: icon=RightPointer,color=Salmon}\hspace*{1cm} + +\bigskip + +\hspace*{2.5cm}\texttt{UpArrow} \hspace{1em} \pdfcomment[icon=UpArrow,color=Teal]{Options: icon=UpArrow,color=Teal} \hfill \texttt{UpLeftArrow} \hspace{1em} \pdfcomment[icon=UpLeftArrow,color=Magenta]{Options: icon=UpLeftArrow,color=Magenta}\hspace*{2.5cm} + +\bigskip + +\subsection[\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} +You can use the option \styleoption{hspace} for defining the horizontal space after the pdf text annotations. + +\section{Commands}\label{sec:befehle} + +\subsection{Comment commands} + +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. + +\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. + +\subsection{Misc. commands} + +\subsubsection{\texorpdfstring{\cs{pdfcommentsetup}}{\textbackslash pdfcommentsetup}} +\label{sec:commentsetup} +With the command \cmd\pdfcommentsetup \margcs{\cmd\pdfcommentsetup\marg{options}} you can reset the global options at any time. With it, e.g. a co-author can simply use a different optical look, without specifying the options in every comment command. + +{ +\clearpage +\raggedright +\nocite{*} +\bibliography{pdfcomment} +\addcontentsline{toc}{section}{\refname} +} + +%for index +\footnotesize +\end{document} diff --git a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment_de.pdf b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment_de.pdf new file mode 100644 index 00000000000..024e66ee609 Binary files /dev/null and b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment_de.pdf differ diff --git a/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment_de.tex b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment_de.tex new file mode 100644 index 00000000000..6f880f6ab2a --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfcomment/pdfcomment_de.tex @@ -0,0 +1,164 @@ +\documentclass[a4paper]{ltxdoc} + +\usepackage[german]{babel}% +\usepackage[latin1]{inputenc}% +\usepackage[T1]{fontenc}% +\usepackage{textcomp}% +\usepackage{bera}% +\usepackage{microtype} +\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} +%\usepackage{acrofont}% +\CodelineIndex +%\EnableCrossrefs +%\setfnsymbol{wiley} +%\makeatletter +%\def\tableofcontents{\@starttoc{toc}} +%\makeatother +\renewcommand{\arg}[1]{% + {\ttfamily\string{}\meta{#1}{\ttfamily\string}}% + \index{#1=\string\ttt{#1}, Argument}\index{Argument>#1=\string\ttt{#1}}% +}% +\renewcommand{\oarg}[1]{% + {\ttfamily[%] + }\meta{#1}{\ttfamily%[ + ]}% + \index{#1=\string\ttt{#1}, optionales Argument}% + \index{Argument, optional>#1=\string\ttt{#1}}% +}% +\renewcommand\env{\name@idx{Umgebung}}% +\renewcommand*{\file}[1]{% + {\ttfamily#1}% + \index{#1=\string\ttt{#1}}\index{Datei>#1=\string\ttt{#1}}% +}% +\newcommand\styleoption{\name@idx{Styleoption}}% +\newcommand\stylename{\name@idx{Dokumentenstyle}}% +\def\name@idx#1#2{% + {\ttfamily#2}% + \index{#2\space#1=\string\ttt{#2}\space#1}\index{#1>#2=\string\ttt{#2}}% +}% + +\newcommand*\margcs[1]{\marginnote{\raggedleft\scriptsize #1}} +\newcommand*\package[1]{\texttt{#1}\index{#1=\string\ttt{#1}}} +\newcommand*\mco[1]{\mbox{\LANGLE\itshape#1\RANGLE}\index{#1, Klassenoptionwert}\index{Klassenoptionwert>#1}} +\setlength\parindent{0pt} +\makeatletter +\renewcommand\@biblabel[1]{\makebox[1.5cm][l]{[#1]}} +\makeatother +\hypersetup{pdfauthor={Josef Kleber},pdftitle={Ein benutzerfreundliches Interface zu PDF-Kommentaren},pdfsubject={Dokumentation für den LaTeX style pdfcomment.sty}} +\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}}}\\Ein benutzerfreundliches Interface zu PDF-Kommentaren\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} +\texttt{pdflatex}\footnote{Bitte beachten Sie, daß dieses Paket nur unter Verwendung von \texttt{pdflatex} einsetzbar ist}\index{pdflatex} bietet seit jeher den Befehl \cmd\pdfannot{} für das Einfügen beliebiger pdf annotations. Allerdings in einer Form, in der zusätzliche Kenntnisse der PDF-Referenz unabdingbar sind. \substyle{pdfcomment.sty} ist eine Antwort auf die in Newsgroups von Zeit zu Zeit auftauchende Frage, wie man die Kommentarfunktion des \texttt{Adobe Reader} nutzen könnte. Zumindest aus dem \LaTeX{}-Code heraus bietet \substyle{pdfcomment.sty} eine bequeme und nutzerfreundliche Möglichkeit pdf annotations in pdf-Dateien zu nutzen. + +Leider ist die Unterstützung der pdf annotations durch die PDF-Viewer teilweise nur sehr eingeschränkt bzw. gar nicht vorhanden. Der Referenz-Viewer für die Entwicklung dieses Pakets ist \texttt{Adobe Reader}. + +Falls Sie diesen Kommentar \pdfcomment[author={Josef Kleber},subject={Test Kommentar},color=lime,hspace=18pt]{Das ist ein Kommentar} nicht sehen, benutzen Sie definitiv den falschen PDF-Viewer! +\end{abstract} +\vfill +\begin{center} +\subsubsection*{Benötigte Pakete für die Nutzung von \substyle{pdfcomment.sty}} +\fbox{\parbox[t]{.8\linewidth}{\small \package{hyperref}, \package{xkeyval}, \package{ifpdf}, \package{marginnote} und die von diesen Paketen aufgerufenen Dateien.}} +\end{center} +\vfill +\clearpage +%\begin{multicols}{2} +%[\section*{Inhaltsverzeichnis} +%\setlength{\columnseprule}{.4pt} +%\setlength{\columnsep}{18pt}] +%\tableofcontents +%\end{multicols} +\tableofcontents +\clearpage +\section{Optionen} +Die anschließend vorgestellten Optionen sind sowohl als Styleoptionen, als auch als Optionen für die im Abschnitt \ref{sec:befehle} vorgestellten Befehle anwendbar. Als Styleoptionen besitzen sie globale Wirkung, während sie in Befehlen nur eine lokale Wirkung besitzen und die globalen Optionen nicht überschreiben. + +\subsection[\texttt{subject}]{\styleoption{subject}}\label{sec:subject} +Die Option \styleoption{subject} dient der Festlegung der Überschriften der pdf popup annotations. + +\subsection[\texttt{author}]{\styleoption{author}}\label{sec:author} +Die Option \styleoption{author} dient der Festlegung des Verfassers der pdf popup annotations. + +\subsection[\texttt{color}]{\styleoption{color}}\label{sec:color} +Die Option \styleoption{color} dient der Festlegung der Farbe der pdf popup annotations in der Form \{0.34 0.56 0.12\} (RGB). Bei Verwendung des Zusatzpakets \package{xcolor} kann man auch vordefinierte Basisfarbnamen, sowie die zusätzlich verfügbaren optionalen Farbnamen verwenden. Außerdem kann man mit dem Befehl \cmd\definecolor{} eigene benannte Farben definieren. Bitte beachten Sie das beigefügte Beispiel \file{example.tex}.\marginnote{\attachfile[author={Josef Kleber},subject={example.tex},description={Sourcecode: example.tex} ,mimetype={text/plain}, icon={Tag}]{example.tex}} Es bietet einen Überblick über die unterschiedlichen Möglichkeiten zur Festlegung der Farbe. + +\subsection[\texttt{icon}]{\styleoption{icon}}\label{sec:icon} +Die Option \styleoption{icon} dient der Festlegung der Grafik, die für die pdf text annotations benutzt werden sollen. Die folgenden Icons werden in der PDF-Referenz als verbindlich festgelegt: + +\bigskip\pdfcommentsetup{author={Josef Kleber},subject={Icon Übersicht}} +\texttt{Comment} \hspace{1em} \pdfcomment[icon=Comment,color=Ivory]{Optionen: icon=Comment,color=Ivory} \hfill \texttt{Key} \hspace{1em} \pdfcomment[icon=Key,color=Khaki]{Optionen: icon=Key,color=Khaki} \hfill \texttt{Note} \hspace{1em} \pdfcomment[icon=Note,color=LavenderBlush]{Optionen: icon=Note,color=LavenderBlush} \hfill \texttt{Help} \hspace{1em} \pdfcomment[icon=Help,color=CornflowerBlue]{Optionen: icon=Help,color=CornflowerBlue} + +\bigskip + +\hspace*{1cm}\texttt{NewParagraph} \hspace{1em} \pdfcomment[icon=NewParagraph,color=SkyBlue]{Optionen: icon=NewParagraph,color=SkyBlue} \hfill \texttt{Paragraph} \hspace{1em} \pdfcomment[icon=Paragraph,color=SpringGreen]{Optionen: icon=Paragraph,color=SpringGreen} \hfill \texttt{Insert} \hspace{1em} \pdfcomment[icon=Insert,color=PaleTurquoise]{Optionen: Insert,color=PaleTurquoise}\hspace{0pt}\hspace*{1cm} + +\bigskip +Außerdem werden vom \texttt{Adobe Reader} und einigen anderen Viewern auch diese Icons unterstützt: + +\bigskip + +\texttt{Check} \hspace{1em} \pdfcomment[icon=Check,color=Orchid]{Optionen: icon=Check,color=Orchid} \hfill \texttt{Circle} \hspace{1em} \pdfcomment[icon=Circle,color=LightCyan]{Optionen: icon=Circle,color=LightCyan} \hfill \texttt{Cross} \hspace{1em} \pdfcomment[icon=Cross,color=Bisque]{Optionen: icon=Cross,color=Bisque} + +\bigskip + +\hspace*{1cm}\texttt{Star} \hspace{1em} \pdfcomment[icon=Star,color=Aquamarine]{Optionen: icon=Star,color=Aquamarine} \hfill \texttt{RightArrow} \hspace{1em} \pdfcomment[icon=RightArrow,color=Gainsboro]{Optionen: icon=RightArrow,color=Gainsboro} \hfill \texttt{RightPointer} \hspace{1em} \pdfcomment[icon=RightPointer,color=Salmon]{Optionen: icon=RightPointer,color=Salmon}\hspace*{1cm} + +\bigskip + +\hspace*{2.5cm}\texttt{UpArrow} \hspace{1em} \pdfcomment[icon=UpArrow,color=Teal]{Optionen: icon=UpArrow,color=Teal} \hfill \texttt{UpLeftArrow} \hspace{1em} \pdfcomment[icon=UpLeftArrow,color=Magenta]{Optionen: icon=UpLeftArrow,color=Magenta}\hspace*{2.5cm} + +\bigskip + +\subsection[\texttt{open}]{\styleoption{open}}\label{sec:open} +Die Option \styleoption{open} dient der Festlegung des Öffnungsstatus der pdf popup annotations. Mögliche Werte sind dabei \texttt{true} oder \texttt{false} (Default). + +\subsection[\texttt{hspace}]{\styleoption{hspace}}\label{sec:hspace} +Die Option \styleoption{hspace} dient der Anpassung des horizontalen Abstands hinter den pdf text annotations. + +\section{Befehle}\label{sec:befehle} + +\subsection{Kommentarbefehle} + +Die folgenden Befehlen können Sie zur Kommentierung Ihres Dokuments einsetzen. + +\subsubsection{\texorpdfstring{\cs{pdfcomment}}{\textbackslash pdfcomment}} +\label{sec:pdfcomment} +\cmd\pdfcomment \margcs{\cmd\pdfcomment\\\oarg{Optionen}\marg{Kommentar}} setzt den Kommentar an der aktuellen Position \pdfcommentsetup{subject={\textbackslash pdfcomment Test},hspace=18pt}\pdfcomment[icon=Star,color=YellowGreen]{Das ist ein Kommentar im Fließtext} in den Fließtext. + +\subsubsection{\texorpdfstring{\cs{pdfmargincomment}}{\textbackslash pdfmargincomment}} +\label{sec:pdfmargincomment} +\cmd\pdfmargincomment \margcs{\cmd\pdfmargincomment\\\oarg{Optionen}\marg{Kommentar}} setzt den Kommentar in Höhe der aktuellen Zeile in die Randspalte. Bitte beachten Sie in diesem Beispiel die Positionierung des Kommentars. Diese Dokumentation wurde mit der \LaTeX{}-Klasse \texttt{ltxdoc} \pdfcommentsetup{subject={\textbackslash pdfmargincomment Test}}\pdfmargincomment[icon=Help,color=DeepPink,hspace=-30pt]{Das ist ein Kommentar in der Randspalte} erstellt. Daher erscheint der Kommentar in der linken Randspalte. + +\subsection{Allgemeine Befehle} + +\subsubsection{\texorpdfstring{\cs{pdfcommentsetup}}{\textbackslash pdfcommentsetup}} +\label{sec:commentsetup} +Mit dem Befehl \cmd\pdfcommentsetup \margcs{\cmd\pdfcommentsetup\marg{Optionen}} kann man jederzeit die globalen Styleoptionen neu setzen. Damit kann z.\,B. ein Co-Autor Kommentare anders kennzeichnen, ohne in jedem Kommentarbefehl die Optionen einzeln anpassen zu müssen. + +{ +\clearpage +\raggedright +\nocite{*} +\bibliography{pdfcomment} +\addcontentsline{toc}{section}{\refname} +} + +%for index +\footnotesize +\end{document} diff --git a/Master/texmf-dist/tex/latex/pdfcomment/pdfcomment.sty b/Master/texmf-dist/tex/latex/pdfcomment/pdfcomment.sty new file mode 100644 index 00000000000..d65343e719d --- /dev/null +++ b/Master/texmf-dist/tex/latex/pdfcomment/pdfcomment.sty @@ -0,0 +1,258 @@ +%% +%% Copyright (C) 2008 by: +%% Josef Kleber +%% +%% +%% This file may be distributed and/or modified under the conditions of +%% the LaTeX Project Public License, either version 1.3 of this license +%% or (at your option) any later version. The latest version of this +%% license is in: +%% +%% http://www.latex-project.org/lppl.txt +%% +%% and version 1.3 or later is part of all distributions of LaTeX version +%% 2003/12/01 or later. +%% +%% This work has the LPPL maintenance status "author-maintained". +%% +%% This Current Maintainer of this work is Josef Kleber. +%% +%% This work consists of all files listed in manifest.txt. +%% +% +\ProvidesPackage{pdfcomment}[2008/12/07 pdfcomment.sty v1.0 - Josef Kleber (C) 2008]% +% +\RequirePackage{xkeyval}% +% +% default values for global package options +\gdef\pc@goptd@subject{}% +\gdef\pc@goptd@color{0 0 1}% +\gdef\pc@goptd@author{}% +\gdef\pc@goptd@icon{Comment}% +\gdef\pc@goptd@open{false}% +\gdef\pc@goptd@hspace{15pt}% +% +% values for global package options +\gdef\pc@gopt@subject{}% +\gdef\pc@gopt@color{}% +\gdef\pc@gopt@author{}% +\gdef\pc@gopt@icon{}% +\gdef\pc@gopt@open{}% +\gdef\pc@gopt@hspace{}% +% +% values for local command options +\gdef\pc@lopt@subject{}% +\gdef\pc@lopt@color{}% +\gdef\pc@lopt@author{}% +\gdef\pc@lopt@icon{}% +\gdef\pc@lopt@open{}% +\gdef\pc@lopt@hspace{}% +% +% define global style option subject for setting the subject of pdf annotations +\define@key{pdfcomment.sty}{subject}[\pc@goptd@subject]% +{% + \gdef\pc@gopt@subject{#1}% +}% +% +% define global style option color for setting the color of pdf annotations +\define@key{pdfcomment.sty}{color}[\pc@goptd@color]% +{% + \gdef\pc@gopt@color{#1}% +}% +% +% define global style option author for setting the author of pdf annotations +\define@key{pdfcomment.sty}{author}[\pc@goptd@author]% +{% + \gdef\pc@gopt@author{#1}% +}% +% +% define global style option icon for setting the icon of pdf annotations +\define@key{pdfcomment.sty}{icon}[\pc@goptd@icon]% +{% + \gdef\pc@gopt@icon{#1}% +}% +% +% define global style option open for setting the open status (true,false) of pdf annotations +\define@key{pdfcomment.sty}{open}[\pc@goptd@open]% +{% + \gdef\pc@gopt@open{#1}% +}% +% +% define global style option hspace for setting the space after the pdf annotations +\define@key{pdfcomment.sty}{hspace}[\pc@goptd@hspace]% +{% + \gdef\pc@gopt@hspace{#1}% +}% +% +% define local command option subject for setting the subject of pdf annotations +\define@key{pdfcomment}{subject}[\pc@gopt@subject]% +{% + \gdef\pc@lopt@subject{#1}% +}% +% +% define local command option color for setting the color of pdf annotations +\define@key{pdfcomment}{color}[\pc@gopt@color]% +{% + \gdef\pc@lopt@color{#1}% +}% +% +% define local command option author for setting the author of pdf annotations +\define@key{pdfcomment}{author}[\pc@gopt@author]% +{% + \gdef\pc@lopt@author{#1}% +}% +% +% define local command option icon for setting the icon of pdf annotations +\define@key{pdfcomment}{icon}[\pc@gopt@icon]% +{% + \gdef\pc@lopt@icon{#1}% +}% +% +% define local command option open for setting the open status (true,false) of pdf annotations +\define@key{pdfcomment}{open}[\pc@gopt@open]% +{% + \gdef\pc@lopt@open{#1}% +}% +% +% define local command option hspace for setting the space after the pdf annotations +\define@key{pdfcomment}{hspace}[\pc@gopt@hspace]% +{% + \gdef\pc@lopt@hspace{#1}% +}% +% +% define local command option subject for setting the subject of pdf annotations +\define@key{pdfmargincomment}{subject}[\pc@gopt@subject]% +{% + \gdef\pc@lopt@subject{#1}% +}% +% +% define local command option color for setting the color of pdf annotations +\define@key{pdfmargincomment}{color}[\pc@gopt@color]% +{% + \gdef\pc@lopt@color{#1}% +}% +% +% define local command option author for setting the author of pdf annotations +\define@key{pdfmargincomment}{author}[\pc@gopt@author]% +{% + \gdef\pc@lopt@author{#1}% +}% +% +% define local command option icon for setting the icon of pdf annotations +\define@key{pdfmargincomment}{icon}[\pc@gopt@icon]% +{% + \gdef\pc@lopt@icon{#1}% +}% +% +% define local command option open for setting the open status (true,false) of pdf annotations +\define@key{pdfmargincomment}{open}[\pc@gopt@open]% +{% + \gdef\pc@lopt@open{#1}% +}% +% +% define local command option hspace for setting the space after the pdf annotations +\define@key{pdfmargincomment}{hspace}[\pc@gopt@hspace]% +{% + \gdef\pc@lopt@hspace{#1}% +}% +% +\ExecuteOptionsX{subject,color,author,icon,open,hspace}% +% +\ProcessOptionsX\relax% +% +\RequirePackage{marginnote}% +\RequirePackage{hyperref}% +\RequirePackage{ifpdf}% +% +\ifpdf% +\else% + \PackageError{pdfcomment}% + {pdfcomment works only with pdflatex in PDF mode!}% + {Not running pdfLaTeX in PDF mode; pdfcomment makes use of pdflatex primitive \pdfannot! Please run pdflatex!}% +\fi% +% +\newcommand{\pdfcomment}[2][subject={\pc@gopt@subject},color={\pc@gopt@color},author={\pc@gopt@author},icon={\pc@gopt@icon},open={\pc@gopt@open},hspace={\pc@gopt@hspace}]% +{% + % Copy all global option to local options + \gdef\pc@lopt@subject{\pc@gopt@subject}% + \gdef\pc@lopt@color{\pc@gopt@color}% + \gdef\pc@lopt@author{\pc@gopt@author}% + \gdef\pc@lopt@icon{\pc@gopt@icon}% + \gdef\pc@lopt@open{\pc@gopt@open}% + \gdef\pc@lopt@hspace{\pc@gopt@hspace}% + % Change local options if specified + \setkeys{pdfcomment}{#1}% + % Encode Contents, Author and Subject to pdf encodings (PD or PU) with hyperref's \pdfstringdef + \def\pc@pdfenc@contents{}% + \pdfstringdef\pc@pdfenc@contents{#2}% + \def\pc@pdfenc@author{}% + \pdfstringdef\pc@pdfenc@author{\pc@lopt@author}% + \def\pc@pdfenc@subject{}% + \pdfstringdef\pc@pdfenc@subject{\pc@lopt@subject}% + % transform color input to pdf color + \HyColor@XZeroOneThreeFour{\pc@lopt@color}{\pc@hyenc@color}{pdfcomment}{color}% + % typeset text annotation (see: PDF Reference) + \pdfannot width 0pt height \baselineskip depth 0pt% + {% + /Subtype /Text% + /C [\pc@hyenc@color]% + /T (\pc@pdfenc@author)% + /Subj (\pc@pdfenc@subject)% + /Name /\pc@lopt@icon% + /Contents (\pc@pdfenc@contents)% + /Open \pc@lopt@open% + } + \hspace{\pc@lopt@hspace}% +}% +% +\newcommand{\pdfmargincomment}[2][subject={\pc@gopt@subject},color={\pc@gopt@color},author={\pc@gopt@author},icon={\pc@gopt@icon},open={\pc@gopt@open},hspace={\pc@gopt@hspace}]% +{% + % Copy all global option to local options + \gdef\pc@lopt@subject{\pc@gopt@subject}% + \gdef\pc@lopt@color{\pc@gopt@color}% + \gdef\pc@lopt@author{\pc@gopt@author}% + \gdef\pc@lopt@icon{\pc@gopt@icon}% + \gdef\pc@lopt@open{\pc@gopt@open}% + \gdef\pc@lopt@hspace{\pc@gopt@hspace}% + % Change local options if specified + \setkeys{pdfmargincomment}{#1}% + % Encode Contents, Author and Subject to pdf encodings (PD or PU) with hyperref's \pdfstringdef + \def\pc@pdfenc@contents{}% + \pdfstringdef\pc@pdfenc@contents{#2}% + \def\pc@pdfenc@author{}% + \pdfstringdef\pc@pdfenc@author{\pc@lopt@author}% + \def\pc@pdfenc@subject{}% + \pdfstringdef\pc@pdfenc@subject{\pc@lopt@subject}% + % transform color input to pdf color + \HyColor@XZeroOneThreeFour{\pc@lopt@color}{\pc@hyenc@color}{pdfcomment}{color}% + \begingroup + % center marginnotes! + \renewcommand*{\raggedleftmarginnote}{\centering}% + \renewcommand*{\raggedrightmarginnote}{\centering}% + % typeset text annotation (see: PDF Reference) + \marginnote% + {% + \pdfannot width 0pt height \baselineskip depth 0pt% + {% + /Subtype /Text% + /C [\pc@hyenc@color]% + /T (\pc@pdfenc@author)% + /Subj (\pc@pdfenc@subject)% + /Name /\pc@lopt@icon% + /Contents (\pc@pdfenc@contents)% + /Open \pc@lopt@open% + } + \hspace{\pc@lopt@hspace}% + }% + \endgroup +}% +% +\newcommand{\pdfcommentsetup}[1]% +{% + % Change global options if specified + \setkeys{pdfcomment.sty}{#1}% +}% +% +% +% +\endinput% \ No newline at end of file diff --git a/Master/tlpkg/bin/tlpkg-ctan-check b/Master/tlpkg/bin/tlpkg-ctan-check index cc531e3bc0a..f0ad28404d8 100755 --- a/Master/tlpkg/bin/tlpkg-ctan-check +++ b/Master/tlpkg/bin/tlpkg-ctan-check @@ -165,7 +165,7 @@ my @WorkingTLP = qw( parallel paresse parrun passivetex patch pauldoc pax pbox pb-diagram pdf-forms-tutorial-de pdf-forms-tutorial-en - pdf-trans pdfcprot pdfcrop + pdf-trans pdfcomment pdfcprot pdfcrop pdfpages pdfscreen pdfslide pdfsync pdftex-def pdftricks pdfx perception perltex permute petiteannonce diff --git a/Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc b/Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc index f9a57cd4929..8d691fa7ab3 100644 --- a/Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc +++ b/Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc @@ -367,6 +367,7 @@ depend pawpict depend pax depend pbox depend pbsheet +depend pdfcomment depend pdfcprot depend pdfscreen depend pdfslide diff --git a/Master/tlpkg/tlpsrc/pdfcomment.tlpsrc b/Master/tlpkg/tlpsrc/pdfcomment.tlpsrc new file mode 100644 index 00000000000..01f70b9165e --- /dev/null +++ b/Master/tlpkg/tlpsrc/pdfcomment.tlpsrc @@ -0,0 +1,2 @@ +name pdfcomment +category Package -- cgit v1.2.3