Información de la Licencia y los Créditos

README FILE FOR THE POSTNUKE MODULE
===================================

WARNING
=======

THIS MODULE IS ALPHA CODE.

That means it probably has bugs in it. Some of them may be serious. Use it at
your own risk.

Having said that, it works for me!

***Please read all of this document***. I know it goes on a bit, but it
contains important information. If you don't do some of the things discussed
here, the wiki won't work!


INTRODUCTION
============

This module allows you to use Steve Wainstead's phpWiki scritp within Postnuke.
It requires at least version 0.7 of Postnuke. It is based on version 1.3.2 of
phpWiki, which is itself presently still in development (and is itself alpha
quality), although it is quite stable.

If you don't like the way the wiki looks (and some of the colours *are* a bit
odd), try editing the css files phpwiki.css and phpwiki-heavy.css. You may
need to do some tweaking to get the wiki to fit in with your chosen theme.


STARTING OFF
============

To use this module:

1) Create a subdirectory in your modules directory called phpWiki (or whatever
you want this module to be called). NOTE: You should not call it Wiki, or it
will cause conflicts with some of PostNuke's core code.

2) Change directory to that directory and untar/zip the files there.

3) Change the ownership of the files so that they can be seen by the user that
your web server runs as (e.g in Linux, try something like
chown -R apache.apache *

4) Check that the file permissions are set correctly. You probably need
something like chmod 400 for files and 500 for directories.

5) Create the tables in your datatbase as follows:

mysql -uusername -ppassword postnuke < schemas/schema.mysql

[NB: replace 'postnuke' with the name of your postnuke database]

[NB2: this will create tables in you PN database without any prefix. If
you want to use a prefix, you will need to edit the schema file first to
change the table names to something like prefix_tablename. You will also
need to change the 'prefix' setting in index.php]

6) Edit index.php as appropriate. A number of the options there are for
phpWiki as a standalone script, and have no effect in the module version. Some
options should not be changed or the module will not work. Make sure you read
the comments in the file before you change everything. You should not need to
change much at all, in fact.

7) Set up your PostNuke permissions - see the section on Security below.

8) Log in to your site as a user with Admin rights, and visit
http://yoursite.com//modules.php?op=modload&name=phpWiki&file=index

The first time you do that, the wiki will load a set of default pages. You
should see a message to that effect.

9) Use and enjoy!



SECURITY AND PERMISSIONS - ***THIS IS IMPORTANT***
==================================================

The original wiki at http://c2.com/cgi/wiki can be edited by *anyone*. I know
you may find that odd, but it works. In fact, one of the strengths of wiki is
the ability of anyone at all to contribute and edit contributions. There are no
barriers to entry, such as logins and passwords, so people feel encouraged to
contribute. Take a look at that site to see what I mean. Stay a while and
browse.

Some people, however, want security (whether or not it is actually a good idea).
There is a good discussion at http://www.usemod.com/cgi-bin/mb.pl?OnWikisAndSecurity

phpWiki does have security measures. Archived copies of pages can be kept, and
restored if someone deletes or defaces a page. Logs can (and do by
default)track ip address and resolved DNS names of editors. Also, you can log
in if you want to (and your contributions will be logged under your name), but
you don't have to. In fact, you can log in using any name. You probably
shouldn't use someone else's - its rude and may be illegal.

Having said all that, for the purposes of this PostNuke module I have made use
of PostNuke's permissions system. Read on...


POSTNUKE PERMISSIONS INTEGRATION
================================

This is not a guide to the use of the PostNuke permissions system. But you do
need to read this to get your wiki working. Before you start, you need to have a
general idea how the Permissions system works. Try the online manual on the
Admin/Permissions screen.

Out of the box, Postnuke gives all users, registered and unregistered, the Read
permission for all components (ie all parts of the system). So everyone should
be able to see your wiki. If they can't check that you have not edited the
permissions table to remove Read permissions from any particular group.
Similarly, by default, admins have Admin rights (no surprises there), so they
(and only they) will be able to administrate your wiki. To edit the wiki, a
user needs to be given the Edit permission. Unless you change something,
therefore, no-one except admins will be able to edit wiki pages, because noone
except admins has the Edit permission in a default installation. Since the whole
point of a wiki is that people can edit pages, this is probably not what you
want. So ...

If you want to allow everyone to edit, you need to make an entry in the group
permissions table **above the line which gives unregistered users Read
permissions**, but **below the line which gives Admins Admin permissions**,
which gives Edit permissions for the Wiki:: component to All Groups. The entry
in the instance column should be .*

If you want to allow only registered users (but not unregistered users) to edit,
do the same thing, but make the group Users instead of All Groups.

Summary
========

The Component column should always contain Wiki::

The Instance column should be contain .* (unless you are doing something fancy
- see Advanced permissions below)

The Groups column should contain All groups, users or anonymous (depending on
what you are trying to do)

The Permissions level column should contain Read (to allow the group see the
wiki at all), Edit (to allow it to edit pages), Admin (see if you can guess!)


Remember, permissions are applied from the top of the table down. So if a match
is found high up in the table, the permissions which follow will not be applied.
Put the more specific permissions at the top, and the more general ones further
down.


Advanced permissions
====================

Warning: This bit may be confusing. You probably don't need to know it. Don't
say I didn't warn you.

It is possible to exercise very fine grained control over who can do what with
the wiki. You can give different rights to different users (not just different
groups). You can give different rights to users or groups on a page by page
basis (hint: try pagename:.* as the instance, where pagename is the relevant
pagename!). You can even give people rights to do certain things (such as
lock/unlock pages) which they would not normally have (hint: try
pagename:[lock|unlock]:.* as the instance).

Bugs
====

Please report any bugs in the Wiki Module on the bug tracker at
mods.postnuke.com

If you are sure that the problem is with phpWiki, and not with the module,
report it to phpwiki-talk@lists.sourceforge.net


Lawrence Akka January 2002
lakka@users.sourceforge.net




Changes
====================
20030111 mats@kling.nu

**
Added pninit.php
This file creates the neccery tables in the database.

**
added

'prefix' => pnConfigGetVar('prefix')."_phpwiki_",

in index.php so phpwiki loads the right prefix.

**
added


$pathseparator=":"; // default Unix
if(strstr($_SERVER["SERVER_SOFTWARE"],"Win32")) // if Win32 user this
{
$pathseparator=";";
}
$peardir=pnModGetVar('phpWiki', 'peardir');

ini_set('include_path', ".".$pathseparator.$scriptdir.$pathseparator.$peardir);
}

in index.php so the pathseparator changes depending on OS and the peardir is loaded from the modules settings (changed in admin)

**
added pnadmin.php (lets the user enter the dir where PEAR is located)

**
added pnimages/admin.png (picture for the admin)

**
added pnlang\eng\admin.php (some text for the adminstuff)