Table of Contents

Downloaded 527 times
Version 1.0.4
Released On
Updated On
File Size 7.82 Kb
MD5 Signature f68f53d55ba41aebc9b6d9ca303f23b7
Licence GNU General Public License, Version 2 or later

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

Depth

Set the maximum depth up to which Header tags in the content will be scanned to create the Table of Contents, eg: H1 - H3

Heading Tag

Default tag to use for the Table of Contents

Container Class

Alternate classname(s) for the Table of Contents container. Seperate multiple classnames with a space.

Heading Class

Alternate classname(s) for the Table of Contents Heading. Seperate multiple classnames with a space.

Usage

Select a place in the content to create the Table of Contents and click the Table of Contents button. A Table of Contents list will be created from existing Headings (H1 to H6) in the content, with a title of "Table of Contents".

The title is editable but to change the Table of Contents list items, change each Heading in the content and click the Table of Contents button again.

Changelog

1.0.4

Added
  • Added an option to set the Table of Contents depth from 1-6

1.0.3

Added
  • Added parameter options for Container Class, Header Tag and Header Class
  • Added data-wf-toc identifier attribute
  • Container and Header classes support multiple space seperated values

1.0.2

Fixed
  • TOC would generate unnecessary nested lists in some instances

1.0.1

Fixed
  • Updating the Table of Contents by clicking the button would replace any edits of the Table of Contents title