Difference between revisions of "Command/placefloat"
< Command
Jump to navigation
Jump to search
(Describe more options, add "see also" links) |
|||
Line 1: | Line 1: | ||
− | |||
− | |||
<cd:commandgroup name="placefloat" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807"> | <cd:commandgroup name="placefloat" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807"> | ||
− | <cd:shortdesc> | + | <cd:shortdesc><!-- a short command summary goes here --> |
− | <!-- a short command summary goes here --> | + | The command <tt>\placefloat</tt> is the basis for all float placement commands like {{cmd|placefigure}}, {{cmd|placetable}} etc. |
− | The command <tt>\placefloat</tt> is | ||
</cd:shortdesc> | </cd:shortdesc> | ||
<cd:variants> | <cd:variants> | ||
Line 10: | Line 7: | ||
<cd:arguments> | <cd:arguments> | ||
<cd:keywords ordinal="1"> | <cd:keywords ordinal="1"> | ||
− | <cd:keywordsdoc></cd:keywordsdoc> | + | <cd:keywordsdoc>name of the float class, e.g. image, table</cd:keywordsdoc> |
<cd:constant type="cd:singular"></cd:constant> | <cd:constant type="cd:singular"></cd:constant> | ||
</cd:keywords> | </cd:keywords> | ||
<cd:keywords list="yes" optional="yes" ordinal="2"> | <cd:keywords list="yes" optional="yes" ordinal="2"> | ||
<cd:keywordsdoc>optional positioning key. There are a great many positioning keys defined, and they can be combined (although not all combinations make sense).</cd:keywordsdoc> | <cd:keywordsdoc>optional positioning key. There are a great many positioning keys defined, and they can be combined (although not all combinations make sense).</cd:keywordsdoc> | ||
− | <cd:constant type="split"></cd:constant> | + | <cd:constant type="split">For tables: may split over pages</cd:constant> |
− | <cd:constant type="always"> | + | <cd:constant type="always">Precedence over stored floats</cd:constant> |
<cd:constant type="left">To the left of text</cd:constant> | <cd:constant type="left">To the left of text</cd:constant> | ||
<cd:constant type="right">To the right of the text</cd:constant> | <cd:constant type="right">To the right of the text</cd:constant> | ||
− | <cd:constant type="inner"></cd:constant> | + | <cd:constant type="inner">In inner margin</cd:constant> |
− | <cd:constant type="outer"></cd:constant> | + | <cd:constant type="outer">In outer margin</cd:constant> |
− | <cd:constant type="backspace"></cd:constant> | + | <cd:constant type="backspace">?</cd:constant> |
− | <cd:constant type="cutspace"></cd:constant> | + | <cd:constant type="cutspace">?</cd:constant> |
<cd:constant type="inleft">In left margin</cd:constant> | <cd:constant type="inleft">In left margin</cd:constant> | ||
<cd:constant type="inright">In right margin</cd:constant> | <cd:constant type="inright">In right margin</cd:constant> | ||
<cd:constant type="inmargin">In the margin (left or right)</cd:constant> | <cd:constant type="inmargin">In the margin (left or 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:constant type="innermargin"></cd:constant> | + | <cd:constant type="innermargin">In inner margin</cd:constant> |
− | <cd:constant type="outermargin"></cd:constant> | + | <cd:constant type="outermargin">In outer 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="text"></cd:constant> | + | <cd:constant type="text">In main text area</cd:constant> |
− | <cd:constant type="opposite"> | + | <cd:constant type="opposite">On the opposite page of a spread</cd:constant> |
− | <cd:constant type="reset"></cd:constant> | + | <cd:constant type="reset">?</cd:constant> |
− | <cd:constant type="height"></cd:constant> | + | <cd:constant type="height">?</cd:constant> |
− | <cd:constant type="depth"></cd:constant> | + | <cd:constant type="depth">?</cd:constant> |
− | <cd:constant method="none" prefix="cd:sign" type="line"></cd:constant> | + | <cd:constant method="none" prefix="cd:sign" type="line">?</cd:constant> |
− | <cd:constant type="halfline"></cd:constant> | + | <cd:constant type="halfline">?</cd:constant> |
− | <cd:constant type="grid"></cd:constant> | + | <cd:constant type="grid">?</cd:constant> |
− | <cd:constant type="high"></cd:constant> | + | <cd:constant type="high">Switch off page headings (for page floats)</cd:constant> |
− | <cd:constant type="low"></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"></cd:constant> | + | <cd:constant type="90">Rotation</cd:constant> |
− | <cd:constant type="180"></cd:constant> | + | <cd:constant type="180">Rotation</cd:constant> |
− | <cd:constant type="270"></cd:constant> | + | <cd:constant type="270">Rotation</cd:constant> |
− | <cd:constant type="nonumber"></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> | ||
− | <cd:constant type="local"></cd:constant> | + | <cd:constant type="local">?</cd:constant> |
<cd:constant type="here">Preferably here</cd:constant> | <cd:constant type="here">Preferably here</cd:constant> | ||
<cd:constant type="force">Force placement here</cd:constant> | <cd:constant type="force">Force placement here</cd:constant> | ||
<cd:constant type="margin">In the margin (margin float)</cd:constant> | <cd:constant type="margin">In the margin (margin float)</cd:constant> | ||
− | <cd:constant method="none" prefix="cd:sign" type="hang"></cd:constant> | + | <cd:constant method="none" prefix="cd:sign" type="hang">?</cd:constant> |
− | <cd:constant type="hanging"></cd:constant> | + | <cd:constant type="hanging">?</cd:constant> |
− | <cd:constant type="tall"></cd:constant> | + | <cd:constant type="tall">?</cd:constant> |
− | <cd:constant type="both"></cd:constant> | + | <cd:constant type="both">?</cd:constant> |
− | <cd:constant type="middle"></cd:constant> | + | <cd:constant type="middle">?</cd:constant> |
− | <cd:constant type="offset"></cd:constant> | + | <cd:constant type="offset">?</cd:constant> |
<cd:constant type="top">At the top of the page</cd:constant> | <cd:constant type="top">At the top of the page</cd:constant> | ||
<cd:constant type="bottom">At the bottom of the page</cd:constant> | <cd:constant type="bottom">At the bottom of the page</cd:constant> | ||
− | <cd:constant type="auto"></cd:constant> | + | <cd:constant type="auto">?</cd:constant> |
− | <cd:constant type="page"> | + | <cd:constant type="page">On a new (empty) page</cd:constant> |
− | <cd:constant type="leftpage"></cd:constant> | + | <cd:constant type="leftpage">On an empty left page</cd:constant> |
− | <cd:constant type="rightpage"></cd:constant> | + | <cd:constant type="rightpage">On an empty right page</cd:constant> |
− | <cd:constant type="somewhere"></cd:constant> | + | <cd:constant type="somewhere">?</cd:constant> |
− | <cd:constant type="effective"></cd:constant> | + | <cd:constant type="effective">?</cd:constant> |
− | <cd:constant type="header"></cd:constant> | + | <cd:constant type="header">Use header space (combine with "high")</cd:constant> |
− | <cd:constant type="footer"></cd:constant> | + | <cd:constant type="footer">Use footer space (combine with "low")</cd:constant> |
− | <cd:constant type="tblr"></cd:constant> | + | <cd:constant type="tblr">Precedence in page columns: top, bottom, left, right</cd:constant> |
− | <cd:constant type="lrtb"></cd:constant> | + | <cd:constant type="lrtb">Precedence in page columns: left, right, top, bottom</cd:constant> |
− | <cd:constant type="tbrl"></cd:constant> | + | <cd:constant type="tbrl">Precedence in page columns: top, bottom, right, left</cd:constant> |
− | <cd:constant type="rltb"></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">?</cd:constant> |
− | <cd:constant type="btlr"></cd:constant> | + | <cd:constant type="btlr">Precedence in page columns</cd:constant> |
− | <cd:constant type="lrbt"></cd:constant> | + | <cd:constant type="lrbt">Precedence in page columns</cd:constant> |
− | <cd:constant type="btrl"></cd:constant> | + | <cd:constant type="btrl">Precedence in page columns</cd:constant> |
− | <cd:constant type="rlbt"></cd:constant> | + | <cd:constant type="rlbt">Precedence in page columns</cd:constant> |
− | <cd:constant type="fxbt"></cd:constant> | + | <cd:constant type="fxbt">?</cd:constant> |
− | <cd:constant type="fixd"></cd:constant> | + | <cd:constant type="fixd">?</cd:constant> |
</cd:keywords> | </cd:keywords> | ||
<cd:keywords list="yes" optional="yes" ordinal="3"> | <cd:keywords list="yes" optional="yes" ordinal="3"> | ||
Line 90: | Line 87: | ||
<cd:constant type="cd:text"></cd:constant> | <cd:constant type="cd:text"></cd:constant> | ||
</cd:keywords> | </cd:keywords> | ||
− | <cd:content ordinal="5"></cd:content> | + | <cd:content ordinal="5">float content</cd:content> |
</cd:arguments> | </cd:arguments> | ||
</cd:command> | </cd:command> | ||
</cd:variants> | </cd:variants> | ||
− | <cd:description> | + | <cd:description><!-- the long description of the command goes here --> |
− | <!-- the long description of the command goes here --> | ||
</cd:description> | </cd:description> | ||
− | <cd:examples> | + | <cd:examples></cd:examples> |
− | + | <cd:notes></cd:notes> | |
− | |||
− | |||
− | |||
− | </cd:examples> | ||
− | <cd:notes> | ||
− | |||
− | |||
− | |||
− | |||
− | </cd:notes> | ||
<cd:seealso> | <cd:seealso> | ||
− | + | <cd:source file="strc-flt.mkvi" originator="system"></cd:source> | |
− | <cd: | + | <cd:wikipage page="Floating_Objects"></cd:wikipage> |
− | <cd:wikipage | + | <cd:wikipage originator="system" page="Category:Structure"></cd:wikipage> |
− | <cd: | + | <cd:commandref name="definefloat"></cd:commandref> |
− | + | <cd:commandref name="setupfloat"></cd:commandref></cd:seealso> | |
− | |||
− | |||
− | <cd: | ||
− | <cd: | ||
− | </cd:seealso> | ||
</cd:commandgroup> | </cd:commandgroup> |
Revision as of 13:31, 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 |
180 | Rotation |
270 | Rotation |
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 | ? |
btlr | Precedence in page columns |
lrbt | Precedence in page columns |
btrl | Precedence in page columns |
rlbt | Precedence in page columns |
fxbt | ? |
fixd | ? |
optional reference label | |
caption content | |
{...} | float content |