Imported Upstream version 1.22.4
[platform/upstream/groff.git] / contrib / hdtbl / examples / short_reference.roff
1 .ig
2
3 short_reference.roff
4
5 This file is part of groff, the GNU roff type-setting system.
6
7 Copyright (C) 2005-2018 Free Software Foundation, Inc.
8 written by Joachim Walsdorff <Joachim.Walsdorff@urz.uni-heidelberg.de>.
9
10 groff is free software; you can redistribute it and/or modify it under
11 the terms of the GNU General Public License as published by the Free
12 Software Foundation, either version 3 of the License, or
13 (at your option) any later version.
14
15 groff is distributed in the hope that it will be useful, but WITHOUT
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
18 for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
23 ..
24 .
25 .if !d sopath \
26 .  ds sopath
27 .
28 .so \*[sopath]examples/common.roff
29 .
30 .t*pv 1.2 1.2 "" x
31 .H Short Reference for the HDtbl-Macros
32 This Short Reference describes the Heidelberger Table Macros
33 using the macros themselves.
34 .br
35 .nr t*csp .3n
36 .nr t*cpd .3n
37 .ds t*ff HN
38 .ds t*val m
39 .ds t*hal l
40 .xig
41 .TBL "width=10% 40% 25% 25%" border= "fsz=1 .8"
42 .CPTN Base- Optional- and Utility-Macros val=b
43 .TR
44 .TH Macro .TH Description .TH Predecessors .TH Successors 
45 .TR 
46 .TD \&.TBL .TD Begin a new table .TD \&.TD \&.TH \%.ETB cell content
47 .TD \&.CPTN \&.TR 
48 .TR 
49 .TD \&.CPTN .TD Optional numbered or unnumbered table caption
50 .TD \&.TBL .TD \&.TR 
51 .TR
52 .TD \&.TR .TD Begin a new table row .TD \&.TBL \&.CPTN cell content
53 .TD \&.TD \&.TR
54 .TR
55 .TD \&.TH .TD Optional begin table header cell 
56 .TD \&.TR \&.TD \&.TH \%.ETB cell content
57 .TD \&.TD \&.TH \&.TR \%.ETB cell content
58 .TR 
59 .TD \&.TD .TD Begin table data cell .TD \&.TR \&.TD \&.TH \%.ETB cell content
60 .TD \&.TD \&.TH \&.TR \%.ETB cell content
61 .TR 
62 .TD \&.ETB .TD Finish and print table .TD \&.TD \&.TH \%.ETB cell content
63 .TD \&.TBL \&.TR \&.TD \&.TH \%.ETB cell content
64 .TR
65 .TD \&.t*free 
66 .TD colspan=3 val=t Utility macro to free held tables. Use it outside any table.
67 .ETB
68 .bp
69 .x.
70 .TBL "fsz=1 .8" "width=20% 32% 8% 8% 8% 8% 8% 8%" border=
71 .TR
72 .TH Argument .TH Value .TH \&.TBL .TH \&.CPT .TH \&.TR .TH \&.TH .TH \&.TD .TH \&.ETB
73 .TR 
74 .TD border=\fI[n]\fP 
75 .TD border thickness .TD .ce X .TD .TD .TD .TD .TD
76 .TR
77 .TD bc=\fI[c]\fP 
78 .TD color of border and cellseperatorlines .TD .ce X .TD .TD .ce X .TD .ce X .TD .ce X .TD
79 .ETB
80 .H ------ incomplete -------
81 .
82 .\" ====================================================================
83 .\" Editor settings
84 .\" ====================================================================
85 .
86 .\" Local Variables:
87 .\" mode: nroff
88 .\" fill-column: 72
89 .\" End:
90 .\" vim: set filetype=groff textwidth=72: