summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/poll.mdwn
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2010-10-14 13:38:43 +0200
committerJonas Smedegaard <dr@jones.dk>2010-10-14 13:38:43 +0200
commite990b132016f231ef150085597d02e2eb4883a1f (patch)
tree4220bd4d1a026353c7c6f74aa438aef9c6a10ff4 /ikiwiki/directive/poll.mdwn
Sync with ikiwiki 3.20100926.HEADmasterikiwiki
Diffstat (limited to 'ikiwiki/directive/poll.mdwn')
-rw-r--r--ikiwiki/directive/poll.mdwn25
1 files changed, 25 insertions, 0 deletions
diff --git a/ikiwiki/directive/poll.mdwn b/ikiwiki/directive/poll.mdwn
new file mode 100644
index 0000000..6aa3d2c
--- /dev/null
+++ b/ikiwiki/directive/poll.mdwn
@@ -0,0 +1,25 @@
+The `poll` directive is supplied by the [[!iki plugins/poll desc=poll]] plugin.
+
+This directive allows you to create online polls in the wiki. Here's an
+example use:
+
+ \[[!poll 0 "red" 0 "green" 0 "blue"]]
+
+The numbers indicate how many users voted for that choice. When a user
+votes for a choice in the poll, the page is modified and the number
+incremented.
+
+While some basic precautions are taken to prevent users from accidentially
+voting twice, this sort of poll should not be counted on to be very
+accurate; all the usual concerns about web based polling apply. Unless the
+page that the poll is in is locked, users can even edit the page and change
+the numbers!
+
+Parameters:
+
+* `open` - Whether voting is still open. Set to "no" to close the poll to
+ voting.
+* `total` - Show total number of votes at bottom of poll. Default is "yes".
+* `percent` - Whether to display percents. Default is "yes".
+
+[[!meta robots="noindex, follow"]]