[phpwiki-checkins] SF.net SVN: phpwiki:[7386] trunk/pgsrc

[<var...@us...>]

Revision: 7386
          http://phpwiki.svn.sourceforge.net/phpwiki/?rev=7386&view=rev
Author:   vargenau
Date:     2010-05-07 13:14:26 +0000 (Fri, 07 May 2010)

Log Message:
-----------
Describe UserRatings plugin

Modified Paths:
--------------
    trunk/pgsrc/Help%2FRateItPlugin
    trunk/pgsrc/Help%2FUserRatingsPlugin

Modified: trunk/pgsrc/Help%2FRateItPlugin
===================================================================
--- trunk/pgsrc/Help%2FRateItPlugin	2010-05-07 10:04:26 UTC (rev 7385)
+++ trunk/pgsrc/Help%2FRateItPlugin	2010-05-07 13:14:26 UTC (rev 7386)
@@ -1,4 +1,4 @@
-Date: Thu, 15 Apr 2010 16:32:58 +0000
+Date: Fri,  7 May 2010 15:13:31 +0000
 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0RC-20100415)
 X-Rcs-Id: $Id$
 Content-Type: application/x-phpwiki;
@@ -51,7 +51,7 @@
 ** Autoclass: simple public domain C library
 ** MLC++: C++ library http://www.sgi.com/tech/mlc/
 
-== Usage
+== Usage ==
 
 Note: The wikilens theme or any derivate must be enabled, to enable this plugin!
 
@@ -64,7 +64,7 @@
 TODO:   <<RateIt show=text>> just text, no widget, for dumps
 }}}
 
-== Arguments
+== Arguments ==
 
 {| class="bordered"
 |-
@@ -109,19 +109,20 @@
 | false
 |}
 
-== Example
+== Example ==
 
 {{{
 <<RateIt>>
 }}}
 
-== Author
+== Author ==
 * Dan Frankowski (wikilens author),
 * [[PhpWiki:ReiniUrban|Reini Urban]] (as plugin)
 
-== See Also
+== See Also ==
+* [[Help:UserRatingsPlugin]]
 
-== To do
+== To do ==
 * finish mysuggest.c (external engine with data from mysql)
 
 <noinclude>

Modified: trunk/pgsrc/Help%2FUserRatingsPlugin
===================================================================
--- trunk/pgsrc/Help%2FUserRatingsPlugin	2010-05-07 10:04:26 UTC (rev 7385)
+++ trunk/pgsrc/Help%2FUserRatingsPlugin	2010-05-07 13:14:26 UTC (rev 7386)
@@ -1,4 +1,4 @@
-Date: Thu, 15 Apr 2010 16:32:58 +0000
+Date: Fri,  7 May 2010 15:13:31 +0000
 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0RC-20100415)
 X-Rcs-Id: $Id$
 Content-Type: application/x-phpwiki;
@@ -8,28 +8,74 @@
   charset=UTF-8
 Content-Transfer-Encoding: binary
 
-_short description_
+The **~UserRatings** [[Help:WikiPlugin|plugin]] lists the user's ratings.
 
-== Usage
+== Usage ==
+
 {{{
-<<UserRatings>>
+<<UserRatings arguments>>
 }}}
 
-== Arguments
+== Arguments ==
 
-page _(default: current pagename)_:
-  The page to execute upon.
+{| class="bordered"
+|-
+! Argument
+! Description
+! Default value
+|-
+| **dimension**
+|
+| 0
+|-
+| **userids**
+| Array of userids to display ratings for; null/empty for active user only
+| null
+|-
+| **pageids**
+| Array of pageids to display ratings for; null for all of current active user's ratings
+| null
+|-
+| **category**
+| a category to display ratings for; null for no category; has higher precedence than pageids
+| null
+|-
+| **pagename**
+|
+|
+|-
+| **exclude**
+| Pages to exclude (allows multiple pagenames exclude=HomePage,RecentChanges)
+|
+|-
+| **limit**
+| limit of <=0 is show-all
+| 0
+|-
+| **noheader**
+| 
+| 0
+|-
+| **userPage**
+| 
+| false
+|-
+| **info**
+| columns to display (hits, pagename, author, ratingwidget...)
+| pagename
+|}
 
-== Example
+== Example ==
 
 {{{
 <<UserRatings>>
 }}}
 
-== Author
-* [[PhpWiki:ReiniUrban|Reini Urban]]
+== Author ==
+* Dan Frankowski
 
-== See Also
+== See Also ==
+* [[Help:RateItPlugin]]
 
 <noinclude>
 ----


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.