DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:doodle3

doodle3 Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" yes
  • 2016-06-26 "Elenor Of Tsort" yes
  • 2015-08-10 "Detritus" yes
  • 2014-09-29 "Hrun" yes

plugin Let users vote for given choices, e.g. to schedule a meeting. (Inspired by doodle.com and doodle2-plugin)

Last updated on
2017-03-29
Provides
Syntax
Repository
Source
Conflicts with
doodle, doodle2

Similar to doodle, doodle2, userpoll, vote

Tagged with doodle, doodle2, poll, schedule, vote

Description

Since Dogiemucs doodle2 plugin did not see any changes and fixes since 2011-01-20 I encountered various problems in using his plugin. There seems to be no activity on github at all so I decided to adopt this plugin. The code of this plugin is widely copied from Dogiemucs code but contains fixes and improvements.

With this plugin you can offer your visitors a poll, where each user can vote for one (or more) choices. This is a unification of the doodle, vote, and userpoll plugins. I tried to implement all their features into one plugin:

  • duplicate votes can be prevented by IP or voting can only be allowed for logged in users
  • logged in users can edit their vote afterwards
  • a poll can be closed
  • a poll can be moved to another page without loosing its data
  • well documented code

Installation

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Syntax and Usage

<doodle
  title="What do you like best?"
  auth="none|ip|user"
  adminUsers="user1|user2"
  adminGroups="group1|group2"
  voteType="single|multi"
  fieldwidth="auto|123px"
  closed="true|false" 
>
   * Option 1 
   * Option 2 **some wikimarkup** \\ is __allowed__!
   * Option 3
</doodle>
  • The title is also used as “key” for the plugin's data file under /data/meta
  • adminUsers and members of the adminGroups can always edit any entry
  • voteType=“single” shows round checkboxes where only one can be chosen
  • voteType=“multi” lets users check any number of square boxes
  • fieldwidth (optional) defines the width of every option column, valid options: auto or like 123px
  • If closed=“true” is set, then users cannot vote anymore. The result of the vote will still be shown.
  • If closed=“YYYY-MM-DD hh:mm:ss” is set, users can't vote or change their vote after the defined timestamp. Uses mysql datetime representation1). You can leave out values beginning from the right if you don't need the timestamp to be that specific.

Only the title and at least one option are required. Do not change the options and their order, after the first vote has been casted! You may move the whole doodle to another page, whenever you want.

Authentication

By default anyone can vote, even multiple times under different name. In this mode users cannot change their vote, once they submitted it.

You can prevent multiple votes, by setting auth="IP". Then users will be authenticated by their IP address2).

If you set auth="user" then only registered and logged in users are allowed to vote. This has the advantage, that users later on can edit their vote, i.e. change their mind. In this mode, the users fullname and login name are automatically set for the vote.3)

More Details

The doodle's data is saved in <dokuwiki>/data/meta/title_of_vote.doodle. The filename is the (masked) title. This has the advantage that you can move your doodle to another page, without losing the data.

Each of the green success icons has a popup title, that shows when this vote has been casted.

Version History

This plugin is widely based on dogiemucs plugin doodle2 which was based on the plugin doodle. dogiemucs plugin was considered the successor of doodle by both dogiemuc and the author of doodle.

As both plugins were not maintained any more I copied wide parts of the code to improve the plugin and bring it back to life.

Change Log

Bug Tracking

FAQ

Could the doodle accept Replacement patterns such as @DATE@ or @ID@? This would vastly increase usability when created via a Namespace Template. Alternatively, an option to save doodle masked below the namespace it was created in would work as well.


Some suggestions:

  • It would be useful if the header categories could optionally be shown at the bottom of the table. This is relevant when the table grows longer than the page height so new users don't have to scroll to the top to see the titles.
  • Optionally hiding submissions from other users would enable only privileged users, say administrators, to see everyone's votes. This could be beneficial if the objective is to maintain privacy.
  • A demo page for Doodle3 would be useful to show off its capabilities.

Bob :)


Another suggestion:

  • admin should be able to add lines with names, who are no users.

Helmut

2)
which is not a very good way of authenticating users. But at least it requires no registration.
3)
You have no idea how complicated this can get. But don't worry, the plugin takes care of all that. For example, let's assume someone starts an open vote, and after some votes changes this to auth="user". Now user “Peter” logs in. But someone (maybe anyone) may already have voted with the name “Peter”. In this case, this becomes Peters vote, and he might change it.
plugin/doodle3.txt · Last modified: 2017-03-30 16:18 by 46.18.62.1