FogBugz Wiki Article Index Plug-in

Overview

This plug-in adds a widget that you can insert into a FogBugz wiki to display an article index.

Feature Summary

It is very similar to the Fog Creek “Wiki Page Table of Contents” plug-in, except that it creates a table of contents listing all articles in the wiki, instead of a listing of headers within the same wiki article.

Insert Menu

Insert a wiki index from the editor's insert menu

Insert Dialog

Next, select the display options

Wiki Article Index
Wiki Article Index as the users would see it

Configuration Screen

exclude articles from the index on the config screen

Where do I get it?

You can download and install the Scratchout plug-in from the FogBugz plugin gallery, it is also available for all FogBugz on Demand users from the plug-in administration screen.

What does it cost?

Nada. It’s freeware. I haven’t attached any licensing terms to it yet, but am okay with you doing whatever you want with it so long as you don’t steal my work and claim it as your own.

System Requirements

This plug-in requires FogBugz 7.0 or later and will run on any of the platforms that support FogBugz plug-ins.

Frequently Asked Questions

How is this different from the Fog Creek “Wiki Page Table of Contents” plug-in?
That plug-in builds a table of contents from the header styles for the single article it is inserted into. This plug-in provides a table of contents listing all of the articles in the wiki.

Can I modify the look of the TOC that is displayed?
By editing the WikiArticleIndex.CSS file in the ZIP file before installing it, you can tweak the appearance to some degree. It’s safe to re-install the plug-in repeatedly if you need to do so while tweaking the CSS settings.

How can I exclude a wiki article from inclusion in the Table of Contents?
Open the relevant article and press the “Info” button in the top right corner to configure it. Then Uncheck the “Include this article in indexes” checkbox under the “Wiki Article Index” section.

My article is not showing up, even though “Include this article in indexes” is checked. What’s up with that?
The table of contents is designed to never include the current page (the one with the index in it) in the index.

Can I include this plug-in on a wiki template page?
Sorry. Not yet, but it is on the list for a future version.

Advertisements

2 Responses

  1. Hi John, is there any chance you would consider sending us the code for your Article Index plugin? I’ve described what we are trying to do here:
    http://fogbugz.stackexchange.com/questions/8250/wiki-alphabetical-title-index

    • I posted a response to your inquiry on FogBugz.StackExchange.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: