| 1 |
\ProvidesFile{finstrut.tex}[2011/03/14 documenting finstrut.sty (UL)] |
| 2 |
\title{\textsf{finstrut.sty}\\---\\Final Strut Allowing Vertical |
| 3 |
Mode---The \texttt{\cs{@finalstrut}} Encyclopedia and |
| 4 |
Toolkit\thanks{This document describes version |
| 5 |
\textcolor{blue}{\UseVersionOf{finstrut.sty}} |
| 6 |
of \textsf{finstrut.sty} as of \UseDateOf{finstrut.sty}. |
| 7 |
This upload is a birthday package for Donald Arseneau---he |
| 8 |
will be so happy!}} |
| 9 |
% \listfiles %% 2010/12/22 |
| 10 |
{ \RequirePackage{makedoc}[2010/12/20] \ProcessLineMessage{} |
| 11 |
\MakeJobDoc{18}{\SectionLevelTwoParseInput} |
| 12 |
} |
| 13 |
\documentclass{article}%% TODO paper dimensions!? |
| 14 |
\input{makedoc.cfg} %% shared formatting settings |
| 15 |
\newcommand*{\lt}{<} \newcommand*{\gt}{>} %% 2010/12/22 |
| 16 |
\providecommand*{\strong}{\textbf} %% 2010/12/15 |
| 17 |
\ReadPackageInfos{finstrut} |
| 18 |
\usepackage{color} |
| 19 |
\makeatletter \@beginparpenalty\@lowpenalty \makeatother |
| 20 |
\sloppy |
| 21 |
\begin{document} |
| 22 |
% \author{Uwe L\"uck\thanks{\urlhttpref{http://contact-ednotes.sty.de.vu}} |
| 23 |
% \and |
| 24 |
% Donald Arseneau} |
| 25 |
\maketitle |
| 26 |
\begin{abstract}\noindent |
| 27 |
\LaTeX\ internally inserts `\@finalstrut<strutbox>' |
| 28 |
at the end of footnotes or `p' (paragraph) `tabular' cells. |
| 29 |
When the user's entry ends on a `\par' token---which may |
| 30 |
be issued by some more-general-purpose user macro |
| 31 |
such as the `\lipsum' command from the \ctanpkgref{lipsum} |
| 32 |
package\urlfoot{CtanPkgRef}{lipsum} for dummy text---this |
| 33 |
produces a usually unwanted extra, empty line. |
| 34 |
'finstrut.sty' changes `\@finalstrut' in order to avoid |
| 35 |
this effect. |
| 36 |
\par |
| 37 |
The first version of the package just had this minimum purpose. |
| 38 |
But then Donald Arseneau has convinced me to consider |
| 39 |
a wide range of cases and to replace my code by his proposals. |
| 40 |
v0.5 again adds an idea of my own ones: %% 2011/03/14: |
| 41 |
instead of testing for `hmode' vs.~`vmode', |
| 42 |
`vmode' may be \emph{forced} by a `\par'---saves tokens! |
| 43 |
In order not to break code that some package writers may have |
| 44 |
used so far, choices by package options are offered. |
| 45 |
v0.4 offered choice among 6 definitions, with v0.5 they are 9---! |
| 46 |
(Not 9!.) |
| 47 |
\par\smallskip\noindent |
| 48 |
\strong{Keywords:}\quad footnotes; tables, dummy text, |
| 49 |
macro programming |
| 50 |
\end{abstract} |
| 51 |
\tableofcontents |
| 52 |
|
| 53 |
% \newpage |
| 54 |
\section{Remark on 'lipsum'} |
| 55 |
Almost at the same moment that 'finstrut' v0.1 was installed |
| 56 |
(2011-02-09), a new version v1.1 %% v0.4: v1.1 |
| 57 |
of 'lipsum' was uploaded that offers a package option |
| 58 |
`[nopar]' %% v0.4 |
| 59 |
to avoid a final `\par'. |
| 60 |
|
| 61 |
\section{Installing and Calling} |
| 62 |
The package file 'finstrut.sty' is provided ready, |
| 63 |
installation only requires putting it somewhere where \TeX\ finds it |
| 64 |
(which may need updating the filename data |
| 65 |
base).\urlfoot{ukfaqref}{inst-wlcf} |
| 66 |
|
| 67 |
Below the `\documentclass' line(s) and above `\begin{document}', |
| 68 |
you load 'finstrut.sty' (as usually) by |
| 69 |
\[`\usepackage{finstrut}'\qquad \mbox{or by}\qquad |
| 70 |
`\usepackage[<options>]{finstrut}'\]---<options> described below. |
| 71 |
|
| 72 |
\section{The Package File} |
| 73 |
\subsection{Header (Legalize)} |
| 74 |
\input{finstrut.doc} |
| 75 |
\end{document} |
| 76 |
|
| 77 |
VERSION HISTORY |
| 78 |
|
| 79 |
2011/02/09 cut out from `fnlineno.sty' [and corr. date+script] |
| 80 |
2011/02/09c remark on `lipsum' upload same day |
| 81 |
2011/02/11 \subsection |
| 82 |
2011/02/12 for v0.4 |
| 83 |
2011/02/16 for v0.5, abstract mentions Donald Arseneau |
| 84 |
2011/03/14 "encyclopedia and toolkit", abstract extended |