=================================
Wikiapp Installation and Settings
=================================

To install WikiApp, simply put the `wiki` diretory (or a link to it)
anywhere in you `PYTHONPATH`.


Settings
========

To add the wiki to your site, add 'wiki' to the INSTALLED_APPS setting
of your project.

The are some settings you may want to add to configure wikiapp:

WIKI_MARKUP_CHOICES
-------------------

The markup style options you will give to your users when editing
an article.

Default
  A tuple defining, by default, `creole`_, `reST`_, `textile`_ and `markdown`_
  as possible markup choices::
    (
        ('creole', _(u'Creole')),
        ('restructuredtext', _(u'reStructuredText')),
        ('textile', _(u'Textile')),
        ('markdown', _(u'Markdown')),
    )

.. note::
   If you are updating from WikiApp 0.1, you will have to migrate your data from
   the old format: on the `markup` field of the `wiki_article`, 'crl' must turn into
   'creole', 'rst' into 'restructuredtext', 'txl' into 'textile' and 'mrk' into
   'markdown'.

WIKI_LOCK_DURATION
------------------

Defines the duration of the soft editing lock on article, in seconds.

Values
  Any positive integer.

Default
  15

WIKI_REQUIRES_LOGIN
-------------------

Determines if the wiki will be for registered users only, or if it will allow
anonimous users.

Values
  Either True (all views require logged users) or False.

Default
  True

WIKI_URL_RE
-----------

The wiki article title regexp to match on the url.
Keep in mind that the url regexps must not contain groups inside groups,
due to a Django bug.

WIKI_WORD_RE
------------

The regexp to match to discover WikiWords on the article content.

MARKUP_FILTER
-------------

Configurates `template_utils`_ markup template filters.
Must be at least ``(None, {})``.


.. _`creole`: http://www.wikicreole.org/
.. _`reST`: http://docutils.sourceforge.net/rst.html
.. _`markdown`: http://daringfireball.net/projects/markdown/
.. _`textile`: http://textile.thresholdstate.com/
.. _`template_utils`: http://api.rst2a.com/1.0/rst2/html?uri=http%3A//django-template-utils.googlecode.com/svn/trunk/docs/markup.txt
