summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/fixfoot/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-07-20 23:35:51 +0000
committerKarl Berry <karl@freefriends.org>2009-07-20 23:35:51 +0000
commitb6986fded02b44f860cce27463c9f5a70e7f6103 (patch)
tree54fab94fdd11b2a761bed834a1e0756ddc9bbb75 /Master/texmf-dist/doc/latex/fixfoot/README
parent046d8ea1784304bf8a1e2d4d635fd3a35b4eca3c (diff)
fixfoot update (20jul09)
git-svn-id: svn://tug.org/texlive/trunk@14354 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/fixfoot/README')
-rw-r--r--Master/texmf-dist/doc/latex/fixfoot/README38
1 files changed, 38 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/fixfoot/README b/Master/texmf-dist/doc/latex/fixfoot/README
new file mode 100644
index 00000000000..a9e5a2b22b4
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fixfoot/README
@@ -0,0 +1,38 @@
+Notes on fixfoot.sty
+
+This is an experimental package that provides fixed footnotes; only
+one instance of a fixed footnote will appear on any one page. (The
+package is "experimental" because it's lacking at least one obvious
+facility; no reports of problems in actual use have been received.)
+
+The package defines a single command, \DeclareFixedFootnote, which
+takes an optional *, and two `ordinary' arguments.
+
+If the optional * is present, the command declared has an \xspace
+command (from the xspace package) imbedded in it, so that spaces
+following the fixed footnote in running text tend not to be lost.
+
+The first ordinary argument is a command name.
+The second ordinary argument is the fixed text of the footnote.
+
+\DeclareFixedFootnote will then define the command to produce the
+footnote, or to a link to an existing copy of the fixed footnote on
+the same page.
+
+e.g., \DeclareFixedFootnote*{\sic}{\emph{sic}}
+ \DeclareFixedFootnote{\prooflater}{This theorem will be proved
+ later}
+
+The package works by exchanging information with itself via the .aux
+file. Just as with labels (and per-page footnote numbers in
+footmisc), the user ordinarily needs to run latex at least twice.
+
+The package does not (yet) have the ability to warn the user that
+another run of latex is still necessary. Some evidence of user demand
+would be necessary to encourage me to invest effort in getting LaTeX
+to give that warning.
+
+Robin Fairbairns
+afterthought, of 2009-07-20
+
+$Id: README,v 1.2 2009/07/20 12:45:45 rf10 Exp rf10 $