Commits

Patrick Samson committed 22e5c66

first page

Comments (0)

Files changed (1)

-== Welcome ==
+== Welcome to django-postman's documentation! ==
 
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
+This is an application for [[http://www.djangoproject.com|Django]]-powered websites.
 
-=== Wiki features ===
+Basically, the purpose is to allow authenticated users of a site to exchange private messages within the site.
+In this documentation, the word user is to be understood as an instance of a User, in the django.contrib.auth context.
 
-This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
+But it may be beneficial for a subscriber to receive inquiries from any visitor, that is even if non authenticated.
+For instance, a subscriber as a service provider wants an ask-me-details form on a presentation page
+to facilitate possible business contacts.
+In this case, the visitor is presented a compose message form with an additional field to give an email address
+for the reply. The email is obfuscated to the recipient.
 
-The wiki itself is actually a hg repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
+What is a message ? Roughly a piece of text, about a subject, sent by a sender to a recipient.
+Each user has access to a collection of messages, stored in folders:
 
-Go ahead and try:
+    * {{{Inbox}}} for incoming messages
+    * {{{Sent}}} for sent messages
+    * {{{Archives}}} for archived messages
+    * {{{Trash}}} for messages marked as deleted
 
-{{{
-$ hg clone http://bitbucket.org/psam/django-postman/wiki
-}}}
+In folders, messages can be presented in two modes:
 
-Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
+* by **thread**, for a compact view: the original message and its replies are grouped in a set to constitute one sole entry.\\
+  The lastest message (time deposit related) is the representative of the set.
+* by **message**, for an expanded view: each message is considered on its own.
 
-=== Syntax highlighting ===
+=== Moderation ===
 
-You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
+As an option, messages may need to be validated by a moderator before to be visible to the recipient.
+Possible usages are:
 
-Here's an example of some Python code:
+* control there is no bad words in the text fields.
+* make sure that no direct contact means are exchanged when the site is an intermediary and delivers services based on subscription fees.
 
-{{{
-#!python
+Messages are first created in a //pending// state. A moderator is in charge to move them to a //rejected// or //accepted// state.
+This operation can be done in two ways:
 
-def wiki_rocks(text):
-	formatter = lambda t: "funky"+t
-	return formatter(text)
-}}}
+* By a person, through the Admin site. A special simplified change view is provided, with one-click buttons to accept or reject the message.
+* Automatically, through one or more auto-moderator functions.
 
-You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
+=== Filters ===
 
-Have fun!
+As options, custom filters can disallow messages, in two ways:
+* user filter: a user is not in a state to act as a recipient
+* exchange filter: criteria for a message between a specific sender and a specific recipient are not fulfilled
+
+----
+
+== Contents ==
+
+   [[quickstart]]
+   [[features]]
+   [[tags-filters]]
+   [[management]]
+   [[faq]]
+
+