rate Plugin

This is a very simple plugin that will allow the inclusion of single or multiple Star Rating or Voting Systems on one page.
The rating details within an expandable box answering how many vistors vote per star level.
It utilises small text files to store it's required information instead of a database. It also delivers a configurable ip voting
restriction and the ability to set how many times a single ip may vote.

To see the plugin in action please visit: fcon- Rater examples

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin.
Refer to Plugins on how to install plugins manually.

Or just download and extract it as folder “rater” into your “\lib\plugins” directory.

External requirements:

• none

Attention !
The update to version 2011-09-27 needed a change in ”.rating” file names. To reuse the former ”.rating” files please change the filenames
in ”…/data/meta”-directory according following concept:

Configuration of rater plugin can be done easily.

1. Log in as administrator into DW
2. click on Admin action link to open the Admin tools
3. change to Configuration Settings
4. jump to Rater Plugin Settings to adjust the options.

The following can be configured:

There is also a css file but it is related to thumb output only.

This delivers a picture of 5 stars and radio buttons below to rate. The rating will be counted and stored to a file at …dat/meta/*.rating
The code base is picked up from PHP, 5 Star Rating System \\ (using hReview) as mentioned within forum post Rating plugin.

{(rater>id=1|name=item1|type=rate)}

This delivers up/down thumbs to vote for a certain topic.

{(rater>id=1|name=item1|type=vote)}

Flam & Loleg asked for a statistic feature to see a list of all raters of a site sorted by highest rate. This is now implemented and the following syntax will deliver it (see also Examples). There are no more prameter necessary.

{(rater>id=1|name=item1|type=stat)}

There are no more prameter necessary. The list layout can be customized within style.css

The following line contains all paramters and possible values:

{(rater>id=1|name=item1|type=rate/vote/stat|trace=user/ip|end=09/25/10 / 25.09.2011|tracedetails=0/1)})}

• Following parameters:
  • id — mandatory, unique — an id to differ between the rate/vote
  • name — mandatory, unique — usually the item name what will be voted/rated
  • type — mandatory — defines of rate, vote or stat use case
  • trace — optional — can be set to user or ip, where user is to be preferred for closed wikis
  • end — optional — defines the end date of the rate/vote action, can be any valid date expression
  • tracedetails — optional — can be 0 or 1 and defines if the rate or vote details will be displayed
    ( vote + tracedetails will display real user name or its ip ⇒ be carefully with this combination)

It is allowed to place more than one rate/vote function into the same page but I dont know about the performance impacts if you will place
there hundreds.

• BugFix: Vote details link prevented if tracedetails switched off (2011/12/16 20:02)
• New: rater usage by namespace template, BF: one rater missed on stat (2011/10/05 11:17)
• detail anker included, id handling fixed, a few xhtml errors corrected (2011/09/28 19:57)
• New Feature: statistic overview of rater type incl. page links (2011/09/27 22:43)
• New Features: handle end of vote periods, trace option real names, language support (2011/09/26 16:13)
• BugFix: conflict with other plugins on action.php solved (2011/09/16 20:08)
• New Feature: rating details within expandable box (2011/09/16 16:38)
• Bugfix on vote thumb down (2011/09/16 11:34)

[this section might not be needed in case of external bug manager, or use RSS feed]

[developers roadmap]

a small FAQ is provided at: Rater plugin - FAQ

You got this plugin up and running? You have got a demo page? Put a link here!
Feel free to add yours here:

• fcon - Rater Examples
• Fanarts for wii. The rater plugin is used for the votes of the fanarts

Please use only the DokuWiki Forum for discussion and Rater issues to raise your problems. You can mention it here but this page is not regularily tracked
and if something is solved it will be cleaned from this page (better to use the forum due to automated notifications).