Commit 869a62ea by benjaoming

Better install instructions for Issue #14 and #12

parent 43c32df6
django-wiki django-wiki
=========== ===========
*Last update: 2012-08-08* *Last update: 2012-08-11*
Demo here, sign up for an account to see the notification system. Demo here, sign up for an account to see the notification system.
...@@ -21,28 +21,61 @@ This is where it all begins. In less than *3* weeks we should have a wiki system ...@@ -21,28 +21,61 @@ This is where it all begins. In less than *3* weeks we should have a wiki system
Installation Installation
------------ ------------
1. Install.
pip install git+git://github.com/benjaoming/django-wiki.git pip install git+git://github.com/benjaoming/django-wiki.git
After that, add `'wiki'` and `'django_notify'` to `settings.INSTALLED_APPS` and the plugins (they aren't optional yet). 2. Configure `settings.INSTALLED_APPS`
You must remember to add the dependencies to `settings.INSTALLED_APPS` (`'mptt'`, `'sekizai'`, `'django.contrib.humanize'`) and run `syncdb`.
Make sure that the following is present:
'wiki',
'wiki.plugins.attachments',
'wiki.plugins.notifications',
'wiki.plugins.images',
'south',
'django_notify',
'mptt',
'sekizai',
'django.contrib.humanize',
3. Database
Run
python manage.py syncdb
python manage.py migrate
4. Configure `settings.TEMPLATE_CONTEXT_PROCESSORS`
Then, add `'sekizai.context_processors.sekizai'` to `settings.TEMPLATE_CONTEXT_PROCESSORS`. Then, add `'sekizai.context_processors.sekizai'` to `settings.TEMPLATE_CONTEXT_PROCESSORS`.
To integrate the wiki to your existing application, you shoud add the following lines to `urls`: 5. Include urlpatterns
url(r'^wiki/', include('wiki.urls', namespace='wiki')), To integrate the wiki to your existing application, you shoud add the following lines at the end of your project's `urls.py`.
url(r'^django_notify/', include('django_notify.urls', namespace='notify')),
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 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.attachments'`
* `'wiki.plugins.images'` * `'wiki.plugins.images'`
* `'wiki.plugins.notifications'` * `'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 Background
---------- ----------
...@@ -73,12 +106,17 @@ So far the dependencies are: ...@@ -73,12 +106,17 @@ So far the dependencies are:
* [django-mptt>=0.5](https://github.com/django-mptt/django-mptt) * [django-mptt>=0.5](https://github.com/django-mptt/django-mptt)
* [django-sekizai](https://github.com/ojii/django-sekizai/) * [django-sekizai](https://github.com/ojii/django-sekizai/)
If you are using pip or virtualenv, the dependencies could be installed Development
with the command `pip install -r requirements.txt`. ------------
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 Acknowledgements
---------------- ----------------
* The people at [edX](http://www.edxonline.org/) & MIT for finding and supporting the project both financially and with ideas. * 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-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.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment