Table of Contents

Version 1.1.0
Released On
Updated On
File Size 11.09 Kb
MD5 Signature f51995c0b850aa010e0f536655b21b2a
Licence GNU General Public License, Version 2

Generates a Table of Contents in content from existing Headings

Installation

Install using the Joomla Extensions Installer - https://docs.joomla.org/Installing_an_extension

After installation, assign the plugin to an Editor Profile in Editor Profiles -> Features & Layout by dragging the icon into an editor toolbar row.

Add the button to the editor toolbar

Configuration

Parameters can be set in Editor Profiles -> Plugin Parameters -> Table of Contents.

Table of Contents Parameter Options
Table of Contents Parameter Options

Start Heading

Set the starting heading level to scan, e.g. 1 for H1, 2 for H2, etc.

Depth

Set the maximum heading depth to scan when generating the table of contents, e.g. H1-H3.

Heading Tag

Default tag to use for the Table of Contents

Container Class

CSS classes to apply to the table of contents container.

Heading Class

CSS classes to apply to the table of contents heading.

Container Class

CSS classes to apply to the table of contents container.

Heading Class

CSS classes to apply to the table of contents heading.

List Classes

CSS classes to apply to the table of contents list.

List Attributes

Additional attributes to add to the table of contents list. Add each attribute as a Name/Value pair.

Usage

Place the cursor in the content where you want to insert the Table of Contents, then click the Table of Contents button in the editor toolbar. A Table of Contents list will be generated from the existing heading elements (H1–H6) in the content, with the default title “Table of Contents”.

The title can be edited directly. To update the list items, modify the corresponding headings in the content and click the Table of Contents button again to regenerate the list.

To delete a Table of Contents list, click the list to select it, then click the Table of Contents button in the editor toolbar while holding the ALT key (or Option key on macOS). A confirmation prompt will be shown before the block is removed.