diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/tablefootnote/README')
-rw-r--r-- | Master/texmf-dist/doc/latex/tablefootnote/README | 172 |
1 files changed, 172 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/tablefootnote/README b/Master/texmf-dist/doc/latex/tablefootnote/README new file mode 100644 index 00000000000..f6dc5566227 --- /dev/null +++ b/Master/texmf-dist/doc/latex/tablefootnote/README @@ -0,0 +1,172 @@ +README for tablefootnote package, 2011/10/29, v1.0b + + +TABLE OF CONTENTS +================= + +1 Introduction +2 Download +3 Installation +4 Additional Packages +5 Package Compatibility +6 Author/Maintainer +7 Bug Reports +8 Known Problems + + +1 INTRODUCTION +============== + +This LaTeX package provides the command \tablefootnote{...} +to be used in a table or sidewaystable environment. +In those environments \footnote{...} would not work and +would need to be replaced by \footnotemark in the +(sideways)table and \footnotetext{...} after the +(sideways)table environment ended. Additionally the counters +for footnote and (when the hyperref package is used) +Hfootnote would need to be adjusted manually. +(Even more changes would be needed in a sidewaystable.) +Just using \tablefootnote{...} in the (sideways)table does +all this automatically. +This material is subject to the LaTeX Project Public License +(LPPL). See http://www.ctan.org/tex-archive/help/Catalogue/ +licenses.lppl.html for the details of that license. + + +2 DOWNLOAD +========== + +`tablefootnote' is available on CTAN: + CTAN:macros/latex/contrib/tablefootnote/ + +Running +tex tablefootnote.dtx +generats the files +tablefootnote.ins tablefootnote.drv tablefootnote.sty +and tablefootnote-example.tex. + +Also a ZIP file is provided that contains these files, +the manual (tablefootnote.pdf), the compiled example, +(tablefootnote-example.pdf), and this README, already +sorted in a TDS tree: + CTAN:install/macros/latex/contrib/tablefootnote.tds.zip + +`CTAN:' means one of the `Comprehensive TeX Archive Network' +nodes or one of its mirrors. This is explained in + http://www.tex.ac.uk/cgi-bin/texfaq2html?label=archives + +The CTAN stuff will be mirrored automatically from the +ftp server, so + ftp://ftp.tug.org/pub/tex/tablefootnote/ +corresponds to + CTAN:macros/latex/contrib/tablefootnote/ + + +3 INSTALLATION +============== + +Installation with ZIP file in TDS format +---------------------------------------- +The ZIP file `tablefootnote.tds.zip' contains the files +sorted in a TDS tree. Thus you can directly unpack the +ZIP file inside a TDS tree. +(See CTAN:tds.zip for an explanation of TDS.) +Example: + cd /...somewhere.../texmf + unzip /...downloadpath.../tablefootnote.tds.zip +Do not forget to refresh the file name database of this +TDS tree. +Example: + texhash /...somewhere.../texmf + +Manual installation +------------------- +a) Download the tablefootnote files from CTAN. + If necessary, unpack them. +b) Generate the package and driver files: + tex tablefootnote.dtx +c) Install the file `*.sty' in your TDS tree: + cp *.sty TDS:tex/latex/tablefootnote/ + Replace `TDS:' by the prefix of your TDS tree + (texmf directory). +d) Copy the documentation files to + "TDS:doc/latex/tablefootnote/": + README, tablefootnote.pdf, tablefootnote-example.tex, + tablefootnote-example.pdf. +e) Update the databases if necessary, e.g. for teTeX: + mktexlsr .../texmf + + +4 ADDITIONAL PACKAGES +===================== + +tablefootnote loads other packages: +* ltxcmds, http://ctan.org/pkg/ltxcmds +When the rotating package is used (for its sidewaystable +environment; http://ctan.org/pkg/rotating) also these +packages are loaded: + - amstext, http://ctan.org/pkg/amstext + - setspace, http://ctan.org/pkg/setspace + - subcaption, http://ctan.org/pkg/subcaption +which again load other packages +(see the result of the \listfiles command in the log-file + of the example). + + +5 PACKAGE COMPATIBILITY +======================= + +Pages with tables with footnotes, which are rotated with the +(pdf)lscape-package, will break the hyperlinks to the +table-footnotes on that page. +Using the hyperref-option pdfview=FitH or FitBH makes the +hyperlinks of footnotes in sidewaystables aim at the end of +the document(printed version is OK). + + +6 AUTHOR/MAINTAINER +===================== + +* Hans-Martin Münch + + +7 BUG REPORTS +============== + +A bug report should contain: +* Comprehensive problem description. This includes error or + warning messages. + * \errorcontextlines=\maxdimen can be added in the + TeX code to get more information in TeX error messages. +* Minimal test file that shows the problem, but does not + contain any unnecessary packages and code. +* Used drivers/programs. +* Version information about used packages and programs. + * If you are using LaTeX, then add "\listfiles". Then + a list of version information is printed at the end + of the LaTeX run. +* Please no other files than the minimal test file. + The other files .log, .dvi, .ps, .pdf are seldom + necessary, so send them only on request. +* Please .zip or .tar.gz your file(s) before sending them! + +Bug address +----------- +Bug reports can be send to the maintainer: + Hans-Martin Münch + <Martin [dot] Muench [at] Uni-Bonn [dot] de> + + +8 KNOWN PROBLEMS +================= + +Pages with tables with footnotes, which are rotated with the +(pdf)lscape-package, will break the hyperlinks to the +table-footnotes on that page. +Using the hyperref-option pdfview=FitH or FitBH makes the +hyperlinks of footnotes in sidewaystables aim at the end of +the document(printed version is OK). +When a table with (table)footnotes floates to another place, +its footnotenumbers are not automatically adapted. + +Ideas for solutions welcome! |