From d22dbedf055ea3923fb14ffc86889bddc06b1a96 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 4 Sep 2009 00:51:54 +0000 Subject: hyperref update (2sep09) git-svn-id: svn://tug.org/texlive/trunk@15059 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/hyperref/manual.html | 3793 ++++++++++++---------- 1 file changed, 2004 insertions(+), 1789 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 7defe603f35..6e09e7cbafc 100644 --- a/Master/texmf-dist/doc/latex/hyperref/manual.html +++ b/Master/texmf-dist/doc/latex/hyperref/manual.html @@ -7,7 +7,7 @@ - + @@ -21,8 +21,7 @@ class="E">EX: a manual for hyperref
Sebastian Rahtz
Heiko Oberdiek
-
+class="ec-lmr-12">Heiko Oberdiek
October 2008
@@ -97,9 +96,10 @@ href="#x1-3300010.10" id="QQ2-1-33">Future revisions of this license

1 Introduction

The package derives from, and builds on, the work of the HyperTEX project, described at EX project, described at +http://xxx.lanl.gov/hypertex/. It extends the functionality of all the LAThttp://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 @@ -201,7 +201,7 @@ or local identifier, while name_string could be any string at all: the only caveat is that ‘"’ characters should be escaped with a backslash (n), and if it looks like a URL name it may cause +class="lmsy-10">\), and if it looks like a URL name it may cause problems. @@ -319,12 +319,9 @@ class="E">EX document by specifying in the document preamble -
+
\usepackage{hyperref}
-

