summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/hyperref/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2007-11-05 00:06:38 +0000
committerKarl Berry <karl@freefriends.org>2007-11-05 00:06:38 +0000
commit5b3df0d3745a0955e550d4103228cf8d52a73241 (patch)
treee9c84d96e4bf295935da473aada238ac0b164cae /Master/texmf-dist/doc/latex/hyperref/README
parent78bd6b24f3c38ea9be1371b6180fa90b76221e21 (diff)
hyperref update (3nov07)
git-svn-id: svn://tug.org/texlive/trunk@5345 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/hyperref/README')
-rw-r--r--Master/texmf-dist/doc/latex/hyperref/README205
1 files changed, 183 insertions, 22 deletions
diff --git a/Master/texmf-dist/doc/latex/hyperref/README b/Master/texmf-dist/doc/latex/hyperref/README
index 090d8c39286..cb09d340841 100644
--- a/Master/texmf-dist/doc/latex/hyperref/README
+++ b/Master/texmf-dist/doc/latex/hyperref/README
@@ -1,4 +1,4 @@
-README for hyperref bundle, 2007/05/31
+README for hyperref bundle, 2007/11/02
TABLE OF CONTENTS
@@ -121,25 +121,180 @@ f) Update the databases if necessary, eg. for teTeX:
4 ADDITIONAL PACKAGES
=====================
-Depending on the driver, hyperref loads other packages
-apart from nameref and backref:
-* url.sty
- CTAN:macros/latex/contrib/other/misc/url.sty
-* keyval.sty, color.sty:
+Depending on the driver and option settings, hyperref loads
+other packages apart from nameref and backref:
+* atbegshi.sty:
+ CTAN:macros/latex/contrib/oberdiek/atbegshi.pdf
+* backref.sty (loaded by option `backref' or `pagebackref'):
+ CTAN:macros/latex/contrib/hyperref/backref.dtx
+* bigintcalc.sty (loaded by package `bitset'):
+ CTAN:macros/latex/contrib/oberdiek/bigintcalc.pdf
+* bitset.sty:
+ CTAN:macros/latex/contrib/oberdiek/bitset.pdf
+* color.sty (loaded by option `colorlinks'):
+ CTAN:macros/latex/required/graphics/
+* etexcmds.sty:
+ CTAN:macros/latex/contrib/oberdiek/etexcmds.pdf
+* hycolor.sty:
+ CTAN:macros/latex/contrib/oberdiek/hycolor.pdf
+* infwarerr.sty (loaded by packages `etexcmds', `stringenc',
+ `atbegshi', `bitset'):
+ CTAN:macros/latex/contrib/oberdiek/infwarerr.pdf
+* ifpdf.sty (loaded by package `atbegshi'):
+ CTAN:macros/latex/contrib/oberdiek/atbegshi.pdf
+* intcalc.sty (loaded by package `bitset'):
+ CTAN:macros/latex/contrib/oberdiek/intcalc.pdf
+* keyval.sty
CTAN:macros/latex/required/graphics/
-* pdftex.def:
- CTAN:macros/pdftex/graphics/pdftex.def
-* kvoptions.def:
+* kvoptions.sty:
CTAN:macros/latex/contrib/oberdiek/kvoptions.pdf
-* refcount.sty (loaded by nameref)
+* kvsetkeys.sty:
+ CTAN:macros/latex/contrib/oberdiek/kvsetkeys.pdf
+* memhfixc.sty (loaded if class `memoir' is loaded):
+ CTAN:macros/latex/contrib/memoir/memhfixc.sty
+* nameref.sty:
+ CTAN:macros/latex/contrib/hyperref/nameref.dtx
+* pdfescape.sty (loaded by package `stringenc'):
+ CTAN:macros/latex/contrib/oberdiek/pdfescape.pdf
+* refcount.sty (loaded by package `nameref')
CTAN:macros/latex/contrib/oberdiek/refcount.pdf
+* stringenc.sty:
+ CTAN:macros/latex/contrib/oberdiek/stringenc.pdf
+* tex4ht.sty (loaded by option `tex4ht'):
+ CTAN:support/TeX4ht/
+* url.sty
+ CTAN:macros/latex/contrib/other/misc/url.sty
+* vtexhtml.sty (loaded if VTeX is used in HTML mode)
5 NEW FEATURES
==============
-Option pdfencoding
-------------------
+Option `pdfnewwindow' changed
+-------`------------'--------
+ Before 6.77b:
+ * pdfnewwindow=true --> /NewWindow true
+ * pdfnewwindow=false --> (absent)
+ * unused pdfnewwindow --> (absent)
+ Since 6.77b:
+ * pdfnewwindow=true --> /NewWindow true
+ * pdfnewwindow=false --> /NewWindow false
+ * pdfnewwindow={} --> (absent)
+ * unused pdfnewwindow --> (absent)
+
+ Rationale: There is a difference between setting to `false'
+ and an absent entry. In the former case the new document
+ replaces the old one, in the latter case the PDF viewer
+ application should respect the user preference.
+
+Flag options for PDF forms
+--------------------------
+ PDF form field macros (\TextField, \CheckBox, ...) support
+ boolean flag options. The option name is the lowercase
+ version of the names in the PDF specification (1.7):
+ http://www.adobe.com/devnet/pdf/pdf_reference.html
+ http://www.adobe.com/devnet/acrobat/pdfs/pdf_reference.pdf
+ Options (convert to lowercase) except flags in square brackets:
+ * Table 8.16 Annotation flags (page 608):
+ 1 Invisible
+ 2 Hidden (PDF 1.2)
+ 3 Print (PDF 1.2)
+ 4 NoZoom (PDF 1.3)
+ 5 NoRotate (PDF 1.3)
+ 6 NoView (PDF 1.3)
+ [7 ReadOnly (PDF 1.3)] ignored for widget annotations, see table 8.70
+ 8 Locked (PDF 1.4)
+ 9 ToggleNoView (PDF 1.5)
+ 10 LockedContents (PDF 1.7)
+ * Table 8.70 Field flags common to all field types (page 676):
+ 1 ReadOnly
+ 2 Required
+ 3 NoExport
+ * Table 8.75 Field flags specific to button fields (page 686):
+ 15 NoToggleToOff (Radio buttons only)
+ 16 Radio (set: radio buttons, clear: check box, pushbutton: clear)
+ 17 Pushbutton
+ 26 RadiosInUniso (PDF 1.5)
+ * Table 8.77 Field flags specific to text fields (page 691):
+ 13 Multiline
+ 14 Password
+ 21 FileSelect (PDF 1.4)
+ 23 DoNotSpellCheck (PDF 1.4)
+ 24 DoNotScroll (PDF 1.4)
+ 25 Comb (PDF 1.5)
+ 26 RichText (PDF 1.5)
+ * Table 8.79 Field flags specific to choice fields (page 693):
+ 18 Combo (set: combo box, clear: list box)
+ 19 Edit (only useful if Combo is set)
+ 20 (Sort) for authoring tools, not PDF viewers
+ 22 MultiSelect (PDF 1.4)
+ 23 DoNotSpellCheck (PDF 1.4) (only useful if Combo and Edit are set)
+ 27 CommitOnSelChange (PDF 1.5)
+ * Table 8.86 Flags for submit-form actions (page 704):
+ [1 Include/Exclude] unsupported, use `noexport' (table 8.70) instead
+ 2 IncludeNoValueFields
+ [3 ExportFormat] handled by option `export'
+ 4 GetMethod
+ 5 SubmitCoordinates
+ [6 XFDF (PDF 1.4)] handled by option `export'
+ 7 IncludeAppendSaves (PDF 1.4)
+ 8 IncludeAnnotations (PDF 1.4)
+ [9 SubmitPDF (PDF 1.4)] handled by option `export'
+ 10 CanonicalFormat (PDF 1.4)
+ 11 ExclNonUserAnnots (PDF 1.4)
+ 12 ExclFKey (PDF 1.4)
+ 14 EmbedForm (PDF 1.5)
+
+ New option `export' sets the export format of a submit action.
+ Valid values are (upper- or lowercase):
+ * FDF
+ * HTML
+ * XFDF
+ * PDF (not supported by Acrobat Reader)
+
+Option `pdfversion'
+-------`----------'
+ This is an experimental option. It notifies `hyperref' about
+ the intended PDF version. Currently this is used in code for
+ PDF forms (implementation notes 116 and 122 of PDF spec 1.7).
+
+ Values: 1.2, 1.3, 1.4, 1.5, 1.6, 1.7. Values below 1.2 are not
+ supported, because most drivers expect higher PDF versions.
+
+ The option must be used early, not after \usepackage{hyperref}.
+
+ In theory this option should also set the PDF version,
+ but this is not generally supported.
+ * pdfTeX below 1.10a: unsupported.
+ pdfTeX >= 1.10a and < 1.30: \pdfoptionpdfminorversion
+ pdfTeX >= 1.30: \pdfminorversion
+ * dvipdfm: configuration file, example:
+ TeX Live 2007, texmf/dvipdfm/config/config, entry `V 2'.
+ * dvipdfmx: configuration file, example:
+ TeX Live 2007, texmf/dvipdfm/dvipdfmx.cfg, entry `V 4'.
+ * Ghostscript: option -dCompatibilityLevel (this is set in
+ `ps2pdf12', `ps2pdf13', `ps2pdf14').
+
+ The current PDF version is used as default if this version
+ can be detected (only pdfTeX >= 1.10a). Otherwise the lowest
+ version 1.2 is assumed. Thus `hyperref' tries to avoid PDF code
+ that breaks this version, but is free to use ignorable higher PDF
+ features.
+
+Field option `name'
+-------------`----'
+ Many form objects uses the label argument
+ for several purposes:
+ * Layouted label.
+ * As name in HTML structures.
+ Code that is suitable for layouting with TeX can
+ break in the structures of the output format.
+ If option `name' is given, then its value is used
+ as name in the different output structures. Thus
+ the value should consist of letters only.
+
+Option `pdfencoding'
+-------`-----------'
The PDF format allows two encodings for bookmarks and entries
in the information dictionary: PDFDocEncoding and Unicode
as UTF-16BE. Option "pdfencoding" selects between these encodings:
@@ -409,9 +564,9 @@ arydshln, longtable
babel/magyar.ldf
----------------
- Unsupported.
- magyar.ldf's redefinitions of many LaTeX internals conflict
- with hyperref's redefinitions of these commands.
+ The old version 2005/03/30 v1.4j will not work.
+ You need at least version 1.5, maintained by P\'eter Szab\'o,
+ see CTAN:language/hungarian/babel/.
bibentry
--------
@@ -485,18 +640,24 @@ float
foiltex
-------
- Version 2002/10/29 v2.1.4a forgets adding \HyPL@EveryPage to
- the code that is executed each page. This sabotages the page
- labels (option pdfpagelabels) and a rerun warning can be shown
- (depends on the used driver).
+ Since version 6.77a hyperref does not hack into \@begindvi,
+ it uses package `atbegshi' instead, that hooks into \shipout.
+ Thus the patch of `foils.cls' regarding hyperref is now obsolete
+ and causes an undefined error message about \@hyperfixhead.
Workaround:
+ \makeatletter
+ \providecommand*{\@hyperfixhead}{}
+ \makeatother
+ If you don't want to have page anchors (page anchors are the default),
+ then \HyPL@EveryPage gets executed twice on each page, this can be
+ avoided by disabling page anchors later:
\documentclass{foils}
\usepackage{hyperref}
\makeatletter
- \ifHy@pageanchor
- \g@addto@macro\@hyperfixhead{\HyPL@EveryPage}%
- \fi
+ \providecommand*{\@hyperfixhead}{}
\makeatother
+ \begin{document}
+ \hypersetup{pageanchor=false}
footnote
--------