To integrate the wiki to your existing application, you shoud add the following lines at the end of your project's `urls.py`.
from wiki.urls import get_pattern as get_wiki_pattern
from django_notify.urls import get_pattern as get_notify_pattern
urlpatterns += patterns('',
(r'^notify/', get_notify_pattern()),
(r'', get_wiki_pattern())
)
Please use these function calls rather than writing your own include() call - the url namespaces aren't supposed to be customized.
The above line puts the wiki in **/** so it's important to put it at the end of your urlconf. You can also put it in **/wiki** by putting `'^wiki/'` as the pattern.
Plugins
------------
Add the following to your `settings.INSTALLED_APPS` to enable some nifty plugins:
Add/remove the following to your `settings.INSTALLED_APPS` to enable/disable the core plugins:
*`'wiki.plugins.attachments'`
*`'wiki.plugins.images'`
*`'wiki.plugins.notifications'`
The notifications plugin is mandatory for an out-of-the-box installation. You can safely remove it from INSTALLED_APPS if you also override the **wiki/base.html** template.
If you are using pip or virtualenv, the dependencies could be installed
with the command `pip install -r requirements.txt`.
Development
------------
In a your Git fork, run `pip install -r requirements.txt` to install the requirements.
The folder **testproject/** contains a pre-configured django project and an sqlite database. Login for django admin is *admin:admin*. This project should always be maintained, although the sqlite database will be deleted very soon to avoid unnecessary conflicts.
Acknowledgements
----------------
* The people at [edX](http://www.edxonline.org/) & MIT for finding and supporting the project both financially and with ideas.
*[django-cms](https://github.com/divio/django-cms) for venturing where no django app has gone before in terms of well-planned features and high standards. It's a very big inspiration.
*[django-mptt](https://github.com/django-mptt/django-mptt), a wonderful utility for inexpensively using tree structures in Django with a relational database backend.