3,897
edits
Changes
Jump to navigation
Jump to search
Command/completelist (view source)
Revision as of 14:18, 26 September 2020
, 14:18, 26 September 2020Created page with "Documentation for \completelist"
<cd:commandgroup name="completelist" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc>The command <tt>\completelist</tt> is used for typesetting a named list complete with section head.
</cd:shortdesc>
<cd:variants>
<cd:command category="structure" file="strc-lst.mkvi" interfacedate="2020-07-14T09:24" interfacefile="i-list.xml" level="document" name="completelist" variantnumber="1">
<cd:arguments>
<cd:keywords ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:list"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" optional="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:inherit name="setuplist"></cd:inherit>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>This is like {{cmd|placelist}} except that it prepends a {{cmd|title}} to the actual list, with its text being the label text of the named list.
Not all lists have a default label text, so you may need to set one up using {{cmd|setupheadtext}}.
</cd:description>
<cd:examples><cd:example title=""><context source="yes" text="This produces:">
\setuppapersize[A8][A7,landscape]
\setuppaper[nx=2, ny=1]
\setuparranging[XY]
\showframe[page]
\setupheadtext[section=Sections]
\setuphead[section][number=no]
\starttext
\startchapter[title=Foo Chapter]
\startsection[title={Beta}] First Section \stopsection
\startsection[title={Alpha}] Second Section \stopsection
\stopchapter
\break
\completelist[section][criterium=all]
\stoptext
</context></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="definelist" originator="system"></cd:commandref>
<cd:commandref name="setuplist" originator="system"></cd:commandref>
<cd:source file="strc-lst.mkvi" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage>
<cd:commandref name="placelist"></cd:commandref>
<cd:commandref name="setupheadtext"></cd:commandref></cd:seealso>
</cd:commandgroup>
<cd:shortdesc>The command <tt>\completelist</tt> is used for typesetting a named list complete with section head.
</cd:shortdesc>
<cd:variants>
<cd:command category="structure" file="strc-lst.mkvi" interfacedate="2020-07-14T09:24" interfacefile="i-list.xml" level="document" name="completelist" variantnumber="1">
<cd:arguments>
<cd:keywords ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:list"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" optional="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:inherit name="setuplist"></cd:inherit>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>This is like {{cmd|placelist}} except that it prepends a {{cmd|title}} to the actual list, with its text being the label text of the named list.
Not all lists have a default label text, so you may need to set one up using {{cmd|setupheadtext}}.
</cd:description>
<cd:examples><cd:example title=""><context source="yes" text="This produces:">
\setuppapersize[A8][A7,landscape]
\setuppaper[nx=2, ny=1]
\setuparranging[XY]
\showframe[page]
\setupheadtext[section=Sections]
\setuphead[section][number=no]
\starttext
\startchapter[title=Foo Chapter]
\startsection[title={Beta}] First Section \stopsection
\startsection[title={Alpha}] Second Section \stopsection
\stopchapter
\break
\completelist[section][criterium=all]
\stoptext
</context></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="definelist" originator="system"></cd:commandref>
<cd:commandref name="setuplist" originator="system"></cd:commandref>
<cd:source file="strc-lst.mkvi" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage>
<cd:commandref name="placelist"></cd:commandref>
<cd:commandref name="setupheadtext"></cd:commandref></cd:seealso>
</cd:commandgroup>
