From f95af114c0c92289f1fe0aecf486bc412dcd5be3 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 24 Oct 2023 17:50:28 +0000 Subject: hyperref (23oct23) git-svn-id: svn://tug.org/texlive/trunk@68630 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/hyperref/ChangeLog.txt | 31 + Master/texmf-dist/doc/latex/hyperref/README.md | 2 +- Master/texmf-dist/doc/latex/hyperref/backref.pdf | Bin 206282 -> 206681 bytes .../texmf-dist/doc/latex/hyperref/hyperref-doc.css | 7 +- .../doc/latex/hyperref/hyperref-doc.html | 6404 ++++++++++---------- .../texmf-dist/doc/latex/hyperref/hyperref-doc.pdf | Bin 321491 -> 317664 bytes .../texmf-dist/doc/latex/hyperref/hyperref-doc.tex | 273 +- .../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-doc6.html | 2 +- .../doc/latex/hyperref/hyperref-doc7.html | 8 +- .../doc/latex/hyperref/hyperref-doc8.html | 2 +- .../doc/latex/hyperref/hyperref-doc9.html | 19 + .../doc/latex/hyperref/hyperref-linktarget.pdf | Bin 439546 -> 439782 bytes Master/texmf-dist/doc/latex/hyperref/hyperref.pdf | Bin 2343685 -> 2346680 bytes Master/texmf-dist/doc/latex/hyperref/nameref.pdf | Bin 184831 -> 184798 bytes Master/texmf-dist/doc/latex/hyperref/paper.pdf | Bin 132446 -> 0 bytes Master/texmf-dist/doc/latex/hyperref/slides.pdf | Bin 384001 -> 0 bytes .../texmf-dist/source/latex/hyperref/backref.dtx | 8 +- .../texmf-dist/source/latex/hyperref/hluatex.dtx | 4 +- .../source/latex/hyperref/hyperref-linktarget.dtx | 2 +- .../source/latex/hyperref/hyperref-patches.dtx | 2 +- .../texmf-dist/source/latex/hyperref/hyperref.dtx | 113 +- .../texmf-dist/source/latex/hyperref/nameref.dtx | 21 +- Master/texmf-dist/tex/latex/hyperref/backref.sty | 2 +- Master/texmf-dist/tex/latex/hyperref/hdvipdfm.def | 2 +- Master/texmf-dist/tex/latex/hyperref/hdvips.def | 2 +- Master/texmf-dist/tex/latex/hyperref/hdvipson.def | 2 +- Master/texmf-dist/tex/latex/hyperref/hdviwind.def | 2 +- Master/texmf-dist/tex/latex/hyperref/hluatex.def | 4 +- Master/texmf-dist/tex/latex/hyperref/hpdftex.def | 2 +- Master/texmf-dist/tex/latex/hyperref/htex4ht.cfg | 2 +- Master/texmf-dist/tex/latex/hyperref/htex4ht.def | 2 +- Master/texmf-dist/tex/latex/hyperref/htexture.def | 2 +- Master/texmf-dist/tex/latex/hyperref/hvtex.def | 2 +- Master/texmf-dist/tex/latex/hyperref/hvtexhtm.def | 2 +- Master/texmf-dist/tex/latex/hyperref/hvtexmrk.def | 2 +- Master/texmf-dist/tex/latex/hyperref/hxetex.def | 2 +- Master/texmf-dist/tex/latex/hyperref/hyperref.sty | 88 +- Master/texmf-dist/tex/latex/hyperref/hypertex.def | 2 +- Master/texmf-dist/tex/latex/hyperref/nameref.sty | 21 +- .../texmf-dist/tex/latex/hyperref/nohyperref.sty | 2 +- Master/texmf-dist/tex/latex/hyperref/pd1enc.def | 2 +- Master/texmf-dist/tex/latex/hyperref/pdfmark.def | 2 +- Master/texmf-dist/tex/latex/hyperref/psdextra.def | 2 +- Master/texmf-dist/tex/latex/hyperref/puarenc.def | 2 +- .../texmf-dist/tex/latex/hyperref/puenc-extra.def | 2 +- Master/texmf-dist/tex/latex/hyperref/puenc.def | 2 +- Master/texmf-dist/tex/latex/hyperref/puvnenc.def | 2 +- Master/texmf-dist/tex/latex/hyperref/xr-hyper.sty | 2 +- 51 files changed, 3618 insertions(+), 3445 deletions(-) create mode 100644 Master/texmf-dist/doc/latex/hyperref/hyperref-doc9.html delete mode 100644 Master/texmf-dist/doc/latex/hyperref/paper.pdf delete mode 100644 Master/texmf-dist/doc/latex/hyperref/slides.pdf diff --git a/Master/texmf-dist/doc/latex/hyperref/ChangeLog.txt b/Master/texmf-dist/doc/latex/hyperref/ChangeLog.txt index 62e2f83fa9f..38c62f78c6c 100644 --- a/Master/texmf-dist/doc/latex/hyperref/ChangeLog.txt +++ b/Master/texmf-dist/doc/latex/hyperref/ChangeLog.txt @@ -1,3 +1,34 @@ +=========== +Version: 2023-10-21 v7.01c + +2023-10-16 Ulrike Fischer + * hyperref.dtx: add \@currentHpage support + +2023-10-12 Ulrike Fischer + * hyperref.dtx: handle \TextOrMath in \pdfstringdef, issue 303 + * support babel languages loaded with main or + with \babelprovide, issue 165 + +2023-10-05 Ulrike Fischer + * nameref.dtx: add missing nameref nopatches issue 302, + version changed to 2023-10-05 v2.54 + +2023-08-14 Ulrike Fischer + * remove redefinition of \newlabel from the aux if format is new enough. + * clean up and update documentation of package compabilities + +2023-08-01 Ulrike Fischer + * correct example in backref documentation, version changed to 2023-08-01 v1.43 + +2023-07-18 Ulrike Fischer + * delay anchor in \@thm, issue 294 + +2023-07-10 Ulrike Fischer + * solve amsmath/showkeys/final conflict, issue 292 + +=============== +Version: 2023-07-08 v7.01b + 2023-07-07 Ulrike Fischer * make \Hy@@SectionAnchor safe in a MakeUppercase, issue 281 * reset also \ltx@label of amsmath (avoids problems with ntheorem and classes like svmono) diff --git a/Master/texmf-dist/doc/latex/hyperref/README.md b/Master/texmf-dist/doc/latex/hyperref/README.md index cdf76f45c76..8a2088f6662 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-07-08 v7.01b +Version 2023-10-21 v7.01c ## INTRODUCTION diff --git a/Master/texmf-dist/doc/latex/hyperref/backref.pdf b/Master/texmf-dist/doc/latex/hyperref/backref.pdf index 15ca607a5f5..9ed150253b2 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.css b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.css index 328505fcb2d..e476f4934e9 100644 --- a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.css +++ b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.css @@ -66,7 +66,6 @@ .ec-lmss-10{ font-family: sans-serif;} .ec-lmss-10{ font-family: sans-serif;} .ec-lmss-10{ font-family: sans-serif;} -.lmsy7-{font-size:70%;} .ec-lmr-9{font-size:90%;} .ec-lmr-8{font-size:80%;} .ec-lmvtt-10x-x-80{font-size:80%; font-family: monospace,monospace;} @@ -261,7 +260,6 @@ table.pmatrix {width:100%;} span.bar-css {text-decoration:overline;} img.cdots{vertical-align:middle;} .partToc a, .partToc, .likepartToc a, .likepartToc {line-height: 200%; font-weight:bold; font-size:110%;} -.chapterToc a, .chapterToc, .likechapterToc a, .likechapterToc, .appendixToc a, .appendixToc {line-height: 200%; font-weight:bold;} .index-item, .index-subitem, .index-subsubitem {display:block} div.caption {text-indent:-2em; margin-left:3em; margin-right:1em; text-align:left;} div.caption span.id{font-weight: bold; white-space: nowrap; } @@ -281,6 +279,10 @@ div.author{white-space: nowrap;} div.abstract p {margin-left:5%; margin-right:5%;} div.abstract {width:100%;} .abstracttitle{text-align:center;margin-bottom:1em;} +.subsectionToc, .likesubsectionToc {margin-left:1em;} +.subsubsectionToc, .likesubsubsectionToc {margin-left:2em;} +.paragraphToc, .likeparagraphToc {margin-left:3em;} +.subparagraphToc, .likesubparagraphToc {margin-left:4em;} div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; } table.tabular td p{margin-top:0em;} table.tabular {margin-left: auto; margin-right: auto;} @@ -318,4 +320,3 @@ span.HoLogo-LaTeX2e span.HoLogo-2{padding-left:.15em;} span.HoLogo-LaTeX2e span.HoLogo-e{position:relative;top:.35ex;text-decoration:none;} /* end css.sty */ - diff --git a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.html b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.html index 19e888b0beb..550a1b4f654 100644 --- a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.html +++ b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc.html @@ -20,285 +20,275 @@
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-10-21 v7.01c

Contents

-  1 1 Preface -
  1.1 1.1 Restoring removed patches -
 2 2 Introduction -
 3 3 Implicit behavior -
 4 4 Interfaces for class and package authors -
  4.1 4.1 Counters -
  4.2 4.2 Values of package and \hypersetup options -
  4.3 4.3 Links commands -
  4.4 4.4 Creating targets -
  4.5 4.5 Patches and how to suppress them -
 5 5 Package options -
  5.1 5.1 General options -
  5.2 5.2 Options for destination names -
  5.3 Configuration options -
  5.4 Backend drivers -
  5.5 Extension options -
  5.6 PDF-specific display options -
  5.7 PDF display and information options -
  5.8 Option 5.3 Page anchors +
5.4 Configuration options +
5.5 Backend drivers +
5.6 Extension options +
5.7 PDF-specific display options +
5.8 PDF display and information options +
5.9 Option pdfinfo -
  5.9 Big alphabetical list -
 6 Additional user macros -
  6.1 Bookmark macros -
   6.1.1 Setting bookmarks -
   6.1.2 Replacement macros -
  6.2 Pagelabels -
  6.3 Utility macros -
 7 New Features -
  7.1 Option ‘pdflinkmargin’ -
  7.2 Field option ‘calculatesortkey’ -
  7.3 Option ‘next-anchor’ -
  7.4 Option ‘localanchorname’ -
  7.5 Option ‘customdriver’ -
  7.6 Option ‘psdextra’ - - -
  7.7 \XeTeXLinkBox -
  7.8 \IfHyperBooleanExists and \IfHyperBoolean -
  7.9 \unichar -
  7.10 \ifpdfstringunicode -
  7.11 Customizing index style file with \nohyperpage -
  7.12 Experimental option ‘ocgcolorlinks’ -
  7.13 Option ‘pdfa’ -
  7.14 Option ‘linktoc’ added -
  7.15 Option ‘pdfnewwindow’ changed -
  7.16 Flag options for PDF forms -
  7.17 Option ‘pdfversion’ -
  7.18 Field option ‘name’ -
  7.19 Option ‘pdfencoding’ -
  7.20 Color options/package hycolor -
  7.21 Option pdfusetitle -
  7.22 Starred form of \autoref -
  7.23 Link border style -
  7.24 Option 5.10 Big alphabetical list +
6 Additional user macros +
6.1 Bookmark macros +
6.1.1 Setting bookmarks +
6.1.2 Replacement macros +
6.2 Pagelabels +
6.3 Utility macros +
7 New Features +
7.1 Option ‘pdflinkmargin’ +
7.2 Field option ‘calculatesortkey’ +
7.3 Option ‘next-anchor’ +
7.4 Option ‘localanchorname’ +
7.5 Option ‘customdriver’ + + +
7.6 Option ‘psdextra’ +
7.7 \XeTeXLinkBox +
7.8 \IfHyperBooleanExists and \IfHyperBoolean +
7.9 \unichar +
7.10 \ifpdfstringunicode +
7.11 Customizing index style file with \nohyperpage +
7.12 Experimental option ‘ocgcolorlinks’ +
7.13 Option ‘pdfa’ +
7.14 Option ‘linktoc’ added +
7.15 Option ‘pdfnewwindow’ changed +
7.16 Flag options for PDF forms +
7.17 Option ‘pdfversion’ +
7.18 Field option ‘name’ +
7.19 Option ‘pdfencoding’ +
7.20 Color options/package hycolor +
7.21 Option pdfusetitle +
7.22 Starred form of \autoref +
7.23 Link border style +
7.24 Option bookmarksdepth -
  7.25 Option 7.25 Option pdfescapeform -
  7.26 Default driver setting -
  7.27 Backref entries -
  7.28 \phantomsection -
  7.29 puenc encoding, puenc-greekbasic.def and puenc-extra.def -
 8 Acrobat-specific behavior -
 9 PDF and HTML forms -
  9.1 Forms environment parameters -
  9.2 Forms optional parameters -
 10 Defining a new driver -
 11 Special support for other packages -
  11.1 Package Compatibility -
   11.1.1 algorithm -
   11.1.2 amsmath -
   11.1.3 amsrefs -
   11.1.4 arydshln, longtable -
   11.1.5 babel/magyar.ldf -
   11.1.6 babel/spanish.ldf -
   11.1.7 bibentry -
   11.1.8 bigfoot -
   11.1.9 chappg -
   11.1.10 cite -
   11.1.11 count1to -
   11.1.12 dblaccnt -
   11.1.13 easyeqn -
   11.1.14 ellipsis -
   11.1.15 float -
   11.1.16 endnotes -
   11.1.17 foiltex -
   11.1.18 footnote -
   11.1.19 geometry -
   11.1.20 IEEEtran.cls -
   11.1.21 index -
   11.1.22 lastpage - -
   11.1.23 linguex -
   11.1.24 ltabptch -
   11.1.25 mathenv -
   11.1.26 minitoc-hyper -
   11.1.27 multind -
   11.1.28 natbib -
   11.1.29 nomencl -
   11.1.30 ntheorem-hyper -
   11.1.31 prettyref -
   11.1.32 setspace -
   11.1.33 sidecap -
   11.1.34 subfigure -
   11.1.35 titleref -
   11.1.36 tabularx -
   11.1.37 titlesec -
   11.1.38 ucs/utf8x.def -
   11.1.39 varioref -
   11.1.40 verse -
   11.1.41 vietnam -
   11.1.42 XeTeX -
 12 Limitations -
  12.1 Wrapped/broken link support -
  12.2 Links across pages -
  12.3 Footnotes -
 13 Hints -
  13.1 Spaces in option values -
  13.2 Index with makeindex -
  13.3 Warning 7.26 Default driver setting +
7.27 Backref entries +
7.28 \phantomsection +
7.29 puenc encoding, puenc-greekbasic.def and puenc-extra.def +
8 Acrobat-specific behavior +
9 PDF and HTML forms +
9.1 Forms environment parameters +
9.2 Forms optional parameters +
10 Defining a new driver +
11 Special support for other packages +
11.1 Package Compatibility +
11.1.1 algorithm +
11.1.2 amsmath +
11.1.3 amsrefs +
11.1.4 arydshln, longtable +
11.1.5 babel/magyar.ldf +
11.1.6 babel/spanish.ldf +
11.1.7 bibentry +
11.1.8 bigfoot +
11.1.9 chappg +
11.1.10 count1to +
11.1.11 dblaccnt +
11.1.12 easyeqn +
11.1.13 ellipsis +
11.1.14 float +
11.1.15 endnotes +
11.1.16 foiltex +
11.1.17 footnote +
11.1.18 linguex +
11.1.19 ltabptch +
11.1.20 mathenv +
11.1.21 minitoc-hyper + +
11.1.22 multind +
11.1.23 natbib +
11.1.24 nomencl +
11.1.25 ntheorem-hyper +
11.1.26 prettyref +
11.1.27 setspace +
11.1.28 sidecap +
11.1.29 subfigure +
11.1.30 titleref +
11.1.31 tabularx +
11.1.32 titlesec +
11.1.33 ucs/utf8x.def +
11.1.34 varioref +
11.1.35 verse +
11.1.36 vietnam +
11.1.37 XeTeX +
12 Limitations +
12.1 Wrapped/broken link support +
12.2 Links across pages +
12.3 Footnotes +
13 Hints +
13.1 Spaces in option values +
13.2 Index with makeindex +
13.3 Warning "bookmark level for unknown <foobar> defaults to 0" -
  13.4 Link anchors in figures -
  13.5 Additional unicode characters in bookmarks and pdf information entries: -
  13.6 Footnotes -
  13.7 Subordinate counters -
 14 History and acknowledgments -
 15 GNU Free Documentation License -
  15.1 Applicability and definitions -
  15.2 Verbatim copying -
  15.3 Copying in quantity -
  15.4 Modifications -
  15.5 Combining documents -
  15.6 Collections of documents -
  15.7 Aggregation with independent works -
  15.8 Translation -
  15.9 Termination -
  15.10 Future revisions of this license +
13.4 Link anchors in figures +
13.5 Additional unicode characters in bookmarks and pdf information entries: +
13.6 Footnotes +
13.7 Subordinate counters +
14 History and acknowledgments +
15 GNU Free Documentation License +
15.1 Applicability and definitions +
15.2 Verbatim copying +
15.3 Copying in quantity +
15.4 Modifications +
15.5 Combining documents +
15.6 Collections of documents +
15.7 Aggregation with independent works +
15.8 Translation +
15.9 Termination +
15.10 Future revisions of this license
- -

1 Preface

@@ -308,6 +298,8 @@ changes over time. The introduction mentions workflows, drivers and problems tha only in edge cases) relevant. The documentation reflects this varied history: changes and extensions and explanations were and are spread over various papers and sources or have been incorporated later and so are not always in a coherent order and in sync which each + + other.

This history is continuing: If you are using the new LATEX PDF management which is currently distributed as a testphase package \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. @@ -372,9 +364,6 @@ href="hyperref-doc3.html#fn2x0">2< says that conformant viewers/translators must recognize the following set of \special constructs:

- - -

href:

@@ -384,7 +373,6 @@ class="ec-lmvtt-10"> href = "href_string">
-

name:

@@ -393,15 +381,15 @@ class="ec-lmvtt-10">html:<a name = "name_string"> + +
-

end:

html:</a>

-

image:

@@ -411,7 +399,6 @@ class="ec-lmvtt-10"> src = "href_string">
-

base_name:

