Pikiwiki - a wiki solution based on Python, Django and Pinax
============================================================

Pikiwiki is a wiki project solution that's driven by Django and Pinax. Some
features:

- Pinax based, that means: a hundred features out of the box, including
  user profiles, simple user signup and openid support.
- Uses `WakaWaka`_ as it's wiki engine with all it's features
- WYSIWYG Editor
- Realtime preview in the editor
- Creole markup language support
- Attachment support

.. _WakaWaka: https://github.com/bartTC/django-wakawaka/

Live example
============

I've deployed a working example under `pikiwiki.mahner.org`_ . Feel free
to create an account (OpenID works too!) and play with it.

.. _pikiwiki.mahner.org: http://pikiwiki.mahner.org/

Documentation
=============

A complete documentation follows.  So long, here is a quick installation guide:

1. Create a pinax environment and install all it's requirements. Pikiwiki is
   developed and tested under the latest **Pinax development** release. 
   (As writing this, it's v0.7beta3 and up).

2. Clone Pikiwiki::

    hg clone http://bitbucket.org/barttc/pinax-pikiwiki/

3. Install Pikiwiki's requirements::

    pip install -U -r pinax-pikiwiki/pikiwiki/requirements.txt

4. Change to the Pikwiki directory, syncronize your database and collect all
   static media::

    cd pinax-pikiwiki/pikiwiki/
    python manage.py syncdb
    python manage.py build_media

5. Start your server and login with the data you provided in the ``syncdb``
   command. Open Django's Administration (example.com/admin/) and go to 
   Groups -> WikiUsers -> Edit.
   
   Add some permissions to this group::
   
    attachments.add_attachment
    attachments.delete_attachment
    wakawaka.add_wikipage
    wakawaka.change_wikipage
    wakawaka.add_revision
    wakawaka.change_revision
    
   These permissions are automatically assigned to newly registered users.

6. Have fun, do the wiki thing.