The package derives from, and builds on, the work of the HyperTEX project, described at http://xxx.lanl.gov/hypertex/. It extends the functionality of all the LATEX cross-referencing commands (including the table of contents, bibliographies etc) to produce \special commands which a driver can turn into hypertext links; 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 https://github.com/latex3/hyperref/ and issues should be reported there.
This manual provides a brief overview of the hyperref package. For more details, you should read the additional documentation distributed with the package, as well as the complete documentation by processing hyperref.dtx. You should also read the chapter on hyperref in The LATEX Web Companion, where you will find additional examples.
The HyperTEX specification1 says that conformant viewers/translators must recognize the following set of \special constructs:
The href, name and end commands are used to do the basic hypertext operations of establishing links between sections of documents. The image command is intended (as with current HTML viewers) to place an image of arbitrary graphical format on the page in the current location. The base_name command is be used to communicate to the DVI viewer the full (URL) location of the current document so that files specified by relative URLs may be retrieved correctly.
The href and name commands must be paired with an end command later in the TEX file—the TEX commands between the two ends of a pair form an anchor in the document. In the case of an href command, the anchor is to be highlighted in the DVI viewer, and when clicked on will cause the scene to shift to the destination specified by href_string. The anchor associated with a name command represents a possible location to which other hypertext links may refer, either as local references (of the form href="#name_string" with the name_string identical to the one in the name command) or as part of a URL (of the form URL#name_string). Here href_string is a valid URL or local identifier, while name_string could be any string at all: the only caveat is that ‘"’ characters should be escaped with a backslash (\), and if it looks like a URL name it may cause 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:
Output from dvips or dvipsone must be processed using Acrobat Distiller to obtain a PDF file.2 The result is generally preferable to that produced by using the hypertex driver, and then processing with dvips -z, but the DVI file is not portable. The main advantage of using the HyperTEX \special commands is that you can also use the document in hypertext DVI viewers, such as xdvi.
driverfallback=dvipdfm
Autodetected drivers (pdftex, 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 hyperref uses the driver, given by driverfallback. If the driver is already specified or can be autodetected, then option driverfallback is ignored.
This package can be used with more or less any normal LATEX document by specifying in the document preamble
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. 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 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. Other options control the appearance of links, and give extra control over PDF output. For example, colorlinks, as its name well implies, colors the links instead of using boxes; this is the option used in this document.
All user-configurable aspects of hyperref are set using a single ‘key=value’ scheme (using the keyval package) with the key Hyp. The options can be set either in the optional argument to the \usepackage command, or using the \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 unicode) can only be used as packge options, and not in \hypersetup as the option settings are processed as the package is read.
As an example, the behavior of a particular file could be controlled by:
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.
Package ‘kvoptions-patch’ patches LATEX to make it aware of key value options and to prevent premature value expansions.
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 true if used. These are the ones classed as ‘boolean’. The values true and false can always be specified, however.
Firstly, the options to specify general behavior and page size.
draft | boolean | false | all hypertext options are turned off |
final | boolean | true | all hypertext options are turned on |
debug | boolean | false | extra diagnostic messages are printed in |
the log file | |||
verbose | boolean | false | same as debug |
implicit | boolean | true | redefines LATEX internals |
setpagesize | boolean | true | sets page size by special driver commands |
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 \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:
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 number. Therefore hyperref has introduced \theH<counter> that allows a unique counter value without messing up with the appearance of the counter number. For example, the number of the second table in the third chapter might be printed as 2, the result of \thetable. But the destination name 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 \theH<counter>. Defaults for standard cases (chapter, …) are provided. And after hyperref is loaded, new counters with parent counters also define \theH<counter> automatically, if \newcounter, \@addtoreset or \numberwithin of package amsmath are used.
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 the counter value. In case of page anchors the absolute page anchor is used. With option 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 \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, because both documents might contain chapter.1 or page.1. Also hyperref sets anchor with name Doc-Start at the begin of the document. This can be resolved by redefining \HyperDestNameFilter. Package hyperref calls this macro each time, it uses a destination name. The macro must be expandable and expects the destination name as only argument. As example, the macro is redefined to add a prefix to all destination names:
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 changed them), for example:
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 approximation:
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 anchor setting, the new name is recorded in the .aux file and used in the subsequent LATEX run. The renaming is done by a redefinition of \HyperDestNameFilter. That leaves the old destination names intact (e.g., they are needed for \autoref). This redefinition is also available as \HyperDestLabelReplace, thus that an own redefinition can use it. The following example also adds a prefix for all destination names:
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 expandable string test (\pdfstrcmp of pdfTEX or \strcmp of XƎTEX, package pdftexcmds also supports LuaTEX):
With option destlabel destinations can also named manually, if the destination is not yet renamed:
\HyperDestRename{⟨destination⟩}{⟨newname⟩}
Hint: Anchors can also be named and set by \hypertarget.
destlabel | boolean | false | destinations are named by first \label |
after anchor creation | |||
hypertexnames | boolean | true | use guessable names for links |
naturalnames | boolean | false | use LATEX-computed names for links |
plainpages | boolean | false | Forces page anchors to be named by the Arabic form |
of the page number, rather than the formatted form. | |||
raiselinks | boolean | true |
In the hypertex driver, the height of links is normally calculated by the driver as simply the base line of contained text; this options forces \special commands to reflect the real height of the link (which could contain a graphic) |
breaklinks | boolean | false |
Allows link text to break across lines; since this cannot be accommodated in PDF, it is only set true by default if the pdftex driver is used. This makes links on multiple lines into different PDF links to the same target. |
pageanchor | boolean | true |
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 | false |
Allows links to be nested; no drivers currently support this. |
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.
If no driver is specified, the package tries to find a driver in the following order:
Many distributions are using a driver file hypertex.cfg that define \Hy@defaultdriver with hdvips. This is recommended because driver dvips provides much more features than hypertex for PDF generation.
driverfallback |
Its value is used as driver option |
if the driver is not given or autodetected. |
|
dvipdfm |
Sets up hyperref for use with the dvipdfm driver. |
dvipdfmx |
Sets up hyperref for use with the dvipdfmx driver. |
dvips |
Sets up hyperref for use with the dvips driver. |
dvipsone |
Sets up hyperref for use with the dvipsone driver. |
dviwindo |
Sets up hyperref for use with the dviwindo Windows previewer. |
hypertex |
Sets up hyperref for use with the HyperTEX-compliant drivers. |
latex2html |
Redefines a few macros for compatibility with latex2html. |
nativepdf |
An alias for dvips |
pdfmark |
An alias for dvips |
pdftex |
Sets up hyperref for use with the pdftex program. |
ps2pdf |
Redefines a few macros for compatibility with Ghostscript’s PDF writer, otherwise identical to dvips. |
tex4ht |
For use with TEX4ht |
textures |
For use with Textures |
vtex |
For use with MicroPress’ VTeX; the PDF and HTML backends are detected automatically. |
vtexpdfmark |
For use with VTeX’s PostScript backend. |
xetex |
For use with XeTEX(using backend for dvipdfm). |
If you use dviwindo, you may need to redefine the macro \wwwbrowser (the default is C:\netscape\netscape) to tell dviwindo what program to launch. Thus, users of Internet Explorer might add something like this to hyperref.cfg:
extension | text |
Set the file extension (e.g. dvi) which will be appended to file links created if you use the xr package. |
|
hyperfigures | boolean |
|
|
backref | text | false |
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 \bibitem. Supported values are section, slide, page, none, or false. If no value is given, section is taken as default. |
pagebackref | boolean | false |
Adds ‘backlink’ text to the end of each item in the bibliography, as a list of page numbers. |
hyperindex | boolean | true |
Makes the page numbers of index entries into hyperlinks. Relays on unique page anchors (pageanchor, …) |
pageanchors and plainpages=false. | |||
hyperfootnotes | boolean | true |
Makes the footnote marks into hyperlinks to the footnote text. Easily broken … |
encap |
Sets encap character for hyperindex |
||
linktoc | text | section |
make text (section), page number (page), both (all) or nothing (none) be link on TOC, LOF and LOT |
linktocpage | boolean | false |
make page number, not text, be link on TOC, LOF and LOT |
breaklinks | boolean | false |
allow links to break over lines by making links over multiple lines into PDF links to the same target |
colorlinks | boolean | false |
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 | red |
Color for normal internal links. |
anchorcolor | color | black |
Color for anchor text. Ignored by most drivers. |
citecolor | color | green |
Color for bibliographical citations in text. |
filecolor | color | cyan |
Color for URLs which open local files. |
menucolor | color | red |
Color for Acrobat menu items. |
runcolor | color | filecolor |
Color for run links (launch annotations). |
urlcolor | color | magenta |
Color for linked URLs. |
allcolors | color |
Set all color options (without border and field options). |
|
frenchlinks | boolean | false |
Use small caps instead of color for links. |
hidelinks |
Hide links (removing color and border). |
||
Note that all color names must be defined before use, following the normal system of the standard LATEX color package.
bookmarks | boolean | true |
A set of Acrobat bookmarks are written, in a manner similar to the table of contents, requiring two passes of LATEX. Some postprocessing of the bookmark file (file extension .out) may be needed to translate LATEX codes, since bookmarks must be written in PDFEncoding. To aid this process, the .out file is not rewritten by LATEX if it is edited to contain a line \let\WriteBookmarks\relax |
bookmarksopen | boolean | false |
If Acrobat bookmarks are requested, show them with all the subtrees expanded. |
bookmarksopenlevel | parameter |
level (\maxdimen) to which bookmarks are open |
|
bookmarksnumbered | boolean | false |
If Acrobat bookmarks are requested, include section numbers. |
bookmarkstype | text | toc |
to specify which ‘toc’ file to mimic |
CJKbookmarks | boolean | false |
This option should be used to produce CJK bookmarks. Package hyperref supports both normal and preprocessed mode of the CJK package; during the creation of bookmarks, 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 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 translate non-Unicode bookmarks to Unicode; for portable PDF documents only Unicode encoding should be used. |
pdfhighlight | name | /I |
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 | 0 1 0 |
The color of the box around citations |
filebordercolor | RGB color | 0 .5 .5 |
The color of the box around links to files |
linkbordercolor | RGB color | 1 0 0 |
The color of the box around normal links |
menubordercolor | RGB color | 1 0 0 |
The color of the box around Acrobat menu links |
urlbordercolor | RGB color | 0 1 1 |
The color of the box around links to URLs |
runbordercolor | RGB color | 0 .7 .7 |
Color of border around ‘run’ links |
allbordercolors |
Set all border color options |
||
pdfborder | 0 0 1 |
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. |
|
Note that the color of link borders can be specified only as 3 numbers in the range 0..1, giving an RGB color. You cannot use colors defined in TEX. Since version 6.76a this is no longer true. Especially with the help of package xcolor the usual color specifications of package (x)color can be used. For further information see description of package hycolor.
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 for this, the .out file is not overwritten on the next TEX run if it is edited to contain the line
baseurl |
URL |
Sets the base URL of the PDF document |
|
pdfpagemode |
text | empty |
Determines how the file is opening in Acrobat; the possibilities are UseNone, UseThumbs (show thumbnails), UseOutlines (show bookmarks), FullScreen, UseOC (PDF 1.5), and UseAttachments (PDF 1.6). If no mode if explicitly chosen, but the bookmarks option is set, UseOutlines is used. |
pdftitle |
text |
Sets the document information Title field |
|
pdfauthor |
text |
Sets the document information Author field |
|
pdfsubject |
text |
Sets the document information Subject field |
|
pdfcreator |
text |
Sets the document information Creator field |
|
addtopdfproducer |
text |
Adds additional text to the document information Producer field |
|
pdfkeywords |
text |
Sets the document information Keywords field |
|
pdftrapped |
text | empty |
Sets the document information Trapped entry. |
|
Possible values are True, False and Unknown. |
||
|
An empty value means, the entry is not set. |
||
pdfinfo |
key value list | empty |
Alternative interface for setting the document information. |
pdfview |
text | XYZ |
Sets the default PDF ‘view’ for each link |
pdfstartpage |
text | 1 |
Determines on which page the PDF file is opened. |
pdfstartview |
text | Fit |
Set the startup page view |
pdfremotestartview |
text | Fit |
Set the startup page view of remote PDF files |
pdfpagescrop |
n n n n |
Sets the default PDF crop box for pages. This should be a set of four numbers |
|
pdfcenterwindow |
boolean | false |
position the document window in the center of the screen |
pdfdirection |
text | empty |
direction setting |
pdfdisplaydoctitle |
boolean | false |
display document title instead of file name in title bar |
pdfduplex |
text | empty |
paper handling option for print dialog |
pdffitwindow |
boolean | false |
resize document window to fit document size |
pdflang |
text | relax |
PDF language identifier (RFC 3066) |
pdfmenubar |
boolean | true |
make PDF viewer’s menu bar visible |
pdfnewwindow |
boolean | false |
make links that open another PDF file start a new window |
pdfnonfullscreenpagemode |
boolean | empty |
page mode setting on exiting full-screen mode |
pdfnumcopies |
integer | empty |
number of printed copies |
pdfpagelayout |
text | empty |
set layout of PDF pages |
pdfpagelabels |
boolean | true |
set PDF page labels |
pdfpagetransition |
text | empty |
set PDF page transition style |
pdfpicktraybypdfsize |
text | empty |
set option for print dialog |
pdfprintarea |
text | empty |
set /PrintArea of viewer preferences |
pdfprintclip |
text | empty |
set /PrintClip of viewer preferences |
pdfprintpagerange |
n n (n n)* | empty |
set /PrintPageRange of viewer preferences |
pdfprintscaling |
text | empty |
page scaling option for print dialog (option /PrintScaling of viewer preferences, PDF 1.6); valid values are None and AppDefault |
pdftoolbar |
boolean | true |
make PDF toolbar visible |
pdfviewarea |
text | empty |
set /ViewArea of viewer preferences |
pdfviewclip |
text | empty |
set /ViewClip of viewer preferences |
pdfwindowui |
boolean | true |
make PDF user interface elements visible |
unicode |
boolean | false |
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 46. pdfTEX works by supplying default values for XYZ (horizontal × vertical × zoom) and FitBH. However, drivers using pdfmark do not supply defaults, so hyperref passes in a value of -32768, which causes Acrobat to set (usually) sensible defaults. The following are possible values for the pdfview, pdfstartview and pdfremotestartview parameters.
XYZ | left top zoom |
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 |
Fits the page to the window. |
|
FitH | top |
Fits the width of the page to the window. |
FitV | left |
Fits the height of the page to the window. |
FitR | left bottom right top |
Fits the rectangle specified by the four coordinates to the window. |
FitB |
Fits the page bounding box to the window. |
|
FitBH | top |
Fits the width of the page bounding box to the window. |
FitBV | left |
Fits the height of the page bounding box to the window. |
The pdfpagelayout can be one of the following values.
SinglePage |
Displays a single page; advancing flips the page |
OneColumn |
Displays the document in one column; continuous scrolling. |
TwoColumnLeft |
Displays the document in two columns, odd-numbered pages to the left. |
TwoColumnRight |
Displays the document in two columns, odd-numbered pages to the right. |
TwoPageLeft |
Displays two pages, odd-numbered pages to the left (since PDF 1.5). |
TwoPageRight |
Displays two pages, odd-numbered pages to the right (since PDF 1.5). |
Finally, the pdfpagetransition can be one of the following values, where /Di stands for direction of motion in degrees, generally in 90∘ steps, /Dm is a horizontal (/H) or vertical (/V) dimension (e.g. Blinds /Dm /V), and /M is for motion, either in (/I) or out (/O).
Blinds | /Dm |
Multiple lines distributed evenly across the screen sweep in the same direction to reveal the new page. |
Box | /M |
A box sweeps in or out. |
Dissolve |
The page image dissolves in a piecemeal fashion to reveal the new page. |
|
Glitter | /Di |
Similar to Dissolve, except the effect sweeps across the screen. |
Split | /Dm /M |
Two lines sweep across the screen to reveal the new page. |
Wipe | /Di |
A single line sweeps across the screen to reveal the new page. |
The information entries can be set using pdftitle, pdfsubject, …. Option pdfinfo provides an alternative interface. It takes a key value list. The key names are the names that appear in the PDF information dictionary directly. Known keys such as Title, Subject, Trapped and other are mapped to options pdftitle, subject, trapped, …Unknown keys are added to the information dictionary. Their values are text strings (see PDF specification). Example:
The following is a complete listing of available options for hyperref, arranged alphabetically.
anchorcolor | black |
set color of anchors, ignored by most drivers. |
backref | false |
do bibliographical back references |
baseurl | empty |
set base URL for document |
bookmarks | true |
make bookmarks |
bookmarksnumbered | false |
put section numbers in bookmarks |
bookmarksopen | false |
open up bookmark tree |
bookmarksopenlevel | \maxdimen |
level to which bookmarks are open |
bookmarkstype | toc |
to specify which ‘toc’ file to mimic |
breaklinks | false |
allow links to break over lines |
CJKbookmarks | false |
to produce CJK bookmarks |
citebordercolor | 0 1 0 |
color of border around cites |
citecolor | green |
color of citation links |
colorlinks | false |
color links |
true |
(tex4ht, dviwindo) |
|
debug | false |
provide details of anchors defined; same as verbose |
destlabel | false |
destinations are named by the first \label after the anchor creation |
draft | false |
do not do any hyperlinking |
dvipdfm |
use dvipdfm backend |
|
dvipdfmx |
use dvipdfmx backend |
|
dvips |
use dvips backend |
|
dvipsone |
use dvipsone backend |
|
dviwindo |
use dviwindo backend |
|
encap |
to set encap character for hyperindex |
|
extension | dvi |
suffix of linked files |
filebordercolor | 0 .5 .5 |
color of border around file links |
filecolor | cyan |
color of file links |
final | true |
opposite of option draft |
frenchlinks | false |
use small caps instead of color for links |
hyperfigures | false |
make figures hyper links |
hyperfootnotes | true |
set up hyperlinked footnotes |
hyperindex | true |
set up hyperlinked indices |
hypertex |
use HyperTEX backend |
|
hypertexnames | true |
use guessable names for links |
implicit | true |
redefine LATEX internals |
latex2html |
use LATEX2HTML backend |
|
linkbordercolor | 1 0 0 |
color of border around links |
linkcolor | red |
color of links |
linktoc | section |
make text be link on TOC, LOF and LOT |
linktocpage | false |
make page number, not text, be link on TOC, LOF and LOT |
menubordercolor | 1 0 0 |
color of border around menu links |
menucolor | red |
color for menu links |
nativepdf | false |
an alias for dvips |
naturalnames | false |
use LATEX-computed names for links |
nesting | false |
allow nesting of links |
pageanchor | true |
put an anchor on every page |
pagebackref | false |
backreference by page number |
pdfauthor | empty |
text for PDF Author field |
pdfborder | 0 0 1 |
width of PDF link border |
0 0 0 |
(colorlinks) |
|
pdfcenterwindow | false |
position the document window in the center of the screen |
pdfcreator | LaTeX with |
text for PDF Creator field |
hyperref |
|
|
pdfdirection | empty |
direction setting |
pdfdisplaydoctitle | false |
display document title instead of file name in title bar |
pdfduplex | empty |
paper handling option for print dialog |
pdffitwindow | false |
resize document window to fit document size |
pdfhighlight | /I |
set highlighting of PDF links |
pdfinfo | empty |
alternative interface for setting document information |
pdfkeywords | empty |
text for PDF Keywords field |
pdflang | relax |
PDF language identifier (RFC 3066) |
pdfmark | false |
an alias for dvips |
pdfmenubar | true |
make PDF viewer’s menu bar visible |
pdfnewwindow | false |
make links that open another PDF |
file start a new window |
||
pdfnonfullscreenpagemode | empty |
page mode setting on exiting full-screen mode |
pdfnumcopies | empty |
number of printed copies |
pdfpagelayout | empty |
set layout of PDF pages |
pdfpagemode | empty |
set default mode of PDF display |
pdfpagelabels | true |
set PDF page labels |
pdfpagescrop | empty |
set crop size of PDF document |
pdfpagetransition | empty |
set PDF page transition style |
pdfpicktraybypdfsize | empty |
set option for print dialog |
pdfprintarea | empty |
set /PrintArea of viewer preferences |
pdfprintclip | empty |
set /PrintClip of viewer preferences |
pdfprintpagerange | empty |
set /PrintPageRange of viewer preferences |
pdfprintscaling | empty |
page scaling option for print dialog |
pdfproducer | empty |
text for PDF Producer field |
pdfremotestartview | Fit |
starting view of remote PDF documents |
pdfstartpage | 1 |
page at which PDF document opens |
pdfstartview | Fit |
starting view of PDF document |
pdfsubject | empty |
text for PDF Subject field |
pdftex |
use pdfTEX backend |
|
pdftitle | empty |
text for PDF Title field |
pdftoolbar | true |
make PDF toolbar visible |
pdftrapped | empty |
Sets the document information Trapped entry. Possible values are True, False and Unknown. An empty value means, the entry is not set. |
pdfview | XYZ |
PDF ‘view’ when on link traversal |
pdfviewarea | empty |
set /ViewArea of viewer preferences |
pdfviewclip | empty |
set /ViewClip of viewer preferences |
pdfwindowui | true |
make PDF user interface elements visible |
plainpages | false |
do page number anchors as plain Arabic |
ps2pdf |
use ps2pdf backend |
|
raiselinks | false |
raise up links (for HyperTEX backend) |
runbordercolor | 0 .7 .7 |
color of border around ‘run’ links |
runcolor | filecolor |
color of ‘run’ links |
setpagesize | true |
set page size by special driver commands |
tex4ht |
use TEX4ht backend |
|
textures |
use Textures backend |
|
unicode | false |
Unicode encoded pdf strings, by defaut true with XeTEX and LuTEX |
urlbordercolor | 0 1 1 |
color of border around URL links |
urlcolor | magenta |
color of URL links |
verbose | false |
be chatty |
vtex |
use VTeX backend |
|
xetex |
use XeTEX backend |
|
If you need to make references to URLs, or write explicit links, the following low-level user macros are provided:
\href[options]{URL}{text}
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 pdfremotestartview, pdfnewwindow and the following key value options:
\url{URL}
Similar to \href{URL}{\nolinkurl{URL}}. Depending on the driver \href also tries to detect the link type. Thus the result can be a url link, file link, …
\nolinkurl{URL}
Write URL in the same way as \url, without creating a hyperlink.
\hyperbaseurl{URL}
A base URL is established, which is prepended to other specified URLs, to make it easier to write portable documents.
\hyperimage{imageURL}{text}
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 text being ignored completely.
\hyperdef{category}{name}{text}
A target area of the document (the text) is marked, and given the name category.name
\hyperref{URL}{category}{name}{text}
text is made into a link to URL#category.name
\hyperref[label]{text}
text is made into a link to the same place as \ref{label} would be linked.
\hyperlink{name}{text}
\hypertarget{name}{text}
A simple internal link is created with \hypertarget, with two parameters of an anchor name, and anchor text. \hyperlink has two arguments, the name of a hypertext object defined somewhere by \hypertarget, and the text which be used as the link on the page.
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 \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:
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.
\autoref{label}
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 \label command by hyperref by using the macros listed below (shown with their default values). The macros can be (re)defined in documents using \(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, hyperref checks \*autorefname before \*name. For instance, it looks for \figureautorefname before \figurename.
Macro |
Default |
\figurename |
Figure |
\tablename |
Table |
\partname |
Part |
\appendixname |
Appendix |
\equationname |
Equation |
\Itemname |
item |
\chaptername |
chapter |
\sectionname |
section |
\subsectionname |
subsection |
\subsubsectionname |
subsubsection |
\paragraphname |
paragraph |
\Hfootnotename |
footnote |
\AMSname |
Equation |
\theoremname |
Theorem |
\page |
page |
Example for a redefinition if babel is used:
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 \newtheorem if a lemma shares a counter with theorems. Then package aliascnt provides a method to generate a simulated second counter that allows the differentiation between theorems and lemmas:
\autopageref{label}
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 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
We want \ref*{other} to generate the correct number, but not to form a link, since we do this ourselves with \hyperref.
\pdfstringdef{macroname}{TEXstring}
\pdfstringdef returns a macro containing the PDF string. (Currently this is done globally, but do not rely on it.) All the following tasks, definitions and redefinitions are made in a group to keep them local:
In addition, parentheses are protected to avoid the danger of unsafe unbalanced parentheses in 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 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.
Usually hyperref automatically adds bookmarks for \section and similar macros. But they can also set manually.
\pdfbookmark[level]{text}{name}
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{text}{name}
creates a bookmark at the current level.
\subpdfbookmark{text}{name}
creates a bookmark one step down in the bookmark hierarchy. Internally the current level is increased by one.
\belowpdfbookmark{text}{name}
creates a bookmark below the current bookmark level. However after the command the current bookmark level has not changed.
Hint: Package bookmark replaces hyperref’s bookmark organization by a new algorithm:
Therefore I recommend using this package.
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{TEXstring}{PDFstring}
For example,
\pdfstringdef executes the hook before it expands the string. Therefore, you can use this hook to perform additional tasks or to disable additional commands.
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):
\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, pdfstartview and pdfremotestartview. Example:
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 \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.
Option ‘pdflinkmargin’ is an experimental option for specifying a link margin, if the driver supports this. Default is 1 pt for supporting drivers.
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.
When an anchor is set (e.g. via \refstepcounter, then the anchor name is globally set to the current anchor name.
For example:
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 name is not available as expected.
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 quite messy, the option is mainly intended to ease developing, testing, debugging the driver part.
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, therefore they are defined with prefix ‘text’ (\textgeq, \textnotin, ...). They can be mapped to short names during the processing to PDF strings. The disadvantage is that they are many hundreds macros that need to be redefined for each PDF string conversion. Therefore this can be enabled or disabled as option ‘psdextra’. On default the option is turned off (set to ‘false’). Turning the option on means that the short names are available. Then \geq can directly be used instead of \textgeq.
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:
If a hyperref OPTION is a boolean, that means it takes values ‘true’ or ‘false’, then \IfHyperBooleanExists calls YES, otherwise NO.
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 \MaybeStopEarly or \MaybeStopNow end hyperref prematurely.
If a Unicode character is not supported by puenc.def, it can be given by using \unichar. Its name and syntax is inherited from package ‘ucs’. However it is defined independently for use in hyperref’s \pdfstringdef (that converts arbitrary TeX code to PDF strings or tries to do this).
Macro \unichar takes a TeX number as argument, examples for U+263A (WHITE SMILING FACE):
‘"’ must not be a babel shorthand character or otherwise active. Otherwise prefix it with \string:
Users of (n)german packages or babel options may use \dq instead:
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 by a representation for the PDF string. However \texorpdfstring does not distinguish the two encodings. This gap closes \ifpdfstringunicode. It is only allowed in the second argument of \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 Han The Thanh. Correctly written it needs some accented characters, one character even with a double accent. Class ‘tugboat.cls’ defines a macro for the typesetted name:
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 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:
Thus we can put this together:
For PDFDocEncoding (PD1) the variant above has dropped the second accent. Alternatively we could provide a representation without accents instead of wrong accents:
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:
(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, suffix_2p, suffix_3p, suffix_mp needs markup that \hyperpage can detect and knows that this stuff does not belong to a page number. Makro \nohyperpage serves as this markup. Put the customized code for these keys inside \nohyperpage, e.g.:
(Depending on the typesetting tradition some space "\\," or "~" should be put before the first f inside \nohyperpage.)
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 package. Check its documentation for details how to use it.
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:
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}).
The new option ‘linktoc’ allows more control which part of an entry in the table of contents is made into a link:
Before 6.77b:
Since 6.77b:
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.
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:
New option ‘export’ sets the export format of a submit action. Valid values are (upper- or lowercase):
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 higher PDF versions.
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.
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.
Many form objects uses the label argument for several purposes:
Code that is suitable for layouting with TeX can break in the structures of the output format. If option ‘name’ is given, then its value is used as name in the different output structures. Thus the value should consist of letters only.
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:
The luatex driver uses "unicode" by default. If another encoding should be forced, it should be done in hypersetup.
See documentation of package ‘hycolor’.
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).
\autoref* generates a reference without link as \ref* or \pageref*.
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 support:
Unsupported:
The depth of the bookmarks can be controlled by the new option "bookmarksdepth". The option acts globally and distinguishes three cases:
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:
(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 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 "hyperref.cfg":
for dvips, or
for the default behaviour of hyperref.
See also the new option ‘driverfallback’.
Alternative interface for formatting of backref entries, example:
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.
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.
If you want to access the menu options of Acrobat Reader or Exchange, the following macro is provided in the appropriate drivers:
\Acrobatmenu{menuoption}{text}
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.
File |
Open, Close, Scan, Save, SaveAs, Optimizer:SaveAsOpt, Print, PageSetup, Quit |
File→Import |
ImportImage, ImportNotes, AcroForm:ImportFDF |
File→Export |
ExportNotes, AcroForm:ExportFDF |
File→DocumentInfo |
GeneralInfo, OpenInfo, FontsInfo, SecurityInfo, Weblink:Base, AutoIndex:DocInfo |
File→Preferences |
GeneralPrefs, NotePrefs, FullScreenPrefs, Weblink:Prefs, AcroSearch:Preferences(Windows) or, AcroSearch:Prefs(Mac), Cpt:Capture |
Edit |
Undo, Cut, Copy, Paste, Clear, SelectAll, Ole:CopyFile, TouchUp:TextAttributes, TouchUp:FitTextToSelection, TouchUp:ShowLineMarkers, TouchUp:ShowCaptureSuspects, TouchUp:FindSuspect, |
Properties |
|
Edit→Fields |
AcroForm:Duplicate, AcroForm:TabOrder |
Document |
Cpt:CapturePages, AcroForm:Actions, CropPages, RotatePages, InsertPages, ExtractPages, ReplacePages, DeletePages, NewBookmark, SetBookmarkDest, CreateAllThumbs, DeleteAllThumbs |
View |
ActualSize, FitVisible, FitWidth, FitPage, ZoomTo, FullScreen, FirstPage, PrevPage, NextPage, LastPage, GoToPage, GoBack, GoForward, SinglePage, OneColumn, TwoColumns, ArticleThreads, PageOnly, ShowBookmarks, ShowThumbs |
Tools |
Hand, ZoomIn, ZoomOut, SelectText, SelectGraphics, Note, Link, Thread, AcroForm:Tool, Acro_Movie:MoviePlayer, TouchUp:TextTool, Find, FindAgain, FindNextNote, CreateNotesFile |
Tools→Search |
AcroSrch:Query, AcroSrch:Indexes, AcroSrch:Results, AcroSrch:Assist, AcroSrch:PrevDoc, AcroSrch:PrevHit, AcroSrch:NextHit, AcroSrch:NextDoc |
Window |
ShowHideToolBar, ShowHideMenuBar, ShowHideClipboard, Cascade, TileHorizontal, TileVertical, CloseAll |
Help |
HelpUserGuide, HelpTutorial, HelpExchange, HelpScan, HelpCapture, HelpPDFWriter, HelpDistiller, HelpSearch, HelpCatalog, HelpReader, Weblink:Home |
Help(Windows) |
About |
You must put your fields inside a Form environment (only one per file).
There are six macros to prepare fields:
\TextField[parameters]{label}
\CheckBox[parameters]{label}
\ChoiceMenu[parameters]{label}{choices}
\PushButton[parameters]{label}
\Submit[parameters]{label}
\Reset[parameters]{label}
The way forms and their labels are laid out is determined by:
\LayoutTextField{label}{field}
\LayoutChoiceField{label}{field}
\LayoutCheckField{label}{field}
These macros default to #1 #2
What is actually shown in as the field is determined by:
\MakeRadioField{width}{height}
\MakeCheckField{width}{height}
\MakeTextField{width}{height}
\MakeChoiceField{width}{height}
\MakeButtonField{text}
These macros default to \vbox to #2{\hbox to #1{\hfill}\vfill}, except the last, which defaults to #1; it is used for buttons, and the special \Submit and \Reset macros.
You may also want to redefine the following macros:
action | URL |
The URL that will receive the form data if a Submit button is included in the form |
encoding | name |
The encoding for the string set to the URL; FDF-encoding is usual, and html is the only valid value |
method | name |
Used only when generating HTML; values can be post or get |
Note that all colors must be expressed as RGB triples, in the range 0..1 (i.e. color=0 0 0.5)
accesskey | key | (as per HTML) | |
align | number | 0 | alignment within text field; 0 is left-aligned, |
1 is centered, 2 is right-aligned. | |||
altname | name | alternative name, | |
the name shown in the user interface | |||
backgroundcolor | color of box | ||
bordercolor | color of border | ||
bordersep | box border gap | ||
borderwidth | 1 | width of box border, the value is a dimension | |
or a number with default unit bp | |||
calculate | JavaScript code to calculate the value of the field | ||
charsize | dimen | font size of field text | |
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 | false | whether option selected by default |
color | color of text in box | ||
combo | boolean | false | choice list is ‘combo’ style |
default | default value | ||
disabled | boolean | false | field disabled |
format | JavaScript code to format the field | ||
height | dimen | height of field box | |
hidden | boolean | false | field hidden |
keystroke | JavaScript code to control the keystrokes on entry | ||
mappingname | name | the mapping name to be used when exporting | |
the field data | |||
maxlen | number | 0 | number of characters allowed in text field |
menulength | number | 4 | number of elements shown in list |
multiline | boolean | false | whether text box is multiline |
name | name | name of field (defaults to label) | |
onblur | JavaScript code | ||
onchange | JavaScript code | ||
onclick | JavaScript code | ||
ondblclick | JavaScript code | ||
onfocus | JavaScript code | ||
onkeydown | JavaScript code | ||
onkeypress | JavaScript code | ||
onkeyup | JavaScript code | ||
onmousedown | JavaScript code | ||
onmousemove | JavaScript code | ||
onmouseout | JavaScript code | ||
onmouseover | JavaScript code | ||
onmouseup | JavaScript code | ||
onselect | JavaScript code | ||
password | boolean | false | text field is ‘password’ style |
popdown | boolean | false | choice list is ‘popdown’ style |
radio | boolean | false | choice list is ‘radio’ style |
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 | false | field is readonly |
rotation | number | 0 | rotation of the widget annotation |
(degree, counterclockwise, multiple of 90) | |||
tabkey | (as per HTML) | ||
validate | JavaScript code to validate the entry | ||
value | initial value | ||
width | dimen | width of field box | |
A hyperref driver has to provide definitions for eight macros:
1. \hyper@anchor
2. \hyper@link
3. \hyper@linkfile
4. \hyper@linkurl
5. \hyper@anchorstart
6. \hyper@anchorend
7. \hyper@linkstart
8. \hyper@linkend
The draft option defines the macros as follows
Package hyperref aims to cooperate with other packages, but there are several possible sources for conflict, such as
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 \label/\ref mechanisms and per-chapter tables of contents, respectively.
Currently only package loading orders are available:
Note: hyperref loads package "nameref" at \begin{document}. Sometimes this is too late, thus this package must be loaded earlier.
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:
Package loading order:
Package longtable must be put before hyperref and arydshln, hyperref after arydshln generates an error, thus the resulting package order is then:
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/.
Babel’s spanish.ldf redefines ‘\.’ to support ‘\...’. In bookmarks (\pdfstringdef) only ‘\.’ is supported. If ‘\...’ is needed, \texorpdfstring{\...}{\dots} can be used instead.
Workaround:
Hyperref does not support package ‘bigfoot’. And package ‘bigfoot’ does not support hyperref’s footnotes and disables them (hyperfootnotes=false).
Package ‘chappg’ uses \@addtoreset that is redefined by ‘hyperref’. The package order is therefore:
This is from Mike Shell: cite.sty cannot currently be used with hyperref. However, I can do a workaround via:
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).
Package ‘count1to’ adds several \@addtoreset commands that confuse ‘hyperref’. Therefore \theH<...> has to be fixed:
pd1enc.def or puenc.def should be loaded before:
or see entry for "vietnam".
Not compatible, breaks.
This packages redefines \textellipsis after package hyperref (pd1enc.def/puenc.def should be loaded before):
Unsupported.
Update to version 2008/01/28 v2.1.4b: Since version 6.77a hyperref does not hack into \@begindvi, it uses package ‘atbegshi’ instead, that hooks into \shipout. Thus the patch of ‘foils.cls’ regarding hyperref is now obsolete and causes an undefined error message about \@hyperfixhead. This is fixed in FoilTeX 2.1.4b.
This package is not supported, you have to disable hyperref’s footnote support by using option "hyperfootnotes=false".
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:
version >= V1.6b (because of \@makecaption, see ChangeLog)
version >= 1995/09/28 v4.1 (because of \addcontentsline redefinition)
Compatible.
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.
This package is obsolete, use the uptodate original package minitoc instead.
Example for introducing links for the page numbers:
For equations the following might work:
Both packages want to redefine \@starttoc.
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’.
"nameref" supports titlesec, but hyperref does not (unsolved is the anchor setting, missing with unnumbered section, perhaps problems with page breaks with numbered ones).
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:
The notation with two carets avoids trouble with 8-bit bytes for the README file, you can use the characters directly.
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:
Also some babel versions can be problematic. For exmample, 2005/05/21 v3.8g contains a patch for varioref that breaks the hyperref support for varioref.
Also unsupported:
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):
Default for the encoding of bookmarks is ‘pdfencoding=auto’. That means the strings are always treated as unicode strings. Only if the string restricts to the printable ASCII set, it is written as ASCII string. The reason is that the \special does not support PDFDocEncoding.
XeTeX uses the program xdvipdfmx for PDF output generation. This program behaves a little different from dvipdfm, because of the supported Unicode characters. Strings for bookmarks or information entries can be output directly. The big chars (char code > 255) are written in UTF-8 and xdvipdfmx tries to convert them to UTF-16BE. However hyperref already provides PDF strings encoded in UTF-16BE, thus the result is a warning
"Failed to convert input string to UTF16..."
The best way would be, if xdvipdfm could detect the byte order marker (\376\377) and skips the conversion if that marker is present.
For the time being I added the following to hyperref, when option ‘pdfencoding=auto’ is set (default for XeTeX): The string is converted back to big characters thus that the string is written as UTF-8. But I am very unhappy with this solution. Main disadvantage: Two versions of \pdfstringdef are needed:
a) The string is converted back to big characters for the "tainted keys" of xdvipdfmx (spc_pdfm.c: default_taintkeys). The subset hyperref uses is /Title, /Author, /Subject, /Keywords, /Creator, /Producer, /T. Any changes of this set in xdvipdfmx cannot be detected by hyperref.
b) Without conversion for the other strings , providing UTF16be directly. Examples: Prefix of page labels, some elements of formulars.
Thus each application that uses \pdfstringdef now must check, if it defines a string for some of the tained keys. If yes, then the call of \pdfstringdef should be preceded by "\csname HyPsd@XeTeXBigCharstrue\endcsname". Example: package bookmark.
Only few drivers support automatically wrapped/broken links, e.g. pdftex, dvipdfm, hypertex. Other drivers lack this feature, e.g. dvips, dvipsone.
Workarounds:
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).
In general they have problems:
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 \footnotemark to \footnotetext is not as strong as \ref to \label. Therefore it is not clear in general which \footnotemark references which \footnotetext. But that is necessary to implement hyperlinking. Thus the implementation of hyperref does not support the optional argument of \footnotemark\verb and \footnotetext.
Unhappily LaTeX strips spaces from options if they are given in \documentclass or \usepackage (or \RequirePackage), e.g.:
Package hyperref now gets
and the result is an invalid PDF file. As workaround braces can be used:
Some options can also be given in \hypersetup
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 packages "kvoptions-patch" (from project "kvoptions") or "xkvltxp" (from project "xsetkeys").
Getting rid of it:
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.sty" that implements a method to circumvent the problem.
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 (\.{a}, \d{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.)
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):
Optional: "8" is used for abbreviations:
5. Declare the character with LaTeX:
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 "hyperfootnotes=false" or fiddle with internal macros, nasty examples:
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 \@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 meaning of \@addtoreset is called without hyperref’s additions. Then the companion counter macro \theH<counter> can be redefined accordingly. Or move the definition of subordinate counters after hyperref is loaded.
Example for \newtheorem, problematic case:
Solution a)
Solution b)
The original authors of hyperbasics.tex and hypertex.sty, from which this package descends, are Tanmoy Bhattacharya and Thorsten Ohl. Package hyperref started as a simple port of their work to LATEX2ε standards, but eventually I rewrote nearly everything, because I didn’t understand a lot of the original, and was only interested in getting it to work with LATEX. I would like to thank Arthur Smith, Tanmoy Bhattacharya, Mark Doyle, Paul Ginsparg, David Carlisle, T. V. Raman and Leslie Lamport for comments, requests, thoughts and code to get the package into its first useable state. Various other people are mentioned at the point in the source where I had to change the code in later versions because of problems they found.
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 dvipsone and dviwindo drivers. Sergey Lesenko provided the changes needed for dvipdf, and Hàn Thê´ Thành supplied all the information needed for pdftex. Patrick Daly kindly updated his natbib package to allow easy integration with hyperref. Michael Mehlich’s 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 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 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 hyperref.
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.
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 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 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.
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 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 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 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 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 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 for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or 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 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 proprietary formats that can be read and edited only by proprietary word processors, SGML 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 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 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 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.
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 13.3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
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 identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in 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 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 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 of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will 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 redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 13.2 and 13.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:
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 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 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 names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 13.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 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 documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements”.
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 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.
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 13.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.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 13.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 this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original 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 requirement (section 13.4) to Preserve its Title (section 13.1) will typically require changing the actual title.
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.
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 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.
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 © 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.” line with this:
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 those two alternatives to suit the situation.
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.