Diff: Help/UserRatingsPlugin

Differences between current version and predecessor to the previous major change of Help/UserRatingsPlugin.

Other diffs: Previous Revision, Previous Author

Newer page: version 6 Last edited on 17 January 2022 3:00 by harold
Older page: version 5 Last edited on 9 September 2007 0:16 by harold Revert
@@ -1,27 +1,77 @@
-_short description_  
+The **~UserRatings** [[Help:WikiPlugin|plugin]] lists the user's ratings.  
  
-! Usage  
-<verbatim>  
- <?plugin UserRatings ?>  
-</verbatim>  
+== Usage ==  
  
-! Arguments  
+{{{  
+<<UserRatings arguments>>  
+}}}  
  
-page _(default: current pagename)_:  
- The page to execute upon.  
+== Arguments ==  
  
-! Example  
+{| 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)  
+| none  
+|-  
+| **limit**  
+| limit of <=0 is show-all  
+| 0  
+|-  
+| **noheader**  
+| Boolean. If true, header should be omitted.  
+| false  
+|-  
+| **userPage**  
+| Boolean. If true, we're on a user's homepage, get **their** ratings  
+| false  
+|-  
+| **nobuds**  
+| Boolean.  
+| false  
+|-  
+| **info**  
+| columns to display (hits, pagename, author, ratingwidget...)  
+| pagename  
+|}  
  
-<verbatim>  
-<?plugin UserRatings ?>  
-</verbatim>  
+== Example ==  
  
-<?plugin UserRatings ? > 
+{{{  
+< <UserRatings>>  
+}}}  
  
-! Author  
-PhpWiki:ReiniUrban  
+== Author ==  
+* Dan Frankowski  
  
-! See Also 
+== See Also ==  
+* [[Help:RateItPlugin]]  
  
+<noinclude>  
 ---- 
-PhpWikiDocumentation Help:WikiPlugin  
+[[ PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
+</noinclude>  

current version

The UserRatings plugin lists the user's ratings.

Usage

<<UserRatings arguments>>

Arguments

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)

none

limit

limit of <=0 is show-all

0

noheader

Boolean. If true, header should be omitted.

false

userPage

Boolean. If true, we're on a user's homepage, get their ratings

false

nobuds

Boolean.

false

info

columns to display (hits, pagename, author, ratingwidget...)

pagename

Example

<<UserRatings>>

Author

  • Dan Frankowski

See Also