Command/setuplist

From Wiki
Jump to navigation Jump to search


\setuplist

Summary

The command \setuplist configures collected lists like for the TOC

Settings

\setuplist[...,...][...=...,...]
[...,...]list
statestart stop
locationnone here
typesimple command userdata
criteriumlocal intro reference sectionblock:reference all sectionblock:all text sectionblock:text current sectionblock:current here previous sectionblock:previous component section sectionblock:section
listname
widthfit broad dimension
heightfit broad dimension
depthfit broad dimension
symbolone two three none default
labelyes no none name
startercommand
stoppercommand
commandthreearguments
numbercommandoneargument
textcommandoneargument
pagecommandoneargument
pagenumberyes no always realpage
headnumberyes no always
beforecommand
aftercommand
inbetweencommand
marginnone dimension
distancenone dimension
aligntitleyes no
numberalignleft right middle flushleft flushright inner outer
alignsee \setupalign
hangyes no
leftcommand
rightcommand
interactionyes no all number text title page sectionnumber pagenumber
limittextyes no text
stylestyle command
colorcolor
numberstylestyle command
numbercolorcolor
textstylestyle command
textcolorcolor
pagestylestyle command
pagecolorcolor
referencenumber
extrasname
ordercommand all title
alternativea b c d e f g left right top bottom command none interactive paragraph horizontal vertical name
maxwidthdimension
pageprefixyes no
pageprefixseparatorsetname
pageprefixconversionsetname
pageprefixsetname
pageprefixsegmentsnumber number:number number:* number:all section section:section section:* section:all current
pageprefixconnectorcommand processor->command
pageconversionsetname
pagestartercommand processor->command
pagestoppercommand processor->command
...=...,...inherits from \setupcounter
...=...,...inherits from \setupframed

OptionExplanation
criterium
Default criterium is criterium=local for a newly defined list. That can cause an empty \placelist. Criterium criterium=component is used to establish ToC (and other lists) via project structures.
interaction
what part of content line should be interactive if \setupinteraction[state=start]
order
title sorts the list by title
alternative
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 \definelistalternative for exact details.
a number – title – pagenumber
b number – title – spaces – pagenumber
c number – title – dots – pagenumber
d number – title – pagenumber (continuous)
e title (framed)
f title (left, middle or right aligned)
g title (centered)
command use with own 3-parameter macro, e.g command=\MyListEntry. removes linking and bookmarks in the parameters, unless added by the supplied macro.
interactive use with own 3-parameter macro command=\MyListEntry. keeps linking and bookmarks in the parameters.

Description

Examples

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:

\setuppapersize[A7,landscape]
\setuplist[alternative=c]

\setuphead[subsubsection][number=no]
\setuplist[subsubsection][margin=20mm]

\starttext
  \placecontent
  \hairline
  \section{Section}
    \subsection{Subsection}
      \subsubsection{Subsubsection}
\stoptext

Left-hand page numbers

The following example positions the page number to the left of the list entry title:

\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]

The alternative=interactive is required to maintain hyperlinked page numbers when links are enabled in the document. Without the after=\endgraf items would be displayed on one line.

Using tabular numbers

In a long TOC it looks awkward if proportional numbers are used. It is better to enable the font feature tabularnumbers:

\setuplist
  [chapter]
  [pagestyle={\feature[+][tabularnumbers]}]

Notes

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: