\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{natbib}
\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
%\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 \filename}}
\begin{document}
\bibliographystyle{alphadin}
\title{\substyle{\filename} \fileversion\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}\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{\filename} 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{\filename} eine bequeme und nutzerfreundliche Möglichkeit pdf annotations in pdf-Dateien zu nutzen. Seit Version v1.1 unterstützt \texttt{\filename{}} auch:

\medskip
\noindent\hfill\texttt{\LaTeX{} $\rightarrow$ \texttt{dvips} $\rightarrow$ \texttt{ps2pdf}, \LaTeX{} $\rightarrow$ \texttt{dvipdfmx}\footnote{nur mit der Styleoption \texttt{dvipdfmx}} und \XeLaTeX}.\hfill
\medskip

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{\filename}}
\fbox{\parbox[t]{.8\linewidth}{\small \package{hyperref} (v6.76a [2007/04/09]), \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*{Danksagung}
Für Beiträge zur Entwicklung dieses Pakets möchte ich folgenden Personen danken:

\begin{itemize}
\item \textbf{Alexander Grahn} für das Bereitstellen eines Patchs für andere Treiber

\medskip
\noindent\hfill\texttt{\LaTeX{} $\rightarrow$ \texttt{dvips} $\rightarrow$ \texttt{ps2pdf}, \LaTeX{} $\rightarrow$ \texttt{dvipdfmx} und \XeLaTeX}.\hfill
\medskip

\item \textbf{Gabriel Cardona} für den Hinweis auf Probleme mit älteren Versionen von \texttt{hyperref} (v6.76a [2007/04/09])
\end{itemize}
\clearpage
\section{Optionen}
\subsection{Globale Styleoptionen}
\subsubsection[\texttt{final}]{\styleoption{final}}\label{sec:final}
Mit der Option \texttt{final} versetzt man das Paket in den Final-Modus. Die pdf annotations werden nicht gesetzt und beeinflussen daher auch nicht den Zeilen\-umbruch. 
\subsubsection[\texttt{draft}]{\styleoption{draft}}\label{sec:draft}
Mit der Option \texttt{draft} (default) versetzt man das Paket in den Draft-Modus. Die pdf annotations werden daher gesetzt.
\subsubsection[\texttt{dvipdfmx}]{\styleoption{dvipdfmx}}\label{sec:dvipdfmx}
Falls Sie für die Erstellung Ihrer Dokumente den Treiber \texttt{dvipdfmx} einsetzen möchten, müssen sie die Option \texttt{dvipdfmx} benutzen. Die anderen bereits erwähnten Treiber werden automatisch erkannt.
\subsection{Lokale Optionen}
Die anschließend vorgestellten Optionen sind für die im Abschnitt \ref{sec:befehle} vorgestellten Befehle anwendbar, allerdings können sie auch als Styleoptionen benutzt werden. Als Styleoptionen besitzen sie globale Wirkung, während sie in Befehlen nur eine lokale Wirkung besitzen und die globalen Optionen nicht überschreiben. 

\subsubsection[\texttt{subject}]{\styleoption{subject}}\label{sec:subject}
Die Option \styleoption{subject} dient der Festlegung der Überschriften der pdf popup annotations.

\subsubsection[\texttt{author}]{\styleoption{author}}\label{sec:author}
Die Option \styleoption{author} dient der Festlegung des Verfassers der pdf popup annotations.

\subsubsection[\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.

\subsubsection[\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

\subsubsection[\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).

\subsubsection[\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}
