Products.PloneSurvey 1.4.0

Products.PloneSurvey - A survey tool for Plone
============================================================

This package allows users to create a survey or simple form for collecting user's feedback. Surveys can be a simple single page, or a multi page survey with complex branching

Using PloneSurvey
-----------------
Once a survey is added, questions can be added such as select question or


Installation
------------

To install the package, list it in the ``eggs`` line in buildout.cfg, e.g.::

[instance]
...
eggs =
...
Products.PloneSurvey

Alternatively, use one of the buildouts in the `buildout directory<http://svn.plone.org/svn/collective/Products.PloneSurvey/buildout/>`__

Once you have the package installed, you need to use the Portal Quick Installer to install it into your Plone site.

Usage
-----

Once a survey has been added, you can add questions within the survey. For a multi page survey, add a `sub survey` and add your questions within the `sub survey`. To make a survey available to users, publish the survey and the questions within it. If you want the survey to be available to anonymous users, you must select `Allow Anonymous` on the survey edit form.

There are several question types: Text Question, Select Question, Date Question and Matrix Question. Matrix Questions are for tabular question banks, where the matrix questions share the same answer options.

The sub surveys allow fairly simple branching based on either an option in a previous question being selected or not selected. The option to branch on more than one answer option or more than one question is not supported yet. The branching functionality should support most use cases if your survey is well designed, but it is possible to create portions of your survey that can not be completed by branching on a question that has not been presented to the user before the branch takes place.

Answers are stored with the question, so deleting a question will also remove all responses to that question. Questions can also be added after the survey is launched without compromising the survey, however users who have already completed the survey will appear to have not completed the new question.

You can reset the survey completely, which will remove all answers to all questions, or reset for particular users. There is also a permission `PloneSurvey: Reset Own Responses` that will allow users to reset their own responses and allow them to fill in the survey again.

Anonymous users are tracked with a cookie, so they will be unable to complete the survey more than once. However, if the anonymous user closes their browser and reopens the survey, they will be able to complete the survey as a new anonymous user. This is to support multiple user computers such as drop in computers within Libraries. The IP address is tracked, so users trying to spam the survey can be spotted within the results and these could be reset by the survey administrator.

There is also a permission, `PloneSurvey: View Survey Results`, to grant users access to the results of the survey. This has not been fully tested and may not work as expected.

Respondents can be categorised as one of three kinds.

1. portal members, who must have view permission on the survey in order to be able to complete it.

2. Anonymous users, who must have view permission, and you must have enabled the `allow anonymous` option on the survey.

3. Survey respondents, who can be added using the respondents tab on the survey. This allows you to add users with a one time token to allow a closed survey to be completed by users who are not portal members.

Respondents can be added individually, or can be bulk uploaded by adding a file with an id of `user_import` in the import directory of your site. The format must be one user per line, and an example user_import file is in the tests/utils folder within the product. This functionality has not been fully tested and may not work with your configuration.

Known Issues
------------

The save functionality does not work reliably, and should not be used.

The confidential option on the survey does not do anything yet, and respondent's personal data is still saved to the system.

Changelog for Products.PloneSurvey
==================================

1.4.0 - 2010-10-10
----------------------

* Polish translation and i18n improvements
[Maciej Zieba]

* Eggification and upgrade to Plone 4 compatibility
[Ross Patterson]

* Improve the respondents functionality and various other improvements
[Michael Davis]

* Captcha integration (with quintagroup.plonecaptchas)
[sureshvv]

* Bugfix on SurveyDateQuestion, in barchart view
[tiazma]

* French translation update
[tiazma]

1.3.0 - 2009-02-10
------------------

* Fork for plone 3 compatibility

1.2.2 - alpha1 - 2009-02-09
---------------------------

* French translation update
[sneridagh]

* Catalan translation
[Pilar Marinas]

* Date question
[Michael Davis]

* Pass survey id in form to get round cookies disabled problem
[Michael Davis]

* Capture respondent details with date times for start and end
[Michael Davis]

1.2.1 - 2008-05-21
------------------

