Difference between revisions of "Command/placefloat"
< Command
Jump to navigation
Jump to search
(Describe more options, add "see also" links) |
(some more information) |
||
Line 42: | Line 42: | ||
<cd:constant type="low">Switch off page footers (for page floats) (?)</cd:constant> | <cd:constant type="low">Switch off page footers (for page floats) (?)</cd:constant> | ||
<cd:constant type="fit">?</cd:constant> | <cd:constant type="fit">?</cd:constant> | ||
− | <cd:constant type="90">Rotation</cd:constant> | + | <cd:constant type="90">Rotation of float and caption</cd:constant> |
− | <cd:constant type="180">Rotation</cd:constant> | + | <cd:constant type="180">Rotation of float and caption</cd:constant> |
− | <cd:constant type="270">Rotation</cd:constant> | + | <cd:constant type="270">Rotation of float and caption</cd:constant> |
<cd:constant type="nonumber">Suppress the float number</cd:constant> | <cd:constant type="nonumber">Suppress the float number</cd:constant> | ||
<cd:constant type="none">Suppress the caption, including the "<i>FLOAT 1</i>" label.</cd:constant> | <cd:constant type="none">Suppress the caption, including the "<i>FLOAT 1</i>" label.</cd:constant> | ||
Line 71: | Line 71: | ||
<cd:constant type="tbrl">Precedence in page columns: top, bottom, right, left</cd:constant> | <cd:constant type="tbrl">Precedence in page columns: top, bottom, right, left</cd:constant> | ||
<cd:constant type="rltb">Precedence in page columns: right, left, top, bottom</cd:constant> | <cd:constant type="rltb">Precedence in page columns: right, left, top, bottom</cd:constant> | ||
− | <cd:constant type="fxtb">?</cd:constant> | + | <cd:constant type="fxtb">Precedence in page columns: top bottom (?)</cd:constant> |
<cd:constant type="btlr">Precedence in page columns</cd:constant> | <cd:constant type="btlr">Precedence in page columns</cd:constant> | ||
<cd:constant type="lrbt">Precedence in page columns</cd:constant> | <cd:constant type="lrbt">Precedence in page columns</cd:constant> | ||
<cd:constant type="btrl">Precedence in page columns</cd:constant> | <cd:constant type="btrl">Precedence in page columns</cd:constant> | ||
<cd:constant type="rlbt">Precedence in page columns</cd:constant> | <cd:constant type="rlbt">Precedence in page columns</cd:constant> | ||
− | <cd:constant type="fxbt">?</cd:constant> | + | <cd:constant type="fxbt">Precedence in page columns: bottom top (?)</cd:constant> |
− | <cd:constant type="fixd">?</cd:constant> | + | <cd:constant type="fixd">Precedence in page columns: force here (?)</cd:constant> |
</cd:keywords> | </cd:keywords> | ||
<cd:keywords list="yes" optional="yes" ordinal="3"> | <cd:keywords list="yes" optional="yes" ordinal="3"> | ||
Line 100: | Line 100: | ||
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage> | <cd:wikipage originator="system" page="Category:Structure"></cd:wikipage> | ||
<cd:commandref name="definefloat"></cd:commandref> | <cd:commandref name="definefloat"></cd:commandref> | ||
− | <cd:commandref name="setupfloat"></cd:commandref></cd:seealso> | + | <cd:commandref name="setupfloat"></cd:commandref> |
+ | <cd:source file="page-cst.lua">Lua functions that control the four-letter placement codes in page floats</cd:source></cd:seealso> | ||
</cd:commandgroup> | </cd:commandgroup> |
Revision as of 13:38, 19 September 2021
Contents
\placefloat
Summary
The command \placefloat is the basis for all float placement commands like \placefigure, \placetable etc.
Settings
\placefloat[...][...,...][...,...]{...}{...} | |
[...] | singular |
[...,...] | split always left right inner outer backspace cutspace inleft inright inmargin leftmargin rightmargin leftedge rightedge innermargin outermargin inneredge outeredge text opposite reset height depth [+-]line halfline grid high low fit 90 180 270 nonumber none local here force margin [+-]hang hanging tall both middle offset top bottom auto page leftpage rightpage somewhere effective header footer tblr lrtb tbrl rltb fxtb btlr lrbt btrl rlbt fxbt fixd |
[...,...] | reference |
{...} | text |
{...} | content |
Option | Explanation |
---|---|
name of the float class, e.g. image, table | |
optional positioning key. There are a great many positioning keys defined, and they can be combined (although not all combinations make sense). | |
split | For tables: may split over pages |
always | Precedence over stored floats |
left | To the left of text |
right | To the right of the text |
inner | In inner margin |
outer | In outer margin |
backspace | ? |
cutspace | ? |
inleft | In left margin |
inright | In right margin |
inmargin | In the margin (left or right) |
leftmargin | In left margin |
rightmargin | In right margin |
leftedge | In left edge area |
rightedge | In right edge area |
innermargin | In inner margin |
outermargin | In outer margin |
inneredge | In inner edge area |
outeredge | In outer edge area |
text | In main text area |
opposite | On the opposite page of a spread |
reset | ? |
height | ? |
depth | ? |
[+-]line | ? |
halfline | ? |
grid | ? |
high | Switch off page headings (for page floats) |
low | Switch off page footers (for page floats) (?) |
fit | ? |
90 | Rotation of float and caption |
180 | Rotation of float and caption |
270 | Rotation of float and caption |
nonumber | Suppress the float number |
none | Suppress the caption, including the "FLOAT 1" label. |
local | ? |
here | Preferably here |
force | Force placement here |
margin | In the margin (margin float) |
[+-]hang | ? |
hanging | ? |
tall | ? |
both | ? |
middle | ? |
offset | ? |
top | At the top of the page |
bottom | At the bottom of the page |
auto | ? |
page | On a new (empty) page |
leftpage | On an empty left page |
rightpage | On an empty right page |
somewhere | ? |
effective | ? |
header | Use header space (combine with "high") |
footer | Use footer space (combine with "low") |
tblr | Precedence in page columns: top, bottom, left, right |
lrtb | Precedence in page columns: left, right, top, bottom |
tbrl | Precedence in page columns: top, bottom, right, left |
rltb | Precedence in page columns: right, left, top, bottom |
fxtb | Precedence in page columns: top bottom (?) |
btlr | Precedence in page columns |
lrbt | Precedence in page columns |
btrl | Precedence in page columns |
rlbt | Precedence in page columns |
fxbt | Precedence in page columns: bottom top (?) |
fixd | Precedence in page columns: force here (?) |
optional reference label | |
caption content | |
{...} | float content |
Description
Examples
Notes
See also
- strc-flt.mkvi
- Floating_Objects
- \definefloat
- \setupfloat
- page-cst.lua Lua functions that control the four-letter placement codes in page floats