From 1034af11def997396d8fd825e90e67901498f70b Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Thu, 20 Apr 2023 19:59:06 +0000 Subject: hyperref (20apr23) git-svn-id: svn://tug.org/texlive/trunk@66902 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/hyperref/ChangeLog.txt | 34 +- Master/texmf-dist/doc/latex/hyperref/README.md | 2 +- Master/texmf-dist/doc/latex/hyperref/backref.pdf | Bin 205447 -> 206645 bytes .../doc/latex/hyperref/hyperref-doc.html | 2318 ++++++++++---------- .../texmf-dist/doc/latex/hyperref/hyperref-doc.pdf | Bin 319115 -> 319722 bytes .../texmf-dist/doc/latex/hyperref/hyperref-doc.tex | 35 +- .../doc/latex/hyperref/hyperref-doc2.html | 2 +- .../doc/latex/hyperref/hyperref-doc4.html | 2 +- .../doc/latex/hyperref/hyperref-doc5.html | 2 +- .../doc/latex/hyperref/hyperref-linktarget.pdf | Bin 438106 -> 439270 bytes Master/texmf-dist/doc/latex/hyperref/hyperref.pdf | Bin 2368871 -> 2358985 bytes Master/texmf-dist/doc/latex/hyperref/nameref.pdf | Bin 180085 -> 180085 bytes 12 files changed, 1233 insertions(+), 1162 deletions(-) (limited to 'Master/texmf-dist/doc/latex') diff --git a/Master/texmf-dist/doc/latex/hyperref/ChangeLog.txt b/Master/texmf-dist/doc/latex/hyperref/ChangeLog.txt index 84e45090475..ede86c2c91f 100644 --- a/Master/texmf-dist/doc/latex/hyperref/ChangeLog.txt +++ b/Master/texmf-dist/doc/latex/hyperref/ChangeLog.txt @@ -1,5 +1,24 @@ -2023-02-05 Ulrike Fischer/David Carlisle - * if babel is loaded casing with \MakeUppercase and \MakeLowercase +2023-04-20 Ulrike Fischer + * fix spacing issues in theorems with new \@thm handling, issues 11,48. + This requires etoolbox and the LaTeX para hooks. + * Adapted MakeUppercase and MakeLowercase to new \BCPdata used by babel and polyglossia. + * added swissgerman and nswissgerman, issue #264 + * removed stray \CheckSum from backref.dtx + +2023-04-19 Ulrike Fischer + * support hitex engine + +2023-02-19 Yukai Chou + * remove dependency on etexcmds package + +2023-02-19 Ulrike Fischer/David Carlisle + * expand key once, issue #275 + * added italian to backref, PR # 274 + * added swedish to autoref names, PR #266 + +2023-02-05 Ulrike Fischer/David Carlisle + * if babel is loaded casing with + \MakeUppercase and \MakeLowercase respects the rules of the current locale/language in the bookmarks. * removed old amstex patch of \@seteqlabel * added test for \hyper@nopatch@amsmath@tag to allow to suppress an amsmath patch @@ -11,12 +30,11 @@ * change puenc-greek.def to puenc-greekbasic.def in docs, to sync with file renaming, issue #269 -2022-22-11 Ulrike Fischer/David Carlisle - * don't set the pagesize if \mag is different from 1000, see issue #1138 in latex3. - * avoid error from old labels if hyperref is loaded, issue #261 - * fixed issue #260 - * fixed a nopatch command, issue #258 - * Use protected commands in \contentsline to allow the use of \MakeUppercase, issue #121 +2022-11-13 Ulrike Fischer/David Carlisle * don't set the pagesize if \mag is + different from 1000, see issue #1138 in latex3. * avoid error from old + labels if hyperref is loaded, issue #261 * fixed issue #260 * fixed a + nopatch command, issue #258 * Use protected commands in \contentsline to + allow the use of \MakeUppercase, issue #121 2022-09-22 Ulrike Fischer/David Carlisle * adapt setpagesize option to changes in LaTeX (stockwidth is always defined) diff --git a/Master/texmf-dist/doc/latex/hyperref/README.md b/Master/texmf-dist/doc/latex/hyperref/README.md index bc04cf62ac2..b9074843191 100644 --- a/Master/texmf-dist/doc/latex/hyperref/README.md +++ b/Master/texmf-dist/doc/latex/hyperref/README.md @@ -1,6 +1,6 @@ # README for hyperref bundle -Version 2023-02-07 v7.00v +Version 2023-04-20 v7.00w ## INTRODUCTION diff --git a/Master/texmf-dist/doc/latex/hyperref/backref.pdf b/Master/texmf-dist/doc/latex/hyperref/backref.pdf index 8245a47d9d3..60d29897164 100644 Binary files a/Master/texmf-dist/doc/latex/hyperref/backref.pdf and b/Master/texmf-dist/doc/latex/hyperref/backref.pdf differ diff --git a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.html b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.html index 19e888b0beb..69ea41dee6b 100644 --- a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.html +++ b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.html @@ -20,12 +20,12 @@
Sebastian Rahtz (deceased)
Heiko Oberdiek (inactive)
The LaTeX3 Project ( The LaTeX3 Project (https://github.com/latex3/hyperref/issues)

2023-02-07 v7.00v
+class="ec-lmr-12">2023-04-20 v7.00w

Contents

@@ -348,7 +348,7 @@ class="ec-lmvtt-10">\special commands which a driver can turn into hypert it also provides new commands to allow the user to write ad hoc hypertext links, including those to external documents and URLs. -

The package is currently maintained at

The package is currently maintained at https://github.com/latex3/hyperref/ and issues should be reported there. @@ -460,14 +460,15 @@ problems.

However, the drivers intended to produce only PDF use literal PostScript or PDF \special -commands. The commands are defined in configuration files for different drivers, selected by package -options; at present, the following drivers are supported: +commands. The commands are defined in configuration files for different drivers, selected by +package options or for most current engines autodetected; at present, the following drivers are +supported:

-

+

hypertex

-

DVI processors conforming to the HyperTeX guidelines (i.e. 

DVI processors conforming to the HyperTeX guidelines (i.e. xdvi, dvips (with the -z option), @@ -477,106 +478,118 @@ class="ec-lmss-10">zTEX, and Textures) - +class="ec-lmss-10">Textures)

-

+

dvips

-

produces

produces \special commands tailored for dvips +class="ec-lmss-10">dvips. This is the default driver if dvi mode is + detected.

-

+

dvipsone

-

produces

produces \special commands tailored for dvipsone

-

+

ps2pdf

-

a special case of output suitable for processing by earlier versions of Ghostscript’s PDF +

a special case of output suitable for processing by earlier versions of Ghostscript’s PDF writer; this is basically the same as that for dvips, but a few variations remained before version 5.21

-

+

tex4ht

-

produces

produces \special commands for use with TeX4ht +class="ec-lmss-10">TeX4ht, autodetected.

-

+

pdftex

-

pdfTeX, Hàn Thế Thành’s TeX variant that writes PDF directly +

pdfTeX, Hàn Thế Thành’s TeX variant that writes PDF directly, autodetected.

-

+

luatex

-

luaTeX, Unicode TeX variant that writes PDF directly +

luaTeX, Unicode TeX variant that writes PDF directly, autodetected.

-

+

dvipdfm

-

produces

produces \special commands for Mark Wicks’ DVI to PDF driver dvipdfm

-

+

dvipdfmx

-

produces

produces \special commands for driver dvipdfmx, a successor of dvipdfm

-

+

dviwindo

-

produces

produces \special commands that Y&Y’s Windows previewer interprets as hypertext jumps within the previewer

-

+

vtex

-

produces

produces \special commands that MicroPress’ HTML and PDF-producing TeX variants - interpret as hypertext jumps within the previewer + interpret as hypertext jumps within the previewer, autodetected.

-

+

textures

-

produces

produces \special commands that Textures interprets as hypertext jumps within the previewer

-

+

xetex

-

produces \special commands for XeTeX

-

Output from

produces \special commands for XeTeX, autodetected. +

+

+hitex

+

(new 2023) for the hint format produces by the HiTeX engine, autodetected. This a quite + experimental engine and the driver file is not part of the hyperref bundle but is provided by + the hitex package. Problems should be reported to https://github.com/ruckertm/HINT.

+

Output from dvips or dvipsone must be processed using Acrobat Distiller to obtain a PDF file.\special commands is that you can also use the docume xdvi.

-

+

driverfallback

-

If a driver is not given and cannot be autodetected, then use the driver option, given as value to +

If a driver is not given and cannot be autodetected, then use the driver option, given as value to this option driverfallback. Example:

-

driverfallback=dvipdfm

-

Autodetected drivers (

Autodetected drivers (pdftex, luatex, xetex, vtex, vtexpdfmark) are recognized from within TeX and - therefore cannot be given as value to option driverfallback. However a DVI driver program is run - after the TeX run is finished. Thus it cannot be detected at TeX macro level. Then package - vtexpdfmark, hitex) are recognized from + within TeX and therefore cannot be given as value to option driverfallback. However a + DVI driver program is run after the TeX run is finished. Thus it cannot be detected + at TeX macro level. Then package hyperref uses the driver, given by driverfallback. If the driver is already specified or can be - autodetected, then option driverfallback is ignored.

+class="ec-lmss-10">driverfallback. + If the driver is already specified or can be autodetected, then option driverfallback is + ignored. + +

3 Implicit behavior

-

This package can be used with more or less any normal LaTeX document by specifying in the document +

This package can be used with more or less any normal LaTeX document by specifying in the document preamble 

 \usepackage{hyperref}
-

-

Make sure it comes

+

Make sure it comes last of your loaded packages, to give it a fighting chance of not being over-written, since its job is to redefine many LaTeX commands.4 -

Do not load it in \AtBeginDocument or the nameref use this hook too to initialize commands, timing of code execution is tricky and fragile if the packages are loaded there. If you want to delay the loading, use the begindocument/before hook. -

Hopefully you will find that all cross-references work correctly as hypertext. For example,

Hopefully you will find that all cross-references work correctly as hypertext. For example, \section commands will produce a bookmark and a link, whereas \section* commands will only show links when paired with a corresponding \addcontentsline command. -

In addition, the

In addition, the hyperindex option (see below) attempts to make items in the index by hyperlinked back to the text, and the option backref inserts extra ‘back’ links into the bibliography for each entry. @@ -658,7 +676,7 @@ class="ec-lmvtt-10">colorlinks, as its name well implies, colors the link document.

4 Interfaces for class and package authors

-

hyperlink features are nowadays a common requirement.

hyperlink features are nowadays a common requirement. hyperref patches quite a number of commands from the LaTeX core and from packages to add such features. But this is rather fragile and it add dependencies on the loading order and can break if the external packages @@ -666,26 +684,26 @@ changes. It is therefore much better if packages add suitable support to their c directly. Quite a lot packages actually did this, but due to missing documentation of the interface they often looked into the code and then used internal commands not meant as public command. -

The following tries to describe the existing variables and commands that can be viewed as public +

The following tries to describe the existing variables and commands that can be viewed as public interfaces or which should or can be set by packages to stay compatible with the hyperref command. Documented user commands are naturally interfaces too, they are not explicitly mentioned here again. -

This section is work in progress. Suggestions or comments are welcome. -

+

This section is work in progress. Suggestions or comments are welcome. +

4.1 Counters

-

Counters play an important part in the code. They are used to create destination names and to +

Counters play an important part in the code. They are used to create destination names and to define hierarchies like the bookmarks. To work correctly often they require some additional setups. -

+

-

+

\theH<counter>

-

hyperref creates destination names for link anchor typically out of the name of the counter and the \the<counter> value. This can fail, e.g. if \theH<counter> should be defined so class="ec-lmss-10">hyperref is not loaded.

-

+

\toclevel@<counter>

-

This is a variable which should contain a number. It is used for the level in the bookmarks. +

This is a variable which should contain a number. It is used for the level in the bookmarks. It should be defined for all counters which are used in toc like lists and \addcontentsline. Typical values are @@ -716,20 +734,20 @@ class="ec-lmvtt-10">\addcontentsline. \def\toclevel@subparagraph{5} \def\toclevel@figure{0} -

+

-

+

4.2 Values of package and \hypersetup options

-

When

WhenNew in version 7.00s a key is set either in the package options or with \hypersetup hyperref typically stores the result in internal variables, or executes some code or sets a internal boolean. Package and class authors should here not rely on the names or the details of the key processing. -

But as other packages sometimes need to know which value has been set, some values can be +

But as other packages sometimes need to know which value has been set, some values can be retrieved with the expandable \GetDocumentProperties. The values are given back surrounded by \edef\mypdfauthor{\GetDocumentProperties{hyperref/pdfauthor}} -

-

The values are given back as entered by the user! If they should be used in a PDF context +

+

The values are given back as entered by the user! If they should be used in a PDF context \pdfstringdef or something equivalent must still be applied. -

Currently this interface can be used for the keys

Currently this interface can be used for the keys pdfauthor, pdftitle, pdfproducer, pdfkeywords. If used with a unknown key an empty valu works also if the new PDF management is loaded with \DocumentMetadata, in this case more keys gives back their value. -

+

4.3 Links commands

-

The following commands are provided by all drivers to create links. They can be used by packages if the +

The following commands are provided by all drivers to create links. They can be used by packages if the user commands are not sufficient. New drivers must provide this commands with similar arguments. @@ -776,11 +794,11 @@ arguments.  \hyper@linklaunch{filename} {link text} {Parameters}  %Launch, only with new generic driver  \hyper@linknamed {action}{link text}                  %Named, only with new generic driver -

-

+

+

4.4 Creating targets

-

Internal links and bookmarks need something they can jump to. In a PDF this is normally called a +

Internal links and bookmarks need something they can jump to. In a PDF this is normally called a destination (and the primitive is therefor called \pdfdest), in HTML it is more common to call this an @@ -791,29 +809,29 @@ class="ec-lmvtt-10">\hyper@anchor). History can not be undone but future commands and descriptions will use the generic target unless the PDF specific destination is meant. -

Targets are created automatically when

Targets are created automatically when \refstepcounter is used and in many cases this does the right thing and nothing more is needed. But there are exceptions:

-

Package authors and users can use the following commands to create and manipulate targets. The +

Package authors and users can use the following commands to create and manipulate targets. The commands are described in more detail in hyperref-linktarget.pdf. @@ -825,11 +843,11 @@ class="ec-lmvtt-10">hyperref-linktarget.pdf.  \NextLinkTarget  \SetLinkTargetFilter -

-

The first four commands will be defined also in LaTeX directly as no-op and so can be used even if +

+

The first four commands will be defined also in LaTeX directly as no-op and so can be used even if hyperref is not loaded. -

Until LaTeX is updated package authors can also provide these definitions directly: +

Until LaTeX is updated package authors can also provide these definitions directly: 

@@ -838,27 +856,27 @@ class="ec-lmss-10">hyperref is not loaded.
 \ProvideDocumentCommand\LinkTargetOff{}{}
 \ProvideDocumentCommand\NextLinkTarget{m}{}
-

-

+

+

4.5 Patches and how to suppress them

-

The patches to external commands made by

The patches to external commands made by hyperref can be avoided completely by loading hyperref with the option implicit=false. But suppressing everything is often too drastic. There is a work in progress to classify the patches and to offer interfaces to suppress them in a more granular way. -

+

-

+

sectioning commands

-

+

  • -

    hyperref patches

    hyperref patches \@sect, \@ssect, \@chapter, \@part, \@spart.

  • -

    It adds to the starred commands a target for a link (with the prefix

    It adds to the starred commands a target for a link (with the prefix chapter* for chapters and section* otherwise). To the other commands it adds a target for a link if @@ -876,7 +894,7 @@ class="ec-lmvtt-10">secnumdepth setting or in the front matter.

  • -

    The patch can be suppressed by defining the command

    The patch can be suppressed by defining the command \hyper@nopatch@sectioning. This should normally be done only by a class or a package which provides sectioning commands and adds the targets itself. Targets have a location on the page and e.g. the @@ -887,23 +905,23 @@ class="ec-lmvtt-10">\@currentHref should get the correct meaning before class="ec-lmvtt-10">\addcontentsline is used.

  • -

    Note that the

    Note that the nameref package patches these commands too to add commands to store the title text in \@currentlabelname. Check the nameref documentation about a way to suppress these patches.

-

+

footnotes

-

To enable (partly) the linking of footnotes hyperref redefines or patches various commands, in part +

To enable (partly) the linking of footnotes hyperref redefines or patches various commands, in part package dependant.

  • -

    hyperref redefines

    hyperref redefines \@xfootnotenext, \@xfootnotemark, \footref and \maketitle.

  • -

    All those redefinitions can be suppressed by defining \hyper@nopatch@footnote. Be aware that this can suppress links but also make unwanted links appear.

-

+

amsmath tags

-

hyperref redefines two internal commands of amsmath related the

hyperref redefines two internal commands of amsmath related the \tag command to add an anchor. This code can be suppressed by defining \hyper@nopatch@amsmath@tag. (This normally makes no sense in packages but will probably be needed when math environments are changed to allow tagging.)

-

+

counters

-

hyperref patches the kernel command

hyperref patches the kernel command \@definecounter, \@newctr, \@addtoreset and @@ -954,11 +972,11 @@ class="ec-lmvtt-10">\theHcounter representation is created or reset. This class="ec-lmvtt-10">\hyper@nopatch@counter. (This normally makes no sense in packages but will probably be needed when kernel commands are changed to allow tagging.)

-

+

math environments

-

hyperref patches

hyperref patches \equation/\endequation, \eqnarray, \endeqnarray. This code can be suppressed by defining \hyper@nopatch@mathenv.

-

+

table of contents

-

hyperref redefines

hyperref redefines \contentsline to be able to add links to toc entries. It redefines \addcontentsline to create the bookmarks and pass the destination names to the toc entries. This code can be suppressed by defining \hyper@nopatch@toc.

-

+class="ec-lmvtt-10">\hyper@nopatch@toc. +

+

+captions

+

hyperref redefines \caption and \@caption to insert targets for links. This code can be suppressed + by defining \hyper@nopatch@caption (additional helper commands are not suppressed). As + various packages redefine captions too (e.g. the caption package) side-effects must be carefully + tested! + +

+

+longtable

+

hyperref redefines \LT@start and \LT@array to move the targets in a better place. This code can + be suppressed by defining \hyper@nopatch@longtable

+

5 Package options

- - -

All user-configurable aspects of

All user-configurable aspects of hyperref are set using a single ‘key=value’ scheme (using the keyval package) with the key \hypersetup macro. When the package is loaded, a file hyperref.cfg is read 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

Note however that some options (for example unicode) can only be used as package options, and not in \hypersetup as the option settings are processed as the package is read. The following @@ -1009,13 +1049,13 @@ id="TBL-2-2"> option

remark +class="td11">

remark

all driver options, e.g. pdftex

often +class="td11">

often not needed, as @@ -1029,7 +1069,7 @@ class="ec-lmvtt-10">implicit style="vertical-align:baseline;" id="TBL-2-4-"> pdfa

no-op +class="td11">

no-op with new pdfmanagement, @@ -1043,7 +1083,7 @@ class="ec-lmvtt-10">\DeclareDocumentMetadata. style="vertical-align:baseline;" id="TBL-2-5-"> unicode

is +class="td11">

is the default now @@ -1052,7 +1092,7 @@ class="td11">

is style="vertical-align:baseline;" id="TBL-2-6-"> pdfversion

no-op +class="td11">

no-op with new pdfmanagement, @@ -1066,7 +1106,7 @@ class="ec-lmvtt-10">\DeclareDocumentMetadata. style="vertical-align:baseline;" id="TBL-2-7-"> bookmarks

this +class="td11">

this will probably change @@ -1077,50 +1117,50 @@ class="td11">

this style="vertical-align:baseline;" id="TBL-2-8-"> backref

pagebackref

+class="td11">

destlabel

pdfusetitle

+class="td11">

pdfpagelabels

+class="td11">

hyperfootnotes

+class="td11">

hyperfigures

+class="td11">

hyperindex

+class="td11">

encap

+class="td11">

CJKbookmarks

only +class="td11">

only with the new @@ -1139,7 +1179,7 @@ class="ec-lmvtt-10">\hypersetup style="vertical-align:baseline;" id="TBL-2-18-"> psdextra

only +class="td11">

only with the new @@ -1158,7 +1198,7 @@ class="ec-lmvtt-10">\hypersetup style="vertical-align:baseline;" id="TBL-2-19-"> nesting

only +class="td11">

only with the new @@ -1187,10 +1227,10 @@ class="ec-lmvtt-10">\hypersetup class="td11"> -

As an example, the behavior of a particular file could be controlled by: +

As an example, the behavior of a particular file could be controlled by:

-

As seen in the previous example, information entries (pdftitle, pdfauthor, …) should be set after the +

+

As seen in the previous example, information entries (pdftitle, pdfauthor, …) should be set after the package is loaded. Otherwise LaTeX expands the values of these options prematurely. Also LaTeX strips spaces in options. Especially option ‘pdfborder’ requires some care. Curly braces protect the value, if given as package option. They are not necessary in \hypersetup. \usepackage[pdfborder={0 0 0}]{hyperref} \hypersetup{pdfborder=0 0 0} -

-

Some options can be given at any time, but many are restricted: before

+

Some options can be given at any time, but many are restricted: before \begin{document}, only in \usepackage[...]{hyperref}, before first use, etc. -

In the key descriptions that follow, many options do not need a value, as they default to the value +

In the key descriptions that follow, many options do not need a value, as they default to the value true if used. These are the ones classed as ‘boolean’. The values true and false can always be specified, however. -

+

5.1 General options

-

Firstly, the options to specify general behavior and page size. -

+

Firstly, the options to specify general behavior and page size. +

-

+

5.2 Options for destination names

-

Destinations names (also anchor, target or link names) are internal names that identify a position on a +

Destinations names (also anchor, target or link names) are internal names that identify a position on a page in the document. They are used in link targets for inner document links or the bookmarks, for example. -

Usually anchor are set, if

Usually anchor are set, if \refstepcounter is called. Thus there is a counter name and value. Both are used to construct the destination name. By default the counter value follows the counter name separated by a dot. Example for the fourth chapter:

-

chapter.4

-

This scheme is used by: +

This scheme is used by:

-

+

\autoref

-

displays the description label for the reference depending on the counter name. +

displays the description label for the reference depending on the counter name.

-

+

\hyperpage

-

is used by the index to get page links. Page anchor setting (

is used by the index to get page links. Page anchor setting (pageanchor) must not be turned off.

-

It is very important that the destination names are unique, because two destinations must not share +

It is very important that the destination names are unique, because two destinations must not share the same name. The counter value \the<counter> is not always unique for the counter. For example, table and figures can be numbered inside the chapter without having the chapter number in their @@ -1372,7 +1412,7 @@ class="ec-lmvtt-10">table.2.4 is unique because it has used \theHtable that gives 2.4 in this case. -

Often the user do not need to set

Often the user do not need to set \theH<counter>. Defaults for standard cases (chapter, …) are provided. And after hyperref is loaded, new counters with parent counters also define \@addtoreset or \numberwithin of package amsmath are used. -

Usually problems with duplicate destination names can be solved by an appropriate definition of +

Usually problems with duplicate destination names can be solved by an appropriate definition of \theH<counter>. If option hypertexnames is disabled, then a unique artificial number is used instead of @@ -1392,11 +1432,11 @@ class="ec-lmvtt-10">plainpages the page anchors use the arabic form. In both latter cases \hyperpage for index links is affected and might not work properly. -

If an unnumbered entity gets an anchor (starred forms of chapters, sections, …) or

If an unnumbered entity gets an anchor (starred forms of chapters, sections, …) or \phantomsection is used, then the dummy counter name section* and an artificial unique number is used. -

If the final PDF file is going to be merged with another file, than the destination names might clash, +

If the final PDF file is going to be merged with another file, than the destination names might clash, because both documents might contain chapter.1 or page.1. Also \renewcommand*{\HyperDestNameFilter}[1]{\jobname-#1} -

-

In document

+

In document docA the destination name chapter.2 becomes docA-chapter.2. -

Destination names can also be used from the outside in URIs(, if the driver has not removed or +

Destination names can also be used from the outside in URIs(, if the driver has not removed or changed them), for example:

@@ -1427,8 +1467,8 @@ changed them), for example: 
 http://somewhere/path/file.pdf#nameddest=chapter.4
-

-

However using a number seems unhappy. If another chapter is added before, the number changes. But it is +

+

However using a number seems unhappy. If another chapter is added before, the number changes. But it is very difficult to pass a new name for the destination to the anchor setting process that is usually deep hidden in the internals. The first name of \label after the anchor setting seems a good @@ -1440,8 +1480,8 @@ approximation:   \section{Introduction}   \label{intro} -

-

Option

+

Option destlabel checks for each \label, if there is a new destination name active and replaces the destination name by the label name. Because the destination name is already in use because of the @@ -1463,8 +1503,8 @@ class="ec-lmri-10">all destination names:   \jobname-\HyperDestLabelReplace{#1}% } -

-

The other case that only files prefixed that do not have a corresponding

+

The other case that only files prefixed that do not have a corresponding \label is more complicate, because \HyperDestLabelReplace needs the unmodified destination name as argument. This is solved by an @@ -1488,12 +1528,12 @@ LuaTEX): } \makeatother -

-

With option

+

With option destlabel destinations can also named manually, if the destination is not yet renamed:

-

\HyperDestRename{⟨destination⟨newname⟩}

-

Hint: Anchors can also be named and set by

Hint: Anchors can also be named and set by \hypertarget. -

+

-

+

5.3 Configuration options

-

+

boolean @@ -1625,7 +1665,7 @@ class="td11"> boolean @@ -1637,7 +1677,7 @@ class="td11"> boolean +

Allows links to be nested; no drivers currently support this.

@@ -1654,35 +1694,35 @@ class="td11">
true -

In the hypertex driver, the height of links is normally +

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 \special commands to reflect the @@ -1611,7 +1651,7 @@ class="td11"> boolean

both -

This option is in hyperref only used in the dviwindo driver, +

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.

true -

Determines whether every page is given an implicit anchor +

Determines whether every page is given an implicit anchor at the top left corner. If this is turned off, \printindex will not contain valid hyperlinks.

false -

Allows links to be nested; no drivers currently support this.

-

Note for option

Note for option breaklinks: The correct value is automatically set according to the driver features. It can be overwritten for drivers that do not support broken links. However, at any case, the link area will be wrong and displaced. -

+

5.4 Backend drivers

-

If no driver is specified, the package tries to find a driver in the following order: +

If no driver is specified, the package tries to find a driver in the following order:

  1. -

    Autodetection, some TeX processors can be detected at TeX macro level (pdfTeX, XeTeX, +

    Autodetection, some TeX processors can be detected at TeX macro level (pdfTeX, XeTeX, VTeX).

  2. -

    Option

    Option driverfallback. If this option is set, its value is taken as driver option.

  3. -

    Macro

    Macro \Hy@defaultdriver. The macro takes a driver file name (without file extension).

  4. -

    Package default is

    Package default is hypertex.

-

Many distributions are using a driver file

Many distributions are using a driver file hypertex.cfg that define \Hy@defaultdriver with hdvips. This @@ -1690,9 +1730,9 @@ is recommended because driver dvips provides much more features than hypertex for PDF generation. -

+

class="td01">driverfallback +

Its value is used as driver option

+

if the driver is not given or autodetected.

dvipdfm driver. < class="td01">dvipdfmx @@ -1731,7 +1771,7 @@ class="ec-lmss-10">dvipdfmx driver. < class="td01">dvips dvips driver. class="td01">dvipsone dvipsone driver. class="td01">dviwindo dviwindo Windows previewer. class="td01">hypertex pdftex program. ps2pdf dvips. class="td01">tex4ht VTeX; the PDF and HTML backends are detected class="td01">vtexpdfmark +

For use with XeTeX (using backend for dvipdfm).

@@ -1843,7 +1883,7 @@ class="td01"> class="td01">
-

Its value is used as driver option

-

if the driver is not given or autodetected.

dvipdfm -

Sets up

Sets up hyperref for use with the dvipdfm driver.

-

Sets up

Sets up hyperref for use with the dvipdfmx driver.

-

Sets up

Sets up hyperref for use with the dvips driver.

-

Sets up

Sets up hyperref for use with the dvipsone driver.

-

Sets up

Sets up hyperref for use with the dviwindo Windows previewer.

-

Sets up

Sets up hyperref for use with the HyperTeX-compliant drivers.

latex2html -

Redefines a few macros for compatibility with

Redefines a few macros for compatibility with latex2html.

nativepdf -

An alias for

An alias for dvips

pdfmark -

An alias for

An alias for dvips

pdftex -

Sets up

Sets up hyperref for use with the pdftex program.

-

Redefines a few macros for compatibility with Ghostscript’s PDF writer, +

Redefines a few macros for compatibility with Ghostscript’s PDF writer, otherwise identical to dvips.

-

For use with

For use with TeX4ht

textures -

For use with

For use with Textures

vtex -

For use with MicroPress’

For use with MicroPress’ VTeX; the PDF and HTML backends are detected automatically.

-

For use with

For use with VTeX’s PostScript backend.

xetex -

For use with XeTeX (using backend for dvipdfm).

-

If you use

If you use dviwindo, you may need to redefine the macro \wwwbrowser (the default is -

-

+

+

5.5 Extension options

-

+

extension +

+

Sets encap character for hyperindex

@@ -1999,7 +2039,7 @@ class="td11"> boolean +

Color for normal internal links.

+

Color for anchor text. Ignored by most drivers.

+

Color for bibliographical citations in text.

+

Color for URLs which open local files.

+

Color for Acrobat menu items.

+

Color for run links (launch annotations).

+

Color for linked URLs.

+

Use small caps instead of color for links.

+

Hide links (removing color and border).

@@ -2113,15 +2153,15 @@ class="td11">
text -

Set the file extension (e.g. 

Set the file extension (e.g. dvi) which will be appended to file links created if you use the xr @@ -1889,7 +1929,7 @@ class="ec-lmvtt-10">hyperfigures

boolean -

text false -

Adds ‘backlink’ text to the end of each item in the +

Adds ‘backlink’ text to the end of each item in the bibliography, as a list of section numbers. This can only work properly if there is a blank line after each @@ -1920,7 +1960,7 @@ class="td11"> boolean

false -

Adds ‘backlink’ text to the end of each item in the +

Adds ‘backlink’ text to the end of each item in the bibliography, as a list of page numbers.

boolean true -

Makes the page +

Makes the page numbers of index entries into hyperlinks. Relays on unique page anchors (pageanchor, …) boolean

true -

Makes the footnote marks into hyperlinks to the +

Makes the footnote marks into hyperlinks to the footnote text. Easily broken …

encap -

Sets encap character for hyperindex

text section -

make text (

make text (section), page number (page), both (all) @@ -1977,7 +2017,7 @@ class="td11"> boolean

false -

make page number, not text, be link on TOC, LOF +

make page number, not text, be link on TOC, LOF and LOT

boolean false -

allow links to break over lines by making links over +

allow links to break over lines by making links over multiple lines into PDF links to the same target

false -

Colors the text of links and anchors. The colors +

Colors the text of links and anchors. The colors chosen depend on the the type of link. At present the only types of link distinguished are citations, page references, URLs, local file references, and other @@ -2013,7 +2053,7 @@ class="td11"> color

red -

Color for normal internal links.

color black -

Color for anchor text. Ignored by most drivers.

color green -

Color for bibliographical citations in text.

color cyan -

Color for URLs which open local files.

color red -

Color for Acrobat menu items.

color filecolor -

Color for run links (launch annotations).

color magenta -

Color for linked URLs.

allcolors color -

Set all color options (without border and field +

Set all color options (without border and field options).

boolean false -

Use small caps instead of color for links.

hidelinks -

Hide links (removing color and border).

-

Note that all color names must be defined before use, following the normal system of the standard +

Note that all color names must be defined before use, following the normal system of the standard LaTeX color package. -

+

5.6 PDF-specific display options

-

+

boolean @@ -2167,7 +2207,7 @@ class="ec-lmvtt-10">bookmarksopenlevel +

to specify which ‘toc’ file to mimic

@@ -2224,7 +2264,7 @@ class="td11"> name @@ -2236,7 +2276,7 @@ class="td11"> RGB color +

The color of the box around citations

+

The color of the box around links to files

+

The color of the box around normal links

+

The color of the box around Acrobat menu links

+

The color of the box around links to URLs

+

Color of border around ‘run’ links

+

Set all border color options

true -

A set of Acrobat bookmarks are written, in a +

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 boolean

false -

If Acrobat bookmarks are requested, show them +

If Acrobat bookmarks are requested, show them with all the subtrees expanded.

parameter -

level (

level (\maxdimen) to which bookmarks are open
boolean false -

If Acrobat bookmarks are requested, include +

If Acrobat bookmarks are requested, include section numbers.

text toc -

to specify which ‘toc’ file to mimic

boolean false -

This option should be used to produce CJK +

This option should be used to produce CJK bookmarks. Package hyperref supports both normal and preprocessed mode of the CJK Acroread itself) support this. Also note that option ‘CJKbookmarks’ cannot be used together with option ‘unicode’. -

No mechanism is provided to +

No mechanism is provided to translate non-Unicode bookmarks to Unicode; for portable PDF documents only Unicode encoding should be used.

/I -

How link buttons behave when selected; /I is +

How link buttons behave when selected; /I is for inverse (the default); the other possibilities are /N (no effect), /O (outline), and /P (inset highlighting).

0 1 0 -

The color of the box around citations

RGB color 0 .5 .5 -

The color of the box around links to files

RGB color 1 0 0 -

The color of the box around normal links

RGB color 1 0 0 -

The color of the box around Acrobat menu links

RGB color 0 1 1 -

The color of the box around links to URLs

RGB color 0 .7 .7 -

Color of border around ‘run’ links

allbordercolors -

Set all border color options

0 0 1 -

The style of box around links; defaults to a box +

The style of box around links; defaults to a box with lines of 1pt thickness, but the colorlinks option resets it to produce no border.

-

The color of link borders used to be specified

The color of link borders used to be specified only as 3 numbers in the range 0..1, giving an RGB color. Since version 6.76a, the usual color specifications of package (x)color can be used if hycolor. -

The bookmark commands are stored in a file called

The bookmark commands are stored in a file called jobname.out. The files is not processed by LaTeX so any markup is passed through. You can postprocess this file as needed; as an aid @@ -2338,13 +2378,13 @@ line 

 \let\WriteBookmarks\relax
-

-

+

+

5.7 PDF display and information options

-

+

class="td01">baseurl +

Sets the base URL of the PDF document

pdftitle +

Sets the document information Title field

+

Sets the document information Author field

+

Sets the document information Subject field

+

Sets the document information Creator field

+

Sets the document information Keywords field

+

Sets the default PDF ‘view’ for each link

class="td01">pdfstartview +

Set the startup page view

+

Set the startup page view of remote PDF files

class="td01">pdfpagescrop @@ -2552,22 +2592,22 @@ class="ec-lmvtt-10">R2L (right to left) class="td01">pdfdisplaydoctitle +

resize document window to fit document size

+

PDF language identifier (RFC 3066)

+

make PDF viewer’s menu bar visible

class="td01">pdfnumcopies +

number of printed copies

+

set PDF page labels

@@ -2718,11 +2758,11 @@ class="td10"> class="td01">pdfprintarea class="td01">pdfprintclip class="td01">pdfprintpagerange +

set /PrintPageRange of viewer preferences

class="td01">pdftoolbar +

make PDF toolbar visible

class="td01">pdfviewclip class="td01">pdfwindowui +

make PDF user interface elements visible

+

Unicode encoded PDF strings

@@ -2862,11 +2902,11 @@ class="td11">
-

URL

URL

-

Sets the base URL of the PDF document

pdfpagemode -

name

name

empty -

Determines how the file is opening in +

Determines how the file is opening in Acrobat; the possibilities are UseNone, UseOutlines is used.

-

text

text

-

Sets the document information Title field

pdfauthor -

text

text

-

Sets the document information Author field

pdfsubject -

text

text

-

Sets the document information Subject field

pdfcreator -

text

text

-

Sets the document information Creator field

addtopdfcreator -

text

text

-

Adds additional text to the document +

Adds additional text to the document information Creator field

pdfkeywords -

text

text

-

Sets the document information Keywords field

pdftrapped -

name

name

empty -

Sets the document information Trapped entry. +

Sets the document information Trapped entry. Possible values are True, False and Unknown. class="td01">pdfinfo

-

key +

key value list

empty -

Alternative interface for setting the document +

Alternative interface for setting the document information.

pdfview -

name

name

XYZ -

Sets the default PDF ‘view’ for each link

pdfstartpage -

integer

integer

1 -

Determines on which page the PDF file is +

Determines on which page the PDF file is opened. An empty value means, the entry is not set.

-

name

name

Fit -

Set the startup page view

pdfremotestartview -

name

name

Fit -

Set the startup page view of remote PDF files

-

n +

n n n n

-

Sets the default PDF crop box for pages. This +

Sets the default PDF crop box for pages. This should be a set of four numbers

pdfcenterwindow -

boolean

boolean

false -

position the document window in the center +

position the document window in the center of the screen

pdfdirection -

name

name

empty -

direction setting. Possible values:

direction setting. Possible values: L2R (left to right) and R2L (right to left)

-

boolean

boolean

false -

display document title instead of file name in +

display document title instead of file name in title bar

pdfduplex -

name

name

empty -

paper handling option for print +

paper handling option for print dialog. Possible vatues are: Simplex (print single-sided), DuplexFlipLongEdge (duplex and flip on class="td01">pdffitwindow

-

boolean

boolean

false -

resize document window to fit document size

pdflang -

name

name

relax -

PDF language identifier (RFC 3066)

pdfmenubar -

boolean

boolean

true -

make PDF viewer’s menu bar visible

pdfnewwindow -

boolean

boolean

false -

make links that open another PDF file start a +

make links that open another PDF file start a new window

pdfnonfullscreenpagemode -

name

name

empty -

page mode setting on exiting full-screen mode. +

page mode setting on exiting full-screen mode. Possible values are UseNone, UseOutlines, @@ -2638,21 +2678,21 @@ class="ec-lmvtt-10">UseOC

-

integer

integer

empty -

number of printed copies

pdfpagelayout -

name

name

empty -

set layout of PDF pages. Possible values: +

set layout of PDF pages. Possible values: SinglePage, OneColumn, TwoPageRight class="td01">pdfpagelabels

-

boolean

boolean

true -

set PDF page labels

pdfpagetransition -

name

name

empty -

set PDF page transition style. Possible values +

set PDF page transition style. Possible values are Split, Blinds, R, which simply replaces the old page w class="td01">pdfpicktraybypdfsize

-

boolean

boolean

false -

specify whether PDF page size is used to select +

specify whether PDF page size is used to select input paper tray in print dialog

-

name

name

empty -

set /PrintArea of viewer preferences. Possible +

set /PrintArea of viewer preferences. Possible values are MediaBox, CropBox, CropBox

-

name

name

empty -

set /PrintClip of viewer preferences. Possible +

set /PrintClip of viewer preferences. Possible values are MediaBox, CropBox, CropBox

-

n +

n n (n n)*

empty -

set /PrintPageRange of viewer preferences

pdfprintscaling -

name

name

empty -

page scaling option for print dialog (option +

page scaling option for print dialog (option /PrintScaling of viewer preferences, PDF 1.6); valid values are None and AppDefault

-

boolean

boolean

true -

make PDF toolbar visible

pdfviewarea -

name

name

empty -

set /ViewArea of viewer preferences. Possible +

set /ViewArea of viewer preferences. Possible values are MediaBox, CropBox, CropBox

-

name

name

empty -

set /ViewClip of viewer preferences Possible +

set /ViewClip of viewer preferences Possible values are MediaBox, CropBox, CropBox

-

boolean

boolean

true -

make PDF user interface elements visible

unicode -

boolean

boolean

true -

Unicode encoded PDF strings

-

Each link in Acrobat carries its own magnification level, which is set using PDF coordinate space, which +

Each link in Acrobat carries its own magnification level, which is set using PDF coordinate space, which is not the same as TeX’s. The unit is bp and the origin is in the lower left corner. See also \hypercalcbp that is explained on page 60. pdfTeX works by supplying default values for 61. pdfTeX works by supplying default values for XYZ (horizontal × vertical pdfview, pdfstartview and pdfremotestartview parameters. -

+

XYZ +

Fits the page to the window.

+

Fits the width of the page to the window.

+

Fits the height of the page to the window.

+

Fits the page bounding box to the window.

left top zoom -

Sets a coordinate and a zoom factor. If any one +

Sets a coordinate and a zoom factor. If any one is null, the source link value is used. null null Fit

-

Fits the page to the window.

FitH top -

Fits the width of the page to the window.

FitV left -

Fits the height of the page to the window.

FitR left bottom right top -

Fits the rectangle specified by the four +

Fits the rectangle specified by the four coordinates to the window.

FitB -

Fits the page bounding box to the window.

FitBH top -

Fits the width of the page bounding box to +

Fits the width of the page bounding box to the window.

FitBV left -

Fits the height of the page bounding box to +

Fits the height of the page bounding box to the window.

-

The

The pdfpagelayout can be one of the following values. -

+

class="td01">SinglePage +

Displays a single page; advancing flips the page

+

Displays the document in one column; continuous scrolling.

class="td01">
-

Displays a single page; advancing flips the page

OneColumn -

Displays the document in one column; continuous scrolling.

TwoColumnLeft -

Displays the document in two columns, odd-numbered pages to +

Displays the document in two columns, odd-numbered pages to the left.

TwoColumnRight -

Displays the document in two columns, odd-numbered pages to +

Displays the document in two columns, odd-numbered pages to the right.

TwoPageLeft -

Displays two pages, odd-numbered pages to the left (since PDF +

Displays two pages, odd-numbered pages to the left (since PDF 1.5).

TwoPageRight -

Displays two pages, odd-numbered pages to the right (since PDF +

Displays two pages, odd-numbered pages to the right (since PDF 1.5).

-

Finally, the

Finally, the pdfpagetransition can be one of the following values, where /Di stands for direction of motion in degrees, generally in 90Blinds /Dm /V), and /M is for motion, either in (/I) or out (/O). -

+

Blinds +

A box sweeps in or out.

Dissolve +

Two lines sweep across the screen to reveal the new page.

+

Simply replaces the old page with the new one.

Push Cover Fade
/Dm -

Multiple lines distributed evenly across the screen sweep +

Multiple lines distributed evenly across the screen sweep in the same direction to reveal the new page.

Box /M -

A box sweeps in or out.

-

The page image dissolves in a piecemeal fashion to reveal +

The page image dissolves in a piecemeal fashion to reveal the new page.

Glitter /Di -

Similar to Dissolve, except the effect sweeps across the +

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 +

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 +

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.

/Di -

The old page slides off the screen while the new page +

The old page slides off the screen while the new page slides in, pushing the old page out in the direction specified by /Di.

/Di -

The new page slides on to the screen in the direction +

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 +

The old page slides off the screen in the direction specified by /Di, uncovering the new page in the direction specified by /Di.

-

The new page gradually becomes visible through the old +

The new page gradually becomes visible through the old one.

-

+

5.8 Option pdfinfo

-

The information entries can be set using

The information entries can be set using pdftitle, pdfsubject, …. Option pdfinfo provides an alternative @@ -3206,15 +3246,15 @@ strings (see PDF specification). Example:   } } -

-

+

+

5.9 Big alphabetical list

-

The following is a complete listing of available options for

The following is a complete listing of available options for hyperref, arranged alphabetically. -

+

allbordercolors +

Set all border color options

+

set color of anchors, ignored by most drivers.

+

do bibliographical back references

+

set base URL for document

+

make bookmarks

+

put section numbers in bookmarks

+

open up bookmark tree

+

level to which bookmarks are open

+

to specify which ‘toc’ file to mimic

+

allow links to break over lines

+

to produce CJK bookmarks

+

color of border around cites

+

color of citation links

+

color links

debug @@ -3366,7 +3406,7 @@ class="ec-lmvtt-10">destlabel draft +

do not do any hyperlinking

+

default if no driver specified or detected

+

to set encap character for hyperindex

+

suffix of linked files

+

color of border around file links

+

color of file links

+

opposite of option draft

+

use small caps instead of color for links

+

Hide links (removing color and border)

+

make figures hyper links

+

set up hyperlinked footnotes

+

set up hyperlinked indices

+

use guessable names for links

+

redefine LaTeX internals

+

color of border around links

+

color of links

+

make text be link on TOC, LOF and LOT

+

color of border around menu links

+

color for menu links

+

use LaTeX-computed names for links

nesting +

allow nesting of links

+

allow to set the name of the next anchor

+

put an anchor on every page

+

backreference by page number

+

text for PDF Author field

+

width of PDF link border

+

border style for links

+

text for PDF Creator field

+

+

direction setting

+

paper handling option for print dialog

+

resize document window to fit document size

+

set highlighting of PDF links

+

text for PDF Keywords field

+

PDF language identifier (RFC 3066)

+

make PDF viewer’s menu bar visible

+

make links that open another PDF

+

file start a new window

+

page mode setting on exiting full-screen mode

+

number of printed copies

+

set PDF page labels

+

set layout of PDF pages

+

set default mode of PDF display

+

set crop size of PDF document

pdfpagetransition +

set PDF page transition style

+

set option for print dialog

+

set /PrintArea of viewer preferences

+

set /PrintClip of viewer preferences

+

set /PrintPageRange of viewer preferences

+

page scaling option for print dialog

+

text for PDF Producer field

+

starting view of remote PDF documents

+

page at which PDF document opens

+

starting view of PDF document

+

text for PDF Subject field

+

text for PDF Title field

+

make PDF toolbar visible

+

PDF ‘view’ when on link traversal

+

set /ViewArea of viewer preferences

+

set /ViewClip of viewer preferences

+

make PDF user interface elements visible

+

do page number anchors as plain Arabic

+

color of border around ‘run’ links

+

color of ‘run’ links

+

set page size by special driver commands

@@ -4075,7 +4115,7 @@ class="ec-lmvtt-10">unicode +

color of border around URL links

+

color of URL links

+

be chatty

-

Set all border color options

allcolors -

Set all color options (without border and field +

Set all color options (without border and field options)

anchorcolor black -

set color of anchors, ignored by most drivers.

backref false -

do bibliographical back references

baseurl empty -

set base URL for document

bookmarks true -

make bookmarks

bookmarksnumbered false -

put section numbers in bookmarks

bookmarksopen false -

open up bookmark tree

bookmarksopenlevel \maxdimen -

level to which bookmarks are open

bookmarkstype toc -

to specify which ‘toc’ file to mimic

breaklinks false -

allow links to break over lines

CJKbookmarks false -

to produce CJK bookmarks

citebordercolor 0 1 0 -

color of border around cites

citecolor green -

color of citation links

colorlinks false -

color links

true -

(

(tex4ht, dviwindo)

false -

provide details of anchors defined; same as +

provide details of anchors defined; same as verbose

false -

destinations are named by the first

destinations are named by the first \label after the anchor creation

false -

do not do any hyperlinking

driverfallback -

default if no driver specified or detected

dvipdfm -

use

use dvipdfm backend

dvipdfmx -

use

use dvipdfmx backend

dvips -

use

use dvips backend

dvipsone -

use

use dvipsone backend

dviwindo -

use

use dviwindo backend

encap -

to set encap character for hyperindex

extension dvi -

suffix of linked files

filebordercolor 0 .5 .5 -

color of border around file links

filecolor cyan -

color of file links

final true -

opposite of option draft

frenchlinks false -

use small caps instead of color for links

hidelinks -

Hide links (removing color and border)

hyperfigures false -

make figures hyper links

hyperfootnotes true -

set up hyperlinked footnotes

hyperindex true -

set up hyperlinked indices

hypertex -

use

use HyperTeX backend

hypertexnames true -

use guessable names for links

implicit true -

redefine LaTeX internals

latex2html -

use

use LaTeX2HTML backend

linkbordercolor 1 0 0 -

color of border around links

linkcolor red -

color of links

linktoc section -

make text be link on TOC, LOF and LOT

linktocpage false -

make page number, not text, be link on TOC, +

make page number, not text, be link on TOC, LOF and LOT

menubordercolor 1 0 0 -

color of border around menu links

menucolor red -

color for menu links

nativepdf false -

an alias for

an alias for dvips

naturalnames false -

use LaTeX-computed names for links

false -

allow nesting of links

next-anchor -

allow to set the name of the next anchor

pageanchor true -

put an anchor on every page

pagebackref false -

backreference by page number

pdfauthor empty -

text for PDF Author field

pdfborder 0 0 1 -

width of PDF link border

0 0 0 -

(

(colorlinks)

pdfborderstyle -

border style for links

pdfcenterwindow false -

position the document window in the center +

position the document window in the center of the screen

pdfcreator LaTeX with -

text for PDF Creator field

hyperref -

pdfdirection empty -

direction setting

pdfdisplaydoctitle false -

display document title instead of file name in +

display document title instead of file name in title bar

pdfduplex empty -

paper handling option for print dialog

pdffitwindow false -

resize document window to fit document size

pdfhighlight /I -

set highlighting of PDF links

pdfinfo empty -

alternative interface for setting document +

alternative interface for setting document information

pdfkeywords empty -

text for PDF Keywords field

pdflang relax -

PDF language identifier (RFC 3066)

pdfmark false -

an alias for

an alias for dvips

pdfmenubar true -

make PDF viewer’s menu bar visible

pdfnewwindow false -

make links that open another PDF

-

file start a new window

pdfnonfullscreenpagemode empty -

page mode setting on exiting full-screen mode

pdfnumcopies empty -

number of printed copies

pdfpagelabels true -

set PDF page labels

pdfpagelayout empty -

set layout of PDF pages

pdfpagemode empty -

set default mode of PDF display

pdfpagescrop empty -

set crop size of PDF document

empty -

set PDF page transition style

pdfpicktraybypdfsize empty -

set option for print dialog

pdfprintarea empty -

set /PrintArea of viewer preferences

pdfprintclip empty -

set /PrintClip of viewer preferences

pdfprintpagerange empty -

set /PrintPageRange of viewer preferences

pdfprintscaling empty -

page scaling option for print dialog

pdfproducer empty -

text for PDF Producer field

pdfremotestartview Fit -

starting view of remote PDF documents

pdfstartpage 1 -

page at which PDF document opens

pdfstartview Fit -

starting view of PDF document

pdfsubject empty -

text for PDF Subject field

pdftex -

use

use pdfTeX backend

pdftitle empty -

text for PDF Title field

pdftoolbar true -

make PDF toolbar visible

pdftrapped empty -

Sets the document information Trapped entry. +

Sets the document information Trapped entry. Possible values are True, False and pdfview

XYZ -

PDF ‘view’ when on link traversal

pdfviewarea empty -

set /ViewArea of viewer preferences

pdfviewclip empty -

set /ViewClip of viewer preferences

pdfwindowui true -

make PDF user interface elements visible

plainpages false -

do page number anchors as plain Arabic

ps2pdf -

use

use ps2pdf backend

psdextra false -

define more short names for PDF string +

define more short names for PDF string commands

raiselinks false -

raise up links (for

raise up links (for HyperTeX backend)

runbordercolor 0 .7 .7 -

color of border around ‘run’ links

runcolor filecolor -

color of ‘run’ links

setpagesize true -

set page size by special driver commands

tex4ht -

use

use TeX4ht backend

textures -

use

use Textures backend

true -

Unicode encoded pdf strings, starting with +

Unicode encoded pdf strings, starting with version v7.00g set by default to true for all engines. It will load a number of definitions in puenc.def. It can be set to false for pdflatex, @@ -4087,7 +4127,7 @@ class="ec-lmvtt-10">urlbordercolor

0 1 1 -

color of border around URL links

urlcolor magenta -

color of URL links

verbose false -

be chatty

vtex -

use

use VTeX backend

xetex -

use

use XeTeX backend

-

+

6 Additional user macros

-

If you need to make references to URLs, or write explicit links, the following low-level user macros are +

If you need to make references to URLs, or write explicit links, the following low-level user macros are provided: -

}{text}
-

The

The text is made a hyperlink to the URL; this must be a full URL (relative to the base URL, if that is defined). The special characters # and % do not need to be escaped in any way (unless the command is used in the argument of another command). -

The optional argument

The optional argument options recognizes the hyperref options pdfremotestartview, pdfnewwindow and the following key value options:

-

+

page:

-

Specifies the start page number of remote PDF documents. First page is

Specifies the start page number of remote PDF documents. First page is 1.

-

+

ismap:

-

Boolean key, if set to

Boolean key, if set to true, the URL should appended by the coordinates as query parameters by the PDF viewer.

-

+

nextactionraw:

-

The value of key

The value of key /Next of action dictionaries, see PDF specification.

-

\url{URL}
-

Similar to

Similar to \href{URLURL}}. Depending on the driver \href also tries to detect the link type. Thus the result can be a url link, file link, … -

\nolinkurl{URL}
-

Write

Write URL in the same way as \url, without creating a hyperlink. -

{URL}
-

A base

A base URL is established, which is prepended to other specified URLs, to make it easier to write portable documents. -

}{text}
-

The link to the image referenced by the URL is inserted, using

The link to the image referenced by the URL is inserted, using text as the anchor. -

For drivers that produce HTML, the image itself is inserted by the browser, with the

For drivers that produce HTML, the image itself is inserted by the browser, with the text being ignored completely. -

}{text}
-

A target area of the document (the

A target area of the document (the text) is marked, and given the name category.name -

}{text}
-

text is made into a link to URL#category.name -

]{text}
-

text is made into a link to the same place as \ref{label} would be linked. -

}{text}
-

}{text}
-

A simple internal link is created with

A simple internal link is created with \hypertarget, with two parameters of an anchor name, and anchor \hyperlink has two arguments, the name class="ec-lmvtt-10">\hypertarget, and the text which be used as the link on the page. -

Note that in HTML parlance, the

Note that in HTML parlance, the \hyperlink command inserts a notional # in front of each link, making it relative to the current testdocument; \href expects a full URL. -

\phantomsection
-

This sets an anchor at this location. It works similar to

This sets an anchor at this location. It works similar to \hypertarget{}{} with an automatically chosen anchor name. Often it is used in conjunction with \addcontentsline for sectionlike things (index, @@ -4383,10 +4423,10 @@ Example: \addcontentsline{toc}{chapter}{\indexname} \printindex -

-

Now the entry in the table of contents (and bookmarks) for the index points to the start of the index page, +

+

Now the entry in the table of contents (and bookmarks) for the index points to the start of the index page, not to a location before this page. -

}{label}
-

This retrieves the anchor or the page anchor from a label in an expandable way. It takes +

This retrieves the anchor or the page anchor from a label in an expandable way. It takes \HyperDestNameFilter into account. It can e.g. be used with the \bookmark from the bookmark @@ -4415,12 +4455,12 @@ package to set a destination to a label: 

 \bookmark[dest=\hyperget{anchor}{sec}]{section}
-

-

As

+

As pageanchor retrieves the page number from the label it can’t be use together with the option plainpages. -

{currentanchor}{}
-

This retrieves the last anchor that has been set. It too takes

This retrieves the last anchor that has been set. It too takes \HyperDestNameFilter into account. -

\autoref class="ec-lmvtt-10">{label}
-

This is a replacement for the usual

This is a replacement for the usual \ref command that places a contextual label in front of the reference. This gives your users a bigger target to click for hyperlinks (e.g. ‘section 2’ instead of merely the number ‘2’). -

The label is worked out from the context of the original

The label is worked out from the context of the original \label command by hyperref by using the macros listed below (shown with their default values). The macros can be (re)defined in documents using @@ -4456,16 +4496,16 @@ macros listed below (shown with their default values). The macros can be (re)def class="ec-lmvtt-10">\(re)newcommand; note that some of these macros are already defined in the standard document classes. The mixture of lowercase and uppercase initial letters is deliberate and corresponds to the author’s practice. -

For each macro below,

For each macro below, hyperref checks \*autorefname before \*name. For instance, it looks for \figureautorefname before \figurename. -

+

class="td01">Macro +

Figure

+

Table

+

Part

+

Appendix

+

Equation

+

item

+

chapter

+

section

+

subsection

+

subsubsection

+

paragraph

+

footnote

class="td01">\AMSname +

Equation

+

Theorem

+

page

@@ -4586,7 +4626,7 @@ class="td01"> class="td01">
-

Default

\figurename -

Figure

\tablename -

Table

\partname -

Part

\appendixname -

Appendix

\equationname -

Equation

\Itemname -

item

\chaptername -

chapter

\sectionname -

section

\subsectionname -

subsection

\subsubsectionname -

subsubsection

\paragraphname -

paragraph

\Hfootnotename -

footnote

-

Equation

\theoremname -

Theorem

\page -

page

-

Example for a redefinition if

Example for a redefinition if babel is used:

@@ -4597,8 +4637,8 @@ class="ec-lmss-10">babel is used:   \def\subsectionautorefname{Unterkapitel}% } -

-

Hint:

+

Hint: \autoref works via the counter name that the reference is based on. Sometimes \autoref chooses the wrong name, if the counter is used for different things. For example, it happens with @@ -4638,8 +4678,8 @@ We will use \autoref{a} to prove \auto \end{document} -

-

+

{label}
-

It replaces

It replaces \pageref and adds the name for page in front of the page reference. First \pageautorefname is checked before \pagename. -

For instances where you want a reference to use the correct counter, but not to create a +

For instances where you want a reference to use the correct counter, but not to create a link, there are starred forms (these starred forms exist even if hyperref has been loaded with implicit=false): -

\ref*{label}
-

{label}
-

\autoref*{label}
-

{label}
-

A typical use would be to write +

A typical use would be to write 

 \hyperref[other]{that nice section (\ref*{other}) we read before}
-

-

We want

+

We want \ref*{other} to generate the correct number, but not to form a link, since we do this ourselves with \hyperref. -

}{TeXstring}
-

\pdfstringdef returns a macro containing the PDF string. (Currently this is done globally, but do not rely on it.) All the following tasks, definitions and redefinitions are made in a group to keep them local:

-

In addition, parentheses are protected to avoid the danger of unsafe unbalanced parentheses in +

In addition, parentheses are protected to avoid the danger of unsafe unbalanced parentheses in the PDF string. For further details, see Heiko Oberdiek’s EuroTeX paper distributed with hyperref. -

{NoHyper}…\end{NoHyper}
-

Sometimes we just don’t want the wretched package interfering with us. Define an environment we +

Sometimes we just don’t want the wretched package interfering with us. Define an environment we can put in manually, or include in a style file, which stops the hypertext functions doing anything. This is used, for instance, in the Elsevier classes, to stop hyperref playing havoc in the front matter. -

+

6.1 Bookmark macros

-

+

6.1.1 Setting bookmarks
-

Usually

Usually hyperref automatically adds bookmarks for \section and similar macros. But they can also set manually. -

}{name}
-

creates a bookmark with the specified text and at the given level (default is 0). As name for the +

creates a bookmark with the specified text and at the given level (default is 0). As name for the internal anchor name is used (in conjunction with level). Therefore the name must be unique (similar to \label). -

}{name}
-

creates a bookmark at the current level. -

creates a bookmark at the current level. +

}{name}
-

creates a bookmark one step down in the bookmark hierarchy. Internally the current level is increased +

creates a bookmark one step down in the bookmark hierarchy. Internally the current level is increased by one. -

}{name}
-

creates a bookmark below the current bookmark level. However after the command the current +

creates a bookmark below the current bookmark level. However after the command the current bookmark level has not changed. -

Hint: Package bookmark replaces hyperref’s bookmark organization by a new algorithm:

-

Therefore I recommend using this package. -

+

Different bookmark actions are supported (external file links, URLs, …). +

Therefore I recommend using this package. +

6.1.2 Replacement macros
-

hyperref takes the text for bookmarks from the arguments of commands like \section, which can contain things like math, colors, or font changes, none of which will display in bookmarks as is. -

}{PDFstring}
-

