= Debian README for the usemod-wiki package =

== Using multiple wiki instances ==

This package includes a wrapper script [1] that can be used to run multiple
usemod wiki instances in parallel without the need to edit the main wiki.pl
script.

[1] /usr/share/doc/usemod-wiki/examples/wiki-wrapper.pl

== UseModWiki and mod_perl ==

UseModWiki is currently not mod_perl clean. Using the provided wiki.pl as a
perl module and running multiple wiki instances will break as the configs
interfere. In the same line, the wiki-wrapper.pl script will break (at least)
the RSS feed with mod_perl. It is probably possible to convert wiki.pl to a
UseModWiki.pm that can run a single wiki instance, but this package does not
attempt to. Use Apache's cgi-script handler.

== Charset and Language ==

Up to version 0.92, this package did not specify a charset for the wiki pages,
which resulted in a us-ascii (depending on the client, latin1) default. The
config file in /etc/usemod-wiki/ now specifies utf-8. The charset conversion
script skeleton [2] can be used to convert legacy pages.

[2] /usr/share/doc/usemod-wiki/examples/convert-charset.sh

As of version 1.0-7, the NewFS setting has been activated to enable non-ascii
utf-8 characters. Please run ?action=convert when upgrading from an older
version.

The umtrans.pl script [3] can be used to translate the wiki messages to other
languages.

[3] /usr/share/usemod-wiki/umtrans.pl

== Patches ==

=== BodyOnly ===

If you set $BodyOnly = 1, the program will only output the HTML that is inside
the <body> tag in normal use. This can be used with SSI statements like the
following to embed the wiki in a custom layout template:

	<!--#exec cmd="/path/to/wiki.pl"-->

=== Unresolvable IP addresses ===

Using the special "unknown" token in the banned list will block all edits from
unresolvable IP addresses.

 -- Christoph Berg <myon@debian.org>  Thu,  6 Oct 2005 22:52:04 +0200

