summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/arraycols/arraycols.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/arraycols/arraycols.dtx')
-rw-r--r--macros/latex/contrib/arraycols/arraycols.dtx84
1 files changed, 48 insertions, 36 deletions
diff --git a/macros/latex/contrib/arraycols/arraycols.dtx b/macros/latex/contrib/arraycols/arraycols.dtx
index 335ca53c11..9a62fa7f1c 100644
--- a/macros/latex/contrib/arraycols/arraycols.dtx
+++ b/macros/latex/contrib/arraycols/arraycols.dtx
@@ -1,6 +1,6 @@
% \iffalse meta-comment
%
-% Copyright (C) 2019 by Antoine Missier <antoine.missier@ac-toulouse.fr>
+% Copyright (C) 2019-2020 by Antoine Missier <antoine.missier@ac-toulouse.fr>
%
% This file may be distributed and/or modified under the conditions of
% the LaTeX Project Public License, either version 1.3 of this license
@@ -20,7 +20,7 @@
%<*package>
\NeedsTeXFormat{LaTeX2e}[2005/12/01]
\ProvidesPackage{arraycols}
- [2019/06/26 v1.0 .dtx arraycols file]
+ [2020/11/23 v1.1 .dtx arraycols file]
%</package>
%<*driver>
\documentclass{ltxdoc}
@@ -50,7 +50,7 @@
%</driver>
% \fi
%
-% \CheckSum{614}
+% \CheckSum{46}
%
% \CharacterTable
% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
@@ -71,14 +71,16 @@
% \changes{v0.1}{27/12/2011}{First personal version}
% \changes{v1.0}{2019/05/04}{Initial version, creating dtx and ins files}
% \changes{v1.0}{2019/06/17}{English translation by François Bastouil}
+% \changes{v1.1}{2020/11/23}{Incompatibility with tablestyles mentioned,
+% minor changes in documentation}
%
% \GetFileInfo{arraycols.sty}
%
% \title{The \textsf{arraycols} package\thanks{This document
-% corresponds to \textsf{arraycols}~\fileversion, initial version dated \filedate.
-% Thanks to François Bastouil for English translation.}}
+% corresponds to \textsf{arraycols}~\fileversion, dated \filedate.
+% Thanks to François Bastouil for help in English translation.}}
% \author{Antoine Missier \\ \texttt{antoine.missier@ac-toulouse.fr}}
-% \date{June 26, 2019}
+% \date{November 23, 2020}
% \maketitle
%
% \section{Introduction}
@@ -132,12 +134,15 @@
% Note that if a column type has already been defined previously,
% it will be overwritten with a warning message.
%
-% Besides \textsf{array}, \textsf{arraycols} loads the \textsf{cellspace} package,
+% Besides \textsf{array}, \textsf{arraycols} loads the \textsf{cellspace} package~\cite{CELLSP},
% necessary for the \texttt{x}, \texttt{y}, \texttt{z} and \texttt{Z} types of columns and
% \textsf{tabularx}~\cite{TABX}, necessary for \texttt{T} and \texttt{Z},
% as well as \textsf{makecell}~\cite{MKCELL} for various alignments of multilined table cells.
+% The \textsf{tablestyles} package~\cite{TBLSTY} defines also L, C, R, Z column types
+% but in a different way, nevertheless this package is incompatible with \textsf{makecell}
+% and therefore with \textsf{arraycols} too.
%
-% This package, with a very short code, does not claim to develop new macros.
+% With a very short code, this package does not claim to develop new macros.
% Its main action is to combine and set features coming from other packages.
%
% \section{Usage}
@@ -145,13 +150,13 @@
%\medskip
% \DescribeEnv{L} \DescribeEnv{C} \DescribeEnv{R}
% Referring to an example from the \textsf{array} package documentation,
-% \textsf{arraycols} provides the |L|, |C|, |R| type of columns
+% \textsf{arraycols} provides the |L|, |C|, |R| columns types
% which reverse the mathematical mode.
-% Then we can use these column types to get centred, left-aligned or right-aligned
-% LR-mode in an \texttt{array} or math-mode in a \texttt{tabular} environment.
-% For instance, declaration *\begin{tabular}{|l|C|r|}* produces the second column
-% in a centred mathematical mode and declaration *\begin{array}{|L|c|c|}*
-% produces the first column in text mode, left aligned\footnote{The declarations
+% Then we can use them to get centered, left-aligned or right-aligned
+% LR-mode in an \texttt{array} environment or math-mode in a \texttt{tabular} environment.
+% For instance, the declaration *\begin{tabular}{|l|C|r|}* sets centered mathematical mode
+% in the second column and declaration *\begin{array}{|L|c|c|}*
+% sets text mode, left aligned in the first column\footnote{The declarations
% \texttt{L, C, R} do not work in a \texttt{tabularx} environment.
% Note that the \textsf{tabulary} package by David Carlisle~\cite{TABY}
% already defines the \texttt{L, C, R, J} column types for particular alignments
@@ -162,22 +167,24 @@
%
% \medskip
% \DescribeEnv{t\marg{width}}
-% We add the definition \texttt{t}\{\meta{width}\} (text in LR-mode)
-% producing a horizontal and a vertical centering in the column unlike the classics
-% \texttt{p}\marg{width} and \texttt{m}\marg{width} which produce left aligned text.
+% The new column type definition \texttt{t}\{\meta{width}\} (text in LR-mode)
+% produces horizontal and vertical centering in the column unlike the classics
+% \texttt{p}\marg{width} (in standard \LaTeX) and \texttt{m}\marg{width}
+% (from the \textsf{array} package) which produce left aligned text (visible when the column
+% is wider than the text inside).
%
% \medskip
% \DescribeEnv{x} \DescribeEnv{y}
-% To ensure a sufficient height for rows, for instance for formulas
-% in displaymath mode, we have defined the columntypes \texttt{x} (centred)
+% To ensure sufficient height for rows, for instance in displaymath mode
+% formulas, we provide the columntypes \texttt{x} (centered)
% and \texttt{y} (left aligned), based on the \textsf{cellspace} package
% by Josselin Noirel~\cite{CELLSP}.
-% They allows an automatic adjustment of the rows heights to avoid touching the
+% They allow automatic adjustment of row heights to avoid touching the
% horizontal rules when content is too high.
% Although \textsf{cellspace} is defined \emph{a priori} for \texttt{tabular} environments,
% the new \texttt{x} and \texttt{y} column types, defined by \textsf{arraycols},
-% produce a column in mathematical mode with the right adjustment,
-% either with a \texttt{tabular} or with an \texttt{array} environment.
+% produce a column in mathematical mode with good adjustment,
+% either in a \texttt{tabular} or in an \texttt{array} environment.
%
% Look at the following examples produced with
% *\begin{array}{|c|}* and with *\begin{array}{|x|}*.
@@ -213,20 +220,20 @@
% \og the \textsf{amsmath} package can be loaded beforehand with other
% packages (such as \texttt{empheq} or \texttt{mathtools}),
% were an incompatibility to arise from one’s loading it later\fg.}
-% for a good management of rows heights in matrix tables.
+% for a good management of row heights in matrix tables.
%
% \medskip
% Notice that another package, \textsf{booktabs}~\cite{BOOK}, also provides
-% an excellent adjustment for rows heights, but unfortunately, it doesn't handle the height
+% an excellent adjustment of row heights, but unfortunately, it doesn't handle height
% of vertical separators *|*.
% To get the same vertical adjustment as \textsf{booktabs},
-% thus we set the \textsf{cellspace} parameters:\\
+% we set the \textsf{cellspace} parameters as follows:\\
% |\setlength{\cellspacetoplimit}{3pt}|, \\
% |\setlength{\cellspacebottomlimit}{2pt}|.
%
% We should also mention the \textsf{tabls} package by Donald Arneseau~\cite{TABLS}
-% making a good adjustment of rows heights as well, but it's incompatible with the \textsf{array}
-% and \textsf{numprint} packages.
+% that makes a good adjustment of row heights as well, but it is incompatible
+% with the \textsf{array} and \textsf{numprint} packages.
%
% \medskip
% At last, it is also possible to make manual adjustments with the |\vstrut| command
@@ -236,8 +243,9 @@
%
% \medskip
% \DescribeEnv{z\marg{width}}
-% The column definition \texttt{z}\marg{width} enables, just as \texttt{t}\marg{width},
-% to set the column width, but also activates the math mode and adjusts the row height,
+% The column type \texttt{z}\marg{width} enables to set the column width,
+% as \texttt{t}\marg{width},
+% but also activates the math mode and adjusts the row height,
% as \texttt{x}.
%
% \medskip
@@ -249,8 +257,8 @@
% *\begin{tabularx}{8cm}{|c|X|X|}* adjusts the width of the \texttt{X} columns
% for a total witdh of the table equals to 8\,cm. As a complement, we propose
% the \texttt{T} declaration, doing the same thing but with horizontal centering
-% and \texttt{Z} which furthermore activates the mathematical mode and adjusts the height
-% of the line (as \texttt{x} or \texttt{z}). Here is an example with
+% and \texttt{Z} which furthermore activates the mathematical mode and adjusts
+% line heights (as \texttt{x} or \texttt{z}). Here is an example with
% *\begin{tabularx}{\linewidth}{|T|y|x|Z|T|}*.
% \begin{center}
% \begin{tabularx}{\linewidth}{|T|y|x|Z|T|}
@@ -264,7 +272,7 @@
% \end{tabularx}
% \end{center}
% To keep the perfect aligment of fraction bars in mathematical formulas,
-% cells are not vertically centred, however, to get a proper vertical positioning
+% cells are not vertically centered, however, to get a proper vertical positioning
% in the last cell, we have used the powerfull |\makecell| command of
% the \textsf{makecell} package by Olga Lapko~\cite{MKCELL}:
% |\makecell{a multiline \\ piece of text}|.
@@ -295,12 +303,14 @@
% |\renewcommand\theadfont{\footnotesize\sffamily}| \\
% (originally |\footnotesize| only, without |\sffamily|).
% At last, according to a recommendation of the \textsf{array} package~\cite{ARRAY},
-% 1\,pt has been added to the normal height of every row of the table, with the command
+% 1\,pt has been added to the normal height of every row of this table, with the command
% |\setlength{\extrarowheight}{1pt}|\footnote{As mentioned
% in the \textsf{array} package documentation:
% \og This is important for tables with horizontal lines because those
% lines normally touch the capital letters\fg.}.
%
+% \StopEventually{}
+%
% \section{Implementation}
% \begin{macrocode}
\RequirePackage{array}
@@ -326,7 +336,7 @@
\setlength{\cellspacebottomlimit}{2pt}
\newcolumntype{z}[1]{>{$}S{>{\centering\arraybackslash}p{#1}}<{$}}
% \end{macrocode}
-% For the \texttt{z} defintion of column, we use \texttt{p} and not \texttt{m}
+% For the \texttt{z} definition of column, we use \texttt{p} and not \texttt{m}
% (which automatically centers) in order to keep a correct alignment for mathematical
% expressions in the cells of a same row.
% \medskip
@@ -334,7 +344,7 @@
\newcolumntype{T}{>{\centering\arraybackslash}X}
\newcolumntype{Z}{>{$}ST<{$}}
% \end{macrocode}
-% The \texttt{T} columns are not automatically centred. It would be possible to do it
+% The \texttt{T} columns are not automatically centered. It would be possible to do it
% with the command |\renewcommand{\tabularxcolumn}[1]{m{#1}}|
% (with \texttt{m} instead of default value \texttt{p}),
% but unfortunately this has a global effect for all the declarations of columns based
@@ -352,7 +362,7 @@
\renewcommand\theadfont{\footnotesize\sffamily}
% \end{macrocode}
%
-% \begin{thebibliography}{10}
+% \begin{thebibliography}{11}
% \bibitem{ARRAY} \emph{A new implementation of LATEX’s \textsf{tabular} and \textsf{array}
% environment}, Frank Mittelbach, David Carlisle, CTAN, v2.4k revised 2018/12/30.
% \bibitem{CELLSP} \emph{The \textsf{cellspace} package}, Josselin Noirel, CTAN,
@@ -360,6 +370,8 @@
% \bibitem{TABX} \emph{The \textsf{tabularx} package}, David Carlisle, CTAN, v2.11.b 2016/02/03.
% \bibitem{MKCELL} \emph{The \textsf{makecell} package}, Olga Lapko, CTAN, v0.1e 2009/08/03.
% \bibitem{TABY} \emph{The \textsf{tabulary} package}, David Carlisle, CTAN, v1.10 2014/06/11.
+% \bibitem{TBLSTY} \emph{The \textsf{tablestyles} package}, Matthias Pospiech, CTAN,
+% v0.1 2014/06/27.
% \bibitem{BOOK} \emph{Publication quality tables in \LaTeX}, package \textsf{booktabs} by
% Simon Fear, CTAN, v1.618033 2016/04/29.
% \bibitem{TABLS} \emph{The \textsf{tabls} package}, Donald Arseneau, CTAN, v3.5 2010/02/26.