Debian Codegraph @

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

raw
1 <!-- -->
2
3 Source: footnotehyper.dtx (v1.1f 2025/11/15)
4 Author: Jean-Francois Burnol
5 Info: hyperref aware footnote.sty
6 License: LPPL 1.3c
7 Copyright (C) 2016-2021, 2025 Jean-Francois Burnol
8 <jfbu at free dot fr>.
9
10 ABSTRACT
11 ========
12
13 The `footnote` package by Mark Wooding (`1997/01/28` `1.13`)
14 allows to gather footnotes (`\begin{savenotes}`) and later insert
15 them (after `\end{savenotes}`) at the bottom of the page, even
16 if the intervening material consists of tabulars, minipages or
17 framed contents for example. One can also use the
18 `\savenotes/\spewnotes` syntax.
19
20 Also, `footnote.sty` provides a `footnote` environment which
21 allows to insert verbatim material.
22
23 Earlier releases of the present `footnotehyper` package added
24 patches for `hyperref` compatibility and some bugfixes, addressing
25 in particular the incompatibility with `color/xcolor`, and with
26 `babel-frenchb`, and also fixing the `footnote` environment with
27 optional argument `[NUM]`. Since `v0.99` all macros are defined
28 internally and the `footnote` package is not loaded at all.
29
30 The same user interface is kept. Since `v1.0` it is possible to
31 use `footnotehyper` also in absence of `hyperref` or when the latter is
32 loaded with its `hyperfootnotes=false` option. The order of loading of
33 `footnotehyper` and `hyperref` is inconsequential.
34
35 INSTALLATION
36 ============
37
38 The recommended way is to first extract the package (.sty)
39 and driver (.tex) files from footnotehyper.dtx via
40
41 tex footnotehyper.dtx
42
43 and then produce the documentation via
44
45 latex footnotehyper.tex (twice)
46 dvipdfmx footnotehyper.dvi
47
48 It is also possible to produce simultaneously the package
49 and the documentation via one of these two routes:
50
51 pdflatex footnotehyper.dtx (twice)
52
53 or
54
55 latex footnotehyper.dtx (twice)
56 dvips
57 ps2pdf
58
59 The method using the extracted file footnotehyper.tex produces
60 the smallest pdf file and is the officially preferred one as
61 it allows to set options in footnotehyper.tex to customize the
62 footnotehyper.pdf file:
63
64 - scrartcl class options (paper size, font size, ...)
65 - with or without source code,
66 - with dvipdfmx or with latex+dvips or pdflatex.
67
68 Installation:
69
70 footnotehyper.sty -> TDS:tex/latex/footnotehyper/footnotehyper.sty
71 footnotehyper.dtx -> TDS:source/latex/footnotehyper/footnotehyper.dtx
72 footnotehyper.pdf -> TDS:doc/latex/footnotehyper/footnotehyper.pdf
73 README.md -> TDS:doc/latex/footnotehyper/README.md
74
75 The other files may be discarded.
76
77 LICENSE
78 =======
79
80 This Work may be distributed and/or modified under the conditions
81 of the LaTeX Project Public License, version 1.3c. This version of
82 this license is in:
83
84 > <http://www.latex-project.org/lppl/lppl-1-3c.txt>
85
86 and the latest version of this license is in:
87
88 > <http://www.latex-project.org/lppl.txt>
89
90 Version 1.3 or later is part of all distributions of
91 LaTeX version 2005/12/01 or later.
92
93 The Author of this Work is:
94
95 - Jean-Francois Burnol `<jfbu at free dot fr>`
96
97 This Work consists of the main source file footnotehyper.dtx
98 and the derived files footnotehyper.sty, footnotehyper.tex,
99 footnotehyper.pdf, footnotehyper.dvi.