Recent changes to HowTo_TocChapterPrefix

HowTo_TocChapterPrefix modified by Markus Kohm

Markus Kohm — Wed, 13 Aug 2025 11:49:59 -0000

--- v4
+++ v5
@@ -1,7 +1,6 @@
 # How to prepend a “Chapter” to the number of chapter entries in the table of contents.

-This can be done in KOMA-Script primarily by redefining `\addchaptertocentry`. In this case, if a number has been specified, i.e. the first argument is not empty, it is best to insert `\chapapp` followed by a whitespace character, i.e.:
-
+For KOMA-Script versions before 3.46 this can be done primarily by redefining `\addchaptertocentry`. In this case, if a number has been specified, i.e. the first argument is not empty, it is best to insert `\chapapp` followed by a whitespace character, i.e.:
 ```latex
 \renewcommand*{\addchaptertocentry}[2]{%
   \IfArgIsEmpty{#1}{% no number:
@@ -13,36 +12,37 @@
 ```

 Additionally you have to make sure that there is enough space for the number. This can be done in KOMA-Script with the help of `\DeclareTOCStyleEntry`:
-
 ```latex
 \DeclareTOCStyleEntry[numwidth=5.5em]{chapter}{chapter}
 ```
-
 or `\RedeclareSectionCommand`:
-
 ```latex
 \RedeclareSectionCommand[tocnumwidth=5.5em]{chapter}
 ```
-
 can be achieved.

-I myself prefer `\RedeclareSectionCommand`, because you don't need to know, i.e. look up in the KOMA-Script manual, that there is a style `chapter` for chapter entries, which has to be specified as the first mandatory argument to `\DeclareTOCStyleEntry`.
+Since KOMA-Script 3.46, however, the `\DeclareTOCStyleEntry` option `numberprefix` for the style `tocline`—and thus also for the style `chapter` derived from it—allows the entry number to be directly preceded by a prefix:
+```latex
+\DeclareTOCStyleEntry[dynnumwidth,numberprefix=\chapapp\ ]{chapter}{chapter}
+```
+or
+```latex
+\RedeclareSectionCommand[tocdynnumwidth,tocnumberprefix=\chapapp\ ]{chapter}
+```
+Here I have left it to the `tocbasic` package to determine the required width for the number including the prefix itself via `dynnumwidth`.
+
+In addition, a colon is often required after the number in this style.

 All in all, this results in:
-
 ```latex
 \documentclass{scrbook}
 \usepackage{blindtext}

-\renewcommand*{\addchaptertocentry}[2]{%
-  \IfArgIsEmpty{#1}{% no number:
-    \addtocentrydefault{chapter}{#1}{#2}% as before.
-  }{% with number:
-    \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
@@ -52,7 +52,7 @@
 \end{document}
 ```

-Why `\chapapp` was used instead of a static string “`chapter`” should become clear if you read the explanation of this statement in the KOMA-Script manual or in the German KOMA-Script book. 
+Why `\chapapp` was used instead `\chaptername` or of a static string “Chapter” should become clear if you read the explanation of this statement in the KOMA-Script manual or in the German KOMA-Script book. 

 If the prefix should also be set for unnumbered entries and at the same time the text of the entry should be indented as for numbered entries, rather use the property `entrynumberformat` for `\DeclareTOCEntryStyle` or `tocentrynumberformat` for `\RedeclareSectionCommand` and additionally set option `toc=numberline`:

@@ -61,7 +61,7 @@
 \usepackage{blindtext}

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

 \begin{document}
 \tableofcontents
@@ -83,7 +83,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 — Thu, 05 Jun 2025 08:27:13 -0000

--- v3
+++ v4
@@ -1,4 +1,4 @@
-# How to prepend a “chapter” to the number of chapter entries in the table of contents.
+# How to prepend a “Chapter” to the number of chapter entries in the table of contents.

 This can be done in KOMA-Script primarily by redefining `\addchaptertocentry`. In this case, if a number has been specified, i.e. the first argument is not empty, it is best to insert `\chapapp` followed by a whitespace character, i.e.:

HowTo_TocChapterPrefix modified by Markus Kohm

Markus Kohm — Wed, 28 Jul 2021 09:51:05 -0000

HowTo_TocChapterPrefix modified by Markus Kohm

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

--- v1
+++ v2
@@ -80,7 +80,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:20:32 -0000

How to prepend a “chapter” to the number of chapter entries in the table of contents.

This can be done in KOMA-Script primarily by redefining \addchaptertocentry. In this case, if a number has been specified, i.e. the first argument is not empty, it is best to insert \chapapp followed by a whitespace character, i.e.:

\renewcommand*{\addchaptertocentry}[2]{%
  \IfArgIsEmpty{#1}{% no number:
    \addtocentrydefault{chapter}{#1}{#2}% as before.
  }{% with number:
    \addtocentrydefault{chapter}{\chapapp\ #1}{#2}%
  }%
}

Additionally you have to make sure that there is enough space for the number. This can be done in KOMA-Script with the help of \DeclareTOCStyleEntry:

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

or \RedeclareSectionCommand:

\RedeclareSectionCommand[tocnumwidth=5.5em]{chapter}

can be achieved.

I myself prefer \RedeclareSectionCommand, because you don't need to know, i.e. look up in the KOMA-Script manual, that there is a style chapter for chapter entries, which has to be specified as the first mandatory argument to \DeclareTOCStyleEntry.

All in all, this results in:

\documentclass{scrbook}
\usepackage{blindtext}

\renewcommand*{\addchaptertocentry}[2]{%
  \IfArgIsEmpty{#1}{% no number:
    \addtocentrydefault{chapter}{#1}{#2}% as before.
  }{% with number:
    \addtocentrydefault{chapter}{\chapapp\ #1}{#2}%
  }%
}

\RedeclareSectionCommand[tocnumwidth=5.5em]{chapter}

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

Why \chapapp was used instead of a static string “chapter” should become clear if you read the explanation of this statement in the KOMA-Script manual or in the German KOMA-Script book.

If the prefix should also be set for unnumbered entries and at the same time the text of the entry should be indented as for numbered entries, rather use the property entrynumberformat for \DeclareTOCEntryStyle or tocentrynumberformat for \RedeclareSectionCommand and additionally set option toc=numberline:

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

Without the toc=numberline option, using tocentrynumberformat will only affect the numbered chapter entries.

The solution using entrynumberformat and \DeclareTOCStyleEntry also works with the standard classes with some adjustments. Of course, package tocbasic must then be loaded explicitly. The numberline property is then set for the table of contents via \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}