@@ -460,14 +447,14 @@ 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), @@ -478,105 +465,102 @@ class="ec-lmss-10">TEX, and 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 + 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.dvips -z, but the DVI file is not portable. The main a HyperTeX \special commands is that you can also use the document in hypertext DVI viewers, such as xdvi. +class="ec-lmss-10">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 +645,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 +653,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>

+class="description"> + -

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 +702,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 +762,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 +777,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 +811,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 +824,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 +862,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 +873,24 @@ 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

+class="description"> +

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

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 +941,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 +

+theorems
+

hyperref patches \@thm. This code can be suppressed by defining \hyper@nopatch@thm + +

+citations and bibliography
+

If natbib is not loaded hyperref redefines \bibcite, \@lbibitem and \@bibitem. These redefinitions + can be suppressed by defining \hyper@nopatch@bib.

+

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 tabular lists (hopefully all) these options. Be aware that some of the option do nothing or -have changed behaviour if the new pdfmanagement and so the new generic hyperref driver is +have changed behaviour if the new pdfmanagement and so the new generic hyperref driver is used. @@ -1009,13 +1039,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 +1059,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 +1073,7 @@ class="ec-lmvtt-10">\DeclareDocumentMetadata. style="vertical-align:baseline;" id="TBL-2-5-"> unicode

is +class="td11">

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

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

no-op +class="td11">

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

this +class="td11">

this will probably change @@ -1077,50 +1107,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 +1169,7 @@ class="ec-lmvtt-10">\hypersetup style="vertical-align:baseline;" id="TBL-2-18-"> psdextra

only +class="td11">

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

only +class="td11">

only with the new @@ -1187,10 +1217,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 +1400,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 +1420,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 +1455,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 +1468,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 +1491,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 +1516,12 @@ LuaTEX): } \makeatother -

-

With option

+

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

-

\HyperDestRename{destinationnewname}

-

Hint: Anchors can also be named and set by

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

+

-

+

5.3 Configuration options

-

-

Page anchors +

In a PDF hyperref adds to every page an target for links (in the upper left corner). These targets are for +example used by the index to references the pages of the entries. Unlike the targets generated by other +counters it is not possible to change the names of these targets by defining a \theHpage command: the +name can currently not be stored in a label and so is not referenceable. Nevertheless a few options +exists, they are already mentioned elsewhere in the documentation but we provide here a +summary: +

+

+pageanchor
+

A boolean option that determines whether every page is given an target at the top left + corner. If this is turned off, \printindex will not contain valid hyperlinks. + +

+hypertexnames
+

By default the targets have names built with \thepage: page.\thepage, so e.g., page.4 or + page.iii. The names require that every page as an unique number representation. A frequent + problem here is with title pages which often don’t show page numbers but internally use + the same number as a following page. If you get messages about destination with the same + identifier (namepage.1), change the number representation of title pages or disable the page + target. +

If the boolean option hypertexnames is set to false, an internal page counter is stepped and + used as arabic number. In most cases this should mean that you get the absolute page number + (exceptions could be with documents throwing away or duplicating pages at shipout). This + option avoids the problem with duplicated identifiers, but does not work with an index, as + the backlinks have to be created from the represention passed to the index. +

+plainpages
+

This forces page anchors to be named by the arabic form, but unlike the previous option it + does not use an internal counter but the page counter. That means if you have for example + roman and arabic pages you will get duplicated target names as page i and page 1 both set + the anchor page.1.

+

- +
raiselinks boolean \@currentHpage
+

Starting with version 7.01c hyperref stores the name of the page target it has just set into the (global) +variable \@currentHpage. The fallback value is Doc-Start. As the target is set when the page is shipout, +\@currentHpage is only reliable at shipout. With a LATEX format from 2023-11-01 the name can be +labeled like this: + + +

+%labeling in the document
+\RecordProperties{mylabel}{pagetarget}
+%linking to the page:
+\hyperlink{\RefProperty{mylabel}{pagetarget}}{some text}
+
+

+

+

5.4 Configuration options

+

+

+ - - +

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

raiselinks boolean true 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 real height of the link (which could contain a graphic)

breaklinks boolean breaklinks boolean both 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.

pageanchor boolean pageanchor boolean true 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.

nesting boolean nesting boolean false 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: +

+

5.5 Backend drivers

+

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, + class="enumerate" id="x1-17002x1"> +

    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,160 +1795,160 @@ is recommended because driver dvips provides much more features than hypertex for PDF generation. -

+

+> +

Its value is used as driver option

+

if the driver is not given or autodetected.

- - +

For use with XeTeX (using backend for dvipdfm). + +

driverfallback driverfallback -

Its value is used as driver option

-

if the driver is not given or autodetected.

dvipdfm dvipdfm -

Sets up

Sets up hyperref for use with the dvipdfm driver.

dvipdfmx dvipdfmx -

Sets up

Sets up hyperref for use with the dvipdfmx driver.

dvips dvips -

Sets up

Sets up hyperref for use with the dvips driver.

dvipsone dvipsone -

Sets up

Sets up hyperref for use with the dvipsone driver.

dviwindo dviwindo -

Sets up

Sets up hyperref for use with the dviwindo Windows previewer.

hypertex hypertex -

Sets up

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

latex2html latex2html -

Redefines a few macros for compatibility with

Redefines a few macros for compatibility with latex2html.

nativepdf nativepdf -

An alias for

An alias for dvips

pdfmark pdfmark -

An alias for

An alias for dvips

pdftex pdftex -

Sets up

Sets up hyperref for use with the pdftex program.

ps2pdf ps2pdf -

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.

tex4ht tex4ht -

For use with

For use with TeX4ht

textures textures -

For use with

For use with Textures

vtex vtex -

For use with MicroPress’

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

vtexpdfmark vtexpdfmark -

For use with

For use with VTeX’s PostScript backend.

xetex 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 dviwindo what program to launch. Thus, users of Intern add something like this to hyperref.cfg: -

+   
 \renewcommand{\wwwbrowser}{C:\string\Program\space
   Files\string\Plus!\string\Microsoft\space
   Internet\string\iexplore.exe}
 
-

-

-

5.5 Extension options

-

+

+

+

5.6 Extension options

+

+> +

+

Sets encap character for hyperindex

+

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

extension text extension 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 package.

hyperfigures boolean hyperfigures boolean -

backref text backref text false 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 @@ -1913,24 +2018,24 @@ class="ec-lmvtt-10">false. If no value is given, section is taken as default.

pagebackref boolean pagebackref boolean false 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.

hyperindex boolean hyperindex boolean true true -

Makes the page +

Makes the page numbers of index entries into hyperlinks. Relays on unique page anchors (pageanchor, …) pageanchors and plainpages=false.

hyperfootnotes boolean hyperfootnotes boolean true true -

Makes the footnote marks into hyperlinks to the +

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

encap encap -

Sets encap character for hyperindex

linktoc text linktoc text section section -