For example, +

For example, 

@@ -4920,8 +4960,8 @@ class="ec-lmvtt-10">}  
 }
 \section{\texorpdfstring{\textcolor{red}}{}{Red} Mars}
-

-

+

\pdfstringdef executes the hook before it expands the string. Therefore, you can use this hook to perform additional tasks or to disable additional commands. @@ -4933,8 +4973,8 @@ perform additional tasks or to disable additional commands.   \renewcommand{\mycommand}[1]{}% } -

-

However, for disabling commands, an easier way is via

+

However, for disabling commands, an easier way is via \pdfstringdefDisableCommands, which adds its argument to the definition of \pdfstringdefPreHook (‘@’ can here be used as letter in command @@ -4948,11 +4988,11 @@ names):   \let\textcolor\@gobble } -

-

+

+

6.2 Pagelabels

-

{page number format}
-

This allows to change format of the page number shown in the tool bar of a PDF viewer for a specific +

This allows to change format of the page number shown in the tool bar of a PDF viewer for a specific page, for example -

\thispdfpagelabel{Empty Page-\roman{page}} -

The command affects the page on which it is executed, so asynchronous page breaking should be +

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 \thispagestyle can be use too. -

+

6.3 Utility macros

-

{dimen specification}
-

\hypercalcbp takes a TeX dimen specification and converts it to bp and returns the number without the unit. This is useful for options pdfview, -

