Poll#
- .. poll:: id#
This directive adds a live audience poll. The poll identifier
id
is required and its value must be unique across the site. The content of the directive is composed of the question, followed by a bullet list, where each list item becomes an answer. Both the question and the answers can contain arbitrary markup. Answers can optionally be marked as solutions by prefixing them with:
(the prefix is removed).Polls can be controlled by members of the group
polls:control
, using the buttons in the toolbar./ : Open or close the poll. Closed polls don't accept votes.
/ : Show or hide the poll results.
/ : Show or hide the solutions.
: Clear the poll results.
Voting on polls doesn't require any permissions. Polls are single-choice by default (
:mode: single
): selecting a different answer de-select a previously selected one, and re-selecting the selected answer un-selects it. Setting:mode: multi
enables voters to select multiple answers.Options
- :mode: value (single | multi)#
The poll mode: single answer (
single
, the default) or allow multiple answers (multi
).
- :number: value (none | decimal | lower-alpha | upper-alpha)#
The answer numbering: no numbering (
none
), using decimal numbers (decimal
), using lowercase letters (lower-alpha
) or using uppercase letters (upper-alpha
, the default).
- :close-after: value (duration | never)#
The duration after opening when the poll should be closed automatically. The value is of the form
2h35m42s
ornever
. The default is 15 minutes.
- :class: name [name...] (IDs)#
A space-separated list of CSS classes to add to the outer container.