Download Plugin v0.2
Compatible with WordPress 2.8 and up.
This is a sidebar widget for WordPress that will generate a table of contents from the posts located within a specified category.
It is intended for authors of web fiction but should be useful to anyone using posts to write a book or similar in a serialized format.
The plugin appears to work, but this is an early release. Your feedback (and bug reports/suggestions) is very much appreciated.
Sample Web Fiction Using Ths Widget
Installation:
- Upload the `web-fiction-table-of-contents-widget` directory to the `/wp-content/plugins/` directory
- Activate the plugin through the ‘Plugins’ menu in WordPress
- The widget will now show up under Appearance/Widgets ready for use.
Support:
Muse’s Success Forums
Widget Configuration Options
The widget has several options which you can use to customise its behaviour. The
following is an outline of these options.
Title
By default we name the Table of Contents simply Table of Contents. This isn’t
always desirable however, so you can use this option to change Table of Contents
to anything you wish.
Category Containing Chapters
The plugin expects you to have a category dedicated to only containing the
chapters of your story/novel/etc. You need to tell the widget from which
category to generate the table of contents.
Format of Chapter Title
There are numerous ways authors have of naming their posts. Some use just the
chapter title. Others, use Chapter 33 with no title. Others still will specify
both like 33. Name.
| If you name your posts like this: | Use this: |
|---|---|
| Name of Chapter {ex: Heroes} | {num}. {title} |
| Chapter NUM (ex: Chapter 33) | {title} |
| NUM. Title (ex: 33. Heroes) | {title} |
| Chapter NUM: Title {Chapter 33: Heroes} | You should rename your chapters. |
{title} is the post’s title.
{num} is an auto-generated chapter number.
Display TOC in Chapters Only
You can choose to only display the table of contents on posts that are a part
of the category specified under Category Containing Chapters. This is especially
useful for authors with multiple stories on a single WordPress install as they
can choose to only display the table of contents related to the chapter
currently being read.
Use Ordered List
You should feel comfortable with CSS if you tick this option.
You can choose to use an ordered list rather then the default unordered list. If
you choose this option, you will want to set “Format of Chapter Title” to only
{title}, and probably wish to edit your stylesheet since WordPress themes don’t
by default style a sidebar widget that use’s the ol tag.
Donate!
If this plugin is useful to you, please consider donating.