1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
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}
|
