NAME
    README for PodWiki

DESCRIPTION
    PodWiki is a collaboratve Web-based authoring tool written in Perl which
    differs from other WikiWiki tools in that it uses Perl POD as its
    standard markup language. It is easy to install, runs on mod_perl, and
    has all required features of a WikiWiki tool, and in addition a build-in
    revision control system, authentication (users/groups), and evaluation
    of Perl code.

    PodWiki also understands foreign Wiki markups: WikiShorthand and
    TikiWiki markup.

REQUIREMENTS
    *   Apache webserver: http://www.apache.org/

    *   Perl5: http://www.perl.org/

    *   RCS revision control system:
        http://www.cs.purdue.edu/homes/trinkle/RCS/

    *   Optional ImageMagick: http://www.imagemagick.org/

    All required perl modules are included in the distribution and will be
    installed automatically, so you dont have to worry about them.

WHERE TO GET
    The main download location can be found at sourceforge:

    http://sourceforge.net/projects/podwiki

    You may download full releases or single modules separately (e.g.
    templates).

    The very latest sources are available via anonymous CVS on sourceforge
    too. Be warned: the CVS code may be totally buggy. Do not send bug
    reports for an unreleased version of PodWiki. However, patches are
    always welcome :-)

INSTALLATION
    There are two ways to install PodWiki. The preferred way is to use the
    supplied configure script which generates a Makefile for the
    installation. It is also possible to install the files manually.

  Installation via autoconf
    Enter the following command to create the Makefile:

     ./configure

    You can change some variables before installing, issue the following
    command to find out what can be tweaked:

     ./configure --help.

    Usually you would want to change the installation destination (--prefix)
    and the user/group podwiki will run as (--with-user and --with-group).

    You can select from a set of pre-defined templates for a site design,
    use the --with-template parameter. The default is "standard".

    PodWiki must be installed somewhere into your apache's document root.
    Make sure you have write permissions on the target directory.

    Now execute the command:

     make install

    This should install all the files into a new directory and set some
    permissions. Important: The data/ and images/ directories must be
    writable by the apache. The Makefile makes those directories writable
    for the user/group you specified in the Makefile. This is neccessary
    because PodWiki runs under the Userid of your apache and must be able to
    write pages.

    Basic installation is now complete.

  Manual Installation
    Copy the whole directory to your webservers document root, probably into
    a newly created directory. Make sure, the apache user is able to read
    the files and to enter the directories. Apply write permissions to data/
    and images/ to the apache user.

    Move podwiki.pl.in to podwiki.pl and edit the shebang line (replace
    @PERL@ with the current perl interpreter). Move podwiki.conf.in to
    podwiki.conf (replace @PASSWD@ with a default passwd).

    Basic installation is now complete.

CONFIGURATION
    During the installation process a .htaccess file has been installed in
    the podwiki root directory. You may edit this file to enable some
    features:

    To run PodWiki under mod_perl, uncomment the mod_perl block (everything
    within the <IfModule mod_perl.c> block). mod_perl is required for this
    feature.

    To enable URi rewriting, uncomment the block <IfModule mod_rewrite.c>.
    mod_rewrite required! Note: normally a page view request would look
    like:

      http://podwiki.org/podwiki.pl?page=UserHelp

    with reqriting it looks like:

      http://podwiki.org/UserHelp

    You may change the regular exprssion to match it your installation. E.g.
    if you installed PodWiki to /var/www/htdocs/intranet/podwiki while
    /var/www/htdocs/ is you document root, then the expression must be
    changed to:

     RewriteRule ^/intranet/podwiki/([A-Z][a-zA-Z\-\_\.]+)/?$   /podwiki.pl?page=$1  [PT]

    Now open the file podwiki.conf with an editor. You can change some vars.
    By default nothing have to be changed beside the 'direct' variable which
    must be turned on (set to '1') if you previously enabled rewriting.

CHANGE ROOT PASSWORD
    PodWiki includes an authentication system. By default a user 'root' will
    be created who is able to create more users.

    When PodWiki starts the first time, it presents you a "Change Password"
    dialog which makes it possible to set a new password for the root user
    of your PodWiki (the root user is the default administrator account).
    This dialog requires the default password which is defined in the config
    file in the variable "default_admin_passwd" and is only required the
    first time you start PodWiki.

    If you forgot the root password, use the script support/pwreset.pl in
    the distribution source directory. It asks you for the location of the
    PodWiki data/ directory and the new root password. It will not ask for
    the old password.

UPDATING
    If you are updating to a newer version of PodWiki, follow the normal
    installation procedure and install it into the same location as the
    previous version. Your data/ and images/ directories will not be
    overwritten. Only the program and library files will be installed.

    If you want to include the latest version of the documentation of
    PodWiki you have to use the "Doc-Update" function on the "Site
    Administration" within PodWiki. Just click on the link and PodWiki will
    import the new versions of the doc files into the RCS repository. If you
    have changed one or more of those pages you can de-select them. Note: If
    you made some changes to the PodWiki documentation which maybe
    interesting for other PodWiki users too, please send me the changed
    files so that I can incorporate them into the distribution.

USAGE
    The user guide can be viewed online:

    http://$yourserver/podwiki.pl?page=PodWikiHelp

    or:

    http://www.daemon.de/PodWikiHelp

    An offline version of the user documentation is supplied with the
    distribution tarball in the help/ directory.

    Just point your browser to the index.html file:

     tar xvfz podwiki-0.8.5.tgz
     cd podwiki-0.8.5/help
     konqueror index.html &

HELP and CONTACT
    To get help with PodWiki or to submit patches or even suggest new
    featured, use the mailinglist:

    <podwiki-devel@lists.sourceforge.net>

    You can subscribe easily to the list here:

    http://lists.sourceforge.net/lists/listinfo/podwiki-devel/

BUGS
    The preferred way to submit bugreports is to use the sourceforge
    bug-tracking facility:

    http://sourceforge.net/tracker/?group_id=107739&atid=649244

    Please be so kind and look if the bug your are submitting has not
    previously submitted by someone else before.

COPYRIGHT
    PodWiki (c) 2003-2007 by Thomas Linden <tom@daemon.de>.

LICENSE
    PodWiki is distributed under the terms of the GPL. The dsitribution
    contains a copy of the GPL in the file 'COPYING'.

AUTHORS
    Thomas Linden <tom@daemon.de> David A. Bright <BrightD@acm.org>