-

The origin of the PDF coordinate system is the lower left corner. -

Note, for calculations you need either package

+

The origin of the PDF coordinate system is the lower left corner. +

Note, for calculations you need either package calc or ε-TEX. Nowadays the latter should automatically be enabled for LATEX formats. Users without ε-TEX, please, look in the source documentation hyperref.dtx for further limitations. -

Also

Also \hypercalcbp cannot be used in option specifications of \documentclass and \usepackage, because LATEX expands the option lists of these commands. However package hyperref is not yet loaded and an undefined control sequence error would arise. -

+

7 New Features5

7.1 Option ‘pdflinkmargin’

-

Option ‘pdflinkmargin’ is an experimental option for specifying a link margin, if the driver supports this. +

Option ‘pdflinkmargin’ is an experimental option for specifying a link margin, if the driver supports this. Default is 1 pt for supporting drivers. -

+

-

+

pdfTeX

-

+

  • -

    The link area also depends on the surrounding box. +

    The link area also depends on the surrounding box.

  • -

    Settings have local effect. +

    Settings have local effect.

  • -

    When a page is shipped out, pdfTeX uses the current setting of the link margin for all +

    When a page is shipped out, pdfTeX uses the current setting of the link margin for all links on the page.

-

+

pdfmark

-

+

  • -

    Settings have global effect.

