Command/placefloat
< Command
Jump to navigation
Jump to search
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).
new in 2024-06: paragraph, to be combined with left/right to avoid problems with other mechanisms that affect the paragraph shape, like initials. (handindent vs. parshape) | |
| split | If a table is too long for the page, and split has been specified, then the table will be split over as many pages as are required.
See the command \setupfloatsplitting for options specific to the split. You can’t combinesplit with other options (like here, top, page), it alone is like here. If you need page, surround the placement with \startpostponing … \stoppostponing. |
| always | Precedence over stored floats |
| left | To the left of the text |
| right | To the right of the text |
| inner | like left/right |
| outer | lik left/right |
| 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 | Move content higher, rather than aligning the top with a baseline. |
| depth | Align bottom of content with a baseline. Takes precedence over height. |
| [+-]line | +line: shifts content one baseline further down than otherwise.
-line and line: shifts content one baseline further up than otherwise. Both of these done without affecting hanging indentation for left or right. |
| halfline | ? Moves content up roughly 1/2 line, unless height is used, in which case content is moved down roughly 1/2 line ? |
| grid | ? |
| high | with "page": like top. with left/right: move up. |
| low | with "page": like bottom. with left/right: move down. |
| fit | with left/right: no distance between float and text |
| 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 | ? +hang apparently like hang apparently like 1*hang, -hang apparently like -1*hang. E.g., 2*hang |
| hanging | ? apparently the same as 0*hang |
| tall | ? |
| both | ? |
| middle | ? |
| offset | ? |
| top | At the top of the page |
| bottom | At the bottom of the page (unreliable) |
| auto | ? |
| page | On a new (empty) page |
| leftpage | On an empty left page |
| rightpage | On an empty right page |
| somewhere | Used as a location prefix with \placenamedfloat. See that command page for example usage |
| 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
- Document layout and layers/Floating objects
- \definefloat
- \setupfloat
- \setupfloatsplitting
- page-cst.lua Lua functions that control the four-letter placement codes in page columns
