summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-03-07 17:10:40 +0000
committerKarl Berry <karl@freefriends.org>2010-03-07 17:10:40 +0000
commit85df4257f923d7f041db739f71bb254a01a22a4d (patch)
tree52173d351f93f0091665df3243dedf9a4ff4f63c
parent9cff31734d1fc187de0e21d954f0c89bd6796f00 (diff)
threeparttable doc update (6mar10)
git-svn-id: svn://tug.org/texlive/trunk@17366 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r--Master/texmf-dist/doc/latex/threeparttable/miscdoc.sty111
-rw-r--r--Master/texmf-dist/doc/latex/threeparttable/threeparttable.pdfbin0 -> 285420 bytes
-rw-r--r--Master/texmf-dist/doc/latex/threeparttable/threeparttable.tex110
-rw-r--r--Master/texmf-dist/tex/latex/threeparttable/threeparttable.sty (renamed from Master/texmf-dist/tex/latex/ltxmisc/threeparttable.sty)0
-rwxr-xr-xMaster/tlpkg/bin/tlpkg-ctan-check2
-rwxr-xr-xMaster/tlpkg/libexec/ctan2tds1
-rw-r--r--Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc1
-rw-r--r--Master/tlpkg/tlpsrc/threeparttable.tlpsrc0
8 files changed, 224 insertions, 1 deletions
diff --git a/Master/texmf-dist/doc/latex/threeparttable/miscdoc.sty b/Master/texmf-dist/doc/latex/threeparttable/miscdoc.sty
new file mode 100644
index 00000000000..878ff148692
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/threeparttable/miscdoc.sty
@@ -0,0 +1,111 @@
+\ProvidesPackage{miscdoc}[2010/01/20 v1.2 documentation macros misc latex pkgs]
+
+% miscdoc.sty
+% Copyright 2010 Robin Fairbairns
+%
+% This work may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either version 1.3
+% of this license or (at your option) any later version.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3 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 Robin Fairbairns.
+%
+% This work consists of the file miscdoc.sty (only)
+
+\setcounter{errorcontextlines}{1274}
+
+% The package arose from a small exercise to document packages whose
+% previous documentation consisted solely of comments in the package files.
+% The macros here defined are lifted from the author's faq.sty
+% (written for the UK TeX FAQ, CTAN:help/uk-tex-faq) or are inspired
+% by others' work (credited where the author is known) ... except
+% where they came as a flash of inspiration while actually writing the
+% documentation.
+
+% this option suggested by Heiko Oberdiek, 2010-01-29
+\DeclareOption{hyper}{%
+ \AtEndOfPackage{%
+ \RequirePackage[pdfusetitle]{hyperref}
+ \RequirePackage{bookmark}
+ \bookmarksetup{numbered,open,openlevel=1}
+ }
+}
+\ProcessOptions\relax
+
+% note: T1 encoding assumed
+\usepackage{lmodern}
+\usepackage[T1]{fontenc}
+\usepackage{booktabs}
+
+% from faq.sty
+\newcommand\cs[1]{\texttt{\char`\\#1}}
+\let\csx\cs
+\def\bsbs{\cs{\char`\\}}
+
+% \cmdinvoke\cs<argument sequence>
+% \cs typeset as above
+% <argument sequence> may consist of optional or mandatory arguments;
+%
+% the `arguments' are simply typesett \texttt, as yet -- if something
+% fancier is needed, there's a bunch of code needs rewriting here...
+\DeclareRobustCommand\cmdinvoke{\@ifstar
+ {\let\@tempa\emph\@scmdinvoke}%
+ {\let\@tempa\relax\@scmdinvoke}%
+}
+\def\@scmdinvoke#1{\texttt{\symbol{92}#1}%
+ \futurelet\@let@token\@cmdinvoke
+}
+\def\@cmdinvoke{\ifx\@let@token\bgroup
+ \let\@tempb\@cmdinvoke@lbrace
+ \else
+ \ifx\@let@token[% ]
+ \let\@tempb\@cmdinvoke@lbrack
+ \else
+ \ifx\@let@token(% )
+ \let\@tempb\@cmdinvoke@lparen
+ \else
+ \let\@tempb\@empty
+ \fi
+ \fi
+ \fi
+ \@tempb
+}
+\def\@cmdinvoke@lbrace#1{\penalty0\hskip0pt\relax
+ \texttt{\symbol{123}\@tempa{#1}\symbol{125}}%
+ \futurelet\@let@token\@cmdinvoke
+}
+\def\@cmdinvoke@lbrack[#1]{\penalty-150\hskip0pt\relax
+ \texttt{[\@tempa{#1}]}%
+ \futurelet\@let@token\@cmdinvoke
+}
+\def\@cmdinvoke@lparen(#1){\penalty-150\hskip0pt\relax
+ \texttt{(\@tempa{#1})}%
+ \futurelet\@let@token\@cmdinvoke
+}
+% and extension -- versions that take a single extra (delimiter)
+% argument, such as \delcmdinvoke{lscrunge}( ... awful syntax, but...
+\DeclareRobustCommand\delcmdinvoke{\@ifstar
+ {\let\@tempa\emph\@sdelcmdinvoke}%
+ {\let\@tempa\relax\@sdelcmdinvoke}%
+}
+\def\@sdelcmdinvoke#1#2{\texttt{\symbol{92}#1#2}%
+ \futurelet\@let@token\@cmdinvoke
+}
+
+% sui generis
+\newcommand\newitem{\par\addvspace{1ex}\noindent}
+
+% inspired by doc.sty in latex distribution
+\newcommand\meta[1]{\ensuremath{\langle}\emph{#1}\ensuremath{\rangle}}
+
+% meaningful names, as in faq.sty
+\let\environment\texttt
+\let\Package\textsf
+\def\option{\@ifnextchar[\@optionb\@option}% ]
+\def\@optionb[#1]{[{\normalfont\ttfamily#1}]}
+\def\@option#1{\texttt{#1}}
diff --git a/Master/texmf-dist/doc/latex/threeparttable/threeparttable.pdf b/Master/texmf-dist/doc/latex/threeparttable/threeparttable.pdf
new file mode 100644
index 00000000000..f168f5bc442
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/threeparttable/threeparttable.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/threeparttable/threeparttable.tex b/Master/texmf-dist/doc/latex/threeparttable/threeparttable.tex
new file mode 100644
index 00000000000..eb8c333a01b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/threeparttable/threeparttable.tex
@@ -0,0 +1,110 @@
+\documentclass[a4paper]{article}
+\usepackage{miscdoc}
+\begin{document}
+\title{The \Package{threeparttable} package\thanks{This documentation
+ covers version 3.0 of the package, dated 2006-06-13}}
+\author{Donald Arseneau\thanks{Documentation put together by Robin
+ Fairbairns}}
+\maketitle
+
+\section{Outline}
+
+This package facilitates tables with titles (captions) and notes. The
+title and notes are given a width equal to the body of the table (a
+tabular environment). By itself, a \environment{threeparttable} does
+not float, but you can put it in a \environment{table} or a
+\environment{table*} or some other floating environment. (This causes
+extra typing, but gives more flexibility.)
+
+Inside a \environment{threeparttable} there should be a caption,
+followed by a tabular environment (\environment{tabular},
+\environment{tabular*}, \environment{tabularx} or the like), possibly
+followed by a series of itemized \emph{tablenotes}. (The caption may
+also go after the tabular environment.)
+
+For example:
+\begin{quote}
+\begin{verbatim}
+\begin{table}
+ \begin{threeparttable}[b]
+ \caption{...}
+ \begin{tabular}...% or {tabular*}
+ ...42\tnote{1}&.... ...
+ \end{tabular}
+ \begin{tablenotes}
+ \item [1] the first note ...
+ \end{tablenotes}
+ \end{threeparttable}
+\end{table}
+\end{verbatim}
+\end{quote}
+
+The {threeparttable} environment takes an optional vertical-placement
+parameter, \option[t], \option[b], or \option[c]; the default is
+\option[t].
+
+There is nothing automatic about the notes; you must specify the
+identifier in the body of the table (``\cmdinvoke{tnote}{a}'') and in
+the notes below the table (``\cmdinvoke{item}[a]\texttt{...}''). The
+author chose this method because automatic numbering with \cs{footnote} would be very hard to use, particularly because many tables make
+repeated reference to a single note\footnote{If someone has a
+ convenient, elegant, automatic system, the author promises to
+ listen!}. \cs{tnote} commands may be given in the caption too, and
+they will \textbf{not} appear in the list of tables.
+
+There are several commands which should be redefined for customizing the
+behaviour of \Package{threeparttable}, especially the table notes.
+Some options are provided for common variations of the table notes:
+\begin{description}
+\item[\option{para}] Notes come one-after-another without line breaks
+\item[\option{flushleft}] No hanging indentation on notes
+\item[\option{online}] \cs{item} tag is printed normal size, not superscript
+\item[\option{normal}] restores default formatting
+\end{description}
+These options can be given to the \cs{usepackage} command or to each
+individual \environment{tablenotes} environment. The
+\option[normal] option is intended to reverse the whole-document
+options for a particular table; e.g.
+\begin{quote}
+\begin{verbatim}
+\usepackage[para]{threeparttable}
+... document rambles on ...
+\begin{tablenotes}[normal,flushleft]
+\end{verbatim}
+\end{quote}
+These few options will not give you every format you might want, so
+you may find that you need to redefine one or more of the
+configuration commands. Note that mixing options with redefinitions
+is unlikely to work smoothly: Please submit your redefinitions to be
+used as options in future versions!
+
+Configuration commands:
+\begin{itemize}
+\item \cs{TPTminimum}: command givining minimum caption width.
+ Default \texttt{4em}; change with \cs{def} or \cs{renewcommand}.
+\item \cs{TPTrlap}: A command with one argument, to make notes go out
+ of the column, into the column separation (for right-aligning)
+\item \cs{TPTtagStyle}: Command with one argument to set appearance of
+ the tag (number) in \cmdinvoke{tnote}{tag}. It defaults to nil. It
+ could be \cs{textit}.
+\item \cs{tnote}: Yes, you can redefine the \cs{tnote} command.
+\item \cs{TPTnoteLabel}: Command with one argument to format the item
+ label in the tablenotes list (\cs{makelabel}); default uses
+ \cs{tnote}.
+\item \cs{TPTnoteSettings}: A command to issue all the
+ list-environment setup commands for the tablenotes.
+\item \cs{tablenotes} or \cs{TPTdoTablenotes}: Yes, you can redefine
+ the whole tablenotes environment. (\cs{tablenotes} processes
+ optional parameters, then invokes \cs{TPTdoTablenotes}; the
+ \option[para] option replaces \cs{TPTdoTablenotes}).
+\end{itemize}
+For figures, there is an equivalent \environment{measuredfigure}
+environment. It is fairly fragile though, and should be used only for
+a single graphic above a single caption.
+
+Note that the \cs{caption} formatting is \emph{not} adjusted by
+\Package{threeparttable}. You should use one of the caption-control
+packages to get captions that work well as table titles. In truth,
+\Package{threeparttable} sets \cs{abovecaptionskip} to zero for
+captions above the table, but more complete changes are called for.
+\end{document}
diff --git a/Master/texmf-dist/tex/latex/ltxmisc/threeparttable.sty b/Master/texmf-dist/tex/latex/threeparttable/threeparttable.sty
index bc9f5943d8c..bc9f5943d8c 100644
--- a/Master/texmf-dist/tex/latex/ltxmisc/threeparttable.sty
+++ b/Master/texmf-dist/tex/latex/threeparttable/threeparttable.sty
diff --git a/Master/tlpkg/bin/tlpkg-ctan-check b/Master/tlpkg/bin/tlpkg-ctan-check
index 94a6c77145f..c7c3ce1d932 100755
--- a/Master/tlpkg/bin/tlpkg-ctan-check
+++ b/Master/tlpkg/bin/tlpkg-ctan-check
@@ -280,7 +280,7 @@ my @TLP_working = qw(
texpower texshade
textcase textfit textopo textpath textpos
thailatex theoremref thesis-titlepage-fhac
- thinsp thmbox thmtools threeparttablex
+ thinsp thmbox thmtools threeparttable threeparttablex
thumb thumbpdf thumby thuthesis ticket
tikz-3dplot tikz-inet tikz-qtree tikz-timing timetable tipa
titlefoot titlepages titlepic titlesec titling
diff --git a/Master/tlpkg/libexec/ctan2tds b/Master/tlpkg/libexec/ctan2tds
index 360db65efb3..dae3284dc6b 100755
--- a/Master/tlpkg/libexec/ctan2tds
+++ b/Master/tlpkg/libexec/ctan2tds
@@ -943,6 +943,7 @@ $standardtex='\.(cfg|sty|clo|ldf|cls|def|fd|cmap|4ht)$';
'taylor', 'diagrams.tex',
'tex-ewd', 'dotnot.tex',
'texsis', '\.txs|TXS.*tex|texsis.tex',
+ 'threeparttable', '^..[^s].*\.sty', # not miscdoc.sty
'ticket', '\.tdf|' . $standardtex,
'tikz-qtree', '(pgf|tikz-)(subpic|q?tree(-compat)?)\.(tex|sty)',
'tkz-doc', '\.cls', # no example.sty
diff --git a/Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc b/Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc
index fc4c5e34883..bffb4103626 100644
--- a/Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc
+++ b/Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc
@@ -596,6 +596,7 @@ depend textfit
depend textmerg
depend textpos
depend theoremref
+depend threeparttable
depend threeparttablex
depend thinsp
depend thmtools
diff --git a/Master/tlpkg/tlpsrc/threeparttable.tlpsrc b/Master/tlpkg/tlpsrc/threeparttable.tlpsrc
new file mode 100644
index 00000000000..e69de29bb2d
--- /dev/null
+++ b/Master/tlpkg/tlpsrc/threeparttable.tlpsrc