+

Settings have global effect.

-

+

xetex

-

+

  • -

    Settings must be done in the preamble or the first page and then have global effect. +

    Settings must be done in the preamble or the first page and then have global effect. The key inserts the new (x)dvipdfmx special \special{dvipdfmx:config g #1} (with the unit removed).

-

+

Other drivers

-

Unsupported.

-

+

Unsupported. +

7.2 Field option ‘calculatesortkey’

-

Fields with calculated values are calculated in document order by default. If calculated field values +

Fields with calculated values are calculated in document order by default. If calculated field values depend on other calculated fields that appear later in the document, then the correct calculation order can be specified with option ‘calculatesortkey’. Its value is used as key to lexicographically sort the calculated fields. The sort key do not need to be unique. Fields that share the same key are sorted in document order. -

Currently the field option ‘calculatesortkey’ is only supported by the driver for pdfTeX. -

+

Currently the field option ‘calculatesortkey’ is only supported by the driver for pdfTeX. +

7.3 Option ‘next-anchor’

-

This option allows to overwrite the anchor name of the next anchor. This makes it possible to give for +

This option allows to overwrite the anchor name of the next anchor. This makes it possible to give for example the heading of the table of contents an anchor name which can be referenced with a bookmark command. @@ -5096,14 +5136,14 @@ command. \tableofcontents \bookmark[dest=\HyperDestNameFilter{toc},level=section]{\contentsname} -

-

+

+

7.4 Option ‘localanchorname’

-

WhenDeprecated 2022-04-27 v7.00o an anchor is set (e.g. via

WhenDeprecated 2022-04-27 v7.00o an anchor is set (e.g. via \refstepcounter, then the anchor name is globally set to the current anchor name. -

For example: +

For example: 

@@ -5111,28 +5151,28 @@ globally set to the current anchor name.
     \begin{equation}\end{equation}
     \label{sec:foobar}
-

With the default global setting (localanchorname=false) a reference to ‘sec:foobar’ jumps to the +

With the default global setting (localanchorname=false) a reference to ‘sec:foobar’ jumps to the equation before. With option ‘localanchorname’ the anchor of the equation is forgotten after the environment and the reference ‘sec:foobar’ jumps to the section title. -

Option ‘localanchorname’ is an experimental option, there might be situations, where the anchor +

Option ‘localanchorname’ is an experimental option, there might be situations, where the anchor name is not available as expected. -

The option is deprecated: it makes it difficult for package authors to add targets for links if it is +

The option is deprecated: it makes it difficult for package authors to add targets for links if it is unclear if \@currentHref is set locally or globally. -

+

7.5 Option ‘customdriver’

-

The value of option ‘customdriver’ is the name of an external driver file without extension ‘.def’. The file +

The value of option ‘customdriver’ is the name of an external driver file without extension ‘.def’. The file must have \ProvidesFile with a version date and number that match the date and number of ‘hyperref’, otherwise a warning is given. -

Because the interface, what needs to be defined in the driver, is not well defined and +

Because the interface, what needs to be defined in the driver, is not well defined and quite messy, the option is mainly intended to ease developing, testing, debugging the driver part. -

+

7.6 Option ‘psdextra’

-

LaTeX’s NFSS is used to assist the conversion of arbitrary TeX strings to PDF strings (bookmarks, PDF +

LaTeX’s NFSS is used to assist the conversion of arbitrary TeX strings to PDF strings (bookmarks, PDF information entries). Many math command names (\geq, \notin, ...) are not in control of NFSS, @@ -5146,17 +5186,17 @@ on means that the short names are available. Then \geq can directly be used instead of \textgeq. -

+

7.7 \XeTeXLinkBox

-

When XeTeX generates a link annotation, it does not look at the boxes (as the other drivers), but only +

When XeTeX generates a link annotation, it does not look at the boxes (as the other drivers), but only at the character glyphs. If there are no glyphs (images, rules, ...), then it does not generate a link annotation. Macro \XeTeXLinkBox puts its argument in a box and adds spaces at the lower left and upper right corners. An additional margin can be specified by setting it to the dimen register \XeTeXLinkMargin. The default is 2pt. -

Example: +

Example: 

@@ -5173,8 +5213,8 @@ class="ec-lmvtt-10">\XeTeXLinkMargin. The default is 2pt.
     }
     \end{document}
-

-

+

+

7.8 \IfHyperBooleanExists and \IfHyperBoolean

@@ -5182,7 +5222,7 @@ class="ec-lmvtt-10">\XeTeXLinkMargin. The default is 2pt. 
  \IfHyperBooleanExists{OPTION}{YES}{NO}
-

If a hyperref OPTION is a boolean, that means it takes values ‘true’ or ‘false’, then

If a hyperref OPTION is a boolean, that means it takes values ‘true’ or ‘false’, then \IfHyperBooleanExists calls YES, otherwise NO. @@ -5190,23 +5230,23 @@ calls YES, otherwise NO. 

  \IfHyperBoolean{OPTION}{YES}{NO}
-

Macro

Macro \IfHyperBoolean calls YES, if OPTION exists as boolean and is enabled. Otherwise NO is executed. -

Both macros are expandable. Additionally option ‘stoppedearly’ is available. It is enabled if +

Both macros are expandable. Additionally option ‘stoppedearly’ is available. It is enabled if \MaybeStopEarly or \MaybeStopNow end hyperref prematurely. -

+

7.9 \unichar

-

If a Unicode character is not supported by puenc.def, it can be given by using

If a Unicode character is not supported by puenc.def, it can be given by using \unichar. Its name and syntax is inherited from package ‘ucs’. However it is defined independently for use in hyperref’s \pdfstringdef (that converts arbitrary TeX code to PDF strings or tries to do this). -

Macro

Macro \unichar takes a TeX number as argument, examples for U+263A (WHITE SMILING FACE): @@ -5215,7 +5255,7 @@ FACE):     \unichar{"263A}% hexadecimal notation     \unichar{9786}% decimal notation -

‘"’ must not be a babel shorthand character or otherwise active. Otherwise prefix it with +

‘"’ must not be a babel shorthand character or otherwise active. Otherwise prefix it with \string: @@ -5223,18 +5263,18 @@ class="ec-lmvtt-10">\string: 

     \unichar{\string"263A}% converts ‘"’ to ‘"’ with catcode 12 (other)
-

Users of (n)german packages or babel options may use

Users of (n)german packages or babel options may use \dq instead: 

     \unichar{\dq 263A}% \dq is double quote with catcode 12 (other)
-

-

+

+

7.10 \ifpdfstringunicode

-

Some features of the PDF specification needs PDF strings. Examples are bookmarks or the entries in the +

Some features of the PDF specification needs PDF strings. Examples are bookmarks or the entries in the information dictionary. The PDF specification allows two encodings ‘PDFDocEncoding’ (8-bit encoding) and ‘Unicode’ (UTF-16). The user can help using \texorpdfstring to replace complicate TeX constructs @@ -5245,7 +5285,7 @@ class="ec-lmvtt-10">\ifpdfstringunicode. It is only allowed class="ec-lmvtt-10">\texorpdfstring and takes two arguments, the first allows the full range of Unicode. The second is limited to the characters available in PDFDocEncoding. -

As example we take a macro definition for the Vietnamese name of Hàn Thế Thành. Correctly written +

As example we take a macro definition for the Vietnamese name of Hàn Thế Thành. Correctly written it needs some accented characters, one character even with a double accent. Class ‘tugboat.cls’ defines a macro for the typesetted name: @@ -5257,9 +5297,9 @@ macro for the typesetted name:       ~Th\‘anh%     } -

It’s not entirely correct, the second accent over the ‘e’ is not an acute, but a hook. However standard +

It’s not entirely correct, the second accent over the ‘e’ is not an acute, but a hook. However standard LaTeX does not provide such an accent. -

Now we can extend the definition to support hyperref. The first and the last word are already +

Now we can extend the definition to support hyperref. The first and the last word are already supported automatically. Characters with two or more accents are a difficult business in LaTeX, because the NFSS2 macros of the LaTeX kernel do not support more than one accent. Therefore also puenc.def misses support for them. But we can provide it using     % U+1EC3 LATIN SMALL LETTER E WITH CIRCUMFLEX AND HOOK ABOVE -

Thus we can put this together: +

Thus we can put this together: 

@@ -5281,7 +5321,7 @@ is:
       ~Th\‘anh%
     }
-

For PDFDocEncoding (PD1) the variant above has dropped the second accent. Alternatively we could +

For PDFDocEncoding (PD1) the variant above has dropped the second accent. Alternatively we could provide a representation without accents instead of wrong accents: @@ -5300,12 +5340,12 @@ provide a representation without accents instead of wrong accents:       }%     } -

