Plugin Vote
Introduced in Tiki2
This wiki plugin is a specific use of the trackers feature, specialized for voting and survey, which can be inserted into any wiki page, article, or blog. It operates in a manner similar to the Polls and Surveys feature, but with more robust features.
This plugin combines 2 tracker plugins:
- PluginTracker - which allows each user (with the appropriate permissions) to enter their vote. ( = create a tracker item)
- PluginTrackerStat - which displays voting results ( = statistics on the tracker).
The advantage to use the tracker is that you can :
- unlike polls, use a variety of input fields (like country, drop down, radio...)
- unlike polls, ask a number of questions.
- have mandatory fields
- unlike surveys, you can have as many vote boxes in a page as you want. (limitation: each vote must use a different tracker)
- you can use the plugin trackerlist to have the detail - who votes what
Parameters
Create a tracker for votingIntroduced in Tiki 2. Required parameters are in
bold.Go to the source code
Preferences required: feature_trackers, wikiplugin_vote
| Parameters | Accepted Values | Description | Default | Since |
|---|---|---|---|---|
| (body of plugin) | Title | |||
trackerId |
digits | Numeric value representing the tracker ID | 2.0 | |
fields |
separator: : |
Colon-separated list of field IDs to be displayed. If not set all the fields that
can be used (except IP, user, system, private fields) are used. Example: 2:4:5 |
2.0 | |
float |
(blank) left right none |
Align the plugin on the page, allowing other elements to wrap around it (not set by default) | 2.0 | |
show_bar |
(blank) y n |
Choose whether to show a bar representing the number of votes each option received (not shown by default) | n | 2.0 |
show_creator |
(blank) y n |
Choose whether to display the user name of the creator of the voting tracker (not shown by default) | 2.0 | |
show_percent |
(blank) y n |
Choose whether to show the percentage of the vote each option received (not shown by default) | n | 2.0 |
show_stat |
(blank) y n |
Choose whether to show the voting results (shown by default) | y | 2.0 |
show_stat_only_after |
(blank) y n |
Choose whether to show the voting results only after the date given in the tracker configuration (not set by default) | 2.0 | |
show_toggle |
(blank) y n |
Show toggle or not to display the form and the results | 10.0 | |
status |
(blank) o p c op oc pc opc |
Only show items matching certain status filters | o | 2.0 |
The parameters of this plugin are the parameters of the tracker plugin and the trackerStat plugin.
Configuration
The tracker used for a vote must be configured specifically to behave like a vote system.
- a user or an IP can vote only one time must be checked
- the tracker must have a field of type 'IP selector' or 'User selector' with an option 1
- if you want to have your vote or survey activated only during a certain period of time, you have to set the 2 dates ( or only one) after and before.
If there is only a field 'IP selector', a vote with the same IP replaces any previous one. If there is only a field 'user selector', a vote with the same user that a previous one replaces the vote. If the tracker has both fields, a vote with the same user or the same IP will replace the previous one.
If you give a "after" date, the vote box will display "the vote begins after" before this date
If you give a "before" date, the vote box will display "the vote ends after" before the end, and "the vote is closed since" after the date
Example
Basic syntax
{VOTE(trackerId="19" fields="73" float="right")}Thank you for your vote{VOTE}