summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/hyperref/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-02-05 22:15:53 +0000
committerKarl Berry <karl@freefriends.org>2021-02-05 22:15:53 +0000
commite1edadb492845c4b7206da9fb634dc4013826a45 (patch)
tree76494678b9c9dde08e7ebc4a5217094b5b694312 /Master/texmf-dist/source/latex/hyperref/doc
parent249b9d82a3260fcf1fd741ad7f6df5b5553343eb (diff)
hyperref (5feb21)
git-svn-id: svn://tug.org/texlive/trunk@57623 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.tex53
1 files changed, 33 insertions, 20 deletions
diff --git a/Master/texmf-dist/source/latex/hyperref/doc/manual.tex b/Master/texmf-dist/source/latex/hyperref/doc/manual.tex
index ded7aeb799a..ddd48e6ea14 100644
--- a/Master/texmf-dist/source/latex/hyperref/doc/manual.tex
+++ b/Master/texmf-dist/source/latex/hyperref/doc/manual.tex
@@ -177,7 +177,7 @@
}
\makeatother
\title{Hypertext marks in \hologo{LaTeX}: a manual for \xpackage{hyperref}}
-\date{2020-05-15 v7.00e}
+\date{2021-02-04 v7.00g}
\begin{document}
@@ -336,7 +336,7 @@ if it can be found, and this is a convenient place to set options on a
site-wide basis.
Note however that some options (for example \texttt{unicode}) can only be used as
-packge options, and not in \verb|\hypersetup| as the option settings are processed
+package options, and not in \verb|\hypersetup| as the option settings are processed
as the package is read.
As an example, the behavior of a particular file could be controlled by:
@@ -559,9 +559,8 @@ plainpages & boolean & false & Forces page anchors to be named by the Arabic
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) \\
-breaklinks & boolean & false & Allows link text to break across lines; since this cannot be accommodated in PDF, it is
- only set true by default if the pdftex driver is used. This makes links on multiple lines
- into different PDF links to the same target. \\
+breaklinks & boolean & both & This option is in hyperref only used in the dviwindo driver, in all other cases it doesn't do anything sensible---it neither allows nor prevents links to be broken. The ocgx2 package
+checks the state of the boolean.\\
pageanchor & boolean & true & Determines whether every page is given an implicit anchor at the top left corner. If this
is turned off, \verb|\printindex| will not contain
valid hyperlinks. \\
@@ -739,7 +738,7 @@ 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 \\
+addtopdfcreator & text & & Adds additional text to the document information Creator field \\
pdfkeywords & text & & Sets the document information Keywords field \\
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.\\
@@ -808,7 +807,7 @@ pdfviewclip & name & empty & set /ViewClip of viewer preferences Possi
\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
+unicode & boolean & true & Unicode encoded PDF strings
\end{longtable}
Each link in Acrobat carries its own magnification level, which is set
@@ -1017,7 +1016,7 @@ runcolor & \textit{filecolor} & color of `run' links\\
setpagesize & \textit{true} & set page size by special driver commands \\
tex4ht & & use \textsf{\TeX4ht} backend \\
textures & & use \textsf{Textures} backend \\
-unicode & \textit{false} & Unicode encoded pdf strings, by defaut true with \textsf{Xe\TeX} and \textsf{Lu\TeX} \\
+unicode & \textit{true} & Unicode encoded pdf strings, starting with version 2021-02-04 v7.00g set by default to true for all engines. \\
urlbordercolor & \textit{0 1 1} & color of border around URL links \\
urlcolor & \textit{magenta} & color of URL links \\
verbose & \textit{false} & be chatty \\
@@ -1392,6 +1391,19 @@ command names):
}
\end{verbatim}
+\subsection{Pagelabels}
+\begin{cmdsyntax}
+\ci{thispdfpagelabel}\verb|{|\emph{page number format}\verb|}|
+\end{cmdsyntax}
+
+This allows to change format of the page number shown in the tool bar of
+a PDF viewer for a specific page, for example
+
+\verb+\thispdfpagelabel{Empty Page-\roman{page}}+
+
+The command affects the page on which it is executed, so asynchronous page breaking
+should be taken into account. It should be used in places where for example \verb+\thispagestyle+ can be use too.
+
\subsection{Utility macros}
\label{hypercalcbp}
@@ -1955,10 +1967,11 @@ sequence error would arise.
\item \xoption{unicode} sets Unicode. It is encoded as UTF-16BE. Two bytes
are used for most characters, surrogates need four bytes.
\item \xoption{auto} PDFDocEncoding if the string does not contain characters
- outside the encoding and Unicode otherwise.
+ outside the encoding (outside ascii if an unicode engine is used)
+ and Unicode otherwise. This option is normally no suited for the unicode engines.
\end{itemize}
- The luatex driver uses \xoption{unicode} by default. If another encoding should be forced,
+ All drivers use \xoption{unicode} by default now. If another encoding should be forced,
it should be done in \verb|hypersetup|.
\subsection{Color options/package hycolor}
@@ -2293,7 +2306,7 @@ The way forms and their labels are laid out is determined by:
These macros default to \#1 \#2
-What is actually shown in as the field is determined by:
+What is actually shown in the field is determined by:
\begin{cmdsyntax}
\ci{MakeRadioField}\verb|{|\emph{width}\verb|}{|\emph{height}\verb|}|
\end{cmdsyntax}
@@ -2905,7 +2918,7 @@ For equations the following might work:
\end{verbatim}
- Also some babel versions can be problematic. For exmample,
+ Also some babel versions can be problematic. For example,
2005/05/21 v3.8g contains a patch for varioref that breaks
the hyperref support for varioref.
@@ -2978,21 +2991,21 @@ For equations the following might work:
\subsubsection{XeTeX}
- Default for the encoding of bookmarks is `pdfencoding=auto'.
+ Default for the encoding of bookmarks is \verb|pdfencoding=unicode|.
That means the strings are always treated as unicode strings.
- Only if the string restricts to the printable ASCII set,
- it is written as ASCII string. The reason is that the
- \verb|\special| does not support PDFDocEncoding.
+ If \verb|auto| or \verb|pdfdoc| is forced it applies only
+ if the string restricts to the printable ASCII set,
+ The reason is that the \verb|\special| does not support PDFDocEncoding.
In older versions hyperref contained special conversion code from
UTF-16BE back to UTF-8 in a number of places for
- xetex to avoid the xdvipdfmx warning
-
+ xetex to avoid the xdvipdfmx warning
+
\verb"Failed to convert input string to UTF16..."
-
+
This is no longer needed with a current xdvipdfmx, so this code has
been removed. \verb|\csname HyPsd@XeTeXBigCharstrue\endcsname| should no
- longer be used.
+ longer be used.
\section[Limitations]{Limitations%