Debian Codegraph @

texmf-dist/doc/latex/hyperref/README.md

raw
1 # README for hyperref bundle
2
3 Version 2026-04-24 v7.01q
4
5 ## INTRODUCTION
6
7 This package is used to emend cross-referencing commands in LaTeX to
8 produce some sort of `\special` commands; there are backends for the
9 `\special` set defined for HyperTeX dvi processors, for embedded pdfmark
10 commands for processing by Acrobat Distiller (dvips and dvipsone), for
11 dviwindo, for pdfTeX, for dvipdfm, for TeX4ht, and for VTEX's pdf and HTML
12 backends.
13
14 Included are:
15
16 1. `hyperref` The main hyperlinking functionality.
17 2. `backref` a package by David Carlisle to provide links back from
18 bibliography to the main text; these are hypertext links after using
19 `hyperref`.
20 3. `nameref` a package to allow reference to the *names* of sections rather
21 than their numbers.
22
23 ## DOWNLOAD
24
25 `hyperref` is available on CTAN:https://ctan.org/pkg/hyperref
26
27 Also a ZIP file is provided that contains the files, already sorted
28 in a TDS tree:
29 CTAN:http://mirrors.ctan.org/install/macros/latex/contrib/hyperref.tds.zip
30
31 "CTAN:" means one of the 'Comprehensive TeX Archive Network'
32 nodes or one of its mirrors. This is explained in
33 https://texfaq.org/FAQ-archives
34
35 The main repository of hyperref is located at github
36 https://github.com/latex3/hyperref
37
38 ## INSTALLATION
39
40 The easiest is to use the package manager of the TeX System.
41
42 ### Installation with ZIP file in TDS format
43
44 The ZIP file [hyperref.tds.zip](http://mirrors.ctan.org/install/macros/latex/contrib/hyperref.tds.zip)
45 contains the files sorted in a TDS tree. Thus you can directly unpack the ZIP file
46 inside a TDS tree. (See [CTAN:tds.zip](https://ctan.org/pkg/tds) for an explanation of TDS.)
47 Example:
48
49 ```
50 cd /...somewhere.../texmf
51 unzip /...downloadpath.../hyperref.tds.zip
52 ```
53
54 Do not forget to refresh the file name database of this TDS tree.
55 Example for TeXLive:
56
57 ```
58 mktexlsr /...somewhere.../texmf
59 ```
60
61 ### Manual installation
62
63 1. Download the hyperref files from CTAN or the TUG server.
64 If necessary, unpack them.
65 2. Generate the package and driver files: `tex hyperref.ins`
66 3. Install the files `*.sty`, `*.def`, and `*.cfg` in your TDS tree:
67 `cp *.sty *.def *.cfg TDS:tex/latex/hyperref/`.
68 Replace `TDS:` by the prefix of your TDS tree (`texmf` directory).
69 The exception is `bmhydoc.sty`, it belongs to the source files
70 (`TDS:source/latex/hyperref/`).
71 4. Copy the documentation files to "`TDS:doc/latex/hyperref/`":
72 hyperref-doc.pdf, README.md, ChangeLog.txt,
73 slides.pdf, paper.pdf, hyperref.pdf, backref.pdf,
74 nameref.pdf (Also the HTML version of the manual can be put there).
75 5. Update the databases if necessary, eg. for TeXLive:
76 `mktexlsr .../texmf`
77
78 ## AUTHORS/MAINTAINERS
79
80 * Sebastian Rahtz (died 2016)
81 * Heiko Oberdiek (inactive)
82 * The LaTeX Project
83
84 ## LICENSE
85
86 LATEX Project Public License, version 1.3c or later.
87
88 ## BUG REPORTS
89
90 A bug report should contain:
91
92 * Comprehensive problem description. This includes error or
93 warning messages.
94 * `\errorcontextlines=\maxdimen` can be added in the TeX code
95 to get more information in TeX error messages.
96 * Minimal test file that shows the problem, but does not
97 contain any unnecessary packages and code.
98 * Used drivers/programs.
99 * Version information about used packages and programs.
100 * If you are using LaTeX, then add "`\listfiles`". Then
101 a list of version information is printed at the end
102 of the LaTeX run.
103 * Please no other files than the minimal test file.
104 The other files .log, .dvi, .ps, .pdf are seldom necessary,
105 so send them only on request.
106
107 ## Bug address
108
109 A bug tracker is available at github:
110 https://github.com/latex3/hyperref/issues
111
112 ## Vietnamese part
113
114 Responsible for the Vietnamese translations of the
115 \autoref names and puvnenc.def are:
116
117 - Han The Thanh `<hanthethanh [at] gmail [dot] com>`
118 - Reinhard Kotucha `<reinhard [dot] kotucha at web [dot] de>`
119
120 ## Arabic part
121
122 Responsible for the additions to PU encoding for Arabi is
123 Youssef Jabri `<yjabri [at] ensa [dot] univ-oujda [dot] ac [dot] ma>`
124
125 ## KNOWN PROBLEMS
126
127 * (half-done) hyper images (link from thumbnail in text)
128 * Relative links are not sorted out or documented well.
129 For PDF generation:
130 * With baseurl: all links are considered relative to this URL.
131 * Without baseurl: a relative link without "file:" can be
132 achieved by:
133 ```
134 \begingroup
135 \hypersetup{linkfileprefix={}}%
136 \href{../foo/bar.html}{bar.html}
137 \endgroup
138 ```
139 * ...