1f57853e3a2b04ce927e92d11513cd292b0b9e76
[matthijs/upstream/blosxom-plugins.git] / general / wikieditish.README
1 # Blosxom Plugin: wikieditish
2 # Author(s): Rael Dornfest <rael@oreilly.com> 
3 # Version: 2003-05-27
4
5 # Quick Start
6
7 Welcome to the Blosxom [http://www.raelity.org/apps/blosxom/] wikieditish 
8 plug-in.
9
10 This package provides you all you need to get wikieditish up and running
11 on your Blosxom weblog.
12
13 Installation is quick and easy...
14
15 1. Drop the wikieditish plug-in file, found in this package's plugins 
16    directory, into your plug-ins directory (whatever you set as 
17    $plugin_dir in blosxom.cgi).
18
19 2.  wikieditish, being a well-behaved plug-in, won't do anything until you 
20     either set a password ($password) or turn off the password requirement 
21     (set $require_password = 0).
22
23 4. Move the contents of the flavours folder included in this distribution 
24    into your Blosxom data directory (whatever you set as $datadir in 
25    blosxom.cgi).  
26
27    Don't move the folder itself, only the files it contains!  If you don't
28    have the the sample flavours handy, you can download them from:
29
30    http://www.raelity.org/apps/blosxom/downloads/plugins/wikieditish.zip
31
32 5. Point your browser at one of your Blosxom entries, specifying the 
33    wikieditish flavour:
34
35    http://localhost/cgi-bin/blosxom.cgi/path/to/a/post.wikieditish
36
37    (Replace "localhost/cgi-bin/blosxom.cgi" with your weblog's URL and 
38    "/path/to/a/post" with the path to a weblog post, including its
39    filename.)
40
41 6. Edit the entry, supply your password (if required -- the default), and 
42    hit the Save button to save your changes.  
43
44 You can just as easily create a new blog entry by pointing your browser at a non-existent filename, potentially on a non-existent path (e.g. http://localhost/cgi-bin/blosxom.cgi/path/to/a/nonexistent_post.wikieditish).  Give the entry a
45 title and body, supply your password (again, if required), and hit the Save 
46 button.  The wikieditish plug-in will create a new blog entry for you on 
47 your specified path, creating the supplied path's directory structure for you
48 on the fly if necessary.
49
50 For detailed documentation, take a gander at the bottom of writeback
51 plug-in file itself or type: 
52
53   perldoc wikieditish