This is an old revision of the document!
Table of Contents
rate Plugin
Compatible with DokuWiki
Rincewind, Angua, Adora Belle, Weatherwax, Binky, Hrun
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
Similar to stars
Intro
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 visitors vote per star level. It utilises small text files to store its 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
Installation
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:
old filename format | converted filename |
---|---|
rater_[ID][NAME][TYPE].rating | rater_[ID]_[NAME]_[TYPE].rating |
rater_1test1rate.rating | rater_1_test1_rate.rating |
Configuration and Settings
Configuration of rater plugin can be done easily.
- Log in as administrator into DW
- click on Admin action link to open the Admin tools
- change to Configuration Settings
- jump to Rater Plugin Settings to adjust the options.
The following can be configured:
Item | default value |
---|---|
restrict ip address voting | true |
allowed user votes | 1 |
Exceeded user rate attempts msg | You have already rated this item. You were allowed %s vote(s). |
Missing rate value msg | You have not selected a rating value. |
Thank you for msg | Thank you for voting. |
generic item text | this item |
end of line character (OS specific) | \n |
There is also a css file but it is related to thumb output only.
Syntax
The following line contains all parameter and possible values:
{(rater>id=1|name=item1|type=rate/vote/stat/localstat|trace=user/ip|end=09/25/10 / 25.09.2011|tracedetails=0/1|img= :taggic.png|zoom=30x30|headline=off/on|rater_hdl=test)})}
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) |
headline | optional | can be on or off to show or hide the headline of the rating (if not set it is set to on - works only for the type “rate”) |
rater_hdl | optional | a free-text headline to substitute that defined in language.php |
img | optional | defines the DW path to the media file to include it into the ater box, pipe extensions and curly brackets are not allowed |
zoom | optional | on statistics to define size of Image thumbnails when img is defined, follows media link definition |
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.
Examples/Usage
Attention !
Please take care that the identifiers like item1
must not contain space characters ! Instead of a space use an underline if needed (i.e. item_1
).
5 Star Rating
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)}
Voting
This delivers up/down thumbs to vote for a certain topic.
{(rater>id=1|name=item1|type=vote)}
Rater Statistic
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 parameter necessary. From “Adora Belle” onwards the list can be sorted by click on column header.
{(rater>type=stat)}
The list layout can be customized within style.css. The list shows the Star rater first and the Voting below, all sorted according their value. The list shows only rater objects currently referenced on pages. Orphan rater object files cannot be detected (currently). Rater syntax inside code blocks will be ignored.
If you want to consider just the rater objects of the same page then use following syntax:
{(rater>type=localstat)}
Development
Change Log
- issue with 'id' letters within other params (2017-03-20 19:23)
- register controller & handler (2016-06-02 10:54)
- Statistic output extended (2015-03-14 20:51)
- minor correction (2015-02-09 09:51)
- New Features (2015-02-05 21:58)
- small update rg. German umlauts and underlines (2015-02-04 19:30)
- small fix (2015-02-04 17:37)
- single page stat + bugfix (2015-02-04 12:05)
Known Bugs and Issues
ToDo/Wish List
[developers roadmap]
FAQ
a small FAQ is provided at: Rater plugin - FAQ
Sites using this Plugin
You got this plugin up and running? You have got a demo page? Put a link here!
Feel free to add yours here:
Discussion
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).
Use with URL rewrite
If the instance you are using this plugin with is set up to do URL Rewriting (Option 1: via Web server) you will get redirection issues when it comes to a user clicking on the vote button as the code is set to always start with doku.php?id=
. To workaround this change the following lines:
action.php
Line 171 to:
echo '<meta http-equiv="refresh" content="2; URL='.$_SERVER['REDIRECT_URL'].'#'.$anker_id.'"><div class="thumb__positive_feedback">'.$rater_ip.' : '.$rater_msg.'<br />'. '<a href="'.$_SERVER['REDIRECT_URL'].'#'.$anker_id.'" />'.$alink_Back.'</a></div>';
syntax.php
Line 351 to:
$ret .= $addMSG.'<a class="thumbup tup" href="?do=rate_voteup&rater_id='.$rater_id.'&rater_ip='.$rater_ip.'&rater_end='.$data['rater_end'].'&anker='.$anker_id.'&rater_name='.$rater_name.'"></a>'. '<span id="vote1_1" style="color:#5b8f22">('.$vote1.') </span>'. '<a class="thumbdown tdn" href="?do=rate_votedown&rater_id='.$rater_id.'&rater_ip='.$rater_ip.'&rater_end='.$data['rater_end'].'&anker='.$anker_id.'&rater_name='.$rater_name.'"></a>'. '<span id="vote1_2" style="color:#FF1822">('.$vote2.')</span>';