WordPress.org

Dzongkha

Get WordPress
WordPress.org

Plugin Directory

HM Content TOC

This plugin hasn’t been tested with the latest 3 major releases of WordPress. It may no longer be maintained or supported and may have compatibility issues when used with more recent versions of WordPress.

HM Content TOC

By Dasha Luna at Human Made
Download

Description

The plugin provides:

  • Shortcode [hm_content_toc] with title and headers attributes.
    The shortcode should be inserted into post/page content with optional attributes
    Example: [hm_content_toc title="TOC title" headers="h2, h3, h4"]
  • Plugin settings to specify default TOC settings for title and header, which will
    be used in case a shortcode is specified without attributes, i.e. [hm_content_toc]
    Plugin’s defaults are: empty title and headers h2, h3, h4, h5, h6
  • Integration with “Shortcake (Shortcode UI)” plugin

Bugs or feature requests

To report bugs or feature requests, please use Github issues.

Translations

  • English – default, always included
  • Русский (Russian) by Dasha Luna
  • Italiano (Italian) by Franz Vitulli
  • Português (Portuguese – Portugal) by Ana Silva

Note: All my plugins are localized/translatable by default. This is very important for
all users worldwide. So please contribute your language to the plugin to make it even more useful.
Please read the instructions on how to contribute a translation.

License: GPLv2 or later

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

Screenshots

  • WordPress Admin: Plugins page – a summary of the plugin with quick action links to plugin’s Settings and Documentation on github webiste.
  • WordPress Admin: Settings page – plugin’s default settings. These settings will be used when a shortcode [hm_content_toc] is specified without attributes. Shortcode attribute takes precedence over default settings.
  • WordPress Admin: Pages – example of a page that uses [hm_content_toc] shortcode with its attributes, to specify title that appears before TOC and HTML element names used to generate the TOC.
  • Main website: Example of a page with generated TOC with specified parameters.
  • Main website: Example of a page when a link from the TOC is clicked. In this case, the Heading #3 - third level link from the TOC is clicked, a visitor is taken to that heading within the page content. The URL uses an anchor that has been inserted before the heading in the page content.
  • WordPress Admin: Integration with Shortcake UI – the view when Add Media button is clicked. The Insert Post Element tab lists all registered shortcodes with Shortcake. The HM Content TOC is present to be inserted into post/page content.
  • WordPress Admin: Integration with Shortcake UI – the view when HM Content TOC box was clicked, allowing for shortcode parameters to be specified.

Installation

HM Content TOC can be installed like any other WordPress plugin.

  1. Upload the entire folder hm-content-toc to the /wp-content/plugins/ directory.
  2. Activate the plugin through the ‘Plugins’ menu in WordPress.

  3. Plugin settings will be added to WordPress Settings admin menu,
    i.e. Settings -> HM Content TOC Settings, to specify the default settings for the
    plugin.

    The settings page is visible only for users who can manage options, by default
    it is super administrators and administrators.

  4. Now you can use [hm_content_toc] shortcode in your post/page content to generate
    TOC for specified headers from that post/page content.

FAQ

1. What versions of WordPress are supported?

The plugin has been extensively tested on both standard and multisite installations
for the following WordPress versions:

Reviews

Not as good as it could be

སྤྱི་ཟླ་དགུ་པ། 3, 2016 1 reply
It works, but i do not like two things 1. there is only one level of UL. Especialy for headers i would prefer also possibility of nested TOC with H3 intended over H2 etc. 2. Integration with shortcake is fine on first sight, but the problem is, that the TOC is not visible in wysiwyg editor – the widget is there, but it has zero height, so it it almost impossible to work with it

Simple and works

སྤྱི་ཟླ་དགུ་པ། 3, 2016 1 reply
Works straight out of the box and does exactly what it says. All I wanted was a nice simple ToC without unneccesary bloat and this does just that. One thing I would have liked to have seen is that the jump links created were the text of the headers and not just “heading-1”, “heading-2″, etc. e.g. – My first h1 title – should be <h1 id=”my-first-h1-title”>My first h1 title</h1>. Better for SEO and better for screen readers. This is the only reason I didn’t give 5/5. Otherwise stellar plugin!
Read all 2 reviews

Contributors & Developers

“HM Content TOC” is open source software. The following people have contributed to this plugin.

Contributors

Translate “HM Content 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.0.1

  • Removed a full stop at the end of the plugin description as it was too long by WP standards – doh!

Meta

Ratings

See all
Log in to submit a review.

Support

Got something to say? Need help?

View support forum