EXT: Simple Survey¶

What does it do?¶

• This extension helps you to create surveys which will be displayed in the frontend. The surveys will be created in the backend and have several options. You can create dependences, save the results to the database, send an email to listed addresses and also to the user which filled out the survey, use one question in several surveys, show a statistic of the results in the frontend and in the backend, define mandatory fields, separate questions and user data, use templates for the survey and the emails, export the results to CSV, ...
• If you like this extension it would be great if you could support the development with a small donation... michael.kuzmin@stp-online.de

Screenshots¶

Backend – question1

Backend – question2

Backend – help

Backend – user data

Backend – survey (screenshot from version 1.5.4!!!)

Frontend – overview

Frontend – survey1

Frontend – survey2

Frontend – goodbye

Frontend - results

Backend - web->info

Backend¶

To create a survey you have to log in to the backend and go to “web”->”list” and create a SysFolder anywhere in your page. Then you can create a new data record “surveys”. In this you can configure your survey. You also have to create some questions in the SysFolder in fact the survey only shows already created questions ;) User data are also stored there, but are not mandatory... If you have finished creating questions and surveys and the page including the plugin has caching enabled, please clear the cache manually! (or disable caching for this page...)

If you want to know the results, you can enable to save the results in the database. Then you can evaluate the results in “web”->”info”. There you have to choose “SimpleSurvey results” in the drop down list and select the SysFolder containing the surveys in the tree.

If you want to create and test your own unit tests you have to install the extensions “oelib” and “phpunit”.

TypoScript¶

If you use this TS, the settings will overwrite the settings filled in the backend!

plugin.tx_simplesurvey_pi1.results_at_a_time = 10 the number of surveys shown in the list view. Default: 20

plugin.tx_simplesurvey_pi1.maxPages = 3 the number of pages shown in the list view. Default: 5

plugin.tx_simplesurvey_pi1.template = fileadmin/survey/tmpl.html the absolute path from the typo3 folder to the template file

CSS¶

In the simplesurvey extension directory is a sample CSS-file!

You can style the survey with following CSS-classes:

- in the survey

tx-simplesurvey-pi1

tx-simplesurvey-pi1-notemplate

tx-simplesurvey-pi1-title

tx-simplesurvey-pi1-caption

tx-simplesurvey-pi1-description

tx-simplesurvey-pi1-questiontext

tx-simplesurvey-pi1-help

tx-simplesurvey-pi1-question

tx-simplesurvey-pi1-answer

