Documentation

Tired of using Media Wiki? Sick of fighting with WordPress to get your own documentation project happening?

If so then the WP Wiki Plugin is the answer for you. The new WP Wiki Plugin made by the guys at Instinct (who brought you the famous WP e-Commerce Plugin) have developed a new Plugin that adds Wiki functionality to your WordPress powered website.

Plugin Features

• Ability to check posts and pages as “Wiki Editable”
• Ability for people to subscribe to your site and edit documentation
• Supports Internal links and Piped links
• Wiki Style Table of Contents (based on h2 and h3 tags)
• My Contributions Widget

Getting Started

Installing this Plugin adds the ability to assign a WordPress Page or a Post as “wiki editable”.

1. Installing the WP Wiki Plugin adds a new checkbox to the edit Page & Post screen. This is available underneath the main TinyMC box where you write your Page or Post.
2. Once this is checked it means that anybody logged in to your site as an “Wiki Editor” can edit those particular Pages.
3. Once a Page or Post has been checked as “Wiki Editable” you can edit that Page or Post from the front end of your site because there is now a list of revisions displayed underneath the main content for that Page or Post. The most recent revision has an edit link – if you click that you will be able to edit the Page / Post content.
4. If you click a past revision it is merely displayed – you can click through and peruse all old revisions.

Using the My Contributions Widget

1. The “My Contributions” Widget is available in the Widget page of your website. Just add it to any sidebar on your website and it will auto-magically appear. This module basically adds link to each page or post you have contributed too.

Using the Dashboard Widget / Admin Alerts

1. The Dashboard Widget updates whenever a new contribution is made to your Wiki. This a a feature for administrators. It maybe modified at some point more closely reflect the WordPress Comments system where there is an orange icon visible showing you how many new contributions have been made.

Using the RSS Feed

1. The url for your wiki feeds arehttp://domain.tld/?feed=wiki (if permalink is not enabled) and
   http://domain.tld/feed/wiki (if permalink is enabled)

Using Wiki Links

1. The WP Wiki Plugin supports Internal links and Piped links.

Using Table of Contents

1. You can select what pages and posts display a Table of Contents by select the checkbox underneath the Write Page / Post screen. This option is in the Wiki box as illustrated here.
2. When creating a Table of Contents, any h2 tags display as main sections and h3 tags display as sub-sections.

Installation – Getting Started

1. Copy the Plugin files (like you would any other) to /wp-content/plugins/ and then activate the wp wiki plugin
2. Edit a Post or Page and check it as being Wiki Editable (there is a new check-box on this page)
3. Now you have checked your Post or Page as “Wiki Friendly” you can view the page on your site – assuming you are logged in as an admin or as an editor you will now be able to see a list of revisions – the most recent of which has an “edit link”

Future RoadMap

• Ability to Collapse / Expand revision list
• My Watchlist Widget
• Possible Track Changes (need developer help and contributors)

License Information

• Oops we haven’t put the license in yet but it is under the GPL (same as WordPress).

Download WP Wiki Plugin

• Download WP Wiki Plugin
• Download WP Wiki Plugin – Brazilian Portuguese
• 下载WP Wiki Plugin中文版 -支持：Anson Ho