NAME

Blosxom Plug-in: purple

VERSION

0+1i

DESCRIPTION

Uses the PurpleWiki text formatting rules for blosxom entries. Will also integrate with an existing PurpleWiki installation. For example, it will link WikiWords in your blosxom entry to your PurpleWiki. See:

http://www.eekim.com/blog/

for an example.

Prerequisites

PurpleWiki. See:

http://www.blueoxen.net/tools/purplewiki/

http://purplewiki.blueoxen.net/

Configuration variables

$configDir is the location of your Wiki's configuration directory (usually called wikidb). There must be a valid PurpleWiki config file in the directory, even if you don't actually have a local Wiki installation.

Adding purple numbers to your entries

You can use the purple utility (different from this plugin) that comes with PurpleWiki to add purple numbers to your entries. However, you have to be a bit careful, because strictly speaking, a blosxom entry is not a legal PurpleWiki document. The first line of a blosxom entry is the title of the entry. To make sure that title is not inadvertently processed by the purple utility, make sure there are no blank lines between the title and the first paragraph.

Suppose you have the entry entry.txt under the category personal. Suppose that the URL that will point to this entry is:

http://foo.bar/blog/personal/entry.html

To preprocess entry.txt, do:

purple --add_ids --url=http://foo.bar/blog/personal/entry.html \
    /path/to/wikidb entry.txt

where /path/to/wikidb is the path to your wikidb directory. The --url option enables transclusions. If you don't need this feature, you can omit this option.

Working with the seemore plugin

To use with Todd Larason's seemore plugin, rename seemore so that it loads before purple. Preprocess your entry as described above, then follow the seemore instructions.

AUTHOR

Eugene Eric Kim, <eekim@blueoxen.org>

LICENSE

Copyright (C) 2003 Blue Oxen Associates.

(This license is the same as Blosxom's)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.