diff options
author | Karl Berry <karl@freefriends.org> | 2011-11-03 18:20:24 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2011-11-03 18:20:24 +0000 |
commit | 101b8dbc25eea15d8e82c6a3aa17c1fcea572759 (patch) | |
tree | 8a227d2794f0f9367ae184c6f1f33c64fc34cc5e /Master/texmf-dist/doc/latex/tablefootnote | |
parent | 2b46076210d9d0b7ffec3cd884329f5ea6b86bb1 (diff) |
new latex package tablefootnote (29oct11)
git-svn-id: svn://tug.org/texlive/trunk@24478 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tablefootnote')
-rw-r--r-- | Master/texmf-dist/doc/latex/tablefootnote/README | 172 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/tablefootnote/tablefootnote-example.pdf | bin | 0 -> 117430 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/tablefootnote/tablefootnote-example.tex | 195 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/tablefootnote/tablefootnote.pdf | bin | 0 -> 307897 bytes |
4 files changed, 367 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! diff --git a/Master/texmf-dist/doc/latex/tablefootnote/tablefootnote-example.pdf b/Master/texmf-dist/doc/latex/tablefootnote/tablefootnote-example.pdf Binary files differnew file mode 100644 index 00000000000..4b248bf04ed --- /dev/null +++ b/Master/texmf-dist/doc/latex/tablefootnote/tablefootnote-example.pdf diff --git a/Master/texmf-dist/doc/latex/tablefootnote/tablefootnote-example.tex b/Master/texmf-dist/doc/latex/tablefootnote/tablefootnote-example.tex new file mode 100644 index 00000000000..b615d86c85f --- /dev/null +++ b/Master/texmf-dist/doc/latex/tablefootnote/tablefootnote-example.tex @@ -0,0 +1,195 @@ +%% +%% This is file `tablefootnote-example.tex', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% tablefootnote.dtx (with options: `example') +%% +%% This is a generated file. +%% +%% Project: tablefootnote +%% Version: 2011/10/29 v1.0b +%% +%% Copyright (C) 2011 by +%% H.-Martin M"unch <Martin dot Muench at Uni-Bonn dot de> +%% +%% The usual disclaimer applys: +%% If it doesn't work right that's your problem. +%% (Nevertheless, send an e-mail to the maintainer +%% when you find an error in this package.) +%% +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either +%% version 1.3c of this license or (at your option) any later +%% version. 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 +%% and version 1.3c or later is part of all distributions of +%% LaTeX version 2005/12/01 or later. +%% +%% This work has the LPPL maintenance status "maintained". +%% +%% The Current Maintainer of this work is H.-Martin Muench. +%% +%% This work consists of the main source file tablefootnote.dtx, +%% the README, and the derived files +%% tablefootnote.sty, tablefootnote.pdf, +%% tablefootnote.ins, tablefootnote.drv, +%% tablefootnote-example.tex, tablefootnote-example.pdf. +%% +\documentclass[british]{article}[2007/10/19]% v1.4h +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\usepackage{float}[2001/11/08]% v1.3d +\usepackage{placeins}[2005/04/18]% v2.2 ; for \FloatBarrier + +\usepackage{rotating}[2009/03/28]% v2.16a; for sidewaystable-environment + +\usepackage{tablefootnote}[2011/10/29]% v1.0b + +\usepackage[% + extension=pdf,% + plainpages=false,% + pdfpagelabels=true,% + hyperindex=false,% + pdflang={en},% + pdftitle={tablefootnote package example},% + pdfauthor={Hans-Martin Muench},% + pdfsubject={Example for the tablefootnote package},% + pdfkeywords={LaTeX, tablefootnote, footnote, table, Hans-Martin Muench},% + % pdfview=FitH and FitBH do not work: hyperlinks in sidewaystables + % aim at the end of the document, not at the footnote + % pdfview=Fit, FitV, FitR, FitB, FitBV work + % print is OK for all those options + pdfstartview=FitH,% + pdfpagelayout=OneColumn% +]{hyperref}[2011/10/01]% v6.82j + +\gdef\unit#1{\mathord{\thinspace\mathrm{#1}}}% +\listfiles +\begin{document} +\pagenumbering{arabic} +\section*{Example for tablefootnote} + +This example demonstrates the use of package\newline +\textsf{tablefootnote}, v1.0b as of 2011/10/29 (HMM).\newline +There were no options used. (The package provides no options.)\newline + +\textbf{The \texttt{tablefootnote-example.tex} needs to be compiled +at least twice to get the references right!}\newline + +If the etoolbox-package is found, it is automatically used.\newline + +For more details please see the documentation!\newline + +\noindent Save per page about $200\unit{ml}$ water, +$2\unit{g}$ CO$_{2}$ and $2\unit{g}$ wood:\newline +Therefore please print only if this is really necessary.\newline + +Here is some text.\footnote{And this is a text footnote.}\newline + +Tables \ref{tab.first}, \ref{tab.another} and \ref{tab.floatH} show +normal tables, table~\ref{tab.sideways} depicts a sidewaystable. +Table~\ref{tab.floatH} uses the float specifier~\texttt{H} from the +float package.\newline + +\texttt{Hyperref} option \verb|pdfview=FitH| and \verb|FitBH| do +not work: hyperlinks in sidewaystables aim at the end of the document, +not at the footnote. \verb|pdfview=Fit|, \verb|FitV|, \verb|FitR|, +\verb|FitB|, \verb|FitBV| work, print is OK for all those options. + +\bigskip + +\listoftables + +\pagebreak + +\begin{table} +\centering +\begin{tabular}{ccc} +Some\tablefootnote{A table footnote.} & % +text\tablefootnote{Another table footnote.} & % +in a table\tablefootnote{A third table footnote.} +\end{tabular} +\caption[A table]{A first table\label{tab.first}} +\end{table} + +Some text.\footnote{Another text footnote.} + +\pagebreak + +More text.\footnote{And yet another text footnote.} + +\begin{table}[t] +\centering +\begin{tabular}{|c|c|c|} +\hline +Another\tablefootnote{A $2^{nd}$ table footnote.} & % +text\tablefootnote{Another $2^{nd}$ table footnote.} & % +in a table\tablefootnote{A $2^{nd}$ third table footnote.}\\ \hline +\end{tabular} +\caption[Another table]{Another table (second one)\label{tab.another}} +\end{table} + +Please note that the table floated to the top of the page. While the +footnotes are set and (when hyperref is used) hyperlinked, they are +not automatically adapted. Thus either do not use a footnote at the +same page before the table, or place the table in +\textquotedblleft here\textquotedblright\ or +\textquotedblleft bottom\textquotedblright\ position. +\verb|\clear(double)page|, \verb|h(!)|, \verb|H|~from the +\texttt{float} package, or \verb|\FloatBarrier| from the +\texttt{picins} package might help, too. (Or move the table in the +source code near the position where it floats to.) + +Table~\ref{tab.floatH} (page~\pageref{tab.floatH}) uses float specifier +\texttt{H} from the float package and does not float. + +Some text.\footnote{This is just another text footnote.} + +\pagebreak + +\FloatBarrier + +\begin{sidewaystable} +\centering% +\begin{tabular}{ccc} +Text\tablefootnote{Rotate view for testing the hyperlinks.} & % +in a\tablefootnote{Another sidewaystable footnote.} & % +sidewaystable% +\tablefootnote{Sidewaystable-environment provided by % +\url{http://CTAN.org/pkg/rotating} package.} +\end{tabular} +\caption[A sideways table]{A table in the \texttt{sideways} % +environment\label{tab.sideways}}% +\end{sidewaystable}% + +\FloatBarrier + +\pagebreak + +A last table, here with float specifier \texttt{H} from the +float\footnote{\url{http://CTAN.org/pkg/float}} package. + +\begin{table}[H] +\centering +\begin{tabular}{ccc} +Another\tablefootnote{A $4^{th}$ table footnote.} & % +text\tablefootnote{Another $4^{th}$ table footnote.} & % +in a table\tablefootnote{A $4^{th}$ third table footnote.} +\end{tabular} +\caption[A last table]{A very last table\label{tab.floatH}} +\end{table} + +Some text.\footnote{This is just another text footnote.} + +\pagebreak + +End of the example for the +tablefootnote\footnote{\url{http://CTAN.org/pkg/tablefootnote}} package. + +\end{document} +\endinput +%% +%% End of file `tablefootnote-example.tex'. diff --git a/Master/texmf-dist/doc/latex/tablefootnote/tablefootnote.pdf b/Master/texmf-dist/doc/latex/tablefootnote/tablefootnote.pdf Binary files differnew file mode 100644 index 00000000000..48a3efd0969 --- /dev/null +++ b/Master/texmf-dist/doc/latex/tablefootnote/tablefootnote.pdf |