Plugin: table-of-contents-plus (Used by 59,452 domains)

A powerful yet user friendly plugin that automatically creates a context specific index or table of contents (TOC) for long pages (and custom post types). More than just a table of contents plugin, this plugin can also output a sitemap listing pages and/or categories across your entire site.

Built from the ground up and with Wikipedia in mind, the table of contents by default appears before the first heading on a page. This allows the author to insert lead-in content that may summarise or introduce the rest of the page. It also uses a unique numbering scheme that doesn’t get lost through CSS differences across themes.

This plugin is a great companion for content rich sites such as content management system oriented configurations. That said, bloggers also have the same benefits when writing long structured articles.

Includes an administration options panel where you can customise settings like display position, define the minimum number of headings before an index is displayed, other appearance, and more. For power users, expand the advanced options to further tweak its behaviour – eg: exclude undesired heading levels like h5 and h6 from being included; disable the output of the included CSS file; adjust the top offset and more. Using shortcodes, you can override default behaviour such as special exclusions on a specific page or even to hide the table of contents altogether.

Prefer to include the index in the sidebar? Go to Appearance > Widgets and drag the TOC+ to your desired sidebar and position.

Custom post types are supported, however, auto insertion works only when the_content() has been used by the custom post type. Each post type will appear in the options panel, so enable the ones you want.

Collaborate, participate, fork this plugin on Github.

Shortcodes

The plugin was designed to be as seamless and painfree as possible and did not require you to insert a shortcode for operation. However, using the shortcode allows you to fully control the position of the table of contents within your page. The following shortcodes are available with this plugin.

When attributes are left out for the shortcodes below, they will fallback to the settings you defined under Settings > TOC+. The following are detailed in the help tab.

[toc]

Lets you generate the table of contents at the preferred position. Useful for sites that only require a TOC on a small handful of pages. Supports the following attributes:

• “label”: text, title of the table of contents
• “no_label”: true/false, shows or hides the title
• “wrapping”: text, either “left” or “right”
• “heading_levels”: numbers, this lets you select the heading levels you want included in the table of contents. Separate multiple levels with a comma. Example: include headings 3, 4 and 5 but exclude the others with heading_levels="3,4,5"
• “class”: text, enter CSS classes to be added to the container. Separate multiple classes with a space.
• “start”: number, show when this number of headings are present in the content.

[no_toc]

Allows you to disable the table of contents for the current post, page, or custom post type.

[sitemap]

Produces a listing of all pages and categories for your site. You can use this on any post, page or even in a text widget. Note that this will not include an index of posts so use sitemap_posts if you need this listing.

[sitemap_pages]

Lets you print out a listing of only pages. The following attributes are accepted:

• “heading”: number between 1 and 6, defines which html heading to use
• “label”: text, title of the list
• “no_label”: true/false, shows or hides the list heading
• “exclude”: IDs of the pages or categories you wish to exclude
• “exclude_tree”: ID of the page or category you wish to exclude including its all descendants
• “child_of”: “current” or page ID of the parent page. Defaults to 0 which includes all pages.

[sitemap_categories]

Same as [sitemap_pages] but for categories.

[sitemap_posts]

This lets you print out an index of all published posts on your site. By default, posts are listed in alphabetical order grouped by their first letters. The following attributes are accepted:

• “order”: text, either ASC or DESC
• “orderby”: text, popular options include “title”, “date”, “ID”, and “rand”. See WP_Query for a list.
• “separate”: true/false (defaults to true), does not separate the lists by first letter when set to false.

Use the following CSS classes to customise the appearance of your listing:

• toc_sitemap_posts_section
• toc_sitemap_posts_letter
• toc_sitemap_posts_list

Credits

This plugin was created and maintained for many years by conjur3r. We are grateful for all the hard work he put in and we are excited to continue to build on that!