summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/footnotehyper/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-04-19 21:14:51 +0000
committerKarl Berry <karl@freefriends.org>2016-04-19 21:14:51 +0000
commitccf357defee0d406f6a8b7517b7bb0b4134ac6ba (patch)
treeb5c64630111d6984b3523aae85be846aed69582f /Master/texmf-dist/doc/latex/footnotehyper/README.md
parent17d52247f834d20bf2fdc87165784126b353446c (diff)
footnotehyper (19apr16)
git-svn-id: svn://tug.org/texlive/trunk@40620 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/footnotehyper/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/footnotehyper/README.md97
1 files changed, 97 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/footnotehyper/README.md b/Master/texmf-dist/doc/latex/footnotehyper/README.md
new file mode 100644
index 00000000000..d0207ec65fe
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/footnotehyper/README.md
@@ -0,0 +1,97 @@
+<!-- -->
+
+ Source: footnotehyper.dtx (v0.9a 2016/04/19)
+ Author: Jean-Francois Burnol
+ Info: hyperref aware footnote.sty
+ License: LPPL 1.3c or later
+ Copyright (C) 2016 Jean-Francois Burnol <jfbu at free dot fr>.
+
+ABSTRACT
+========
+
+The `footnote` package by Mark Wooding dates back to 1997 and has
+not been made `hyperref` compatible. The aim of the present
+package is to do that. It is barely tested and its state is what I
+found sufficiently well-working on a current LaTeX document of
+mine, I have not attempted any in-depth analysis of all possible
+situations. As version number is at `v0.9a`, there is room for
+incorporating suggestions until reaching final `v1.0`. I promise
+not to find a mathematical constant in-between and I will
+certainly not play the `999..9` game à la XeTeX.
+
+For those who don't know: the `footnote` package allows via
+`\savenotes` to gather footnotes and later release them via
+`\spewnotes`. Thus footnotes emitted from tabulars or minipages
+are not separated from the general document stream of footnotes,
+and are printed with the others at bottom of page. This works also
+for environments like `framed` (1) from the eponymous package and
+avoids the `\footnotemark/\footnotetext` approach, which anyhow is
+not immediately `hyperref` compatible. The `footnote` package has
+a facility to patch any user-chosen environment to do the
+`\savenotes/\spewnotes` automatically.
+
+This package provides no facility for handling footnotes from floating
+environments.
+
+It will load `footnote` but it is up to the user to take care of
+`hyperref`.
+
+(1): in case of multi-page content, the footnotes are delivered in
+the last page.
+
+INSTALLATION
+============
+
+To extract the package (.sty) and driver (.tex) files from
+footnotehyper.dtx:
+
+- if footnotehyper.ins is present: etex footnotehyper.ins
+- without footnotehyper.ins: etex footnotehyper.dtx
+- or run latex or pdflatex directly on footnotehyper.dtx
+
+At least three ways to produce footnotehyper.pdf (method (1) is
+preferred):
+
+1. latex footnotehyper.tex (thrice), then dvipdfmx
+2. pdflatex footnotehyper.dtx (thrice)
+3. latex footnotehyper.dtx (thrice), then dvips, then ps2pdf
+
+Method (1) produces the smallest pdf files.
+Options can be set in footnotehyper.tex:
+
+- scrdoc class options (paper size, font size, ...)
+- with or without source code,
+- with dvipdfmx or with latex+dvips or pdflatex.
+
+Installation:
+
+ footnotehyper.sty -> TDS:tex/latex/footnotehyper/footnotehyper.sty
+ footnotehyper.dtx -> TDS:source/latex/footnotehyper/footnotehyper.dtx
+ footnotehyper.pdf -> TDS:doc/latex/footnotehyper/footnotehyper.pdf
+ README.md -> TDS:doc/latex/footnotehyper/README.md
+
+The other files may be discarded.
+
+LICENSE
+=======
+
+This Work may be distributed and/or modified under the conditions
+of the LaTeX Project Public License, version 1.3c. This version of
+this license is in:
+
+> <http://www.latex-project.org/lppl/lppl-1-3c.txt>
+
+and the latest version of this license is in:
+
+> <http://www.latex-project.org/lppl.txt>
+
+Version 1.3 or later is part of all distributions of
+LaTeX version 2005/12/01 or later.
+
+The Author of this Work is:
+
+- Jean-Francois Burnol `<jfbu at free dot fr>`
+
+This Work consists of the main source file footnotehyper.dtx and the
+derived files footnotehyper.sty, footnotehyper.ins, footnotehyper.tex,
+footnotehyper.pdf, footnotehyper.dvi.