Diff: Help/ModeratedPagePlugin

Note: You are viewing an old revision of this page. View the current version.

Differences between version 2 and previous revision of Help/ModeratedPagePlugin.

Other diffs: Previous Major Revision, Previous Author

Newer page: version 2 Last edited on 9 September 2007 0:16 by harold Revert
Older page: version 1 Last edited on 17 January 2022 18:35 by harold Revert
@@ -1,91 +1,27 @@
-== What is a ModeratedPage? ==  
+_short description_  
  
-A ModeratedPage is a page-internal setting, which restricts certain actions on certain pages.  
-The requested action and page is stored internally and an email is sent to the moderators  
-described in the linked and locked ModeratedPage action page.  
-Any moderator may approve or reject the action by simply clicking an URL.  
-When approving the action, the requested action (edit, rename, ...) is performed.  
+! Usage  
+<verbatim>  
+ <?plugin ModeratedPage ?>  
+</verbatim>  
  
-In both cases the author is notified, so it's recommended for the  
-moderator to click on either the approve or reject links in the moderation email.  
-In case of multiple moderators: first comes, first serves.  
+! Arguments  
  
-== How to enable ModeratedPage on a single page? ==  
+page _(default: current pagename)_:  
+ The page to execute upon.  
  
-* Check the status of this action page, esp. the moderators in the  
- plugin line, if they had their emails stored in their  
- [[UserPreferences]], and if the action page is locked.  
-* Add a link to this action page in the page(s) in question.  
-* Save the page.  
-* Lock the page to actually change the moderation status. You may want to unlock it then.  
+! Example  
  
-== How to disable ModeratedPage on a single page ? ==  
+<verbatim>  
+<?plugin ModeratedPage ?>  
+</verbatim>  
  
-* Remove the link to this action page in the page(s) in question.  
-* Save the page.  
-* Lock the page to actually change the moderation status. You may want to unlock it then.  
+<?plugin ModeratedPage ?>  
  
-== Usage ==  
-{{{  
-<<ModeratedPage arguments>>  
-}}}  
+! Author  
+PhpWiki:ReiniUrban  
  
-== Arguments ==  
+! See Also  
  
-{| class="bordered"  
-|-  
-! Argument  
-! Description  
-! Default value  
-|-  
-| **moderators**  
-| comma-separated list of registered usernames or groups.  
-Each user should have his email defined in his prefs.  
-| "Administrators" or "<<SystemInfo ADMIN_USER>>"  
-|-  
-| **requirelevel**  
-| one of 0, 1, 2 or 10 on which moderation is used  
-| false (use requireaccess instead)  
-|-  
-| **requireaccess**  
-| comma-separated list of access perms, on which the moderation is used  
-"view,edit,create,list,remove,change"  
-| edit,remove,change  
-|}  
-  
-== Example ==  
-  
-{{{  
-<<ModeratedPage>>  
-}}}  
-  
-== How does it work internally? ==  
-  
-You need to lock the page additionally, so that the link parser performs  
-some magic whether the ModeratedPage link is present or not, for efficiency  
-reasons. It can be unlocked again, and even the ModeratedPage link may be removed.  
-The status will only be changed on the *lock* action, whether the ModeratedPage  
-link is present or not.  
-  
-The moderation status is stored in each page in question.  
-Each moderated action is stored in the page also, together with a randomly  
-created permission key to allow Grant by a simple external unauthorized request.  
-There's no timeout on moderated actions, so the actions may stack up.  
-The delayed actions may be performed in any order, there's no strict ordering to  
-follow for the moderator.  
-  
-== How to enable ModeratedPage on multiple/all pages? ==  
-  
-If you enable the config option ENABLE_MODERATEDPAGE_ALL, the page moderation status on  
-every page is automatically set to check this action page ModeratedPage.  
-  
-There may come another administrative plugin to change the moderation  
-status on selected pages.  
-  
-== Author ==  
-* [[Help:Reini Urban|Reini Urban]]  
-  
-<noinclude>  
 ---- 
-[[ PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
-</noinclude>  
+PhpWikiDocumentation Help:WikiPlugin  

version 2

short description

Usage

  <?plugin ModeratedPage ?>

Arguments

page (default: current pagename)
The page to execute upon.

Example

<?plugin ModeratedPage ?>

Author

PhpWiki:ReiniUrban

See Also


PhpWikiDocumentation Help:WikiPlugin