Changes

Jump to navigation Jump to search
14,388 bytes added ,  19:33, 25 September 2020
Created page with "Documentation for \setuplist"
<cd:commandgroup name="setuplist" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc>The command <tt>\setuplist</tt> configures collected lists like for the TOC
</cd:shortdesc>
<cd:variants>
<cd:command category="structure" file="strc-lst.mkvi" interfacedate="2020-07-14T09:24" interfacefile="i-list.xml" level="style" name="setuplist" variantnumber="1">
<cd:arguments>
<cd:keywords list="yes" optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:list"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="state">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="start"></cd:constant>
<cd:constant type="stop"></cd:constant>
</cd:parameter>
<cd:parameter name="location">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="none"></cd:constant>
<cd:constant type="here"></cd:constant>
</cd:parameter>
<cd:parameter name="type">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="simple"></cd:constant>
<cd:constant type="command"></cd:constant>
<cd:constant type="userdata"></cd:constant>
</cd:parameter>
<cd:parameter name="criterium">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="local"></cd:constant>
<cd:constant type="intro"></cd:constant>
<cd:constant type="reference"></cd:constant>
<cd:constant method="range" prefix="cd:sectionblock" type="reference"></cd:constant>
<cd:constant type="all"></cd:constant>
<cd:constant method="range" prefix="cd:sectionblock" type="all"></cd:constant>
<cd:constant type="text"></cd:constant>
<cd:constant method="range" prefix="cd:sectionblock" type="text"></cd:constant>
<cd:constant type="current"></cd:constant>
<cd:constant method="range" prefix="cd:sectionblock" type="current"></cd:constant>
<cd:constant type="here"></cd:constant>
<cd:constant type="previous"></cd:constant>
<cd:constant method="range" prefix="cd:sectionblock" type="previous"></cd:constant>
<cd:constant type="component"></cd:constant>
<cd:constant type="cd:section"></cd:constant>
<cd:constant method="range" prefix="cd:sectionblock" type="cd:section"></cd:constant>
</cd:parameter>
<cd:parameter name="list">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="width">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="fit"></cd:constant>
<cd:constant type="broad"></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="height">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="fit"></cd:constant>
<cd:constant default="yes" type="broad"></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="depth">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="fit"></cd:constant>
<cd:constant default="yes" type="broad"></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="symbol">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="one"></cd:constant>
<cd:constant type="two"></cd:constant>
<cd:constant type="three"></cd:constant>
<cd:constant type="none"></cd:constant>
<cd:constant default="yes" type="default"></cd:constant>
</cd:parameter>
<cd:parameter name="label">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant default="yes" type="no"></cd:constant>
<cd:constant type="none"></cd:constant>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="starter">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="stopper">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="command">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:threearguments"></cd:constant>
</cd:parameter>
<cd:parameter name="numbercommand">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:oneargument"></cd:constant>
</cd:parameter>
<cd:parameter name="textcommand">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:oneargument"></cd:constant>
</cd:parameter>
<cd:parameter name="pagecommand">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:oneargument"></cd:constant>
</cd:parameter>
<cd:parameter list="yes" name="pagenumber">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="yes"></cd:constant>
<cd:constant type="no"></cd:constant>
<cd:constant type="always"></cd:constant>
<cd:constant type="realpage"></cd:constant>
</cd:parameter>
<cd:parameter name="headnumber">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="yes"></cd:constant>
<cd:constant type="no"></cd:constant>
<cd:constant type="always"></cd:constant>
</cd:parameter>
<cd:parameter name="before">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="after">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="inbetween">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="margin">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="none"></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="distance">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="none"></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="aligntitle">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant default="yes" type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="numberalign">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="left"></cd:constant>
<cd:constant type="right"></cd:constant>
<cd:constant type="middle"></cd:constant>
<cd:constant type="flushleft"></cd:constant>
<cd:constant type="flushright"></cd:constant>
<cd:constant type="inner"></cd:constant>
<cd:constant type="outer"></cd:constant>
</cd:parameter>
<cd:parameter name="align">
<cd:paramdoc></cd:paramdoc>
<cd:inherit name="setupalign"></cd:inherit>
</cd:parameter>
<cd:parameter name="hang">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="yes"></cd:constant>
<cd:constant type="no"></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 name="interaction">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant type="no"></cd:constant>
<cd:constant default="yes" type="all"></cd:constant>
<cd:constant type="number"></cd:constant>
<cd:constant type="text"></cd:constant>
<cd:constant type="title"></cd:constant>
<cd:constant type="page"></cd:constant>
<cd:constant type="sectionnumber"></cd:constant>
<cd:constant type="pagenumber"></cd:constant>
</cd:parameter>
<cd:parameter name="limittext">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant type="no"></cd:constant>
<cd:constant type="cd:text"></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="numberstyle">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:style"></cd:constant>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="numbercolor">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="textstyle">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:style"></cd:constant>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="textcolor">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="pagestyle">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:style"></cd:constant>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="pagecolor">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="reference">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="extras">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="order">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="command"></cd:constant>
<cd:constant type="all"></cd:constant>
<cd:constant type="title"></cd:constant>
</cd:parameter>
<cd:parameter name="alternative">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="a"></cd:constant>
<cd:constant default="yes" type="b"></cd:constant>
<cd:constant type="c"></cd:constant>
<cd:constant type="d"></cd:constant>
<cd:constant type="e"></cd:constant>
<cd:constant type="f"></cd:constant>
<cd:constant type="g"></cd:constant>
<cd:constant type="left"></cd:constant>
<cd:constant type="right"></cd:constant>
<cd:constant type="top"></cd:constant>
<cd:constant type="bottom"></cd:constant>
<cd:constant type="command"></cd:constant>
<cd:constant type="none"></cd:constant>
<cd:constant type="interactive"></cd:constant>
<cd:constant type="paragraph"></cd:constant>
<cd:constant type="horizontal"></cd:constant>
<cd:constant type="vertical"></cd:constant>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="maxwidth">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="pageprefix">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="pageprefixseparatorset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="pageprefixconversionset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="pageprefixset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="pageprefixsegments">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
<cd:constant method="range" prefix="cd:number" type="cd:number"></cd:constant>
<cd:constant method="range" prefix="cd:number" type="*"></cd:constant>
<cd:constant method="range" prefix="cd:number" type="all"></cd:constant>
<cd:constant type="cd:section"></cd:constant>
<cd:constant method="range" prefix="cd:section" type="cd:section"></cd:constant>
<cd:constant method="range" prefix="cd:section" type="*"></cd:constant>
<cd:constant method="range" prefix="cd:section" type="all"></cd:constant>
<cd:constant type="current"></cd:constant>
</cd:parameter>
<cd:parameter name="pageprefixconnector">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
<cd:constant method="apply" prefix="cd:processor" type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="pageconversionset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="pagestarter">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
<cd:constant method="apply" prefix="cd:processor" type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="pagestopper">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
<cd:constant method="apply" prefix="cd:processor" type="cd:command"></cd:constant>
</cd:parameter>
<cd:inherit name="setupcounter"></cd:inherit>
<cd:inherit name="setupframed"></cd:inherit>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description><!-- the long description of the command goes here -->
</cd:description>
<cd:examples></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="definecounter" originator="system"></cd:commandref>
<cd:commandref name="defineframed" originator="system"></cd:commandref>
<cd:commandref name="definelist" originator="system"></cd:commandref>
<cd:commandref name="setupalign" originator="system"></cd:commandref>
<cd:commandref name="setupcounter" originator="system"></cd:commandref>
<cd:commandref name="setupframed" 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="setupcombinedlist"></cd:commandref>
<cd:commandref name="definecombinedlist"></cd:commandref>
<cd:commandref name="definelistalternative"></cd:commandref></cd:seealso>
</cd:commandgroup>

Navigation menu