wiki:EasyPollMacro

Add polls and voting functionality to wiki pages and tickets

Description

This is a fully featured database driven poll macro with permission controls for voting and polls creation. Google charts is used to graphically show poll results. The purpose of this macro is to provide an easy way to integrate polls with Trac wiki and ticket pages.

Key features:

  1. Response type: Poll creator can decide the response type for polls, ie whether you want single response poll (radio button poll) or multiple response poll (checkbox button poll).
  2. Google charts: Poll creator can decide which type of chart they want to use for showing poll results.
  3. Poll options: Poll option can be any valid english string or any Ticket number from Trac, EasyPoll will fetch summary for given ticket and use it as option text.
  4. Change vote: Poll creator can manage whether user can change their vote or not after casting it for the first time.

Permissions: this macro introduces the following permissions:

  1. EASYPOLL_CREATE: this permission allows a user to create polls in wiki or ticket pages.
  2. EASYPOLL_VOTE: this permission allows a user to vote on polls in wiki or ticket pages.

Note that the TRAC_ADMIN permission provides for both of the above permissions.

Every logged in user on Trac can see EasyPoll, but can vote or create only if the user has sufficient permissions.

Example:

[[EasyPoll(name = my first poll, title = What's the best programming language to start with?, response_type = single, options = Python : C : PHP : Java : Lisp, user_can_change_vote = false, chart_type = pie)]]

Attributes:

  1. name (required): name is used as a poll identifier, if you change the name value than it will be treated as new poll. Nowhere in the poll the name will be shown. Don't change the name of the poll after poll creation.
  2. title (required): title will be used as a poll title. You can change it whenever you want.
  3. options (required): options should be separated by colon (:) option can also have Ticket id as their option like options = #1 : #2 : #3 In this case the summary will be pulled out from the valid tickets and will be used as option text with ticket link.
  4. response (optional): response can take two values (1) multiple and (2) single. Default is (2) single option.
    1. multiple: multiple response type will generate poll with checkboxes, in this case user can choose multiple options.
    2. single: single response type will generate poll with radio buttons, in this case user can choose only one option.
  5. user_can_change_vote(optional): user_can_change_vote can take two values (1) false and (2) true. Default is (1) false.
    1. false: once user cast their vote, they cannot change their vote, Poll will be disabled for them, however they can see poll results.
    2. true: user can change their vote at any time and many times. Poll will always be enabled for them and they can see poll results.
  6. chart_type(optional): chart_type can take two values (1) pie and (2) bar. Default is (1) pie.
    1. pie: Pie chart will be used to show poll results.
    2. bar: Bar chart will be used to show poll results. User can see poll results only after casting their vote.

Sample Poll Example:

Limitations:

  1. EasyPoll as of now only supports ASCII characters.
  2. Don't use comma (,) while picking poll options, because it is used as an attribute separator. Instead, options should be separated by a colon (:).

See also: PollMacro, which works up to Trac v1.2.

Bugs/Feature Requests

Please provide your feedback/suggestions to hi.amigo@…. I would really appreciate it.

Existing bugs and feature requests for EasyPollMacro are here.

If you have any issues, create a new ticket.

defect

0 / 1

Download

Download the zipped source from here.

Source

You can check out EasyPollMacro from here using Subversion, or browse the source with Trac.

Installation

General instructions on installing Trac plugins can be found on the TracPlugins page.

Recent Changes

16394 by rjollos on 2017-03-25 09:20:58
Remove eggs
11582 by itspanky on 2012-05-20 07:07:37
Readme file with installation instructions
11581 by itspanky on 2012-05-20 06:57:32
Readme file and .egg file
(more)

Author/Contributors

Author: itspanky
Maintainer: Pankaj Meena
Contributors:

Last modified 3 years ago Last modified on May 3, 2022, 5:16:37 AM

Attachments (2)

Download all attachments as: .zip