annotate whitepaper.txt @ 1:79ba50af9443

add more notes
author k0s <k0scist@gmail.com>
date Mon, 04 Jan 2010 21:17:41 -0500
parents c904249afb04
children 910fa7e781b9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
1 = Discussions =
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
2
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
3 All Discussions objects are basically the same. You get a set of
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
4 options which are inherited from the parent or provided.
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
5
1
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
6 == Roles and Permissions ==
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
7
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
8 A member can be in one of three states with respect to a resource:
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
9
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
10 * administrator: has all rights over a resource except as set by
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
11 above resources; Administrators of the root ('/') resource are
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
12 site administrators and have all rights.
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
13
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
14 * members: has permissions of a resource as dictated by the
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
15 administrator (view, post, etc). [different types of members?
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
16 groups? probably not]
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
17
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
18 * non-members: if an agent isn't a member of a resource, they
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
19 generally have lowest level priveleges.
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
20
0
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
21 == Options ==
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
22
1
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
23 Options can be in one of three states: unset, set, and locked (and
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
24 set + locked). In
0
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
25 the case where the option is locked, all children inherit the setting
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
26 as well:
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
27
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
28 archive.lock = false
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
29
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
30 Locking an option prohibits any but a higher-level admin from
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
31 unlocking it. The higher-level admin is free to change the setting:
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
32
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
33 archive.lock = false
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
34 archive = true
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
35
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
36 This locks the archive of subchildren into the false state, but sets
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
37 the archive for this discussion in the current discussion.
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
38
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
39 This prevents archiving on any sublist. Messages to a list inherit
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
40 the list settings.
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
41
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
42 If an option is unset, it will use the settings of its parent, the
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
43 site defaults, or the application default, based on its type
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
44 (Forum or Discussion).
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
45
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
46
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
47 = Members =
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
48
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
49 == Preferences ==
c904249afb04 initial commit of discussions
k0s <k0scist@gmail.com>
parents:
diff changeset
50
1
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
51 Member preferences can also be set from the site level.
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
52
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
53 = Digest =
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
54
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
55 Different templates can be used to display different digest methods.
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
56 For instance, you could display a brief form of the message with just
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
57 the links:
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
58
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
59 {{{
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
60 Example of .ini configuration:
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
61
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
62 [digest:daily]
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
63 template = /path/to/templates/daily-digest.txt
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
64
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
65 }}}
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
66
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
67 This can be used to facilitate a moderated digest. Roundup emails can
79ba50af9443 add more notes
k0s <k0scist@gmail.com>
parents: 0
diff changeset
68 be sent about a discussion written and editted by the moderator.