wordpress simple table of contents plugin

Hi Guys,

Well I thought this could be a good addition to my Blog if I end up offering Table Of Contents for visitors to browse an article more efficiently. That’s when I decided to go ahead with this plugin.

This  plugin is called “JCWP Simple table of contents”

What does this plugin do?

Well it created a table on contents for your post completely on client side without putting any extra pressure on load times of your article.

Here are some screens that will tell you what this plugin does

Let me explain a bit what above settings means

1. Enabled:  You can enable or disable this plugin without actually deactivating the plugin. When you disable this plugin that means Table of contents will not appear at all.
2. Article parent Tag: You will seldom need to change this because its standard all across the WordPress Blog. However if your article is wrapped in some other class other than .entry-content then you will need to mention it here.
3. Scroll speed: You can control scroll speed when user is browsing from header A to header B
4. Text length per Item: Sometimes out header text is way to long. You can limit the number of characters displayed in the Table of contents by setting this value
5. Fancy Scroll: This plugin can make use of jScrollPane, you can beautify your TOC scroll by setting this value. A scroll will appear when height of your TOC exceeds the Table default height that you set.
6. Auto minimize: Yes if you don’t want TOC always visible to the user. User hovers on TOC triggers show/hide of TOC
7. Default height: I would recommend that it should be atleast 300px but you can set it to whatever you like.
8. Table title: Default is “Table of contents” I recommend that you shouldn’t set it more than 30 character in length.
9. Easing animation: Just in case you want something other than linear animation when scroll happens.
10. Position: Position your TOC to wherever you like it.
11. Powered by: Well this is my 5th WP plugin and your support matters to me a lot. so if you tick this box an invisible link will be placed in the footer of you website that points to this website.

How does it look

(minimized)

(Expanded – outdated screenshot)

Changelog

v0.9

• I used it for my internal blog

v1.01

• Submitted to wordpress
• Settings page added

Advertisement

Donations

Well I know that you won’t but its always worth asking just if you changed your mind. There are so many improvements that can be made to this plugin and your contribution will help fund my time for future updates and features.

Installation

Its really simple to install this plugin, here are the steps that you need to follow

1. Go to Plugins > Add New.
2. Under Search, type in “jcwp simple table of contents”.
3. WordPress will show a popup window will ask you to confirm your wish to install my Plugin.
4. If this is the first time you’ve installed a WordPress Plugin, enter the FTP login credential information. If you’ve installed a Plugin before, it will still have the login information.
5. Click Proceed to continue with the installation. The resulting installation screen will list the installation as successful or failed.
6. If successful in installation, click Activate Plugin to activate it, or Return to Plugin Installer for further actions.
7. Settings are available from Settings menu on the left

From the zip file downloaded form this page

I do not offer any more downloads because of the bandwidth cost that I was billed for in the past. All past downloads are still available but you can always get the latest version from wordpress.org

Future

There is so much room for improvement for this plugin and I am willing to spend some more time in future. There are atleast 4 improvements that I can think of right now and does exist in my JIRA Todo tasks.

Where can I get it

http://wordpress.org/extend/plugins/jcwp-simple-table-of-contents

Questions/Answers

1. Will you add more styles
   Yes! when I get some time
2. How can I edit styles myself
   Just look for jcwptoc.css file under plugin folder and that where you change those styles. I’ve kept it really simple so that you can use your imagination on what a TOC should look like for you site.
3. What if I want to add more tags other than default h1,h2,h3,h4 supported by plugin?
   This is bit tricky but I may extend this functionality in future release.

Demo

If you are using supported browser then look to your right for table of contents.

I hope that this plugin will be helpful to you in some form.

Cheers

Advertisement