3,897
edits
Changes
Jump to navigation
Jump to search
Created page with "Documentation for \setuplines"
<cd:commandgroup name="setuplines" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc>The command <tt>\setuplines</tt> sets up the options for line-based material.
</cd:shortdesc>
<cd:variants>
<cd:command category="structure" file="spac-lin.mkiv" interfacedate="2020-07-14T09:24" interfacefile="i-lines.xml" level="style" name="setuplines" variantnumber="1">
<cd:arguments>
<cd:keywords list="yes" optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="option">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="packed">Disables page-break between lines</cd:constant>
</cd:parameter>
<cd:parameter name="before">
<cd:paramdoc>''command'' that is expanded and then placed at the start of the environment</cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="after">
<cd:paramdoc>''command'' that is expanded and then placed at the end of the environment</cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="inbetween">
<cd:paramdoc>''command'' that is expanded and then placed between paragraph</cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="indenting">
<cd:paramdoc>Whether the lines should be indented.</cd:paramdoc>
<cd:inherit name="setupindenting"></cd:inherit>
</cd:parameter>
<cd:parameter name="align">
<cd:paramdoc>Controls alignment of the lines.</cd:paramdoc>
<cd:inherit name="setupalign"></cd:inherit>
</cd:parameter>
<cd:parameter name="space">
<cd:paramdoc>Whether spaces should be preserved. </cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant type="on">In [[mkii]], makes spaces visible as well as preserving them.</cd:constant>
<cd:constant type="off"></cd:constant>
<cd:constant type="fixed"></cd:constant>
<cd:constant default="yes" type="default"></cd:constant>
</cd:parameter>
<cd:parameter name="command">
<cd:paramdoc>''command'' that is applied to each non-empty line</cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="style">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:style"></cd:constant>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="color">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="left">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="right">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter list="yes" name="indentlist">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
<cd:constant type="*"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>Define the settings for the {{cmd|startlines}} environment. If {{cmd|definelines|[mylines]}} was used to define an environment <code>\startmylines</code>, you can set that up with either {{cmd|setuplines|2=[mylines][...=...]}} or {{cmd|setupmylines|2=[...=...]}}.
</cd:description>
<cd:examples></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="defineindenting" originator="system"></cd:commandref>
<cd:commandref name="definelines" originator="system"></cd:commandref>
<cd:commandref name="setupalign" originator="system"></cd:commandref>
<cd:commandref name="setupindenting" originator="system"></cd:commandref>
<cd:source file="spac-lin.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage>
<cd:commandref name="startlines"></cd:commandref>
<cd:commandref name="_startlines"></cd:commandref></cd:seealso>
</cd:commandgroup>
<cd:shortdesc>The command <tt>\setuplines</tt> sets up the options for line-based material.
</cd:shortdesc>
<cd:variants>
<cd:command category="structure" file="spac-lin.mkiv" interfacedate="2020-07-14T09:24" interfacefile="i-lines.xml" level="style" name="setuplines" variantnumber="1">
<cd:arguments>
<cd:keywords list="yes" optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="option">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="packed">Disables page-break between lines</cd:constant>
</cd:parameter>
<cd:parameter name="before">
<cd:paramdoc>''command'' that is expanded and then placed at the start of the environment</cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="after">
<cd:paramdoc>''command'' that is expanded and then placed at the end of the environment</cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="inbetween">
<cd:paramdoc>''command'' that is expanded and then placed between paragraph</cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="indenting">
<cd:paramdoc>Whether the lines should be indented.</cd:paramdoc>
<cd:inherit name="setupindenting"></cd:inherit>
</cd:parameter>
<cd:parameter name="align">
<cd:paramdoc>Controls alignment of the lines.</cd:paramdoc>
<cd:inherit name="setupalign"></cd:inherit>
</cd:parameter>
<cd:parameter name="space">
<cd:paramdoc>Whether spaces should be preserved. </cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant type="on">In [[mkii]], makes spaces visible as well as preserving them.</cd:constant>
<cd:constant type="off"></cd:constant>
<cd:constant type="fixed"></cd:constant>
<cd:constant default="yes" type="default"></cd:constant>
</cd:parameter>
<cd:parameter name="command">
<cd:paramdoc>''command'' that is applied to each non-empty line</cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="style">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:style"></cd:constant>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="color">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="left">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="right">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter list="yes" name="indentlist">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
<cd:constant type="*"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>Define the settings for the {{cmd|startlines}} environment. If {{cmd|definelines|[mylines]}} was used to define an environment <code>\startmylines</code>, you can set that up with either {{cmd|setuplines|2=[mylines][...=...]}} or {{cmd|setupmylines|2=[...=...]}}.
</cd:description>
<cd:examples></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="defineindenting" originator="system"></cd:commandref>
<cd:commandref name="definelines" originator="system"></cd:commandref>
<cd:commandref name="setupalign" originator="system"></cd:commandref>
<cd:commandref name="setupindenting" originator="system"></cd:commandref>
<cd:source file="spac-lin.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage>
<cd:commandref name="startlines"></cd:commandref>
<cd:commandref name="_startlines"></cd:commandref></cd:seealso>
</cd:commandgroup>
