From b77d0d3ac4159779a8c68ae949f717bdd72ca634 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 20 Jan 2007 00:29:10 +0000 Subject: hyperref update (19jan07) git-svn-id: svn://tug.org/texlive/trunk@3605 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/hyperref/manual.html | 887 ++++++++++++----------- 1 file changed, 454 insertions(+), 433 deletions(-) (limited to 'Master/texmf-dist/doc/latex/hyperref/manual.html') diff --git a/Master/texmf-dist/doc/latex/hyperref/manual.html b/Master/texmf-dist/doc/latex/hyperref/manual.html index 1c68aeb5de3..a12f7d66902 100644 --- a/Master/texmf-dist/doc/latex/hyperref/manual.html +++ b/Master/texmf-dist/doc/latex/hyperref/manual.html @@ -7,7 +7,7 @@ - + @@ -267,7 +267,7 @@ class="ecbx-1000">dvipdfmx
produces \special commands for driver dvipdfmx, a successor of dvipdfm. +class="ecss-1000">dvipdfm
dviwindo
textures
produces \special commands that Textures interprets as hypertext jumps within the - previewer
-

Output from

+xetex
produces \special commands for XeTEX
+

Output from dvips or dvipsone must be processed using Acrobat Distiller to obtain a PDF file.xdvi.

2 Implicit behavior

-

This package can be used with more or less any normal LAT

This package can be used with more or less any normal LATEX document by specifying in the -document preamble - +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. Hopefully you will find that all cross-references @@ -326,7 +331,7 @@ 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. @@ -334,10 +339,10 @@ Other options control the appearance of links, and give extra control over PDF o colorlinks, as its name well implies, colors the links instead of using boxes; this is the option used in this document. -

+

3 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 lo hyperref.cfg is read if it can be found, and this is a convenient place to set options on a site-wide basis. -

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:

-

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

+

3.1 General options

-

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

+

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

-

+

3.2 Configuration options

-

+

boolean boolean
true -

In the hypertex driver, the height of links is +

In the hypertex driver, the height of links is normally calculcated by the driver as simply the base line of contained text; this options forces boolean

false -

Allows link text to break across lines; since +

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 @@ -602,7 +607,7 @@ class="td11"> boolean

true -

Determines whether every page is given an +

Determines whether every page is given an implicit anchor at the top left corner. If this is turned off, \printindex will not contain valid @@ -615,7 +620,7 @@ class="td11"> boolean

false -

Forces page anchors to be named by the arabic +

Forces page anchors to be named by the arabic form of the page number, rather than the formatted form.

false -

Allows links to be nested; no drivers currently +

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

+

3.3 Backend drivers

-

If no driver is specified, the package defaults to loading the hypertex driver. All of these are boolean -options. -

+

If no driver is specified, the package defaults to loading the hypertex driver. +

class="td11"> dvipdfm dvipdfm driver. class="td11"> dvipdfmx dvipdfmx driver. class="td11"> dvips dvips driver. class="td11"> dvipsone - - + + EX-compliant drivers. class="td11"> latex2html +

An alias for dvips

+

An alias for dvips

pdftex program. < class="td11"> ps2pdf dvips. class="td11"> tex4ht +class="ecss-1000">4htVTeX; the PDF and HTML backends are detected class="td11"> vtexpdfmark +

For use with VTeX’s PostScript backend.

+class="td11"> xetex @@ -798,7 +806,7 @@ class="td11"> class="td11">
-

Sets up

Sets up hyperref for use with the dvipdfm driver.

-

Sets up

Sets up hyperref for use with the dvipdfmx driver.

-

Sets up

Sets up hyperref for use with the dvips driver.

-

Sets up

Sets up hyperref for use with the dvipsone driver.

dviwindo -

Sets up

Sets up hyperref for use with the dviwindo Windows previewer.

hypertex -

Sets up

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

-

Redefines a few macros for compatibility with

Redefines a few macros for compatibility with latex2html.

nativepdf -

an alias for dvips

pdfmark -

an alias for dvips

pdftex -

Sets up

Sets up hyperref for use with the pdftex program.

-

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

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

-

for use with

For use with TEX4ht

textures -

for use with

For use with Textures

vtex -

For use with MicroPress’

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

-

for use with VTeX’s PostScript backend.

+

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

 
  Internet\string\iexplore.exe}
-

-

+

+

3.4 Extension options

-

+

extension +

