ApproveChanges

Changeset

29:acba83570c3d
2013-11-05 Paul Boddie raw files shortlog changelog graph Added documentation of the configuration settings. Tidied up the documentation. Added a "to do" item about the ApprovalQueueUser and how it may be superfluous.
README.txt (file) to-do/drop-approval-queue-user.txt (file)
     1.1 --- a/README.txt	Tue Nov 05 20:33:53 2013 +0100
     1.2 +++ b/README.txt	Tue Nov 05 22:18:45 2013 +0100
     1.3 @@ -77,7 +77,7 @@
     1.4  set up in a wiki. For this purpose, the resource_pages directory contains
     1.5  example pages defining the membership of two groups:
     1.6  
     1.7 -  ApprovedGroup:        the approved users group; users whose changes do not
     1.8 +  ApprovedGroup         the approved users group; users whose changes do not
     1.9                          need to approved and who can edit the wiki normally
    1.10  
    1.11    PageReviewersGroup    the reviews group; users who can review the changes
    1.12 @@ -123,6 +123,47 @@
    1.13  
    1.14    http://moinmo.in/HelpOnAccessControlLists
    1.15  
    1.16 +The configuration settings used by ApproveChanges are as follows:
    1.17 +
    1.18 +  queued_changes_page
    1.19 +  -------------------
    1.20 +
    1.21 +  The name of the subpage used to hold a queue of unapproved changes for a
    1.22 +  page. By default, this setting is set to ApprovalQueue.
    1.23 +
    1.24 +  Thus, edits to a page called WikiPage will get saved to a subpage called
    1.25 +  WikiPage/ApprovalQueue. See also the queued_changes_per_user setting.
    1.26 +
    1.27 +  queued_changes_per_user
    1.28 +  -----------------------
    1.29 +
    1.30 +  Whether the queued changes page resides below a user-specific subpage of the
    1.31 +  edited page. By default, this setting is set to False. When set to a true
    1.32 +  value, the username of any logged in unapproved user will be used when
    1.33 +  setting the name of the unapproved changes subpage.
    1.34 +
    1.35 +  Thus, any edits to a page called WikiPage will get saved to a subpage called
    1.36 +  WikiPage/User/ApprovalQueue with this setting enabled. Otherwise, the
    1.37 +  simpler form of subpage name will be used.
    1.38 +
    1.39 +  approved_editors_group
    1.40 +  ----------------------
    1.41 +
    1.42 +  This gives the name of the group page holding the names of approved wiki
    1.43 +  users. By default, it is set to ApprovedGroup. See "Resource Pages" above.
    1.44 +
    1.45 +  reviewers_group
    1.46 +  ---------------
    1.47 +
    1.48 +  This gives the name of the group page holding the names of reviewers. By
    1.49 +  default, it is set to PageReviewersGroup. See "Resource Pages" above.
    1.50 +
    1.51 +  queued_changes_user
    1.52 +  -------------------
    1.53 +
    1.54 +  This gives the name of the user who saves unapproved changes to approval
    1.55 +  queues. By default, it is set to ApprovalQueueUser.
    1.56 +
    1.57  Troubleshooting
    1.58  ---------------
    1.59  
    1.60 @@ -138,8 +179,6 @@
    1.61  Recommended Software
    1.62  --------------------
    1.63  
    1.64 -See the "Dependencies" section below for essential software.
    1.65 -
    1.66  The moinsetup tool is recommended for installation since it aims to support
    1.67  all versions of MoinMoin that are supported for use with this software.
    1.68  
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/to-do/drop-approval-queue-user.txt	Tue Nov 05 22:18:45 2013 +0100
     2.3 @@ -0,0 +1,3 @@
     2.4 +The ApprovalQueueUser is perhaps superfluous as it is also possible to grant
     2.5 +admin rights temporarily by adopting alternative security permissions and then
     2.6 +writing a comment with an ACL defined within it.