3,899
edits
Changes
Jump to navigation
Jump to search
Created page with "Documentation for \startregister"
<cd:commandgroup name="startregister" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc><!-- a short command summary goes here -->
The command <tt>\startregister</tt> is used for ...
</cd:shortdesc>
<cd:variants>
<cd:command category="structure" file="strc-reg.mkiv" interfacedate="2019-11-19T09:54" interfacefile="i-register.xml" level="document" name="startregister" variantnumber="1">
<cd:arguments>
<cd:keywords ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name">registername (e.g. "index")</cd:constant>
</cd:keywords>
<cd:keywords ordinal="2">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name">reference code, in case several register spans overlap</cd:constant>
</cd:keywords>
<cd:keywords optional="yes" ordinal="3">
<cd:keywordsdoc>alternative</cd:keywordsdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:keywords>
<cd:keywords optional="yes" ordinal="4">
<cd:keywordsdoc>Just <code>processor-></code> is only a page formatter, <code>processor->text</code> also provides an override sorting key.</cd:keywordsdoc>
<cd:constant type="cd:text">override sorting key</cd:constant>
<cd:constant method="apply" prefix="cd:processor" type="cd:text">page formatter</cd:constant>
</cd:keywords>
<cd:index list="yes" ordinal="5">the index entry</cd:index>
<cd:keywords delimiters="none" ordinal="6">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:content">normal text flow content</cd:constant>
</cd:keywords>
<cd:delimiter name="stopregister" ordinal="7"></cd:delimiter>
<cd:keywords ordinal="8">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name">repeat of argument 1</cd:constant>
</cd:keywords>
<cd:keywords ordinal="9">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name">repeat of argument 2</cd:constant>
</cd:keywords>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>Set an index (or other register) entry for a page span, e.g. a whole chapter, without the need to repeat {{cmd|index}}.
It’s always {{cmd|startregister|2=[registername]}}, the short form <code>\startindex</code> (or <code>\startmyownregister</code>) doesn’t exist!
</cd:description>
<cd:examples><cd:example title=""><texcode>
\startregister[index][knuth]{Knuth, Donald}
... a long section about Donald Knuth ...
\stopregister[index][knuth]
</texcode></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:source file="strc-reg.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage>
<cd:commandref name="defineregister"></cd:commandref>
<cd:commandref name="setupregister"></cd:commandref>
<cd:commandref name="_register"></cd:commandref></cd:seealso>
</cd:commandgroup>
<cd:shortdesc><!-- a short command summary goes here -->
The command <tt>\startregister</tt> is used for ...
</cd:shortdesc>
<cd:variants>
<cd:command category="structure" file="strc-reg.mkiv" interfacedate="2019-11-19T09:54" interfacefile="i-register.xml" level="document" name="startregister" variantnumber="1">
<cd:arguments>
<cd:keywords ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name">registername (e.g. "index")</cd:constant>
</cd:keywords>
<cd:keywords ordinal="2">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name">reference code, in case several register spans overlap</cd:constant>
</cd:keywords>
<cd:keywords optional="yes" ordinal="3">
<cd:keywordsdoc>alternative</cd:keywordsdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:keywords>
<cd:keywords optional="yes" ordinal="4">
<cd:keywordsdoc>Just <code>processor-></code> is only a page formatter, <code>processor->text</code> also provides an override sorting key.</cd:keywordsdoc>
<cd:constant type="cd:text">override sorting key</cd:constant>
<cd:constant method="apply" prefix="cd:processor" type="cd:text">page formatter</cd:constant>
</cd:keywords>
<cd:index list="yes" ordinal="5">the index entry</cd:index>
<cd:keywords delimiters="none" ordinal="6">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:content">normal text flow content</cd:constant>
</cd:keywords>
<cd:delimiter name="stopregister" ordinal="7"></cd:delimiter>
<cd:keywords ordinal="8">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name">repeat of argument 1</cd:constant>
</cd:keywords>
<cd:keywords ordinal="9">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name">repeat of argument 2</cd:constant>
</cd:keywords>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>Set an index (or other register) entry for a page span, e.g. a whole chapter, without the need to repeat {{cmd|index}}.
It’s always {{cmd|startregister|2=[registername]}}, the short form <code>\startindex</code> (or <code>\startmyownregister</code>) doesn’t exist!
</cd:description>
<cd:examples><cd:example title=""><texcode>
\startregister[index][knuth]{Knuth, Donald}
... a long section about Donald Knuth ...
\stopregister[index][knuth]
</texcode></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:source file="strc-reg.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage>
<cd:commandref name="defineregister"></cd:commandref>
<cd:commandref name="setupregister"></cd:commandref>
<cd:commandref name="_register"></cd:commandref></cd:seealso>
</cd:commandgroup>
