TOC Attributes Reference

Attribute Values Example Syntax Notes Backends

toc

auto, left, right, macro, preamble

:toc: left

Not set by default. Defaults to auto if value is unspecified.

html

auto, macro, preamble

:toc: macro

Not set by default. Defaults to auto if value is unspecified.

html (embeddable)

auto

:toc:

Not set by default. When the title page is enabled in PDF output, the table of contents is placed directly after the title page.

pdf

auto

:toc:

Not set by default. The placement and styling of the table of contents is determined by the DocBook toolchain configuration.

docbook

toclevels

1–5

:toclevels: 4

Default value is 2.

html, pdf

toc-title

user-defined

:toc-title: Contents

Default value is Table of Contents.

html, pdf

toc-class

valid CSS class name

:toc-class: floating-toc

Default value is toc.

html