-

+

+

7.11 Customizing index style file with \nohyperpage

-

Since version 2008/08/14 v6.78f. -

For hyperlink support in the index, hyperref inserts

Since version 2008/08/14 v6.78f. +

For hyperlink support in the index, hyperref inserts \hyperpage into the index macros. After processing with Makeindex, \hyperpage analyzes its argument to detect page ranges and page comma @@ -5316,7 +5356,7 @@ lists. However, only the standard settings are supported directly:     delim_r "--"     delim_n ", " -

(See manual page/documentation of Makeindex that explains the keys that can be used in style files for +

(See manual page/documentation of Makeindex that explains the keys that can be used in style files for Makeindex.) Customized versions of delim_r, delim_n, -

(Depending on the typesetting tradition some space “

(Depending on the typesetting tradition some space “\\,” or “~” should be put before the first f inside \nohyperpage.) -

+

7.12 Experimental option ‘ocgcolorlinks’

-

The idea are colored links, when viewed, but printed without colors. This new experimental option +

The idea are colored links, when viewed, but printed without colors. This new experimental option ‘ocgcolorlinks’ uses Optional Content Groups, a feature introduced in PDF 1.5. -

A better implementation which hasn’t the disadvantage to prevent line breaks is in the ocgx2 +

A better implementation which hasn’t the disadvantage to prevent line breaks is in the ocgx2 package. Check its documentation for details how to use it.

-

+

7.13 Option ‘pdfa’

-

The new option ‘pdfa’ tries to avoid violations of PDF/A in code generated by hyperref. However, the +

The new option ‘pdfa’ tries to avoid violations of PDF/A in code generated by hyperref. However, the result is usually not in PDF/A, because many features aren’t controlled by hyperref (XMP metadata, fonts, colors, driver dependend low level stuff, ...). -

Currently, option ‘pdfa’ sets and disables the following items: +

Currently, option ‘pdfa’ sets and disables the following items:

-

The default value of the new option ‘pdfa’ is ‘false’. It influences the loading of the package and +

The default value of the new option ‘pdfa’ is ‘false’. It influences the loading of the package and cannot be changed after hyperref is loaded (\usepackage{hyperref}). -

+

7.14 Option ‘linktoc’ added

-

The new option ‘linktoc’ allows more control which part of an entry in the table of contents is made into +

The new option ‘linktoc’ allows more control which part of an entry in the table of contents is made into a link:

-

+

‘linktoc=all’ (both the section and page part are links) +

7.15 Option ‘pdfnewwindow’ changed

-

Before 6.77b: +

Before 6.77b:

-

Since 6.77b: +

Since 6.77b:

-

Rationale: There is a difference between setting to ‘false’ and an absent entry. In the former case the +

Rationale: There is a difference between setting to ‘false’ and an absent entry. In the former case the new document replaces the old one, in the latter case the PDF viewer application should respect the user preference. -

+

7.16 Flag options for PDF forms

-

PDF form field macros (

PDF form field macros (\TextField, \CheckBox, ...) support boolean flag options. The option name is the lowercase version of the names in the PDF specification (1.7): -

http://www.adobe.com/devnet/pdf/pdf_reference.html -

http://www.adobe.com/devnet/acrobat/pdfs/pdf_reference.pdf -

Options (convert to lowercase) except flags in square brackets: +

Options (convert to lowercase) except flags in square brackets:

-

New option ‘export’ sets the export format of a submit action. Valid values are (upper- or +

New option ‘export’ sets the export format of a submit action. Valid values are (upper- or lowercase):

-

+

PDF (not supported by Acrobat Reader) +

7.17 Option ‘pdfversion’

-

This is an experimental option. It notifies ‘hyperref’ about the intended PDF version. Currently this is +

This is an experimental option. It notifies ‘hyperref’ about the intended PDF version. Currently this is used in code for PDF forms (implementation notes 116 and 122 of PDF spec 1.7). -

Values: 1.2, 1.3, 1.4, 1.5, 1.6, 1.7. Values below 1.2 are not supported, because most drivers expect +

Values: 1.2, 1.3, 1.4, 1.5, 1.6, 1.7. Values below 1.2 are not supported, because most drivers expect higher PDF versions. -

The option must be used early, not after

The option must be used early, not after \usepackage{hyperref}. -

In theory this option should also set the PDF version, but this is not generally supported. +

In theory this option should also set the PDF version, but this is not generally supported.

-

The current PDF version is used as default if this version can be detected (only pdfTeX

Ghostscript: option -dCompatibilityLevel (this is set in ‘ps2pdf12’, ‘ps2pdf13’, ‘ps2pdf14’). +

The current PDF version is used as default if this version can be detected (only pdfTeX ≥ 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. -

+

7.18 Field option ‘name’

-

Many form objects uses the label argument for several purposes: +

Many form objects uses the label argument for several purposes:

-

Code that is suitable for layouting with TeX can break in the structures of the output format. If option +

As name in HTML structures. +

Code that is suitable for layouting with TeX can break in the structures of the output format. If option ‘name’ is given, then its value is used as name in the different output structures. Thus the value should consist of letters only. -

+

7.19 Option ‘pdfencoding’

-

The PDF format allows two encodings for bookmarks and entries in the information dictionary: +

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:

-

All drivers use

All drivers use unicode by default now. If another encoding should be forced, it should be done in hypersetup. -

+

7.20 Color options/package hycolor

-

See documentation of package ‘hycolor’. -

+

See documentation of package ‘hycolor’. +

7.21 Option pdfusetitle

-

If option pdfusetitle is set then hyperref tries to derive the values for pdftitle and pdfauthor +

If option pdfusetitle is set then hyperref tries to derive the values for pdftitle and pdfauthor from \title and \author. An optional argument for \title and \author is supported (class amsart). -

+

7.22 Starred form of \autoref

-

\autoref* generates a reference without link as \ref* or \pageref*. -

+

7.23 Link border style

-

Links can be underlined instead of the default rectangle or options

Links can be underlined instead of the default rectangle or options colorlinks, frenchlinks. This is done by option pdfborderstyle={/S/U/W 1} -

Some remarks: +

Some remarks:

-

+

7.24 Option bookmarksdepth

-

The depth of the bookmarks can be controlled by the new option

The depth of the bookmarks can be controlled by the new option bookmarksdepth. The option acts globally and distinguishes three cases:

-

+

+

7.25 Option pdfescapeform

-

There are many places where arbitrary strings end up as PS or PDF strings. The PS/PDF strings in +

There are many places where arbitrary strings end up as PS or PDF strings. The PS/PDF strings in parentheses form require the protection of some characters, e.g. unmatched left or right parentheses need escaping or the escape character itself (backslash). Since 2006/02/12 v6.75a the PS/PDF driver should do this automatically. However I assume a problem with compatibility, especially regarding the form part where larger amounts of JavaScript code can be present. It would be a pain to remove all the escaping, because an additional escaping layer can falsify the code. -

Therefore a new option pdfescapeform was introduced: +

Therefore a new option pdfescapeform was introduced:

-

+

7.26 Default driver setting

-

(hyperref

(hyperref ≥ 6.72s) If no driver is given, hyperref tries its best to guess the most suitable driver. Thus it loads hpdftex, if pdfTeX is detected running in PDF mode. Or it loads the @@ -5784,18 +5824,18 @@ class="ec-lmvtt-10">hyperref.cfg: 

     \providecommand*{\Hy@defaultdriver}{hdvips}
-

for dvips, or +

for dvips, or 

     \providecommand*{\Hy@defaultdriver}{hypertex}
-

for the default behaviour of hyperref. -

See also the new option ‘driverfallback’. -

+

for the default behaviour of hyperref. +

See also the new option ‘driverfallback’. +

7.27 Backref entries

-

Alternative interface for formatting of backref entries, example: +

Alternative interface for formatting of backref entries, example: 

@@ -5888,11 +5928,11 @@ class="ec-lmvtt-10">hyperref.cfg:
 
 \end{document}
-

-

+

+

7.28 \phantomsection

-

Set an anchor at this location. It is often used in conjunction with

Set an anchor at this location. It is often used in conjunction with \addcontentsline for sectionlike things (index, bibliography, preface). \addcontentsline refers to the latest previous location where an anchor is @@ -5905,13 +5945,13 @@ set.   \addcontentsline{toc}{chapter}{\indexname}   \printindex -

-

Now the entry in the table of contents (and bookmarks) for the index points to the start of the index +

+

Now the entry in the table of contents (and bookmarks) for the index points to the start of the index page, not to a location before this page. -

+

7.29 puenc encoding, puenc-greekbasic.def and puenc-extra.def

-

The

The unicode option loads for the bookmarks puenc.def which contains quite a lot definitions of commands for the bookmarks. As hyperref uses two strategies.

-

+

8 Acrobat-specific behavior

-

If you want to access the menu options of Acrobat Reader or Exchange, the following macro is provided +

If you want to access the menu options of Acrobat Reader or Exchange, the following macro is provided in the appropriate drivers: -

}{text}
-

The

The text is used to create a button which activates the appropriate menuoption. The following table lists the option names you can use—comparison of this with the menus in Acrobat Reader or Exchange will show what they do. Obviously some are only appropriate to Exchange. -

+

-

style="vertical-align:baseline;" id="TBL-44-1-"> class="td01">File→Export +

Properties

@@ -6056,7 +6096,7 @@ class="td10"> style="vertical-align:baseline;" id="TBL-44-9-"> +

About

@@ -6171,18 +6211,18 @@ class="td01"> class="td01">
File -

Open, +

Open, Close, Scan, Save, @@ -5988,7 +6028,7 @@ class="td10"> class="td01">File→Import

-

ImportImage, +

ImportImage, ImportNotes, AcroForm:ImportFDF

-

ExportNotes, +

ExportNotes, AcroForm:ExportFDF

File→DocumentInfo -

GeneralInfo, +

GeneralInfo, OpenInfo, FontsInfo, SecurityInfo, @@ -6014,7 +6054,7 @@ class="td10"> class="td01">File→Preferences

-

GeneralPrefs, +

GeneralPrefs, NotePrefs, FullScreenPrefs, Weblink:Prefs, @@ -6026,7 +6066,7 @@ class="td10"> style="vertical-align:baseline;" id="TBL-44-6-">

Edit -

Undo, +

Undo, Cut, Copy, Paste, @@ -6042,13 +6082,13 @@ class="td10"> style="vertical-align:baseline;" id="TBL-44-7-">

 -

Properties

Edit→Fields -

AcroForm:Duplicate, +

AcroForm:Duplicate, AcroForm:TabOrder

Document -

Cpt:CapturePages, +

Cpt:CapturePages, AcroForm:Actions, CropPages, RotatePages, @@ -6072,7 +6112,7 @@ class="td10"> style="vertical-align:baseline;" id="TBL-44-10-">

View -

ActualSize, +

ActualSize, FitVisible, FitWidth, FitPage, @@ -6096,7 +6136,7 @@ class="td10"> style="vertical-align:baseline;" id="TBL-44-11-">

Tools -

Hand, +

Hand, ZoomIn, ZoomOut, SelectText, @@ -6118,7 +6158,7 @@ class="td10"> class="td01">Tools→Search

-

AcroSrch:Query, +

AcroSrch:Query, AcroSrch:Indexes, AcroSrch:Results, AcroSrch:Assist, @@ -6130,7 +6170,7 @@ class="td10"> style="vertical-align:baseline;" id="TBL-44-13-">

Window -

ShowHideToolBar, +

ShowHideToolBar, ShowHideMenuBar, ShowHideClipboard, Cascade, @@ -6141,7 +6181,7 @@ class="td10"> style="vertical-align:baseline;" id="TBL-44-14-">

Help -

HelpUserGuide, +

HelpUserGuide, HelpTutorial, HelpExchange, HelpScan, @@ -6156,7 +6196,7 @@ class="td10"> style="vertical-align:baseline;" id="TBL-44-15-">

Help(Windows) -

About

-

+

9 PDF and HTML forms

-

You must put your fields inside a

You must put your fields inside a Form environment. The environment does some general setups, so should be used only once in a document. Using simply \Form at the begin of the document is possible too. -

There are six macros to prepare fields: +

There are six macros to prepare fields: -

]{label}
-

]{label}
-

}{choices}
-

]{label}
-

]{label}
-

]{label}
-

