Display an automated table of contents via shortcode.
| Author: | James Kemp (profile at wordpress.org) |
| WordPress version required: | 4.0 |
| WordPress version tested: | 4.9.7 |
| Plugin version: | 1.0.3 |
| Added to WordPress repository: | 29-11-2017 |
| Last updated: | 31-07-2018
Warning! This plugin has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues when used with more recent versions of WordPress.
|
| Rating, %: | 94 |
| Rated by: | 6 |
| Plugin URI: | http://jckemp.com |
| Total downloads: | 26 741 |
| Active installs: | 400+ |
Click to start download
|
Screenshots
![Add the <code>[toc]</code> shortcode to any post/page/custom-post-type, at any position in the content.](https://ps.w.org/shortcode-toc/assets/screenshot-1.png?rev=1779328)
Add the [toc] shortcode to any post/page/custom-post-type, at any position in the content.
A nested list will be generated based on the headings within your chosen HTML element.
Add the anchor-text parameter.
When the anchor-text parameter is set, the text will be appended to your headings so your users can easily copy the link to that section.
Installation Instructions
- Upload the plugin files to the
/wp-content/plugins/shortcode-toc directory, or install the plugin through the WordPress plugins screen directly.
- Activate the plugin through the ‘Plugins’ screen in WordPress
Can I use the shortcode multiple times on a page?
No. Currently it’ll only work once per page.
The table of contents isn’t showing up.
Did you set the content parameter of the shortcode to a valid CSS selector on your page? This is a required argument.
Can I build a table of contents for just h2 and h3 tags?
Yup, your shortcode would look like this [toc content=".your-container" headers="h2,h3"]
Is there a PHP version of the shortcode?
You can use the do_shortcode() function like this:
<?php echo do_shortcode( '[toc content=".your-container"]' ); ?>
ChangeLog
v1.0.3 (31/07/2018)
[fix] Revert back to original anchorific. Bower one was an old version.
v1.0.2 (01/12/2017)
[update] Use latest anchorific.
v1.0.1 (30/11/2017)
[update] Remove anchor text by default.
[fix] Ensure ‘spy’ param works with true/false values.
v1.0.0 (29/11/2017)
[release] Initial release.
