1@Section
2    @Title { Summary of options }
3    @Tag { tbl_summ }
4@Begin
5@PP
6This summary applies to all @Code "@Tbl" options except the @Code format
7tables. @RawIndex { tables }
8tables.summary @SubIndex { summary of all options }
9options described in Section {@NumberOf tbl_rows}.  Here is the complete
10list of these options, one option per line, showing its alternative
11spellings, default values (PostScript and PDF, and plain text) from the setup
12file, and allowed range of values.  Where one option is indented below
13another, it means that the indented option is a specialized version of
14the other, which affects its default value.  For more on this see below.
15@DP
16@Tbl
17    marginvertical { 0.5vx }
18    aformat { @Cell ml { 0i }               @Code A |
19	      @Cell @Code B | @Cell @Code C | @Cell mr { 0i } D }
20    bformat { @Cell ml { 0i } indent { 1f } @Code A |
21	      @Cell @Code B | @Cell @Code C | @Cell mr { 0i } D }
22    cformat { @Cell ml { 0i } indent { 2f } @Code A |
23	      @Cell @Code B | @Cell @Code C | @Cell mr { 0i } D }
24    dfont { Italic }
25    dbreak { lines }
26    dformat { @Cell ml { 0i } A | @Cell B | @Cell C | @Cell mr { 0i } D }
27    fformat { @StartHSpan @Cell ml { 0i }               @Code A |
28	      @HSpan | @HSpan | @Cell mr { 0i } D }
29    gformat { @StartHSpan @Cell ml { 0i } indent { 1f } @Code A |
30	      @HSpan | @HSpan | @Cell mr { 0i } D }
31    hformat { @StartHSpan @Cell ml { 0i } indent { 2f } @Code A |
32	      @HSpan | @HSpan | @Cell mr { 0i } D }
33{
34@Rowd
35    A { Option names }
36    B { Default in
37PS, PDF }
38    C { Default in
39plain text }
40    D { Allowed values }
41    rulebelow { yes }
42@HeaderRowd
43    A { Option names (ctd.) }
44    B { Default in
45PS, PDF }
46    C { Default in
47plain text }
48    D { Allowed values }
49    rulebelow { yes }
50@Rowa
51    A { paint  p }
52    B { none }
53    D { any colour from Section {@NumberOf colour} }
54@Rowa
55    A { texture  t }
56    B { solid }
57    D { any texture from Section {@NumberOf textures} }
58@Rowa
59    A { background  bg }
60    D { any object }
61@Rowa
62    A { font  f }
63    D { any font e.g. @Code "Helvetica Slope -2p" }
64@Rowa
65    A { break  b }
66    D { any break e.g. @Code "ragged nohyphen" }
67@Rowa
68    A { width  w }
69    D { @Code "expand" or any length e.g. @Code 5c }
70@Rowa
71    A { height  h }
72    D { any length e.g. @Code 3c }
73@Rowa
74    A { indent  i }
75    B { @Code left }
76    D { {@Code left}, {@Code ctr}, {@Code align}, {@Code mctr}, {@Code right}, or any length }
77@Rowa
78    A { indentvertical  iv }
79    B { @Code top }
80    D { {@Code top}, {@Code ctr}, {@Code align}, {@Code mctr}, {@Code foot}, or any length }
81@Rowa
82    A { strut  s }
83    B { yes }
84    C { yes }
85    D { {@Code no}, {@Code yes}, or any length }
86@Rowa
87    A { struthorizontal  sh }
88    B { no }
89    C { no }
90    D { {@Code no}, {@Code yes}, or any length }
91@Rowa
92    ma { 1v }
93    A { margin  m }
94    B { }
95    C { }
96    D { any length }
97@Rowb
98    A { marginhorizontal  mh }
99    B { 0.6f }
100    C { 2s }
101    D { any length }
102@Rowc
103    A { marginleft  ml }
104    D { any length }
105@Rowc
106    A { marginright  mr }
107    D { any length }
108@Rowb
109    A { marginvertical  mv }
110    B { 0.3f }
111    C { 2f }
112    D { any length }
113@Rowc
114    A { marginabove  ma }
115    D { any length }
116@Rowc
117    A { marginbelow  mb }
118    D { any length }
119@Rowa
120    ma { 1v }
121    A { rule  r }
122    B { no }
123    C { no }
124    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
125@Rowb
126    A { rulehorizontal  rh }
127    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
128@Rowc
129    A { ruleabove  ra }
130    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
131@Rowc
132    A { rulebelow  rb }
133    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
134@Rowb
135    A { rulevertical  rv }
136    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
137@Rowc
138    A { ruleleft  rl }
139    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
140@Rowc
141    A { ruleright  rr }
142    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
143@Rowa
144    ma { 1v }
145    A { rulewidth  rw }
146    B { 0.05f }
147    D { any length }
148@Rowb
149    A { rulehorizontalwidth  rhw }
150    C { 1f }
151    D { any length }
152@Rowc
153    A { ruleabovewidth  raw }
154    D { any length }
155@Rowc
156    A { rulebelowwidth  rbw }
157    D { any length }
158@Rowb
159    A { ruleverticalwidth  rvw }
160    C { 1s }
161    D { any length }
162@Rowc
163    A { ruleleftwidth  rlw }
164    D { any length }
165@Rowc
166    A { rulerightwidth  rrw }
167    D { any length }
168@Rowa
169    ma { 1v }
170    A { rulegap  rg }
171    B { 0.15f }
172    D { any length }
173@Rowb
174    A { rulehorizontalgap  rhg }
175    C { 0f }
176    D { any length }
177@Rowc
178    A { ruleabovegap  rag }
179    D { any length }
180@Rowc
181    A { rulebelowgap  rbg }
182    D { any length }
183@Rowb
184    A { ruleverticalgap  rvg }
185    C { 0s }
186    D { any length }
187@Rowc
188    A { ruleleftgap  rlg }
189    D { any length }
190@Rowc
191    A { rulerightgap  rrg }
192    D { any length }
193@Rowa
194    ma { 1v }
195    A { rulecolour  rulecolor  rc }
196    B { black }
197    D { any colour from Section {@NumberOf colour} }
198@Rowg
199    A { rulehorizontalcolour  rulehorizontalcolor  rhc }
200    D { any colour from Section {@NumberOf colour} }
201@Rowh
202    A { ruleabovecolour  ruleabovecolor  rac }
203    D { any colour from Section {@NumberOf colour} }
204@Rowh
205    A { rulebelowcolour  rulebelowcolor  rbc }
206    D { any colour from Section {@NumberOf colour} }
207@Rowg
208    A { ruleverticalcolour  ruleverticalcolor  rvc }
209    D { any colour from Section {@NumberOf colour} }
210@Rowh
211    A { ruleleftcolour  ruleleftcolor  rlc }
212    D { any colour from Section {@NumberOf colour} }
213@Rowh
214    A { rulerightcolour  rulerightcolor  rrc }
215    D { any colour from Section {@NumberOf colour} }
216@Rowa
217    ma { 1v }
218    A { ruleplainchar  rpc }
219    C { . }
220    D { any simple word e.g. @Code + }
221    rulebelow { yes }
222@EndHeaderRow
223}
224@DP
225There are seven places where these options may be given, counting the
226setup file (Section {@NumberOf tbl_setu}).  To make it clear that this
227summary applies to any of these options, we illustrate the seven places
228with a fictitious option called {@Code option}:
229@ID @OneRow @Code @Verbatim {
230@Use { @TblSetup
231    option { 1 }
232}
233
234@Tbl
235    option { 2 }
236    aoption { 3 }
237    aformat { @Cell option { 4 } A }
238{
239    @Rowa
240        option { 5 }
241    @Row
242        option { 6 }
243        format { @Cell option { 7 } A }
244}
245}
246Each occurrence of @Code option is of course optional.  If there are
247none, the default value given in the table above applies.  For any other
248combination of absent and present options, the value that applies is the
249present and relevant one with the largest number in the illustration
250just above.  But before applying this rule, any general options must be
251thought of as being replaced by their more specialized versions:
252@ID @Code "rulehorizontal { yes }"
253is equivalent to
254@ID @Code @Verbatim {
255ruleabove { yes }
256rulebelow { yes }
257}
258for example.  Conflicts are resolved in the logical way:
259@ID @Code @Verbatim {
260margin { 0.5f }
261marginleft { 0.0f }
262}
263is equivalent to the four specialized options
264@ID @Code @Verbatim {
265marginabove { 0.5f }
266marginbelow { 0.5f }
267marginleft { 0.0f }
268marginright { 0.5f }
269}
270General options are really just abbreviations for sets of specialized
271options.
272@End @Section
273