tx-simplesurvey-pi1-error ( this is not a class, it's an id! )

tx-simplesurvey-pi1-uploaderror

tx-simplesurvey-pi1-submit

- user data area in the survey

tx-simplesurvey-pi1-userdata

tx-simplesurvey-pi1-userdata-title

tx-simplesurvey-pi1-userdata-answer

- result view

tx-simplesurvey-pi1-results-not-allowed

tx-simplesurvey-pi1-result-header-questions

tx-simplesurvey-pi1-result-question

tx-simplesurvey-pi1-result-percent

tx-simplesurvey-pi1-result-answer

tx-simplesurvey-pi1-result-noanswer

tx-simplesurvey-pi1-result-userdata

tx-simplesurvey-pi1-overall-points

Template¶

The following lines are copied from the default_template.html and shows a sample of a template. You can change the order, delete unneeded markers or even add own CSS-classes or hard coded text!

###TITLE### The survey title will be inserted here.

###CAPTION### The caption will be inserted here, if available!

###DESCRIPTION### The description appears here...

<!--###QUESTIONS### start--> Begin of question loop. It will be repeated as long as a question is available!

###QUESTIONTEXT### The numeration of each question gets here with a continuously number!

###QUESTION### The question of the current question loop.

<!--###ANSWERS### start--> Begin of answer loop. It will be repeated as long as an answer is available!

###ANSWER### The answer of the current answer loop.

<!--###ANSWERS### end--> End of answer loop.

<!--###QUESTIONS### end--> End of question loop .

###USERDATA### All user data fields are inserted here!

###ERROR### The error message appears here, if a mandatory field is not filled out.

###SUBMIT### The submit button gets here.

Questions and user data¶

First you can set the type to one of the usual form fields (text, text area, radio button, ...).

In the next field you have to insert the question...

Next you can define if the field should be a mandatory field - else it can be left blank in the survey. Madatory fields will be marked with a "*" (not in static text and upload field).

If you choosed the type “selectorbox”, you now can specify the size of it. If you leave the default value (0) or set a 1, it will be a drop down box – if you set a value from 2-9 it will be that size.

In the answer field you can set the answers:

DropDown, Radio, Checkbox: Each line will be one answer, if one line starts with @ this line will be set as default selected/checked. If you set more than one @ value in the DropDown or Radio, the last one will be marked. If you don't set a @ value in the DropDown, the first value it marked.

Text, Textarea: If one line starts with @ this line will be inserted as default. If you don't write a @ sign, this content will be inserted in the text/textarea tag! This can be used to set the size or a class (cols="30" rows="20")... Here is an example:

@This is the first line of the textarea

cols=”30”

rows=”20”

@This is the second line of the standard text. Both lines will be inserted by default.

Static text: Insert ANY text you want! You can also use HTML-Tags like <b> <i> ... This is useful if you want to insert a small explanation or an image. Also you can insert JS-scripts etc.

Upload: When you insert a upload field, you an specify the maximum file size in bytes. It is marked with an @! For example @100000 will limit the file size to 100kb. Next you have to specify the allowed file types! Here you simply insert the valid MIME-Types separated by a line break. For example text/plain will limit the file types to simple txt-files. A list of valid MIME-Types can be found here: http://de.selfhtml.org/diverses/mimetypen.htm

Example for text/pdf/word files which are smaller than 100kb:

@100000

text/plain

application/pdf

applicaton/msword

Mandatory rules are only available when you use drop down or radio button. Each line contains one answer-text, which should be mandatory be selected/choosed. Because in a DropDown-field and in Radio Buttons you can only select one answer, one answer in a line is allowed! The mandatory-field will fail if an answer is choosen, which is not listed in this field!

If you use checkbox as a mandatory field, all checkboxes must be checked in the frontend!

In the field tooltip information you can insert an information text which will be displayed when the user clicks on the “?” near the current question. If it is blank the “?” will be hidden. (not available in static text!)

Choose, if the question should be displayed in frontend or not (only questions / not in static text and file upload).

Survey¶

You can set a title,

a caption

and a description.

Then you can add questions to the survey (you have to create the questions first and then insert them here).

Now you can create dependences.

" question2 > question1 = Yes;Maybe " without quotes means that the question with the id 2 only appears if the question with the id 1 is " Yes " or " Maybe ". Multiple answers are separated by a ; One dependence per line! "userdata" instead of "question" for the user data fields!

Here you can activate the pointing system where each question can get a number of points.

If the previous checkbox is checked you can insert the pointing-rules in the field “Allocate points”.

“ question1 = Berlin > 5 ” without quotes means that the user gets 5 points if he answers the question with the id 1 with “ Berlin ”. Multiple answers are separated by a ; Both answers will get 5 points... One point per line! If a question is not listed here, it will be ignored in the pointing system. Here a simple example:

->question1: What a number has PI?

question1 = 3.14 > 5

question1 = 3.1 > 4

question1 = 3 > 2

If a user types in 3.14 he gets 5 points. If he types in 4 he will get 0 points because it is not listed! You can also set negative values!

In the next two checkboxes, which are only shown if the pointing system is activated, you can define if the number of possible points are shown after a question...

...and if the user will get an overview of his attained points when he finished the survey (in the results and the email).

In the next field you can set the text of the numeration. For example "Question #:" (without quotes) will be shown as "Question 1:" etc. So the # will be replaced by the current question number. If no # is found, the number will be placed at the end. Uncheck the box if you don't need numeration of questions.

In the next field you can set a title for the submit button.

In the template field you can set your own html-template for the look of the survey. Else the default-template.html will be taken - take a look at the Template chapter if you want to see, how to set up your own template!

In the field "Mandatory field error text" you can set a short text which will appear, if a mandatory field is not filled.

In this field you can choose if the survey results should be available in the frontend or not.

Here you can say that questions which are not anymore in the survey, will not be displayed in the results.

In the "Survey result to following e-mails"-field you can add mails where the result of the survey will be sent to. Separate the mails by a simple linebreak - each line should only contain one email!

In the next four fields you can enter the mail subject...

...the senders mail...

...the sender name...

...and optional a HTML-template file. Use ###CONTENT### in the HTML- file if you want to fill in the survey result there. If a template is selected, the next field will be ignored!

And finally the content of the email. Use ###CONTENT### in the text if you want to fill in the survey result there.

If you want to save the results to the database you can check this field. (Needed if you want to evaluate the survey results in the backend!)

The target-page is the page where the user will be sent to, when he submits the form. This should only be a page id (123) or a website (http://www.yourpage.com)! If it's blank he will get to the same page without the form but a good bye text (see next point)...

The "goodbye text" will be shown if you filled out a survey and no target page is defined (use ###CONTENT### in the text if you want the user to show the result again)!

Next you can add some userdata-fields - this can be for example the users lastname, his email, company, etc. (to use this, the user data fields have to be created like the questions).

If you have set a user data field with the users e-mail you can send him an affirmation-mail by checking this box.

...and if the box is checked you have to set the field, where the mail will be filled in (e.g. the e-mail field) by the user.

In the next three fields you have to insert the mail subject (Thanks for filling the survey!)

and the senders mail (survey@yourcompany.com)

and the senders name if you want to send a mail to the user or/and yourself. These three fields will apply to the emails in the “receipt mails field” and the affirmation email.

In the Mail-Template field you can upload a HTML-file for the user- mail. Use ###CONTENT### in the HTML-file if you want to fill in the survey result there. If a template is selected, the next field will be ignored!

Now you can set the content of the mail which will be send to the user - use ###CONTENT### in the text if you want to fill in the survey result there.