Recent changes to HowTo_TocChapterPrefix

HowTo_TocChapterPrefix modified by Markus Kohm

Markus Kohm — Wed, 13 Aug 2025 11:50:01 -0000

--- v4
+++ v5
@@ -1,7 +1,6 @@
 # Wie im Inhaltsverzeichnis bei Kapiteleinträgen der Nummer ein „Kapitel“ vorangestellt werden kann

-Das geht bei KOMA-Script primär über die Umdefinierung von `\addchaptertocentry`. Dabei muss für den Fall, dass eine Nummer angegeben wurde, also das erste Argument nicht leer ist, am besten `\chapapp` gefolgt von einem Leerzeichen eingefügt werden, also:
-
+Bei KOMA-Script-Versionen vor 3.46 ging das primär über die Umdefinierung von `\addchaptertocentry`. Dabei musste für den Fall, dass eine Nummer angegeben wurde, also das erste Argument nicht leer ist, am besten `\chapapp` gefolgt von einem Leerzeichen eingefügt werden, also:
 ```latex
 \renewcommand*{\addchaptertocentry}[2]{%
   \IfArgIsEmpty{#1}{% keine Nummer:
@@ -11,36 +10,38 @@
   }%
 }
 ```
-
-Zusätzlich muss allerdings noch dafür gesorgt werden, dass auch entsprechend viel Platz für die Nummer bereit steht. Das kann bei KOMA-Script wahlweise mit Hilfe von `\DeclareTOCStyleEntry`:
-
+Zusätzlich musste allerdings noch dafür gesorgt werden, dass auch entsprechend viel Platz für die Nummer bereit steht. Das kann bei KOMA-Script wahlweise mit Hilfe von `\DeclareTOCStyleEntry`:
 ```latex
 \DeclareTOCStyleEntry[numwidth=5.5em]{chapter}{chapter}
 ```
-
 oder `\RedeclareSectionCommand`:
-
 ```latex
 \RedeclareSectionCommand[tocnumwidth=5.5em]{chapter}
 ```
+erreicht werden. 

-erreicht werden. Ich selbst bevorzuge `\RedeclareSectionCommand`, weil man dabei nicht wissen muss, also in der KOMA-Script-Anleitung nachschlagen muss, dass es für Kapiteleinträge den Stil `chapter` gibt, der als erstes obligatorisches Argument bei `\DeclareTOCStyleEntry` anzugeben ist.
+Seit KOMA-Script 3.46 gibt es aber mit der `\DeclareTOCStyleEntry`-Option `numberprefix` für den Stil `tocline` – und damit auch für den davon abgeleiteten Stil `chapter` – die Möglichkeit, der Eintragsnummer direkt einen Präfix voranzustellen:
+```latex
+\DeclareTOCStyleEntry[dynnumwidth,numberprefix=\chapapp\ ]{chapter}{chapter}
+```
+oder:
+```latex
+\RedeclareSectionCommand[tocdynnumwidth,tocnumberprefix=\chapapp\ ]{chapter}
+```
+Hier habe ich es über `dynnumwidth` dem Paket `tocbasic` überlassen, die benötigte Breite für die Nummer einschließlich Präfix selbst zu bestimmen.
+
+Häufig wird bei einem solchen Stil außerdem gewünscht, dass nach der Nummer noch ein Doppelpunkt erfolgt.

 Insgesamt ergibt sich also:
-
 ```latex
 \documentclass{scrbook}
 \usepackage{blindtext}

-\renewcommand*{\addchaptertocentry}[2]{%
-  \IfArgIsEmpty{#1}{% keine Nummer:
-    \addtocentrydefault{chapter}{#1}{#2}% wie bisher
-  }{% mit Nummer:
-    \addtocentrydefault{chapter}{\chapapp\ #1}{#2}%
-  }%
-}
-
-\RedeclareSectionCommand[tocnumwidth=5.5em]{chapter}
+\DeclareTOCStyleEntry[%
+  dynnumwidth,% automatic detection of needed number width
+  numberprefix=\chapapp\ ,% number prefix: "Chapter " resp. "Appendix "
+  numberpostfix=:,% number postfix: ":" 
+]{chapter}{chapter}

 \begin{document}
 \tableofcontents
@@ -50,7 +51,7 @@
 \end{document}
 ```

