WordPress.org

Plugin Directory

Test out the new Plugin Directory and let us know what you think.

Easy Table of Contents

Adds a user friendly and fully automatic way to create and display a table of contents generated from the page content.

A user friendly, featured focused plugin which allows you to insert a table of contents into your posts, pages and custom post types.

Features

  • Automatically generate a table of contents for your posts, pages and custom post types by parsing its contents for headers.
  • Optionally enable for pages and/or posts. Custom post types are supported, as long as their content is output with the the_content() template tag.
  • Optionally auto insert the table of contents into the page, selectable by enabled post type.
  • Provides many easy to understand options to configure when and where to insert the table of contents.
  • Many options are available to configure how the inserted table of contents appears which include several builtin themes. If the supplied themes do no meet you needs, you can create your own by choosing you own colors for the border, background and link color.
  • Multiple counter bullet formats to choose from; none, decimal, numeric and roman.
  • Choose to display the table of contents hierarchical or not. This means headings of lower priority will be nested under headings of higher priority.
  • User can optionally hide the table of contents. You full control of this feature. It can be disabled and you can choose to have it hidden by default.
  • Supports smooth scrolling.
  • Selectively enable or disabled the table of contents on a post by post basis.
  • Choose which headings are used to generate the table of contents. This too can be set on a post by post basis.
  • Easily exclude headers globally and on a post by post basis.
  • If you rather not insert the table of contents in the post content, you can use the supplied widget and place the table of contents in your theme's sidebar.
  • The widgets supports being affixed or stuck on the page so it is always visible as you scroll down the page. NOTE: this is an advanced option since every theme is different, you might need support from your theme developer to learn what the correct item selector to use in the settings to enable this feature.
  • The widget auto highlights the sections currently visible on the page. The highlight color is configurable.
  • Developer friendly with many action hooks and filters available. More can be added by request on Github. Pull requests are welcomed.

Live Examples

Here are links to documentation pages for several of the premium templates for the Connections Business Directory plugin which utilize the widget included with this plugin:

Roadmap

  • Fragment caching for improved performance.
  • Support for <!--nextpage-->.
  • Customizer support.

Requirements

  • WordPress version: >= 3.2
  • PHP version: >= 5.2.4

Credit

Easy Table Contents is a fork of the excellent Table of Contents Plus plugin by Michael Tran.

Requires: 3.2 or higher
Compatible up to: 4.5.5
Last Updated: 9 months ago
Active Installs: 2,000+

Ratings

4.6 out of 5 stars

Support

2 of 4 support threads in the last two months have been marked resolved.

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

100,1,1
100,1,1
100,1,1
100,1,1