aboutsummaryrefslogtreecommitdiffstats
path: root/doc/user/tbl_summ
blob: 6fed734a57c46d8d291c60a8274199470ca322b8 (plain) (blame)
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
@Section
    @Title { Summary of options }
    @Tag { tbl_summ }
@Begin
@PP
This summary applies to all @Code "@Tbl" options except the @Code format
options described in Section {@NumberOf tbl_rows}.  Here is the complete
list of these options, one option per line, showing its alternative
spellings, default values (PostScript and PDF, and plain text) from the setup
file, and allowed range of values.  Where one option is indented below
another, it means that the indented option is a specialized version of
the other, which affects its default value.  For more on this see below.
@DP
@Tbl
    marginvertical { 0.5vx }
    aformat { @Cell ml { 0i }               @Code A |
	      @Cell @Code B | @Cell @Code C | @Cell mr { 0i } D }
    bformat { @Cell ml { 0i } indent { 1f } @Code A |
	      @Cell @Code B | @Cell @Code C | @Cell mr { 0i } D }
    cformat { @Cell ml { 0i } indent { 2f } @Code A |
	      @Cell @Code B | @Cell @Code C | @Cell mr { 0i } D }
    dfont { Italic }
    dbreak { lines }
    dformat { @Cell ml { 0i } A | @Cell B | @Cell C | @Cell mr { 0i } D }
    fformat { @StartHSpan @Cell ml { 0i }               @Code A |
	      @HSpan | @HSpan | @Cell mr { 0i } D }
    gformat { @StartHSpan @Cell ml { 0i } indent { 1f } @Code A |
	      @HSpan | @HSpan | @Cell mr { 0i } D }
    hformat { @StartHSpan @Cell ml { 0i } indent { 2f } @Code A |
	      @HSpan | @HSpan | @Cell mr { 0i } D }
{
@Rowd
    A { Option names }
    B { Default in
PS, PDF }
    C { Default in
plain text }
    D { Allowed values }
    rulebelow { yes }
@Rowa
    A { paint  p }
    B { nopaint }
    D { any colour from Section {@NumberOf colour} }
@Rowa
    A { background  bg }
    D { any object }
@Rowa
    A { font  f }
    D { any font e.g. @Code "Helvetica Slope -2p" }
@Rowa
    A { break  b }
    D { any break e.g. @Code "ragged nohyphen" }
@Rowa
    A { width  w }
    D { @Code "expand" or any length e.g. @Code 5c }
@Rowa
    A { height  h }
    D { any length e.g. @Code 3c }
@Rowa
    A { indent  i }
    D { {@Code left}, {@Code ctr}, {@Code mctr}, {@Code right}, or any length }
@Rowa
    A { indentvertical  iv }
    D { {@Code top}, {@Code ctr}, {@Code mctr}, {@Code foot}, or any length }
@Rowa
    A { strut  s }
    B { yes }
    C { yes }
    D { {@Code no}, {@Code yes}, or any length }
@Rowa
    A { struthorizontal  sh }
    B { no }
    C { no }
    D { {@Code no}, {@Code yes}, or any length }
@Rowa
@Rowa
    A { margin  m }
    B { }
    C { }
    D { any length }
@Rowb
    A { marginhorizontal  mh }
    B { 0.6f }
    C { 2s }
    D { any length }
@Rowc
    A { marginleft  ml }
    D { any length }
@Rowc
    A { marginright  mr }
    D { any length }
@Rowb
    A { marginvertical  mv }
    B { 0.3f }
    C { 2f }
    D { any length }
@Rowc
    A { marginabove  ma }
    D { any length }
@Rowc
    A { marginbelow  mb }
    D { any length }
@Rowa
@Rowa
    A { rule  r }
    B { no }
    C { no }
    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
@Rowb
    A { rulehorizontal  rh }
    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
@Rowc
    A { ruleabove  ra }
    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
@Rowc
    A { rulebelow  rb }
    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
@Rowb
    A { rulevertical  rv }
    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
@Rowc
    A { ruleleft  rl }
    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
@Rowc
    A { ruleright  rr }
    D { {@Code no}, {@Code yes}, {@Code single}, or {@Code double} }
@Rowa
@Rowa
    A { rulewidth  rw }
    B { 0.05f }
    D { any length }
@Rowb
    A { rulehorizontalwidth  rhw }
    C { 1f }
    D { any length }
@Rowc
    A { ruleabovewidth  raw }
    D { any length }
@Rowc
    A { rulebelowwidth  rbw }
    D { any length }
@Rowb
    A { ruleverticalwidth  rvw }
    C { 1s }
    D { any length }
@Rowc
    A { ruleleftwidth  rlw }
    D { any length }
@Rowc
    A { rulerightwidth  rrw }
    D { any length }
@Rowa
@Rowa
    A { rulegap  rg }
    B { 0.15f }
    D { any length }
@Rowb
    A { rulehorizontalgap  rhg }
    C { 0f }
    D { any length }
@Rowc
    A { ruleabovegap  rag }
    D { any length }
@Rowc
    A { rulebelowgap  rbg }
    D { any length }
@Rowb
    A { ruleverticalgap  rvg }
    C { 0s }
    D { any length }
@Rowc
    A { ruleleftgap  rlg }
    D { any length }
@Rowc
    A { rulerightgap  rrg }
    D { any length }
@Rowa
@Rowa
    A { rulecolour  rulecolor  rc }
    B { black }
    D { any colour from Section {@NumberOf colour} }
@Rowg
    A { rulehorizontalcolour  rulehorizontalcolor  rhc }
    D { any colour from Section {@NumberOf colour} }
@Rowh
    A { ruleabovecolour  ruleabovecolor  rac }
    D { any colour from Section {@NumberOf colour} }
@Rowh
    A { rulebelowcolour  rulebelowcolor  rbc }
    D { any colour from Section {@NumberOf colour} }
@Rowg
    A { ruleverticalcolour  ruleverticalcolor  rvc }
    D { any colour from Section {@NumberOf colour} }
@Rowh
    A { ruleleftcolour  ruleleftcolor  rlc }
    D { any colour from Section {@NumberOf colour} }
@Rowh
    A { rulerightcolour  rulerightcolor  rrc }
    D { any colour from Section {@NumberOf colour} }
@Rowa
@Rowa
    A { ruleplainchar  rpc }
    C { . }
    D { any simple word e.g. @Code + }
    rulebelow { yes }
}
@DP
There are seven places where these options may be given, counting the
setup file (Section {@NumberOf tbl_setu}).  To make it clear that this
summary applies to any of these options, we illustrate the seven places
with a fictitious option called {@Code option}:
@ID @OneRow @Code @Verbatim {
@Use { @TblSetup
    option { 1 }
}

@Tbl
    option { 2 }
    aoption { 3 }
    aformat { @Cell option { 4 } A }
{
    @Rowa
        option { 5 }
    @Row
        option { 6 }
        format { @Cell option { 7 } A }
}
}
Each occurrence of @Code option is of course optional.  If there are
none, the default value given in the table above applies.  For any other
combination of absent and present options, the value that applies is the
present and relevant one with the largest number in the illustration
just above.  But before applying this rule, any general options must be
thought of as being replaced by their more specialized versions:
@ID @Code "rulehorizontal { yes }"
is equivalent to
@ID @Code @Verbatim {
ruleabove { yes }
rulebelow { yes }
}
for example.  Conflicts are resolved in the logical way:
@ID @Code @Verbatim {
margin { 0.5f }
marginleft { 0.0f }
}
is equivalent to the four specialized options
@ID @Code @Verbatim {
marginabove { 0.5f }
marginbelow { 0.5f }
marginleft { 0.0f }
marginright { 0.5f }
}
General options are really just abbreviations for sets of specialized
options.
@End @Section