boolean @@ -901,7 +909,7 @@ class="td11"> boolean encap +

Sets encap character for hyperindex

@@ -943,7 +951,7 @@ class="td11"> boolean +

Color for normal internal links.

+

Color for anchor text.

+

Color for URLs which open local files.

+

Color for Acrobat menu items.

+

Color for linked URLs.

+

use small caps instead of color for links

@@ -1039,16 +1047,16 @@ class="td11">
text -

Set the file extension (e.g. 

Set the file extension (e.g. dvi) which will be appended to file links created if you use the hyperfigures

boolean -

boolean false -

Adds ‘backlink’ text to the end of each +

Adds ‘backlink’ text to the end of each item in the bibliography, as a list of section numbers. This can only work properly boolean

false -

Adds ‘backlink’ text to the end of each +

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

true -

Makes the page numbers of index +

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

true -

Makes the footnote marks into +

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

-

Sets encap character for hyperindex

boolean false -

make page number, not text, be link on +

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

boolean false -

allow links to break over lines by +

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

false -

Colors the text of links and anchors. +

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 @@ -957,7 +965,7 @@ class="td11"> color

red -

Color for normal internal links.

color black -

Color for anchor text.

color green -

Color for bibliographical citations in +

Color for bibliographical citations in text.

color magenta -

Color for URLs which open local files.

color red -

Color for Acrobat menu items.

color red -

Color for links to other pages, but +

Color for links to other pages, but currently unused.

color cyan -

Color for linked URLs.

boolean false -

use small caps instead of color for links

-

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

+

3.5 PDF-specific display options

-

+

boolean +

to specify which ‘toc’ file to mimic

@@ -1151,7 +1159,7 @@ class="td11"> name @@ -1163,7 +1171,7 @@ class="td11"> RGB color +

The color of the box around citations

+

The color of the box around links to files

+

The color of the box around normal links

+

The color of the box around Acrobat menu links

+

The color of the box around links to pages

+

The color of the box around links to URLs

+

color of border around ‘run’ links

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 @@ -1088,7 +1096,7 @@ class="td11"> boolean

false -

If Acrobat bookmarks are requested, show them +

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

bookmarksopenlevel parameter -

level (

level (\maxdimen) to which bookmarks are open

boolean false -

If Acrobat bookmarks are requested, include +

If Acrobat bookmarks are requested, include section numbers.

text toc -

to specify which ‘toc’ file to mimic

boolean false -

This option should be used to produce CJK +

This option should be used to produce CJK bookmarks. Package hyperref supports both normal and preprocessed mode of the CJK @@ -1139,7 +1147,7 @@ class="ectt-1000">hyperref supports both non-Unicode character codes are used – some PDF readers localized for CJK languages (most notably Acroread itself) support this. -

No mechanism is provided to +

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

/I -

How link buttons behave when selected; /I is +

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

0 1 0 -

The color of the box around citations

RGB color 0 .5 .5 -

The color of the box around links to files

RGB color 1 0 0 -

The color of the box around normal links

RGB color 1 0 0 -

The color of the box around Acrobat menu links

RGB color 1 1 0 -

The color of the box around links to pages

RGB color 0 1 1 -

The color of the box around links to URLs

RGB color 0 .7 .7 -

color of border around ‘run’ links

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.

-

Note that the color of link borders can be specified

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

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 LAT

\let\WriteBookmarks\relax
-

-

+

+

3.6 PDF display and information options

-

+

baseurl +

Set the startup page view

pdfpagescrop boolean +

direction setting

+

paper handling option for print dialog

+

PDF language identifier (RFC 3066)

+

make PDF viewer’s menu bar visible

+

number of printed copies

+

set layout of PDF pages

+

set PDF page labels

+

set PDF page transition style

+

set option for print dialog

+

set /PrintArea of viewer preferences

+

set /PrintClip of viewer preferences

@@ -1590,7 +1598,7 @@ class="td11"> boolean +

make PDF toolbar visible

+

set /ViewArea of viewer preferences

text +

set /ViewClip of viewer preferences

+

Unicode encoded PDF strings

@@ -1644,12 +1652,12 @@ class="td11"> class="td11">
URL -

Sets the base URL of the PDF +

Sets the base URL of the PDF document

text empty -

Determines how the file is +

Determines how the file is opening in Acrobat; the possibilities are None, pdftitle

text -

Sets the document information Title +

Sets the document information Title field

pdfauthor text -

Sets the document information Author +

Sets the document information Author field

pdfsubject text -

Sets the document information Subject +

Sets the document information Subject field

pdfcreator text -

Sets the document information Creator +

Sets the document information Creator field

pdfproducer text -

Sets the document information +

Sets the document information Producer field

pdfkeywords text -

Sets the document information +

Sets the document information Keywords field

text XYZ -

Sets the default PDF ‘view’ for each +

Sets the default PDF ‘view’ for each link

text 1 -

Determines on which page the PDF file +

Determines on which page the PDF file is opened.

text Fit -

Set the startup page view

n n n n -

Sets the default PDF crop box for +

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

false -

position the document window in the +

position the document window in the center of the screen

text empty -

direction setting

boolean false -

display document title instead of file +

display document title instead of file name in title bar

text empty -

paper handling option for print dialog

boolean false -

resize document window to fit +

resize document window to fit document size

text empty -

PDF language identifier (RFC 3066)

boolean true -

make PDF viewer’s menu bar visible

boolean false -

make links that open another PDF file +

make links that open another PDF file start a new window

boolean empty -

page mode setting on exiting full-screen +

page mode setting on exiting full-screen mode

integer empty -

number of printed copies

text empty -

set layout of PDF pages

boolean true -

set PDF page labels

text empty -

set PDF page transition style

text empty -

set option for print dialog

text empty -

set /PrintArea of viewer preferences

text empty -

set /PrintClip of viewer preferences

n n (n n)* empty -

set /PrintPageRange of viewer +

set /PrintPageRange of viewer preferences

text empty -

page scaling option for print dialog; +

page scaling option for print dialog; valid values are None and AppDefault

true -

make PDF toolbar visible

text empty -

set /ViewArea of viewer preferences

empty -

set /ViewClip of viewer preferences

boolean true -

make PDF user interface elements +

make PDF user interface elements visible

boolean false -

Unicode encoded PDF strings

-

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

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 32. pdfT33. pdfTEX works by supplying default values for XYZ (horizontal hyperref passes in a value of -32768, which causes Acro class="ectt-1000">pdfview and pdfstartview parameters. -

+

XYZ +

Fits the page to the window.

+

Fits the width of the page to the window.

+

Fits the height of the page to the window.

+

Fits the page bounding box to the window.

left top zoom -

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

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

-

Fits the page to the window.

FitH top -

Fits the width of the page to the window.

FitV left -

Fits the height of the page to the window.

FitR left bottom right top -

Fits the rectangle specified by the four +

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

FitB -

Fits the page bounding box to the window.

FitBH top -

Fits the width of the page bounding box to +

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

FitBV left -

Fits the height of the page bounding box to +

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

-

The

The pdfpagelayout can be one of the following values. -

+

class="td11"> SinglePage +

Displays a single page; advancing flips the page

+

Displays the document in one column; continuous scrolling.

class="td11">
-

Displays a single page; advancing flips the page

OneColumn -

Displays the document in one column; continuous scrolling.

TwoColumnLeft -

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

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

TwoColumnRight -

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

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

-

Finally, the

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

+

Blinds +

A box sweeps in or out.

+

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

/Dm -

Multiple lines distributed evenly across the screen sweep +

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

Box /M -

A box sweeps in or out.

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 -

Similar to Dissolve, except the effect sweeps across the +

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

Split /Dm /M -

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

Wipe /Di -

A single line sweeps across the screen to reveal the new +

A single line sweeps across the screen to reveal the new page.

-

+

3.7 Big alphabetical list

-

The following is a complete listing of available options for

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

+

a4paper +

use A4 paper

+

use A5 paper

+

set color of anchors

+

use B5 paper

+

do bibliographical back references

+

set base URL for document

+

make bookmarks

+

put section numbers in bookmarks

+

open up bookmark tree

+

level to which bookmarks are open

+

to specify which ‘toc’ file to mimic

+

allow links to break over lines

+

to produce CJK bookmarks

+

color of border around cites

+

color of citation links

+

color links

debug +

do not do any hyperlinking

@@ -2102,7 +2110,7 @@ class="td11"> dvipsone +

to set encap character for hyperindex

+

use executivepaper

+

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

+

make figures hyper links

+

set up hyperlinked footnotes

+

set up hyperlinked indices

+

use guessable names for links

+

use legalpaper

@@ -2250,7 +2258,7 @@ class="td11"> letterpaper +

use letterpaper

+

color of border around links

+

color of links

+

color of border around menu links

+

color for menu links

@@ -2319,7 +2327,7 @@ class="ectt-1000">nesting +

allow nesting of links

+

put an anchor on every page

+

backreference by page number

+

color of border around page links

+

color of page links, but currently unused

+

text for PDF Author field

+

width of PDF link border

+

text for PDF Creator field

+

+

@@ -2418,7 +2426,7 @@ class="ectt-1000">pdfdirection +

direction setting

+

paper handling option for print dialog

+

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

pdfnonfullscreenpagemode +

number of printed copies

+

set layout of PDF pages

+

set default mode of PDF display

+

set PDF page labels

+

set crop size of PDF document

+

set PDF page transition style

+

set option for print dialog

+

set /PrintArea of viewer preferences

@@ -2586,7 +2594,7 @@ class="ectt-1000">pdfprintclip +

set /PrintClip of viewer preferences

+

page scaling option for print dialog

+

text for PDF Producer field

+

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

+

do page number anchors as plain arabic

ps2pdf +

color of border around ‘run’ links

+

Unicode encoded pdf strings

+

color of border around URL links

+

color of URL links

+

be chatty

+class="td11"> xetex @@ -2823,32 +2840,35 @@ class="td11"> class="td11"> +
-

use A4 paper

a5paper -

use A5 paper

anchorcolor black -

set color of anchors

b5paper -

use B5 paper

backref false -

do bibliographical back references

baseurl empty -

set base URL for document

bookmarks true -

make bookmarks

bookmarksnumbered false -

put section numbers in bookmarks

bookmarksopen false -

open up bookmark tree

bookmarksopenlevel \maxdimen -

level to which bookmarks are open

bookmarkstype toc -

to specify which ‘toc’ file to mimic

breaklinks false -

allow links to break over lines

CJKbookmarks false -

to produce CJK bookmarks

citebordercolor 0 1 0 -

color of border around cites

citecolor green -

color of citation links

colorlinks false -

color links

true -

(

(tex4ht, dviwindo)

false -

provide details of anchors defined; same +

provide details of anchors defined; same as verbose

draft false -

do not do any hyperlinking

dvipdf -

use

use dvipdf backend (deprecated)

dvipdfm -

use

use dvipdfm backend

dvipdfmx -

use

use dvipdfmx backend

dvips -

use

use dvips backend

-

use

use dvipsone backend

dviwindo -

use

use dviwindo backend

encap -

to set encap character for hyperindex

executivepaper -

use executivepaper

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

use HyperThypertexnames

true -

use guessable names for links

implicit true -

redefine LAT

redefine LATEX internals

latex2html -

use

use LAT legalpaper

-

use legalpaper

-

use letterpaper

linkbordercolor 1 0 0 -

color of border around links

linkcolor red -

color of links

linktocpage false -

make page number, not text, be link on +

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

menubordercolor 1 0 0 -

color of border around menu links

menucolor red -

color for menu links

nativepdf false -

an alias for

an alias for dvips

naturalnames false -

use LAT

use LATEX-computed names for links

false -

allow nesting of links

pageanchor true -

put an anchor on every page

pagebackref false -

backreference by page number

pagebordercolor 1 1 0 -

color of border around page links

pagecolor red -

color of page links, but currently unused

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 +

position the document window in the center of the screen

pdfcreator LaTeX with -

text for PDF Creator field

hyperref -

package -

empty -

direction setting

pdfdisplaydoctitle false -

display document title instead of file +

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 +

resize document window to fit document size

pdfhighlight /I -

set highlighting of PDF links

pdfkeywords empty -

text for PDF Keywords field

pdflang empty -

PDF language identifier (RFC 3066)

pdfmark false -

an alias for

an alias for dvips

pdfmenubar true -

make PDF viewer’s menu bar visible

pdfnewwindow false -

make links that open another PDF

-

file start a new window

empty -

page mode setting on exiting full-screen +

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

pdfpicktrackbypdfsize empty -

set option for print dialog

pdfprintarea empty -

set /PrintArea of viewer preferences

empty -

set /PrintClip of viewer preferences

pdfprintpagerange empty -

set /PrintPageRange of viewer +

set /PrintPageRange of viewer preferences

pdfprintscaling empty -

page scaling option for print dialog

pdfproducer empty -

text for PDF Producer field

pdfstartpage 1 -

page at which PDF document opens

pdfstartview Fit -

starting view of PDF document

pdfsubject empty -

text for PDF Subject field

pdftex -

use

use pdfTpdftitle

empty -

text for PDF Title field

pdftoolbar true -

make PDF toolbar visible

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 +

make PDF user interface elements visible

plainpages false -

do page number anchors as plain arabic

-

use

use ps2pdf backend

raiselinks false -

raise up links (for

raise up links (for HyperTrunbordercolor

0 .7 .7 -

color of border around ‘run’ links

setpagesize true -

set page size by special driver +

set page size by special driver commands

tex4ht -

use

use TE textures

-

use

use Textures backend

unicode false -

Unicode encoded pdf strings

urlbordercolor 0 1 1 -

color of border around URL links

urlcolor magenta -

color of URL links

verbose false -

be chatty

vtex -

use

use VTeX backend

+

use XeTEX backend

-

+

4 Additional user macros

-

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

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

+

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

+

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

+type. Thus the result can be a url link, file link, . . . +

\nolinkurl{URL} -

Write

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

+

\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{imageURL}{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{categoryname}{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{URLname}{text} -

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

+

\hyperlink{name}{text} -

+

\hypertarget{name}{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 of \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 choosen 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: +is set. Example: +

@@ -2964,19 +2985,19 @@ class="verbatim">
 
\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. -

+

\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 @@ -2984,16 +3005,16 @@ macros listed below (shown with their default values). The macros can be (re)def class="ectt-1000">\(re)newcommand; note that some of these macros are already defined in the standard document classes. The mixture of lowercase and uppercase initial letters is deliberate and corresponds to the author’s practice. -

For each macro below,

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

+

class="td11"> Macro +

Figure

+

Table

+

Part

+

Appendix

+

Equation

+

item

+

chapter

+

section

+

subsection

class="td11"> \subsubsectionname +

subsubsection

+

paragraph

+

footnote

+

Equation

+

Theorem

@@ -3105,19 +3126,19 @@ class="td11"> class="td11">
-

Default

\figurename -

Figure

\tablename -

Table

\partname -

Part

\appendixname -

Appendix

\equationname -

Equation

\Itemname -

item

\chaptername -

chapter

\sectionname -

section

\subsectionname -

subsection

-

subsubsection

\paragraphname -

paragraph

\Hfootnotename -

footnote

\AMSname -

Equation

\theoremname -

Theorem

-

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

For instances where you want a reference to use the correct counter, but not to create a link, there are two starred forms: -

+

\ref*{label} -

+

\pageref*{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{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 +

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

+

4.1 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{TEXstring}{PDFstring} -

For example, +

For example,
 
\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. @@ -3236,8 +3257,8 @@ class="verbatim">

 
}
-

-

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 @@ -3254,16 +3275,16 @@ class="verbatim">

 
}
-

-

+

+

4.2 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

 
}
-

-

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

Note, for calculations you need either package |calc| or

+

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

Note, for calculations you need either package |calc| or e-TEX. Nowadays the latter should @@ -3294,7 +3315,7 @@ src="cmmi10-22.gif" alt="e" class="10x-x-22" />-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, @@ -3302,26 +3323,26 @@ because LATEX expands the option lists of these commands. However package hyperref is not yet loaded and an undefined control sequence error would arise. -

+

5 Acrobat-specific behavior

-

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

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

+

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

+

valign="baseline" id="TBL-13-1-"> +

ImportImage, ImportNotes, AcroForm:ImportFDF

+

ExportNotes, AcroForm:ExportFDF

@@ -3369,7 +3390,7 @@ class="td11"> valign="baseline" id="TBL-13-6-"> @@ -3377,19 +3398,19 @@ class="td11"> valign="baseline" id="TBL-13-7-"> +

Properties

+

AcroForm:Duplicate, AcroForm:TabOrder

@@ -3397,7 +3418,7 @@ class="td11"> valign="baseline" id="TBL-13-10-"> @@ -3416,28 +3437,28 @@ class="td11"> Tools-->Search +

About

@@ -3452,29 +3473,29 @@ class="td11"> class="td11">
File -

Open, Close, Scan, Save, SaveAs, Optimizer:SaveAsOpt, +

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

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

File-->Preferences -

GeneralPrefs, NotePrefs, FullScreenPrefs, Weblink:Prefs, +

GeneralPrefs, NotePrefs, FullScreenPrefs, Weblink:Prefs, AcroSearch:Preferences(Windows) or, AcroSearch:Prefs(Mac), Cpt:Capture

Edit -

Undo, Cut, Copy, Paste, Clear, SelectAll, Ole:CopyFile, +

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

Cpt:CapturePages, AcroForm:Actions, CropPages, RotatePages, InsertPages, ExtractPages, ReplacePages, DeletePages, NewBookmark, SetBookmarkDest, CreateAllThumbs, DeleteAllThumbs

View -

ActualSize, FitVisible, FitWidth, FitPage, ZoomTo, +

ActualSize, FitVisible, FitWidth, FitPage, ZoomTo, FullScreen, FirstPage, PrevPage, NextPage, LastPage, GoToPage, GoBack, GoForward, SinglePage, OneColumn, TwoColumns, ArticleThreads, PageOnly, ShowBookmarks, @@ -3406,7 +3427,7 @@ class="td11"> valign="baseline" id="TBL-13-11-">

Tools -

Hand, ZoomIn, ZoomOut, SelectText, SelectGraphics, +

Hand, ZoomIn, ZoomOut, SelectText, SelectGraphics, Note, Link, Thread, AcroForm:Tool, Acro_Movie:MoviePlayer, TouchUp:TextTool, Find, FindAgain, FindNextNote, CreateNotesFile

-

AcroSrch:Query, AcroSrch:Indexes, AcroSrch:Results, +

AcroSrch:Query, AcroSrch:Indexes, AcroSrch:Results, AcroSrch:Assist, AcroSrch:PrevDoc, AcroSrch:PrevHit, AcroSrch:NextHit, AcroSrch:NextDoc

Window -

ShowHideToolBar, ShowHideMenuBar, +

ShowHideToolBar, ShowHideMenuBar, ShowHideClipboard, Cascade, TileHorizontal, TileVertical, CloseAll

Help -

HelpUserGuide, HelpTutorial, HelpExchange, HelpScan, +

HelpUserGuide, HelpTutorial, HelpExchange, HelpScan, HelpCapture, HelpPDFWriter, HelpDistiller, HelpSearch, HelpCatalog, HelpReader, Weblink:Home

Help(Windows) -

About

-

+

6 PDF and HTML forms

-

You must put your fields inside a

You must put your fields inside a Form environment (only one per file). -

There are six macros to prepare fields: +

There are six macros to prepare fields: -

+

\TextField[parameters]{label} -

+

\CheckBox[parameters]{label} -

+

\ChoiceMenu[parameterslabel}{choices} -

+

\PushButton[parameters]{label} -

+

\Submit[parameters]{label} -

+

\Reset[parameters]{label} -

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

+

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

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

+

These macros default to #1 #2 +

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

\MakeRadioField{width}{height} -

+

\MakeCheckField{width}{height} -

+

width}{height} -

+

\MakeChoiceField{width}{height} -

+

\MakeButtonField{text} -

These macros default to

These macros default to \vbox to #2{\hbox #1{\hfill}\vfill}, except the last, 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\DefaultWidthofText{3cm}
-

-

+

+

6.1 Forms environment parameters

-

+

action encoding method @@ -3651,16 +3672,16 @@ class="td11">
URL -

The URL that will receive the form data if a

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

name -

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

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

name -

Used only when generating HTML; values can be

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

-

+

6.2 Forms optional parameters

-

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

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

+

-

+

7 Defining a new driver

-

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

1.

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

1. \hyper@anchor -

2.

2. \hyper@link -

3.

3. \hyper@linkfile -

4.

4. \hyper@linkurl -

5.

5. \hyper@anchorstart -

6.

6. \hyper@anchorend -

7.

7. \hyper@linkstart -

8.

8. \hyper@linkend -

The draft option defines the macros as follows +

The draft option defines the macros as follows
 
\let\hyper@linkend\@empty
-

-

+

+

8 Special support for other packages

-

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

+

-

The

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 EX’s normal \label/\ref mechanisms and per-chapter tables of contents, respectively. -

+

9 History and acknowledgments

-

The original authors of

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

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

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 (bmoss@math.clemson.edu) into the later versions includi many bugs, and his testing is appreciated. Hans Hagen (pragma@pi.net) 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 Dandy recreated the manual source in July 2003 after it had been lost. -

Especial extra thanks to David Carlisle for the

Steve Dandy 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 -- cgit v1.2.3