Author: eduardo.padoan
Date: Sat Sep 20 15:35:36 2008
New Revision: 163
Added:
trunk/docs/
trunk/docs/api.txt
trunk/docs/index.txt
trunk/docs/install.txt
Modified:
trunk/ (props changed)
trunk/README.rst
trunk/wiki/urls.py
Log:
Added a 'docs' directory and moved the README contents to install.rst and
api.rst. Also added a little more of documentation and removed some
comments.
Modified: trunk/README.rst
==============================================================================
--- trunk/README.rst (original)
+++ trunk/README.rst Sat Sep 20 15:35:36 2008
@@ -2,124 +2,4 @@
Django WikiApp
================
-
-Install
-=======
-
-To install WikiApp, simply put the `wiki` diretory (or a link to it)
-anywhere in you `PYTHONPATH`.
-
-
-Settings
-========
-
-To add the wiki to your site, add 'wiki' to the INSTALLED_APPS setting
-of your project.
-
-The are some settings you may want to add to configure wikiapp:
-
-WIKI_MARKUP_CHOICES
--------------------
-
-The markup style options you will give to your users when editing
-an article.
-
-Default
- A tuple defining `reST`_, `textile`_ and `markdown`_ as possible
- markup choices.
-
-WIKI_LOCK_DURATION
-------------------
-
-Defines the duration of the soft editing lock on article, in seconds.
-
-Values
- Any positive integer.
-
-Default
- 15
-
-WIKI_REQUIRES_LOGIN
--------------------
-
-Determines if the wiki will be for registered users only, or if it will
allow
-anonimous users.
-
-Values
- Either True (all views require logged users) or False.
-
-Default
- True
-
-WIKI_URL_RE
------------
-
-The wiki article title regexp to match on the url.
-Keep in mind that the url regexps must not contain groups inside groups,
-due to a Django bug.
-
-WIKI_WORD_RE
-------------
-
-The regexp to match to discover WikiWords on the article content.
-
-Urls
-====
-
-WikiApp comes with 2 urlconf files:
-
-urls.py
--------
-
-The main urlconf file. When including it in your project urlconf, you can
pass the following
-kwargs:
-
-group_slug
- The name of the slug field of the article group model.
- See `Article Groups`_ for more information.
-
-group_qs
- The article group queryset.
- See `Article Groups`_ for more information.
-
-article_qs
- The Article queryset. By default, all articles are listed.
-
-changes_qs
- The ChangeSet queryset. By default, all non-reverted changesets are
listed.
-
-template_dir
- The directory of the templates to use with wikiapp.
-
-extra_context
- A dictionary of variables that you want to render on the template.
-
-static_url.py
--------------
-
-Static files urls. Use if you want to see the example templates.
-
-Views Arguments
-===============
-
-You can customize some aspects of your wiki passing the following arguments
-when including urls.py:
-
-template
- To use a template with in a different path then the default for the view.
-
-extra_context
- A dict with any template variables you want to render.
-
-Article Groups
-==============
-
-
-Template Tags
-=============
-
-
-
-.. _`reST`: http://docutils.sourceforge.net/rst.html
-.. _`markdown`: http://daringfireball.net/projects/markdown/
-.. _`textile`: http://textile.thresholdstate.com/
+Django-Wikiapp is a complete wiki (for very small values of "complete"),
with support for multiple markup languages and revision control.
Added: trunk/docs/api.txt
==============================================================================
--- (empty file)
+++ trunk/docs/api.txt Sat Sep 20 15:35:36 2008
@@ -0,0 +1,79 @@
+===========================
+ Wikiapp API Documentation
+===========================
+
+
+Urls
+====
+
+WikiApp comes with 2 urlconf files:
+
+urls.py
+-------
+
+The main urlconf file.
+
+To use Wikiapp as a "top-level" application, your urls.py must look like
this::
+
+ urlpatterns = patterns('',
+ ...
+ (r'^mywiki/', include('wiki.urls')),
+ )
+
+When including it in your project urlconf, you can pass the following
kwargs:
+
+group_slug
+ The name of the slug field of the article group model.
+ See `Article Groups`_ for more information.
+
+group_qs
+ The article group queryset.
+ See `Article Groups`_ for more information.
+
+article_qs
+ The Article queryset. By default, all articles are listed.
+
+changes_qs
+ The ChangeSet queryset. By default, all non-reverted changesets are
listed.
+
+template_dir
+ The directory of the templates to use with wikiapp.
+
+extra_context
+ A dictionary of variables that you want to render on the template.
+
+static_url.py
+-------------
+
+Static files urls. Use if you want to test the example templates.
+
+Article Groups
+==============
+
+Instances of the `Article` model can be related to any other model instance
+that you want to serve as a group of articles.
+
+Example urls.py::
+
+ from myproj.myapp import models
+
+ wiki_args = {'group_slug_field': 'slug',
+ 'group_qs': models.MyGroup.objects.all()}
+
+ urlpatterns = patterns('',
+ ...
+ url(r'^(?P<group_slug>\w+)/wiki/', include('wiki.urls'),
wiki_args),
+ )
+
+.. note::
+ Because of the way that reversing urls works on Django, you could run
into
+ problems if you included the wikiapp urls for more than one group.
+ The soluction was to hardcode the url format as
/group_slug/wiki/ArticleName.
+
+
+Template Tags
+=============
+
+Wikiapp have some template tags and filters to simplify working with
multiple
+markup languages, WikiWords and to keep templates from violating the DRY
+(dont repeat yourself) principle.
Added: trunk/docs/index.txt
==============================================================================
--- (empty file)
+++ trunk/docs/index.txt Sat Sep 20 15:35:36 2008
@@ -0,0 +1,12 @@
+##############
+django-wikiapp
+##############
+
+Django-wikiapp provides the very miminum of functinalities one might
expect from a modern Wiki, like simple markup syntax and revision control,
leaving other website expecific features, like sitemaps, to the developers
integrating Wikiapp into their projects. Some Wikiapp features, like feeds
for article changes and article classification by tagging, depends on other
django reusable applications. Wikiapp articles can be "pluggled" to any
model that you want to serve as a "group" of articles.
+
+Contents:
+
+.. toctree::
+
+ install.txt
+ api.txt
Added: trunk/docs/install.txt
==============================================================================
--- (empty file)
+++ trunk/docs/install.txt Sat Sep 20 15:35:36 2008
@@ -0,0 +1,66 @@
+=================================
+Wikiapp Installation and Settings
+=================================
+
+To install WikiApp, simply put the `wiki` diretory (or a link to it)
+anywhere in you `PYTHONPATH`.
+
+
+Settings
+========
+
+To add the wiki to your site, add 'wiki' to the INSTALLED_APPS setting
+of your project.
+
+The are some settings you may want to add to configure wikiapp:
+
+WIKI_MARKUP_CHOICES
+-------------------
+
+The markup style options you will give to your users when editing
+an article.
+
+Default
+ A tuple defining `reST`_, `textile`_ and `markdown`_ as possible
+ markup choices.
+
+WIKI_LOCK_DURATION
+------------------
+
+Defines the duration of the soft editing lock on article, in seconds.
+
+Values
+ Any positive integer.
+
+Default
+ 15
+
+WIKI_REQUIRES_LOGIN
+-------------------
+
+Determines if the wiki will be for registered users only, or if it will
allow
+anonimous users.
+
+Values
+ Either True (all views require logged users) or False.
+
+Default
+ True
+
+WIKI_URL_RE
+-----------
+
+The wiki article title regexp to match on the url.
+Keep in mind that the url regexps must not contain groups inside groups,
+due to a Django bug.
+
+WIKI_WORD_RE
+------------
+
+The regexp to match to discover WikiWords on the article content.
+
+
+
+.. _`reST`: http://docutils.sourceforge.net/rst.html
+.. _`markdown`: http://daringfireball.net/projects/markdown/
+.. _`textile`: http://textile.thresholdstate.com/
Modified: trunk/wiki/urls.py
==============================================================================
--- trunk/wiki/urls.py (original)
+++ trunk/wiki/urls.py Sat Sep 20 15:35:36 2008
@@ -4,22 +4,6 @@
from wiki import views, models
from wiki.templatetags.wiki import WIKI_URL_RE
-# --- The urlconf of your project must be something like this:
-#
-#urlpatterns = patterns('',
-# (r'^mywiki/', include('wiki.urls')), # this file
-# (r'', include('wiki.static_urls')), # static files, testing only
-#)
-#
-# --- If you want groups of articles:
-#
-#from myproj.myapp import models
-#urlpatterns = patterns('',
-# url(r'^(?P<group_slug>\w+)/wiki/', include('wiki.views'),
-# {'group_slug_field': 'slug',
-# 'group_qs': models.MyGroup.objects.all()}),
-#)
-#
urlpatterns = patterns('',
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"pinax-updates" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/pinax-updates?hl=en
-~----------~----~----~----~------~----~------~--~---