make text (

make text (section), page number (page), both (all) or nothing (none) be link on TOC, LOF and LOT

linktocpage boolean linktocpage boolean false false -

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

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

breaklinks boolean breaklinks boolean false 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

colorlinks boolean colorlinks boolean false 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 links. Unlike colored boxes, the colored text remains when printing.

linkcolor color linkcolor color red red -

Color for normal internal links.

anchorcolor color anchorcolor color black black -

Color for anchor text. Ignored by most drivers.

citecolor color citecolor color green green -

Color for bibliographical citations in text.

filecolor color filecolor color cyan cyan -

Color for URLs which open local files.

menucolor color menucolor color red red -

Color for Acrobat menu items.

runcolor color runcolor color filecolor filecolor -

Color for run links (launch annotations).

urlcolor color urlcolor color magenta magenta -

Color for linked URLs.

allcolors color allcolors color -

Set all color options (without border and field +

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

frenchlinks boolean frenchlinks boolean false false -

Use small caps instead of color for links.

hidelinks 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

-

+

+

5.7 PDF-specific display options

+

+> +

to specify which ‘toc’ file to mimic

+

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

bookmarks boolean bookmarks boolean true 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 .out file is not rewritten \let\WriteBookmarks\relax

bookmarksopen boolean bookmarksopen boolean false false -

If Acrobat bookmarks are requested, show them +

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

bookmarksopenlevel parameter bookmarksopenlevel parameter -

level (

level (\maxdimen) to which bookmarks are open

bookmarksnumbered boolean bookmarksnumbered boolean false false -

If Acrobat bookmarks are requested, include +

If Acrobat bookmarks are requested, include section numbers.

bookmarkstype text bookmarkstype text toc toc -

to specify which ‘toc’ file to mimic

CJKbookmarks boolean CJKbookmarks boolean false 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 it simply replaces CJK’s macros with special versions which expand to the corresponding character codes. Note that without the ‘unicode’ - option of hyperref you get PDF files which + option of hyperref you get PDF files which actually violate the PDF specification because non-Unicode character codes are used – some PDF readers localized for CJK languages (most notably 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.

pdfhighlight name pdfhighlight name /I /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).

citebordercolor RGB color citebordercolor RGB color 0 1 0 0 1 0 -

The color of the box around citations

filebordercolor RGB color filebordercolor RGB color 0 .5 .5 0 .5 .5 -

The color of the box around links to files

linkbordercolor RGB color linkbordercolor RGB color 1 0 0 1 0 0 -

The color of the box around normal links

menubordercolor RGB color menubordercolor RGB color 1 0 0 1 0 0 -

The color of the box around Acrobat menu links

urlbordercolor RGB color urlbordercolor RGB color 0 1 1 0 1 1 -

The color of the box around links to URLs

runbordercolor RGB color runbordercolor RGB color 0 .7 .7 0 .7 .7 -

Color of border around ‘run’ links

allbordercolors allbordercolors -

Set all border color options

pdfborder pdfborder 0 0 1 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 @@ -2335,41 +2441,41 @@ class="ec-lmvtt-10">.out file is not overwritten on the next TeX r line -

+   
 \let\WriteBookmarks\relax
 
-

-

-

5.7 PDF display and information options

-

+

+

+

5.8 PDF display and information options

+

+> +

Sets the base URL of the PDF document

+

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 creation date, see below the table for + more info about the format

+

Sets the modification date, see below the table + for more info about the format

+ + +

Sets the default PDF ‘view’ for each link

+

Set the startup page view + +

- - +

Set the startup page view of remote PDF files

+

resize document window to fit document size

+

PDF language identifier (RFC 3066)

+

make PDF viewer’s menu bar visible

+

number of printed copies

+

set PDF page labels

+

set /PrintPageRange of viewer preferences

+

make PDF toolbar visible

+

make PDF user interface elements visible

+

Unicode encoded PDF strings

baseurl baseurl -

URL

URL

-

Sets the base URL of the PDF document

pdfpagemode pdfpagemode -

name

name

empty empty -

Determines how the file is opening in +

Determines how the file is opening in Acrobat; the possibilities are UseNone, UseAttachments (PDF 1.6). If no option is set, UseOutlines is used.

pdftitle pdftitle -

text

text

-

Sets the document information Title field

pdfauthor pdfauthor -

text

text

-

Sets the document information Author field

pdfsubject pdfsubject -

text

text

-

Sets the document information Subject field

pdfcreator pdfcreator -

text

text

-

Sets the document information Creator field

addtopdfcreator pdfcreationdate -

text

date

-

Adds additional text to the document - information Creator field

pdfkeywords pdfmoddate -

text

date

-

Sets the document information Keywords field

pdftrapped addtopdfcreator -

name

empty

text

-

Sets the document information Trapped entry. - Possible values are

Adds additional text to the document + information Creator field

pdfkeywords +

text

+

Sets the document information Keywords field

pdftrapped +

name

empty +

Sets the document information Trapped entry. + Possible values are True, False and Unknown. An empty value means, the entry is not set.

pdfinfo pdfinfo -

key +

key value - list

empty empty -

Alternative interface for setting the document +

Alternative interface for setting the document information.

pdfview pdfview -

name

name

XYZ XYZ -

Sets the default PDF ‘view’ for each link

pdfstartpage pdfstartpage -

integer

integer

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

pdfstartview pdfstartview -

name

name

Fit Fit -

Set the startup page view

pdfremotestartview pdfremotestartview -

name

name

Fit Fit -

Set the startup page view of remote PDF files

pdfpagescrop pdfpagescrop -

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

boolean

boolean

false false -

position the document window in the center +

position the document window in the center of the screen

pdfdirection pdfdirection -

name

name

empty empty -

direction setting. Possible values:

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

pdfdisplaydoctitle pdfdisplaydoctitle -

boolean

boolean

false false -

display document title instead of file name in +

display document title instead of file name in title bar

pdfduplex pdfduplex -

name

name

empty empty -

paper handling option for print +

paper handling option for print dialog. Possible vatues are: Simplex (print single-sided), DuplexFlipShortEdge (duplex class="ec-lmvtt-10">DuplexFlipLongEdge (duplex and flip on the long edge of the sheet)

pdffitwindow pdffitwindow -

boolean

boolean

false false -

resize document window to fit document size

pdflang pdflang -

name

name

relax relax -

PDF language identifier (RFC 3066)

pdfmenubar pdfmenubar -

boolean

boolean

true true -

make PDF viewer’s menu bar visible

pdfnewwindow pdfnewwindow -

boolean

boolean

false false -

make links that open another PDF file start a +

make links that open another PDF file start a new window

pdfnonfullscreenpagemode pdfnonfullscreenpagemode -

name

name

empty empty -

page mode setting on exiting full-screen mode. +

page mode setting on exiting full-screen mode. Possible values are UseNone, UseOutlines, @@ -2634,25 +2760,25 @@ class="ec-lmvtt-10">UseOutlines, class="ec-lmvtt-10">UseThumbs, and UseOC

pdfnumcopies pdfnumcopies -

integer

integer

empty empty -

number of printed copies

pdfpagelayout pdfpagelayout -

name

name

empty empty -

set layout of PDF pages. Possible values: +

set layout of PDF pages. Possible values: SinglePage, OneColumn, TwoPageLeft, and TwoPageRight

pdfpagelabels pdfpagelabels -

boolean

boolean

true true -

set PDF page labels

pdfpagetransition pdfpagetransition -

name

name

empty empty -

set PDF page transition style. Possible values +

set PDF page transition style. Possible values are Split, Blinds, Fade. class="ec-lmvtt-10">R, which simply replaces the old page with the new one.

pdfpicktraybypdfsize pdfpicktraybypdfsize -

boolean

boolean

false 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

pdfprintarea pdfprintarea -

name

name

empty empty -

set /PrintArea of viewer preferences. Possible +

set /PrintArea of viewer preferences. Possible values are MediaBox, CropBox, ArtBox. The dafault according to the PDF Refence is CropBox

pdfprintclip pdfprintclip -

name

name

empty empty -

set /PrintClip of viewer preferences. Possible +

set /PrintClip of viewer preferences. Possible values are MediaBox, CropBox, ArtBox. The dafault according to the PDF Refence is CropBox

pdfprintpagerange pdfprintpagerange -

n +

n n (n - n)*

empty empty -

set /PrintPageRange of viewer preferences

pdfprintscaling pdfprintscaling -

name

name

empty 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

pdftoolbar pdftoolbar -

boolean

boolean

true true -

make PDF toolbar visible

pdfviewarea pdfviewarea -

name

name

empty empty -

set /ViewArea of viewer preferences. Possible +

set /ViewArea of viewer preferences. Possible values are MediaBox, CropBox, ArtBox. The dafault according to the PDF Refence is CropBox

pdfviewclip pdfviewclip -

name

name

empty empty -

set /ViewClip of viewer preferences Possible +

set /ViewClip of viewer preferences Possible values are MediaBox, CropBox, ArtBox. The dafault according to the PDF Refence is CropBox

pdfwindowui pdfwindowui -

boolean

boolean

true true -

make PDF user interface elements visible

unicode unicode -

boolean

boolean

true true -

Unicode encoded PDF strings

-

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 XYZ (horizontal × -vertical

The dates CreationDate and ModDate are normally set automatically to the current date/time when +the compilation started. If they should be changed (e.g. for regression tests to produce reproducible +documents) they can be set with \hypersetup with the keys pdfcreationdate, pdfmoddate or externally +by setting the SOURCE_DATE_EPOCH environment variable. + + +

+ \hypersetup{pdfcreationdate=D:20010101205959-00’00’}
+ 
+
+

+

The format should be a full date/time in PDF format, so one of these (naturally the numbers can +change): + + +

+  D:20010101205959-00’00’
+  D:20010101205959+00’00’
+  D:20010101205959Z
+ 
+
+

+

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 64. pdfTeX works by supplying default values for XYZ +(horizontal × vertical × zoom) and FitBH. However, drivers using pdfmark do not supply defaults, so @@ -2880,306 +3034,306 @@ class="ec-lmvtt-10">pdfview, pdfstartview and pdfremotestartview parameters. -

+

+> - - +

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.

XYZ XYZ left top zoom 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 null will give the same values as the current page.

Fit Fit -

Fits the page to the window.

FitH FitH top top -

Fits the width of the page to the window.

FitV FitV left left -

Fits the height of the page to the window.

FitR FitR left bottom right top left bottom right top -

Fits the rectangle specified by the four +

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

FitB FitB -

Fits the page bounding box to the window.

FitBH FitBH top top -

Fits the width of the page bounding box to +

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

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

+

+> +

Displays a single page; advancing flips the page

+

Displays the document in one column; continuous scrolling.

+ +
SinglePage SinglePage -

Displays a single page; advancing flips the page

OneColumn OneColumn -

Displays the document in one column; continuous scrolling.

TwoColumnLeft TwoColumnLeft -

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

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

TwoColumnRight TwoColumnRight -

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

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

TwoPageLeft 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 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 90 steps, /Di stands for +direction of motion in degrees, generally in 90 degree steps, /Dm is a horizontal (/H) or vertical (/V) dimension -(e.g. /H) or +vertical (/V) dimension (e.g. Blinds /Dm /V), and /M is for motion, either in (/I) or out (/I) or out +(/O). -

+

+> - - +

A box sweeps in or out.

+

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

+

Simply replaces the old page with the new one.

+ +
Blinds /Dm Blinds /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 Box /M -

A box sweeps in or out.

Dissolve Dissolve -

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 Glitter /Di -

Similar to Dissolve, except the effect sweeps across the +

Similar to Dissolve, except the effect sweeps across the screen.

Split /Dm /M Split /Dm /M -

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

Wipe /Di 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 R -

Simply replaces the old page with the new one.

Fly /Di /M 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.

Push /Di Push /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.

Cover /Di Cover /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 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.

Fade Fade -

The new page gradually becomes visible through the old +

The new page gradually becomes visible through the old one.

-

-

5.8 Option

+

5.9 Option pdfinfo

-

The information entries can be set using

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

-
+     
 \hypersetup{
   pdfinfo={
     Title={My Title},
@@ -3206,948 +3360,966 @@ strings (see PDF specification). Example:
   }
 }
 
-

-

-

5.9 Big alphabetical list

-

The following is a complete listing of available options for

+

+

5.10 Big alphabetical list

+

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

+

+> +

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

+

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

+

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

+ +

Sets the creation date, see below the table in + section 5.8 for more info about the format

+

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

+

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

- - +

color of border around URL links

+

color of URL links

+

be chatty

allbordercolors allbordercolors -

Set all border color options

allcolors allcolors -

Set all color options (without border and field +

Set all color options (without border and field options)

anchorcolor anchorcolor black black -

set color of anchors, ignored by most drivers.

backref backref false false -

do bibliographical back references

baseurl baseurl empty empty -

set base URL for document

bookmarks bookmarks true true -

make bookmarks

bookmarksnumbered bookmarksnumbered false false -

put section numbers in bookmarks

bookmarksopen bookmarksopen false false -

open up bookmark tree

bookmarksopenlevel bookmarksopenlevel \maxdimen \maxdimen -

level to which bookmarks are open

bookmarkstype bookmarkstype toc toc -

to specify which ‘toc’ file to mimic

breaklinks breaklinks false false -

allow links to break over lines

CJKbookmarks CJKbookmarks false false -

to produce CJK bookmarks

citebordercolor citebordercolor 0 1 0 0 1 0 -

color of border around cites

citecolor citecolor green green -

color of citation links

colorlinks colorlinks false false -

color links

true true -

(

(tex4ht, dviwindo)

debug debug false false -

provide details of anchors defined; same as +

provide details of anchors defined; same as verbose

destlabel destlabel false false -

destinations are named by the first

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

draft draft false false -

do not do any hyperlinking

driverfallback driverfallback -

default if no driver specified or detected

dvipdfm dvipdfm -

use

use dvipdfm backend

dvipdfmx dvipdfmx -

use

use dvipdfmx backend

dvips dvips -

use

use dvips backend

dvipsone dvipsone -

use

use dvipsone backend

dviwindo dviwindo -

use

use dviwindo backend

encap encap -

to set encap character for hyperindex

extension extension dvi dvi -

suffix of linked files

filebordercolor filebordercolor 0 .5 .5 0 .5 .5 -

color of border around file links

filecolor filecolor cyan cyan -

color of file links

final final true true -

opposite of option draft

frenchlinks frenchlinks false false -

use small caps instead of color for links

hidelinks hidelinks -

Hide links (removing color and border)

hyperfigures hyperfigures false false -

make figures hyper links

hyperfootnotes hyperfootnotes true true -

set up hyperlinked footnotes

hyperindex hyperindex true true -

set up hyperlinked indices

hypertex hypertex -

use

use HyperTeX backend

hypertexnames hypertexnames true true -

use guessable names for links

implicit implicit true true -

redefine LaTeX internals

latex2html latex2html -

use

use LaTeX2HTML backend

linkbordercolor linkbordercolor 1 0 0 1 0 0 -

color of border around links

linkcolor linkcolor red red -

color of links

linktoc linktoc section section -

make text be link on TOC, LOF and LOT

linktocpage linktocpage false false -

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

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

menubordercolor menubordercolor 1 0 0 1 0 0 -

color of border around menu links

menucolor menucolor red red -

color for menu links

nativepdf nativepdf false false -

an alias for

an alias for dvips

naturalnames naturalnames false false -

use LaTeX-computed names for links

nesting nesting false false -

allow nesting of links

next-anchor next-anchor -

allow to set the name of the next anchor

pageanchor pageanchor true true -

put an anchor on every page

pagebackref pagebackref false false -

backreference by page number

pdfauthor pdfauthor empty empty -

text for PDF Author field

pdfborder pdfborder 0 0 1 0 0 1 -

width of PDF link border

0 0 0 0 0 0 -

(

(colorlinks)

pdfborderstyle pdfborderstyle -

border style for links

pdfcenterwindow pdfcenterwindow false false -

position the document window in the center +

position the document window in the center of the screen

pdfcreator pdfcreator LaTeX with LaTeX with -

text for PDF Creator field

hyperref hyperref +

pdfcreationdate -

pdfdirection pdfdirection empty empty -

direction setting

pdfdisplaydoctitle pdfdisplaydoctitle false false -

display document title instead of file name in +

display document title instead of file name in title bar

pdfduplex pdfduplex empty empty -

paper handling option for print dialog

pdffitwindow pdffitwindow false false -

resize document window to fit document size

pdfhighlight pdfhighlight /I /I -

set highlighting of PDF links

pdfinfo pdfinfo empty empty -

alternative interface for setting document +

alternative interface for setting document information

pdfkeywords pdfkeywords empty empty -

text for PDF Keywords field

pdflang pdflang relax relax -

PDF language identifier (RFC 3066)

pdfmark pdfmark false false -

an alias for

an alias for dvips

pdfmenubar pdfmenubar true true -

make PDF viewer’s menu bar visible

pdfnewwindow pdfmoddate +

Sets the modification date, see below the table + in section 5.8 for more info about the format

pdfnewwindow false false -

make links that open another PDF

-

file start a new window

pdfnonfullscreenpagemode pdfnonfullscreenpagemode empty empty -

page mode setting on exiting full-screen mode

pdfnumcopies pdfnumcopies empty empty -

number of printed copies

pdfpagelabels pdfpagelabels true true -

set PDF page labels

pdfpagelayout pdfpagelayout empty empty -

set layout of PDF pages

pdfpagemode pdfpagemode empty empty -

set default mode of PDF display

pdfpagescrop pdfpagescrop empty empty -

set crop size of PDF document

pdfpagetransition pdfpagetransition empty empty -

set PDF page transition style

pdfpicktraybypdfsize pdfpicktraybypdfsize empty empty -

set option for print dialog

pdfprintarea pdfprintarea empty empty -

set /PrintArea of viewer preferences

pdfprintclip pdfprintclip empty empty -

set /PrintClip of viewer preferences

pdfprintpagerange pdfprintpagerange empty empty -

set /PrintPageRange of viewer preferences

pdfprintscaling pdfprintscaling empty empty -

page scaling option for print dialog

pdfproducer pdfproducer empty empty -

text for PDF Producer field

pdfremotestartview pdfremotestartview Fit Fit -

starting view of remote PDF documents

pdfstartpage pdfstartpage 1 1 -

page at which PDF document opens

pdfstartview pdfstartview Fit Fit -

starting view of PDF document

pdfsubject pdfsubject empty empty -

text for PDF Subject field

pdftex pdftex -

use

use pdfTeX backend

pdftitle pdftitle empty empty -

text for PDF Title field

pdftoolbar pdftoolbar true true -

make PDF toolbar visible

pdftrapped pdftrapped empty empty -

Sets the document information Trapped entry. +

Sets the document information Trapped entry. Possible values are True, False and Unknown. An empty value means, the entry is not set.

pdfview pdfview XYZ XYZ -

PDF ‘view’ when on link traversal

pdfviewarea pdfviewarea empty empty -

set /ViewArea of viewer preferences

pdfviewclip pdfviewclip empty empty -

set /ViewClip of viewer preferences

pdfwindowui pdfwindowui true true -

make PDF user interface elements visible

plainpages plainpages false false -

do page number anchors as plain Arabic

ps2pdf ps2pdf -

use

use ps2pdf backend

psdextra psdextra false false -

define more short names for PDF string +

define more short names for PDF string commands

raiselinks raiselinks false false -

raise up links (for

raise up links (for HyperTeX backend)

runbordercolor runbordercolor 0 .7 .7 0 .7 .7 -

color of border around ‘run’ links

runcolor runcolor filecolor filecolor -

color of ‘run’ links

setpagesize setpagesize true true -

set page size by special driver commands

tex4ht tex4ht -

use

use TeX4ht backend

textures textures -

use

use Textures backend

unicode unicode true 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, but this is not recommended.

urlbordercolor urlbordercolor 0 1 1 0 1 1 -

color of border around URL links

urlcolor urlcolor magenta magenta -

color of URL links

verbose verbose false false -

be chatty

vtex vtex -

use

use VTeX backend

xetex 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 + id="x1-230006">Additional user macros

+

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

\href[}{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 options recognizes the hyperref options

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{URL{URL}}. Depending on the driver \href also tries to detect the link -type. Thus the result can be a url link, file link, … -

url package and +its commands can be used to format and fine tune the url, but the behaviour of \url is different to the +behaviour in the url package: Most importantly the hyperref \url expands commands. If the behaviour or +the original \url is needed, the url package should be loaded first and the command should be copied +into some alias command. +

\nolinkurl{URL}
-

Write

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

\url described above, without creating a hyperlink. +

\hyperbaseurl{URL}
-

A base

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

\hyperimage{}{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. -

\hyperdef{}{text}
-

A target area of the document (the

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

\hyperref{}{text}
-

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

\hyperref[]{text}
-

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

\hyperlink{}{text}
-

\hypertarget{}{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, bibliography, preface). \addcontentsline refers to the latest previous location where an anchor is set. -Example: - +Example:

-
+     
 \cleardoublepage
 \phantomsection
 \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. -

\hyperget{}{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 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. -

\hyperget
\hyperget{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{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,149 +4636,149 @@ 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. -

+

+> +

Figure

+

Table

+

Part

+

Appendix

+

Equation

+

item

+

chapter

+

section

+

subsection

+

subsubsection

+

paragraph

+

footnote

+

Equation

+

Theorem

+

page

Macro Macro -

Default

\figurename \figurename -

Figure

\tablename \tablename -

Table

\partname \partname -

Part

\appendixname \appendixname -

Appendix

\equationname \equationname -

Equation

\Itemname \Itemname -

item

\chaptername \chaptername -

chapter

\sectionname \sectionname -

section

\subsectionname \subsectionname -

subsection

\subsubsectionname \subsubsectionname -

subsubsection

\paragraphname \paragraphname -

paragraph

\Hfootnotename \Hfootnotename -

footnote

\AMSname \AMSname -

Equation

\theoremname \theoremname -

Theorem

\page \page -

page

-

Example for a redefinition if

Example for a redefinition if babel is used:

-
+     
 \usepackage[ngerman]{babel}
 \addto\extrasngerman{%
   \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 @@ -4610,7 +4790,7 @@ lemmas:

-
+     
 \documentclass{article}
 
 \usepackage{aliascnt}
@@ -4638,87 +4818,87 @@ We will use \autoref{a} to prove \auto
 
 \end{document}
 
-

-

+

\autopageref{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}
-

\pageref*{label}
-

\autoref*{label}
-

\autopageref*{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. -

\pdfstringdef{}{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:

  • -

    Switching to PD1 or PU encoding +

    Switching to PD1 or PU encoding

  • -

    Defining the “octal sequence commands” (

    Defining the “octal sequence commands” (\345): \edef\3{\string\3}

  • -

    Special glyphs of TeX:

    Special glyphs of TeX: \{, \%, \&, \space, \dots, etc.

  • -

    National glyphs (

    National glyphs (german.sty, french.sty, etc.)

  • -

    Logos:

    Logos: \TeX, \eTeX, \MF, etc.

  • -

    Disabling commands that do not provide useful functionality in bookmarks:

    Disabling commands that do not provide useful functionality in bookmarks: \label, \index, \def, \let, etc.

  • -

    LaTeX’s font commands like

    LaTeX’s font commands like \textbf, etc.

  • -

    Support for

    Support for \xspace provided by the xspace package

-

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

\begin{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

-

+ id="x1-240006.1">Bookmark macros +

6.1.1 Setting bookmarks
-

Usually Setting bookmarks +

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

\pdfbookmark[}{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). -

\currentpdfbookmark{}{name}
-

creates a bookmark at the current level. -

creates a bookmark at the current level. +

\subpdfbookmark{}{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. -

\belowpdfbookmark{}{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:

  • -

    Usually only one LaTeX run is needed. +

    Usually only one LaTeX run is needed.

  • -

    More control over the bookmark appearance (color, font). +

    More control over the bookmark appearance (color, font).

  • -

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

-

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
-

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

\texorpdfstring{}{PDFstring}
-

For example, +

For example, -

+   
 \section{Pythagoras:
   \texorpdfstring{$ a^2 + b^2 = c^2 $}{%
     a\texttwosuperior\ + b\texttwosuperior\ =
@@ -4920,73 +5100,73 @@ 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. -

+   
 \expandafter\def\expandafter\pdfstringdefPreHook
 \expandafter{%
   \pdfstringdefPreHook
   \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 names): -

+   
 \pdfstringdefDisableCommands{%
   \let~\textasciitilde
   \def\url{\pdfstringdefWarn\url}%
   \let\textcolor\@gobble
 }
 
-

-

+

+

6.2 Pagelabels

-

Pagelabels +

\thispdfpagelabel{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

-

Utility macros +

\hypercalcbp{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, -

+     
 \hypersetup{
   pdfstartview={FitBH \hypercalcbp{\paperheight-\topmargin-1in
     -\headheight-\headsep}
 }
 
-

-

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 FeaturesNew Features5

+ id="x1-29001f5">

7.1 Option ‘pdflinkmargin’

-

Option ‘pdflinkmargin’ is an experimental option for specifying a link margin, if the driver supports this. + id="x1-300007.1">Option ‘pdflinkmargin’ +

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 + id="x1-310007.2">Field option ‘calculatesortkey’ +

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 -example the heading of the table of contents an anchor name which can be referenced with a bookmark -command. + id="x1-320007.3">Option ‘next-anchor’ +

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 from the bookmark package: -

+   
 \hypersetup{next-anchor=toc}
 \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 Option ‘localanchorname’ +

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

+   
     \section{Foobar}
     \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 + id="x1-340007.5">Option ‘customdriver’ +

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 + id="x1-350007.6">Option ‘psdextra’ +

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,20 +5324,20 @@ 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 + id="x1-360007.7">\XeTeXLinkBox +

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

+   
     % xelatex
     \documentclass{article}
     \usepackage{hyperref}
@@ -5173,68 +5351,71 @@ class="ec-lmvtt-10">\XeTeXLinkMargin. The default is 2pt.
     }
     \end{document}
 
-

-

+

+

7.8 \IfHyperBooleanExists and \IfHyperBoolean

+ id="x1-370007.8">\IfHyperBooleanExists and \IfHyperBoolean -
+   
  \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. -

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

+class="ec-lmvtt-10">\MaybeStopNow end hyperref prematurely. +

7.9 \unichar

-

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

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

+   
     \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: -

+   
     \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 + id="x1-390007.10">\ifpdfstringunicode +

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,21 +5426,22 @@ 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: -

+   
     \def\Thanh{%
       H\‘an~%
       Th\^e\llap{\raise 0.5ex\hbox{\’{}}}%
       ~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 \unichar. The character in question is: -

+   
     % U+1EC3 LATIN SMALL LETTER E WITH CIRCUMFLEX AND HOOK ABOVE
 
-

Thus we can put this together: +

Thus we can put this together: -

+   
     \def\Thanh{%
       H\‘an~%
       \texorpdfstring{Th\^e\llap{\raise 0.5ex\hbox{\’{}}}}%
@@ -5281,11 +5463,11 @@ 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: -

+   
     \def\Thanh{%
       \texorpdfstring{%
         H\‘an~%
@@ -5300,23 +5482,24 @@ 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 Customizing index style file with \nohyperpage +

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 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,\nohyperpage, e.g.: -

+   
     suffix_2p "\\nohyperpage{f.}"
     suffix_3p "\\nohyperpage{ff.}"
 
-

(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 + id="x1-410007.12">Experimental option ‘ocgcolorlinks’ +

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.

  • -

    The option must be given for package loading:

    The option must be given for package loading: \usepackage[ocgcolorlinks]{hyperref}

  • -

    Main disadvantage: Links cannot be broken across lines. PDF reference 1.7: 4.10.2 “Making +

    Main disadvantage: Links cannot be broken across lines. PDF reference 1.7: 4.10.2 “Making Graphical Content Optional”: Graphics state operations, such as setting the color, ..., are still applied. Therefore the link text is put in a box and set twice, with and without color.

  • -

    The feature can be switched of by

    The feature can be switched of by \hypersetup{ocgcolorlinks=false} inside the document.

  • -

    Supported drivers: pdftex, dvipdfm +

    Supported drivers: pdftex, dvipdfm

  • -

    The PDF version should be at least 1.5. It is automatically set for pdfTeX, LuaTeX and +

    The PDF version should be at least 1.5. It is automatically set for pdfTeX, LuaTeX and dvipdfmx.

-

+

7.13 Option ‘pdfa’

-

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, + id="x1-420007.13">Option ‘pdfa’ +

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:

  • -

    Enabled annotation flags: Print, NoZoom, NoRotate [PDF/A 6.5.3]. +

    Enabled annotation flags: Print, NoZoom, NoRotate [PDF/A 6.5.3].

  • -

    Disabled annotation flags: Hidden, Invisible, NoView [PDF/A 6.5.3]. +

    Disabled annotation flags: Hidden, Invisible, NoView [PDF/A 6.5.3].

  • -

    Disabled: Launch action (

    Disabled: Launch action ([PDF/A 6.6.1].

  • -

    Restricted: Named actions (NextPage, PrevPage, FirstPage, LastPage) [PDF/A 6.6.1]. +

    Restricted: Named actions (NextPage, PrevPage, FirstPage, LastPage) [PDF/A 6.6.1].

  • -

    Many things are disabled in PDF formulars: +

    Many things are disabled in PDF formulars:

    • -

      JavaScript actions [PDF/A 6.6.1] +

      JavaScript actions [PDF/A 6.6.1]

    • -

      Trigger events (additional actions) [PDF/A 6.6.2] +

      Trigger events (additional actions) [PDF/A 6.6.2]

    • -

      Push button (because of JavaScript) +

      Push button (because of JavaScript)

    • -

      Interactive Forms: Flag NeedAppearances is the default ‘false’ (Because of this, - hyperref’s implementation of Forms looks ugly). [PDF/A 6.9]

    +

    Interactive Forms: Flag NeedAppearances is the default ‘false’ (Because of this, + hyperref’s implementation of Forms looks ugly). [PDF/A 6.9]

-

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 (

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 + id="x1-430007.14">Option ‘linktoc’ added +

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

  • -

    ‘linktoc=none’ (no links) +

    ‘linktoc=none’ (no links)

  • -

    ‘linktoc=section’ (default behaviour, same as ‘linktocpage=false’) +

    ‘linktoc=section’ (default behaviour, same as ‘linktocpage=false’)

  • -

    ‘linktoc=page’ (same as ‘linktocpage=true’) +

    ‘linktoc=page’ (same as ‘linktocpage=true’)

  • -

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

-

+

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

7.15 Option ‘pdfnewwindow’ changed

-

Before 6.77b: + id="x1-440007.15">Option ‘pdfnewwindow’ changed +

Before 6.77b:

  • -

    pdfnewwindow=true

    pdfnewwindow=true /NewWindow true

  • -

    pdfnewwindow=false

    pdfnewwindow=false (absent)

  • -

    unused pdfnewwindow

    unused pdfnewwindow (absent)

-

Since 6.77b: +

Since 6.77b:

  • -

    pdfnewwindow=true

    pdfnewwindow=true /NewWindow true

  • -

    pdfnewwindow=false

    pdfnewwindow=false /NewWindow false

  • -

    pdfnewwindow=

    pdfnewwindow= (absent)

  • -

    unused pdfnewwindow

    unused pdfnewwindow (absent)

-

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 (Flag options for PDF forms +

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:

  • -

    Table 8.16 Annotation flags (page 608): -

    +

    Table 8.16 Annotation flags (page 608): +


    1 Invisible
    2 Hidden (PDF 1.2)
    3 Print (PDF 1.2) @@ -5494,23 +5681,23 @@ class="ec-lmvtt-10">http://www.adobe.com/devnet/acrobat/pdfs/pdf_reference.pdf10 LockedContents (PDF 1.7)
  • -

    Table 8.70 Field flags common to all field types (page 676): -

    +

    Table 8.70 Field flags common to all field types (page 676): +


    1 ReadOnly
    2 Required
    3 NoExport
  • -

    Table 8.75 Field flags specific to button fields (page 686): -

    +

    Table 8.75 Field flags specific to button fields (page 686): +


    15 NoToggleToOff (Radio buttons only)
    16 Radio (set: radio buttons, clear: check box, pushbutton: clear)
    17 Pushbutton
    26 RadiosInUniso (PDF 1.5)
  • -

    Table 8.77 Field flags specific to text fields (page 691): -

    +

    Table 8.77 Field flags specific to text fields (page 691): +


    13 Multiline
    14 Password
    21 FileSelect (PDF 1.4) @@ -5521,8 +5708,8 @@ class="ec-lmvtt-10">http://www.adobe.com/devnet/acrobat/pdfs/pdf_reference.pdf
  • -

    Table 8.79 Field flags specific to choice fields (page 693): -

    +

    Table 8.79 Field flags specific to choice fields (page 693): +


    18 Combo (set: combo box, clear: list box)
    19 Edit (only useful if Combo is set)
    20 (Sort) for authoring tools, not PDF viewers @@ -5531,8 +5718,8 @@ class="ec-lmvtt-10">http://www.adobe.com/devnet/acrobat/pdfs/pdf_reference.pdf27 CommitOnSelChange (PDF 1.5)
  • -

    Table 8.86 Flags for submit-form actions (page 704): -

    +

    Table 8.86 Flags for submit-form actions (page 704): +


    [1 Include/Exclude] unsupported, use ‘noexport’ (table 8.70) instead
    2 IncludeNoValueFields
    [3 ExportFormat] handled by option ‘export’ @@ -5547,35 +5734,35 @@ class="ec-lmvtt-10">http://www.adobe.com/devnet/acrobat/pdfs/pdf_reference.pdf12 ExclFKey (PDF 1.4)
    14 EmbedForm (PDF 1.5)
-

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

  • -

    FDF +

    FDF

  • -

    HTML +

    HTML

  • -

    XFDF +

    XFDF

  • -

    PDF (not supported by Acrobat Reader)

-

+

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 + id="x1-460007.17">Option ‘pdfversion’ +

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.

  • -

    pdfTeX below 1.10a: unsupported. pdfTeX

    pdfTeX below 1.10a: unsupported. pdfTeX 1.10a and < 1.30: \pdfoptionpdfminorversion pdfTeX 1.30: \pdfminorversion

  • -

    dvipdfm: configuration file, example: TeX Live 2007, texmf/dvipdfm/config/config, entry ‘V +

    dvipdfm: configuration file, example: TeX Live 2007, texmf/dvipdfm/config/config, entry ‘V 2’.

  • -

    dvipdfmx: configuration file, example: TeX Live 2007, texmf/dvipdfm/dvipdfmx.cfg, entry +

    dvipdfmx: configuration file, example: TeX Live 2007, texmf/dvipdfm/dvipdfmx.cfg, entry ‘V 4’.

  • -

    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

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: + id="x1-470007.18">Field option ‘name’ +

Many form objects uses the label argument for several purposes:

  • -

    Layouted label. +

    Layouted label.

  • -

    As name in HTML structures.

-

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: + id="x1-480007.19">Option ‘pdfencoding’ +

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:

  • -

    pdfdoc uses PDFDocEncoding. It uses just one byte per character, but the supported characters are limited (244 in PDF-1.7).

  • -

    unicode sets Unicode. It is encoded as UTF-16BE. Two bytes are used for most characters, surrogates need four bytes.

  • -

    auto PDFDocEncoding if the string does not contain characters outside the encoding (outside ascii if an unicode engine is used) and Unicode otherwise. This option is not intended for the unicode engines.

-

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

+ id="x1-490007.20">Color options/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 + id="x1-500007.21">Option pdfusetitle +

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

-

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 Link border style +

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:

  • -

    AR7/Linux seems to have a bug, that don’t use the default value

    AR7/Linux seems to have a bug, that don’t use the default value 1 for the width, but zero, thus that the underline is not visible without /W 1. The same applies for dashed pdfborderstyle=/S/D/D[3 2]/W 1

  • -

    The syntax is described in the PDF specification, look for “border style”, eg. Table 8.13 +

    The syntax is described in the PDF specification, look for “border style”, eg. Table 8.13 “Entries in a border style dictionary” (specification for version 1.6)

  • -

    The border style is removed by pdfborderstyle= This is automatically done if option +

    The border style is removed by pdfborderstyle= This is automatically done if option colorlinks is enabled.

  • -

    Be aware that not all PDF viewers support this feature, not even Acrobat Reader itself: -

    Some support: +

    Be aware that not all PDF viewers support this feature, not even Acrobat Reader itself: +

    Some support:

    • -

      AR7/Linux:

      AR7/Linux: underline and dashed, but the border width must be given.

    • -

      xpdf 3.00:

      xpdf 3.00: underline and dashed

    -

    Unsupported: +

    Unsupported:

    • -

      AR5/Linux +

      AR5/Linux

    • -

      ghostscript 8.50

    +

    ghostscript 8.50

-

+

7.24 Option 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:

  • -

    bookmarksdepth without value Then hyperref uses the current value of counter tocdepth. - This is the compatible behaviour and the default. +

    bookmarksdepth without value Then hyperref uses the current value of counter tocdepth. This + is the compatible behaviour and the default.

  • -

    bookmarksdepth=<number>, the value is number (also negative): The depth for the bookmarks are set to this number.

  • -

    bookmarksdepth=<name> The <name> is a document division name (part, chapter, ...). It must - not start with a digit or minus to avoid mixing up with the number case. Internally hyperref uses + not start with a digit or minus to avoid mixing up with the number case. Internally hyperref uses the value of macro \toclevel@<name>. Examples: -

    +     
              \hypersetup{bookmarksdepth=paragraph}
              \hypersetup{bookmarksdepth=4} % same as before
              \hypersetup{bookmarksdepth} % counter "tocdepth" is used
     
    -

-

+

+

7.25 Option 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:

  • -

    pdfescapeform=false Escaping for the formulars are disabled, this is the compatibility +

    pdfescapeform=false Escaping for the formulars are disabled, this is the compatibility behaviour, therefore this is the default.

  • -

    pdfescapeform=true Then the PS/PDF drivers do all the necessary escaping. This is the +

    pdfescapeform=true Then the PS/PDF drivers do all the necessary escaping. This is the logical choice and the recommended setting. For example, the user writes JavaScript as JavaScript and do not care about escaping characters for PS/PDF output.

-

+

7.26 Default driver setting

-

(hyperref 6.72s) If no driver is given, hyperref tries its best to guess the most suitable + id="x1-550007.26">Default driver setting +

(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 -corresponding VTeX driver for VTeX’s working modes. Unhappily many driver programs run -after the TeX compiler, so hyperref does not have a chance (dvips, dvipdfm, ...). In this +corresponding VTeX driver for VTeX’s working modes. Unhappily many driver programs +run after the TeX compiler, so hyperref does not have a chance (dvips, dvipdfm, ...). In this case driver hypertex is loaded that supports the HyperTeX features that are recognized by xdvi for example. This behaviour, however, can easily be changed in the configuration file @@ -5781,24 +5973,25 @@ xdvi for example. This behaviour, however, can easily be changed in the configur 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: + id="x1-560007.27">Backref entries +

Alternative interface for formatting of backref entries, example: -

+   
 \documentclass[12pt,UKenglish]{article}
 
 \usepackage{babel}
@@ -5888,30 +6081,30 @@ class="ec-lmvtt-10">hyperref.cfg:
 
 \end{document}
 
-

-

+

+

7.28 \phantomsection

-

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

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

+   
   \cleardoublepage
   \phantomsection
   \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 puenc encoding, puenc-greekbasic.def and puenc-extra.def +

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.

  • -

    A number of command are only defined conditionally: The commands for the cyrillic block +

    A number of command are only defined conditionally: The commands for the cyrillic block if \CYRDZE is defined, greek if \textBeta is defined, and hebrew if \hebdalet is defined. -

    The greek block is in an extra file,

    The greek block is in an extra file, puenc-greekbasic.def, which can be loaded manually if needed.

  • -

    Other commands are moved to an extra file

    Other commands are moved to an extra file puenc-extra.def which is not loaded automatically, but can be loaded in the preamble if needed. Currently this file contains all definitions for the accent \G.

-

+

8 Acrobat-specific behavior

-

If you want to access the menu options of Acrobat Reader or Exchange, the following macro is provided + id="x1-590008">Acrobat-specific behavior +

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

\Acrobatmenu{}{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. -

+

+ id="x1-59001r13"> -

+> +

Properties

+

About

File File -

Open, +

Open, Close, Scan, Save, @@ -5984,37 +6177,37 @@ class="td10"> PageSetup, Quit

FileImport →Import -

ImportImage, +

ImportImage, ImportNotes, AcroForm:ImportFDF

FileExport →Export -

ExportNotes, +

ExportNotes, AcroForm:ExportFDF

FileDocumentInfo →DocumentInfo -

GeneralInfo, +

GeneralInfo, OpenInfo, FontsInfo, SecurityInfo, Weblink:Base, AutoIndex:DocInfo

FilePreferences →Preferences -

GeneralPrefs, +

GeneralPrefs, NotePrefs, FullScreenPrefs, Weblink:Prefs, @@ -6023,10 +6216,10 @@ class="td10"> AcroSearch:Prefs(Mac), Cpt:Capture

Edit Edit -

Undo, +

Undo, Cut, Copy, Paste, @@ -6039,24 +6232,24 @@ class="td10"> TouchUp:ShowCaptureSuspects, TouchUp:FindSuspect,

-

Properties

EditFields →Fields -

AcroForm:Duplicate, +

AcroForm:Duplicate, AcroForm:TabOrder

Document Document -

Cpt:CapturePages, +

Cpt:CapturePages, AcroForm:Actions, CropPages, RotatePages, @@ -6069,10 +6262,10 @@ class="td10"> CreateAllThumbs, DeleteAllThumbs

View View -

ActualSize, +

ActualSize, FitVisible, FitWidth, FitPage, @@ -6093,10 +6286,10 @@ class="td10"> ShowBookmarks, ShowThumbs

Tools Tools -

Hand, +

Hand, ZoomIn, ZoomOut, SelectText, @@ -6114,11 +6307,11 @@ class="td10">

ToolsSearch →Search -

AcroSrch:Query, +

AcroSrch:Query, AcroSrch:Indexes, AcroSrch:Results, AcroSrch:Assist, @@ -6127,10 +6320,10 @@ class="td10"> AcroSrch:NextHit, AcroSrch:NextDoc

Window Window -

ShowHideToolBar, +

ShowHideToolBar, ShowHideMenuBar, ShowHideClipboard, Cascade, @@ -6138,10 +6331,10 @@ class="td10"> TileVertical, CloseAll

Help Help -

HelpUserGuide, +

HelpUserGuide, HelpTutorial, HelpExchange, HelpScan, @@ -6153,220 +6346,220 @@ class="td10"> HelpReader, Weblink:Home

Help(Windows) Help(Windows) -

About

-

+

9 PDF and HTML forms

-

You must put your fields inside a PDF and HTML forms +

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

-
\TextField[parameters]{label}
-

\CheckBox\TextField[parameters]{label}
-

\ChoiceMenu\CheckBox[parameters]{label}{choices}
-

\PushButton\ChoiceMenu[parameters]{label}{choices}
-

\Submit\PushButton[parameters]{label}
-

\Reset\Submit[parameters]{label}
-

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

\LayoutTextField{\Reset[parameters]{label}{field}
-

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

\LayoutChoiceField\LayoutTextField{label}{field}
-

\LayoutCheckField\LayoutChoiceField{label}{field}
-

These macros default to #1 #2 -

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

\MakeRadioField\LayoutCheckField{widthlabel}{heightfield}
-

These macros default to #1 #2 +

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

\MakeCheckField\MakeRadioField{width}{height}
-

\MakeTextField\MakeCheckField{width}{height}
-

\MakeChoiceField\MakeTextField{width}{height}
-

+
\MakeChoiceField{width}{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: -

+   
 \def\DefaultHeightofSubmit{12pt}
 \def\DefaultWidthofSubmit{2cm}
 \def\DefaultHeightofReset{12pt}
@@ -6391,561 +6584,562 @@ class="ec-lmvtt-10">\Reset macros.
 \def\DefaultHeightofTextMultiline{4\baselineskip}
 \def\DefaultWidthofText{3cm}
 
-

-

+

+

9.1 Forms environment parameters

-

+ id="x1-610009.1">Forms environment parameters +

+>
action action URL 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

encoding encoding name 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

method method name 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. Forms optional parameters +

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

+

+>
accesskey key accesskey key (as per HTML)
align number align number 0 0 alignment within text field; 0 is left-aligned,
1 is centered, 2 is right-aligned.
altname name altname name alternative name,
the name shown in the user interface
backgroundcolor backgroundcolor color of box
bordercolor bordercolor color of border
bordersep bordersep box border gap
borderstyle char borderstyle char S S box border style; S (Solid) is default, B is Beveled,
D is Dashed, I is Inset and U is Underline
borderwidth borderwidth 1 1 width of box border, the value is a dimension
or a number with default unit bp
calculate calculate JavaScript code to calculate the value of the field
charsize dimen charsize dimen font size of field text
checkboxsymbol char checkboxsymbol char 4 () ) symbol used for check boxes (ZapfDingbats),
the value is a character or \ding{number},
see package pifont from bundle psnfss
checked boolean checked boolean false false whether option selected by default
color color color of text in box
combo boolean combo boolean false false choice list is ‘combo’ style
default default default value
disabled boolean disabled boolean false false field disabled
format format JavaScript code to format the field
height dimen height dimen height of field box
hidden boolean hidden boolean false false field hidden
keystroke keystroke JavaScript code to control the keystrokes on entry
mappingname name mappingname name the mapping name to be used when exporting
the field data
maxlen number maxlen number 0 0 number of characters allowed in text field
menulength number menulength number 4 4 number of elements shown in list
multiline boolean multiline boolean false false whether text box is multiline
name name name name name of field (defaults to label)
onblur onblur JavaScript code
onchange onchange JavaScript code
onclick onclick JavaScript code
ondblclick ondblclick JavaScript code
onfocus onfocus JavaScript code
onkeydown onkeydown JavaScript code
onkeypress onkeypress JavaScript code
onkeyup onkeyup JavaScript code
onmousedown onmousedown JavaScript code
onmousemove onmousemove JavaScript code
onmouseout onmouseout JavaScript code
onmouseover onmouseover JavaScript code
onmouseup onmouseup JavaScript code
onselect onselect JavaScript code
password boolean password boolean false false text field is ‘password’ style
popdown boolean popdown boolean false false choice list is ‘popdown’ style
radio boolean radio boolean false false choice list is ‘radio’ style
radiosymbol char radiosymbol char H () ) symbol used for radio fields (ZapfDingbats),
the value is a character or \ding{number},
see package pifont from bundle psnfss
readonly boolean readonly boolean false false field is readonly
rotation number rotation number 0 0 rotation of the widget annotation
(degree, counterclockwise, multiple of 90)
tabkey tabkey (as per HTML)
validate validate JavaScript code to validate the entry
value value initial value
width dimen width dimen width of field box
-

+

10 Defining a new driver

-

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

1. Defining a new driver +

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 -

+   
 \let\hyper@@anchor\@gobble
 \gdef\hyper@link##1##2##3{##3}%
 \def\hyper@linkurl##1##2{##1}%
@@ -6955,105 +7149,126 @@ class="ec-lmvtt-10">\hyper@linkend
 \let\hyper@linkstart\@gobbletwo
 \let\hyper@linkend\@empty
 
-

-

+

+

11 Special support for other packages

-

Package hyperref aims to cooperate with other packages, but there are several possible sources for -conflict, such as + id="x1-6400011">Special support for other packages +

Package hyperref aims to cooperate with other packages, but while the long term goal is to remove +patches and to move link support into the kernel, classes and packages there are still several possible +sources for conflict, such as

  • -

    Packages that manipulate the bibliographic mechanism. Peter William’s harvard package is - supported. However, the recommended package is Patrick Daly’s natbib package that has - specific hyperref hooks to allow reliable interaction. This package covers a very wide variety - of layouts and citation styles, all of which work with

    Packages that manipulate the bibliographic mechanism. Peter William’s harvard package + is supported. However, the recommended package is either Patrick Daly’s natbib package + that has specific hyperref hooks to allow reliable interaction or the biblatex package. Both + packages cover a very wide variety of layouts and citation styles, all of which work with + hyperref.

  • -

    Packages that changes

    Packages that changes \label and \ref macros. +class="ec-lmvtt-10">\ref macros. Since LaTeX 2023-06-01 the kernel and + hyperref/nameref use the same \label definition. \label has a hook for external packages. + There should be no need for external packages and classes to redefine them.

  • -

    Packages that do anything serious with the index. +

    Packages that do anything serious with the index.

  • -

    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 LATEX’s normal +

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

The hyperref package is distributed with a variant of the xr, xr-hyper6 , +which support crossdocument links using LATEX’s normal \label/\ref mechanisms and per-chapter tables of contents, respectively. -

+class="ec-lmvtt-10">\ref mechanisms. + +

11.1 Package Compatibility

-

Currently only package loading orders are available: -

+ id="x1-6500011.1">Package Compatibility +

Currently only package loading orders are available: +

11.1.1 algorithm
+ id="x1-6600011.1.1">algorithm -
+                                                                                 
+   
  \usepackage{float}
   \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 + id="x1-6700011.1.2">amsmath +

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 gather: -

+   
   \usepackage{amsmath}
   \let\equation\gather
   \let\endequation\endgather
 
-

-

+

+

11.1.3 amsrefs
-

Package loading order: + id="x1-6800011.1.3">amsrefs +

The documentation of amsrefs claims that the package must be loaded after hyperref (it is unclear if that +is really true) so the recommended package loading order is: -

+   
   \usepackage{hyperref}
   \usepackage{amsrefs}
 
-

-

+

+

11.1.4 arydshln, longtable
-

Package longtable must be put before hyperref and arydshln, hyperref after arydshln generates an error, + id="x1-6900011.1.4">arydshln, longtable +

Package longtable must be put before hyperref and arydshln, hyperref after arydshln generates an error, thus the resulting package order is then: -

+   
   \usepackage{longtable}
   \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 + id="x1-7000011.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 Szabó, see CTAN:language/hungarian/babel/. -

+

11.1.6 babel/spanish.ldf
-

Babel’s spanish.ldf redefines ‘babel/spanish.ldf +

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: + id="x1-7200011.1.7">bibentry +

Workaround: -

+   
   \makeatletter
   \let\saved@bibitem\@bibitem
   \makeatother
@@ -7083,53 +7298,40 @@ 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 -and disables them (hyperfootnotes=false). -

+ id="x1-7300011.1.8">bigfoot +

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 \@addtoreset that is redefined by ‘hyperref’. The package order is -therefore: + id="x1-7400011.1.9">chappg +

Package chappg uses \@addtoreset that is redefined by hyperref. The package order is 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 -via: - - -

- \makeatletter
- \def\NAT@parse{\typeout{This is a fake Natbib command to fool Hyperref.}}
- \makeatother
-
- \usepackage[hypertex]{hyperref}
-
-

-

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 count1to +

Package ‘count1to’ adds several \@addtoreset commands that confuse ‘hyperref’. Therefore \theH<...> has to be fixed: -

+   
   \usepackage{count1to}
   \AtBeginDocument{% *after* \usepackage{count1to}
     \renewcommand*{\theHsection}{\theHchapter.\arabic{section}}%
@@ -7139,212 +7341,171 @@ has to be fixed:
     \renewcommand*{\theHsubparagraph}{\theHparagraph.\arabic{subparagraph}}%
   }
 
-

-

-

11.1.12 dblaccnt
-

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

+

+

11.1.11 dblaccnt
+

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

+   
   \usepackage{hyperref}
   \usepackage{dblaccnt}
 
-

or see entry for

or see entry for vietnam. -

+

+

11.1.12 easyeqn
+

Not compatible, breaks. +

11.1.13 easyeqn
-

Not compatible, breaks. -

-

11.1.14 ellipsis
-

This packages redefines \textellipsis after package hyperref (pd1enc.def/puenc.def should be loaded + id="x1-7800011.1.13">ellipsis +

This packages redefines \textellipsis after package hyperref (pd1enc.def/puenc.def should be loaded 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
+

+

11.1.14 float
-
+   
  \usepackage{float}
   \usepackage{hyperref}
 
-

+

  • -

    Several

    Several \caption commands are not supported inside one float object.

  • -

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

-

+

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

+

11.1.15 endnotes
+

Unsupported. +

11.1.16 endnotes
-

Unsupported. -

-

11.1.17 foiltex
-

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

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 +class="ec-lmvtt-10">\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 +

+

11.1.17 footnote
+

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 -Then prefer the program ‘dvipdfmx’ or use one of the following workarounds to move the \special of -geometry to an earlier location: - - -

-    \documentclass[dvipdfm]{article}% or other classes
-    \usepackage{atbegshi}
-    \AtBeginDocument{%
-      \let\OrgAtBeginDvi\AtBeginDvi
-      \let\AtBeginDvi\AtBeginShipoutFirst
-    }
-    \usepackage[
-      paperwidth=170mm,
-      paperheight=240mm
-    ]{geometry}
-    \AtBeginDocument{%
-      \let\AtBeginDvi\OrgAtBeginDvi
-    }
-    \usepackage{hyperref}
-
-  or
-
-    \documentclass[dvipdfm]{article}% or other classes
-    \usepackage{atbegshi}
-    \let\AtBeginDvi\AtBeginShipoutFirst
-    \usepackage[
-      paperwidth=170mm,
-      paperheight=240mm
-    ]{geometry}
-    \usepackage{hyperref}
-
-

-

-

11.1.20 IEEEtran.cls
-

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

-

11.1.21 index
-

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

-

11.1.22 lastpage
-

Compatible. -

-

11.1.23 linguex
+

+

11.1.18 linguex
-
+   
  \usepackage{hyperref}
   \usepackage{linguex}
 
-

-

-

11.1.24 ltabptch
+

+

+

11.1.19 ltabptch
-
+   
  \usepackage{longtable}
   \usepackage{ltabptch}
   \usepackage{hyperref}
 
-

-

-

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

-

11.1.27 multind
+

+

+

11.1.20 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.21 minitoc-hyper
+

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

+

11.1.22 multind
-
+   
  \usepackage{multind}
   \usepackage{hyperref}
 
-

-

-

11.1.28 natbib
+

+

+

11.1.23 natbib
-
+   
  \usepackage{natbib}
   \usepackage{hyperref}
 
-

-

-

11.1.29 nomencl
-

Example for introducing links for the page numbers: +

+

+

11.1.24 nomencl
+

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: +

+

+

11.1.25 ntheorem-hyper
+

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

For equations the following might work: -

+   
       \renewcommand*{\eqdeclaration}[1]{%
         \hyperlink{equation.#1}{(Equation~#1)}%
       }
     But the mapping from the equation number to the anchor name
     is not available in general.
 
-

-

-

11.1.31 prettyref
+

+

+

11.1.26 prettyref
-
+   
 %%% example for prettyref %%%
 \documentclass{article}
 \usepackage{prettyref}
@@ -7364,56 +7525,63 @@ properly, for example.
 %%% example for prettyref %%%
       
 
-

-

-

11.1.32 setspace
+

+

+

11.1.27 setspace
-
+   
  \usepackage{setspace}
   \usepackage{hyperref}
 
-

-

-

11.1.33 sidecap
-

Nothing special is needed anymore. -

-

11.1.34 subfigure
-

The package is obsolete. Use either

+

+

11.1.28 sidecap
+

Nothing special is needed anymore. +

+

11.1.29 subfigure
+

The package is obsolete. Use either subfig or subcaption -

-

11.1.35 titleref
+

+

11.1.30 titleref
-
+   
  \usepackage{nameref}
   \usepackage{titleref}% without usetoc
   \usepackage{hyperref}
 
-

-

-

11.1.36 tabularx
-

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

+

+

11.1.31 tabularx
+

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 -macro for speeding up the next calls of that UTF8 sequence. However this makes the first call +class="ec-lmvtt-10">\footnotetext, see section ‘Limitations’. Before version 2011/09/28 6.82i hyperref had +disabled footnotes entirely by hyperfootnotes=false. +

+

11.1.32 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.33 ucs/utf8x.def
+

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

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 \PrerenderUnicode or \PreloadUnicodePage to solve this: -

+   
     \usepackage{ucs}
     \usepackage[utf8x]{inputenc}
     \usepackage{hyperref}% or with option unicode
     \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 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 -now unsupported. -

Perhaps you are lucky and some of the features of varioref works with the following loading -order: - - -

-    \usepackage{nameref}
-    \usepackage{varioref}
-    \usepackage{hyperref}
-
-

-

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

    -
  • -

    \Ref, \Vref do not uppercase the first letter. -

  • -
  • -

    \vpageref[]{...} On the same page a previous space is not suppressed.

-

-

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): +

+

11.1.34 varioref
+

Most previous problems with varioref should be resolved. There is only an open issue regarding +\vrefformat (https://github.com/latex3/hyperref/issues/225). +

It is recommended to load varioref always with the option nospace, see the documentation.

-  \documentclass{article}
-
-  % package order does not matter
-  \usepackage{verse}
-  \usepackage{hyperref}
-
-  \makeatletter
-  % make unique poemline anchors
-  \newcounter{verse@env}
-  \setcounter{verse@env}{0}
-  \let\org@verse\verse
-  \def\verse{%
-    \stepcounter{verse@env}%
-    \org@verse
-  }
-  \def\theHpoemline{\arabic{verse@env}.\thepoemline}
-
-  % add anchor for before \addcontentsline in \@vsptitle
-  \let\org@vsptitle\@vsptitle
-  \def\@vsptitle{%
-    \phantomsection
-    \org@vsptitle
-  }
-  \makeatother
-
-  \begin{document}
-
-  \poemtitle{Poem 1}
-  \begin{verse}
-  An one-liner.
-  \end{verse}
-
-  \newpage
-
-  \poemtitle{Poem 2}
-  \begin{verse}
-  Another one-liner.
-  \end{verse}
-
-  \end{document}
+    \usepackage[nospace]{varioref}
 
-

-

-

11.1.41 vietnam
+

+

+

11.1.35 verse
+

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

+

11.1.36 vietnam
@@ -7520,20 +7632,21 @@ 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

+

+

11.1.37 XeTeX
+

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

+ id="x1-10300012">Limitations7

12.1 Wrapped/broken link support

-

Only few drivers support automatically wrapped/broken links, e.g. pdftex, dvipdfm, hypertex. Other + id="x1-10400012.1">Wrapped/broken link support +

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

Workarounds: +

Workarounds:

  • -

    For long section or caption titles in the table of contents or list of figures/tables option +

    For long section or caption titles in the table of contents or list of figures/tables option linktocpage can be used. Then the page number will be a link, and the overlong section title is not forced into an one line link with overfull \hbox warning.

  • -

    \url”s are caught by package breakurl.

  • -

    The option

    The option breaklinks is intended for internal use. But it can be used to force link wrapping, e.g. when printing a document. However, when such a document is converted to PDF and viewed with a PDF viewer, the active link area will be misplaced. -

    Another limitation: some penalties are “optimized” by TeX, thus there are missing break +

    Another limitation: some penalties are “optimized” by TeX, thus there are missing break points, especially within \url. (See thread “hyperref.sty, breaklinks and url.sty 3.2” in comp.text.tex 2005-09).

-

+

12.2 Links across pages

-

In general they have problems: + id="x1-10500012.2">Links across pages +

In general they have problems:

  • -

    Some driver doesn’t support them at all (see above). +

    Some driver doesn’t support them at all (see above).

  • -

    The driver allows it, but the link result might include the footer and/or header, or an error - message can occur sometimes.

-

+

The driver allows it, but the link result might include the footer and/or header. This can + currently (2023) be avoided by using the PDF management and to load at least the new-or-1 + module from latex-lab: + + +

+           \DocumentMetadata{testphase=new-or-1}
+           
+
+

+ +

12.3 Footnotes

-

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

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 @@ -7605,65 +7727,69 @@ class="ec-lmvtt-10">\label. Therefore it is not clear in ge which \footnotemark references which \footnotetext. But that is necessary to implement hyperlinking. -Thus the implementation of hyperref does not support the optional argument of hyperref does not support the optional argument of \footnotemark and \footnotetext. -

+

13 Hints7

+ id="x1-10700013">Hints8

13.1 Spaces in option values

-

Unhappily LaTeX strips spaces from options if they are given in Spaces in option values +

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

+ id="x1-10900013.2">Index with makeindex
  • -

    Package hyperref adds

    Package hyperref adds \hyperpage commands by the encap mechanism (see documentation of Makeindex), if option hyperindex is set (default). \hyperpage uses the page anchors that - are set by hyperref at each page (default). However in the default case page numbers are used + are set by hyperref at each page (default). However in the default case page numbers are used in anchor names in arabic form. If the page numbers in other formats are used (book class with \frontmatter, \romannumbering, ...), then the page an class="ec-lmvtt-10">plainpages=false is recommended.

  • -

    The encap mechanism of Makeindex allows to use one command only (see documentation of - Makeindex). If the user sets such a command, hyperref suppresses its

    The encap mechanism of Makeindex allows to use one command only (see documentation of + Makeindex). If the user sets such a command, hyperref suppresses its \hyperpage command. With logical markup this situation can easily be solved: -

    +     
                \usepackage{makeidx}
                \makeindex
                \usepackage[hyperindex]{hyperref}
    @@ -7686,31 +7813,32 @@ class="ec-lmvtt-10">\hyperpage command. With
                ...
                \index{Some example|main}
     
    -

    +

  • -

    Scientic Word/Scientific WorkPlace users can use package robustindex with hyperindex=false. +

    Scientic Word/Scientific WorkPlace users can use package robustindex with hyperindex=false.

  • -

    Other encap characters can be set by option

    Other encap characters can be set by option encap. Example for use of “?”: -

    +     
                \usepackage[encap=?]{hyperref}
     
    -

    +

  • -

    Another possibility is the insertion of

    Another possibility is the insertion of \hyperpage by a style file for makeindex. For this case, - hyperref’s insertion will be disabled by hyperref’s insertion will be disabled by hyperindex=false. \hyperpage will be defined regardless of setting of hyperindex. -

    +     
          %%% cut %%% hyperindex.ist %%% cut %%%
          delim_0 ", \\hyperpage{"
          delim_1 ", \\hyperpage{"
    @@ -7722,89 +7850,91 @@ class="ec-lmvtt-10">\hyperpage will be defined regardless o
          encap_suffix "}"
          %%% cut %%% hyperindex.ist %%% cut %%%
     
    -

-

+

+

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

-

Getting rid of it: +

Getting rid of it: -

+   
 \makeatletter
 \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 + id="x1-11100013.4">Link anchors in figures +

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:

+ id="x1-11200013.5">Additional unicode characters in bookmarks and pdf information entries: -
+   
 \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}): -

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

+   
     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): -

+   
     \002\047 -> \9002\047
     \036\241 -> \9036\241
 
-

-

Optional:

+

Optional: 8 is used for abbreviations: -

+   
     \900 = \80, \901 = \81, \902 = \82, ...
 
     \9002\047 -> \82\047
 
-

-

5. Declare the character with LaTeX: +

+

5. Declare the character with LaTeX: -

+   
 \DeclareTextCompositeCommand{\.}{PU}{a}{\82\047}
 \DeclareTextCompositeCommand{\d}{PU}{a}{\9036\241}
 
@@ -7813,20 +7943,21 @@ 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 Footnotes +

The footnote support is rather limited. It is beyond the scope to use \footnotemark and \footnotetext out of order or reusing \footnotemark. Here you can either disable hyperref’s footnote support by +class="ec-lmvtt-10">\footnotemark. Here you can either disable hyperref’s footnote support by hyperfootnotes=false or fiddle with internal macros, nasty examples: -

+   
 \documentclass{article}
 \usepackage{hyperref}
 \begin{document}
@@ -7875,54 +8006,59 @@ C%
 
 \end{document}
 
-

+

-

+

13.7 Subordinate counters

-

Some counters do not have unique values and require the value of other counters to be unique. For + id="x1-11400013.7">Subordinate counters +

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 reset a counter in dependency to -another counter. Package hyperref hooks into hyperref hooks into \@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 +of package amsmath is caught by hyperref. +

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 +class="ec-lmvtt-10">\@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 hyperref is loaded. +

Example for \newtheorem, problematic case: -

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

Solution a) +

Solution a) -

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

Solution b) +

Solution b) -

+   
     \newtheorem{corA}{CorollaryA}[section]
     \usepackage{hyperref}
     \newcommand*{\theHcorA}{\theHsection.\number\value{corA}}
 
-

-

+

+

14 History and acknowledgments

-

The original authors of History and acknowledgments +

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 @@ -7970,62 +8106,62 @@ class="ec-lmss-10">hyperref.

15 GNU Free Documentation License

-

Version 1.2, November 2002 -

Copyright GNU Free Documentation License +

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 + id="x1-117000">Preamble +

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 + id="x1-11800015.1">Applicability and definitions +

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 +8170,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,41 +8178,41 @@ 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, + id="x1-11900015.2">Verbatim copying +

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 copies you make or distribute. However, you may accept compensation in exchange for copies. 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 +href="#x1-12000015.3">15.3. +

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, + id="x1-12000015.3">Copying in quantity +

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 +8221,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,75 +8233,75 @@ 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 15.2 + id="x1-12100015.4">Modifications +

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 +href="#x1-12000015.3">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, + class="enumerate" id="x1-121002x1"> +

    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 + class="enumerate" id="x1-121004x2"> +

    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.

  3. -

    State on the Title page the name of the publisher of the Modified Version, as the publisher. + class="enumerate" id="x1-121006x3"> +

    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. + class="enumerate" id="x1-121008x4"> +

    Preserve all the copyright notices of the Document.

  5. -

    Add an appropriate copyright notice for your modifications adjacent to the other copyright + class="enumerate" id="x1-121010x5"> +

    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 + class="enumerate" id="x1-121012x6"> +

    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 + class="enumerate" id="x1-121014x7"> +

    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. + class="enumerate" id="x1-121016x8"> +

    Include an unaltered copy of this License.

  9. -

    Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at + class="enumerate" id="x1-121018x9"> +

    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 describing the Modified Version as stated in the previous sentence.

  10. -

    Preserve the network location, if any, given in the Document for public access to a + class="enumerate" id="x1-121020x10"> +

    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 @@ -8174,99 +8310,99 @@ Version:

  11. -

    For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the + class="enumerate" id="x1-121022x11"> +

    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 + class="enumerate" id="x1-121024x12"> +

    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 + class="enumerate" id="x1-121026x13"> +

    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 + class="enumerate" id="x1-121028x14"> +

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

  15. -

    Preserve any Warranty Disclaimers. + class="enumerate" id="x1-121030x15"> +

    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 + id="x1-12200015.5">Combining documents +

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 +href="#x1-12100015.4">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, + id="x1-12300015.6">Collections of documents +

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 + id="x1-12400015.7">Aggregation with independent works +

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 15.3 is applicable to these copies of the Document, then if +

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 + id="x1-12500015.8">Translation +

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 +href="#x1-12100015.4">15.4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of @@ -8275,53 +8411,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 +href="#x1-12100015.4">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 + id="x1-12600015.9">Termination +

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 + id="x1-12700015.10">Future revisions of this license +

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 + id="x1-128000">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 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 95b21e342ca..ce7fa93beb9 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 88f4c957531..d9d11ef0cc0 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-07-08 v7.01b} +\date{2023-10-21 v7.01c} \begin{document} @@ -830,6 +830,36 @@ plainpages & boolean & false & Forces page anchors to be named by the Arabic & & & of the page number, rather than the formatted form. \\ \end{longtable} +\subsection{Page anchors} + +In a PDF \xpackage{hyperref} adds to every page an target for links (in the upper left corner). These targets are for example used by the index to references the pages of the entries. Unlike the targets generated by other counters it is not possible to change the names of these targets by defining a \cs{theHpage} command: the name can currently not be stored in a label and so is not referenceable. Nevertheless a few options exists, they are already mentioned elsewhere in the documentation but we provide here a summary: + +\begin{description} +\item[\texttt{pageanchor}] A boolean option that determines whether every page is given an target at the top left corner. If this is turned off, \verb|\printindex| will not contain valid hyperlinks. +\item[\texttt{hypertexnames}] By default the targets have names built with \cs{thepage}: \verb|page.\thepage|, so e.g., \texttt{page.4} or \texttt{page.iii}. The names require that every page as an unique number representation. A frequent problem here is with title pages which often don't show page numbers but internally use the same number as a following page. If you get messages about \texttt{destination with the same identifier (name{page.1})}, change the number representation of title pages or disable the page target. + + If the boolean option \texttt{hypertexnames} is set to false, an internal page counter is stepped and used as arabic number. In most cases this should mean that you get the absolute page number (exceptions could be with documents throwing away or duplicating pages at shipout). This option avoids the problem with duplicated identifiers, but does not work with an index, as the backlinks have to be created from the represention passed to the index. +\item[\texttt{plainpages}] This forces page anchors to be named by the arabic form, but unlike the previous option it does not use an internal counter but the page counter. That means if you have for example roman and arabic pages you will get duplicated target names as page i and page 1 both set the anchor \texttt{page.1}. +\end{description} + +\begin{cmdsyntax} +\ci{@currentHpage} +\end{cmdsyntax} +Starting with version 7.01c \xpackage{hyperref} stores the name of the page +target it has just set into the (global) variable \cs{@currentHpage}. The +fallback value is \texttt{Doc-Start}. As the target is set when the page is +shipout, \cs{@currentHpage} is only reliable at shipout. With a +\hologo{LaTeX} format from 2023-11-01 the name can be labeled like this: + +\begin{verbatim} +%labeling in the document +\RecordProperties{mylabel}{pagetarget} +%linking to the page: +\hyperlink{\RefProperty{mylabel}{pagetarget}}{some text} +\end{verbatim} + + + \subsection{Configuration options} \begin{longtable}{>{\ttfamily}ll>{\itshape}lp{9cm}} @@ -1002,7 +1032,7 @@ next \TeX\ run if it is edited to contain the line \let\WriteBookmarks\relax \end{verbatim} -\subsection{PDF display and information options} +\subsection{PDF display and information options}\label{sec:pdfdata} \begin{longtable}{@{}>{\ttfamily}l>{\raggedright}p{\widthof{key value}}>{\itshape}lp{7cm}@{}} baseurl & URL & & Sets the base URL of the PDF document \\ pdfpagemode & name & empty & Determines how the file is opening in Acrobat; the possibilities are @@ -1014,6 +1044,8 @@ pdftitle & text & & Sets the document information Title field pdfauthor & text & & Sets the document information Author field \\ pdfsubject & text & & Sets the document information Subject field \\ pdfcreator & text & & Sets the document information Creator field \\ +pdfcreationdate & date & & Sets the creation date, see below the table for more info about the format\\ +pdfmoddate & date & & Sets the modification date, see below the table for more info about the format\\ addtopdfcreator & text & & Adds additional text to the document information Creator field \\ pdfkeywords & text & & Sets the document information Keywords field \\ pdftrapped & name & empty & Sets the document information Trapped entry. Possible values are \verb|True|, \verb|False| and \verb|Unknown|. @@ -1086,6 +1118,25 @@ pdfwindowui & boolean & true & make PDF user interface elements visible unicode & boolean & true & Unicode encoded PDF strings \end{longtable} + The dates \verb|CreationDate| and \verb|ModDate| + are normally set automatically to the current date/time when the compilation + started. If they should be changed + (e.g. for regression tests to produce reproducible documents) they can + be set with \verb|\hypersetup| with the keys + \verb|pdfcreationdate|, \verb|pdfmoddate| or externally by setting the \verb|SOURCE_DATE_EPOCH| environment variable. + + \begin{verbatim} + \hypersetup{pdfcreationdate=D:20010101205959-00'00'} + \end{verbatim} + + The format should be a full date/time in PDF format, so one of these (naturally + the numbers can change): + \begin{verbatim} + D:20010101205959-00'00' + D:20010101205959+00'00' + D:20010101205959Z + \end{verbatim} + 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 @@ -1121,12 +1172,11 @@ TwoPageLeft & Displays two pages, odd-numbered pages to the left (since PDF 1 TwoPageRight & Displays two pages, odd-numbered pages to the right (since PDF 1.5). \end{longtable} -Finally, the \texttt{pdfpagetransition} can be one of the following -values, where \textit{/Di} stands for direction of motion in degrees, -generally in 90$^{\circ}$\ steps, \textit{/Dm} is a horizontal -(\texttt{/H}) or vertical (\texttt{/V}) dimension (e.g.\ \texttt{Blinds -/Dm /V}), and \textit{/M} is for motion, either in (\texttt{/I}) or out -(\texttt{/O}). +Finally, the \texttt{pdfpagetransition} can be one of the following values, +where \textit{/Di} stands for direction of motion in degrees, generally in 90 +degree steps, \textit{/Dm} is a horizontal (\texttt{/H}) or vertical +(\texttt{/V}) dimension (e.g.\ \texttt{Blinds /Dm /V}), and \textit{/M} is +for motion, either in (\texttt{/I}) or out (\texttt{/O}). \begin{longtable}{@{}>{\ttfamily}llp{8.5cm}@{}} Blinds & /Dm & Multiple lines distributed evenly across the screen sweep in the same direction to reveal the new @@ -1240,6 +1290,7 @@ pdfborderstyle & & border style for links \\ pdfcenterwindow & \textit{false} & position the document window in the center of the screen \\ pdfcreator & \textit{LaTeX with} & text for PDF Creator field \\ & \textit{hyperref} & \\ +pdfcreationdate & & Sets the creation date, see below the table in section~\ref{sec:pdfdata} for more info about the format\\ pdfdirection & \textit{empty} & direction setting \\ pdfdisplaydoctitle & \textit{false} & display document title instead of file name in title bar\\ @@ -1252,6 +1303,7 @@ pdfkeywords & \textit{empty} & text for PDF Keywords field \\ pdflang & \textit{relax} & PDF language identifier (RFC 3066) \\ pdfmark & \textit{false} & an alias for \textsf{dvips} \\ pdfmenubar & \textit{true} & make PDF viewer's menu bar visible \\ +pdfmoddate & & Sets the modification date, see below the table in section~\ref{sec:pdfdata} for more info about the format\\ pdfnewwindow & \textit{false} & make links that open another PDF \\ & & file start a new window \\ pdfnonfullscreenpagemode @@ -1799,7 +1851,7 @@ sequence error would arise. \subsection{Option `next-anchor'} 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. +an anchor name which can be referenced with a \verb|\bookmark| command from the bookmark package: \begin{verbatim} \hypersetup{next-anchor=toc} @@ -2799,33 +2851,39 @@ The draft option defines the macros as follows \section{Special support for other packages} -Package \xpackage{hyperref} aims to cooperate with other packages, but there are -several possible sources for conflict, such as +Package \xpackage{hyperref} aims to cooperate with other packages, but while +the long term goal is to remove patches and to move link support into the +kernel, classes and packages there are still several possible sources for +conflict, such as \begin{itemize} -\item Packages that manipulate the bibliographic mechanism. Peter -William's \xpackage{harvard} package is supported. However, the -recommended package is Patrick Daly's \xpackage{natbib} package that has -specific \xpackage{hyperref} hooks to allow reliable interaction. This -package covers a very wide variety of layouts and citation styles, all -of which work with \xpackage{hyperref}. +\item Packages that manipulate the bibliographic mechanism. Peter William's + \xpackage{harvard} package is supported. However, the recommended + package is either Patrick Daly's \xpackage{natbib} package that has + specific \xpackage{hyperref} hooks to allow reliable interaction or the + \xpackage{biblatex} package. Both packages cover a very wide variety of + layouts and citation styles, all of which work with + \xpackage{hyperref}. -\item Packages that changes \ci{label} and \ci{ref} -macros. +\item Packages that changes \ci{label} and \ci{ref} macros. Since \LaTeX{} + 2023-06-01 the kernel and \xpackage{hyperref}/\xpackage{nameref} use + the same \ci{label} definition. \ci{label} has a hook for external + packages. There should be no need for external packages and classes to + redefine them. \item Packages that do anything serious with the index. -\item Packages that do anything serious with sectioning commands and the toc +\item Packages that do anything serious with sectioning commands and the + toc. \end{itemize} -The \xpackage{hyperref} package is distributed with variants on two useful -packages designed to work especially well with it. These are \xpackage{xr} -and \xpackage{minitoc}, which support crossdocument links using \hologo{LaTeX}'s -normal \cs{label}/\cs{ref} mechanisms and per-chapter tables of contents, -respectively. +The \xpackage{hyperref} package is distributed with a variant of the +\xpackage{xr}, \xpackage{xr-hyper}\footnote{It will be merged with the +\xpackage{xr} package soon}, which support crossdocument links using +\hologo{LaTeX}'s normal \cs{label}/\cs{ref} mechanisms. \subsection{Package Compatibility} @@ -2857,7 +2915,9 @@ Currently only package loading orders are available: \subsubsection{amsrefs} - Package loading order: +The documentation of \xpackage{amsrefs} claims that the package must be +loaded after \xpackage{hyperref} (it is unclear if that is really true) so +the recommended package loading order is: \begin{verbatim} \usepackage{hyperref} @@ -2930,25 +2990,6 @@ Currently only package loading orders are available: \usepackage{chappg} \end{verbatim} -\subsubsection{cite} - - This is from Mike Shell: - cite.sty cannot currently be used with \xpackage{hyperref}. - However, I can do a workaround via: - -\begin{verbatim} - \makeatletter - \def\NAT@parse{\typeout{This is a fake Natbib command to fool Hyperref.}} - \makeatother - - \usepackage[hypertex]{hyperref} -\end{verbatim} - - so that \xpackage{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). - - \subsubsection{count1to} Package `count1to' adds several \verb|\@addtoreset| commands that confuse @@ -3019,57 +3060,6 @@ Currently only package loading orders are available: support by using option \verb"hyperfootnotes=false". -\subsubsection{geometry} - - 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 \verb|\special| of geometry to an earlier - location: - -\begin{verbatim} - \documentclass[dvipdfm]{article}% or other classes - \usepackage{atbegshi} - \AtBeginDocument{% - \let\OrgAtBeginDvi\AtBeginDvi - \let\AtBeginDvi\AtBeginShipoutFirst - } - \usepackage[ - paperwidth=170mm, - paperheight=240mm - ]{geometry} - \AtBeginDocument{% - \let\AtBeginDvi\OrgAtBeginDvi - } - \usepackage{hyperref} - - or - - \documentclass[dvipdfm]{article}% or other classes - \usepackage{atbegshi} - \let\AtBeginDvi\AtBeginShipoutFirst - \usepackage[ - paperwidth=170mm, - paperheight=240mm - ]{geometry} - \usepackage{hyperref} -\end{verbatim} - -\subsubsection{IEEEtran.cls} - - version $\ge$ V1.6b (because of \verb|\@makecaption|, see ChangeLog) - - -\subsubsection{index} - - version $\ge$ 1995/09/28 v4.1 (because of \verb|\addcontentsline| redefinition) - - -\subsubsection{lastpage} - - Compatible. - - \subsubsection{linguex} \begin{verbatim} \usepackage{hyperref} @@ -3195,6 +3185,8 @@ or \xpackage{subcaption} \subsubsection{ucs/utf8x.def} +Note: utf8 is now the default in \LaTeX{} and \xpackage{ucs} is no + longer recommended. The first time a multibyte UTF8 sequence is called, it does some calculations and stores the result in a macro @@ -3213,84 +3205,22 @@ or \xpackage{subcaption} 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 \xpackage{ucs} is no - longer recommended. \subsubsection{varioref} - There are too many problems with \xpackage{varioref}. Nobody has time to - sort them out. Therefore this package is now unsupported. - - Perhaps you are lucky and some of the features of \xpackage{varioref} works - with the following loading order: +Most previous problems with \xpackage{varioref} should be resolved. There is +only an open issue regarding \ci{vrefformat} +(\url{https://github.com/latex3/hyperref/issues/225}). + +It is recommended to load \xpackage{varioref} always with the option +\texttt{nospace}, see the documentation. \begin{verbatim} - \usepackage{nameref} - \usepackage{varioref} - \usepackage{hyperref} + \usepackage[nospace]{varioref} \end{verbatim} - - Also some babel versions can be problematic. For example, - 2005/05/21 v3.8g contains a patch for \xpackage{varioref} that breaks - the \xpackage{hyperref} support for \xpackage{varioref}. - - - Also unsupported: -\begin{itemize} -\item \verb|\Ref|, \verb|\Vref| do not uppercase the first letter. -\item \verb|\vpageref[]{...}| - On the same page a previous space is not suppressed. -\end{itemize} - \subsubsection{verse} Version 2005/08/22 v2.22 contains support for \xpackage{hyperref}. - For older versions see example from - de.comp.text.tex (2005/08/11, slightly modified): - -\begin{verbatim} - \documentclass{article} - - % package order does not matter - \usepackage{verse} - \usepackage{hyperref} - - \makeatletter - % make unique poemline anchors - \newcounter{verse@env} - \setcounter{verse@env}{0} - \let\org@verse\verse - \def\verse{% - \stepcounter{verse@env}% - \org@verse - } - \def\theHpoemline{\arabic{verse@env}.\thepoemline} - - % add anchor for before \addcontentsline in \@vsptitle - \let\org@vsptitle\@vsptitle - \def\@vsptitle{% - \phantomsection - \org@vsptitle - } - \makeatother - - \begin{document} - - \poemtitle{Poem 1} - \begin{verse} - An one-liner. - \end{verse} - - \newpage - - \poemtitle{Poem 2} - \begin{verse} - Another one-liner. - \end{verse} - - \end{document} -\end{verbatim} - \subsubsection{vietnam} \begin{verbatim} % pd1enc.def should be loaded before package dblaccnt: @@ -3323,7 +3253,7 @@ Note: utf8 is now the default in \LaTeX{} and \xpackage{ucs} is no \subsection{Wrapped/broken link support} Only few drivers support automatically wrapped/broken links, - e.g. pdftex, dvipdfm, hypertex. Other drivers lack this + e.g. pdftex, dvipdfmx, hypertex. Other drivers lack this feature, e.g. dvips, dvipsone. Workarounds: @@ -3351,9 +3281,14 @@ Note: utf8 is now the default in \LaTeX{} and \xpackage{ucs} is no In general they have problems: \begin{itemize} \item Some driver doesn't support them at all (see above). - \item The driver allows it, but the link result might include - the footer and/or header, or an error message can - occur sometimes. + \item The driver allows it, but the link result might include the footer + and/or header. This can currently (2023) be avoided by using the PDF + management and to load at least the new-or-1 module from latex-lab: + + \begin{verbatim} + \DocumentMetadata{testphase=new-or-1} + \end{verbatim} + \end{itemize} \subsection{Footnotes} 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-doc6.html b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc6.html index 86b6169f821..8d8b5298b17 100644 --- a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc6.html +++ b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc6.html @@ -13,7 +13,7 @@

5 5This section moved from the README file, needs more integration into the manual
diff --git a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc7.html b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc7.html index 97b0248da7d..775f79225fc 100644 --- a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc7.html +++ b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc7.html @@ -11,9 +11,11 @@
-

6This section moved from the README file, needs more integration into the manual

+ id="x7-64002x11"> 6It will be merged with the xr package soon
diff --git a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc8.html b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc8.html index ec67959b8a4..e7a3d2bade5 100644 --- a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc8.html +++ b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc8.html @@ -13,7 +13,7 @@
7 7This section moved from the README file, needs more integration into the manual
diff --git a/Master/texmf-dist/doc/latex/hyperref/hyperref-doc9.html b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc9.html new file mode 100644 index 00000000000..00d37bbe574 --- /dev/null +++ b/Master/texmf-dist/doc/latex/hyperref/hyperref-doc9.html @@ -0,0 +1,19 @@ + + + + + + + + + + +
+ 8This section moved from the README file, needs more integration into the manual
+ + diff --git a/Master/texmf-dist/doc/latex/hyperref/hyperref-linktarget.pdf b/Master/texmf-dist/doc/latex/hyperref/hyperref-linktarget.pdf index 1a5c95d3fa7..64e6531cca9 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 09fd05e1142..8fd1a34e5c5 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 3abd7017627..67c1a14e8b0 100644 Binary files a/Master/texmf-dist/doc/latex/hyperref/nameref.pdf and b/Master/texmf-dist/doc/latex/hyperref/nameref.pdf differ diff --git a/Master/texmf-dist/doc/latex/hyperref/paper.pdf b/Master/texmf-dist/doc/latex/hyperref/paper.pdf deleted file mode 100644 index 5b5977bf899..00000000000 Binary files a/Master/texmf-dist/doc/latex/hyperref/paper.pdf and /dev/null differ diff --git a/Master/texmf-dist/doc/latex/hyperref/slides.pdf b/Master/texmf-dist/doc/latex/hyperref/slides.pdf deleted file mode 100644 index 1d98335b32b..00000000000 Binary files a/Master/texmf-dist/doc/latex/hyperref/slides.pdf and /dev/null differ diff --git a/Master/texmf-dist/source/latex/hyperref/backref.dtx b/Master/texmf-dist/source/latex/hyperref/backref.dtx index 266ec9db077..cfcb77923f5 100644 --- a/Master/texmf-dist/source/latex/hyperref/backref.dtx +++ b/Master/texmf-dist/source/latex/hyperref/backref.dtx @@ -32,7 +32,7 @@ %\ProvidesFile{backref.drv} % \fi % \ProvidesFile{backref.dtx} - [2023/04/20 v1.42 Bibliographical back referencing]% + [2023-08-01 v1.43 Bibliographical back referencing]% % % % \iffalse @@ -138,7 +138,11 @@ % and enabled again afterwards, e.g.: % \begin{quote} %\begin{verbatim} -%\bookmarksetup{disable}\cite{...}\bookmarksetup{enable} +%\backrefsetup{disable}\cite{...}\backrefsetup{enable} +%\end{verbatim} +% or +%\begin{verbatim} +%\backrefsetup{disable}\listoffigures \backrefsetup{enable} %\end{verbatim} % \end{quote} % Both options are added in version 2012/07/24 v1.37. diff --git a/Master/texmf-dist/source/latex/hyperref/hluatex.dtx b/Master/texmf-dist/source/latex/hyperref/hluatex.dtx index e6c4bf5f126..f7289be5de7 100644 --- a/Master/texmf-dist/source/latex/hyperref/hluatex.dtx +++ b/Master/texmf-dist/source/latex/hyperref/hluatex.dtx @@ -1,6 +1,6 @@ % \iffalse % Source File: hluatex.dtx -% 2023-07-08 v7.01b +% 2023-10-21 v7.01c % % Copyright % 2016-2019 Oberdiek Package Support Group @@ -31,7 +31,7 @@ % % \begin{macrocode} %<*luatex> -%% 2023-07-08 v7.01b +%% 2023-10-21 v7.01c %% force unicode encoding, see issue #101 %% code mostly copied from hxetex.def \HyPsd@LoadUnicode diff --git a/Master/texmf-dist/source/latex/hyperref/hyperref-linktarget.dtx b/Master/texmf-dist/source/latex/hyperref/hyperref-linktarget.dtx index 1cdb7f511a5..409d6e3c620 100644 --- a/Master/texmf-dist/source/latex/hyperref/hyperref-linktarget.dtx +++ b/Master/texmf-dist/source/latex/hyperref/hyperref-linktarget.dtx @@ -53,7 +53,7 @@ % }^^A % } % -% \date{Version 2023-07-08 v7.01b} +% \date{Version 2023-10-21 v7.01c} % % \maketitle % \begin{documentation} diff --git a/Master/texmf-dist/source/latex/hyperref/hyperref-patches.dtx b/Master/texmf-dist/source/latex/hyperref/hyperref-patches.dtx index ac74f09a62c..4b380a32241 100644 --- a/Master/texmf-dist/source/latex/hyperref/hyperref-patches.dtx +++ b/Master/texmf-dist/source/latex/hyperref/hyperref-patches.dtx @@ -55,7 +55,7 @@ % }^^A % } % -% \date{Version 2023-07-08 v7.01b} +% \date{Version 2023-10-21 v7.01c} % % \maketitle % \begin{documentation} diff --git a/Master/texmf-dist/source/latex/hyperref/hyperref.dtx b/Master/texmf-dist/source/latex/hyperref/hyperref.dtx index b36201dbc05..228069a9ee8 100644 --- a/Master/texmf-dist/source/latex/hyperref/hyperref.dtx +++ b/Master/texmf-dist/source/latex/hyperref/hyperref.dtx @@ -51,7 +51,7 @@ %\ProvidesFile{puvnenc.def} %\ProvidesFile{puarenc.def} %\ProvidesFile{psdextra.def} -% [2023-07-08 v7.01b % +% [2023-10-21 v7.01c % % Hypertext links for LaTeX] % Dummy hyperref (SR)] % Hyperref documentation driver file] @@ -1311,6 +1311,12 @@ \def\MakeLowercase{\MakeLowercaseUnsupportedInPdfStrings}% % \end{macrocode} % +% \paragraph{TextOrMath} +% The \cs{TextOrMath} command is protected in a current \LaTeX{} and +% so can not be processed. +% \begin{macrocode} + \def\TextOrMath{\ifmmode\expandafter\@secondoftwo\else\expandafter\@firstoftwo\fi}% +% \end{macrocode} % \paragraph{Support of math commands without prefix \texttt{text}.} % This is controlled by option ``psdextra'' and only % activated with Unicode PDF strings. @@ -5704,7 +5710,7 @@ % % \begin{macrocode} \def\HyLang@DeclareLang#1#2#3{% - \@ifpackagewith{babel}{#1}{% + \ifcsname extras#1\endcsname \expandafter\HyLang@addto \csname extras#1\expandafter\endcsname \csname HyLang@#2\endcsname @@ -5714,7 +5720,7 @@ }% \x \@namedef{HyLang@#1@done}{}% - }{}% + \fi \begingroup \edef\x##1##2{% \noexpand\ifx##2\relax @@ -9532,9 +9538,14 @@ % to a document without having to remove .aux and .toc files % (this section is by David Carlisle) % All the code is delayed to |\begin{document}| +% change 2023-08-13: with a new format it is no longer +% needed to handle different |\newlabel| +% definitions. The code can be removed completly later. % \begin{macrocode} %<*package> -\Hy@AtBeginDocument{% +\@ifl@t@r\fmtversion{2023-06-01}{} + { + \Hy@AtBeginDocument{% % \end{macrocode} % First the code to deal with removing the hyperref package from % a document. @@ -9545,40 +9556,40 @@ % change 2022-03-28: removed the code for |\contentsline|, it is no % longer needed as |\contentsline| has now always four arguments. % \begin{macrocode} - \if@filesw - \immediate\write\@auxout{% - \string\providecommand\string\HyperFirstAtBeginDocument{% - \string\AtBeginDocument}^^J% - \string\HyperFirstAtBeginDocument{% - \string\ifx\string\hyper@anchor\string\@undefined^^J% - \string\global\string\let\string\oldnewlabel\string\newlabel^^J% - \string\gdef\string\newlabel\string#1\string#2{% - \string\newlabelxx{\string#1}\string#2}^^J% - \string\gdef\string\newlabelxx% - \string#1\string#2\string#3\string#4\string#5\string#6{% - \string\oldnewlabel{\string#1}{{\string#2}{\string#3}}}^^J% + \if@filesw + \immediate\write\@auxout{% + \string\providecommand\string\HyperFirstAtBeginDocument{% + \string\AtBeginDocument}^^J% + \string\HyperFirstAtBeginDocument{% + \string\ifx\string\hyper@anchor\string\@undefined^^J% + \string\global\string\let\string\oldnewlabel\string\newlabel^^J% + \string\gdef\string\newlabel\string#1\string#2{% + \string\newlabelxx{\string#1}\string#2}^^J% + \string\gdef\string\newlabelxx% + \string#1\string#2\string#3\string#4\string#5\string#6{% + \string\oldnewlabel{\string#1}{{\string#2}{\string#3}}}^^J% % \end{macrocode} % % But the new aux file will be read again at the end, with the normal % definitions expected, so better put things back as they were. % \begin{macrocode} - \string\AtEndDocument{% - \string\ifx\string\hyper@anchor\string\@undefined^^J% - \string\let\string\newlabel\string\oldnewlabel^^J% - \string\fi% - }^^J% + \string\AtEndDocument{% + \string\ifx\string\hyper@anchor\string\@undefined^^J% + \string\let\string\newlabel\string\oldnewlabel^^J% + \string\fi% + }^^J% % \end{macrocode} % % If the document is being run with hyperref put this definition % into the aux file, so we can spot it on the next run. % \begin{macrocode} - \string\fi% - }^^J% - \string\global\string\let\string\hyper@last\relax^^J% - \string\gdef\string\HyperFirstAtBeginDocument\string#1{\string#1}% - }% - \fi - \let\HyperFirstAtBeginDocument\ltx@firstofone + \string\fi% + }^^J% + \string\global\string\let\string\hyper@last\relax^^J% + \string\gdef\string\HyperFirstAtBeginDocument\string#1{\string#1}% + }% + \fi + \let\HyperFirstAtBeginDocument\ltx@firstofone % \end{macrocode} % % Now the code to deal with adding the hyperref package to a document @@ -9589,9 +9600,10 @@ % |\contentsline| % has now always four arguments. % \begin{macrocode} - \ifx\hyper@last\@undefined - \def\newlabel#1#2{\@newl@bel r{#1}{#2{}{}{}{}}}% - \fi + \ifx\hyper@last\@undefined + \def\newlabel#1#2{\@newl@bel r{#1}{#2{}{}{}{}}}% + \fi + } } % \end{macrocode} % @@ -10970,11 +10982,13 @@ \H@refstepcounter{#1}% \hyper@makecurrent{#1}% \global\let\Hy@dth@currentHref\@currentHref - \AddToHookNext{para/begin} - {\let\Hy@tempa\@currentHref - \MakeLinkTarget*{\Hy@dth@currentHref}% - \global\let\@currentHref\Hy@tempa - }% + \AddToHookNext{cmd/item/before} + {\AddToHookNext{para/begin} + {\let\Hy@tempa\@currentHref + \MakeLinkTarget*{\Hy@dth@currentHref}% + \global\let\@currentHref\Hy@tempa + }% + }% } \@ifundefined{hyper@nopatch@thm}{% \AtBeginDocument{% @@ -11729,19 +11743,28 @@ % early, if lots of float pages will follow. % Therefore currently nothing is done by hyperref. % -% This where we supply a destination for each page. +% This where we supply a destination for each page. +% +% \marginpar{Experimental!}The name of destination +% is stored in the global command \cs{@currentHpage}, this allows it to retrieve +% it with an extended reference system like zref or the new property code from \LaTeX{} +% 2023-11-01. +% \begin{macrocode} +\def\@currentHpage{Doc-Start} +% \end{macrocode} % \begin{macrocode} \ltx@ifclassloaded{slides}{% \def\Hy@SlidesFormatOptionalPage#1{(#1)}% \def\Hy@PageAnchorSlidesPlain{% \advance\c@page\ltx@one - \edef\Hy@TempPageAnchor{% - \noexpand\hyper@@anchor{% - page.\the\c@slide.\the\c@overlay.\the\c@note% + \xdef\@currentHpage{page.\the\c@slide.\the\c@overlay.\the\c@note% \ifnum\c@page=\ltx@one \else .\the\c@page - \fi + \fi}% + \edef\Hy@TempPageAnchor{% + \noexpand\hyper@@anchor{% + \@currentHpage }% }% \advance\c@page-\ltx@one @@ -11792,6 +11815,7 @@ \ifHy@hypertexnames \ifHy@plainpages \def\Hy@TempPageAnchor{\hyper@@anchor{page.\the\c@page}}% + \xdef\@currentHpage{page.\the\c@page}% \Hy@PageAnchorSlidesPlain \else \begingroup @@ -11802,12 +11826,14 @@ \endgroup \EdefUnescapeString\@the@H@page{\@the@H@page}% \def\Hy@TempPageAnchor{\hyper@@anchor{page.\@the@H@page}}% + \xdef\@currentHpage{page.\@the@H@page}% \fi \else \Hy@GlobalStepCount\Hy@pagecounter \def\Hy@TempPageAnchor{% \hyper@@anchor{page.\the\Hy@pagecounter}% }% + \xdef\@currentHpage{page.\the\Hy@pagecounter}% \fi \vbox to 0pt{% \kern\voffset @@ -12605,14 +12631,15 @@ % \begin{macrocode} \let\HyRef@ShowKeysRef\@gobble \def\HyRef@ShowKeysInit{% - \ifcsname SK@@label\endcsname + \@ifundefined{SK@@label}{} + {% \ifx\SK@ref\@empty \else \def\HyRef@ShowKeysRef{% \SK@\SK@@ref }% \fi - \fi + }% } \AddToHook{package/showkeys/after}{\HyRef@ShowKeysInit} % \end{macrocode} diff --git a/Master/texmf-dist/source/latex/hyperref/nameref.dtx b/Master/texmf-dist/source/latex/hyperref/nameref.dtx index c11127a1213..d282f8dfd57 100644 --- a/Master/texmf-dist/source/latex/hyperref/nameref.dtx +++ b/Master/texmf-dist/source/latex/hyperref/nameref.dtx @@ -33,7 +33,7 @@ %\ProvidesFile{nameref.drv} % \fi % \ProvidesFile{nameref.dtx} - [2023-08-07 v2.53 Cross-referencing by name of section]% + [2023-10-05 v2.54 Cross-referencing by name of section]% % % % \iffalse @@ -648,13 +648,16 @@ % \subsubsection{Theorems} % % \begin{macrocode} -\ltx@IfUndefined{@opargbegintheorem}{}{% - \let\NRorg@opargbegintheorem\@opargbegintheorem - \def\@opargbegintheorem#1#2#3{% - \NR@gettitle{#3}% - \NRorg@opargbegintheorem{#1}{#2}{#3}% - }% -} +\@ifundefined{NR@nopatch@theorem}{% + \ltx@IfUndefined{@opargbegintheorem}{}{% + \let\NRorg@opargbegintheorem\@opargbegintheorem + \def\@opargbegintheorem#1#2#3{% + \NR@gettitle{#3}% + \NRorg@opargbegintheorem{#1}{#2}{#3}% + }% + } +}{} +\@ifundefined{NR@nopatch@amsthm}{% \AtBeginDocument{% \@ifpackageloaded{amsthm}{% \let\NRorg@begintheorem\@begintheorem @@ -672,7 +675,7 @@ }% \fi }{}% -} +}}{} % \end{macrocode} % % \subsection{Referencing stuff} diff --git a/Master/texmf-dist/tex/latex/hyperref/backref.sty b/Master/texmf-dist/tex/latex/hyperref/backref.sty index a21a6248b48..41f914b662d 100644 --- a/Master/texmf-dist/tex/latex/hyperref/backref.sty +++ b/Master/texmf-dist/tex/latex/hyperref/backref.sty @@ -57,7 +57,7 @@ %% given in the file `manifest.txt'. \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{backref} - [2023/04/20 v1.42 Bibliographical back referencing]% + [2023-08-01 v1.43 Bibliographical back referencing]% \RequirePackage{kvoptions}[2011/06/30] \RequirePackage{kvsetkeys}[2009/07/30] \RequirePackage{ltxcmds}[2009/12/12] diff --git a/Master/texmf-dist/tex/latex/hyperref/hdvipdfm.def b/Master/texmf-dist/tex/latex/hyperref/hdvipdfm.def index 46c4da43928..f60993b9160 100644 --- a/Master/texmf-dist/tex/latex/hyperref/hdvipdfm.def +++ b/Master/texmf-dist/tex/latex/hyperref/hdvipdfm.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{hdvipdfm.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for dvipdfm] \Hy@VersionCheck{hdvipdfm.def} \special{pdf:majorversion \Hy@pdf@majorversion} diff --git a/Master/texmf-dist/tex/latex/hyperref/hdvips.def b/Master/texmf-dist/tex/latex/hyperref/hdvips.def index 664672ddc4c..40d94f29e20 100644 --- a/Master/texmf-dist/tex/latex/hyperref/hdvips.def +++ b/Master/texmf-dist/tex/latex/hyperref/hdvips.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{hdvips.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for dvips] \Hy@VersionCheck{hdvips.def} \providecommand*{\XR@ext}{pdf} diff --git a/Master/texmf-dist/tex/latex/hyperref/hdvipson.def b/Master/texmf-dist/tex/latex/hyperref/hdvipson.def index 71b3929bec6..29a81d251b2 100644 --- a/Master/texmf-dist/tex/latex/hyperref/hdvipson.def +++ b/Master/texmf-dist/tex/latex/hyperref/hdvipson.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{hdvipson.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for dvipsone] \Hy@VersionCheck{hdvipson.def} \providecommand*{\XR@ext}{pdf} diff --git a/Master/texmf-dist/tex/latex/hyperref/hdviwind.def b/Master/texmf-dist/tex/latex/hyperref/hdviwind.def index 6f0e85532a0..c01a8213455 100644 --- a/Master/texmf-dist/tex/latex/hyperref/hdviwind.def +++ b/Master/texmf-dist/tex/latex/hyperref/hdviwind.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{hdviwind.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for dviwindo] \Hy@VersionCheck{hdviwind.def} \begingroup diff --git a/Master/texmf-dist/tex/latex/hyperref/hluatex.def b/Master/texmf-dist/tex/latex/hyperref/hluatex.def index a80a517abd9..23d040e50c7 100644 --- a/Master/texmf-dist/tex/latex/hyperref/hluatex.def +++ b/Master/texmf-dist/tex/latex/hyperref/hluatex.def @@ -34,10 +34,10 @@ %% %% File: hyperref.dtx \ProvidesFile{hluatex.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for luaTeX] \Hy@VersionCheck{hluatex.def} -%% 2023-07-08 v7.01b +%% 2023-10-21 v7.01c %% force unicode encoding, see issue #101 %% code mostly copied from hxetex.def \HyPsd@LoadUnicode diff --git a/Master/texmf-dist/tex/latex/hyperref/hpdftex.def b/Master/texmf-dist/tex/latex/hyperref/hpdftex.def index 73e1faa2a0e..97fb2dc2594 100644 --- a/Master/texmf-dist/tex/latex/hyperref/hpdftex.def +++ b/Master/texmf-dist/tex/latex/hyperref/hpdftex.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{hpdftex.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for pdfTeX] \Hy@VersionCheck{hpdftex.def} \pdf@ifdraftmode{% diff --git a/Master/texmf-dist/tex/latex/hyperref/htex4ht.cfg b/Master/texmf-dist/tex/latex/hyperref/htex4ht.cfg index 19e1ba34268..d86a41dcb75 100644 --- a/Master/texmf-dist/tex/latex/hyperref/htex4ht.cfg +++ b/Master/texmf-dist/tex/latex/hyperref/htex4ht.cfg @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{htex4ht.cfg} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref configuration file for TeX4ht] \IfFileExists{\jobname.cfg}{\endinput}{} \Preamble{html} diff --git a/Master/texmf-dist/tex/latex/hyperref/htex4ht.def b/Master/texmf-dist/tex/latex/hyperref/htex4ht.def index b15fb761536..a02ed04b6cd 100644 --- a/Master/texmf-dist/tex/latex/hyperref/htex4ht.def +++ b/Master/texmf-dist/tex/latex/hyperref/htex4ht.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{htex4ht.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for TeX4ht] \Hy@VersionCheck{htex4ht.def} \providecommand*{\XR@ext}{html} diff --git a/Master/texmf-dist/tex/latex/hyperref/htexture.def b/Master/texmf-dist/tex/latex/hyperref/htexture.def index 89746d94681..3a802c93f62 100644 --- a/Master/texmf-dist/tex/latex/hyperref/htexture.def +++ b/Master/texmf-dist/tex/latex/hyperref/htexture.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{htexture.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for Textures] \Hy@VersionCheck{htexture.def} \providecommand*{\XR@ext}{pdf} diff --git a/Master/texmf-dist/tex/latex/hyperref/hvtex.def b/Master/texmf-dist/tex/latex/hyperref/hvtex.def index b3f6a3c9f69..f107fd6b30c 100644 --- a/Master/texmf-dist/tex/latex/hyperref/hvtex.def +++ b/Master/texmf-dist/tex/latex/hyperref/hvtex.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{hvtex.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for VTeX in PDF/PS mode] \Hy@VersionCheck{hvtex.def} \providecommand*{\XR@ext}{pdf} diff --git a/Master/texmf-dist/tex/latex/hyperref/hvtexhtm.def b/Master/texmf-dist/tex/latex/hyperref/hvtexhtm.def index 6bba89749c1..eb53e72600e 100644 --- a/Master/texmf-dist/tex/latex/hyperref/hvtexhtm.def +++ b/Master/texmf-dist/tex/latex/hyperref/hvtexhtm.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{hvtexhtml.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for VTeX in HTML mode] \Hy@VersionCheck{hvtexhtm.def} \providecommand*{\XR@ext}{htm} diff --git a/Master/texmf-dist/tex/latex/hyperref/hvtexmrk.def b/Master/texmf-dist/tex/latex/hyperref/hvtexmrk.def index c3bcaccb68a..24cc9433082 100644 --- a/Master/texmf-dist/tex/latex/hyperref/hvtexmrk.def +++ b/Master/texmf-dist/tex/latex/hyperref/hvtexmrk.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{hvtexmrk.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for VTeX in PDF/PS mode (pdfmark specials)] \Hy@VersionCheck{hvtexmrk.def} \providecommand*{\XR@ext}{pdf} diff --git a/Master/texmf-dist/tex/latex/hyperref/hxetex.def b/Master/texmf-dist/tex/latex/hyperref/hxetex.def index cceb0835cef..b2706caa2b1 100644 --- a/Master/texmf-dist/tex/latex/hyperref/hxetex.def +++ b/Master/texmf-dist/tex/latex/hyperref/hxetex.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{hxetex.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for XeTeX] \Hy@VersionCheck{hxetex.def} \HyPsd@LoadUnicode diff --git a/Master/texmf-dist/tex/latex/hyperref/hyperref.sty b/Master/texmf-dist/tex/latex/hyperref/hyperref.sty index 1dcb34cf647..4a210febb04 100644 --- a/Master/texmf-dist/tex/latex/hyperref/hyperref.sty +++ b/Master/texmf-dist/tex/latex/hyperref/hyperref.sty @@ -36,7 +36,7 @@ %% File: hyperref.dtx \NeedsTeXFormat{LaTeX2e}[2020/10/01] \ProvidesPackage{hyperref} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hypertext links for LaTeX] \begingroup \@makeother\`% @@ -465,6 +465,7 @@ \def\textcolor##1##{\@secondoftwo}% \def\MakeUppercase{\MakeUppercaseUnsupportedInPdfStrings}% \def\MakeLowercase{\MakeLowercaseUnsupportedInPdfStrings}% + \def\TextOrMath{\ifmmode\expandafter\@secondoftwo\else\expandafter\@firstoftwo\fi}% \ifHy@psdextra \ifHy@unicode \csname psdmapshortnames\endcsname @@ -3111,7 +3112,7 @@ \@temptokena{}\toks@\@temptokena } \def\HyLang@DeclareLang#1#2#3{% - \@ifpackagewith{babel}{#1}{% + \ifcsname extras#1\endcsname \expandafter\HyLang@addto \csname extras#1\expandafter\endcsname \csname HyLang@#2\endcsname @@ -3121,7 +3122,7 @@ }% \x \@namedef{HyLang@#1@done}{}% - }{}% + \fi \begingroup \edef\x##1##2{% \noexpand\ifx##2\relax @@ -6156,34 +6157,37 @@ \def\endNoHyper{% \global\let\hyper@link\hyper@livelink } -\Hy@AtBeginDocument{% - \if@filesw - \immediate\write\@auxout{% - \string\providecommand\string\HyperFirstAtBeginDocument{% - \string\AtBeginDocument}^^J% - \string\HyperFirstAtBeginDocument{% - \string\ifx\string\hyper@anchor\string\@undefined^^J% - \string\global\string\let\string\oldnewlabel\string\newlabel^^J% - \string\gdef\string\newlabel\string#1\string#2{% - \string\newlabelxx{\string#1}\string#2}^^J% - \string\gdef\string\newlabelxx% - \string#1\string#2\string#3\string#4\string#5\string#6{% - \string\oldnewlabel{\string#1}{{\string#2}{\string#3}}}^^J% - \string\AtEndDocument{% +\@ifl@t@r\fmtversion{2023-06-01}{} + { + \Hy@AtBeginDocument{% + \if@filesw + \immediate\write\@auxout{% + \string\providecommand\string\HyperFirstAtBeginDocument{% + \string\AtBeginDocument}^^J% + \string\HyperFirstAtBeginDocument{% \string\ifx\string\hyper@anchor\string\@undefined^^J% - \string\let\string\newlabel\string\oldnewlabel^^J% + \string\global\string\let\string\oldnewlabel\string\newlabel^^J% + \string\gdef\string\newlabel\string#1\string#2{% + \string\newlabelxx{\string#1}\string#2}^^J% + \string\gdef\string\newlabelxx% + \string#1\string#2\string#3\string#4\string#5\string#6{% + \string\oldnewlabel{\string#1}{{\string#2}{\string#3}}}^^J% + \string\AtEndDocument{% + \string\ifx\string\hyper@anchor\string\@undefined^^J% + \string\let\string\newlabel\string\oldnewlabel^^J% + \string\fi% + }^^J% \string\fi% }^^J% - \string\fi% - }^^J% - \string\global\string\let\string\hyper@last\relax^^J% - \string\gdef\string\HyperFirstAtBeginDocument\string#1{\string#1}% - }% - \fi - \let\HyperFirstAtBeginDocument\ltx@firstofone - \ifx\hyper@last\@undefined - \def\newlabel#1#2{\@newl@bel r{#1}{#2{}{}{}{}}}% - \fi + \string\global\string\let\string\hyper@last\relax^^J% + \string\gdef\string\HyperFirstAtBeginDocument\string#1{\string#1}% + }% + \fi + \let\HyperFirstAtBeginDocument\ltx@firstofone + \ifx\hyper@last\@undefined + \def\newlabel#1#2{\@newl@bel r{#1}{#2{}{}{}{}}}% + \fi + } } \ifHy@pdfusetitle \let\HyOrg@title\title @@ -7014,10 +7018,12 @@ \H@refstepcounter{#1}% \hyper@makecurrent{#1}% \global\let\Hy@dth@currentHref\@currentHref - \AddToHookNext{para/begin} - {\let\Hy@tempa\@currentHref - \MakeLinkTarget*{\Hy@dth@currentHref}% - \global\let\@currentHref\Hy@tempa + \AddToHookNext{cmd/item/before} + {\AddToHookNext{para/begin} + {\let\Hy@tempa\@currentHref + \MakeLinkTarget*{\Hy@dth@currentHref}% + \global\let\@currentHref\Hy@tempa + }% }% } \@ifundefined{hyper@nopatch@thm}{% @@ -7507,17 +7513,19 @@ \@citedatax[{#1}]% }% }{} +\def\@currentHpage{Doc-Start} \ltx@ifclassloaded{slides}{% \def\Hy@SlidesFormatOptionalPage#1{(#1)}% \def\Hy@PageAnchorSlidesPlain{% \advance\c@page\ltx@one - \edef\Hy@TempPageAnchor{% - \noexpand\hyper@@anchor{% - page.\the\c@slide.\the\c@overlay.\the\c@note% + \xdef\@currentHpage{page.\the\c@slide.\the\c@overlay.\the\c@note% \ifnum\c@page=\ltx@one \else .\the\c@page - \fi + \fi}% + \edef\Hy@TempPageAnchor{% + \noexpand\hyper@@anchor{% + \@currentHpage }% }% \advance\c@page-\ltx@one @@ -7568,6 +7576,7 @@ \ifHy@hypertexnames \ifHy@plainpages \def\Hy@TempPageAnchor{\hyper@@anchor{page.\the\c@page}}% + \xdef\@currentHpage{page.\the\c@page}% \Hy@PageAnchorSlidesPlain \else \begingroup @@ -7578,12 +7587,14 @@ \endgroup \EdefUnescapeString\@the@H@page{\@the@H@page}% \def\Hy@TempPageAnchor{\hyper@@anchor{page.\@the@H@page}}% + \xdef\@currentHpage{page.\@the@H@page}% \fi \else \Hy@GlobalStepCount\Hy@pagecounter \def\Hy@TempPageAnchor{% \hyper@@anchor{page.\the\Hy@pagecounter}% }% + \xdef\@currentHpage{page.\the\Hy@pagecounter}% \fi \vbox to 0pt{% \kern\voffset @@ -8177,14 +8188,15 @@ \def\HyRef@currentHtag{} \let\HyRef@ShowKeysRef\@gobble \def\HyRef@ShowKeysInit{% - \ifcsname SK@@label\endcsname + \@ifundefined{SK@@label}{} + {% \ifx\SK@ref\@empty \else \def\HyRef@ShowKeysRef{% \SK@\SK@@ref }% \fi - \fi + }% } \AddToHook{package/showkeys/after}{\HyRef@ShowKeysInit} \providecommand*\AMSautorefname{\equationautorefname} diff --git a/Master/texmf-dist/tex/latex/hyperref/hypertex.def b/Master/texmf-dist/tex/latex/hyperref/hypertex.def index 7a2d467b46c..f0d55f1a880 100644 --- a/Master/texmf-dist/tex/latex/hyperref/hypertex.def +++ b/Master/texmf-dist/tex/latex/hyperref/hypertex.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{hypertex.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref driver for HyperTeX specials] \Hy@VersionCheck{hypertex.def} \providecommand*{\XR@ext}{dvi} diff --git a/Master/texmf-dist/tex/latex/hyperref/nameref.sty b/Master/texmf-dist/tex/latex/hyperref/nameref.sty index c02bfeb77df..b646c295c45 100644 --- a/Master/texmf-dist/tex/latex/hyperref/nameref.sty +++ b/Master/texmf-dist/tex/latex/hyperref/nameref.sty @@ -58,7 +58,7 @@ %% given in the file `manifest.txt'. \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{nameref} - [2023-08-07 v2.53 Cross-referencing by name of section]% + [2023-10-05 v2.54 Cross-referencing by name of section]% \RequirePackage{refcount}[2006/02/12] \RequirePackage{gettitlestring}[2009/12/18] \RequirePackage{ltxcmds}[2009/12/12] @@ -350,13 +350,16 @@ }{}%@ifundefined }%class later }{} -\ltx@IfUndefined{@opargbegintheorem}{}{% - \let\NRorg@opargbegintheorem\@opargbegintheorem - \def\@opargbegintheorem#1#2#3{% - \NR@gettitle{#3}% - \NRorg@opargbegintheorem{#1}{#2}{#3}% - }% -} +\@ifundefined{NR@nopatch@theorem}{% + \ltx@IfUndefined{@opargbegintheorem}{}{% + \let\NRorg@opargbegintheorem\@opargbegintheorem + \def\@opargbegintheorem#1#2#3{% + \NR@gettitle{#3}% + \NRorg@opargbegintheorem{#1}{#2}{#3}% + }% + } +}{} +\@ifundefined{NR@nopatch@amsthm}{% \AtBeginDocument{% \@ifpackageloaded{amsthm}{% \let\NRorg@begintheorem\@begintheorem @@ -374,7 +377,7 @@ }% \fi }{}% -} +}}{} \providecommand*{\@currentlabelname}{} \providecommand*{\@currentHref}{} \long\def\@firstoffive#1#2#3#4#5{#1} diff --git a/Master/texmf-dist/tex/latex/hyperref/nohyperref.sty b/Master/texmf-dist/tex/latex/hyperref/nohyperref.sty index 9d49db4af76..7134bdef322 100644 --- a/Master/texmf-dist/tex/latex/hyperref/nohyperref.sty +++ b/Master/texmf-dist/tex/latex/hyperref/nohyperref.sty @@ -34,7 +34,7 @@ %% File: hyperref.dtx \NeedsTeXFormat{LaTeX2e}[2020/10/01] \ProvidesPackage{nohyperref} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Dummy hyperref (SR)] \RequirePackage{letltxmacro}[2008/06/13] \let\hyper@@anchor\@gobble diff --git a/Master/texmf-dist/tex/latex/hyperref/pd1enc.def b/Master/texmf-dist/tex/latex/hyperref/pd1enc.def index cc447070467..edbbc07e288 100644 --- a/Master/texmf-dist/tex/latex/hyperref/pd1enc.def +++ b/Master/texmf-dist/tex/latex/hyperref/pd1enc.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{pd1enc.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref: PDFDocEncoding definition (HO)] \DeclareFontEncoding{PD1}{}{} \DeclareTextAccent{\`}{PD1}{\textasciigrave} diff --git a/Master/texmf-dist/tex/latex/hyperref/pdfmark.def b/Master/texmf-dist/tex/latex/hyperref/pdfmark.def index f871feaa672..ff024d7e565 100644 --- a/Master/texmf-dist/tex/latex/hyperref/pdfmark.def +++ b/Master/texmf-dist/tex/latex/hyperref/pdfmark.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{pdfmark.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref definitions for pdfmark specials] \Hy@VersionCheck{pdfmark.def} \begingroup diff --git a/Master/texmf-dist/tex/latex/hyperref/psdextra.def b/Master/texmf-dist/tex/latex/hyperref/psdextra.def index f85a9c5763a..754fa780c08 100644 --- a/Master/texmf-dist/tex/latex/hyperref/psdextra.def +++ b/Master/texmf-dist/tex/latex/hyperref/psdextra.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{psdextra.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref: Additions to PDF string support] \Hy@VersionCheck{psdextra.def} \DeclareTextCommand{\textGamma}{PU}{\83\223}%* U+0393 diff --git a/Master/texmf-dist/tex/latex/hyperref/puarenc.def b/Master/texmf-dist/tex/latex/hyperref/puarenc.def index 72b7529a451..7aafd6f747a 100644 --- a/Master/texmf-dist/tex/latex/hyperref/puarenc.def +++ b/Master/texmf-dist/tex/latex/hyperref/puarenc.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{puarenc.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref: Additions to puenc.def for Arabi] \DeclareTextCommand{\hamza}{PU}{\86\041}% U+0621 \DeclareTextCommand{\alefmadda}{PU}{\86\042}% U+0622 diff --git a/Master/texmf-dist/tex/latex/hyperref/puenc-extra.def b/Master/texmf-dist/tex/latex/hyperref/puenc-extra.def index f0a62e096f1..9edc2e011c1 100644 --- a/Master/texmf-dist/tex/latex/hyperref/puenc-extra.def +++ b/Master/texmf-dist/tex/latex/hyperref/puenc-extra.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{puenc-extra.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref: PDF Unicode extra definition (HO)] \DeclareTextCommand{\G}{PU}[1]{#1\83\017}% U+030F \DeclareTextCompositeCommand{\G}{PU}{\@empty}{\textdoublegrave}% diff --git a/Master/texmf-dist/tex/latex/hyperref/puenc.def b/Master/texmf-dist/tex/latex/hyperref/puenc.def index f7b8264aff9..a568447b581 100644 --- a/Master/texmf-dist/tex/latex/hyperref/puenc.def +++ b/Master/texmf-dist/tex/latex/hyperref/puenc.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{puenc.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref: PDF Unicode definition (HO)] \DeclareFontEncoding{PU}{}{} \DeclareTextCommand{\`}{PU}[1]{#1\83\000}% U+0300 diff --git a/Master/texmf-dist/tex/latex/hyperref/puvnenc.def b/Master/texmf-dist/tex/latex/hyperref/puvnenc.def index c2b486af342..6d2f4ca51da 100644 --- a/Master/texmf-dist/tex/latex/hyperref/puvnenc.def +++ b/Master/texmf-dist/tex/latex/hyperref/puvnenc.def @@ -33,7 +33,7 @@ %% %% File: hyperref.dtx \ProvidesFile{puvnenc.def} - [2023-07-08 v7.01b % + [2023-10-21 v7.01c % Hyperref: Additions to puenc.def for VnTeX] \DeclareTextCommand{\abreve}{PU}{\81\003}% U+0103 \DeclareTextCommand{\acircumflex}{PU}{\80\342}% U+00E2 diff --git a/Master/texmf-dist/tex/latex/hyperref/xr-hyper.sty b/Master/texmf-dist/tex/latex/hyperref/xr-hyper.sty index 83abfaf577d..a5abb24b473 100644 --- a/Master/texmf-dist/tex/latex/hyperref/xr-hyper.sty +++ b/Master/texmf-dist/tex/latex/hyperref/xr-hyper.sty @@ -57,7 +57,7 @@ %% \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{xr-hyper} - [2023-07-08 v7.01b eXternal References (DPC)] + [2023-10-21 v7.01c eXternal References (DPC)] \def\externaldocument{\@testopt\XR@cite{}} \let\externalcitedocument\externaldocument -- cgit v1.2.3