The way forms and their labels are laid out is determined by: -

The way forms and their labels are laid out is determined by: +

}{field}
-

}{field}
-

}{field}
-

These macros default to #1 #2 -

What is actually shown in the field is determined by: -

These macros default to #1 #2 +

What is actually shown in the field is determined by: +

}{height}
-

}{height}
-

}{height}
-

}{height}
-

\MakeButtonField{text}
-

These macros default to

These macros default to \vbox to #2{\hbox #1{\hfill}\vfill}, except the l to #1; it is used for buttons, and the special \Submit and \Reset macros. -

You may also want to redefine the following macros: +

You may also want to redefine the following macros: 

@@ -6391,13 +6431,13 @@ class="ec-lmvtt-10">\Reset macros.
 \def\DefaultHeightofTextMultiline{4\baselineskip}
 \def\DefaultWidthofText{3cm}
-

-

+

+

9.1 Forms environment parameters

-

+

action encoding method @@ -6452,16 +6492,16 @@ class="td01">
URL -

The URL that will receive the form data if a

The URL that will receive the form data if a Submit button is included in the form

name -

The encoding for the string set to the URL; FDF-encoding +

The encoding for the string set to the URL; FDF-encoding is usual, and html is the only valid value

name -

Used only when generating HTML; values can be

Used only when generating HTML; values can be post or get

-

+

9.2 Forms optional parameters

-

Note that all colors must be expressed as RGB triples, in the range 0..1 (i.e. 

Note that all colors must be expressed as RGB triples, in the range 0..1 (i.e. color=0 0 0.5) -

+

-

+

10 Defining a new driver

-

A hyperref driver has to provide definitions for eight macros: -

1.

A hyperref driver has to provide definitions for eight macros: +

1. \hyper@anchor -

2.

2. \hyper@link -

3.

3. \hyper@linkfile -

4.

4. \hyper@linkurl -

5.

5. \hyper@anchorstart -

6.

6. \hyper@anchorend -

7.

7. \hyper@linkstart -

8.

8. \hyper@linkend -

The draft option defines the macros as follows +

The draft option defines the macros as follows 

@@ -6955,16 +6995,16 @@ class="ec-lmvtt-10">\hyper@linkend
 \let\hyper@linkstart\@gobbletwo
 \let\hyper@linkend\@empty
-

-

+

+

11 Special support for other packages

-

Package

Package hyperref aims to cooperate with other packages, but there are several possible sources for conflict, such as

-

The

Packages that do anything serious with sectioning commands and the toc +

The hyperref package is distributed with variants on two useful packages designed to work especially well with it. These are xr and minitoc, which support crossdocument links using \label/\ref mechanisms and per-chapter tables of contents, respectively. -

+

11.1 Package Compatibility

-

Currently only package loading orders are available: -

+

Currently only package loading orders are available: +

11.1.1 algorithm
@@ -7004,11 +7044,11 @@ class="ec-lmvtt-10">\ref mechanisms and per-chapter tables of contents, r   \usepackage{hyperref}   \usepackage[chapter]{algorithm}% eg. -

-

+

+

11.1.2 amsmath
-

The environments equation and eqnarray are not supported too well. For example, there might be +

The environments equation and eqnarray are not supported too well. For example, there might be spacing problems (eqnarray isn’t recommended anyway, see CTAN:info/l2tabu/, the situation for equation is unclear, because nobody is interested in investigating). Consider using the environments that package amsmath provide, e.g. gather for equation. The environment equation can even redefined to use @@ -7020,22 +7060,22 @@ gather:   \let\equation\gather   \let\endequation\endgather -

-

+

+

11.1.3 amsrefs
-

Package loading order: +

Package loading order: 

   \usepackage{hyperref}
   \usepackage{amsrefs}
-

-

+

+

11.1.4 arydshln, longtable
-

Package longtable must be put before hyperref and arydshln, hyperref after arydshln generates an error, +

Package longtable must be put before hyperref and arydshln, hyperref after arydshln generates an error, thus the resulting package order is then: @@ -7044,16 +7084,16 @@ thus the resulting package order is then:   \usepackage{hyperref}   \usepackage{arydshln} -

-

+

+

11.1.5 babel/magyar.ldf
-

The old version 2005/03/30 v1.4j will not work. You need at least version 1.5, maintained by Péter +

The old version 2005/03/30 v1.4j will not work. You need at least version 1.5, maintained by Péter Szabó, see CTAN:language/hungarian/babel/. -

+

11.1.6 babel/spanish.ldf
-

Babel’s spanish.ldf redefines ‘

Babel’s spanish.ldf redefines ‘\.’ to support ‘\...’. In bookmarks (\pdfstringdef) only ‘\.’ is supported. If ‘\...’ is needed, \texorpdfstring{\...}{\dots} can be used instead. -

+

11.1.7 bibentry
-

Workaround: +

Workaround: 

@@ -7083,16 +7123,16 @@ class="ec-lmvtt-10">\texorpdfstring{\...}{\dots} can be use
     \nobibliography{database}
   \endgroup
-

-

+

+

11.1.8 bigfoot
-

Hyperref does not support package ‘bigfoot’. And package ‘bigfoot’ does not support hyperref’s footnotes +

Hyperref does not support package ‘bigfoot’. And package ‘bigfoot’ does not support hyperref’s footnotes and disables them (hyperfootnotes=false). -

+

11.1.9 chappg
-

Package ‘chappg’ uses

Package ‘chappg’ uses \@addtoreset that is redefined by ‘hyperref’. The package order is therefore: @@ -7101,11 +7141,11 @@ therefore:   \usepackage{hyperref}   \usepackage{chappg} -

-

+

+

11.1.10 cite
-

This is from Mike Shell: cite.sty cannot currently be used with hyperref. However, I can do a workaround +

This is from Mike Shell: cite.sty cannot currently be used with hyperref. However, I can do a workaround via: @@ -7116,14 +7156,14 @@ via:  \usepackage[hypertex]{hyperref} -

-

so that hyperref will not redefine any of the biblabel stuff - so cite.sty will work as normal - +

+

so that hyperref will not redefine any of the biblabel stuff - so cite.sty will work as normal - although the citations will not be hyperlinked, of course (But this may not be an issue for many people). -

+

11.1.11 count1to
-

Package ‘count1to’ adds several

Package ‘count1to’ adds several \@addtoreset commands that confuse ‘hyperref’. Therefore \theH<...> has to be fixed: @@ -7139,27 +7179,27 @@ has to be fixed:     \renewcommand*{\theHsubparagraph}{\theHparagraph.\arabic{subparagraph}}%   } -

