# HG changeset patch
# User Paul Boddie <paul@boddie.org.uk>
# Date 1383686325 -3600
# Node ID acba83570c3d3aad0b0d69e4b6d617229a9f195d
# Parent  18c269d09d84347c980ebdc07a0ad2262d9ca43e
Added documentation of the configuration settings. Tidied up the documentation.
Added a "to do" item about the ApprovalQueueUser and how it may be superfluous.

diff -r 18c269d09d84 -r acba83570c3d README.txt
--- a/README.txt	Tue Nov 05 20:33:53 2013 +0100
+++ b/README.txt	Tue Nov 05 22:18:45 2013 +0100
@@ -77,7 +77,7 @@
 set up in a wiki. For this purpose, the resource_pages directory contains
 example pages defining the membership of two groups:
 
-  ApprovedGroup:        the approved users group; users whose changes do not
+  ApprovedGroup         the approved users group; users whose changes do not
                         need to approved and who can edit the wiki normally
 
   PageReviewersGroup    the reviews group; users who can review the changes
@@ -123,6 +123,47 @@
 
   http://moinmo.in/HelpOnAccessControlLists
 
+The configuration settings used by ApproveChanges are as follows:
+
+  queued_changes_page
+  -------------------
+
+  The name of the subpage used to hold a queue of unapproved changes for a
+  page. By default, this setting is set to ApprovalQueue.
+
+  Thus, edits to a page called WikiPage will get saved to a subpage called
+  WikiPage/ApprovalQueue. See also the queued_changes_per_user setting.
+
+  queued_changes_per_user
+  -----------------------
+
+  Whether the queued changes page resides below a user-specific subpage of the
+  edited page. By default, this setting is set to False. When set to a true
+  value, the username of any logged in unapproved user will be used when
+  setting the name of the unapproved changes subpage.
+
+  Thus, any edits to a page called WikiPage will get saved to a subpage called
+  WikiPage/User/ApprovalQueue with this setting enabled. Otherwise, the
+  simpler form of subpage name will be used.
+
+  approved_editors_group
+  ----------------------
+
+  This gives the name of the group page holding the names of approved wiki
+  users. By default, it is set to ApprovedGroup. See "Resource Pages" above.
+
+  reviewers_group
+  ---------------
+
+  This gives the name of the group page holding the names of reviewers. By
+  default, it is set to PageReviewersGroup. See "Resource Pages" above.
+
+  queued_changes_user
+  -------------------
+
+  This gives the name of the user who saves unapproved changes to approval
+  queues. By default, it is set to ApprovalQueueUser.
+
 Troubleshooting
 ---------------
 
@@ -138,8 +179,6 @@
 Recommended Software
 --------------------
 
-See the "Dependencies" section below for essential software.
-
 The moinsetup tool is recommended for installation since it aims to support
 all versions of MoinMoin that are supported for use with this software.
 
diff -r 18c269d09d84 -r acba83570c3d to-do/drop-approval-queue-user.txt
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/to-do/drop-approval-queue-user.txt	Tue Nov 05 22:18:45 2013 +0100
@@ -0,0 +1,3 @@
+The ApprovalQueueUser is perhaps superfluous as it is also possible to grant
+admin rights temporarily by adopting alternative security permissions and then
+writing a comment with an ACL defined within it.