changeset 2:910fa7e781b9

update whitepaper
author k0s <k0scist@gmail.com>
date Tue, 02 Feb 2010 16:39:08 -0500
parents 79ba50af9443
children f09ba04b2e29
files whitepaper.txt
diffstat 1 files changed, 74 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/whitepaper.txt	Mon Jan 04 21:17:41 2010 -0500
+++ b/whitepaper.txt	Tue Feb 02 16:39:08 2010 -0500
@@ -1,9 +1,39 @@
-= Discussions =
+Discussions
+===========
 
 All Discussions objects are basically the same.  You get a set of
 options which are inherited from the parent or provided.
 
-== Roles and Permissions ==
+Discussions (version 1) is a strict hierarchy with views on this object.
+Email messages (as per the python ``email`` module) are used as the
+basis of all message object:  that is, each object should be
+expressable as a set of headers and body.  Since email messages are
+hierarchal, the organization makes sense
+
+Discussion version 2 is planned to be a directed graph.
+
+Core concepts:
+ * events
+ * people
+ * moderation
+ * policy
+
+
+Events
+------
+
+The add_message event: this is the portal event for all messages going
+through discussions.  This may be via 
+
+ * email
+ * web
+ * command line
+
+This could provide a front for twitter, RSS, or other discussions instances.
+
+
+Roles and Permissions
+---------------------
 
 A member can be in one of three states with respect to a resource:  
 
@@ -18,9 +48,10 @@
  * non-members: if an agent isn't a member of a resource, they
    generally have lowest level priveleges.
 
-== Options ==
+Options and Configuration
+-------------------------
 
-Options can be in one of three states:  unset, set, and locked (and
+Configuration options can be in one of three states:  unset, set, and locked (and
 set + locked).  In
 the case where the option is locked, all children inherit the setting
 as well:
@@ -44,13 +75,16 @@
 (Forum or Discussion).
 
 
-= Members =
+Members
+-------
 
-== Preferences ==
+Preferences:
 
 Member preferences can also be set from the site level.
 
-= Digest =
+
+Digest
+------
 
 Different templates can be used to display different digest methods.
 For instance, you could display a brief form of the message with just
@@ -65,4 +99,36 @@
 }}}
 
 This can be used to facilitate a moderated digest.  Roundup emails can
-be sent about a discussion written and editted by the moderator.
\ No newline at end of file
+be sent about a discussion written and editted by the moderator.
+
+
+Hierarchy Example
+-----------------
+
+Both Forum and Conversation objects are MessageContainers.
+
+/foo
+ bar/--message 1
+     |       |
+     |       +-reply to message 1
+     |       |      |
+     |       |      \-"..."
+     |       |
+     |       \-"..."
+     |
+     +-message 2
+     |
+     \-message 3
+
+URL for reply posting: /foo/<message id>/reply
+(posts to /foo/<message id> )
+
+
+Message Objects
+---------------
+
+{ 'headers': {},
+  'messages': [ list, of, children ],
+  'next':
+  'previous':
+  'parent': } 
\ No newline at end of file