summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/cellspace/cellspace.tex
blob: 5c4da1937e237b5e1537badb350212cb6e7160c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
% (C) 2006-2019 Josselin Noirel
% 
% Package cellspace: Ensuring a minimal spacing of table cells.
%
% This material is subject to the LaTeX Project Public License. See
% http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html .
%
\def \filedate    {2019/03/11}%
\def \fileversion {v1.8.1}%

\ProvidesFile{cellspace}%
  [\filedate \space \fileversion \space cellspace documentation (JN)]
\pdfoutput = 1
\documentclass[12pt]{ltxdoc}

\usepackage{ifpdf}
\ifpdf
  \PassOptionsToPackage{pdftex}{geometry}
\else
  \PassOptionsToPackage{dvips}{geometry}
\fi
\usepackage[ascii]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{amsmath}
\usepackage{textcomp}
\usepackage{lmodern}
\usepackage{microtype}
\usepackage[a4paper, margin = 1.3in]{geometry}
\usepackage[math]{cellspace}
\usepackage{booktabs}
\usepackage{tabularx}
\usepackage{moreverb}
\usepackage{floatrow}
  \floatsetup{margins = centering}
\usepackage{algorithmic}
\usepackage[british]{babel}

% -----------------------------------------------------------------

\newcommand*{\compare}[2]{%
  \par \begingroup \trivlist \item \centering
%%   \parbox[t]{0.5\linewidth}{#1}%
%%   \parbox[t]{0.5\linewidth}{#2}%
    \vskip-\baselineskip
  \makebox[0pt]{%
    \mbox{#1}%
    \quad
    \mbox{#2}%
  }
  \endtrivlist \endgroup \par
}
\renewcommand*{\meta}[1]{\textnormal{\textlangle \emph{#1}\textrangle}}
\newcommand*{\pack}{\textsf}
\newcommand*{\tex}[1]{\texttt{#1}}
\renewcommand*{\cmd}[1]{\tex{\textbackslash #1}}
\makeatletter
\newenvironment*{showexample}{%
  \par \vskip-\baselineskip
  \bgroup \obeylines
  \@showexample
}{%
    \endverbatimwrite
  \endgroup
  \begingroup
    \footnotesize
    \samepage
    \verbatimtabinput{cellspace.tmp}%
  \endgroup
  \nobreak \@nobreaktrue \vskip-\baselineskip \vskip\z@skip
  \begingroup \@nameuse{\@showexampleenv}%
    \small
    \input{cellspace.tmp}%
  \@nameuse{end\@showexampleenv}\endgroup
  \par \bigbreak
  \@endparenv
}
\newcommand*{\@showexample}[1][center]{%
  \egroup
  \def \@showexampleenv {#1}%
  \begingroup
    \verbatimwrite{cellspace.tmp}%
}
\makeatother

% -----------------------------------------------------------------

\setlength{\cellspacetoplimit}{2pt}
\setlength{\cellspacebottomlimit}{2pt}
\setcounter{secnumdepth}{0}
\addparagraphcolumntypes{X}

% -----------------------------------------------------------------

\GetFileInfo{cellspace.sty}

\title  {The \pack{cellspace} package}
\author {Josselin Noirel\footnote{This document corresponds to version
  \fileversion\ (\filedate) of \pack{\filename}.}\\%
\url{https://github.com/JosselinNoirel/cellspace}}
\date   {\filedate---\fileversion}

\begin{document}

\maketitle

\begin{abstract}
  This package is intended to allow automatic spacing out of the lines of
  an array.  People often complain about text touching the \cmd{hline} of
  a tabular when it is too high or too deep.  For example (with the
  \pack{amsmath} package) with \tex{\textbackslash dfrac\{1\}\{2\}}
  surrounded by \cmd{hline}s.  This package provides a modifier \tex{S} to
  usual column types (\tex{l}, \tex{c}, \tex{r}, \tex{p}, \tex{m},
  and~\tex{b}) that ensures a minimal spacing between rules and cells of
  an array.
\end{abstract}

\section{Introduction}

The mechanism used by \LaTeX{} to build tables---using struts---has an
important consequence: the cells of a table that extend too much tend to
touch horizontal rules.  First example:
%
\begin{showexample}
\begin{tabular}{cc}
  \hline
  \itshape Bond &
  \itshape Distance ($\mathrm{\mathring{A}})$ \\
  \hline
  C--C          & $1.53$ \\
  C--H          & $1.10$ \\
  \hline
\end{tabular}
\end{showexample}
%
Second example:
%
\begin{showexample}
\begin{tabular}{c}
  \hline
  \itshape Formula \\
  \hline
  $\displaystyle
   e = 1 + \frac{1}{2} + \frac{1}{6}  + \cdots
                       + \frac{1}{k!} + \cdots $ \\
  $\displaystyle
   \pi = 4 \left( 1 - \frac{1}{3} + \frac{1}{5} + \cdots
                    + \frac{(-1)^k}{2 k + 1}
                    + \cdots \right)$ \\
  \hline
\end{tabular}
\end{showexample}
%
The classical workarounds \cmd{\textbackslash}\oarg{dimen} and
\cmd{noalign}\tex{\{}\cmd{vspace}\marg{dimen}\tex{\}} are not very powerful
and need fine tuning.

\section{How to solve this?}

The \pack{cellspace} loads several packages to carry out its job:
\pack{array}, \pack{ifthen}, and~\pack{calc} (along \tex{amsmath} when
the option \tex{math} is passed to \tex{cellspace}).  It redefines several
internals, still not too many (\cmd{@startpbox} and \cmd{@endpbox}).  By
default, the tables will behave as usual.  To improve the spacing of your
tables, you must change the table preamble and prepend \tex{S} to the
column types \tex{l}, \tex{c}, \tex{r}.  The same holds for the paragraph
columns \tex{p}, \tex{m}, and~\tex{b}, except that they must be surrounded
by an extra pair of braces.  For instance, the default behaviour of a
table beginning with
%
\begin{verbatim}
\begin{tabular}{l l l p{3cm}}
\end{verbatim}
%
should be changed into
%
\begin{verbatim}
\begin{tabular}{Sl Sl Sl S{p{3cm}}}
\end{verbatim}

The \pack{cellspace} has two parameters governing the spacing of the
cells.  The dimension \cmd{cellspacetoplimit} is the minimal spacing
required between the actual text the cell is made up of and the top of the
cell (where \cmd{hline}s may appear), if the spacing is less than this
threshold, a space of \cmd{cellspacetoplimit} is added, otherwise nothing
is done. Conversely, at the bottom the dimension
\cmd{cellspacebottomlimit} is the minimal space required between the
bottom of the cell and the text itself. This parameters can be changed in
the document preamble using \cmd{setlength}.  Together with
\pack{booktabs}, the results look rather good.  \pack{cellspace} may work
with other column types (defined through \cmd{newcolumntype} for
instance); it will assume by default that an unknown column is a LR-mode
column.  Otherwise you have to tell \pack{cellspace} something like
%
\begin{verbatim}
\addparagraphcolumntypes{X}
\end{verbatim}
%
(The previous example is needed to make \pack{tabularx} work with
\pack{cellspace}.)

The following examples use a setting of $2\,\mathrm{pt}$ for both top and
bottom space limits.
%
\compare{%
  \begin{tabular}[t]{cc}
    \hline
    \itshape Bond &
    \itshape Distance ($\mathrm{\mathring{A}})$ \\
    \hline
    C--C          & $1.53$ \\
    C--H          & $1.10$ \\
    \hline
  \end{tabular}
}{%
  \begin{tabular}[t]{Sc Sc}
    \hline
    \itshape Bond &
    \itshape Distance ($\mathrm{\mathring{A}})$ \\
    \hline
    C--C          & $1.53$ \\
    C--H          & $1.10$ \\
    \hline
  \end{tabular}
}
%
Some space is added at the top the first row because it doesn't fulfil
the condition imposed by the package.  Similarly some space is added at
the bottom of the first row.  It has to be noted, however, that no space
is added in other rows because they are far enough from the cell
separations.

\compare{%
  \begin{tabular}[t]{c}
    \hline
    \itshape Formula \\
    \hline
    $\displaystyle
    e = 1 + \frac{1}{2} + \frac{1}{6}  + \cdots
                         + \frac{1}{k!} + \cdots $ \\
    $\displaystyle
     \pi = 4 \left( 1 - \frac{1}{3} + \frac{1}{5} + \cdots
                      + \frac{(-1)^k}{2 k + 1}
                      + \cdots \right)$ \\
    \hline
  \end{tabular}
}{%
  \begin{tabular}[t]{Sc}
    \hline
    \itshape Formula \\
    \hline
    $\displaystyle
    e = 1 + \frac{1}{2} + \frac{1}{6}  + \cdots
                         + \frac{1}{k!} + \cdots $ \\
    $\displaystyle
     \pi = 4 \left( 1 - \frac{1}{3} + \frac{1}{5} + \cdots
                      + \frac{(-1)^k}{2 k + 1}
                      + \cdots \right)$ \\
    \hline
  \end{tabular}
}
%
Here it can be immediately remarked that the `Formula' row has the same
height in both examples.  Only the formula lines are affected.  The best
layout is obtained with \pack{booktabs}:
%
\compare{%
  \begin{tabular}[t]{@{} c @{}}
    \toprule
    \itshape Formula \\
    \midrule
    $\displaystyle
    e = 1 + \frac{1}{2} + \frac{1}{6}  + \cdots
                         + \frac{1}{k!} + \cdots $ \\
    $\displaystyle
     \pi = 4 \left( 1 - \frac{1}{3} + \frac{1}{5} + \cdots
                      + \frac{(-1)^k}{2 k + 1}
                      + \cdots \right)$ \\
    \bottomrule
  \end{tabular}
}{%
  \begin{tabular}[t]{@{} Sc @{}}
    \toprule
    \itshape Formula \\
    \midrule
    $\displaystyle
    e = 1 + \frac{1}{2} + \frac{1}{6}  + \cdots
                         + \frac{1}{k!} + \cdots $ \\
    $\displaystyle
     \pi = 4 \left( 1 - \frac{1}{3} + \frac{1}{5} + \cdots
                      + \frac{(-1)^k}{2 k + 1}
                      + \cdots \right)$ \\
    \bottomrule
  \end{tabular}
}

The following example shows that how it works with paragraph columns.
%
\compare{%
  \begin{tabular}[t]{p{5cm}}
    \hline
    $\displaystyle \frac{1}{2}$
    A A A A A A A A A A A A A A
    A A A A A A A A A A A A A A
    A A A A A A A A A A A A A A
    A A A A A A A A A A A A A A
    A A A A A A A A A A A A A A
    $\displaystyle \frac{1}{2}$ \\
    \hline
  \end{tabular}
}{%
  \begin{tabular}[t]{S{p{5cm}}}
    \hline
    $\displaystyle \frac{1}{2}$
    A A A A A A A A A A A A A A
    A A A A A A A A A A A A A A
    A A A A A A A A A A A A A A
    A A A A A A A A A A A A A A
    A A A A A A A A A A A A A A
    $\displaystyle \frac{1}{2}$ \\
    \hline
  \end{tabular}
}

\section{Matrices}

The package can be loaded with the options \tex{nomath} (default) and
\tex{math}.  The latter does two things: it first loads the
\tex{amsmath} package and then redefines
the command that is invoked when one typesets matrices
(\tex{\textbackslash env@matrix} --- this improvement was suggested by
Bastien Roucaries).  The following
examples illustrate what happens with (left) or without (right)
\pack{cellspace}'s correction in a \tex{pmatrix} environment.
%
\[
\begingroup
\makeatletter
  \def\env@matrix{\hskip -\arraycolsep
  \let\@ifnextchar\new@ifnextchar
  \array{*\c@MaxMatrixCols c}}
\makeatother
%
\text{\tex{nomath} option\ }%
\begin{pmatrix}
+\frac{1}{2} & +\frac{1}{3} \\
-\frac{1}{3} & +\frac{1}{2} \\
\end{pmatrix}
\endgroup
\qquad
\text{\tex{math} option\ }%
\begin{pmatrix}
+\frac{1}{2} & +\frac{1}{3} \\
-\frac{1}{3} & +\frac{1}{2} \\
\end{pmatrix}
\]

As a~consequence, the \tex{amsmath} package can be loaded beforehand
with other packages (such as \tex{empheq} or \tex{mathtools}), were an
incompatibility to arise from one's loading it later.

\section{Using a different column name}

An other column name than \tex{S} can be used if \tex{S} conflicts
with the user's own definitions or a package's.  A keyval option can
be passed to the package to that effect;
%
\begin{verbatim}
\usepackage[column=O]{cellspace}
\end{verbatim}
%
can be used to provide cellspace's functionality through the \tex{O}
column modifier instead of the \tex{S} column modifier.


\section{Bugs and limitations}

This package hasn't been heavily tested, so there may be plenty of bugs.
As usual, bugs will certainly arise in complicated situations because
tables can become very complicated (for instance, this package hasn't been
designed with nested tables into mind).  In simple cases however, it should
work nicely.  The package loads \pack{array} ensuring a peaceful
collaboration with each other.  Other packages of special interest haven't
been tested: \pack{tabularx}\footnote{A one minute test seems to indicate
  that it works provided \pack{tabularx} is loaded after \pack{cellspace}.
  The example on this page illustrates this.  A thirty second test
indicates that \pack{cellspace} works correctly with \pack{longtable} as
long as only LR-mode columns are concerned.} and \pack{longtable} in
particular.
%
\begin{trivlist}\item
\begin{tabularx}{\linewidth}{l SX}
  \hline
  A       & B B B B B B B B \\
  A A     & B B B B B B B B
            B B B B B B B B \\
  A A A A & $\dfrac{1}{2}$B B B B B B B B
            B B B B B B B B
            B B B B B B B B
            B B B B B B B B$\dfrac{1}{2}$ \\
  \hline
\end{tabularx}
\end{trivlist}

\pack{tabls}\footnote{Thanks to Jim Hefferon for pointing this out.} is a
package that does a similar job as \pack{cellspace}.
The differences are: \pack{tabls} affects a whole table while
\pack{cellspace} affects only the columns on which applies the modifier
\tex{S}.  Each cell affected by \pack{cellspace} is affected in the same
way: there must be enough space above ($>\cmd{cellspacetoplimit}$) and
below the text ($>\cmd{cellspacebottomlimit}$), even if no \cmd{hline} is
present.  In the other hand, \pack{tabls} ensures a minimal distance using
one threshold parameter \cmd{tablinesep} applying between rows not
separated by a rule and using a systematic spacer \cmd{arraylinesep} when
there is a rule (whereas \pack{cellspace} can leave a cell as is if the
distance to the rule is big enough).  As a last point, \pack{tabls}, as
far as I can see, cannot work with \pack{array}.

\section{What's new}

\begin{description}
\item [v1.8.1] Package becomes aware of the latest version of the
      array package
\end{description}

\end{document}