search

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.
GNU General Public License v2.0
9 stars 6 forks source link

New Name & better tags #86

Open willmot opened 9 years ago

willmot commented 9 years ago

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:

Here's some suggestions

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

dashaluna commented 9 years ago

@willmot good points!

How about HM Table of Contents that's @johnbillion suggested? Or is it better to avoid acronyms in the title all together?

I've got some questions that's related to renaming:

  1. The domain will stay the same hm-content-toc as well as the main plugin file name due to how things work with WP plugin repo?
  2. Shall we review the tags used by the plugin here as well? I've added a separate comment below - would be great to do it as well!
  3. The translations will have to reflect the rename changes?
  4. Would I need to change a name of the shortcode? I guess this means backwards compatibility .. not sure if yes, and if so how to handle that?

/cc @johnbillion

dashaluna commented 9 years ago

Current Tags: TOC, TOC shortcode, shortcode, content TOC, post TOC, page TOC, TOC for content, table of content, table of contents, HM, Human Made

Other plugins tags:

Proposed New Tags:

dashaluna commented 9 years ago

@johnbillion wanted to know your opinion re my questions ^. :) Thanks!

dashaluna commented 9 years ago

@willmot @johnbillion sorry to bugging you guys, just wanted to proceed with this :) Let me know your thoughts and advice. Thanks!

johnbillion commented 8 years ago

The domain will stay the same hm-content-toc as well as the main plugin file name due to how things work with WP plugin repo?

Yes, the text domain and plugin file name will stay the same.

Shall we review the tags used by the plugin here as well? I've added a separate comment below - would be great to do it as well!

I wouldn't worry quite so much about the tags, but your proposed new tags look good.

The translations will have to reflect the rename changes?

You'll need to get new translations for the plugin name, yes, but the rest of the translations won't be affected.

Would I need to change a name of the shortcode? I guess this means backwards compatibility .. not sure if yes, and if so how to handle that?

You can add another shortcode and leave the current one in place for back-compat. Just add another instance of add_shortcode() like there is here: https://github.com/dashaluna/hm-content-toc/blob/020d61feae262065165e54849a73d779b4f7be06/includes/class-content-toc.php#L39. Using [toc] for the shortcode might be a good idea.

dashaluna commented 8 years ago

Renaming the following:

  1. Actual plugin name
  2. Namespace
  3. Shortcode tag/name
  4. Labels on shortcake screen
  5. Labels on settings screen
  6. readme file

WAAAAAAAAAAAAAAA rename all the things, but keep the old shortcode name for some backwards compatibility.

willmot commented 8 years ago

👍

dashaluna commented 8 years ago

After looking at it again, I've decided to rename only user facing bits and leave everything else as is for backwards compatibility.

Renaming the following: