summaryrefslogtreecommitdiff
path: root/doc/context/sources/general/manuals/details/details-captiontrickery.tex
blob: ccd163e2022db87c1e082fdbb1e81bd5ccb52662 (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
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
% language=uk

\environment details-environment

\startcomponent details-captiontrickery

\startchapter[title={Caption handling}]

\start

It's hard to predict what kind of caption placements users want. The amount of
variation if large and thereby any system of specifying them will look complex.
So, examples are the best way to show them.

\startbuffer
\setupcaption
  [figure]
  [location=bottom]
\placefigure
  [left]
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\fakewords{60}{80} \par
\stopbuffer

\typebuffer \getbuffer

\startbuffer
% \setupfloats[grid=yes]
% \setupfloats[grid=tolerant]
\setupcaption
  [figure]
  [location=top]
\placefigure
  [left]
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\fakewords{60}{80} \par
\stopbuffer

\typebuffer \getbuffer

In this document we typeset on a grid. For more complex cases and when a document
is processed without any user intervention, this is often a bad idea because the
snapper can decide to make sure that there is enough space above and below an
element. You can however influence the snapper explicitly:

\startbuffer
\setupcaption
  [figure]
  [location=top]
\placefigure
  [left,line]
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\fakewords{60}{80} \par
\stopbuffer

\typebuffer \getbuffer

Normally a side float plus caption has a normalized (strut) depth while also
top skip gets applied. When one of the grid related options \type {height}, \type
{line}, \type {depth}, \type {grid} or \type {halfline} is given the top skip
correction is removed. The \type {grid} option removes the depth too. The \type
{grid} option removes the depth while the \type {height} and \type {depth}
options adds an extra amount of strut depth. The \type {depth} option also adds a
line and \type {halfline} removes a line but adds strut height. Indeed this sounds
complicated so best play with it a bit.

Keep in mind that the snapper plays safe and therefore tends to add more space when
needed. You can set a grid parameter that controls it:

\starttyping
\setupfloats[grid=tolerant]
\stoptyping

Currently this only applies to side floats but in the future we might support it
for regular floats too.

\startbuffer
\setupcaption
  [figure]
  [width=4cm,align=flushright,location={left,high}]
\placefigure
  [left]
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\fakewords{60}{80} \par
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupcaption
  [figure]
  [width=4cm,align=flushright,location={high,lefthanging}]
\placefigure
  [left]
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\fakewords{60}{80} \par
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupcaption
  [figure]
  [width=4cm,align=flushleft,location={high,righthanging}]
\placefigure
  [right]
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\fakewords{60}{80} \par
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupcaption
  [figure]
  [width=4cm,align=flushleft,location={high,rightmargin}]
\placefigure
  [right]
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\fakewords{60}{80} \par
\stopbuffer

\typebuffer \getbuffer

The location of a caption is determined by the keywords \type {top}, \type
{bottom} and for the side captions \type {high}, \type {middle}, \type {low},
either or not in combination with \type {left}, \type {right}, \type
{leftmargin}, \type {rightmargin}, {lefthanging} or \type {righthanging}.

The next series of examples shows the regular (non||side) floats.

\startbuffer
\setupcaption
  [figure]
  [location={high,left}]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupcaption
  [figure]
  [width=4cm,align=flushright,location={high,left}]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupcaption
  [figure]
  [width=4cm,align=flushright,location={middle,left}]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupcaption
  [figure]
  [width=4cm,align=flushright,location={low,left}]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\stopbuffer

\startbuffer
\setupfloat
  [figure]
  [location=right]
\setupcaption
  [figure]
  [width=4cm,align=flushright,location=high]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupfloat
  [figure]
  [location=right]
\setupcaption
  [figure]
  [width=4cm,align=flushright,location={high,left}]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}

\setupfloat
  [figure]
  [location=left]
\setupcaption
  [figure]
  [width=4cm,align=flushleft, location={high,left}]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupfloat
  [figure]
  [location=middle]
\setupcaption
  [figure]
  [width=4cm,align=flushright, location={high,lefthanging}]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupfloat
  [figure]
  [location=middle]
\setupcaption
  [figure]
  [width=4cm,align=flushleft,  location={high,righthanging}]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupfloat
  [figure]
  [location=right]
\setupcaption
  [figure]
  [width=4cm,align=flushleft, location={high,rightmargin}]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupfloat
  [figure]
  [location=left]
\setupcaption
  [figure]
  [width=4cm,align=flushright,location={high,leftmargin}]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupfloat
  [figure]
  [location=middle]
\setupcaption
  [figure]
  [width=4cm,align=flushright,location={high,outermargin}]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\stopbuffer

\typebuffer \getbuffer

\startbuffer
\setupfloat
  [figure]
  [location=middle]
\setupcaption
  [figure]
  [width=4cm,align=flushleft, location={high,innermargin}]
\placefigure
  {}{\externalfigure[dummy][lines=2,width=4cm]}
\stopbuffer

\typebuffer \getbuffer

The \type {innermargin} and \type {outermargin} are special cases. They adapt to
the kind of page.

\page \stop

\stopchapter

\stopcomponent