custom_toc

Overview

Custom TOC provides a field type that stores editable Table of Contents markup. The CKEditor widget can generate a starter TOC from a chosen source field and lets editors refine link text per page. The formatter renders the saved TOC so the published page matches the stored field value.

Features

• Generate a TOC from headings and edit link text per node.
• Keep TOC output stable across view modes.
• Handle missing or removed fields safely.

Requirements

• Drupal core 10 or 11.
• toc_api module enabled.

Installation

1. Enable the module.
2. Add the "TOC (CKEditor)" field to a content type.
3. Select a formatted text source field (text processing enabled).

Configuration

• Choose the source field for heading extraction.
• Set allowed text formats and a default format.
• Configure toc_api "TOC type" settings for headings and template.

Usage

1. Create or edit content with headings in the source field.
2. Click "Regenerate TOC" to build the initial markup.
3. Optionally edit the TOC HTML, then save the node.

Notes

• Avoid enabling toc_api_example to prevent heading id changes on view.