CMFQuestionnaire

A simple questionnaire for Plone.

Current release

No stable release available yet.

Project Description

CMFQuestionnaire is a simple questionnaire add-on for Plone. Its main features are:

  • user-based or anonymous submissions (through a ticket system)
  • pdf report creation with bar and pie charts for each question
  • internationalization (German, Spanish and Turkish at the moment)
  • creates only 1 portal type for the questionnaire which is internally represented as an XML document

Installing

If you're using buildout, add the product egg to your configuration file and run buildout:

eggs=
    ...
    Products.CMFQuestionnaire

Note that you have to add the address http://dist.plone.org/packages/ to the find-links section as shown below. Otherwise buildout will fetch an older version from PyPI:

find-links =
    http://dist.plone.org
    http://dist.plone.org/packages/

Using

After adding a questionnaire, go to the 'design' tab:

  • Add a question or a group. Adding questions is straight-forward: enter their question text and a list of possible answers. For a group:
    • Enter the title of the group.
    • Enter the scale of the group (the options will be numbered from 1 to this value).
    • Enter the legend to explain the options (put one option on each line, starting with the option for 1)
    • Optionally, enter a description for the group.
    • Add / remove questions to the group.
  • Publish the questionnaire (questionnaires can only be filled out between their start and expiry dates)
  • View submitted forms in the 'submissions' tab or see the summary in the 'evaluate' tab.

Don't forget to check the permissions in the Zope Management Interface that determine who can add, fill-out, or view the results of questionnaires.

PDF Reports

If reportlab is installed, you will see a 'get pdf report' button on the 'results' tab. The report file will use the Bitstream Vera fonts which are distributed along with reportlab (version 2.3 or later), but if you would like to use other fonts, you can place the ttf files into the site-packages/reportlab/fonts directory and adjust the config.py file of this product.

Tickets

If you would like to conduct a questionnaire on a group of people but you would like them to remain anonymous, you can use tickets. To do that, you have to check the 'use_ticket' option in the 'tickets' tab when editing and either type in ticket strings in the 'available tickets' box (one ticket on each line) or use the 'submissions' tab to create random 10-digit tickets. You can get a printable list of tickets from the same tab. Later you can hand out the tickets to the people you would like to participate in the questionnaire.

Known Issues

  • CMFQuestionnaire might not work well with workflows other than the simple publishing workflow.
  • When designing questionnaires the last item might not be deleted on the first try.

You can always find the latest information about CMFQuestionnaire on its web page. The source code is kept in a Subversion repository.

0.7 - March 2009

  • major cleanup
  • product is now an egg (thanks to Millie Ngoka)
  • fixed unicode handling
  • added German translation (thanks to Andreas Czerniak)
  • uses elementtree instead of minidom
  • new field for available tickets
  • removed all persistent lists and dictionaries

0.6.2 - November 2007

  • minor bugfixes

0.6 - November 2007

  • support for Plone 3.0

0.5 - Unreleased

  • support for Plone 2.5
  • support for single-selection style questions
  • support for downloading all questionnaire data as an XML file
  • support for downloading all user answers as a CSV file
  • added translations for the plone domain
  • added the Spanish translation (thanks to Ramon Blasco)
  • some UI improvements
  • disabled migration script from version 0.3.2

0.4.5 - June 2006

  • moved the project to plone.org/products
  • organized the documentation

0.4.4

  • computes weighted averages for report
  • documented the XML format

0.4.3

  • now the product doesn't fail on startup if reportlab is not correctly installed; only the 'get pdf report' button on the 'evaluate' page will be removed
  • corrected i18n problems (some pages were Turkish by default)
  • set up a new website

0.4.2

  • changed permissions to enable anonymous viewing
  • made the 'answers' widget invisible
  • updated the README

0.4

  • added a 'body' attribute for holding empty form as xml (removed import)
  • added an 'answers' attribute for holding submitted forms
  • added a 'use_ticket' attribute
  • use the 'published' state instead of the 'open' attribute
  • permission and security improvements

Self-Certification

[X] Internationalized

[ ] Unit tests

[ ] End-user documentation

[ ] Internal documentation (documentation, interfaces, etc.)

[X] Existed and maintained for at least 6 months

[ ] Installs and uninstalls cleanly

[ ] Code structure follows best practice