-

+

+

11.1.12 dblaccnt
-

pd1enc.def or puenc.def should be loaded before: +

pd1enc.def or puenc.def should be loaded before: 

   \usepackage{hyperref}
   \usepackage{dblaccnt}
-

or see entry for

or see entry for vietnam. -

+

11.1.13 easyeqn
-

Not compatible, breaks. -

+

Not compatible, breaks. +

11.1.14 ellipsis
-

This packages redefines

This packages redefines \textellipsis after package hyperref (pd1enc.def/puenc.def should be loaded before): @@ -7168,10 +7208,10 @@ before):   \usepackage{hyperref}   \usepackage{ellipsis} -

-

(this will lead to wrong ellipsis in the bookmarks, so

+

(this will lead to wrong ellipsis in the bookmarks, so \texorpdfstring is needed). -

+

11.1.15 float
@@ -7180,38 +7220,38 @@ class="ec-lmvtt-10">\texorpdfstring is needed).  \usepackage{float}   \usepackage{hyperref} -

+

-

+

Anchor are set at top of the float object, if its style is controlled by float.sty. +

11.1.16 endnotes
-

Unsupported. -

+

Unsupported. +

11.1.17 foiltex
-

Update to version 2008/01/28 v2.1.4b: Since version 6.77a hyperref does not hack into

Update to version 2008/01/28 v2.1.4b: Since version 6.77a hyperref does not hack into \@begindvi, it uses package ‘atbegshi’ instead, that hooks into \shipout. Thus the patch of ‘foils.cls’ regarding hyperref is now obsolete and causes an undefined error message about \@hyperfixhead. This is fixed in FoilTeX 2.1.4b. -

+

11.1.18 footnote
-

This package is not supported, you have to disable hyperref’s footnote support by using option +

This package is not supported, you have to disable hyperref’s footnote support by using option hyperfootnotes=false. -

+

11.1.19 geometry
-

Driver ‘dvipdfm’ and program ‘dvipdfm’ might generate a warning: Sorry. Too late to change page size +

Driver ‘dvipdfm’ and program ‘dvipdfm’ might generate a warning: Sorry. Too late to change page size Then prefer the program ‘dvipdfmx’ or use one of the following workarounds to move the \special of geometry to an earlier location: @@ -7244,24 +7284,24 @@ geometry to an earlier location:     ]{geometry}     \usepackage{hyperref} -

-

+

+

11.1.20 IEEEtran.cls
-

version

version ≥ V1.6b (because of \@makecaption, see ChangeLog) -

+

11.1.21 index
-

version

version ≥ 1995/09/28 v4.1 (because of \addcontentsline redefinition) -

+

11.1.22 lastpage
-

Compatible. -

+

Compatible. +

11.1.23 linguex
@@ -7270,8 +7310,8 @@ class="ec-lmvtt-10">\addcontentsline redefinition)  \usepackage{hyperref}   \usepackage{linguex} -

-

+

+

11.1.24 ltabptch
@@ -7281,20 +7321,20 @@ class="ec-lmvtt-10">\addcontentsline redefinition)   \usepackage{ltabptch}   \usepackage{hyperref} -

-

+

+

11.1.25 mathenv
-

Unsupported. -

Both ‘mathenv’ and ‘hyperref’ messes around with environment ‘eqnarray’. You can load ‘mathenv’ +

Unsupported. +

Both ‘mathenv’ and ‘hyperref’ messes around with environment ‘eqnarray’. You can load ‘mathenv’ after ‘hyperref’ to avoid an error message. But \label will not work inside environment ‘eqnarray’ properly, for example. -

+

11.1.26 minitoc-hyper
-

This package is obsolete, use the up-to-date original package minitoc instead. -

+

This package is obsolete, use the up-to-date original package minitoc instead. +

11.1.27 multind
@@ -7303,8 +7343,8 @@ properly, for example.  \usepackage{multind}   \usepackage{hyperref} -

-

+

+

11.1.28 natbib
@@ -7313,22 +7353,22 @@ properly, for example.  \usepackage{natbib}   \usepackage{hyperref} -

-

+

+

11.1.29 nomencl
-

Example for introducing links for the page numbers: +

Example for introducing links for the page numbers: 

       \renewcommand*{\pagedeclaration}[1]{\unskip, \hyperpage{#1}}
-

-

+

+

11.1.30 ntheorem-hyper
-

This package is obsolete, use the up-to-date original package ntheorem instead. -

For equations the following might work: +

This package is obsolete, use the up-to-date original package ntheorem instead. +

For equations the following might work: 

@@ -7338,8 +7378,8 @@ properly, for example.
     But the mapping from the equation number to the anchor name
     is not available in general.
-

-

+

+

11.1.31 prettyref
@@ -7364,8 +7404,8 @@ properly, for example. %%% example for prettyref %%%        -

-

+

+

11.1.32 setspace
@@ -7374,18 +7414,18 @@ properly, for example.  \usepackage{setspace}   \usepackage{hyperref} -

-

+

+

11.1.33 sidecap
-

Nothing special is needed anymore. -

+

Nothing special is needed anymore. +

11.1.34 subfigure
-

The package is obsolete. Use either

The package is obsolete. Use either subfig or subcaption -

+

11.1.35 titleref
@@ -7395,24 +7435,24 @@ class="ec-lmss-10">subcaption   \usepackage{titleref}% without usetoc   \usepackage{hyperref} -

-

+

+

11.1.36 tabularx
-

Linked footnotes are not supported inside environment ‘tabularx’, because they uses the optional +

Linked footnotes are not supported inside environment ‘tabularx’, because they uses the optional argument of \footnotetext, see section ‘Limitations’. Before version 2011/09/28 6.82i hyperref had disabled footnotes entirely by ‘hyperfootnotes=false’. -

+

11.1.37 titlesec
-

nameref supports titlesec, but hyperref does not (unsolved is the anchor setting, missing with unnumbered section, perhaps problems with page breaks with numbered ones). -

+

11.1.38 ucs/utf8x.def
-

The first time a multibyte UTF8 sequence is called, it does some calculations and stores the result in a +

The first time a multibyte UTF8 sequence is called, it does some calculations and stores the result in a macro 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 @@ -7428,16 +7468,16 @@ class="ec-lmvtt-10">\PreloadUnicodePage to solve this:     \PrerenderUnicode{^^c3^^b6}% or \PrerenderUnicodePage{1}     \hypersetup{pdftitle={Umlaut example: ^^c3^^b6}} -

The notation with two carets avoids trouble with 8-bit bytes for the README file, you can use the +

The notation with two carets avoids trouble with 8-bit bytes for the README file, you can use the characters directly. -

Note: utf8 is now the default in LaTeX and

Note: utf8 is now the default in LaTeX and ucs is no longer recommended. -

+

11.1.39 varioref
-

There are too many problems with varioref. Nobody has time to sort them out. Therefore this package is +

There are too many problems with varioref. Nobody has time to sort them out. Therefore this package is now unsupported. -

Perhaps you are lucky and some of the features of varioref works with the following loading +

Perhaps you are lucky and some of the features of varioref works with the following loading order: @@ -7446,24 +7486,24 @@ order:     \usepackage{varioref}     \usepackage{hyperref} -

-

Also some babel versions can be problematic. For example, 2005/05/21 v3.8g contains a patch for +

+

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. -

Also unsupported: +

Also unsupported:

-

+

11.1.40 verse
-

Version 2005/08/22 v2.22 contains support for hyperref. -

For older versions see example from de.comp.text.tex (2005/08/11, slightly modified): +

Version 2005/08/22 v2.22 contains support for hyperref. +

For older versions see example from de.comp.text.tex (2005/08/11, slightly modified): 

@@ -7508,8 +7548,8 @@ class="ec-lmvtt-10">\vpageref[]{...} On the same page a pre
 
   \end{document}
-

-

+

+

11.1.41 vietnam
@@ -7520,20 +7560,20 @@ class="ec-lmvtt-10">\vpageref[]{...} On the same page a pre   \usepackage{vietnam}   \usepackage{hyperref} -

-

+

+

11.1.42 XeTeX
-

Default for the encoding of bookmarks is

Default for the encoding of bookmarks is pdfencoding=unicode. That means the strings are always treated as unicode strings. If auto or pdfdoc is forced it applies only if the string restricts to the printable ASCII set, The reason is that the \special does not support PDFDocEncoding. -

In older versions hyperref contained special conversion code from UTF-16BE back to UTF-8 in a +

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 -

Failed to convert input string to UTF16... -

This is no longer needed with a current xdvipdfmx, so this code has been removed. +

This is no longer needed with a current xdvipdfmx, so this code has been removed. \csname HyPsd@XeTeXBigCharstrue\endcsname should no longer be used. -

+

12 Limitations6

12.1 Wrapped/broken link support

-

Only few drivers support automatically wrapped/broken links, e.g. pdftex, dvipdfm, hypertex. Other +

Only few drivers support automatically wrapped/broken links, e.g. pdftex, dvipdfm, hypertex. Other drivers lack this feature, e.g. dvips, dvipsone. -

Workarounds: +

Workarounds:

-

+

12.2 Links across pages

-

In general they have problems: +

In general they have problems:

-

+

12.3 Footnotes

-

LaTeX allows the separation of the footnote mark and the footnote text (

LaTeX allows the separation of the footnote mark and the footnote text (\footnotemark, \footnotetext). This interface might be enough for visual typesetting. But the relation between @@ -7609,14 +7649,14 @@ Thus the implementation of hyperref does not support the optional argument of \footnotemark and \footnotetext. -

+

13 Hints7

13.1 Spaces in option values

-

Unhappily LaTeX strips spaces from options if they are given in

Unhappily LaTeX strips spaces from options if they are given in \documentclass or \usepackage (or \RequirePackage), e.g.: 

     \usepackage[pdfborder=0 0 1]{hyperref}
-

Package hyperref now gets +

Package hyperref now gets 

     pdfborder=001
-

and the result is an invalid PDF file. As workaround braces can be used: +

and the result is an invalid PDF file. As workaround braces can be used: 

     \usepackage[pdfborder={0 0 1}]{hyperref}
-

Some options can also be given in

Some options can also be given in \hypersetup 

     \hypersetup{pdfborder=0 0 1}
-

In

In \hypersetup the options are directly processed as key value options (see package keyval) without space stripping in the value part. -

Alternatively, LaTeX’s option handling system can be adapted to key value options by one of the +

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). -

+

13.2 Index with makeindex

-

+

+

13.3 Warning "bookmark level for unknown <foobar> defaults to 0"

-

Getting rid of it: +

Getting rid of it: 

@@ -7735,16 +7775,16 @@ class="ec-lmvtt-10">"bookmark level for unknown <foobar> defaults
 \providecommand*{\toclevel@<foobar>}{0}
 \makeatother
-

-

+

+

13.4 Link anchors in figures

-

The caption command increments the counter and here is the place where hyperref set the corresponding +

The caption command increments the counter and here is the 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 that implements a method to circumvent the problem. -

+

13.5 Additional unicode characters in bookmarks and pdf information entries:

@@ -7753,14 +7793,14 @@ problem. \documentclass[pdftex]{article} \usepackage[unicode]{hyperref} -

-

Support for additional unicode characters: -

Example:

+

Support for additional unicode characters: +

Example: \.{a} and \d{a} -

1. Get a list with unicode data, eg: -

http://www.unicode.org/Public/UNIDATA/UnicodeData.txt -

2. Identify the characters (

1. Get a list with unicode data, eg: +

http://www.unicode.org/Public/UNIDATA/UnicodeData.txt +

2. Identify the characters (\.{a}, \d{a}): @@ -7769,9 +7809,9 @@ class="ec-lmvtt-10">\d{a}):     0227;LATIN SMALL LETTER A WITH DOT ABOVE;...     1EA1;LATIN SMALL LETTER A WITH DOT BELOW;... -

-

3. Calculate the octal code: -

The first characters of the line in the file are hex values, convert each byte and prepend them with a +

+

3. Calculate the octal code: +

The first characters of the line in the file are hex values, convert each byte and prepend them with a backslash. (This will go into the PDF file.) @@ -7779,9 +7819,9 @@ backslash. (This will go into the PDF file.)     0227 -> \002\047     1EA1 -> \036\241 -

-

4. Transform into a form understood by hyperref: -

Hyperref must know where the first byte starts, this is marked by

+

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 octal numbers): @@ -7790,8 +7830,8 @@ numbers):     \002\047 -> \9002\047     \036\241 -> \9036\241 -

-

Optional:

+

Optional: 8 is used for abbreviations: @@ -7800,8 +7840,8 @@ class="ec-lmvtt-10">8 is used for abbreviations:     \9002\047 -> \82\047 -

-

5. Declare the character with LaTeX: +

+

5. Declare the character with LaTeX: 

@@ -7813,11 +7853,11 @@ class="ec-lmvtt-10">8 is used for abbreviations:
 \end{document}
       
-

-

+

+

13.6 Footnotes

-

The footnote support is rather limited. It is beyond the scope to use

The footnote support is rather limited. It is beyond the scope to use \footnotemark and \footnotetext out of order or reusing -

+

-

+

13.7 Subordinate counters

-

Some counters do not have unique values and require the value of other counters to be unique. For +

Some counters do not have unique values and require the value of other counters to be unique. For example, sections or figures might be numbered within chapters or \newtheorem is used with an optional counter argument. Internally LaTeX uses \@addtoreset to catch this situation. Also \numberwithin of package amsmath is caught by hyperref. -

However, if the definition of subordinate counters take place before hyperref is loaded, the old +

However, if the definition of subordinate counters take place before hyperref is loaded, the old meaning of \@addtoreset is called without hyperref’s additions. Then the companion counter macro \theH<counter> can be redefined accordingly. Or move the definition of subordinate counters after hyperref is loaded. -