-Warum `\chapapp` statt einer festen Zeichenfolge „Kapitel“ verwendet wurde, sollte klar werden, wenn man die Erklärung zu dieser Anweisung in der KOMA-Script-Anleitung oder im KOMA-Script-Buch nachliest. 
+Warum `\chapapp` statt `\chaptername` oder gar einer festen Zeichenfolge „Kapitel“ verwendet wurde, sollte klar werden, wenn man die Erklärung zu dieser Anweisung in der KOMA-Script-Anleitung oder im KOMA-Script-Buch nachliest. 

 Soll der Präfix auch bei nicht nummerierten Einträgen gesetzt und gleichzeitig der Text der Eintragstext wie bei den nummerierten Einträgen eingezogen werden, so ist eher die Eigenschaft `entrynumberformat` für `\DeclareTOCEntryStyle` bzw. `tocentrynumberformat` für`\RedeclareSectionCommand` zu verwenden und zusätzlich Option  `toc=numberline` zu setzen:

@@ -59,7 +60,7 @@
 \usepackage{blindtext}

 \newcommand*{\chapterentrynumberwithprefix}[1]{\chapapp\ #1}
-\RedeclareSectionCommand[tocnumwidth=5.5em,tocentrynumberformat=\chapterentrynumberwithprefix]{chapter}
+\RedeclareSectionCommand[tocdynnumwidth,tocentrynumberformat=\chapterentrynumberwithprefix]{chapter}

 \begin{document}
 \tableofcontents
@@ -81,7 +82,7 @@
 \renewcommand*{\tableofcontents}{\listoftoc[\contentsname]{toc}}% use tocbasic for the ToC
 \setuptoc{toc}{numberline}
 \newcommand*{\chapterentrynumberwithprefix}[1]{\csname @chapapp\endcsname\ #1}% \chapapp is unknown → use \@chapapp
-\DeclareTOCStyleEntry[numwidth=5.5em,entrynumberformat=\chapterentrynumberwithprefix]{tocline}{chapter}% style chapter is unknown → use style tocline
+\DeclareTOCStyleEntry[dynnumwidth,entrynumberformat=\chapterentrynumberwithprefix]{tocline}{chapter}% style chapter is unknown → use style tocline

 \begin{document}
 \tableofcontents

HowTo_TocChapterPrefix modified by Markus Kohm

Markus Kohm — Tue, 03 Aug 2021 08:14:01 -0000

--- v3
+++ v4
@@ -55,7 +55,7 @@
 Soll der Präfix auch bei nicht nummerierten Einträgen gesetzt und gleichzeitig der Text der Eintragstext wie bei den nummerierten Einträgen eingezogen werden, so ist eher die Eigenschaft `entrynumberformat` für `\DeclareTOCEntryStyle` bzw. `tocentrynumberformat` für`\RedeclareSectionCommand` zu verwenden und zusätzlich Option  `toc=numberline` zu setzen:

 ```latex
-documentclass[toc=numberline]{scrbook}
+\documentclass[toc=numberline]{scrbook}
 \usepackage{blindtext}

 \newcommand*{\chapterentrynumberwithprefix}[1]{\chapapp\ #1}

HowTo_TocChapterPrefix modified by Markus Kohm

Markus Kohm — Sat, 17 Jul 2021 14:09:33 -0000

HowTo_TocChapterPrefix modified by Markus Kohm

Markus Kohm — Wed, 23 Jun 2021 18:17:17 -0000

--- v1
+++ v2
@@ -78,7 +78,7 @@
 \usepackage{blindtext}
 \usepackage{tocbasic}

-\renewcommand*{\tableofcontents}{\listoftoc{toc}}% use tocbasic for the ToC
+\renewcommand*{\tableofcontents}{\listoftoc[\contentsname]{toc}}% use tocbasic for the ToC
 \setuptoc{toc}{numberline}
 \newcommand*{\chapterentrynumberwithprefix}[1]{\csname @chapapp\endcsname\ #1}% \chapapp is unknown → use \@chapapp
 \DeclareTOCStyleEntry[numwidth=5.5em,entrynumberformat=\chapterentrynumberwithprefix]{tocline}{chapter}% style chapter is unknown → use style tocline

HowTo_TocChapterPrefix modified by Markus Kohm

Markus Kohm — Wed, 23 Jun 2021 17:09:07 -0000

Wie im Inhaltsverzeichnis bei Kapiteleinträgen der Nummer ein „Kapitel“ vorangestellt werden kann

Das geht bei KOMA-Script primär über die Umdefinierung von \addchaptertocentry. Dabei muss für den Fall, dass eine Nummer angegeben wurde, also das erste Argument nicht leer ist, am besten \chapapp gefolgt von einem Leerzeichen eingefügt werden, also:

\renewcommand*{\addchaptertocentry}[2]{%
  \IfArgIsEmpty{#1}{% keine Nummer:
    \addtocentrydefault{chapter}{#1}{#2}% wie bisher
  }{% mit Nummer:
    \addtocentrydefault{chapter}{\chapapp\ #1}{#2}%
  }%
}

Zusätzlich muss allerdings noch dafür gesorgt werden, dass auch entsprechend viel Platz für die Nummer bereit steht. Das kann bei KOMA-Script wahlweise mit Hilfe von \DeclareTOCStyleEntry:

\DeclareTOCStyleEntry[numwidth=5.5em]{chapter}{chapter}

oder \RedeclareSectionCommand:

\RedeclareSectionCommand[tocnumwidth=5.5em]{chapter}

erreicht werden. Ich selbst bevorzuge \RedeclareSectionCommand, weil man dabei nicht wissen muss, also in der KOMA-Script-Anleitung nachschlagen muss, dass es für Kapiteleinträge den Stil chapter gibt, der als erstes obligatorisches Argument bei \DeclareTOCStyleEntry anzugeben ist.

Insgesamt ergibt sich also:

\documentclass{scrbook}
\usepackage{blindtext}

\renewcommand*{\addchaptertocentry}[2]{%
  \IfArgIsEmpty{#1}{% keine Nummer:
    \addtocentrydefault{chapter}{#1}{#2}% wie bisher
  }{% mit Nummer:
    \addtocentrydefault{chapter}{\chapapp\ #1}{#2}%
  }%
}

\RedeclareSectionCommand[tocnumwidth=5.5em]{chapter}

\begin{document}
\tableofcontents
\blinddocument
\addchap{Heading of not numbered chapter}
\blindtext
\end{document}

Warum \chapapp statt einer festen Zeichenfolge „Kapitel“ verwendet wurde, sollte klar werden, wenn man die Erklärung zu dieser Anweisung in der KOMA-Script-Anleitung oder im KOMA-Script-Buch nachliest.

Soll der Präfix auch bei nicht nummerierten Einträgen gesetzt und gleichzeitig der Text der Eintragstext wie bei den nummerierten Einträgen eingezogen werden, so ist eher die Eigenschaft entrynumberformat für \DeclareTOCEntryStyle bzw. tocentrynumberformat für\RedeclareSectionCommand zu verwenden und zusätzlich Option toc=numberline zu setzen:

documentclass[toc=numberline]{scrbook}
\usepackage{blindtext}

\newcommand*{\chapterentrynumberwithprefix}[1]{\chapapp\ #1}
\RedeclareSectionCommand[tocnumwidth=5.5em,tocentrynumberformat=\chapterentrynumberwithprefix]{chapter}

\begin{document}
\tableofcontents
\blinddocument
\addchap{Heading of not numbered chapter}
\blindtext
\end{document}

Ohne Option toc=numberline hat die Verwendung von tocentrynumberformat dagegen nur eine Wirkung auf die nummerierten Kapiteleinträge.

Die Lösung über entrynumberformat und \DeclareTOCStyleEntry funktioniert mit einigen Anpassungen übrigens auch mit den Standardklassen. Natürlich muss dann Paket tocbasic explizit geladen werden. Die Eigenschaft numberline setzt man für das Inhaltsverzeichnis dann über \setuptoc:

\documentclass{book}
\usepackage{blindtext}
\usepackage{tocbasic}

\renewcommand*{\tableofcontents}{\listoftoc{toc}}% use tocbasic for the ToC
\setuptoc{toc}{numberline}
\newcommand*{\chapterentrynumberwithprefix}[1]{\csname @chapapp\endcsname\ #1}% \chapapp is unknown → use \@chapapp
\DeclareTOCStyleEntry[numwidth=5.5em,entrynumberformat=\chapterentrynumberwithprefix]{tocline}{chapter}% style chapter is unknown → use style tocline

\begin{document}
\tableofcontents
\blinddocument
\chapter*{Heading of not numbered chapter}
\addxcontentsline{toc}{chapter}{Heading of not numbered chapter}
\blindtext
\end{document}