dashaluna/hm-content-toc

WordPress plugin. Creates content TOC (table of contents) for specified header elements from the current post/page content. Adds anchor elements in the content just before the matched headers.

hm-content-toc's Issues

TOC's HTML markup

@sanchothefat Hey, wanted your feedback on TOC HTML structure. Currently I have the following:

<ul id="content-toc">
  <li><a href="#heading-1">Header 2.1</a></li>
  <li><a href="#heading-2">Header 2.2</a></li>
  <li><a href="#heading-3">Header 2.3</a></li>
  <li><a href="#heading-4">Header 3.1</a></li>
  <li><a href="#heading-5">Header 6</a></li>
</ul>

Can I improve it in any way? I was gonna add a class to either li or a with the header element, for example class="header-h2", so it can be targeted for styling. But then thought I'd ask your advice in general :) Thanks!

https://core.trac.wordpress.org/ticket/17817 has been fixed

As the issue in core has been fixed the hack is not needed anymore.
https://github.com/dashaluna/hm-content-toc/blob/master/includes/class-content-toc.php#L129-L152

Add shortcake integration

Inserts multiple anchor points for headers with the same text

Add French translation

Add Portuguese translation

Exclude headings

Hello, I am working on a project where we don't all of headings add to the TOC as they are not related.

The simple text looks like this. When the shortcode is processed it outputs a title.

[testshortcode header="Test Heading"]

<h2>1. Allgemeine Voraussetzungen</h2>
<h2>2. Fördertätigkeit</h2>
<h3>2.1 Werkbeiträge</h3>

My initial idea was to add a filter so that I could remove heading from $post_content before it was processed for heading. What do you think of adding a filter to line 150 of class-content-toc.php ?

Do you have another idea how I could exclude certain headings?

Add Human Made as a contributor

to the plugin header

Add shortcode UI to the editor

Use preg_quote on headers

So that regex is saver from breaking on headers having regex special characters

Admin - add option to add TOC to content automatically without shortcode

List all Native and Custom PT and checkbox whether to display TOC automatically for content.

Allow elements with attributes

At the moment regex works with simple elements, for example div, h2, h3 and so on. Allow elements to be matched with attributes, for example h2 class="section"

New Name & better tags

Whilst the current name does decribe the plugin I think it could be more user friendly.

I have a couple of issues with the current name:

• Do people know what TOC means?
• Content is mentioned twice.

Here's some suggestions

• Inline Table of Contents
• Table of Contents by Human Made
• Digest
• Compendium

Here's some other plugins that show up when searching for Table of Contents: https://wordpress.org/plugins/search.php?q=table+of+contents

Docs: add Translations Available to the plugin description

Add Bulgarian translation

Will ask Petya for help ;)

Add widget

Setup framework for translations

Add quick link to plugin's Settings on the main WP Plugins page

Add matched header element name as a class

add class class="hm-toc-item-<header-element>" to <li> elements to provide better means for styling

Make admin notice about Shortcake plugin dismissible

Add filter to matches

https://github.com/dashaluna/hm-content-toc/blob/master/includes/class-content-toc.php#L296

Params: matches, headers, content.
Aim: allow to filter matches before constructing the TOC.

Docs: add note to contributors to PR again develop branch

Shortcake doesn't allow markup in description

So the description text for the Header Elements is Comma separated list of HTML element names to generate TOC for. For example, default elements are: . NOTE: use <code>h2</code>, not <code>&lt;h2&gt;</code>.

Add images for WP plugin page

Make TOC class a singleton

Add README file

What happens if there are multiple TOCs on a page?

• each TOC needs a unique ID
• anchors should be inserted before a header in the content only once

Add Russian translation

Add Italian translation

TOC link text needs any html removed

Currently the TOC links show escaped HTML if a heading contains a link for example.

Ideally the link text taken from the tag should just show the text. You can use the strip_tags() function on output to do this.

Anchor is not inserted before a title with apostraphy

For example It's good to learn The link in the TOC is generated, but the anchor link is not inserted before the actual heading on the content.

How to version a plugin?

Is there a good info to read on this? @tcrsavage what's your approach?

Add option to generate hierarchical TOC markup

Instantiate plugin from itself

From @tcrsavage feedback
Probably put the class in it's own class file, then the main plugin file would just contain the plugin doc block, include the class file and instantiate the class.

Add admin UI for plugin settings

Add check if plugin file is accessed directly

// Abort - if this file is accessed directly and not via WP
if ( ! defined( 'ABSPATH' ) ) {
    exit;
}

Add Brazilian translation