]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/ikiwiki/directive/poll.mdwn
7b9fdfdc595622364a47fbcb82c14876c5f86126
[git.ikiwiki.info.git] / doc / ikiwiki / directive / poll.mdwn
1 The `poll` directive is supplied by the [[!iki plugins/poll desc=poll]] plugin.
3 This directive allows you to create online polls in the wiki. Here's an
4 example use:
6         \[[!poll 0 "red" 0 "green" 0 "blue"]]
8 The numbers indicate how many users voted for that choice. When a user
9 votes for a choice in the poll, the page is modified and the number
10 incremented.
12 While some basic precautions are taken to prevent users from accidentially
13 voting twice, this sort of poll should not be counted on to be very
14 accurate; all the usual concerns about web based polling apply. Unless the
15 page that the poll is in is locked, users can even edit the page and change
16 the numbers!
18 Parameters: 
20 * `open` - Whether voting is still open. Set to "no" to close the poll to
21   voting.
22 * `expandable` - Set to "yes" to make this poll have an interface to add
23   another choice to the poll.
24 * `total` - Show total number of votes at bottom of poll. Default is "yes".
25 * `percent` - Whether to display percents. Default is "yes".
26 * `postvote` - By default after voting the updated page containing the poll
27   is displayed. This parameter allows advancing onward to another page.
28   This is useful for multi-page polls.
29 * `posttrail` - Similar to postvote, but allows advancing to the next page
30   on a trail after a vote. The value of the parameter is the name of the
31   page that defines the trail to follow. The trail plugin must be
32   enabled for this to work.
34 [[!meta robots="noindex, follow"]]