Changes

Jump to navigation Jump to search
3,317 bytes added ,  21:03, 6 October 2022
no edit summary
</cd:parameter>
<cd:parameter name="criterium">
<cd:paramdoc>Default criterium is <cd:iref name="criterium" type="local"/> for a newly defined list. That can cause an empty {{cmd|placelist}}. Criterium <cd:iref name="criterium" type="component"/> is used to establish [http://wiki.contextgarden.net/Table_of_Contents#ToC_.28and_other_lists.29_via_project_structures ToC (and other lists) via project structures].</cd:paramdoc>
<cd:constant default="yes" type="local"></cd:constant>
<cd:constant type="intro"></cd:constant>
</cd:parameter>
<cd:parameter name="width">
<cd:paramdoc>The width of the heading number (which is left aligned).</cd:paramdoc>
<cd:constant type="fit"></cd:constant>
<cd:constant type="broad"></cd:constant>
</cd:parameter>
<cd:parameter name="margin">
<cd:paramdoc>Extra indent between the margin (where text would normally start) and the heading number.</cd:paramdoc>
<cd:constant type="none"></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="distance">
<cd:paramdoc>The gap between the heading number and the heading.</cd:paramdoc>
<cd:constant type="none"></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="interaction">
<cd:paramdoc>what part of content line should be interactive if {{cmd|setupinteraction|2=[state=start]}}</cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant type="no"></cd:constant>
<cd:constant type="command"></cd:constant>
<cd:constant type="all"></cd:constant>
<cd:constant type="title">sorts the list by title</cd:constant>
</cd:parameter>
<cd:parameter name="alternative">
<cd:paramdoc>Overall layout of the list. The alternatives a, b, c, etc. are predefined. The most flexible solution to implement a custom layout is to define a new custom one which can be set as argument to alternative, see {{cmd|definelistalternative}} for exact details.</cd:paramdoc> <cd:constant type="a">number – title – pagenumber</cd:constant> <cd:constant default="yes" type="b">number – title – spaces – pagenumber</cd:constant> <cd:constant type="c">number – title – dots – pagenumber</cd:constant> <cd:constant type="d">number – title – pagenumber (continuous)</cd:constant> <cd:constant type="e">title (framed)</cd:constant> <cd:constant type="f">title (left, middle or right aligned)</cd:constant> <cd:constant type="g">title (centered)</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">use with own 3-parameter macro, e.g <code>command=\MyListEntry</code>. removes linking and bookmarks in the parameters, unless added by the supplied macro.</cd:constant>
<cd:constant type="none"></cd:constant>
<cd:constant type="interactive">use with own 3-parameter macro <code>command=\MyListEntry</code>. keeps linking and bookmarks in the parameters.</cd:constant>
<cd:constant type="paragraph"></cd:constant>
<cd:constant type="horizontal"></cd:constant>
<cd:description><!-- the long description of the command goes here -->
</cd:description>
<cd:examples><cd:example title="Unnumbered ToC items, with some shift">Sometimes we need to insert unnumbered items into the ToC, and to specify them horizontal shift to "keep the look" of the other (numbered) items. Here "margin" option comes into play: <context source="yes">\setuppapersize[A7,landscape]\setuplist[alternative=c] \setuphead[subsubsection][number=no]\setuplist[subsubsection][margin=20mm] \starttext \placecontent \hairline \section{Section} \subsection{Subsection} \subsubsection{Subsubsection}\stoptext</context></cd:example><cd:example title="Use different alternatives for different levels in the same ToC">You can use different alternatives for different levels. <context source="yes">\setuppapersize[A7,landscape]\setuplist[alternative=c]\setuplist[subsection][alternative=d] \starttext \placecontent \hairline \section{Section} \subsection{Subsection} \subsubsection{Subsubsection}\stoptext</context></cd:example><cd:example title="Left-hand page numbers">The following example positions the page number to the left of the list entry title: <texcode>\define[3]\SectionToCEntry{ \leftaligned\bgroup \hbox to 2em{#3}% \hskip 1em \vtop{\hsize\dimexpr\textwidth-3em\relax#2}% \egroup} \setuplist [section] [alternative=interactive, command=\SectionToCEntry, after=\endgraf]</texcode> The <code>alternative=interactive</code> is required to maintain hyperlinked page numbers when links are enabled in the document. Without the <code>after=\endgraf</code> items would be displayed on one line.</cd:example><cd:example title="Using tabular numbers">In a long TOC it looks awkward if proportional numbers are used. It is better to enable the font feature tabularnumbers: <texcode>\setuplist [chapter] [pagestyle={\feature[+][tabularnumbers]}]</texcode></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="setupcombinedlist"></cd:commandref>
<cd:commandref name="definecombinedlist"></cd:commandref>
<cd:commandref name="definelistalternative"></cd:commandref><cd:wikipage page="Table of Contents"></cd:wikipage></cd:seealso>
</cd:commandgroup>
93

edits

Navigation menu