summaryrefslogtreecommitdiff
path: root/contrib/hdtbl/examples/short_reference.roff
blob: 6dba90ad13502955bdb34f958935ff61e5a8bb12 (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
.\" -*- mode: roff -*-
.ig

short_reference.roff

This file is part of groff, the GNU roff type-setting system.

Copyright (C) 2005, 2006 Free Software Foundation, Inc.
written by Joachim Walsdorff <Joachim.Walsdorff@urz.uni-heidelberg.de>.

groff is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.

groff is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with groff; see the file COPYING.  If not, write to the Free
Software Foundation, 51 Franklin St - Fifth Floor, Boston, MA
02110-1301, USA.

..
.
.time start
.pv 1.2 1.2 "" x
.H Short Reference for the HDtbl-Macros
This Short Reference shortly describes the Heidelberger Table Macros
using these macros themselves.
.br
.nr t*csp .3n
.nr t*cpd .3n
.ds t*ff HN
.ds t*val m
.ds t*hal l
.xig
.TBL "width=10% 40% 25% 25%" border= "fsz=1 .8"
.CPTN Base- Optional- and Utility-Macros val=b
.TR
.TH Macro .TH Description .TH Predecessors .TH Successors 
.TR 
.TD \&.TBL .TD Begin a new table .TD \&.TD \&.TH \%.ETB cellcontent
.TD \&.CPTN \&.TR 
.TR 
.TD \&.CPTN .TD Optional numbered or unnumbered table caption
.TD \&.TBL .TD \&.TR 
.TR
.TD \&.TR .TD Begin a new table row .TD \&.TBL \&.CPTN cellcontent
.TD \&.TD \&.TR
.TR
.TD \&.TH .TD Optional begin table header cell 
.TD \&.TR \&.TD \&.TH \%.ETB cellcontent
.TD \&.TD \&.TH \&.TR \%.ETB cellcontent
.TR 
.TD \&.TH .TD Begin table data cell .TD \&.TR \&.TD \&.TH \%.ETB cellcontent
.TD \&.TD \&.TH \&.TR \%.ETB cellcontent
.TR 
.TD \&.ETB .TD Finish and pront table. .TD \&.TD \&.TH \%.ETB cellcontent
.TD \&.TBL \&.TR \&.TD \&.TH \%.ETB cellcontent
.TR
.TD \&.t*free 
.TD colspan=3 val=t Utility macro to free held tables. Use it outside any table.
.ETB
.bp
.x.
.TBL "fsz=1 .8" "width=20% 32% 8% 8% 8% 8% 8% 8%" border=
.TR
.TH Argument .TH Value .TH \&.TBL .TH \&.CPT .TH \&.TR .TH \&.TH .TH \&.TD .TH \&.ETB
.TR 
.TD border=\fI[n]\fP 
.TD border thickness .TD .ce X .TD .TD .TD .TD .TD
.TR
.TD bc=\fI[c]\fP 
.TD color of border and cellseperatorlines .TD .ce X .TD .TD .ce X .TD .ce X .TD .ce X .TD
.ETB
.H ------ incomplete -------
.time end