general/writeback.README

   1 # Blosxom Plugin: writeback
   2 # Author(s): Rael Dornfest <rael@oreilly.com>
   3 # Version: 2003-03-23
   4
   5 # Quick Start
   6
   7 Welcome to the Blosxom [http://www.raelity.org/apps/blosxom/] writeback plug-in.
   8
   9 This package provides you all you need to get writebacks up and running
  10 on your Blosxom weblog.
  11
  12 Installation is quick and easy...
  13
  14 1. Drop the writeback plug-in file, found in this package's plugins
  15    directory, into your plug-ins directory (whatever you set as
  16    $plugin_dir in blosxom.cgi).
  17
  18 2. Writeback, being a well-behaved plug-in, won't do anything until you set
  19    $writeback_dir.
  20
  21    While you can use the same directory as your blosxom $datadir (WriteBacks
  22    are saved as path/weblog_entry_name.wb), it's probably better to keep
  23    them separate.
  24
  25    I suggest: $writeback_dir = "$blosxom::plugin_state_dir/writeback";
  26
  27 3. Visit your site.  Once $writeback_dir is set, the next time you visit
  28    your site, the writeback plug-in will perform some checks, creating
  29    the $writeback_dir and setting appropriate permissions if it doesn'
  30    already exist.
  31
  32    (Check your error_log for details of what's happening behind the scenes.)
  33
  34 4. Move the contents of the flavours folder included in this distribution
  35    into your Blosxom data directory (whatever you set as $datadir in
  36    blosxom.cgi).
  37
  38    Don't move the folder itself, only the files it contains!  If you don't
  39    have the the sample flavours handy, you can download them from:
  40
  41 5. Point your browser at one of your Blosxom entries, specifying the
  42    writeback flavour:
  43
  44      http://localhost/cgi-bin/blosxom.cgi/path/to/a/post.writeback
  45
  46    (Replace "localhost/cgi-bin/blosxom.cgi" with your weblog's URL
  47     and "/path/to/a/post" with the path to a weblog post, including its
  48     filename.)
  49
  50 For detailed documentation, take a gander at the bottom of writeback
  51 plug-in file itself or type:
  52
  53   perldoc writeback