Home

Jump to bottom Edit New page

yoon edited this page Feb 1, 2013 · 27 revisions

Getting started

Surveyor - A Rails gem plugin for creating surveys from breakpointer on Vimeo.

Participate

The surveyor developers google group is a good place to search for your issue and discuss possible bugs. Confirmed bugs should be submitted to the github issue tracker. For build status see our surveyor's continuous integration page.

The data model

Attributes common to Survey, SurveySection, QuestionGroup, Question, and Answer

#reference_identifier: usually derived from paper numbering, reference_identifier can be assigned in the DSL e.g. question_1 or a_yes. The reference identifier is also used for dependencies and validations, and must be unique for questions within the scope of a section, and unique for answers within the scope of a question.
#data_export_identifier: intended for data export
#common_namespace: intended for mapping to a common vocabulary
#common_identifier: intended for mapping to a common vocabulary
#display_order: for sorting
#custom_class: css class for this answer, for custom styling. Use with Survey#css_url, a path to your custom css stylesheet. not supported by nu_surveyor

Attributes common to QuestionGroup, Question, and Answer

#custom_renderer: path to a custom view use to render the answer e.g. /partials/custom_answer. not supported by nu_surveyor
#text: the text that the user sees.
#help_text: intended to provide supporting explanation or examples when needed.

Question types

Does do

Exclusive checkboxes - a checkbox that when checked, unchecks all the others

Doesn't do

Enforce mandatory questions (although it does have some1 methods2 on ResponseSet to support that)
Dependencies within repeaters #235
Validations within the UI #34, although it does have model support and database representations
GUI creating, editing, deleting and administration of surveys #110
Consistently support HTML tags in title, text, help_text attributes. We intend to move to markdown support so that same survey definition can be used with nu_surveyor.

Other wiki pages