django-wiki
===========
*Last update: 2012-08-22*
Demo here, sign up for an account to see the notification system.
[wiki.overtag.dk](http://wiki.overtag.dk)
NB!! *THIS IS A WORK IN PROGR...*
---------------------------------
Currently, the whole API is subject to change. That means, if you use the wiki, you should use it *as it is* and not access internals or override templates or write plugins... **yet!** But the games will soon begin, and Django South migrations are available.
Please refer to the [TODO](https://github.com/benjaoming/django-wiki/blob/master/TODO.md) for a detailed status or the Issue list.
Manifesto
---------
This is where it all begins. In *less than 1 week* we should have a wiki system appealing to any kind of Django developer out there. Here is the manifest (so far):
* **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](http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/) written for MediaWiki.
* **Be smart.** [This is](https://upload.wikimedia.org/wikipedia/commons/8/88/MediaWiki_database_schema_1-19_%28r102798%29.png) 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.
Installation
------------
### Install
Install directly from Github, since there is no release yet:
`pip install git+git://github.com/benjaoming/django-wiki.git`
### Configure `settings.INSTALLED_APPS`
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',
### Database
To sync and create tables, do:
python manage.py syncdb
python manage.py migrate
### Configure `settings.TEMPLATE_CONTEXT_PROCESSORS`
Add `'sekizai.context_processors.sekizai'` to `settings.TEMPLATE_CONTEXT_PROCESSORS`.
### 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](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](http://code.google.com/p/django-simple-wiki/), 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?** The markup engine will be pluggable, but Markdown will be the built-in supported one.
* **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.
Dependencies
------------
So far the dependencies are:
* [django=>1.4](http://www.djangoproject.com)
* [django-south](http://south.aeracode.org/)
* [Markdown>=2.2.0](https://github.com/waylan/Python-Markdown)
* [django-mptt>=0.5](https://github.com/django-mptt/django-mptt)
* [django-sekizai](https://github.com/ojii/django-sekizai/)
* [sorl-thumbnail](https://github.com/sorl/sorl-thumbnail)
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/openedx/django-wiki",
"name": "openedx-django-wiki",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "django wiki markdown",
"author": "Benjamin Bach",
"author_email": "benjamin@overtag.dk",
"download_url": "https://files.pythonhosted.org/packages/4d/cb/1f0c4a71905f18dfffbc3ec0122c8e3769dfc949174aaf9fae1d68fa138c/openedx-django-wiki-2.1.0.tar.gz",
"platform": null,
"description": "django-wiki\n===========\n\n*Last update: 2012-08-22*\n\nDemo here, sign up for an account to see the notification system.\n\n[wiki.overtag.dk](http://wiki.overtag.dk)\n\nNB!! *THIS IS A WORK IN PROGR...*\n---------------------------------\n\nCurrently, the whole API is subject to change. That means, if you use the wiki, you should use it *as it is* and not access internals or override templates or write plugins... **yet!** But the games will soon begin, and Django South migrations are available.\n\nPlease refer to the [TODO](https://github.com/benjaoming/django-wiki/blob/master/TODO.md) for a detailed status or the Issue list.\n\nManifesto\n---------\n\nThis is where it all begins. In *less than 1 week* we should have a wiki system appealing to any kind of Django developer out there. Here is the manifest (so far):\n\n * **Be pluggable and light-weight.** Don't integrate optional features in the core.\n * **Be open.** Make an extension API that allows the ecology of the wiki to grow. After all, Wikipedia consists of some [680 extensions](http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/) written for MediaWiki.\n * **Be smart.** [This is](https://upload.wikimedia.org/wikipedia/commons/8/88/MediaWiki_database_schema_1-19_%28r102798%29.png) 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.\n * **Be simple.** The source code should *almost* explain itself.\n * **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.\n\nInstallation\n------------\n\n### Install\n\nInstall directly from Github, since there is no release yet:\n\n`pip install git+git://github.com/benjaoming/django-wiki.git`\n\n### Configure `settings.INSTALLED_APPS`\n\nMake sure that the following is present:\n\n 'wiki',\n 'wiki.plugins.attachments',\n 'wiki.plugins.notifications',\n 'wiki.plugins.images',\n 'south',\n 'django_notify',\n 'mptt',\n 'sekizai',\n 'django.contrib.humanize',\n\n### Database\n\nTo sync and create tables, do:\n\n python manage.py syncdb\n python manage.py migrate\n\n### Configure `settings.TEMPLATE_CONTEXT_PROCESSORS`\n\nAdd `'sekizai.context_processors.sekizai'` to `settings.TEMPLATE_CONTEXT_PROCESSORS`.\n\n### Include urlpatterns\n\nTo integrate the wiki to your existing application, you shoud add the following lines at the end of your project's `urls.py`.\n\n from wiki.urls import get_pattern as get_wiki_pattern\n from django_notify.urls import get_pattern as get_notify_pattern\n urlpatterns += patterns('',\n (r'^notify/', get_notify_pattern()),\n (r'', get_wiki_pattern())\n )\n\nPlease use these function calls rather than writing your own include() call - the url namespaces aren't supposed to be customized.\n\nThe 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.\n\n### Settings\n\nFor now, look in [wiki/conf/settings.py](wiki/conf/settings.py) to see a list of available settings.\n\n### Other tips\n\n 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.\n\nPlugins\n------------\n\nAdd/remove the following to your `settings.INSTALLED_APPS` to enable/disable the core plugins:\n\n * `'wiki.plugins.attachments'`\n * `'wiki.plugins.images'`\n * `'wiki.plugins.notifications'`\n\nThe 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.\n\nBackground\n----------\n\nDjango-wiki is a rewrite of [django-simplewiki](http://code.google.com/p/django-simple-wiki/), 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.\n\nAs 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.\n\nContributing\n------------\n\nThis 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.\n\nQ&A\n------------\n\n * **Why is the module named just \"wiki\"?** Because \"pip install wiki\" returns \"No distributions at all found for wiki\"! :)\n * **What markup language will you use?** The markup engine will be pluggable, but Markdown will be the built-in supported one.\n * **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.\n\nDependencies\n------------\n\nSo far the dependencies are:\n\n * [django=>1.4](http://www.djangoproject.com)\n * [django-south](http://south.aeracode.org/)\n * [Markdown>=2.2.0](https://github.com/waylan/Python-Markdown)\n * [django-mptt>=0.5](https://github.com/django-mptt/django-mptt)\n * [django-sekizai](https://github.com/ojii/django-sekizai/)\n * [sorl-thumbnail](https://github.com/sorl/sorl-thumbnail)\n\nDevelopment\n------------\n\nIn a your Git fork, run `pip install -r requirements.txt` to install the requirements.\n\nThe 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.\n\nAcknowledgements\n----------------\n\n * The people at [edX](http://www.edxonline.org/) & MIT for finding and supporting the project both financially and with ideas.\n * [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.\n * [django-mptt](https://github.com/django-mptt/django-mptt), a wonderful utility for inexpensively using tree structures in Django with a relational database backend.\n\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A wiki system written for the Django framework.",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/openedx/django-wiki"
},
"split_keywords": [
"django",
"wiki",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e80f3628bee48a39c61978d80483aacc26d7f4910a7fc3aea30fb7c1cf1d6841",
"md5": "24b7749f0b2a8515b908062be7da4cd5",
"sha256": "135d2bb19af52ad6d44b09a71f1f86f655c85609f682fef78f39c6158414710e"
},
"downloads": -1,
"filename": "openedx_django_wiki-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24b7749f0b2a8515b908062be7da4cd5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 666422,
"upload_time": "2024-03-29T10:45:17",
"upload_time_iso_8601": "2024-03-29T10:45:17.159377Z",
"url": "https://files.pythonhosted.org/packages/e8/0f/3628bee48a39c61978d80483aacc26d7f4910a7fc3aea30fb7c1cf1d6841/openedx_django_wiki-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4dcb1f0c4a71905f18dfffbc3ec0122c8e3769dfc949174aaf9fae1d68fa138c",
"md5": "8947b6a2421118dfc53d9c498db52a05",
"sha256": "073873e38f895e6f905bf692f1a15c1e8b6d80c64889f1ed194da812ca26aa2d"
},
"downloads": -1,
"filename": "openedx-django-wiki-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "8947b6a2421118dfc53d9c498db52a05",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 607225,
"upload_time": "2024-03-29T10:45:19",
"upload_time_iso_8601": "2024-03-29T10:45:19.114835Z",
"url": "https://files.pythonhosted.org/packages/4d/cb/1f0c4a71905f18dfffbc3ec0122c8e3769dfc949174aaf9fae1d68fa138c/openedx-django-wiki-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 10:45:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openedx",
"github_project": "django-wiki",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "openedx-django-wiki"
}
JSON
