Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A wiki system with complex functionality for simple integration and a superb interface. Store your knowledge with style: Use django models.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.travis
django_notify
docs
testproject
wiki
.gitignore
.travis.yml
MANIFEST
README
README.md
TODO.md
model_chart_wiki.pdf
requirements.txt
setup.py

README.md

django-wiki

News: January 26, 2013

New release 0.0.11 is out. Fixed recursive inheritence of permissions, Issue#99.

News: January 9, 2013

Happy new year. We have added a bit more in the department of nptifying ourselves upon errors both in the installation process (Travis) and the demo version. Have a look further below.

Please consider any moment in life that you could have been writing unittests for django-wiki.

Demo

A demo is available here, sign up for an account to see the notification system.

wiki.overtag.dk

Community

Please use our mailing list (google group) for getting in touch on development and support:

django-wiki@googlegroups.com

twitter:djangowiki

THIS IS A WORK IN PROGRE...

Currently, the API is subject to smaller changes. South is used so no database changes will cause data loss. You are not encouraged to make your own fiddling with the internal parts of the wiki - the best idea is to customize it through overriding templates and making custom template tags. The second best strategy is to extend the wiki's class-based views.

Please refer to the TODO for a detailed status or the Issue list.

Manifesto

Django needs a mature wiki system appealing to all kinds of needs, both big and small:

  • Be pluggable and light-weight. Don't integrate optional features in the core.
  • Be open. Make an extension API that allows the ecology of the wiki to grow. After all, Wikipedia consists of some 680 extensions written for MediaWiki.
  • Be smart. This is the map of tables in MediaWiki - we'll understand the choices of other wiki projects and make our own. After-all, this is a Django project.
  • Be simple. The source code should almost explain itself.
  • Be structured. Markdown is a simple syntax for readability. Features should be implemented either through easy coding patterns in the content field, but rather stored in a structured way (in the database) and managed through a friendly interface. This gives control back to the website developer, and makes knowledge more usable. Just ask: Why has Wikipedia never changed? Answer: Because it's knowledge is stored in a complicated way, thus it becomes very static.

Ideas?

Please go ahead and post issues for discussion of ideas.

Installation

Install

To install the latest stable release:

pip install wiki

Install directly from Github, since there is no release yet:

pip install git+git://github.com/benjaoming/django-wiki.git

Configure settings.INSTALLED_APPS

The following applications should be listed - NB! it's important to maintain the order due to database relational constraints:

    'django.contrib.humanize',
    'south',
    'django_notify',
    'mptt',
    'sekizai',
    'sorl.thumbnail',
    'wiki',
    'wiki.plugins.attachments',
    'wiki.plugins.notifications',
    'wiki.plugins.images',

Database

To sync and create tables, do:

python manage.py syncdb
python manage.py migrate

Configure TEMPLATE_CONTEXT_PROCESSORS

Add 'sekizai.context_processors.sekizai' to settings.TEMPLATE_CONTEXT_PROCESSORS. Please refer to the Django docs to see the current default setting for this variable.

Include urlpatterns

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.

Settings

For now, look in wiki/conf/settings.py to see a list of available settings.

Other tips

  1. Account handling: There are simple views that handle login, logout and signup. They are on by default. Make sure to set settings.LOGIN_URL to point to your login page as many wiki views may redirect to a login page.

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.

Background

Django-wiki is a rewrite of django-simplewiki, a project from 2009 that aimed to be a base system for a wiki. It proposed that the user should customize the wiki by overwriting templates, but soon learned that the only customization that really took place was that people forked the entire project. We don't want that for django-wiki, we want it to be modular and extendable.

As of now, Django has existed for too long without a proper wiki application. The dream of django-wiki is to become a contestant alongside Mediawiki, so that Django developers can stick to the Django platform even when facing tough challenges such as implementing a wiki.

Contributing

This project will be very open for enrolling anyone with a good idea. As of now, however, it's a bit closed while we get the foundation laid out.

Q&A

  • Why is the module named just "wiki"? Because "pip install wiki" returns "No distributions at all found for wiki"! :)
  • What markup language will you use? Markdown. The markup renderer is not a pluggable part but has been internalized into core parts. Discussion should go here: https://github.com/benjaoming/django-wiki/issues/76
  • Why not use django-reversion? It's a great project, but if the wiki has to grow ambitious, someone will have to optimize its behavior, and using a third-party application for something as crucial as the revision system is a no-go in this regard.
  • Any support for multiple wikis? Yes, in an sense you can just imagine that you always have multiple wikis, because you always have hierarchies and full control of their permissions. See this discussion: https://github.com/benjaoming/django-wiki/issues/63

Dependencies

So far the dependencies are:

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.

Build Status

Acknowledgements

  • The people at edX & MIT for finding and supporting the project both financially and with ideas.
  • 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, a wonderful utility for inexpensively using tree structures in Django with a relational database backend.
Something went wrong with that request. Please try again.