Make sure it comes last of your loaded packages, to give it a fighting chance of not being over-written, @@ -365,26 +362,20 @@ class="ec-lmtt-10">hyperref.cfg setting up the look of links, adding back a PDF display default: -
+
\hypersetup{backref,  
pdfpagemode=FullScreen,  
colorlinks=true}
-

  • A global option in the file, which is passed down to hyperref: -
    +
    \documentclass[dvips]{article}
    -

  • File-specific options in the \usepackage commands, which override the class="ec-lmtt-10">hyperref.cfg: -
    - \usepackage[pdftitle={A Perfect Day},colorlinks=false]{hyperref} +
    + \usepackage[colorlinks=false]{hyperref} +  
    \hypersetup{pdftitle={A Perfect Day}} +
    +

    +

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

    +\usepackage[pdfborder={0 0 0}]{hyperref} + 
    \hypersetup{pdfborder=0 0 0}
    -
    -

  • -

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

    +

    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 +

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

    +class="td11"> all hypertext options are turned off +class="td11"> all hypertext options are turned on +class="td11"> extra diagnostic messages are printed in +class="td11"> +class="td11"> same as debug +class="td11"> use guessable names for links +class="td11"> sets paper size to 210mm × 297mm +class="td11"> sets paper size to 148mm × 210mm +class="td11"> sets paper size to 176mm × 250mm +class="td11"> sets paper size to 8.5in × 11in +class="td11"> sets paper size to 8.5in × 14in +class="td11"> sets paper size to 7.25in × 10.5in +class="td11"> sets page size by special driver commands +class="td11"> +class="td11"> +class="td11">
    draft boolean boolean false all hypertext options are turned off
    final boolean boolean true all hypertext options are turned on
    debug boolean boolean false extra diagnostic messages are printed in
    the log file the log file
    verbose boolean boolean false same as debug
    implicit boolean boolean true redefines LAT redefines LATEX internals
    hypertexnames boolean boolean true use guessable names for links
    naturalnames boolean boolean false use LAT use LATEX-computed names for links
    a4paper boolean boolean true sets paper size to 210mm 297mm
    a5paper boolean boolean false sets paper size to 148mm 210mm
    b5paper boolean boolean false sets paper size to 176mm 250mm
    letterpaper boolean boolean false sets paper size to 8.5in 11in
    legalpaper boolean boolean false sets paper size to 8.5in 14in
    executivepaper boolean boolean false sets paper size to 7.25in 10.5in
    setpagesize boolean boolean true sets page size by special driver commands
    -

    +

    3.2 Configuration options

    -

    +

    +id="TBL-3-4"> + +class="td11"> +class="td11"> +class="td11">
    raiselinks 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 \special commands to reflect the real graphic)

    breaklinks boolean 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 different PDF links to the same target.

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

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

    nesting boolean boolean 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

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

    +

    - - + + +class="td11"> +class="td11"> +class="td11">
    dvipdfm -

    Sets up

    Sets up hyperref for use with the dvipdfm driver.

    dvipdfmx -

    Sets up

    Sets up hyperref for use with the dvipdfmx driver.

    dvips -

    Sets up

    Sets up hyperref for use with the dvips driver.

    dvipsone -

    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.

    latex2html -

    Redefines a few macros for compatibility with

    Redefines a few macros for compatibility with latex2html.

    nativepdf -

    An alias for

    An alias for dvips

    pdfmark -

    An alias for

    An alias for dvips

    pdftex -

    Sets up

    Sets up hyperref for use with the pdftex program.

    ps2pdf -

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

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

    tex4ht -

    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.

    vtexpdfmark -

    For use with

    For use with VTeX’s PostScript backend.

    xetex -

    For use with XeT

    For use with XeTEX(using backend for dvipdfm).

    -

    If you use

    If you use dviwindo, you may need to redefine the macro \wwwbrowser (the default is dviwindo what program to launch. Thus, users of Intern add something like this to hyperref.cfg: -
    +
    \renewcommand{wwwbrowser}{C:\string\Program\space  
      Files\string\Plus!\string\Microsoft\space  
      Internet\string\iexplore.exe}
    -
    -

    -

    +

    +

    3.4 Extension options

    -

    +

    +

    +

    Sets encap character for hyperindex

    - - + + +

    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

    +class="td11"> +class="td11"> +class="td11">
    extension text text -

    Set the file extension (e.g. 

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

    hyperfigures boolean boolean -

    backref text text 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 section is taken as default.

    pagebackref 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 page numbers.

    hyperindex boolean boolean true -

    Makes the page numbers of index +

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

    pageanchors and plainpages=false.
    hyperfootnotes boolean boolean true -

    Makes the footnote marks into +

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

    encap -

    Sets encap character for hyperindex

    linktocpage boolean boolean false -

    make page number, not text, be link on +

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

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

    colorlinks boolean boolean 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 @@ -972,87 +976,87 @@ class="td11"> and other links.

    linkcolor color color red -

    Color for normal internal links.

    anchorcolor color color black -

    Color for anchor text.

    citecolor color color green -

    Color for bibliographical citations in +

    Color for bibliographical citations in text.

    filecolor color magenta color cyan -

    Color for URLs which open local files.

    menucolor color color red -

    Color for Acrobat menu items.

    runcolor color color filecolor -

    Color for run links (launch +

    Color for run links (launch annotations).

    urlcolor color cyan color magenta -

    Color for linked URLs.

    frenchlinks boolean 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

    -

    +

    - - + + +

    to specify which ‘toc’ file to mimic

    @@ -1170,11 +1174,11 @@ class="ec-lmtt-10">hyperref supports both style="vertical-align:baseline;" id="TBL-6-7-"> @@ -1182,78 +1186,76 @@ class="td10"> style="vertical-align:baseline;" id="TBL-6-8-"> +

    The color of the box around citations

    +

    The color of the box around links to files

    +

    The color of the box around normal links

    - - +

    The color of the box around Acrobat menu links

    +

    The color of the box around links to URLs

    +

    color of border around ‘run’ links

    +class="td01"> +class="td01"> +class="td01">
    bookmarks boolean boolean 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 @@ -1105,49 +1107,51 @@ class="ec-lmtt-10">\let\WriteBookmarks\relax style="vertical-align:baseline;" id="TBL-6-2-">

    bookmarksopen boolean boolean false -

    If Acrobat bookmarks are requested, show them +

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

    bookmarksopenlevel parameter parameter -

    level (

    level (\maxdimen) to which bookmarks are open

    bookmarksnumbered boolean boolean false -

    If Acrobat bookmarks are requested, include +

    If Acrobat bookmarks are requested, include section numbers.

    bookmarkstype text text toc -

    to specify which ‘toc’ file to mimic

    CJKbookmarks boolean 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 @@ -1162,7 +1166,7 @@ class="ec-lmtt-10">hyperref supports both notably Acroread itself) support this. Also note that option ‘CJKbookmarks’ cannot be used together with option ‘unicode’. -

    No mechanism is provided to +

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

    pdfhighlight name name /I -

    How link buttons behave when selected; /I is +

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

    citebordercolor RGB color RGB color 0 1 0 -

    The color of the box around citations

    filebordercolor RGB color RGB color 0 .5 .5 -

    The color of the box around links to files

    linkbordercolor RGB color RGB color 1 0 0 -

    The color of the box around normal links

    menubordercolor RGB color RGB color 1 0 0 -

    The color of the box around Acrobat menu links

    urlbordercolor RGB color RGB color 0 1 1 -

    The color of the box around links to URLs

    runbordercolor RGB color RGB color 0 .7 .7 -

    color of border around ‘run’ links

    pdfborder 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 LATEX so any markup is passed through. You can postprocess this file as needed; as an aid -for this, the EX 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 -
    - +class="E">EX run if it is edited to contain the line +
    -
    +
    \let\WriteBookmarks\relax
    -
    -

    -

    +

    +

    3.6 PDF display and information options

    -

    +

    - - +

    Set the startup page view

    + + +

    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

    - - +

    make PDF toolbar visible

    +

    set /ViewArea of viewer preferences

    +

    set /ViewClip of viewer preferences

    +

    Unicode encoded PDF strings

    +class="td11"> +class="td11"> +class="td11"> - +class="td11">
    baseurl URL URL -

    Sets the base URL of the PDF +

    Sets the base URL of the PDF document

    pdfpagemode text text empty -

    Determines how the file is opening in +

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

    pdftitle text text -

    Sets the document information Title +

    Sets the document information Title field

    pdfauthor text text -

    Sets the document information Author +

    Sets the document information Author field

    pdfsubject text text -

    Sets the document information Subject +

    Sets the document information Subject field

    pdfcreator text text -

    Sets the document information Creator +

    Sets the document information Creator field

    pdfproducer text text -

    Sets the document information +

    Sets the document information Producer field

    pdfkeywords text text -

    Sets the document information +

    Sets the document information Keywords field

    pdfview text text XYZ -

    Sets the default PDF ‘view’ for each +

    Sets the default PDF ‘view’ for each link

    pdfstartpage text text 1 -

    Determines on which page the PDF file +

    Determines on which page the PDF file is opened.

    pdfstartview text text Fit -

    Set the startup page view

    pdfpagescrop n n n n 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

    pdfcenterwindow boolean boolean false -

    position the document window in the +

    position the document window in the center of the screen

    pdfdirection text text empty -

    direction setting

    pdfdisplaydoctitle boolean boolean false -

    display document title instead of file +

    display document title instead of file name in title bar

    pdfduplex text text empty -

    paper handling option for print dialog

    pdffitwindow boolean boolean false -

    resize document window to fit +

    resize document window to fit document size

    pdflang text text empty -

    PDF language identifier (RFC 3066)

    pdfmenubar boolean boolean true -

    make PDF viewer’s menu bar visible

    pdfnewwindow boolean boolean false -

    make links that open another PDF file +

    make links that open another PDF file start a new window

    pdfnonfullscreenpagemode boolean boolean empty -

    page mode setting on exiting full-screen +

    page mode setting on exiting full-screen mode

    pdfnumcopies integer integer empty -

    number of printed copies

    pdfpagelayout text text empty -

    set layout of PDF pages

    pdfpagelabels boolean boolean true -

    set PDF page labels

    pdfpagetransition text text empty -

    set PDF page transition style

    pdfpicktrackbypdfsize text text empty -

    set option for print dialog

    pdfprintarea text text empty -

    set /PrintArea of viewer preferences

    pdfprintclip text text empty -

    set /PrintClip of viewer preferences

    pdfprintpagerange n n (n n)* n n (n n)* empty -

    set /PrintPageRange of viewer +

    set /PrintPageRange of viewer preferences

    pdfprintscaling text text empty -

    page scaling option for print dialog; +

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

    pdftoolbar boolean boolean true -

    make PDF toolbar visible

    pdfviewarea text text empty -

    set /ViewArea of viewer preferences

    pdfviewclip text text empty -

    set /ViewClip of viewer preferences

    pdfwindowui boolean boolean true -

    make PDF user interface elements +

    make PDF user interface elements visible

    unicode boolean 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 35. pdfT33. pdfTEX works by supplying default values for XYZ (horizontal vertical zoom) and × vertical × zoom) and FitBH. However, drivers using pdfmark do not supply defaults, so hyperref passes in a value of -32768, which causes Acr class="ec-lmtt-10">pdfview and pdfstartview parameters. -

    +

    +

    Fits the page to the window.

    +

    Fits the width of the page to the window.

    +

    Fits the height of the page to the window.

    +

    Fits the page bounding box to the window.

    +class="td11"> +class="td11"> +class="td11"> - +class="td11">
    XYZ left top zoom -

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

    Sets a coordinate and a zoom factor. If any one is null, the source link value is used. null null null will give the same values as the current page.

    Fit -

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

    +

    +

    Displays a single page; advancing flips the page

    +

    Displays the document in one column; continuous scrolling.

    +class="td11"> TwoPageLeft +class="td11"> TwoPageRight + + +class="td11"> + +
    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 +

    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.

    +

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

    +

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

    -

    Finally, the

    Finally, the pdfpagetransition can be one of the following values, where /Di stands for direction of motion in degrees, generally in 90 steps,  steps, /Dm is a horizontal (/H) or vertical (/V) dimension @@ -1841,9 +1852,9 @@ class="ec-lmtt-10">Blinds /Dm /V), and /M is for motion, either in (/I) or out (/O). -

    +

    +

    A box sweeps in or out.

    +

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

    +class="td11"> +class="td11"> +class="td11"> -
    Blinds /Dm /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 /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 /Di -

    Similar to Dissolve, except the effect sweeps across the +

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

    Split /Dm /M /Dm /M -

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

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

    +

    +

    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

    +

    do not do any hyperlinking

    - - +

    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

    +

    use letterpaper

    - +class="td11"> +

    color of border around links

    +

    color of links

    +

    color of border around menu links

    - - +

    color for menu links

    +

    allow nesting of links

    +

    put an anchor on every page

    +

    backreference by page number

    +

    text for PDF Author field

    +

    width of PDF link border

    +

    text for PDF Creator field

    +

    +

    +

    direction setting

    +

    paper handling option for print dialog

    - +class="td11"> +

    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

    +

    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

    +

    set /PrintClip of viewer preferences

    +

    page scaling option for print dialog

    - +class="td11"> +

    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

    +

    color of border around ‘run’ links + +

    +

    color of ‘run’ links

    +

    Unicode encoded pdf strings

    - +class="td11"> +

    color of border around URL links

    +

    color of URL links

    +

    be chatty

    +class="td11"> +class="td11"> +class="td11"> +class="td11"> - +class="td11">
    a4paper -

    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)

    debug false -

    provide details of anchors defined; same +

    provide details of anchors defined; same as verbose

    draft false -

    do not do any hyperlinking

    dvipdfm -

    use

    use dvipdfm backend

    dvipdfmx -

    use

    use dvipdfmx backend

    dvips -

    use

    use dvips backend

    dvipsone -

    use

    use dvipsone backend

    dviwindo -

    use

    use dviwindo backend

    encap -

    to set encap character for hyperindex

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

    use small caps instead of color for links

    hyperfigures false false -

    make figures hyper links

    hyperfootnotes true -

    set up hyperlinked footnotes

    hyperindex true -

    set up hyperlinked indices

    hypertex -

    use

    use HyperTEX backend

    hypertexnames true -

    use guessable names for links

    implicit true -

    redefine LAT

    redefine LATEX internals

    latex2html -

    use

    use LATEX2HTML backend

    legalpaper -

    use legalpaper

    letterpaper -

    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

    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 +

    position the document window in the center of the screen

    pdfcreator LaTeX with -

    text for PDF Creator field

    hyperref -

    package -

    pdfdirection 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

    pdfnonfullscreenpagemode 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

    pdfprintclip 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 pdfTEX backend

    pdftitle 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

    ps2pdf -

    use

    use ps2pdf backend

    raiselinks false -

    raise up links (for

    raise up links (for HyperTEX backend)

    runbordercolor 0 .7 .7 -

    color of border around ‘run’ links

    runcolor filecolor -

    color of ‘run’ links

    setpagesize true -

    set page size by special driver +

    set page size by special driver commands

    tex4ht -

    use

    use TEX4ht backend

    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

    xetex -

    use

    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

    +

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

    - - - \url{URL} -

    Similar to

    +

    \url{URL}
    +

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

    - \nolinkurl{URL} -

    Write

    +

    \nolinkurl{URL}
    +

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

    - \hyperbaseurl{URL} -

    A base

    +

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

    +

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

    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

    +

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

    +

    +
    \hyperref{URL}{category}{name}{text}
    +

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

    - \hyperref[label]{text} -

    +

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

    +

    +
    \hyperlink{name}{text}
    +

    +

    +
    \hypertarget{name}{text}
    +

    A simple internal link is created with \hypertarget, with two parameters of an anchor name, and anchor \hyperlink has two arguments, the name o \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

    +

    +
    \phantomsection
    +

    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 @@ -2983,28 +3058,31 @@ is set. Example:

    -
    +
    \cleardoublepage  
    \phantomsection  
    \addcontentsline{toc}{chapter}{\indexname}  
    \printindex
    -
    -

    -

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

    +

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

    - \autoref{label} -

    This is a replacement for the usual

    +

    \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

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

    For each macro below,

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

    +

    +> +

    Figure

    +

    Table

    +

    Part

    +

    Appendix

    +

    Equation

    +

    item

    +

    chapter

    +

    section

    - - +

    subsection

    +

    subsubsection

    +

    paragraph

    +

    footnote +

    +

    Equation

    +

    Theorem

    +

    page

    + style="vertical-align:baseline;" id="TBL-24-17-"> + style="vertical-align:baseline;" id="TBL-24-18-"> + style="vertical-align:baseline;" id="TBL-24-19-"> + style="vertical-align:baseline;" id="TBL-24-20-">
    Macro Macro -

    Default

    \figurename \figurename -

    Figure

    \tablename \tablename -

    Table

    \partname \partname -

    Part

    \appendixname \appendixname -

    Appendix

    \equationname \equationname -

    Equation

    \Itemname \Itemname -

    item

    \chaptername \chaptername -

    chapter

    \sectionname \sectionname -

    section

    \subsectionname \subsectionname -

    subsection

    \subsubsectionname \subsubsectionname -

    subsubsection

    \paragraphname \paragraphname -

    paragraph

    \Hfootnotename \Hfootnotename -

    footnote

    \AMSname \AMSname -

    Equation

    \theoremname \theoremname -

    Theorem

    \page \page -

    page

    -

    Example for a redefinition if

    Example for a redefinition if babel is used:

    -
    +
    \usepackage[ngerman]{babel}  
    \addto\extrasngerman{%  
      \def\subsectionautorefname{Unterkapitel}%  
    }
    -
    -

    -

    - \autopageref{label} -

    It replaces

    +

    +

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

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

    - \ref*{label} -

    - \pageref*{label} -

    - \autoref*{label} -

    - \autopageref*{label} -

    A typical use would be to write +

    +

    \ref*{label}
    +

    +

    +
    \pageref*{label}
    +

    +

    \autoref*{label}
    +

    +

    +
    \autopageref*{label}
    +

    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{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: @@ -3254,34 +3369,43 @@ class="ec-lmtt-10">\textbf, etc.

  • Support for \xspace provided by the xspace package
  • -

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

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

    +

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

    +

    +
    \texorpdfstring{TEXstring}{PDFstring}
    +

    For example, -
    +
    \section{Pythagoras:  
      \texorpdfstring{$ a^2 + b^2 = c^2 $}{%  
        a\texttwosuperior\ + b\texttwosuperior\ = @@ -3290,51 +3414,51 @@ class="verbatim">
     
    }  
    \section{\texorpdfstring{\textcolor{red}}{}{Red} Mars}
    -
    -

    -

    +

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

    -

    However, for disabling commands, an easier way is via

    +

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

    -

    +

    +

    4.2 Utility macros

    -

    - \hypercalcbp{dimen specification} -

    +

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

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

    -

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

    Note, for calculations you need either package |calc| or "-T

    +

    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 "-Tε-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, @@ -3371,262 +3492,366 @@ 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

    +

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

    +

    +> +

    ImportImage, ImportNotes, AcroForm:ImportFDF

    +

    ExportNotes, AcroForm:ExportFDF

    - - + + +

    Properties

    +

    AcroForm:Duplicate, AcroForm:TabOrder

    +

    About

    + style="vertical-align:baseline;" id="TBL-34-16-"> + style="vertical-align:baseline;" id="TBL-34-17-"> + style="vertical-align:baseline;" id="TBL-34-18-">
    File File -

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

    Open, Close, Scan, Save, SaveAs, Optimizer:SaveAsOpt, Print, PageSetup, Quit

    File!Import FileImport -

    ImportImage, ImportNotes, AcroForm:ImportFDF

    File!Export FileExport -

    ExportNotes, AcroForm:ExportFDF

    File!DocumentInfo FileDocumentInfo -

    GeneralInfo, OpenInfo, FontsInfo, SecurityInfo, +

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

    File!Preferences FilePreferences -

    GeneralPrefs, NotePrefs, FullScreenPrefs, Weblink:Prefs, +

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

    Edit 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 EditFields -

    AcroForm:Duplicate, AcroForm:TabOrder

    Document Document -

    Cpt:CapturePages, +

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

    View 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, ShowThumbs

    Tools 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

    Tools!Search ToolsSearch -

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

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

    Window Window -

    ShowHideToolBar, ShowHideMenuBar, +

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

    Help Help -

    HelpUserGuide, HelpTutorial, HelpExchange, HelpScan, +

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

    Help(Windows) 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}
    +

    -

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

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

    - \MakeTextField{width}{height} -

    - \MakeChoiceField{width}{height} -

    - \MakeButtonField{text} -

    These macros default to

    +
    \MakeChoiceField{width}{height}
    +

    +

    \MakeButtonField{text}
    +

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

    You may also want to redefine the following macros: +

    You may also want to redefine the following macros: -
    +
    \def\DefaultHeightofSubmit{12pt}  
    \def\DefaultWidthofSubmit{2cm}  
    \def\DefaultHeightofReset{12pt} @@ -3653,465 +3876,457 @@ class="verbatim">
     
    \def\DefaultHeightofTextMultiline{4\baselineskip}  
    \def\DefaultWidthofText{3cm}
    -
    -

    -

    +

    +

    6.1 Forms environment parameters

    -

    +

    +> + style="vertical-align:baseline;" id="TBL-49-4-"> + style="vertical-align:baseline;" id="TBL-49-5-"> + style="vertical-align:baseline;" id="TBL-49-6-"> + style="vertical-align:baseline;" id="TBL-49-7-">
    action URL action URL -

    The URL that will receive the form data if a

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

    encoding name encoding name -

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

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

    method name method 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) -

    +

    - - +> - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - + style="vertical-align:baseline;" id="TBL-50-22-"> + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - + style="vertical-align:baseline;" id="TBL-50-43-"> + + + + + + + +
    accesskey key (as per HTML)
    align number 0 alignment within text field; 0 is left-aligned,
    1 is centered, 2 is right-aligned.
    backgroundcolor color of box
    bordercolor color of border
    bordersep box border gap
    borderwidth width of box border
    calculate JavaScript code to calculate the value of the field
    charsize dimen font size of field text
    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
    ketstroke JavaScript code to control the keystrokes on entry
    maxlen number 0 number of characters allowed in text field
    menulength number 4 number of elements shown in list
    accesskey key (as per HTML)
    align number 0 alignment within text field; 0 is left-aligned,
    1 is centered, 2 is right-aligned.
    backgroundcolor color of box
    bordercolor color of border
    bordersep box border gap
    borderwidth width of box border
    calculate JavaScript code to calculate the value of the field
    charsize dimen font size of field text
    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
    ketstroke JavaScript code to control the keystrokes on entry
    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
    readonly boolean false field is readonly
    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
    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
    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
    -

    +

    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@@anchor\@gobble  
    \gdef\hyper@link##1##2##3{##3}%  
    \def\hyper@linkurl##1##2{##1}% @@ -4121,12 +4336,11 @@ class="verbatim">
     
    \let\hyper@linkstart\@gobbletwo  
    \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 (thorsten.ohl@physik.th-darmstadt.de). 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 +class="lmmi-10">ε 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. +versions because of problems they found. + -

    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 includ 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 @@ -4217,12 +4432,12 @@ class="ec-lmss-10">hyperref.

    10 GNU Free Documentation License

    -

    Version 1.2, November 2002 -
    +

    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 +class="lmsy-10">© 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.