Difference between revisions of "Command/ placefloat"

From Wiki
Jump to navigation Jump to search
(Created page with "Documentation for \<i>placefloat</i>")
 
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
<?xml version='1.0'?>
 
−
<!-- this file was generated on 2020-08-20T09:05 -->
 
 
<cd:commandgroup generated="yes" name="placefloat" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
 
<cd:commandgroup generated="yes" 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 instances of  <tt>\place<i>float</i></tt> are used for placing floating objects.
−
The instances of  <tt>\<i>placefloat</i></tt> are used for ...
 
 
</cd:shortdesc>
 
</cd:shortdesc>
 
<cd:sequence>
 
<cd:sequence>
Line 21: Line 18:
 
   <cd:arguments>
 
   <cd:arguments>
 
     <cd:keywords list="yes" optional="yes" ordinal="1">
 
     <cd:keywords list="yes" optional="yes" ordinal="1">
−
     <cd:keywordsdoc></cd:keywordsdoc>
+
     <cd:keywordsdoc>see {{cmd|placefloat}} for option values.</cd:keywordsdoc>
 
     <cd:constant type="split"></cd:constant>
 
     <cd:constant type="split"></cd:constant>
 
     <cd:constant type="always"></cd:constant>
 
     <cd:constant type="always"></cd:constant>
Line 90: Line 87:
 
     </cd:keywords>
 
     </cd:keywords>
 
     <cd:keywords list="yes" optional="yes" ordinal="2">
 
     <cd:keywords list="yes" optional="yes" ordinal="2">
−
     <cd:keywordsdoc></cd:keywordsdoc>
+
     <cd:keywordsdoc>optional reference label</cd:keywordsdoc>
 
     <cd:constant type="cd:reference"></cd:constant>
 
     <cd:constant type="cd:reference"></cd:constant>
 
     </cd:keywords>
 
     </cd:keywords>
 
     <cd:keywords delimiters="braces" ordinal="3">
 
     <cd:keywords delimiters="braces" ordinal="3">
−
     <cd:keywordsdoc></cd:keywordsdoc>
+
     <cd:keywordsdoc>caption content</cd:keywordsdoc>
 
     <cd:constant type="cd:text"></cd:constant>
 
     <cd:constant type="cd:text"></cd:constant>
 
     </cd:keywords>
 
     </cd:keywords>
Line 101: Line 98:
 
   </cd:command>
 
   </cd:command>
 
</cd:variants>
 
</cd:variants>
−
<cd:description>
+
<cd:description>With {{cmd|placefloat|[location][ref]{caption}{contents}} } you can declare that you want to take certain contents, and place them on the page as a (numbered) figure, table, graphic, or intermezzo, or as some other ''float'' type that you defined using {{cmd|definefloat}}.
−
<!-- the long description of the command goes here -->
 
 
</cd:description>
 
</cd:description>
−
<cd:examples>
+
<cd:examples><cd:example title=""><context source="yes">
−
<!--  command example(s)
+
% Need to tell ConTeXt where the cow picture is stored
−
<cd:example title="">
+
\setupexternalfigures[location={local,default}]
−
</cd:example>
+
 
−
-->
+
\startcolumns[n=3]
−
</cd:examples>
+
    caption=none
−
<cd:notes>
+
    \placefigure{none}{\externalfigure[cow][height=1cm]}
−
<!--  this is for special remarks that do not fit elsewhere, like discovered bugs in specific context versions
+
\column
−
<cd:note author="..." date="...">
+
    key=none
−
</cd:note>
+
    \placefigure[none]{}{\externalfigure[cow][height=1cm]}
−
-->
+
\column
−
</cd:notes>
+
    empty caption
 +
    \placefigure{}{\externalfigure[cow][height=1cm]}
 +
\stopcolumns
 +
</context></cd:example></cd:examples>
 +
<cd:notes></cd:notes>
 
<cd:seealso>
 
<cd:seealso>
−
<!-- one or more of these:
 
−
<cd:commandref name="xx"></cd:commandref>
 
−
<cd:wikipage  page="xx"></cd:wikipage>
 
−
<cd:url        url="https://xx"></cd:url>
 
−
<cd:manual    pdf="xx"></cd:manual>
 
−
<cd:source    file="xx"></cd:source>
 
−
-->
 
 
<cd:commandref name="_completelistoffloats" originator="system"></cd:commandref>
 
<cd:commandref name="_completelistoffloats" originator="system"></cd:commandref>
 
<cd:commandref name="_placelistoffloats" originator="system"></cd:commandref>
 
<cd:commandref name="_placelistoffloats" originator="system"></cd:commandref>
Line 130: Line 123:
 
<cd:commandref name="definefloat" originator="system"></cd:commandref>
 
<cd:commandref name="definefloat" originator="system"></cd:commandref>
 
<cd:commandref name="setupfloat" originator="system"></cd:commandref>
 
<cd:commandref name="setupfloat" originator="system"></cd:commandref>
−
<cd:source file="strc-flt.mkvi" originator="system"></cd:source>  
+
<cd:source file="strc-flt.mkvi" originator="system"></cd:source>
−
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage>  
+
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage>
−
</cd:seealso>
+
<cd:commandref name="startcombination">to place multiple objects together</cd:commandref>
 +
<cd:commandref name="setupcaption">to place the caption differently than 'below and centered'.</cd:commandref></cd:seealso>
 
</cd:commandgroup>
 
</cd:commandgroup>

Latest revision as of 18:57, 27 August 2020


\placefloat

Summary

The instances of \placefloat are used for placing floating objects.

Instances

\placechemical
\placefigure
\placetable
\placeintermezzo
\placegraphic

Settings instance

\placeFLOAT[...,...][...,...]{...}{...}
[...,...]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

OptionExplanation
see \placefloat for option values.
optional reference label
caption content

Description

With \placefloat[location][ref]{caption}{contents } you can declare that you want to take certain contents, and place them on the page as a (numbered) figure, table, graphic, or intermezzo, or as some other float type that you defined using \definefloat.

Examples

Example 1

% Need to tell ConTeXt where the cow picture is stored
\setupexternalfigures[location={local,default}]

\startcolumns[n=3]
    caption=none
    \placefigure{none}{\externalfigure[cow][height=1cm]}
\column
    key=none
    \placefigure[none]{}{\externalfigure[cow][height=1cm]}
\column
    empty caption
    \placefigure{}{\externalfigure[cow][height=1cm]}
\stopcolumns

Notes

See also

Help from ConTeXt-Mailinglist/Forum

All issues with:

Retrieved from "https://wiki.contextgarden.net/index.php?title=Command/_placefloat&oldid=31078"