diff options
Diffstat (limited to 'macros/latex/contrib/tcolorbox/tcolorbox.doc.initoptions.tex')
-rw-r--r-- | macros/latex/contrib/tcolorbox/tcolorbox.doc.initoptions.tex | 57 |
1 files changed, 56 insertions, 1 deletions
diff --git a/macros/latex/contrib/tcolorbox/tcolorbox.doc.initoptions.tex b/macros/latex/contrib/tcolorbox/tcolorbox.doc.initoptions.tex index 48af585551..bb7c0361ce 100644 --- a/macros/latex/contrib/tcolorbox/tcolorbox.doc.initoptions.tex +++ b/macros/latex/contrib/tcolorbox/tcolorbox.doc.initoptions.tex @@ -376,10 +376,65 @@ To set a short title for headings with the default |\section| setting, use for e for all Students of my Course} \end{dispListing} -\medskip \begin{marker} The core of the list is generated by |\@starttoc|\marg{name} which can be wrapped into an own macro. \end{marker} \end{docCommand} +\clearpage + +\begin{marker} +The following options are not initialization options, but common options, +which are typically reasonable in connection with lists of |tcolorbox|es. +\end{marker} + +\begin{docTcbKey}{list entry}{=\meta{text}}{no default, initially unset} +If the \flqq list of tcolorbox(es)\frqq\ feature described in +%Subsection \ref{sec:listsof} from page \pageref{sec:listsof} +the current subsection +is used, this key +describes the \meta{text} for an entry into the generated list, e.\,g. +\begin{dispListing} +list entry={\protect\numberline{\thetcbcounter}My beautiful Example} +\end{dispListing} +See Section \ref{listing:exercises} from page \pageref{listing:exercises} +for a complete example.\par +If |\thetcbcounter| is omitted, \refKey{/tcb/list entry} could be used for +unnumbered boxes too. +\begin{marker} +This is a customization option. For numbered boxes, \refKey{/tcb/list entry} +typically has not to be given, because this entry will be generated automatically. +\end{marker} +\end{docTcbKey} + +\begin{docTcbKey}[][doc new=2014-09-19]{list text}{=\meta{text}}{style, no default} +This is a shortcut for setting \refKey{/tcb/list entry} to\\ +|\protect\numberline{\thetcbcounter}|\meta{text}. +So, the following settings are identical: +\begin{dispListing} +list text={My beautiful Example}, +list entry={\protect\numberline{\thetcbcounter}My beautiful Example} +\end{dispListing} +See Section \ref{listing:exercises} from page \pageref{listing:exercises} +for a complete example. +\end{docTcbKey} + +\begin{docTcbKey}{add to list}{=\marg{list}\marg{type}}{no default, initially unset} +If the \flqq list of tcolorbox(es)\frqq\ feature described in +%Subsection \ref{sec:listsof} from page \pageref{sec:listsof} +the current subsection +is used, list entries are +generated automatically. With this key, you can enforce an entry to the +given \meta{list} with the given \meta{type}. +This issues:\par +|\addcontentsline|\marg{list}\marg{type}\marg{entry text}\par +\meta{entry text} may be given by \refKey{/tcb/list entry}. +\begin{marker} +This is a customization option. For numbered boxes, this feature is configured +automatically, where +\meta{list} is set by \refKey{/tcb/new/list inside} and +\meta{type} is set by \refKey{/tcb/new/list type} +\end{marker} +\end{docTcbKey} + |