NAME<\/a> groff_hdtbl \u2212 Heidelberger table macros for GNU roff<\/p>\n The hdtbl<\/b> macros consist of four base and three optional macros, controlled by about twenty arguments. The syntax is simple and similar to the HTML<\/b> table model and nearly as flexible: You can write sequences of tokens (macro calls with their arguments and content data), separated by blanks and beginning with a macro call, into the same line to get compact and cleanly arrranged input. An advantage of hdtbl<\/b> is that the tables are constructed without calling a preprocessor; this means that groff<\/b>\u2019s full macro capabilities are available. On the other hand, table processing with hdtbl<\/b> is much slower than using the tbl<\/b>(1) preprocessor. A further advantage is that the HTML-like syntax of hdtbl<\/b> will be easily converted to HTML; this is not implemented yet.<\/p>\n In this and the next section, we present examples to help users understand the basic workflow of hdtbl<\/b>. First of all, you must load the hdtbl.tmac<\/i> file. As with nearly all other groff macro packages, there are two possibilities to do so: Either add the line<\/p>\n .mso hdtbl.tmac<\/p>\n to your roff<\/i> file before using any macros of the hdtbl<\/b> package, or add the option<\/p>\n \u2212m hdtbl<\/p>\n to the command line of groff (before the document file which contains hdtbl<\/b> macros). Then you can include on or more tables in your document, where each one must be started and ended with the .TBL and .ETB macros, respectively.<\/p>\n In this man page, we approximate the result of each example in the tty<\/i> format to be as generic as possible since hdtbl<\/b> currently only supports the PS and PDF output devices.<\/p>\n The simplest well-formed table consists of just single calls to the four base table macros in the right order. Here we construct a table with only one cell.<\/p>\n .TBL A tty<\/i> representation is<\/p>\n +——————————————————+ Equivalent to the above is the following notation.<\/p>\n .TBL .TR .TD “contents of the table cell<\/i>” .ETB<\/p>\n By default, the formatted table is inserted into the surrounding text at the place of its definition. If the vertical space isn\u2019t sufficient, it is placed at the top of the next page. Tables can also be stored for later insertion.<\/p>\n Using \u2018row-number<\/i>*column-number<\/i>\u2019 as the data for the table cells, a table with two rows and two columns can be written as<\/p>\n .TBL cols=2 A tty<\/i> representation is<\/p>\n +————————–+—————————+ Here we see a difference from HTML tables: The number of columns must be explicitly specified using the \u2018cols=m<\/i>\u2019 argument (or indirectly via the \u2018width\u2019 argument, see below).<\/p>\n The contents of a table cell is arbitrary; for example, it can be another table, without restriction to the nesting depth. A given table layout can be either constructed with suitably nested tables or with proper arguments to .TD and .TH, controlling column and row spanning. Note, however, that this table<\/p>\n .TBL and this table<\/p>\n .TBL cols=2 are similar but not identical (the use of .nop is purely cosmetic to get proper indentation).<\/p>\n The first table looks like<\/p>\n +——————————————————+ and the second one like<\/p>\n +——————————————————+ Here the latter table in a more compact form.<\/p>\n .TBL cols=2 .TR “.TD colspan=2” 1*1 1*2 If a macro has one or more arguments (see below), and it is not starting a line, everything belonging to this macro including the macro itself must be enclosed in double quotes.<\/p>\n The order of macro calls and other tokens follows the HTML model. In the following list, valid predecessors and successors of all hdtbl<\/b> macros are given, together with the possible arguments.<\/p>\n Macro arguments are separated by blanks. The order of arguments is arbitrary; they are of the form<\/p>\n key=value<\/i><\/p>\n or<\/p>\n key=’value1<\/i> [value2<\/i> […]]’<\/p>\n with the only exception of the optional argument of the macro .ETB, which is the string \u2018hold\u2019. Another possible form is<\/p>\n “key=value1<\/i> [value2<\/i> […]]”<\/p>\n However, this is limited to the case where the macro is the first one in the line and not already enclosed in double quotes.<\/p>\n Argument values specified below as\u00a0c<\/i> are colors predefined by groff<\/b> or colors defined by the user with the .defcolor request. Argument values\u00a0d<\/i> are decimal numbers with or without decimal point. Argument values\u00a0m<\/i> are natural numbers. Argument values\u00a0n<\/i> are numerical values with the usual groff<\/b> scaling indicators. Some of the arguments are specific to one or two macros, but most of them can be specified with .TBL, .TR, .TD, and .TH. These common arguments are explained in the next subsection.<\/p>\n Most of the argument default values can be changed by the user by setting corresponding default registers or strings, as listed below. Begin a new table.<\/p>\n predecessor:<\/b> .TD, .TH, .ETB, cell contents border=[n<\/i>]<\/p>\n Thickness of the surrounding box border. \u2018border=\u2019 (no value) means neither a surrounding box border nor any horizontal or vertical separator lines between the table rows and cells. \u2018border=0\u2019 suppresses the surrounding box border, but still allows separator lines between cells and rows.
DESCRIPTION<\/a>
USAGE<\/a>
MACROS AND ARGUMENTS<\/a>
HDTBL CUSTOMIZATION<\/a>
BUGS AND SUGGESTIONS<\/a>
AUTHORS<\/a>
SEE ALSO<\/a> <\/p>\n
\nNAME <\/a> <\/h2>\n
DESCRIPTION <\/a> <\/h2>\n
USAGE <\/a> <\/h2>\n
.TR
.TD
contents of the table cell<\/i>
.ETB<\/p>\n
| contents-of-the-table-cell |
+——————————————————+<\/p>\n
. TR .TD 1*1 .TD 1*2
. TR .TD 2*1 .TD 2*2
.ETB<\/p>\n
| 1*1 | 1*2 |
+————————–+—————————+
| 2*1 | 2*2 |
+————————–+—————————+<\/p>\n
. TR
. TD
. nop 1*1 1*2
. TR
. TD
. TBL cols=2 border=
. TR
. TD
. nop 2*1
. TD
. nop 2*2
. ETB
.ETB<\/p>\n
. TR
. TD colspan=2
. nop 1*1 1*2
. TR
. TD
. nop 2*1
. TD
. nop 2*2
.ETB<\/p>\n
| 1*1 1*2 |
+——————————————————+
| |
| 2*1 2*2 |
| |
+——————————————————+<\/p>\n
| 1*1 1*2 |
+—————————+————————–+
| 2*1 | 2*2 |
+—————————+————————–+<\/p>\n
. TR .TD 2*1 .TD 2*2 .ETB<\/p>\nMACROS AND ARGUMENTS <\/a> <\/h2>\n
.TBL<\/b> [args<\/i>]<\/p>\n
successor:<\/b> .CPTN, .TR
arguments:<\/b><\/p>\n
Default:<\/b> \u2018border=.1n\u2019 (register \u2018t*b\u2019).<\/p>\n