summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/bigfoot/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2006-01-09 00:44:40 +0000
committerKarl Berry <karl@freefriends.org>2006-01-09 00:44:40 +0000
commitb4fc5f639874db951177ec539299d20908adb654 (patch)
tree52f08823ca58fffe3db6a9b075635038c567626c /Master/texmf-dist/doc/latex/bigfoot/README
parentdec3d98ebe442d7ea93efbaa8dd2e2be8149a467 (diff)
doc 4
git-svn-id: svn://tug.org/texlive/trunk@80 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/bigfoot/README')
-rw-r--r--Master/texmf-dist/doc/latex/bigfoot/README56
1 files changed, 56 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/bigfoot/README b/Master/texmf-dist/doc/latex/bigfoot/README
new file mode 100644
index 00000000000..68f78063c14
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bigfoot/README
@@ -0,0 +1,56 @@
+This is the bigfoot bundle for critical edition typesetting and other
+concerns, written by David Kastrup (mailto:dak@gnu.org). The complete
+package in development can be accessed using the CVS instructions at
+<URL:http://sarovar.org/projects/bigfoot>, and
+CTAN:/macros/latex/contrib/bigfoot should provide released versions
+once they are fit for general consumption.
+
+The whole bundle is released under the GPL version 2 (or later). Part
+of the work has been sponsored or commissioned by various parties
+(including TUG), but further functionality and development depends on
+your support, financially or by participation. The author has a
+Paypal account which you might consider contributing to.
+
+All of the files (except perpage.sty, for historical reasons) need
+eTeX 2 as the LaTeX engine. Newer distributions already are
+eTeX-based; with older distributions you might need to use the
+`elatex' command.
+
+File descriptions for available files:
+
+suffix.ins: This is a generated file and not in the CVS archive (but
+ on CTAN). If you need to generate it, you can do so by running
+ `tex docstrip' and answering the prompts
+
+ \infileext=dtx
+ \outfileext=ins
+ \Options=installer
+ \filelist=suffix
+
+ Running TeX on suffix.ins will generate further files from
+ `suffix.dtx'.
+
+suffix.dtx: This is the doc source for `suffix.sty', a package that
+ makes it very easy to define command variants like \macro* or
+ \macro\!. It is included in the critical bundle since typical
+ document classes for real critical editions documents will tend to
+ want weird signs under handy abbreviations, like \< and \<<, or
+ \=>, or things like \footnote' macros, or \footnote<...\footnote>
+ with different formatting/numbering and so on.
+
+perpage.sty: Work in progress, CVS only. Used for keeping counters
+ sorted in order of page appearance and making numbering per page
+ possible.
+
+bigfoot.sty: Work in progress, CVS only. Used for solving every
+ problem around footnotes and then some. Deals with nested
+ footnotes in several apparatus, uses a backtracking algorithm for
+ finding the optimal break across several footnotes, automatically
+ breaks in-paragraph style footnotes across pages, uses fuzzy logic
+ for deciding about when to prefer in-paragraph layout to
+ one-footnote-per-paragraph layout on a per-note and per-block
+ basis, deals with colors in footnotes even when broken across
+ pages, adapts the document class's footnote style to in-paragraph
+ footnotes as good as it can, allows customization of styles
+ differing across footnote blocks, allows verbatim text in
+ footnotes and so on.