Difference between revisions of "Command/startplacefloat"
< Command
Jump to navigation
Jump to search
(Created page with "Documentation for \startplacefloat ... \stopplacefloat") |
m (add link to Floating_Objects) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
<cd:commandgroup name="placefloat" type="environment" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807"> | <cd:commandgroup name="placefloat" type="environment" 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 environment <tt>\startplacefloat ... \stopplacefloat</tt> is used to place a floating object (e.g. figure). |
| − | The environment <tt>\startplacefloat ... \stopplacefloat</tt> is used | ||
</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 instance</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" optional="yes" ordinal="2"> | <cd:assignments list="yes" optional="yes" ordinal="2"> | ||
<cd:assignmentsdoc></cd:assignmentsdoc> | <cd:assignmentsdoc></cd:assignmentsdoc> | ||
<cd:parameter name="title"> | <cd:parameter name="title"> | ||
| − | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>caption text</cd:paramdoc> |
<cd:constant type="cd:text"></cd:constant> | <cd:constant type="cd:text"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
| Line 28: | Line 25: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="list"> | <cd:parameter name="list"> | ||
| − | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>description in a list of floats</cd:paramdoc> |
<cd:constant type="cd:text"></cd:constant> | <cd:constant type="cd:text"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
| Line 115: | Line 112: | ||
</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 originator="system" page="Category:Structure"></cd:wikipage> |
| − | <cd:wikipage | + | <cd:commandref name="placefloat"></cd:commandref> |
| − | + | <cd:commandref name="setupfloat"></cd:commandref> | |
| − | <cd: | + | <cd:commandref name="definefloat"></cd:commandref> |
| − | <cd: | + | <cd:wikipage page="Floating Objects"></cd:wikipage></cd:seealso> |
| − | |||
| − | <cd: | ||
| − | <cd:wikipage | ||
| − | </cd:seealso> | ||
</cd:commandgroup> | </cd:commandgroup> | ||
Latest revision as of 09:39, 30 July 2023
Contents
\startplacefloat ... \stopplacefloat
Summary
The environment \startplacefloat ... \stopplacefloat is used to place a floating object (e.g. figure).
Settings
| \startplacefloat[...][...=...,...][...=...,...] ... \stopplacefloat | |
| [...] | singular |
| title | text |
| bookmark | text |
| marking | text |
| list | text |
| location | 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 | reference |
| key | value |
| Option | Explanation | ||
|---|---|---|---|
| name of the float instance | |||
| singular | figure graphic table intermezzo … | ||
| title |
| ||
| list |
| ||
| location |
| ||
