Difference between revisions of "Command/setupfloat"
< Command
Jump to navigation
Jump to search
m (fix links) |
(explain some placement options) |
||
Line 8: | Line 8: | ||
<cd:keywords list="yes" optional="yes" ordinal="1"> | <cd:keywords list="yes" optional="yes" ordinal="1"> | ||
<cd:keywordsdoc>name of the defined float</cd:keywordsdoc> | <cd:keywordsdoc>name of the defined float</cd:keywordsdoc> | ||
− | <cd:constant type="cd:singular"></cd:constant> | + | <cd:constant type="cd:singular">figure/graphic/table/intermezzo</cd:constant> |
</cd:keywords> | </cd:keywords> | ||
<cd:assignments list="yes" ordinal="2"> | <cd:assignments list="yes" ordinal="2"> | ||
<cd:assignmentsdoc></cd:assignmentsdoc> | <cd:assignmentsdoc></cd:assignmentsdoc> | ||
<cd:parameter name="indentnext"> | <cd:parameter name="indentnext"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>indentation of following text line</cd:paramdoc> |
<cd:constant type="yes"></cd:constant> | <cd:constant type="yes"></cd:constant> | ||
<cd:constant type="no"></cd:constant> | <cd:constant type="no"></cd:constant> | ||
Line 77: | Line 77: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="minwidth"> | <cd:parameter name="minwidth"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>minimal width</cd:paramdoc> |
<cd:constant type="cd:dimension"></cd:constant> | <cd:constant type="cd:dimension"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="maxwidth"> | <cd:parameter name="maxwidth"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>maximal width</cd:paramdoc> |
<cd:constant type="cd:dimension"></cd:constant> | <cd:constant type="cd:dimension"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="location"> | <cd:parameter name="location"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>placement (there are even more options!)</cd:paramdoc> |
− | <cd:constant type="left"></cd:constant> | + | <cd:constant type="left">left of text</cd:constant> |
− | <cd:constant type="right"></cd:constant> | + | <cd:constant type="right">right of text</cd:constant> |
<cd:constant type="middle"></cd:constant> | <cd:constant type="middle"></cd:constant> | ||
− | <cd:constant type="flushleft"></cd:constant> | + | <cd:constant type="flushleft">left of text</cd:constant> |
− | <cd:constant type="flushright"></cd:constant> | + | <cd:constant type="flushright">right of text</cd:constant> |
<cd:constant type="center"></cd:constant> | <cd:constant type="center"></cd:constant> | ||
<cd:constant type="max"></cd:constant> | <cd:constant type="max"></cd:constant> | ||
− | <cd:constant type="inner"></cd:constant> | + | <cd:constant type="inner">beside text, spine direction (left)</cd:constant> |
− | <cd:constant type="outer"></cd:constant> | + | <cd:constant type="outer">beside text, outer edge direction (right)</cd:constant> |
− | <cd:constant type="innermargin"></cd:constant> | + | <cd:constant type="innermargin">in inner (left) margin</cd:constant> |
− | <cd:constant type="outermargin"></cd:constant> | + | <cd:constant type="outermargin">in outer (right) margin</cd:constant> |
− | <cd:constant type="inneredge"></cd:constant> | + | <cd:constant type="inneredge">in inner edge area</cd:constant> |
− | <cd:constant type="outeredge"></cd:constant> | + | <cd:constant type="outeredge">in outer edge area</cd:constant> |
− | <cd:constant type="backspace"></cd:constant> | + | <cd:constant type="backspace">spine direction (left)</cd:constant> |
− | <cd:constant type="cutspace"></cd:constant> | + | <cd:constant type="cutspace">outer edge direction (right)</cd:constant> |
− | <cd:constant type="leftmargin"></cd:constant> | + | <cd:constant type="leftmargin">in left margin</cd:constant> |
− | <cd:constant type="rightmargin"></cd:constant> | + | <cd:constant type="rightmargin">in right margin</cd:constant> |
− | <cd:constant type="leftedge"></cd:constant> | + | <cd:constant type="leftedge">in left edge area</cd:constant> |
− | <cd:constant type="rightedge"></cd:constant> | + | <cd:constant type="rightedge">in right edge area</cd:constant> |
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="leftmargindistance"> | <cd:parameter name="leftmargindistance"> | ||
Line 174: | Line 174: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="width"> | <cd:parameter name="width"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>fixed width</cd:paramdoc> |
<cd:constant type="cd:dimension"></cd:constant> | <cd:constant type="cd:dimension"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="height"> | <cd:parameter name="height"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>fixed height</cd:paramdoc> |
<cd:constant type="cd:dimension"></cd:constant> | <cd:constant type="cd:dimension"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
Line 237: | Line 237: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="cache"> | <cd:parameter name="cache"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>re-use image(?)</cd:paramdoc> |
<cd:constant default="yes" type="yes"></cd:constant> | <cd:constant default="yes" type="yes"></cd:constant> | ||
<cd:constant type="no"></cd:constant> | <cd:constant type="no"></cd:constant> |
Latest revision as of 17:36, 11 June 2023
Contents
\setupfloat
Summary
The command \setupfloat configures floating objects
Settings
\setupfloat[...,...][...=...,...] | |
[...,...] | singular |
indentnext | yes no auto |
default | see \placefloat |
fallback | see \placefloat |
inner | command |
criterium | dimension |
method | number |
sidemethod | number |
textmethod | number |
sidealign | height depth line halfline grid normal |
grid | see \snaptogrid |
local | yes no |
command | oneargument |
availablewidth | dimension |
availableheight | dimension |
minwidth | dimension |
maxwidth | dimension |
location | left right middle flushleft flushright center max inner outer innermargin outermargin inneredge outeredge backspace cutspace leftmargin rightmargin leftedge rightedge |
leftmargindistance | dimension |
rightmargindistance | dimension |
leftmargin | dimension |
rightmargin | dimension |
innermargin | dimension |
outermargin | dimension |
bottombefore | command |
bottomafter | command |
expansion | yes no xml |
referenceprefix | + - text |
xmlsetup | name |
catcodes | name |
freeregion | yes no |
spacebefore | none see \blank |
spaceafter | none see \blank |
width | dimension |
height | dimension |
offset | dimension none overlay |
sidespacebefore | none see \blank |
sidespaceafter | none see \blank |
spacebeforeside | none see \blank |
spaceafterside | none see \blank |
sidethreshold | old dimension |
margin | dimension |
ntop | number |
nbottom | number |
step | small medium big line depth |
nlines | number |
cache | yes no |
compress | yes no |
compressdistance | dimension |
...=...,... | inherits from \setupframed |
Option | Explanation | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name of the defined float | |||||||||||||||||||||||||||||||||||
singular | figure/graphic/table/intermezzo | ||||||||||||||||||||||||||||||||||
indentnext |
| ||||||||||||||||||||||||||||||||||
criterium |
| ||||||||||||||||||||||||||||||||||
minwidth |
| ||||||||||||||||||||||||||||||||||
maxwidth |
| ||||||||||||||||||||||||||||||||||
location |
| ||||||||||||||||||||||||||||||||||
width |
| ||||||||||||||||||||||||||||||||||
height |
| ||||||||||||||||||||||||||||||||||
cache |
|
Description
Configures various float settings. For a previously defined specific float type (with \definefloat), use the first argument to enter its name.
Examples
Example 1
\setupfloat[table][default={here,split}] \setupxtable[frame=off,split=yes,header=repeat,footer=repeat] \setupxtable[head][topframe=on,bottomframe=on] \setupxtable[body][] \setupxtable[foot][bottomframe=on] \starttext \startplacetable[title={Average Annual Temperatures}] \startxtable \startxtablehead[head] \startxrow \startxcell[align=middle,width={0.10\textwidth}] Year \stopxcell \startxcell[align=middle,width={0.14\textwidth}] Value \stopxcell \stopxrow \stopxtablehead \startxtablebody[body] \dorecurse{100}{% \startxrow \startxcell[align=middle,width={0.10\textwidth}] 1880 \stopxcell \startxcell[align=middle,width={0.14\textwidth}] 0.1146 \stopxcell \stopxrow} \stopxtablebody \startxtablefoot[foot] \startxrow \startxcell[align=middle,width={0.10\textwidth}] 2018 \stopxcell \startxcell[align=middle,width={0.14\textwidth}] 1.014 \stopxcell \stopxrow \stopxtablefoot \stopxtable \stopplacetable \stoptext