plugin:rater
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
plugin:rater [2015-02-05 22:03] – 87.158.123.50 | plugin:rater [2021-08-04 20:56] – [Sites using this Plugin] clfewlass | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
---- plugin ---- | ---- plugin ---- | ||
Line 6: | Line 6: | ||
email : Taggic@t-online.de | email : Taggic@t-online.de | ||
type : syntax | type : syntax | ||
- | lastupdate : 2015-02-05 | + | lastupdate : 2017-03-20 |
- | compatible : Rincewind, Angua, Adora Belle, Weatherwax, Binky, Hrun | + | compatible : Rincewind, Angua, Adora Belle, Weatherwax, Binky, Hrun, !Hogfather |
depends | depends | ||
conflicts | conflicts | ||
Line 26: | Line 26: | ||
===== Installation ===== | ===== Installation ===== | ||
- | Install | + | Search and install |
- | Or just [[https:// | + | * https:// |
- | :!: **External requirements: | ||
- | * none | ||
__**Attention !**__ \\ | __**Attention !**__ \\ | ||
Line 60: | Line 58: | ||
There is also a css file but it is related to thumb output only. | There is also a css file but it is related to thumb output only. | ||
- | === Syntax === | + | ===== Syntax |
The following line contains all parameter and possible values: | The following line contains all parameter and possible values: | ||
< | < | ||
- | {(rater> | + | {(rater> |
</ | </ | ||
=== Parameters === | === Parameters === | ||
- | ^id|mandatory, | + | ^ id | mandatory, unique |
- | ^name|mandatory, | + | ^ name | mandatory, unique |
- | ^type|mandatory|defines of rate, vote or stat use case| | + | ^ type | mandatory |
- | ^trace|optional|can be set to user or ip, where user is to be preferred for closed wikis| | + | ^ trace |
- | ^end|optional|defines the end date of the rate/vote action, can be any valid date expression| | + | ^ end |
- | ^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)| | + | ^ tracedetails |
- | ^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 " | + | ^ headline |
- | ^rater_hdl|a free-text headline to substitute that defined in language.php| | + | ^ rater_hdl |
- | ^img|defines the DW path to the media file to include it into the ater box, pipe extensions and curly brackets are not allowed| | + | ^ img | optional |
- | ^zoom|on statistics to define size of Image thumbnails when img is defined, follows media link definition| | + | ^ zoom | optional |
+ | ^ sid | optional | ||
+ | ^ ns | optional | ||
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. | 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. | ||
Line 99: | Line 99: | ||
{(rater> | {(rater> | ||
</ | </ | ||
+ | |||
+ | === Images inside === | ||
+ | < | ||
+ | {(rater> | ||
+ | </ | ||
+ | The image is included inside the rater box and zoomed at 45% of its original size. To handover the image the beginning of the media link is used without curly brackets and pipe extension. Special charachters are handled if the replacements are prvided within lang.php file. | ||
=== Rater Statistic === | === Rater Statistic === | ||
Line 110: | Line 116: | ||
< | < | ||
{(rater> | {(rater> | ||
+ | </ | ||
+ | |||
+ | If you want to have the statistic of a dedicated namespace ten use the ns-option. All rater objects of the ns rater:tst will be considered (incl. sub-namespaces, | ||
+ | < | ||
+ | {(rater> | ||
+ | </ | ||
+ | |||
+ | If you specify a dedicated page then you will have the same result as localstat but you can call it from a different page somewhere in your DokuWiki. Please take care to append the <color blue> | ||
+ | < | ||
+ | {(rater> | ||
+ | </ | ||
+ | |||
+ | Furthermore if you provide a zoom option like for media links, then the lit will contain thumbnails of that size of the rater objects (if immages provided inside the box). | ||
+ | The zoom parameter decides if thumbnails will be displayed and what size. | ||
+ | __**Take care:**__ | ||
+ | - No zoom Option = no thumbs ! | ||
+ | - No rates/votes no entry ! | ||
+ | - No Image within rater box = no thumbs ! | ||
+ | So think about the usage and style that it will not that being crauted like following table: | ||
+ | < | ||
+ | {(rater> | ||
</ | </ | ||
Line 126: | Line 153: | ||
- | ===== FAQ ===== | ||
- | |||
- | a small FAQ is provided at: [[http:// | ||
===== Sites using this Plugin ===== | ===== Sites using this Plugin ===== | ||
Line 139: | Line 163: | ||
* [[http:// | * [[http:// | ||
* http:// | * http:// | ||
+ | * [[https:// | ||
===== Discussion ===== | ===== Discussion ===== | ||
Please use only the DokuWiki Forum for discussion and [[http:// | Please use only the DokuWiki Forum for discussion and [[http:// | ||
+ | |||
+ | ===== FAQ ===== | ||
+ | |||
+ | a small but most recent FAQ is provided at: [[http:// | ||
+ | |||
+ | === 1. Can I use multiple rater on the same page ? === | ||
+ | Yes, of course. The rater plugin allows you as many as you want. Therefore you have to define by syntax unique id's. All 3 parameters will be used together as filename. | ||
+ | |||
+ | === 2. Where are the information stored to ? === | ||
+ | All information are stored into files. So you don't need to use a database. The files are within the // | ||
+ | The filename containing the id, item and type parameter from syntax. \\ | ||
+ | __**Example: | ||
+ | The syntax %%{(rater> | ||
+ | |||
+ | === 3. Can I change the Style ? === | ||
+ | Currently the style of rate details expandable box and statistic layout can be customized by style.css stored in the rater plugin folder. How to use css and what parameter are possible is explained many times by articles in the internet (e.g. [[http:// | ||
+ | |||
+ | The rating-details-css defaults are \\ | ||
+ | <code css> | ||
+ | .rating__details { | ||
+ | border: | ||
+ | font-size: | ||
+ | text-align: | ||
+ | background-color: | ||
+ | padding-right: | ||
+ | padding-left: | ||
+ | margin-left: | ||
+ | margin-right: | ||
+ | border-radius: | ||
+ | box-shadow: | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === 4. There are more rate attempts possible than configured === | ||
+ | That is the case if you have set // | ||
+ | |||
+ | === 5. Former results disappeared after rater plugin update === | ||
+ | The update to version 2011-09-27 needed a change in " | ||
+ | |||
+ | ^ old filename format ^ converted filename ^ | ||
+ | | rater_[ID][NAME][TYPE].rating | rater_[ID]**< | ||
+ | | rater_1test1rate.rating | rater_1**< | ||
+ | |||
+ | === 6. How to use rater as part of namespace template ? === | ||
+ | This is possible by using following syntax within your // | ||
+ | < | ||
+ | {(rater> | ||
+ | </ | ||
+ | Further information on namespace templates can be found [[doku> | ||
==== Use with URL rewrite ==== | ==== Use with URL rewrite ==== | ||
If the instance you are using this plugin with is set up to do [[: | If the instance you are using this plugin with is set up to do [[: | ||
- | '' | + | '' |
<code php> | <code php> | ||
Line 154: | Line 228: | ||
</ | </ | ||
- | '' | + | '' |
<code php> | <code php> | ||
$ret .= $addMSG.'< | $ret .= $addMSG.'< |
plugin/rater.txt · Last modified: 2024-01-29 15:33 by 141.23.186.116