* Bugfixes, minor functionality improvements
[Michael Davis]

* Updated French translation
[Yves Moisan]

* Spanish translation
[Hector Velarde]

1.2.0 - 2007-10-15
------------------

* Bug fixes, minor improvements etc during Naples Sprint
[Michael Davis, Nick Davis, Paul Roeland]

* ReportLab integration, two dimensional questions, answer weighting, authenticated respondents, survey dimensions
[Hedley Roos]

* Italian translation
[Massimo Azzolini]

* Dutch translation
[Pander]

* Brasilian Portuguese translation
[Luis Flavio Rocha]

* Update to German translation
[Sven Deichmann]

* Add Likert scale functionality to types
[Michael Davis]

* Sub class types from ATContentTypes
[Michael Davis]

* Implement generic setup
[Michael Davis]

* Remove backward compatibility with 1.0
[Michael Davis]

1.1.0 - 2006-12-21
------------------
* Fix spreadsheet bugs (see resolved issues in tracker)
[Michael Davis, Nick Davis]

* Remove sub survey from navigation portlet
[Michael Davis]

* Deprecate Survey Likert Question
[Michael Davis]

* Add French translation from Marc Van Coillie
[Michael Davis]

* Add max length for text questions
[Michael Davis]

* Add Polish translation and some i18n fixes
[Piotr Furman]

* Add save functionality
[Michael Davis]

* Convert answers to OOBTree
[Michael Davis]

* Tidy overview template, and add functionality to it
[Michael Davis]

* On the overview template, add links to edit function
[Jin Tan]

* fixed the overview information: sub survey
[Jin Tan]

* Add German po file from Eggert Ehmke
[Jin Tan]

* fixed the overview information: sub survey and branching
[Jin Tan]

* Add overview for user function
[Jin Tan]

* Add method to return questions in correct order
[Jin Tan]

* Remove required field from Survey Matrix and use BaseQuestion abstract
[Jin Tan]

* Don't validate non required fields with no value
[Jin Tan]

* Move getColors to survey root
[davismr]

* Add css file to portal_css
[davismr]

* Add test framework and some basic tests
[davismr]

* Radio buttons and Check boxes are using <label> tag to easy select of item (it is possible
to click to the text of the answer, not only to the small area of the circle or box)
[naro]

* removed obsolete i18n files and created new one. Added initial Czech translation.
[naro]

* fixed some errors in SubSurveys caused by using getFolderContents without full_objects parameter.
[naro]

* fixed UnknownValidator error (validator may be empty string sometimes)
[naro]

* fixed some templates - not all question types has Comment field now.
[naro]

* Added rows and cols fields to the SurveyTextQuestion type and fixed text and textarea
macros (question_macro). It is possible to modify number of rows of the textarea field
and number of columns of the Text field. Number of columns of the textarea seems to be
ignored (or overriden by the Plone CSS).
[naro]

* Added Survey configuration field - modifyTitle. According to this field settings,
survey title is extended with the current survey status (open) (closed).
Default behaviour is the same as before (extend title with the status).
[naro]

* Add new types for question matrix and rough macro for view
[davismr]

* Disable enabling objective field
[davismr]

* Change get FolderListingFolderContents to getFolderContents
[davismr]

* Add new questions to view and results
[davismr]

* Add switch for deprecating SurveyQuestion
[davismr]

* Stop new questions from appearing in nav
[davismr]

* Add Likert question type
[davismr]

* Add select question type
[davismr]

* Remove unuseful validators
[davismr]

* Add text question type
[davismr]

* Add branching
[davismr]

* Add validation
[davismr]

* Add question to TypesNotToList
[davismr]

* Enable portal factory for types
[davismr]

* Create base question class
[davismr]

* Fix bug in view results if question options have been deleted with answers for that option
[davismr]

* Add message in view results if no respondents
[davismr]

* Stop view respondents link from opening new window
[davismr]

* Enable allow anonymous function
[davismr]

* Add reset for user function
[davismr]

1.0.0 - 2006-06-06
------------------

* Refactor CMFQuestions to Archetypes
[davismr]