add a poll plugin

1 files changed, 24 insertions, 0 deletions

diff --git a/doc/plugins/poll.mdwn b/doc/plugins/poll.mdwn
new file mode 100644
index 000000000..385a78b42
--- /dev/null
+++ b/doc/plugins/poll.mdwn
@@ -0,0 +1,24 @@
+[[template id=plugin name=poll included=1 author="[[Joey]]"]]
+[[tag type/useful]]
+
+This plugin 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 is should not be counted on the 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".