README

Introduction

This is Wikibot 0.5, by Earle Martin.

Wikibot is a bot that sits on IRC and adds things that you tell it to a wiki (if you don't know what that is, take a look at the WikiWikiWeb).

Setup

Wikibot is written in Perl, and has the following modules as prerequisites for operation:

• Bot::BasicBot
• Config::Tiny
• HTML::TokeParser
• HTTP::Request::Common
• LWP::UserAgent
• POE
• POE::Component::IRC

All of these modules are available from the CPAN. They have help on installing modules if you need it.

To configure wikibot, you must edit the wikibot.conf file. A copy called wikibot.conf.orig is provided should you damage or lose your main configuration file.

1. Enter the appropriate options for connecting to IRC.
2. Specify the kind of wiki software you're using. Currently supported values (case-insensitive) are:

   UseMod

   (UseModWiki)

   OddMuse

   (OddMuse)

   MoinMoin

   (MoinMoin)

   TWiki

   (TWiki)

   Kwiki

   (CGI::Kwiki)

3. Specify the URI of the wiki you want to add things to. Leave off any trailing slashes or question marks. Typical URI styles:
    
   • on a UseMod or OddMuse wiki:
     http://example.com/cgi-bin/wiki.pl
   • on a MoinMoin wiki:
     http://example.com/cgi-bin/moin/moin.cgi
   • on a TWiki wiki:
     http://example.com/cgi-bin/twiki/view/Main
   • on a Kwiki wiki:
     http://example.com/cgi-bin/kwiki/index.cgi
    
4. Specify the name of the default page on the wiki to add things to.
5. Choose if you want the nicknames of people using the bot to appear on the wiki page.
6. Specify any text strings to prepend and append to the comments you're putting on the page (if you want to apply wiki text formatting of some kind).

Usage

On IRC, address the bot with some text. It will be appended to the default page on the wiki that you specified. The bot will send the channel a notice to confirm.

<earle> wikibot: This is a comment.
-wikibot:#test- Added comment to IRC Scratchpad.

You can also tell it the name of a specific page on your wiki to add to.

<earle> wikibot: for Test Page: This is another comment.
-wikibot:#test- Added comment to Test Page.

Note that any question marks you include in a page name will be converted to spaces because they're not valid characters. Likewise, ampersands and plus symbols will be converted to "And".

Owner Commands

The person whose IRC nickname was entered in wikibot.conf as owner can control the bot, by issuing commands on-channel or in private messages. Valid commands:

• join #channel - join a specified channel
• leave #channel - leave a specified channel
• leave - leave the current channel
• quit - quit IRC

That's It

If you have any problems or questions, please feel free to contact the author. (I'd also be interested to hear from anyone using Wikibot.) I can generally be found on IRC in #core on irc.rhizomatic.net. I hope you like Wikibot.

The small print: for usage license and copyright information, see the file LEGAL that accompanies this distribution.