diff --git a/CHANGELOG b/CHANGELOG index db2a77d..6aaaf55 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,8 +1,14 @@ +0.3.0 +===== + - lots of tests + - + 0.2.0 =================== - simplification of status - addition of optional comment fields on edit - cache-based lock for writing + - rename view - added MARKUPWIKI_ settings - RSS for articles and wiki as a whole diff --git a/README.rst b/README.rst index 5dd9686..3c1c3f5 100644 --- a/README.rst +++ b/README.rst @@ -10,17 +10,43 @@ functionality. Pages can be edited, locked, and deleted. Revisions can be viewed, reverted, and compared. If you need much more than that markupwiki might not be for you. - Requirements ------------- +============ django-markupwiki depends on django 1.2+, django-markupfield 1.0.0b+ and libraries for whichever markup options you wish to include. -Settings -======== +Usage +===== +Like any django application, the first step when using django-markupwiki is +to add ``markupwiki`` to your ``INSTALLED_APPS``. + +urls +---- + +To use django-markupwiki's urls you should also add a line like:: + + url(r'^wiki/', include('markupwiki.urls')), + +to your urlconf. + +This will make the following views available (assuming the defined root is /wiki/): + + /wiki/rss/ - RSS feed of latest changes to wiki + /wiki/*article*/ - view the latest version of an article + /wiki/*article*/rss - RSS feed of changes to an article + /wiki/*article*/edit/ - edit (or create) an article + /wiki/*article*/history/ - history view for an article + /wiki/*article*/history/*revision*/ - view a specific version of an article + /wiki/*article*/diff/ - compare a two revisions of an article + +settings +-------- + +django-markupwiki provides a number of optional settings that you may wish to use +to customize the behavior. ``MARKUPWIKI_WRITE_LOCK_SECONDS`` - number of seconds that a user can hold a write lock (default: 300) diff --git a/TODO b/TODO index d73a3cc..673fa63 100644 --- a/TODO +++ b/TODO @@ -1,6 +1,6 @@ +* better documentation * revert option * wikiword highlighting * detect broken wiki links -* tests * only store diffs? * anonymous edits? diff --git a/setup.py b/setup.py index 0264aa6..8e78933 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ long_description = open('README.rst').read() setup( name='django-markupwiki', - version="0.2.0", + version="0.3.0", packages=['markupwiki'], package_dir={'markupwiki': 'markupwiki'}, package_data={'markupwiki': ['templates/markupwiki/*.html']},