3,899
edits
Changes
Jump to navigation
Jump to search
Command/setupblackrules (view source)
Revision as of 19:13, 12 September 2020
, 19:13, 12 September 2020Created page with "Documentation for \setupblackrules"
<cd:commandgroup name="setupblackrules" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc>The command <tt>\setupblackrules</tt> is used for configuring {{cmd|blackrule}} and {{cmd|blackrules}}
</cd:shortdesc>
<cd:variants>
<cd:command category="rules" file="pack-mrl.mkiv" interfacedate="2020-07-14T09:24" interfacefile="i-blackrule.xml" keywords="colors" level="style" name="setupblackrules" variantnumber="1">
<cd:arguments>
<cd:assignments list="yes" ordinal="1">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="width">
<cd:paramdoc> width across the page. Default = 1em</cd:paramdoc>
<cd:constant type="max">same as 1em</cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="height">
<cd:paramdoc>height above the baseline. Default = <code>\exheight</code></cd:paramdoc>
<cd:constant type="max">same as <code>\strutheight</code></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="depth">
<cd:paramdoc>depth below the baseline</cd:paramdoc>
<cd:constant type="max">same as <code>\strutdepth</code></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="distance">
<cd:paramdoc>distance between rules in {{cmd|blackrules}}</cd:paramdoc>
<cd:constant type="cd:dimension">default = <code>.25\emwidth</code></cd:constant>
</cd:parameter>
<cd:parameter name="n">
<cd:paramdoc>number of rules in {{cmd|blackrules}}</cd:paramdoc>
<cd:constant type="cd:number">default = 3</cd:constant>
</cd:parameter>
<cd:parameter name="alternative">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="a">treats <cd:iref name="width"/> as the dimension of one rule</cd:constant>
<cd:constant type="b">treats <cd:iref name="width"/> as the dimension of the whole series</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>color of the rule</cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="type">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="mp">use metapost for rule?</cd:constant>
<cd:constant type="yes">use <code>\vrule</code></cd:constant>
<cd:constant type="no">use <code>\novrule</code></cd:constant>
</cd:parameter>
<cd:parameter name="mp">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>This command is used for configuring {{cmd|blackrule}} and {{cmd|blackrules}}</cd:description>
<cd:examples><cd:example title="">See {{cmd|blackrule}} and {{cmd|blackrules}}</cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:source file="pack-mrl.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Rules"></cd:wikipage>
<cd:wikipage originator="system" page="Keywords:Colors"></cd:wikipage>
<cd:commandref name="blackrule"></cd:commandref>
<cd:commandref name="blackrules"></cd:commandref></cd:seealso>
</cd:commandgroup>
<cd:shortdesc>The command <tt>\setupblackrules</tt> is used for configuring {{cmd|blackrule}} and {{cmd|blackrules}}
</cd:shortdesc>
<cd:variants>
<cd:command category="rules" file="pack-mrl.mkiv" interfacedate="2020-07-14T09:24" interfacefile="i-blackrule.xml" keywords="colors" level="style" name="setupblackrules" variantnumber="1">
<cd:arguments>
<cd:assignments list="yes" ordinal="1">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="width">
<cd:paramdoc> width across the page. Default = 1em</cd:paramdoc>
<cd:constant type="max">same as 1em</cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="height">
<cd:paramdoc>height above the baseline. Default = <code>\exheight</code></cd:paramdoc>
<cd:constant type="max">same as <code>\strutheight</code></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="depth">
<cd:paramdoc>depth below the baseline</cd:paramdoc>
<cd:constant type="max">same as <code>\strutdepth</code></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="distance">
<cd:paramdoc>distance between rules in {{cmd|blackrules}}</cd:paramdoc>
<cd:constant type="cd:dimension">default = <code>.25\emwidth</code></cd:constant>
</cd:parameter>
<cd:parameter name="n">
<cd:paramdoc>number of rules in {{cmd|blackrules}}</cd:paramdoc>
<cd:constant type="cd:number">default = 3</cd:constant>
</cd:parameter>
<cd:parameter name="alternative">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="a">treats <cd:iref name="width"/> as the dimension of one rule</cd:constant>
<cd:constant type="b">treats <cd:iref name="width"/> as the dimension of the whole series</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>color of the rule</cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="type">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="mp">use metapost for rule?</cd:constant>
<cd:constant type="yes">use <code>\vrule</code></cd:constant>
<cd:constant type="no">use <code>\novrule</code></cd:constant>
</cd:parameter>
<cd:parameter name="mp">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>This command is used for configuring {{cmd|blackrule}} and {{cmd|blackrules}}</cd:description>
<cd:examples><cd:example title="">See {{cmd|blackrule}} and {{cmd|blackrules}}</cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:source file="pack-mrl.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Rules"></cd:wikipage>
<cd:wikipage originator="system" page="Keywords:Colors"></cd:wikipage>
<cd:commandref name="blackrule"></cd:commandref>
<cd:commandref name="blackrules"></cd:commandref></cd:seealso>
</cd:commandgroup>
