summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/hyperref/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2020-01-21 21:42:42 +0000
committerKarl Berry <karl@freefriends.org>2020-01-21 21:42:42 +0000
commit7c390d3d29fcbe5f23638ba1a3143e9da3a4b52a (patch)
tree50a74a86e1aec1195a9cf0fc32d894c9f666b6c7 /Master/texmf-dist/source/latex/hyperref/doc
parent7062d8632ec7d062d8f94ed590771e4ece15bb04 (diff)
hyperref (21jan20)
git-svn-id: svn://tug.org/texlive/trunk@53481 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.tex274
-rw-r--r--Master/texmf-dist/source/latex/hyperref/doc/options.tex132
2 files changed, 162 insertions, 244 deletions
diff --git a/Master/texmf-dist/source/latex/hyperref/doc/manual.tex b/Master/texmf-dist/source/latex/hyperref/doc/manual.tex
index 1fba391fcd4..242388fef93 100644
--- a/Master/texmf-dist/source/latex/hyperref/doc/manual.tex
+++ b/Master/texmf-dist/source/latex/hyperref/doc/manual.tex
@@ -4,7 +4,7 @@
% Copyright (C) 2003 Steve Peter and Karl Berry
% Copyright (C) 2006-2012 Heiko Oberdiek.
% Copyright (C) 2017-2019 David Carlisle Ulrike Fischer
-% Copyright (C) 2019- The LaTeX3 Project
+% Copyright (C) 2019-2020 The LaTeX3 Project
%
% Permission is granted to copy, distribute and/or modify this document
% under the terms of the GNU Free Documentation License, Version 1.1 or
@@ -14,9 +14,9 @@
% ``GNU Free Documentation License.''
%
-\def\mydate{September 2019}
+\def\mydate{January 2020}
-\RequirePackage{ifpdf}
+\RequirePackage{iftex}
\ifpdf % We are running pdfTeX in pdf mode
\ifx\directlua\undefinded
\documentclass[pdftex]{article}
@@ -39,6 +39,7 @@
\texttt{\textbackslash #1}%
}
\newcommand*{\xpackage}[1]{\textsf{#1}}
+\newcommand*{\xoption}[1]{\textsf{#1}}
% from doc.sty
\makeatletter
@@ -135,7 +136,6 @@
\makeatother
\usepackage{array,longtable}
-\usepackage{ifluatex,ifxetex}
\ifnum 0\ifluatex 1\else\ifxetex 1\fi\fi=0 %
\usepackage[T1]{fontenc}%
\usepackage{lmodern}%
@@ -166,13 +166,17 @@
\makeatletter
\@ifpackageloaded{tex4ht}{%
+\author{Sebastian Rahtz (deceased)\and
+ Heiko Oberdiek (inactive)\and
+ The \LaTeX3 Project (\url{https://github.com/latex3/hyperref/issues})}
}{%
\usepackage{bmhydoc}%
+\author{Sebastian Rahtz\thanks{deceased}\and
+ Heiko Oberdiek\thanks{inactive}\and
+ The \LaTeX3 Project\thanks{\url{https://github.com/latex3/hyperref/issues}}}
}
\makeatother
-
\title{Hypertext marks in \hologo{LaTeX}: a manual for \xpackage{hyperref}}
-\author{Sebastian Rahtz \and Heiko Oberdiek}
\date{\mydate}
\begin{document}
@@ -186,7 +190,7 @@
\section{Introduction}
The package derives from, and builds on, the work of the Hyper\hologo{TeX}
-project, described at \url{http://xxx.lanl.gov/hypertex/}. It extends
+project, described at \texttt{http://xxx.lanl.gov/hypertex/}\footnote{Now: \url{https://ctan.org/tex-archive/support/hypertex/hypertex}}. It extends
the functionality of all the \hologo{LaTeX} cross-referencing commands
(including the table of contents, bibliographies etc) to produce
\cs{special} commands which a driver can turn into hypertext links;
@@ -391,7 +395,7 @@ as they default to the value true if used. These are the ones classed as
Firstly, the options to specify general behavior and page size.
\medskip
-\noindent\begin{longtable}{>{\ttfamily}ll>{\itshape}ll}
+\begin{longtable}{>{\ttfamily}ll>{\itshape}ll}
draft & boolean & false & all hypertext options are turned off \\
final & boolean & true & all hypertext options are turned on \\
debug & boolean & false & extra diagnostic messages are printed in \\
@@ -540,7 +544,7 @@ if the destination is not yet renamed:
Hint: Anchors can also be named and set by \cs{hypertarget}.
\medskip
-\noindent\begin{longtable}{>{\ttfamily}ll>{\itshape}ll}
+\begin{longtable}{>{\ttfamily}ll>{\itshape}ll}
destlabel & boolean & false & destinations are named by first \cs{label}\\
& & & after anchor creation\\
hypertexnames & boolean & true & use guessable names for links \\
@@ -551,7 +555,7 @@ plainpages & boolean & false & Forces page anchors to be named by the Arabic
\subsection{Configuration options}
-\noindent\begin{longtable}{>{\ttfamily}ll>{\itshape}lp{7cm}}
+\begin{longtable}{>{\ttfamily}ll>{\itshape}lp{9cm}}
raiselinks & boolean & true & In the hypertex driver, the height of links is normally calculated by the driver as
simply the base line of contained text; this options forces \verb|\special| commands to
reflect the real height of the link (which could contain a graphic) \\
@@ -608,7 +612,7 @@ textures & For use with \textsf{Textures} \\
vtex & For use with MicroPress' \textsf{VTeX}; the PDF
and HTML backends are detected automatically. \\
vtexpdfmark & For use with \textsf{VTeX}'s PostScript backend. \\
-xetex & For use with Xe\TeX (using backend for dvipdfm).
+xetex & For use with Xe\TeX\ (using backend for dvipdfm).
\end{longtable}
\smallskip
@@ -624,7 +628,7 @@ Explorer might add something like this to hyperref.cfg:
\end{verbatim}
\subsection{Extension options}
-\begin{longtable}{@{}>{\ttfamily}ll>{\itshape}lp{5.5cm}@{}}
+\begin{longtable}{@{}>{\ttfamily}ll>{\itshape}lp{8cm}@{}}
extension & text & & Set the file extension (e.g.\ \textsf{dvi}) which will be appended to file links
created if you use the \xpackage{xr} package. \\
hyperfigures & boolean & & \\
@@ -635,7 +639,7 @@ backref & text & false & Adds `backlink' text to the end of each ite
pagebackref & boolean & false & Adds `backlink' text to the end of each item in the bibliography, as a list of page
numbers. \\
hyperindex & boolean & true & Makes the page numbers of index entries into hyperlinks. Relays on unique
- page anchors (\verb|pageanchor|, \ldots)\\
+ page anchors (\verb|pageanchor|, \ldots)
\verb|pageanchors| and \verb|plainpages=false|. \\
hyperfootnotes & boolean & true & Makes the footnote marks into hyperlinks to the footnote text.
Easily broken \ldots\\
@@ -665,7 +669,7 @@ Note that all color names must be defined before use, following the
normal system of the standard \LaTeX\ \xpackage{color} package.
\subsection{PDF-specific display options}
-\begin{longtable}{@{}>{\ttfamily}ll>{\itshape}lp{7.5cm}@{}}
+\begin{longtable}{@{}>{\ttfamily}ll>{\itshape}lp{7.6cm}@{}}
bookmarks & boolean & true & A set of Acrobat bookmarks are written, in a manner similar to the
table of contents, requiring two passes of \LaTeX. Some postprocessing
of the bookmark file (file extension \texttt{.out}) may be needed to
@@ -726,57 +730,83 @@ next \TeX\ run if it is edited to contain the line
\subsection{PDF display and information options}
\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}
- (show bookmarks), \texttt{FullScreen}, \texttt{UseOC} (PDF 1.5),
- and \texttt{UseAttachments} (PDF 1.6). If no mode if explicitly chosen, but the
- bookmarks option is set, \texttt{UseOutlines} is used. \\
+pdfpagemode & name & empty & Determines how the file is opening in Acrobat; the possibilities are
+ \verb|UseNone|, \verb|UseThumbs| (show thumbnails), \verb|UseOutlines|
+ (show bookmarks), \verb|FullScreen|, \verb|UseOC| (PDF 1.5),
+ and \verb|UseAttachments| (PDF 1.6). If no mode if explicitly chosen, but the
+ bookmarks option is set, \verb|UseOutlines| is used. \\
pdftitle & text & & Sets the document information Title field \\
pdfauthor & text & & Sets the document information Author field \\
pdfsubject & text & & Sets the document information Subject field \\
pdfcreator & text & & Sets the document information Creator field \\
addtopdfproducer & text & & Adds additional text to 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 \\
-pdfremotestartview & text & Fit & Set the startup page view of remote PDF files \\
+pdftrapped & name & empty & Sets the document information Trapped entry. Possible values are \verb|True|, \verb|False| and \verb|Unknown|.
+ An empty value means, the entry is not set.\\
+%
+pdfinfo & key value list & empty & Alternative interface for setting the
+ document information.\\
+pdfview & name & XYZ & Sets the default PDF `view' for each link \\
+pdfstartpage & integer & 1 & Determines on which page the PDF file is opened. \\
+pdfstartview & name & Fit & Set the startup page view \\
+pdfremotestartview & name & Fit & Set the startup page view of remote PDF files \\
pdfpagescrop & n n n n & & Sets the default PDF crop box for pages. This should be a set of four numbers \\
pdfcenterwindow & boolean & false & position the document window in the center of the screen \\
-pdfdirection & text & empty & direction setting \\
-pdfdisplaydoctitle & boolean & false & display document title instead of
- file name in title bar\\
-pdfduplex & text & empty & paper handling option for print dialog\\
+pdfdirection & name & empty & direction setting. Possible values: \verb|L2R| (left to right) and
+ \verb|R2L| (right to left)\\
+pdfdisplaydoctitle & boolean & false & display document title instead of file name in title bar\\
+pdfduplex & name & empty & paper handling option for print dialog. Possible vatues are:
+ \verb|Simplex| (print single-sided),
+ \verb|DuplexFlipShortEdge| (duplex and flip on the short edge of the sheet),
+ \verb|DuplexFlipLongEdge| (duplex and flip on the long edge of the sheet)\\
+
pdffitwindow & boolean & false & resize document window to fit document size \\
-pdflang & text & relax & PDF language identifier (RFC 3066)\\
+pdflang & name & relax & PDF language identifier (RFC 3066)\\
pdfmenubar & boolean & true & make PDF viewer's menu bar visible \\
pdfnewwindow & boolean & false & make links that open another PDF file start a new window \\
pdfnonfullscreenpagemode
- & text & empty & page mode setting on exiting
- full-screen mode\\
+ & name & empty & page mode setting on exiting full-screen mode. Possible values are
+ \verb|UseNone|, \verb|UseOutlines|, \verb|UseThumbs|, and \verb|UseOC|\\
pdfnumcopies & integer & empty & number of printed copies \\
-pdfpagelayout & text & empty & set layout of PDF pages \\
+pdfpagelayout & name & empty & set layout of PDF pages. Possible values:
+ \verb|SinglePage|, \verb|OneColumn|,
+ \verb|TwoColumnLeft|, \verb|TwoColumnRight|,
+ \verb|TwoPageLeft|, and \verb|TwoPageRight| \\
pdfpagelabels & boolean & true & set PDF page labels \\
-pdfpagetransition & text & empty & set PDF page transition style \\
-pdfpicktraybypdfsize & text & empty & set option for print dialog \\
-pdfprintarea & text & empty & set /PrintArea of viewer preferences \\
-pdfprintclip & text & empty & set /PrintClip of viewer preferences \\
+pdfpagetransition & name & empty & set PDF page transition style. Possible values are
+ \verb|Split|, \verb|Blinds|, \verb|Box|, \verb|Wipe|,
+ \verb|Dissolve|, \verb|Glitter|, \verb|R|,
+ \verb|Fly|, \verb|Push|,
+ \verb|Cover|, \verb|Uncover|,
+ \verb|Fade|.
+ The default according to the PDF~Reference is \verb|R|,
+ which simply replaces the old page with the new one. \\
+pdfpicktraybypdfsize
+ & boolean & false & specify whether PDF page size is used to select input paper tray in print dialog \\
+pdfprintarea & name & empty & set /PrintArea of viewer preferences. Possible values are
+ \verb|MediaBox|, \verb|CropBox|,
+ \verb|BleedBox|, \verb|TrimBox|, and \verb|ArtBox|.
+ The dafault according to the PDF~Refence is \verb|CropBox| \\
+pdfprintclip & name & empty & set /PrintClip of viewer preferences. Possible values are
+ \verb|MediaBox|, \verb|CropBox|,
+ \verb|BleedBox|, \verb|TrimBox|, and \verb|ArtBox|.
+ The dafault according to the PDF~Refence is \verb|CropBox| \\
pdfprintpagerange & n n (n n)*
- & empty & set /PrintPageRange of viewer
- preferences\\
-pdfprintscaling & text & empty & page scaling option for print dialog
+ & empty & set /PrintPageRange of viewer preferences\\
+pdfprintscaling & name & empty & page scaling option for print dialog
(option /PrintScaling of viewer
preferences, PDF 1.6);
- valid values are \texttt{None} and
- \texttt{AppDefault} \\
+ valid values are \verb|None| and
+ \verb|AppDefault| \\
pdftoolbar & boolean & true & make PDF toolbar visible \\
-pdfviewarea & text & empty & set /ViewArea of viewer preferences \\
-pdfviewclip & text & empty & set /ViewClip of viewer preferences \\
+pdfviewarea & name & empty & set /ViewArea of viewer preferences. Possible values are
+ \verb|MediaBox|, \verb|CropBox|,
+ \verb|BleedBox|, \verb|TrimBox|, and \verb|ArtBox|.
+ The dafault according to the PDF~Refence is \verb|CropBox| \\
+pdfviewclip & name & empty & set /ViewClip of viewer preferences Possible values are
+ \verb|MediaBox|, \verb|CropBox|,
+ \verb|BleedBox|, \verb|TrimBox|, and \verb|ArtBox|.
+ The dafault according to the PDF~Refence is \verb|CropBox| \\
pdfwindowui & boolean & true & make PDF user interface elements visible \\
unicode & boolean & false & Unicode encoded PDF strings
\end{longtable}
@@ -830,7 +860,21 @@ Box & /M & A box sweeps in or out. \\
Dissolve & & The page image dissolves in a piecemeal fashion to reveal the new page. \\
Glitter & /Di & Similar to Dissolve, except the effect sweeps across the screen. \\
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.
+Wipe & /Di & A single line sweeps across the screen to reveal the new page. \\
+R & & Simply replaces the old page with the new one. \\
+Fly & /Di /M & Changes are flown out or in (as specified by /M), in the direction
+ specified by /Di, to or from a location that is
+ offscreen except when /Di is None. \\
+Push & /Di & The old page slides off the screen while the new page slides in,
+ pushing the old page out in the direction
+ specified by /Di. \\
+Cover & /Di & The new page slides on to the screen in the direction specified
+ by /Di, covering the old page. \\
+Uncover & /Di & The old page slides off the screen in the direction specified by
+ /Di, uncovering the new page in the direction
+ specified by /Di. \\
+Fade & & The new page gradually becomes visible through the old one.
+
\end{longtable}
\subsection{Option \texttt{pdfinfo}}
@@ -863,6 +907,8 @@ The following is a complete listing of available options for
\textsf{hyperref}, arranged alphabetically.
\begin{longtable}{@{}>{\ttfamily}llp{7cm}@{}}
+allbordercolors & & Set all border color options\\
+allcolors & & Set all color options (without border and field options)\\
anchorcolor & \textit{black} & set color of anchors, ignored by most drivers. \\
backref & \textit{false} & do bibliographical back references \\
baseurl & \textit{empty} & set base URL for document \\
@@ -880,6 +926,7 @@ colorlinks & \textit{false} & color links \\
debug & \textit{false} & provide details of anchors defined; same as verbose \\
destlabel & \textit{false} & destinations are named by the first \verb|\label| after the anchor creation \\
draft & \textit{false} & do not do any hyperlinking \\
+driverfallback & & default if no driver specified or detected\\
dvipdfm & & use \textsf{dvipdfm} backend \\
dvipdfmx & & use \textsf{dvipdfmx} backend \\
dvips & & use \textsf{dvips} backend \\
@@ -891,6 +938,7 @@ filebordercolor & \textit{0 .5 .5} & color of border around file links
filecolor & \textit{cyan} & color of file links \\
final & \textit{true} & opposite of option draft \\
frenchlinks & \textit{false} & use small caps instead of color for links \\
+hidelinks & & Hide links (removing color and border) \\
hyperfigures & \textit{false} & make figures hyper links \\
hyperfootnotes & \textit{true} & set up hyperlinked footnotes \\
hyperindex & \textit{true} & set up hyperlinked indices \\
@@ -912,6 +960,7 @@ pagebackref & \textit{false} & backreference by page number \\
pdfauthor & \textit{empty} & text for PDF Author field \\
pdfborder & \textit{0 0 1} & width of PDF link border \\
& \textit{0 0 0} & (\texttt{colorlinks)} \\
+pdfborderstyle & & border style for links \\
pdfcenterwindow & \textit{false} & position the document window in the center of the screen \\
pdfcreator & \textit{LaTeX with} & text for PDF Creator field \\
& \textit{hyperref} & \\
@@ -933,9 +982,9 @@ pdfnonfullscreenpagemode
& \textit{empty} & page mode setting on exiting
full-screen mode\\
pdfnumcopies & \textit{empty} & number of printed copies\\
+pdfpagelabels & \textit{true} & set PDF page labels \\
pdfpagelayout & \textit{empty} & set layout of PDF pages \\
pdfpagemode & \textit{empty} & set default mode of PDF display \\
-pdfpagelabels & \textit{true} & set PDF page labels \\
pdfpagescrop & \textit{empty} & set crop size of PDF document \\
pdfpagetransition & \textit{empty} & set PDF page transition style \\
pdfpicktraybypdfsize
@@ -961,6 +1010,7 @@ pdfviewclip & \textit{empty} & set /ViewClip of viewer preference
pdfwindowui & \textit{true} & make PDF user interface elements visible \\
plainpages & \textit{false} & do page number anchors as plain Arabic \\
ps2pdf & & use \textsf{ps2pdf} backend \\
+psdextra & \textit{false} & define more short names for PDF string commands \\
raiselinks & \textit{false} & raise up links (for \textsf{Hyper\TeX} backend) \\
runbordercolor & \textit{0 .7 .7} & color of border around `run' links \\
runcolor & \textit{filecolor} & color of `run' links\\
@@ -1652,7 +1702,7 @@ sequence error would arise.
suffix_2p "\\nohyperpage{f.}"
suffix_3p "\\nohyperpage{ff.}"
\end{verbatim}
- (Depending on the typesetting tradition some space "\verb|\\|," or "\verb|~|"
+ (Depending on the typesetting tradition some space ``\verb|\\|,'' or ``\verb|~|''
should be put before the first f inside \verb|\nohyperpage|.)
@@ -1668,7 +1718,7 @@ sequence error would arise.
\item The option must be given for package loading:
\verb|\usepackage[ocgcolorlinks]{hyperref}|
\item Main disadvantage: Links cannot be broken across lines.
- PDF reference 1.7: 4.10.2 "Making Graphical Content Optional":
+ PDF reference 1.7: 4.10.2 ``Making Graphical Content Optional'':
Graphics state operations, such as setting the color, ...,
are still applied.
Therefore the link text is put in a box and set twice, with and
@@ -1730,16 +1780,16 @@ sequence error would arise.
Before 6.77b:
\begin{itemize}
- \item pdfnewwindow=true --> /NewWindow true
- \item pdfnewwindow=false --> (absent)
- \item unused pdfnewwindow --> (absent)
+ \item pdfnewwindow=true $\rightarrow$ /NewWindow true
+ \item pdfnewwindow=false $\rightarrow$ (absent)
+ \item unused pdfnewwindow $\rightarrow$ (absent)
\end{itemize}
Since 6.77b:
\begin{itemize}
- \item pdfnewwindow=true --> /NewWindow true
- \item pdfnewwindow=false --> /NewWindow false
- \item pdfnewwindow={} --> (absent)
- \item unused pdfnewwindow --> (absent)
+ \item pdfnewwindow=true $\rightarrow$ /NewWindow true
+ \item pdfnewwindow=false $\rightarrow$ /NewWindow false
+ \item pdfnewwindow={} $\rightarrow$ (absent)
+ \item unused pdfnewwindow $\rightarrow$ (absent)
\end{itemize}
@@ -1861,8 +1911,8 @@ sequence error would arise.
but this is not generally supported.
\begin{itemize}
\item pdfTeX below 1.10a: unsupported.
- pdfTeX >= 1.10a and < 1.30: \verb|\pdfoptionpdfminorversion|
- pdfTeX >= 1.30: \verb|\pdfminorversion|
+ pdfTeX $\ge$ 1.10a and < 1.30: \verb|\pdfoptionpdfminorversion|
+ pdfTeX $\ge$ 1.30: \verb|\pdfminorversion|
\item dvipdfm: configuration file, example:
TeX Live 2007, texmf/dvipdfm/config/config, entry `V 2'.
\item dvipdfmx: configuration file, example:
@@ -1873,7 +1923,7 @@ sequence error would arise.
The current PDF version is used as default if this version
- can be detected (only pdfTeX >= 1.10a). Otherwise the lowest
+ can be detected (only pdfTeX $\ge$ 1.10a). Otherwise the lowest
version 1.2 is assumed. Thus `hyperref' tries to avoid PDF code
that breaks this version, but is free to use ignorable higher PDF
features.
@@ -1898,17 +1948,17 @@ sequence error would arise.
The PDF format allows two encodings for bookmarks and entries
in the information dictionary: PDFDocEncoding and Unicode
- as UTF-16BE. Option "pdfencoding" selects between these encodings:
+ as UTF-16BE. Option \xoption{pdfencoding} selects between these encodings:
\begin{itemize}
- \item "pdfdoc" uses PDFDocEncoding. It uses just one byte per character,
+ \item \xoption{pdfdoc} uses PDFDocEncoding. It uses just one byte per character,
but the supported characters are limited (244 in PDF-1.7).
- \item "unicode" sets Unicode. It is encoded as UTF-16BE. Two bytes
+ \item \xoption{unicode} sets Unicode. It is encoded as UTF-16BE. Two bytes
are used for most characters, surrogates need four bytes.
- \item "auto" PDFDocEncoding if the string does not contain characters
+ \item \xoption{auto} PDFDocEncoding if the string does not contain characters
outside the encoding and Unicode otherwise.
\end{itemize}
- The luatex driver uses "unicode" by default. If another encoding should be forced,
+ The luatex driver uses \xoption{unicode} by default. If another encoding should be forced,
it should be done in \verb|hypersetup|.
\subsection{Color options/package hycolor}
@@ -1932,21 +1982,21 @@ sequence error would arise.
\subsection{Link border style}
Links can be underlined instead of the default rectangle or
- options "colorlinks", "frenchlinks". This is done by option
+ options \xoption{colorlinks}, \xoption{frenchlinks}. This is done by option
\verb|pdfborderstyle={/S/U/W 1}|
Some remarks:
\begin{itemize}
\item AR7/Linux seems to have a bug, that don't use the default
- value "1" for the width, but zero, thus that the underline
- is not visible without "/W 1". The same applies for
+ value \verb"1" for the width, but zero, thus that the underline
+ is not visible without \verb"/W 1". The same applies for
dashed boxes, eg.:
pdfborderstyle={/S/D/D[3 2]/W 1}
\item The syntax is described in the PDF specification, look for
- "border style", eg.
- Table 8.13 "Entries in a border style dictionary"
+ ``border style'', eg.
+ Table 8.13 ``Entries in a border style dictionary''
(specification for version 1.6)
\item The border style is removed by
@@ -1958,9 +2008,9 @@ sequence error would arise.
Some support:
\begin{itemize}
- \item AR7/Linux: "underline" and "dashed", but the border width
+ \item AR7/Linux: \xoption{underline} and \xoption{dashed}, but the border width
must be given.
- \item xpdf 3.00: "underline" and "dashed"
+ \item xpdf 3.00: \xoption{underline} and \xoption{dashed}
\end{itemize}
Unsupported:
@@ -1970,22 +2020,22 @@ sequence error would arise.
\end{itemize}
\end{itemize}
-\subsection{Option "bookmarksdepth"}
+\subsection{Option \xoption{bookmarksdepth}}
The depth of the bookmarks can be controlled by the new
- option "bookmarksdepth". The option acts globally and
+ option \xoption{bookmarksdepth}. The option acts globally and
distinguishes three cases:
\begin{itemize}
- \item "bookmarksdepth" without value
- Then hyperref uses the current value of counter "tocdepth".
+ \item \xoption{bookmarksdepth} without value
+ Then hyperref uses the current value of counter \xoption{tocdepth}.
This is the compatible behaviour and the default.
- \item "bookmarksdepth=<number>", the value is number (also negative):
+ \item \verb"bookmarksdepth=<number>", the value is number (also negative):
The depth for the bookmarks are set to this number.
- \item "bookmarksdepth=<name>"
+ \item \verb"bookmarksdepth=<name>"
The <name> is a document division name (part, chapter, ...).
It must not start with a digit or minus to avoid mixing up
with the number case. Internally hyperref uses the value
- of macro "\verb|\toclevel@<name>|".
+ of macro \verb|\toclevel@<name>|.
Examples:
\begin{verbatim}
\hypersetup{bookmarksdepth=paragraph}
@@ -1994,7 +2044,7 @@ sequence error would arise.
\end{verbatim}
\end{itemize}
-\subsection{Option "pdfescapeform"}
+\subsection{Option \xoption{pdfescapeform}}
There are many places where arbitrary strings end up as
PS or PDF strings. The PS/PDF strings in parentheses form
@@ -2023,17 +2073,17 @@ sequence error would arise.
\subsection{Default driver setting}
- (hyperref >= 6.72s)
+ (hyperref $\ge$ 6.72s)
If no driver is given, hyperref tries its best to guess the
- most suitable driver. Thus it loads "hpdftex", if pdfTeX is
+ most suitable driver. Thus it loads \xoption{hpdftex}, if pdfTeX is
detected running in PDF mode. Or it loads the corresponding
VTeX driver for VTeX's working modes.
Unhappily many driver programs run after the TeX compiler,
so hyperref does not have a chance (dvips, dvipdfm, ...).
- In this case driver "hypertex" is loaded that supports the
+ In this case driver \xoption{hypertex} is loaded that supports the
HyperTeX features that are recognized by xdvi for example.
This behaviour, however, can easily be changed in the configuration
- file "hyperref.cfg":
+ file \verb"hyperref.cfg":
\begin{verbatim}
\providecommand*{\Hy@defaultdriver}{hdvips}
\end{verbatim}
@@ -2424,7 +2474,7 @@ Currently only package loading orders are available:
-Note: hyperref loads package "nameref" at \verb|\begin{document}|.
+Note: hyperref loads package \xpackage{nameref} at \verb|\begin{document}|.
Sometimes this is too late, thus this package must be loaded
earlier.
@@ -2568,7 +2618,7 @@ earlier.
\usepackage{hyperref}
\usepackage{dblaccnt}
\end{verbatim}
- or see entry for "vietnam".
+ or see entry for \xoption{vietnam}.
\subsubsection{easyeqn}
@@ -2610,7 +2660,7 @@ earlier.
\subsubsection{footnote}
This package is not supported, you have to disable hyperref's footnote
- support by using option "hyperfootnotes=false".
+ support by using option \verb"hyperfootnotes=false".
\subsubsection{geometry}
@@ -2651,12 +2701,12 @@ earlier.
\subsubsection{IEEEtran.cls}
- version >= V1.6b (because of \verb|\@makecaption|, see ChangeLog)
+ version $\ge$ V1.6b (because of \verb|\@makecaption|, see ChangeLog)
\subsubsection{index}
- version >= 1995/09/28 v4.1 (because of \verb|\addcontentsline| redefinition)
+ version $\ge$ 1995/09/28 v4.1 (because of \verb|\addcontentsline| redefinition)
\subsubsection{lastpage}
@@ -2816,7 +2866,7 @@ For equations the following might work:
\subsubsection{titlesec}
- "nameref" supports titlesec, but hyperref does not
+ \xpackage{nameref} supports titlesec, but hyperref does not
(unsolved is the anchor setting, missing with unnumbered
section, perhaps problems with page breaks with numbered ones).
@@ -2828,7 +2878,7 @@ For equations the following might work:
for speeding up the next calls of that UTF8 sequence.
However this makes the first call non-expandable and
will break if used in information entries or bookmarks.
- Package "ucs" offers \verb|\PrerenderUnicode| or \verb|\PreloadUnicodePage|
+ Package \xpackage{ucs} offers \verb|\PrerenderUnicode| or \verb|\PreloadUnicodePage|
to solve this:
\begin{verbatim}
\usepackage{ucs}
@@ -2945,7 +2995,7 @@ For equations the following might work:
hyperref already provides PDF strings encoded in UTF-16BE,
thus the result is a warning
- "Failed to convert input string to UTF16..."
+ \verb"Failed to convert input string to UTF16..."
The best way would be, if xdvipdfm could detect the
byte order marker (\verb|\376\377|) and skips the conversion
@@ -2959,7 +3009,7 @@ For equations the following might work:
Two versions of \verb|\pdfstringdef| are needed:
a) The string is converted back to big characters for
- the "tainted keys" of xdvipdfmx (\verb|spc_pdfm.c: default_taintkeys|).
+ the ``tainted key'' of xdvipdfmx (\verb|spc_pdfm.c: default_taintkeys|).
The subset hyperref uses is /Title, /Author, /Subject,
/Keywords, /Creator, /Producer, /T. Any changes of this
set in xdvipdfmx cannot be detected by hyperref.
@@ -2971,7 +3021,7 @@ For equations the following might work:
Thus \textbf{each} application that uses \verb|\pdfstringdef| now must
check, if it defines a string for some of the tained keys.
If yes, then the call of \verb|\pdfstringdef| should be preceded
- by "\verb|\csname HyPsd@XeTeXBigCharstrue\endcsname|".
+ by \verb|\csname HyPsd@XeTeXBigCharstrue\endcsname|.
Example: package bookmark.
@@ -2986,20 +3036,20 @@ For equations the following might work:
Workarounds:
\begin{itemize}
\item For long section or caption titles in the table of contents
- or list of figures/tables option "linktocpage" can be used.
+ or list of figures/tables option \xoption{linktocpage} can be used.
Then the page number will be a link, and the overlong section
title is not forced into an one line link with overfull \verb|\hbox|
warning.
-\item "\verb|\url|"s are caught by package "breakurl".
-\item The option "breaklinks" is intended for internal use. But it
+\item ``\verb|\url|''s are caught by package \xpackage{breakurl}.
+\item The option \xoption{breaklinks} is intended for internal use. But it
can be used to force link wrapping, e.g. when printing a
document. However, when such a document is converted to PDF
and viewed with a PDF viewer, the active link area will be
misplaced.
- Another limitation: some penalties are "optimized" by TeX,
+ Another limitation: some penalties are ``optimized'' by TeX,
thus there are missing break points, especially within
- \verb|\url|. (See thread "hyperref.sty, breaklinks and url.sty 3.2"
+ \verb|\url|. (See thread ``hyperref.sty, breaklinks and url.sty 3.2''
in comp.text.tex 2005-09).
\end{itemize}
@@ -3054,8 +3104,8 @@ For equations the following might work:
Alternatively, LaTeX's option handling system can be adapted
- to key value options by one of the packages "kvoptions-patch"
- (from project "kvoptions") or "xkvltxp" (from project "xsetkeys").
+ to key value options by one of the packages \xpackage{kvoptions-patch}
+ (from project \xpackage{kvoptions}) or \xpackage{xkvltxp} (from project \xpackage{xsetkeys}).
\subsection{Index with makeindex}
@@ -3069,7 +3119,7 @@ For equations the following might work:
in arabic form. If the page numbers in other formats
are used (book class with \verb|\frontmatter|, \verb|\romannumbering|, ...),
then the page anchors are not unique. Therefore option
- "plainpages=false" is recommended.
+ \verb"plainpages=false" is recommended.
\item The encap mechanism of Makeindex allows to use one command only
(see documentation of Makeindex).
If the user sets such a command, hyperref suppresses its
@@ -3085,14 +3135,14 @@ For equations the following might work:
\end{verbatim}
\item Scientic Word/Scientific WorkPlace users can use
package robustindex with hyperindex=false.
- \item Other encap characters can be set by option "encap".
- Example for use of "?":
+ \item Other encap characters can be set by option \xoption{encap}.
+ Example for use of ``?'':
\begin{verbatim}
\usepackage[encap=?]{hyperref}
\end{verbatim}
- \item An other possibility is the insertion of \verb|\hyperpage| by
+ \item Another possibility is the insertion of \verb|\hyperpage| by
a style file for makeindex. For this case, hyperref's
- insertion will be disabled by "hyperindex=false".
+ insertion will be disabled by \verb"hyperindex=false".
\verb|\hyperpage| will be defined regardless of setting of hyperindex.
\begin{verbatim}
%%% cut %%% hyperindex.ist %%% cut %%%
@@ -3108,7 +3158,7 @@ encap_suffix "}"
\end{verbatim}
\end{itemize}
-\subsection{Warning "bookmark level for unknown <foobar> defaults to 0"}
+\subsection{Warning \texttt{"bookmark level for unknown <foobar> defaults to 0"}}
Getting rid of it:
\begin{verbatim}
@@ -3123,7 +3173,7 @@ encap_suffix "}"
place where hyperref set the corresponding anchor. Unhappily
the caption is set below the figure, so the figure is not
visible if a link jumps to a figure.
- In this case, try package "hypcap.sty" that implements
+ In this case, try package \xpackage{hypcap} that implements
a method to circumvent the problem.
@@ -3161,7 +3211,7 @@ Support for additional unicode characters:
4. Transform into a form understood by hyperref:
Hyperref must know where the first byte starts,
- this is marked by "9" (8 and 9 cannot occur in
+ this is marked by \verb"9" (8 and 9 cannot occur in
octal numbers):
\begin{verbatim}
@@ -3169,7 +3219,7 @@ Support for additional unicode characters:
\036\241 -> \9036\241
\end{verbatim}
- Optional: "8" is used for abbreviations:
+ Optional: \verb"8" is used for abbreviations:
\begin{verbatim}
\900 = \80, \901 = \81, \902 = \82, ...
@@ -3193,7 +3243,7 @@ Support for additional unicode characters:
The footnote support is rather limited. It is beyond the scope
to use \verb|\footnotemark| and \verb|\footnotetext| out of order or reusing
\verb|\footnotemark|. Here you can either disable hyperref's footnote
- support by "hyperfootnotes=false" or fiddle with internal macros,
+ support by \verb"hyperfootnotes=false" or fiddle with internal macros,
nasty examples:
\begin{verbatim}
diff --git a/Master/texmf-dist/source/latex/hyperref/doc/options.tex b/Master/texmf-dist/source/latex/hyperref/doc/options.tex
deleted file mode 100644
index d3e9d64d379..00000000000
--- a/Master/texmf-dist/source/latex/hyperref/doc/options.tex
+++ /dev/null
@@ -1,132 +0,0 @@
-\documentclass[a4paper,11pt]{article}
-\usepackage{geometry}
-\geometry{
- includefoot,
- hmargin=10mm,
- vmargin=15mm,
-}
-\usepackage{array}
-\usepackage{longtable}
-\usepackage{ifluatex,ifxetex}
-\ifnum 0\ifluatex 1\else\ifxetex 1\fi\fi=0 %
- \renewcommand*{\ttdefault}{lmvtt}%
-\else
- \usepackage{fontspec}%
- \renewcommand*{\ttdefault}{lmvtt}%
-\fi
-\title{hyperref package options}
-\author{Sebastian Rahtz, Heiko Oberdiek et al.}
-\date{July 28th 2012}% HO
-\newcommand{\optempty}{{\rmfamily\textit{empty}}}
-\newcommand{\optrelax}{{\rmfamily\textit{relax}}}
-\newcommand*{\for}[1]{{\rmfamily(#1)}}
-\begin{document}
-\maketitle
-\begin{longtable}{@{}>{\ttfamily}lp{70mm}>{\ttfamily}l@{}}
-\hline
-allbordercolors &set all border color options&\\
-allcolors &set all color options (without border and field options)&\\
-anchorcolor &set color of anchors&black\\
-backref &do bibliographical back references&false\\
-baseurl &set base URL for document&\optempty\\
-bookmarks &make bookmarks&true\\
-bookmarksnumbered &put section numbers in bookmarks&false\\
-bookmarksopen &open up bookmark tree&false\\
-bookmarksopenlevel &level to which bookmarks are open&\string\maxdimen\\
-bookmarkstype &to specify which `toc' file to mimic&toc\\
-breaklinks &allow links to break over lines&false\\
-citebordercolor &color of border around cites& 0 1 0\\
-citecolor &color of citation links&green\\
-colorlinks &color links&false\\
-&&true \for{tex4ht, dviwindo}\\
-debug &provide details of anchors defined&false\\
-destlabel &destinations are named by the first \verb|\label| after the anchor creation&false\\
-&same as verbose&\\
-draft &do not do any hyper linking&false\\
-driverfallback &Use this driver option, if no driver is given and cannot be autodetected\\
-dvipdfm &use dvipdfm backend\\
-dvipdfmx &use dvipdfmx backend (dvipdfm)\\
-dvips &use dvips backend\\
-dvipsone &use dvipsone backend\\
-dviwindo &use dviwindo backend\\
-encap &to set encap character for hyperindex\\
-extension &suffix of linked files&dvi\\
-filebordercolor &color of border around file links& 0 .5 .5\\
-filecolor &color of file links&cyan\\
-final &opposite of option draft&true\\
-frenchlinks &use small caps instead of color for links&false\\
-hidelinks&hide links (no color, no border)&\\
-hyperfigures &make figures hyper links&false\\
-hyperfootnotes &set up hyperlinked footnotes&true\\
-hyperindex &set up hyperlinked indices&true\\
-hypertex &use HyperTeX backend\\
-hypertexnames &use guessable names for links&true\\
-implicit &redefine \LaTeX\ internals&true\\
-latex2html &use \LaTeX2HTML backend\\
-linkbordercolor &color of border around links& 1 0 0\\
-linkcolor &color of links&red\\
-linktocpage &make page number, not text, be link on TOC, LOF and LOT&false\\
-menubordercolor &color of border around menu links& 1 0 0\\
-menucolor &color for menu links&red\\
-naturalnames &use \LaTeX-computed names for links&false\\
-nesting &allow nesting of links&false\\
-pageanchor &put an anchor on every page&true\\
-pagebackref &backreference by page number&false\\
-pdfauthor &text for PDF Author field&\optempty\\
-pdfborder &width of PDF link border&0 0 1\\
-&&0 0 0 \for{colorlinks}\\
-pdfcenterwindow &position the document window center of the screen&false\\
-pdfcreator &text for PDF Creator field&LaTeX with hyperref package\\
-pdfdirection & direction setting & \optempty\\
-pdfdisplaydoctitle &display document title instead of file name in title bar&false\\
-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)&\optrelax\\
-pdfmenubar &make PDF viewer's menu bar visible&true\\
-pdfnewwindow &make links that open another PDF file start a new window&false\\
-pdfnonfullscreenpagemode &page mode setting on exiting full-screen mode&\optempty\\
-pdfnumcopies &number of printed copies&\optempty\\
-pdfpagelayout &set layout of PDF pages&\optempty\\
-pdfpagemode &set default mode of PDF display&\optempty\\
-pdfpagelabels &set PDF page labels&false\\
-pdfpagescrop &set crop size of PDF document&\optempty\\
-pdfpagetransition &set PDF page transition style&\optempty\\
-pdfpicktrackbypdfsize &set option for print dialog&\optempty\\
-pdfprintarea &set /PrintArea of viewer preferences&\optempty\\
-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\\
-pdfremotestartview & starting view for links into remote PDF documents&Fit\\
-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\\
-pdftex &use pdf\TeX\ backend\\
-pdftitle &text for PDF Title field&\optempty\\
-pdftoolbar &make PDF toolbar visible&true\\
-pdfview &PDF `view' when on link traversal&\optempty\\
-pdfviewarea &set /ViewArea of viewer preferences&\optempty\\
-pdfviewclip &set /ViewClip of viewer preferences&\optempty\\
-pdfwindowui &make PDF user interface elements visible&true\\
-plainpages &do page number anchors as plain arabic&true\\
-ps2pdf &use ps2pdf backend\\
-raiselinks &raise up links (for HyperTeX backend)&false\\
-runbordercolor &color of border around `run' links& 0 .7 .7\\
-runcolor & color of `run' links& filecolor\\
-setpagesize &set page size by special driver commands&true\\
-tex4ht &use \TeX4ht backend\\
-textures &use Textures backend\\
-unicode &Unicode encoded pdf strings\\
-urlbordercolor &color of border around URL links& 0 1 1\\
-urlcolor &color of URL links&magenta\\
-verbose &be chatty&false\\
-vtex &use V\TeX\ backend\\
-vtexpdfmark &use backend for V\TeX\ in PDF/PS mode (pdfmark specials)\\
-xetex &use XeTeX backend (dvipdfm)\\
-\hline
-\end{longtable}
-\end{document}