Example for

Example for \newtheorem, problematic case: @@ -7903,14 +7943,14 @@ class="ec-lmvtt-10">\newtheorem, problematic case:     \newtheorem{corA}{CorollaryA}[section]     \usepackage{hyperref} -

Solution a) +

Solution a) 

     \usepackage{hyperref}
     \newtheorem{corA}{CorollaryA}[section}
-

Solution b) +

Solution b) 

@@ -7918,11 +7958,11 @@ class="ec-lmvtt-10">\newtheorem, problematic case:
     \usepackage{hyperref}
     \newcommand*{\theHcorA}{\theHsection.\number\value{corA}}
-

-

+

+

14 History and acknowledgments

-

The original authors of

The original authors of hyperbasics.tex and hypertex.sty, from which this package descends, are Tanmoy Bhattacharya and Thorsten Ohl. Package

Tanmoy found a great many of the bugs, and (even better) often provided fixes, which has +

Tanmoy found a great many of the bugs, and (even better) often provided fixes, which has made the package more robust. The days spent on RevTeX are entirely due to him! The investigations of Bill Moss into the later versions including native PDF support uncovered a good many bugs, and his testing is appreciated. Hans Hagen provided a lot of insight into PDF. -

Berthold Horn provided help, encouragement and sponsorship for the

Berthold Horn provided help, encouragement and sponsorship for the dvipsone and dviwindo drivers. Sergey Lesenko provided the changes needed for hyper package (developed in parallel with hyperref) showed me solutions for some problems. Hopefully the two packages will combine one day. -

The forms creation section owes a great deal to: T. V. Raman, for encouragement, support and +

The forms creation section owes a great deal to: T. V. Raman, for encouragement, support and ideas; Thomas Merz, whose book Web Publishing with Acrobat/PDF provided crucial insights; D. P. Story, whose detailed article about pdfmarks and forms solved many practical problems; and Hans Hagen, who explained how to do it in pdftex. -

Steve Peter recreated the manual source in July 2003 after it had been lost. -

Especial extra thanks to David Carlisle for the

Steve Peter recreated the manual source in July 2003 after it had been lost. +

Especial extra thanks to David Carlisle for the backref module, the ps2pdf and dviwindo support, frequent general rewrites of my bad code, and for working on changes to the xr package to suit @@ -7971,61 +8011,61 @@ class="ec-lmss-10">hyperref.

15 GNU Free Documentation License

-

Version 1.2, November 2002 -

Copyright

Version 1.2, November 2002 +

Copyright © 2000,2001,2002 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. -

+

Preamble

-

The purpose of this License is to make a manual, textbook, or other functional and useful document +

The purpose of this License is to make a manual, textbook, or other functional and useful document “free” in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. -

This License is a kind of “copyleft”, which means that derivative works of the document must +

This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. -

We have designed this License in order to use it for manuals for free software, because free software +

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference. -

+

15.1 Applicability and definitions

-

This License applies to any manual or other work, in any medium, that contains a notice placed by +

This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law. -

A “Modified Version” of the Document means any work containing the Document or a +

A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. -

A “Secondary Section” is a named appendix or a front-matter section of the Document that deals +

A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. -

The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of +

The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. -

The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or +

The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. -

A “Transparent” copy of the Document means a machine-readable copy, represented in a format +

A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or @@ -8034,7 +8074,7 @@ otherwise Transparent file format whose markup, or absence of markup, has been a discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”. -

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo +

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include @@ -8042,26 +8082,26 @@ proprietary formats that can be read and edited only by proprietary word process or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. -

The “Title Page” means, for a printed book, the title page itself, plus such following pages as are +

The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text. -

A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely +

A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition. -

The Document may include Warranty Disclaimers next to the notice which states that this +

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License. -

+

15.2 Verbatim copying

-

You may copy and distribute the Document in any medium, either commercially or noncommercially, +

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the @@ -8069,14 +8109,14 @@ copies you make or distribute. However, you may accept compensation in exchange If you distribute a large enough number of copies you must also follow the conditions in section 15.3. -

You may also lend copies, under the same conditions stated above, and you may publicly display +

You may also lend copies, under the same conditions stated above, and you may publicly display copies. -

+

15.3 Copying in quantity

-

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, +

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly @@ -8085,10 +8125,10 @@ words of the title equally prominent and visible. You may add other material on addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects. -

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones +

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages. -

If you publish or distribute Opaque copies of the Document numbering more than 100, you must +

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free @@ -8097,31 +8137,31 @@ begin distribution of Opaque copies in quantity, to ensure that this Transparent remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public. -

It is requested, but not required, that you contact the authors of the Document well before +

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document. -

+

15.4 Modifications

-

You may copy and distribute a Modified Version of the Document under the conditions of sections 

You may copy and distribute a Modified Version of the Document under the conditions of sections 15.2 and 15.3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version: -

+

  1. -

    Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, +

    Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.

  2. -

    List on the Title Page, as authors, one or more persons or entities responsible for authorship +

    List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement. @@ -8129,35 +8169,35 @@ Version:

  3. -

    State on the Title page the name of the publisher of the Modified Version, as the publisher. +

    State on the Title page the name of the publisher of the Modified Version, as the publisher.

  4. -

    Preserve all the copyright notices of the Document. +

    Preserve all the copyright notices of the Document.

  5. -

    Add an appropriate copyright notice for your modifications adjacent to the other copyright +

    Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.

  6. -

    Include, immediately after the copyright notices, a license notice giving the public permission +

    Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.

  7. -

    Preserve in that license notice the full lists of Invariant Sections and required Cover Texts +

    Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.

  8. -

    Include an unaltered copy of this License. +

    Include an unaltered copy of this License.

  9. -

    Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at +

    Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled “History” in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item @@ -8165,7 +8205,7 @@ Version:

  10. -

    Preserve the network location, if any, given in the Document for public access to a +

    Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section. You may omit a network location for a work that was published at least four years before the @@ -8175,96 +8215,96 @@ Version:

  11. -

    For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the +

    For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.

  12. -

    Preserve all the Invariant Sections of the Document, unaltered in their text and in their +

    Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.

  13. -

    Delete any section Entitled “Endorsements”. Such a section may not be included in the +

    Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.

  14. -

    Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with +

    Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.

  15. -

    Preserve any Warranty Disclaimers. +

    Preserve any Warranty Disclaimers.

-

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary +

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles. -

You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of +

You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties–for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard. -

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as +

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one. -

The author(s) and publisher(s) of the Document do not by this License give permission to use their +

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version. -

+

15.5 Combining documents

-

You may combine the Document with other documents released under this License, under the terms +

You may combine the Document with other documents released under this License, under the terms defined in section 15.4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers. -

The combined work need only contain one copy of this License, and multiple identical Invariant +

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. -

In the combination, you must combine any sections Entitled “History” in the various original +

In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements”. -

+

15.6 Collections of documents

-

You may make a collection consisting of the Document and other documents released under this License, +

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects. -

You may extract a single document from such a collection, and distribute it individually under this +

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document. -

+

15.7 Aggregation with independent works

-

A compilation of the Document or its derivatives with other separate and independent documents or +

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document. -

If the Cover Text requirement of section 

If the Cover Text requirement of section 15.3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate. -

+

15.8 Translation

-

Translation is considered a kind of modification, so you may distribute translations of the Document +

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 15.4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant @@ -8275,53 +8315,53 @@ provided that you also include the original English version of this License and versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail. -

If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the +

If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 15.4) to Preserve its Title (section 15.1) will typically require changing the actual title. -

+

15.9 Termination

-

You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under +

You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. -

+

15.10 Future revisions of this license

-

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation +

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/. -

Each version of the License is given a distinguishing version number. If the Document specifies that a +

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. -

+

Addendum: how to use this license for your documents

-

To use this License in a document you have written, include a copy of the License in the document and +

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: -

+

-

Copyright

Copyright © YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.

-

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with...Texts.” +

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with...Texts.” line with this: -

with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and +

with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. -

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge +

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation. -

If your document contains nontrivial examples of program code, we recommend releasing these +

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software. diff --git a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.pdf b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.pdf index 7d28450f788..438d91628e6 100644 Binary files a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.pdf and b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.pdf differ diff --git a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.tex b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.tex index e9019cc9884..05b8a02882e 100644 --- a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.tex +++ b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.tex @@ -166,7 +166,7 @@ } \makeatother \title{Hypertext marks in \hologo{LaTeX}: a manual for \xpackage{hyperref}} -\date{2023-02-07 v7.00v} +\date{2023-04-20 v7.00w} \begin{document} @@ -265,28 +265,33 @@ of a URL (of the form \emph{URL\#name\_string}). Here However, the drivers intended to produce \emph{only} PDF use literal PostScript or PDF \verb|\special| commands. The commands are defined in -configuration files for different drivers, selected by package options; +configuration files for different drivers, selected by package options or for +most current engines autodetected; at present, the following drivers are supported: \begin{description} \item[hypertex] DVI processors conforming to the Hyper\TeX\ guidelines (i.e.\ \textsf{xdvi}, \textsf{dvips} (with the \textsf{-z} option), \textsf{\hologo{OzTeX}}, and \textsf{Textures}) -\item[dvips] produces \verb|\special| commands tailored for \textsf{dvips} +\item[dvips] produces \verb|\special| commands tailored for \textsf{dvips}. This is the default driver if dvi mode is +detected. \item[dvipsone] produces \verb|\special| commands tailored for \textsf{dvipsone} \item[ps2pdf] a special case of output suitable for processing by earlier versions of Ghost\-script's PDF writer; this is basically the same as that for \textsf{dvips}, but a few variations remained before version 5.21 -\item[tex4ht] produces \verb|\special| commands for use with \textsf{\TeX4ht} -\item[pdftex] pdf\TeX, \hologo{HanTheThanh}'s \TeX{} variant that writes PDF directly -\item[luatex] lua\TeX, Unicode \TeX{} variant that writes PDF directly +\item[tex4ht] produces \verb|\special| commands for use with \textsf{\TeX4ht}, autodetected. +\item[pdftex] pdf\TeX, \hologo{HanTheThanh}'s \TeX{} variant that writes PDF directly, autodetected. +\item[luatex] lua\TeX, Unicode \TeX{} variant that writes PDF directly, autodetected. \item[dvipdfm] produces \verb|\special| commands for Mark Wicks' DVI to PDF driver \textsf{dvipdfm} \item[dvipdfmx] produces \verb|\special| commands for driver \textsf{dvipdfmx}, a successor of \textsf{dvipdfm} \item[dviwindo] produces \verb|\special| commands that Y\&Y's Windows previewer interprets as hypertext jumps within the previewer \item[vtex] produces \verb|\special| commands that MicroPress' HTML and PDF-producing \TeX\ variants interpret as hypertext jumps within the - previewer + previewer, autodetected. \item[textures] produces \verb|\special| commands that \textsf{Textures} interprets as hypertext jumps within the previewer -\item[xetex] produces \verb|\special| commands for Xe\TeX{} +\item[xetex] produces \verb|\special| commands for Xe\TeX{}, autodetected. +\item[hitex] (new 2023) for the hint format produces by the Hi\TeX{} engine, autodetected. This a quite experimental +engine and the driver file is not part of the \xpackage{hyperref} bundle but is provided by +the \xpackage{hitex} package. Problems should be reported to \url{https://github.com/ruckertm/HINT}. \end{description} Output from \textsf{dvips} or \textsf{dvipsone} must be processed using @@ -307,8 +312,8 @@ such as \textsf{xdvi}. \begin{quote} \texttt{driverfallback=dvipdfm} \end{quote} - Autodetected drivers (\textsf{pdftex}, \textsf{xetex}, \textsf{vtex}, - \textsf{vtexpdfmark}) are recognized from within \TeX\ and + Autodetected drivers (\textsf{pdftex}, \textsf{luatex}, \textsf{xetex}, \textsf{vtex}, + \textsf{vtexpdfmark}, \textsf{hitex}) are recognized from within \TeX\ and therefore cannot be given as value to option \textsf{driverfallback}. However a DVI driver program is run after the \TeX\ run is finished. Thus it cannot be detected at \TeX\ macro level. Then package @@ -557,7 +562,15 @@ Check the \xpackage{nameref} documentation about a way to suppress these patches \item[table of contents] hyperref redefines \cs{contentsline} to be able to add links to toc entries. It redefines \cs{addcontentsline} to create the bookmarks and pass the -destination names to the toc entries. This code can be suppressed by defining \cs{hyper@nopatch@toc}. +destination names to the toc entries. This code can be suppressed by defining \cs{hyper@nopatch@toc}. + +\item[captions] hyperref redefines \cs{caption} and \cs{@caption} to insert targets for links. +This code can be suppressed by defining \cs{hyper@nopatch@caption} (additional helper commands are +not suppressed). As various packages redefine captions too (e.g. the \xpackage{caption} package) +side-effects must be carefully tested! + +\item[longtable] hyperref redefines \cs{LT@start} and \cs{LT@array} to move the targets in a better place. +This code can be suppressed by defining \cs{hyper@nopatch@longtable} \end{description} \section{Package options} diff --git a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc2.html b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc2.html index c9fa9e4df35..e24d5ff1cd2 100644 --- a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc2.html +++ b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc2.html @@ -14,7 +14,7 @@

1Now: Now: https://ctan.org/tex-archive/support/hypertex/hypertex diff --git a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc4.html b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc4.html index 7e3e6a54ebd..cada83835b3 100644 --- a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc4.html +++ b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc4.html @@ -11,7 +11,7 @@

-

3Make sure you turn off the partial font downloading supported by

-

4But work has started to reduce the number of redefinition and so the dependencies on the loading diff --git a/Master/texmf-dist/doc/latex/hyperref/hyperref-linktarget.pdf b/Master/texmf-dist/doc/latex/hyperref/hyperref-linktarget.pdf index c654567c8b5..b0aa5d88efd 100644 Binary files a/Master/texmf-dist/doc/latex/hyperref/hyperref-linktarget.pdf and b/Master/texmf-dist/doc/latex/hyperref/hyperref-linktarget.pdf differ diff --git a/Master/texmf-dist/doc/latex/hyperref/hyperref.pdf b/Master/texmf-dist/doc/latex/hyperref/hyperref.pdf index 2f67c1643d2..aeac628c4f2 100644 Binary files a/Master/texmf-dist/doc/latex/hyperref/hyperref.pdf and b/Master/texmf-dist/doc/latex/hyperref/hyperref.pdf differ diff --git a/Master/texmf-dist/doc/latex/hyperref/nameref.pdf b/Master/texmf-dist/doc/latex/hyperref/nameref.pdf index c8af996d262..494981728df 100644 Binary files a/Master/texmf-dist/doc/latex/hyperref/nameref.pdf and b/Master/texmf-dist/doc/latex/hyperref/nameref.pdf differ -- cgit v1.2.3