TOC Formatter

Categories

Component ID

1951188

Component name

TOC Formatter

Component type

module

Maintenance status

Development status

Component security advisory coverage

covered

Downloads

2767

Component created

Component changed

Component body

Display formatter that adds a set of table of contents (TOC) links to the top of a text area field, and 'Move to top' links at each H2 tag in the text.

As this is a display formatter it can be used on any text, long text, or text with summary field, at any time. The user adding content to the field doesn't need to include any extra tokens in the text, the formatter works completely automatically.

This module uses PHP DOMDocument to manipulate content, so may be faster and more accurate than other modules that use a regex approach.

To Do

  • Only H2 currently supported, need to add support for other heading tags
  • Smooth jumping to anchor tags
  • Currently TOC is added automatically at top of text, add option to add TOC by including a token

Similar Modules

TOC Node

Unlike most other modules which only provide a TOC for individual fields, this module provides a TOC for the whole of a node.

Table Of Contents

Text format filter which converts user entered token into a table of contents. Has a lot of features.

TOC Filter

Text format filter which converts user entered token into a table of contents. A lightweight alternative to the Table Of Contents module.

Sponsorship

Development funded by Global Canopy Programme.