93
edits
Changes
Jump to navigation
Jump to search
Created
<cd:commandgroup name="hanging" type="environment" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc><!-- a short command summary goes here -->
The environment <tt>\starthanging ... \stophanging</tt> is used to hang the start of a paragraph of text around an object in the style of a drop-cap.
</cd:shortdesc>
<cd:variants>
<cd:command category="alignment" file="spac-ver.mkiv" interfacedate="2020-07-14T09:24" interfacefile="i-align.xml" level="document" name="hanging" type="environment" variantnumber="1">
<cd:arguments>
<cd:assignments list="yes" optional="yes" ordinal="1">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="distance">
<cd:paramdoc>The space between the edge of the image and the start of the text. </cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="n">
<cd:paramdoc>The number of lines of vertical space to indent before returning back to the margin.</cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="location">
<cd:paramdoc>The position of the object.</cd:paramdoc>
<cd:constant default="yes" type="left">At the left hand margin.</cd:constant>
<cd:constant type="right">At the right hand margin.</cd:constant>
</cd:parameter>
</cd:assignments>
<cd:content ordinal="2">The content to hang the text around. Typically an image but could be anything framed, for example.</cd:content>
</cd:arguments>
</cd:command>
<cd:command category="alignment" file="spac-ver.mkiv" interfacedate="2020-07-14T09:24" interfacefile="i-align.xml" level="document" name="hanging" type="environment" variant="argument" variantnumber="2">
<cd:arguments>
<cd:keywords optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant default="yes" type="left"></cd:constant>
<cd:constant type="right"></cd:constant>
</cd:keywords>
<cd:content ordinal="2"></cd:content>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description><!-- the long description of the command goes here -->
</cd:description>
<cd:examples><cd:example title="Cow"><context source="yes">
\starthanging[left]{\externalfigure[cow.pdf][width=3cm]}
\samplefile{lorem}
\stophanging
</context></cd:example><cd:example title=""><context source="yes">
\starthanging[location=left,n=8,distance=5ex]{\externalfigure[cow.pdf][width=3cm]}
\samplefile{lorem}
\stophanging
</context></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:source file="spac-ver.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Alignment"></cd:wikipage>
<cd:commandref name="placefloat"></cd:commandref></cd:seealso>
</cd:commandgroup>
<cd:shortdesc><!-- a short command summary goes here -->
The environment <tt>\starthanging ... \stophanging</tt> is used to hang the start of a paragraph of text around an object in the style of a drop-cap.
</cd:shortdesc>
<cd:variants>
<cd:command category="alignment" file="spac-ver.mkiv" interfacedate="2020-07-14T09:24" interfacefile="i-align.xml" level="document" name="hanging" type="environment" variantnumber="1">
<cd:arguments>
<cd:assignments list="yes" optional="yes" ordinal="1">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="distance">
<cd:paramdoc>The space between the edge of the image and the start of the text. </cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="n">
<cd:paramdoc>The number of lines of vertical space to indent before returning back to the margin.</cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="location">
<cd:paramdoc>The position of the object.</cd:paramdoc>
<cd:constant default="yes" type="left">At the left hand margin.</cd:constant>
<cd:constant type="right">At the right hand margin.</cd:constant>
</cd:parameter>
</cd:assignments>
<cd:content ordinal="2">The content to hang the text around. Typically an image but could be anything framed, for example.</cd:content>
</cd:arguments>
</cd:command>
<cd:command category="alignment" file="spac-ver.mkiv" interfacedate="2020-07-14T09:24" interfacefile="i-align.xml" level="document" name="hanging" type="environment" variant="argument" variantnumber="2">
<cd:arguments>
<cd:keywords optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant default="yes" type="left"></cd:constant>
<cd:constant type="right"></cd:constant>
</cd:keywords>
<cd:content ordinal="2"></cd:content>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description><!-- the long description of the command goes here -->
</cd:description>
<cd:examples><cd:example title="Cow"><context source="yes">
\starthanging[left]{\externalfigure[cow.pdf][width=3cm]}
\samplefile{lorem}
\stophanging
</context></cd:example><cd:example title=""><context source="yes">
\starthanging[location=left,n=8,distance=5ex]{\externalfigure[cow.pdf][width=3cm]}
\samplefile{lorem}
\stophanging
</context></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:source file="spac-ver.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Alignment"></cd:wikipage>
<cd:commandref name="placefloat"></cd:commandref></cd:seealso>
</cd:commandgroup>
