Difference between revisions of "Table"
m (Added link to tugboat article) |
m (Minor grammatical corrections.) |
||
(20 intermediate revisions by 12 users not shown) | |||
Line 1: | Line 1: | ||
< [[Tables Overview]] | [[Tabulate]] | [[Tables]] > | < [[Tables Overview]] | [[Tabulate]] | [[Tables]] > | ||
− | This is | + | This is ConTeXt's oldest table module. It uses the same formatting as [[Tabulate]] (see [[Tables Overview]]). |
− | This mode is based on Michael Wichura's TaBlE package for | + | This mode is based on Michael Wichura's TaBlE package for Plain TeX. The official manual for it is commercial (18 USD), see [http://www.pctex.com/books.html PCTeX] -- but note that the TaBlE manual only talks about the original syntax, which does not use {{cmd|NC}}, {{cmd|HL}}, cum suis. |
− | |||
− | |||
+ | The only ConTeXt docs are in [[manual:ms-cb-en.pdf|ConTeXt - an excursion]]. There are also two introductory articles in TUGboat [http://tug.org/TUGboat/Articles/tb28-3/tb90mahajan.pdf ConTeXt basics for users: Table macros] [http://www.tug.org/TUGboat/Articles/tb29-1/tb91mahajan.pdf Table macros II] by Aditya Mahajan (2007 and 2008). | ||
== Basic Commands == | == Basic Commands == | ||
Line 53: | Line 52: | ||
</td></tr></table> | </td></tr></table> | ||
− | * You get vertical lines (rules), if you use | + | * You get vertical lines (rules), if you use {{cmd|VL}} instead of {{cmd|NC}}. |
− | * Better use | + | * Better use {{cmd|SR}}, {{cmd|FR}}, {{cmd|MR}}, {{cmd|LR}} instead of {{cmd|NR}}. |
− | * You can also use | + | * You can also use {{cmd|AR}} instead of {{cmd|SR}}, {{cmd|FR}}, {{cmd|MR}} and {{cmd|LR}} (AR for automatic row). |
− | * You can leave out the | + | * You can leave out the {{cmd|NC}} before the "row" command, but not if you use {{cmd|AR}} in a last or single row (see example). |
− | * You can influence the table with | + | * You can influence the table with {{cmd|setuptables}}. |
− | |||
==Column Definition== | ==Column Definition== | ||
− | The table is defined by the template enclosed in square brackets after | + | The table is defined by the template enclosed in square brackets after {{cmd|starttable}}. The template has the form |
− | <tt>|keys for the first column|keys for the second column|...|keys for the last column|</tt>. Please note that | + | <br> |
+ | <tt>|keys for the first column|keys for the second column|...|keys for the last column|</tt>. | ||
+ | <br> | ||
+ | Please note that each column is surrounded by <tt>|</tt> signs. These are necessary. The formatting keys for each column can be a choice of | ||
− | + | {| class="wikitable" | |
− | + | ! Key | |
− | + | ! Meaning | |
− | + | |- | |
− | + | ! colspan="2" | Primitive Keys | |
− | + | |- | |
− | + | | <code>a{<em>tokens</em>}</code> | |
− | + | | Adds <code><em>tokens</em></code> <em>after</em> the column content | |
− | + | |- | |
− | + | |- | |
− | + | | <code>b{<em>tokens</em>}</code> | |
− | + | | Adds <code><em>tokens</em></code> <em>before</em> the column content | |
− | + | |- | |
− | + | | <code>\{</code> | |
− | + | | Enclose the column in braces (grouping) | |
− | + | |- | |
− | + | | <code>*{<em>n</em>}{<em>keys</em>}</code> | |
− | + | | Equivalent to repeating the formatting keys <code><i>keys</i></code> <code><i>n</i></code> times | |
− | + | |- | |
− | + | ! colspan="2" | Positioning Keys | |
− | + | |- | |
− | + | | <code>\LeftGlue</code> | |
− | + | | Specifies the left glue to be used before the column | |
− | + | |- | |
− | + | | <code>\RightGlue</code> | |
− | + | | Specifies the right glue to be used after the column | |
− | + | |- | |
− | + | | <code>l</code> | |
− | + | | left-aligned column | |
− | + | |- | |
− | + | | <code>c</code> | |
− | + | | centered column | |
− | + | |- | |
− | + | | <code>r</code> | |
− | + | | right-aligned column | |
− | + | |- | |
− | + | | <code>p(<em>width</em>)</code> | |
− | + | | Set each cell as a paragraph | |
− | + | |- | |
− | + | | <code>s(<em>width</em>)</code> | |
− | + | | Specify the inter-column width | |
− | + | |- | |
− | + | | <code>w</code> | |
− | + | | Set minimum column width | |
− | + | |- | |
− | + | | <code>k</code> | |
− | + | | Insert a kern both left and right of the column | |
− | + | |- | |
− | + | | <code>i</code> | |
− | + | | Add a kern to the left of the column | |
− | + | |- | |
− | + | | <code>j</code> | |
− | + | | Add a kern to the right of the column | |
− | + | |- | |
− | === | + | ! colspan="2" | Numeric and Math Item Keys |
+ | |- | ||
+ | | <code>n</code> | ||
+ | | Numeric item not in math mode | ||
+ | |- | ||
+ | | <code>N</code> | ||
+ | | Numeric item in math mode | ||
+ | |- | ||
+ | | <code>m</code> | ||
+ | | Each cell is in (inline) math mode. Equivalent to <code>b$ a$</code> | ||
+ | |- | ||
+ | | <code>M</code> | ||
+ | | Each cell is in display math mode. Equivalent to <code>\{b{$\displaystyle}a$}</code> | ||
+ | |- | ||
+ | | <code>\m</code> | ||
+ | | Equivalent to 1 <code>l b{{}}m</code> | ||
+ | |- | ||
+ | | <code>\M</code> | ||
+ | | Equivalent to 1 <code>l b{{}}M</code> | ||
+ | |- | ||
+ | ! colspan="2" | Style Keys | ||
+ | |- | ||
+ | | <code>f\<em>command</em></code> | ||
+ | | Set font according to following <code><em>command</em></code> | ||
+ | |- | ||
+ | | <code>B</code> | ||
+ | | Bold. Equivalent to <code>f\bf</code> | ||
+ | |- | ||
+ | | <code>I</code> | ||
+ | | Italic. Equivalent to <code>f\it</code> | ||
+ | |- | ||
+ | | <code>S</code> | ||
+ | | Slanted. Equivalent to <code>f\sl</code> | ||
+ | |- | ||
+ | | <code>R</code> | ||
+ | | Roman. Equivalent to <code>f\rm</code> | ||
+ | |- | ||
+ | | <code>T</code> | ||
+ | | Teletype. Equivalent to <code>f\tt</code> | ||
+ | |- | ||
+ | | <code>C</code> | ||
+ | | Color. Use it in combination with <code>\{</code> (e.g. <code>\{C{<em>red</em>}</code>) | ||
+ | |- | ||
+ | ! colspan="2" | Tabskip Keys | ||
+ | |- | ||
+ | | <code>s</code> | ||
+ | | Set the tabskip to the right of this column and of all following columns up to the next <code>s</code> or <code>o</code> key | ||
+ | |- | ||
+ | | <code>o</code> | ||
+ | | Set the tabskip to the right of this column only | ||
+ | |- | ||
+ | |} | ||
+ | |||
+ | === Column definition examples=== | ||
; <code>|l|</code> : a left aligned column, as wide as necessary | ; <code>|l|</code> : a left aligned column, as wide as necessary | ||
; <code>|lw(2cm)|</code> : a left aligned column of at least 2 cm width | ; <code>|lw(2cm)|</code> : a left aligned column of at least 2 cm width | ||
Line 127: | Line 181: | ||
; <code>|cp(.5\textwidth)|</code> : a center aligned paragraph of specified width | ; <code>|cp(.5\textwidth)|</code> : a center aligned paragraph of specified width | ||
; <code>|xp(.5\textwidth)|</code> : a justified paragraph of specified width | ; <code>|xp(.5\textwidth)|</code> : a justified paragraph of specified width | ||
− | |||
− | |||
− | {{ | + | {{todo|add more examples of column definitions}} |
− | |||
==Column Spans== | ==Column Spans== | ||
− | It's possible to create columnspans (i.e. cells that span more than one column) with the command | + | It's possible to create columnspans (i.e., cells that span more than one column) with the command {{cmd|use|{<i>N</i>}}} where ''N'' is the number of columns spanned by the cell. It's often necessary to use {{cmd|ReFormat|[<i>new keys</i>]{}}} to reformat this specific cell according to the ''new keys''. |
Line 146: | Line 197: | ||
\NC \Use{2}[cB]{Spanning head} \SR % slightly shorted | \NC \Use{2}[cB]{Spanning head} \SR % slightly shorted | ||
\HL | \HL | ||
− | \NC left | + | \NC left text \VL right column text \NC \AR |
− | \NC new row | + | \NC new row \VL new row \NC \AR |
− | \NC left | + | \NC left text \VL \ReFormat[l]{reformatted} \NC \AR |
\HL | \HL | ||
\NC \use{2}Spanning entry \SR | \NC \use{2}Spanning entry \SR | ||
Line 156: | Line 207: | ||
</td><td> | </td><td> | ||
<context> | <context> | ||
+ | \setuppapersize[A5] | ||
\starttable[s(0pt)|ls(10pt)|rs(0pt)|] | \starttable[s(0pt)|ls(10pt)|rs(0pt)|] | ||
\HL | \HL | ||
Line 162: | Line 214: | ||
\NC \Use{2}[cB]{Spanning head} \SR | \NC \Use{2}[cB]{Spanning head} \SR | ||
\HL | \HL | ||
− | \NC left | + | \NC left text \VL right column text \NC \AR |
− | \NC new row | + | \NC new row \VL new row \NC \AR |
− | \NC left | + | \NC left text \VL \ReFormat[l]{reformatted} \NC \AR |
\HL | \HL | ||
\NC \use{2}Spanning entry \SR | \NC \use{2}Spanning entry \SR | ||
+ | \HL | ||
+ | \stoptable | ||
+ | </context> | ||
+ | </td></tr></table> | ||
+ | |||
+ | |||
+ | ({{cmd|ReFormat}} can be abbreviated {{cmd|REF}} for brevity.) | ||
+ | |||
+ | == Row Spans== | ||
+ | |||
+ | It's also possible to create rowspans (i.e. cells that span more than one row) with the command {{cmd|Raise|(<i>dimen</i>){<i>content</i>}}} or {{cmd|Lower|(<i>dimen</i>){</i>content</i>}}} that raise or lower ''content'' by ''dimen''. | ||
+ | |||
+ | <table cols="2"><tr valign="top"><td> | ||
+ | <texcode> | ||
+ | \starttable[|c|c|] | ||
+ | \HL | ||
+ | \VL \Lower(.5\lineheight){a} \VL b \VL \AR | ||
+ | \DC \DL[1] \DR | ||
+ | \VL \VL c \VL \AR | ||
+ | \HL | ||
+ | \stoptable | ||
+ | </texcode> | ||
+ | </td><td> | ||
+ | <context> | ||
+ | \starttable[|c|c|] | ||
+ | \HL | ||
+ | \VL \Lower(.5\lineheight){a} \VL b \VL \AR | ||
+ | \DC \DL[1] \DR | ||
+ | \VL \VL c \VL \AR | ||
+ | \HL | ||
+ | \stoptable | ||
+ | </context> | ||
+ | </td></tr></table> | ||
+ | |||
+ | ({{cmd|Lower|(.5\lineheight){a}}} can be abbreviated {{cmd|LOW|{a}}} for brevity.) | ||
+ | |||
+ | An alternative means of spanning rows by a tall object makes use of a bit of TeX magic: | ||
+ | {{cmd|smash|{tall object}}}: | ||
+ | |||
+ | <table cols="2"><tr valign="top"><td> | ||
+ | <texcode> | ||
+ | \starttable[|M|c|] | ||
+ | \HL | ||
+ | \VL \VL a \VL \AR | ||
+ | \DC \DL[1] \DR | ||
+ | \VL \smash{\sum_0^N} \VL b \VL \AR | ||
+ | \DC \DL[1] \DR | ||
+ | \VL \VL c \VL \AR | ||
+ | \HL | ||
+ | \stoptable | ||
+ | </texcode> | ||
+ | </td><td> | ||
+ | <context> | ||
+ | \starttable[|M|c|] | ||
+ | \HL | ||
+ | \VL \VL a \VL \AR | ||
+ | \DC \DL[1] \DR | ||
+ | \VL \smash{\sum_0^N} \VL b \VL \AR | ||
+ | \DC \DL[1] \DR | ||
+ | \VL \VL c \VL \AR | ||
\HL | \HL | ||
\stoptable | \stoptable | ||
Line 182: | Line 294: | ||
* See [[Floating Objects]] in general. | * See [[Floating Objects]] in general. | ||
− | * If you need information about | + | * If you need information about {{cmd|placetable}} look after {{cmd|placefloat}} in the manual or texshow! |
− | * If you | + | * If you do not want a caption for your table, to get rid of it altogether you have to add "none" to settings and then leave the braces empty; if you only leave the braces empty, your table will still be numbered ("Table 1" etc.). |
+ | |||
+ | <texcode> | ||
+ | \placetable[here,none][tab:sample]{}{ | ||
+ | \starttable ... | ||
+ | \stoptable | ||
+ | } | ||
+ | </texcode> | ||
==Background Colors== | ==Background Colors== | ||
+ | |||
+ | Note: Adding color to tables using the `\CL` and `\BL` commands appears to be deprecated in MKIV; see: http://wiki.contextgarden.net/Tabulate | ||
A very nice application in table are background colors for rows/cells (a feature that doesn't work in [[Tabulate]]): | A very nice application in table are background colors for rows/cells (a feature that doesn't work in [[Tabulate]]): | ||
Line 228: | Line 349: | ||
won't cover the whole cell. | won't cover the whole cell. | ||
− | * | + | * {{cmd|BL}} makes a gray background: the optional argument tells BL how many cells it should color |
− | * | + | * {{cmd|CL}} makes a colored row |
==Fit Table Width== | ==Fit Table Width== | ||
Line 245: | Line 366: | ||
</texcode> | </texcode> | ||
<!-- It makes no sense to typeset this here. --> | <!-- It makes no sense to typeset this here. --> | ||
+ | |||
+ | Since the table module has been under [http://www.ntg.nl/pipermail/ntg-context/2010/055004.html reconstruction] this approach works only for MKII. In MKIV one can use | ||
+ | |||
+ | <texcode> | ||
+ | \starttable[|l|l|][textwidth=max] | ||
+ | \HL | ||
+ | \VL foo foo foo foo foo foo \VL bar bar bar bar bar bar \VL\AR | ||
+ | \HL | ||
+ | \stoptable | ||
+ | </texcode> | ||
+ | |||
+ | to change the width of the current table only. | ||
+ | |||
+ | <code>\setuptables[textwidth=...]</code> will affect the behavior of every table. | ||
== Booktabs == | == Booktabs == | ||
− | Latex has an excellent package called booktabs for typesetting tables. The main features of that package is that you can have top, mid, and bottom rules of different thickness. It is possible to achieve similar effects using | + | Latex has an excellent package called booktabs for typesetting tables. The main features of that package is that you can have top, mid, and bottom rules of different thickness. It is possible to achieve similar effects using table. For example, to match the default settings of booktabs (well almost, this gives a top and bottom rules of 0.09em while booktabs sets it to 0.08em). |
<table cols="2"><tr valign="top"><td> | <table cols="2"><tr valign="top"><td> | ||
Line 270: | Line 405: | ||
</td><td> | </td><td> | ||
<context> | <context> | ||
+ | \setuppapersize[A5] | ||
\setuptables[rulethickness=0.03em] | \setuptables[rulethickness=0.03em] | ||
Latest revision as of 15:50, 26 January 2024
< Tables Overview | Tabulate | Tables >
This is ConTeXt's oldest table module. It uses the same formatting as Tabulate (see Tables Overview).
This mode is based on Michael Wichura's TaBlE package for Plain TeX. The official manual for it is commercial (18 USD), see PCTeX -- but note that the TaBlE manual only talks about the original syntax, which does not use \NC, \HL, cum suis.
The only ConTeXt docs are in ConTeXt - an excursion. There are also two introductory articles in TUGboat ConTeXt basics for users: Table macros Table macros II by Aditya Mahajan (2007 and 2008).
Contents
Basic Commands
\starttable[|l|l|] \HL \NC Command \VL Meaning \SR % or \NC\AR \HL \NC \tex{NC} \VL next column \AR \NC \tex{HL} \VL horizontal line \AR \NC \tex{VL} \VL vertical line \AR \NC \tex{NR} \VL next row \LR \HL \NC \tex{SR} \VL single row \AR \NC \tex{FR} \VL first row \AR \NC \tex{MR} \VL middle row \AR \NC \tex{LR} \VL last row \LR % or \NC\AR \HL \NC \tex{AR} \VL automatic row \SR % or \NC\AR \HL \stoptable |
|
- You get vertical lines (rules), if you use \VL instead of \NC.
- Better use \SR, \FR, \MR, \LR instead of \NR.
- You can also use \AR instead of \SR, \FR, \MR and \LR (AR for automatic row).
- You can leave out the \NC before the "row" command, but not if you use \AR in a last or single row (see example).
- You can influence the table with \setuptables.
Column Definition
The table is defined by the template enclosed in square brackets after \starttable. The template has the form
|keys for the first column|keys for the second column|...|keys for the last column|.
Please note that each column is surrounded by | signs. These are necessary. The formatting keys for each column can be a choice of
Key | Meaning |
---|---|
Primitive Keys | |
a{tokens}
|
Adds tokens after the column content
|
b{tokens}
|
Adds tokens before the column content
|
\{
|
Enclose the column in braces (grouping) |
*{n}{keys}
|
Equivalent to repeating the formatting keys keys n times
|
Positioning Keys | |
\LeftGlue
|
Specifies the left glue to be used before the column |
\RightGlue
|
Specifies the right glue to be used after the column |
l
|
left-aligned column |
c
|
centered column |
r
|
right-aligned column |
p(width)
|
Set each cell as a paragraph |
s(width)
|
Specify the inter-column width |
w
|
Set minimum column width |
k
|
Insert a kern both left and right of the column |
i
|
Add a kern to the left of the column |
j
|
Add a kern to the right of the column |
Numeric and Math Item Keys | |
n
|
Numeric item not in math mode |
N
|
Numeric item in math mode |
m
|
Each cell is in (inline) math mode. Equivalent to b$ a$
|
M
|
Each cell is in display math mode. Equivalent to \{b{$\displaystyle}a$}
|
\m
|
Equivalent to 1 l b{{}}m
|
\M
|
Equivalent to 1 l b{{}}M
|
Style Keys | |
f\command
|
Set font according to following command
|
B
|
Bold. Equivalent to f\bf
|
I
|
Italic. Equivalent to f\it
|
S
|
Slanted. Equivalent to f\sl
|
R
|
Roman. Equivalent to f\rm
|
T
|
Teletype. Equivalent to f\tt
|
C
|
Color. Use it in combination with \{ (e.g. \{C{red} )
|
Tabskip Keys | |
s
|
Set the tabskip to the right of this column and of all following columns up to the next s or o key
|
o
|
Set the tabskip to the right of this column only |
Column definition examples
|l|
- a left aligned column, as wide as necessary
|lw(2cm)|
- a left aligned column of at least 2 cm width
|p(2cm)|
- a centered(!) paragraph of 2 cm width
|lp(.5\textwidth)|
- a left aligned paragraph of specified width
|rp(.5\textwidth)|
- a right aligned paragraph of specified width
|cp(.5\textwidth)|
- a center aligned paragraph of specified width
|xp(.5\textwidth)|
- a justified paragraph of specified width
TODO: add more examples of column definitions (See: To-Do List) |
Column Spans
It's possible to create columnspans (i.e., cells that span more than one column) with the command \use{N} where N is the number of columns spanned by the cell. It's often necessary to use \ReFormat[new keys]{} to reformat this specific cell according to the new keys.
\starttable[s(0pt)|ls(10pt)|rs(0pt)|] \HL \NC \use{2}\ReFormat[cB]{Spanning head} \SR \HL \NC \Use{2}[cB]{Spanning head} \SR % slightly shorted \HL \NC left text \VL right column text \NC \AR \NC new row \VL new row \NC \AR \NC left text \VL \ReFormat[l]{reformatted} \NC \AR \HL \NC \use{2}Spanning entry \SR \HL \stoptable |
|
(\ReFormat can be abbreviated \REF for brevity.)
Row Spans
It's also possible to create rowspans (i.e. cells that span more than one row) with the command \Raise(dimen){content} or \Lower(dimen){content} that raise or lower content by dimen.
\starttable[|c|c|] \HL \VL \Lower(.5\lineheight){a} \VL b \VL \AR \DC \DL[1] \DR \VL \VL c \VL \AR \HL \stoptable |
|
(\Lower(.5\lineheight){a} can be abbreviated \LOW{a} for brevity.)
An alternative means of spanning rows by a tall object makes use of a bit of TeX magic: \smash{tall object}:
\starttable[|M|c|] \HL \VL \VL a \VL \AR \DC \DL[1] \DR \VL \smash{\sum_0^N} \VL b \VL \AR \DC \DL[1] \DR \VL \VL c \VL \AR \HL \stoptable |
|
Table as Floating Object
\placetable[here][tab:sample]{sample table}{ \starttable ... \stoptable }
- See Floating Objects in general.
- If you need information about \placetable look after \placefloat in the manual or texshow!
- If you do not want a caption for your table, to get rid of it altogether you have to add "none" to settings and then leave the braces empty; if you only leave the braces empty, your table will still be numbered ("Table 1" etc.).
\placetable[here,none][tab:sample]{}{ \starttable ... \stoptable }
Background Colors
Note: Adding color to tables using the \CL
and \BL
commands appears to be deprecated in MKIV; see: http://wiki.contextgarden.net/Tabulate
A very nice application in table are background colors for rows/cells (a feature that doesn't work in Tabulate):
\setupcolors[state=start] \starttable[|l|l|] \HL \BL[1]\SR \NC Command \NC Meaning \NC\SR \HL \NC \tex{NC} \NC next column \NC\FR \NC \tex{NR} \NC next row \NC\LR \HL \CL[green]\SR \NC \tex{AR} \NC automatic row\NC\SR \HL \stoptable |
|
The commands work something like this: first, you say what background colour you want for the next row and then you typeset the row. Observe: the line with the colour-command and the row it is supposed to colour should end in the same command (i.e. both \SR, \LR, \FR, ...). If they don't, the background won't cover the whole cell.
- \BL makes a gray background: the optional argument tells BL how many cells it should color
- \CL makes a colored row
Fit Table Width
Hans posted a solution to the list for fitting a wide table (with paragraphs and vertical lines) to the page width. The key to his solution is the .45\textwidth
settings when setting each cell as a paragraph.
\SetTableToWidth{\textwidth} \starttable[|p(.45\textwidth)|p(.45\textwidth)|] \HL \VL foo foo foo foo foo foo \VL bar bar bar bar bar bar \VL\AR \HL \stoptable
Since the table module has been under reconstruction this approach works only for MKII. In MKIV one can use
\starttable[|l|l|][textwidth=max] \HL \VL foo foo foo foo foo foo \VL bar bar bar bar bar bar \VL\AR \HL \stoptable
to change the width of the current table only.
\setuptables[textwidth=...]
will affect the behavior of every table.
Booktabs
Latex has an excellent package called booktabs for typesetting tables. The main features of that package is that you can have top, mid, and bottom rules of different thickness. It is possible to achieve similar effects using table. For example, to match the default settings of booktabs (well almost, this gives a top and bottom rules of 0.09em while booktabs sets it to 0.08em).
\setuptables[rulethickness=0.03em] \starttable[s0|l|i2l|i2r|] \HL[3] \NC \Use2[c]{Item} \NC \NC \AR \DL[2] \DC \DR \NC Animal \NC Description \NC Price (\$) \NC \AR \HL[2] \NC Gnat \NC per gram \NC 13.65 \NC \AR \NC \NC each \NC 0.01 \NC \AR \NC Gnu \NC stuffed \NC 92.50 \NC \AR \NC Emu \NC stuffed \NC 33.33 \NC \AR \NC Armadillo \NC frozen \NC 8.99 \NC \AR \HL[3] \stoptable |
|