f(x) TOC

Description

f(x) TOC Simple Table Of Contents Plugin. Just add [toc] shortcode in content to display. This plugin will parse and grab all heading (h1 -h6) in your content and display it as structured table of contents (just like WikiPedia.org table of contents).

Features:

  1. Super simple and easy to use.
  2. Auto create Table of contents by listing all your headings in your content.
  3. The GPL v2.0 or later license. 🙂 Use it to make something cool.
  4. Support available at Genbu Media.

Shortcode Options:

You can use several options in [toc] shortcode:

  1. title: to change the title of table of contents, as default is Table of contents.
  2. title_tag: element wrapper for the title, the default is h2.
  3. list: you can use ul for unordered list (default), or ol for ordered list.
  4. depth: list depth (numeric). the default is 6.

Advance usage example using all the options:

[toc title=”This page content:” title_tag=”strong” list=”ol” depth=”1″]
Notes for developer:

Github

Development of this plugin is hosted at GitHub. Pull request and bug reports are welcome.

Hooks

List of hooks available in this plugin:

filter: fx_toc_default_args (array)

The default option for the shortcode.

filter: fx_toc_output (string)

HTML output of the shortcode.

Installation

  1. Navigate to “Plugins > Add New” Page from your Admin.
  2. To install directly from WordPress.org repository, search the plugin name in the search box and click “Install Now” button to install the plugin.
  3. To install from plugin .zip file, click “Upload Plugin” button in “Plugins > Add New” Screen. Browse the plugin .zip file, and click “Install Now” button.
  4. Activate the plugin.

FAQ

Can I add this in widget ?

No, you can only add this shortcode in content.

Can I dislay it in archive pages?

Yes, if your theme display full content, table of contents will be displayed.

How to style this ?

The Table of contents output is wrapped in fx-toc class. You can style it using CSS.

Reviews

Perfect the way it is!

Excellent plugin which does exactly what I was looking for. Unbloated (hope it stays that way) and hopefully updated when the need arises … without adding too many options to it.

Perfect the way it is.
Love it!

Thanks for making this one. 🙂

Read all 5 reviews

Contributors & Developers

“f(x) TOC” is open source software. The following people have contributed to this plugin.

Contributors

Translate “f(x) TOC” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.1.0 – 04 May 2016

  • Display TOC on archive pages too.
  • Strip tags for each list item to avoid problem in the future.
  • Add plugin action link for support.
  • new filter “fx_toc_output”.

1.0.0 – 11 Jan 2016

  • Init