web commit by JoshTriplett: Link URL more simply.
[ikiwiki.git] / doc / plugins / poll.mdwn
1 [[template id=plugin name=poll author="[[Joey]]"]]
2 [[tag type/useful]]
3
4 This plugin allows you to create online polls in the wiki. Here's an
5 example use:
6
7         \[[poll 0 "red" 0 "green" 0 "blue"]]
8
9 The numbers indicate how many users voted for that choice. When a user
10 votes for a choice in the poll, the page is modified and the number
11 incremented.
12
13 While some basic precautions are taken to prevent users from accidentially
14 voting twice, this sort of poll should not be counted on to be very
15 accurate; all the usual concerns about web based polling apply. Unless the
16 page that the poll is in is locked, users can even edit the page and change
17 the numbers!
18
19 Parameters: 
20
21 * `open` - Whether voting is still open. Set to "no" to close the poll to
22   voting.
23 * `total` - Show total number of votes at bottom of poll. Default is "yes".
24 * `percent` - Whether to display percents. Default is "yes".