WP Pukiwiki

Thank you for your interest with WP PukiWiki. It is a WordPress plugin that allows the WordPress author to write posts and pages using an eye-friendly texual format, instead of HTML. It features:

Table of contents

#contents

Headings

** Second level heading

Quotation

>> Second level quotation

Lists

– Second level item

Preformatted texts

#include <stdio.h>
void main() {
    printf("Hello world!\n");
}

Tables

| title1 | title2 | title3 |

| data1 | data2 | data3 |

Images

&ref(http://example.com/image.jpg,right,around);

Footnotes

Here is a mysterious sentence.((and its footnote))

Links

[[WordPress:http://wordpress.com/]]

Smileys

⌣ turns into

Table of contents †

Getting started †

You can obtain WP PukiWiki from plugin directory hosted by WordPress.org. Because WP PukiWiki uses PukiWiki system to render HTML, you also need to install PukiWiki, which you can obtain from PukiWiki official page.

Installation instructions †

1. Setup `PukiWiki` and make it accessible via http from your WordPress hosting server. If you have access to existing `PukiWiki` site, skip this step.*1 If you don’t, then download `PukiWiki` from PukiWiki official site. Install `PukiWiki` following the its installation instruction.
2. Download wp-pukiwiki.zip and unzip it. A folder/directory named `wp-pukiwiki` appears.
3. Open `wp-pukiwiki.php` with a text editor and modify the definition for `WPPW_URL` so that it points to the URL of your `PukiWiki` site.
4. Upload the `wp-pukiwiki` folder/directory to the `/wp-content/plugins/` directory of your WordPress hosting server.
5. Activate the plugin.

Quick start †

For those of you who are hasty I prepared a Getting started with WP PukiWiki page that briefly demonstrates how to use WP PukiWiki.

How to use WP PukiWiki †

WP PukiWiki sample page is a fairly comprehensive introduction to WP PukiWiki syntax. It demonstrates most of the PukiWiki syntax rules that you can use to write your posts and pages.

If you want to learn more consult the Pukiwiki official site.

• General introduction to PukiWiki
• Format rules

Some notes †

Accerelating your site with WP-Cache †

WP-Cache is one of the most used WordPress plugin. It implements server-side page caching mechanism. Although PukiWiki is a light-weight Wiki engine and its performance is faster than other Wiki engines such as WP-Dokuwiki, it is a good idea to activate WP-Cache plugin and remove burden of parsing Wiki syntax and rendering HTML from your WordPress hosting server. WP-Cache will turn your WordPress site blazingly fast.

WikiName †

Currently WP PukiWiki does not offer a good support for WikiNames. For this reason, you may see dangling links whose text ending with ?‘s generated everywhere in your text. If you feel these dangling links ugly, you can stop generation of them by modifying PukiWiki’s settings in a following manner:

1. Open pukiwiki.ini.php with a text editor.
2. Search for a line that starts with $nowikiname = and replace it with $nowikiname = 1;.
3. Save the file.

Known issues †

• WP PukiWiki does not work well with WordPress Mu

  WordPress Mu is a multi-user variant of WordPress. It is the system that wordpress.com is build. I found that WP PukiWiki and security mechanism of WordPress Mu interfere. WordPress Mu dislikes the <pukiwiki>/</pukiwiki> style tags. A wordaround is to modify wp-pukiwiki.php with your text editor and change definitions of WPPW_OPENTAG and WPPW_CLOSETAG that you and WPMU feels confortable, such as [pukiwiki] and ”