summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/hyperref/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-01-15 00:23:50 +0000
committerKarl Berry <karl@freefriends.org>2010-01-15 00:23:50 +0000
commit500af65c59a551d272e65a1a8591f9e5e1132281 (patch)
tree09186b93306e173a6cf6a74204825d179a24ac5d /Master/texmf-dist/source/latex/hyperref/doc
parenta73ab16648e87732e07a1be4a43b211b03a23953 (diff)
hyperref update (13jan10)
git-svn-id: svn://tug.org/texlive/trunk@16720 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/hyperref/doc')
-rw-r--r--Master/texmf-dist/source/latex/hyperref/doc/manual.tex44
-rw-r--r--Master/texmf-dist/source/latex/hyperref/doc/options.tex2
2 files changed, 42 insertions, 4 deletions
diff --git a/Master/texmf-dist/source/latex/hyperref/doc/manual.tex b/Master/texmf-dist/source/latex/hyperref/doc/manual.tex
index cd572f4357f..577f8078fcd 100644
--- a/Master/texmf-dist/source/latex/hyperref/doc/manual.tex
+++ b/Master/texmf-dist/source/latex/hyperref/doc/manual.tex
@@ -11,9 +11,11 @@
%
% Manual updates:
% * Steve Peter and Karl Berry, 7/03.
-% * Heiko Oberdiek, 2006-2009.
+% * Heiko Oberdiek, 2006-2010.
%
+\def\mydate{January 2010}
+
\RequirePackage{ifpdf}
\ifpdf % We are running pdfTeX in pdf mode
\documentclass[pdftex]{article}
@@ -24,6 +26,7 @@
\usepackage{etex}% for \eTeX
\usepackage{pifont}
+\usepackage{calc}
\newcommand*{\cs}[1]{%
\texttt{\textbackslash #1}%
@@ -131,7 +134,7 @@
\title{Hypertext marks in \LaTeX: a manual for \textsf{hyperref}}
\author{Sebastian Rahtz \and Heiko Oberdiek}
-\date{December 2009}
+\date{\mydate}
\begin{document}
@@ -493,7 +496,7 @@ next \TeX\ run if it is edited to contain the line \\
\end{verbatim}
\subsection{PDF display and information options}
-\noindent\begin{longtable}{>{\ttfamily}ll>{\itshape}lp{6cm}}
+\noindent\begin{longtable}{@{}>{\ttfamily}l>{\raggedright}p{\widthof{key value}}>{\itshape}lp{7cm}@{}}
baseurl & URL & & Sets the base URL of the PDF document \\
pdfpagemode & text & empty & Determines how the file is opening in Acrobat; the possibilities are
\texttt{UseNone}, \texttt{UseThumbs} (show thumbnails), \texttt{UseOutlines}
@@ -506,6 +509,11 @@ pdfsubject & text & & Sets the document information Subject fie
pdfcreator & text & & Sets the document information Creator field \\
pdfproducer & text & & Sets the document information Producer field \\
pdfkeywords & text & & Sets the document information Keywords field \\
+pdftrapped & text & empty & Sets the document information Trapped entry.\\
+&&& Possible values are \texttt{True}, \texttt{False} and \texttt{Unknown}.\\
+&&& An empty value means, the entry is not set.\\
+pdfinfo & key value list & empty & Alternative interface for setting the
+ document information.\\
pdfview & text & XYZ & Sets the default PDF `view' for each link \\
pdfstartpage & text & 1 & Determines on which page the PDF file is opened. \\
pdfstartview & text & Fit & Set the startup page view \\
@@ -596,12 +604,36 @@ Split & /Dm /M & Two lines sweep across the screen to reveal the new page. \\
Wipe & /Di & A single line sweeps across the screen to reveal the new page.
\end{longtable}
+\subsection{Option \texttt{pdfinfo}}
+
+The information entries can be set using \texttt{pdftitle},
+\texttt{pdfsubject}, \dots. Option \texttt{pdfinfo} provides an alternative
+interface. It takes a key value list. The key names are the names that
+appear in the PDF information dictionary directly. Known keys such as
+\texttt{Title}, \texttt{Subject}, \texttt{Trapped} and other are mapped to
+options \texttt{pdftitle}, \texttt{subject}, \texttt{trapped}, \dots
+Unknown keys are added to the information dictionary. Their values are text
+strings (see PDF specification).
+Example:
+\begin{quote}
+\begin{verbatim}
+\hypersetup{
+ pdfinfo={
+ Title={My Title},
+ Subject={My Subject},
+ NewKey={Foobar},
+ % ...
+ }
+}
+\end{verbatim}
+\end{quote}
+
\subsection{Big alphabetical list}
The following is a complete listing of available options for
\textsf{hyperref}, arranged alphabetically.
-\noindent\begin{longtable}{>{\ttfamily}llp{6cm}}
+\noindent\begin{longtable}{@{}>{\ttfamily}llp{7cm}@{}}
anchorcolor & \textit{black} & set color of anchors \\
backref & \textit{false} & do bibliographical back references \\
baseurl & \textit{empty} & set base URL for document \\
@@ -662,6 +694,7 @@ pdfduplex & \textit{empty} & paper handling option for
print dialog\\
pdffitwindow & \textit{false} & resize document window to fit document size \\
pdfhighlight & \textit{/I} & set highlighting of PDF links \\
+pdfinfo & \textit{empty} & alternative interface for setting document information\\
pdfkeywords & \textit{empty} & text for PDF Keywords field \\
pdflang & \textit{empty} & PDF language identifier (RFC 3066) \\
pdfmark & \textit{false} & an alias for \textsf{dvips} \\
@@ -690,6 +723,9 @@ pdfsubject & \textit{empty} & text for PDF Subject field \\
pdftex & & use \textsf{pdf\TeX} backend \\
pdftitle & \textit{empty} & text for PDF Title field \\
pdftoolbar & \textit{true} & make PDF toolbar visible \\
+pdftrapped & \textit{empty} & Sets the document information Trapped entry.
+ Possible values are \texttt{True}, \texttt{False} and \texttt{Unknown}.
+ An empty value means, the entry is not set.\\
pdfview & \textit{XYZ} & PDF `view' when on link traversal \\
pdfviewarea & \textit{empty} & set /ViewArea of viewer preferences \\
pdfviewclip & \textit{empty} & set /ViewClip of viewer preferences \\
diff --git a/Master/texmf-dist/source/latex/hyperref/doc/options.tex b/Master/texmf-dist/source/latex/hyperref/doc/options.tex
index 4f2f47dd368..04f14859f9b 100644
--- a/Master/texmf-dist/source/latex/hyperref/doc/options.tex
+++ b/Master/texmf-dist/source/latex/hyperref/doc/options.tex
@@ -72,6 +72,7 @@ pdfdisplaydoctitle &display document title instead of file name in title bar&fal
pdfduplex &paper handling option for print dialog& \optempty\\
pdffitwindow &resize document window to fit document size&false\\
pdfhighlight &set highlighting of PDF links& /I\\
+pdfinfo & alternative interface for document information & \optempty\\
pdfkeywords &text for PDF Keywords field&\optempty\\
pdflang &PDF language identifier (RFC 3066)&\optempty\\
pdfmenubar &make PDF viewer's menu bar visible&true\\
@@ -89,6 +90,7 @@ pdfprintclip &set /PrintClip of viewer preferences&\optempty\\
pdfprintpagerange &set /PrintPageRange of viewer preferences&\optempty\\
pdfprintscaling &page scaling option for print dialog&\optempty\\
pdfproducer &text for PDF Producer field&\optempty\\
+pdftrapped & set the document information Trapped entry&\optempty\\
pdfstartpage &page at which PDF document opens&1\\
pdfstartview &starting view of PDF document& /Fit\\
pdfsubject &text for PDF Subject field&\optempty\\