3,899
edits
Changes
Jump to navigation
Jump to search
Command/startmarginrule (view source)
Revision as of 13:25, 14 September 2023
, 13:25, 14 September 2023Created page with "Documentation for \startmarginrule ... \stopmarginrule"
<cd:commandgroup name="marginrule" type="environment" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc><!-- a short command summary goes here -->
The environment <tt>\startmarginrule ... \stopmarginrule</tt> is puts a rule in the margin
</cd:shortdesc>
<cd:variants>
<cd:command category="rules" file="anch-bar.mkiv" interfacedate="2020-06-19T13:41" interfacefile="i-sidebar.xml" level="document" name="marginrule" type="environment" variantnumber="1">
<cd:arguments>
<cd:keywords optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:number">Default is <code>1</code>. Higher numbers are moved further into the margin.</cd:constant>
</cd:keywords>
</cd:arguments>
</cd:command>
<cd:command category="rules" file="anch-bar.mkiv" interfacedate="2020-06-19T13:41" interfacefile="i-sidebar.xml" level="document" name="marginrule" type="environment" variant="assignment" variantnumber="2">
<cd:arguments>
<cd:assignments list="yes" optional="yes" ordinal="1">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:inherit name="setupmarginrule"></cd:inherit>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>Puts a rule in the left margin next to a block. This environment can be nested. It is a special case of sidebar.
</cd:description>
<cd:examples><cd:example title="">Here is example input:
<context source="yes" text="Gives:">
\setuppapersize[A7,landscape]
\starttext
\startmarginrule
The sound of a duck is a good demonstration of how different people
listen to a sound. Everywhere in Europe the sound is equal. But in
every country it is described differently: kwaak||kwaak (Netherlands),
couin||couin (French), gick||gack (German), rap||rap (Danish) and
mech||mech (Spanish). If you speak these words aloud you will notice
that in spite of the consonants the sound is really very
well described. And what about a cow, does it say boe, mboe or mmmmmm?
\stopmarginrule
\stoptext
</context></cd:example><cd:example title="Nested rules (with a bit of setup)"><context source="yes" text="Gives:">
\setuppapersize[A6,landscape]
\setupmarginrule[2][rulecolor=darkblue]
\starttext
\startmarginrule[1]
\input ward
\startmarginrule[2]
\input ward
\stopmarginrule
\stopmarginrule
\blank
\startmarginrule[2]
\input ward
\startmarginrule[1]
\input ward
\stopmarginrule
\stopmarginrule
\stoptext
</context></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="setupmarginrule" originator="system"></cd:commandref>
<cd:source file="anch-bar.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Rules"></cd:wikipage>
<cd:commandref name="definesidebar"></cd:commandref>
<cd:commandref name="setupsidebar"></cd:commandref></cd:seealso>
</cd:commandgroup>
<cd:shortdesc><!-- a short command summary goes here -->
The environment <tt>\startmarginrule ... \stopmarginrule</tt> is puts a rule in the margin
</cd:shortdesc>
<cd:variants>
<cd:command category="rules" file="anch-bar.mkiv" interfacedate="2020-06-19T13:41" interfacefile="i-sidebar.xml" level="document" name="marginrule" type="environment" variantnumber="1">
<cd:arguments>
<cd:keywords optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:number">Default is <code>1</code>. Higher numbers are moved further into the margin.</cd:constant>
</cd:keywords>
</cd:arguments>
</cd:command>
<cd:command category="rules" file="anch-bar.mkiv" interfacedate="2020-06-19T13:41" interfacefile="i-sidebar.xml" level="document" name="marginrule" type="environment" variant="assignment" variantnumber="2">
<cd:arguments>
<cd:assignments list="yes" optional="yes" ordinal="1">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:inherit name="setupmarginrule"></cd:inherit>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>Puts a rule in the left margin next to a block. This environment can be nested. It is a special case of sidebar.
</cd:description>
<cd:examples><cd:example title="">Here is example input:
<context source="yes" text="Gives:">
\setuppapersize[A7,landscape]
\starttext
\startmarginrule
The sound of a duck is a good demonstration of how different people
listen to a sound. Everywhere in Europe the sound is equal. But in
every country it is described differently: kwaak||kwaak (Netherlands),
couin||couin (French), gick||gack (German), rap||rap (Danish) and
mech||mech (Spanish). If you speak these words aloud you will notice
that in spite of the consonants the sound is really very
well described. And what about a cow, does it say boe, mboe or mmmmmm?
\stopmarginrule
\stoptext
</context></cd:example><cd:example title="Nested rules (with a bit of setup)"><context source="yes" text="Gives:">
\setuppapersize[A6,landscape]
\setupmarginrule[2][rulecolor=darkblue]
\starttext
\startmarginrule[1]
\input ward
\startmarginrule[2]
\input ward
\stopmarginrule
\stopmarginrule
\blank
\startmarginrule[2]
\input ward
\startmarginrule[1]
\input ward
\stopmarginrule
\stopmarginrule
\stoptext
</context></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="setupmarginrule" originator="system"></cd:commandref>
<cd:source file="anch-bar.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Rules"></cd:wikipage>
<cd:commandref name="definesidebar"></cd:commandref>
<cd:commandref name="setupsidebar"></cd:commandref></cd:seealso>
</cd:commandgroup>
