EXT: Questionaire¶

What does it do?¶

Questionaire is an extension to take surveys from the visitors of your website. The results can be exported to a csv-file to analyze in Microsoft Excel or the statistical program SPSS , it's open source concurrents PSPP or OpenStat. A separate extension, Questionaire Export (pbsurveyexport) is available to export the results. In the future statistical analysation can be done in the TYPO3 backend as well. The development of this extension Questionaire Statistics (pbsurveystatistics) has already started.

Features¶

24 different questions and presentation items, including 7 open ended questions, 4 matrix types, and 7 choice types

• Visitors can enter the questionaires anonymous or by FE-login.
• Maximum number of responses per logged in user.
• Optional update of response by respondent.
• Different actions after taking a survey, like showing a message or closing the browser window.
• Optional 'Cancel' and/or 'Back'-button
• Multiple options if a user clicks the cancel button while taking a survey.
• Page and question numbering options.
• Possibility to enter a default value for each question.
• Make questions mandatory.
• Pagebreaks
• Show or hide pages from the respondent based on page conditions.
• Form validation on Client Side with JavaScript or Server Side with PHP, especially usefull for accessibility.
• 2 formats of exporting the data format.
• Optional export of unfinished results with separate 'export' extension (pbsurveyexport)
• Styling by template file and Cascading Style Sheets (CSS).
• Configuration by FlexForm or TypoScript.
• XHTML-strict output.
• Optional Captcha check at the beginning of the survey. (Needs the extension sr_freecap to be loaded)
• Redirect respondents to different pages at the end of the survey depending on their scores.
• Send an email to multiple recipients when a visitor finishes a survey, containing the questions with their answers or a message.

Screenshots¶

Image 1Configuration of a questionaire using a FlexForm.

Image 2Add a new question

Image 3The Answer Wizard

Image 4Add a page break.

Image 5The Page Conditions Wizard.

Image 6An example of a questionaire.

Installation¶

Questionaire is developed for systems running TYPO3 version 3.8.1 and up. Install the extension using the Extension Manager.

WARNING !! if you have installed tx_pbsurvey version <0.1.2 and want to upgrade it to version 1.0.0+ please read the part “How to update”.

How to update¶

tx_pbsurvey 1.0.0+ handles the results completely different than previous versions (<0.1.2). I have tried to build an updatetool, but this tool was very time and processor power consuming, especially with large amounts of results.

It is advisable to finish running surveys, export / backup all data and remove the previous extension from the Extension Manager. Remove the database tables “tx_pbsurvey_items” and “tx_pbsurvey_results” as well. All data in these tables will be useless after upgrading to the new version, so it is better to clean them completely.

I have tried to build a proper base for upcoming versions and features of Questionaire. Hopefully the changes to database tables will not be that big in the future.

Preparations¶

• Make a new system folder (SysFolder) for storage of the questionaire items and results. This is optional but recommended.
• If not using a anonymous questionaire, make a new system folder for Frontend users and groups as well.
• A default set of CSS styles is included in the extension. To use these CSS styles, include the static extension template “default CSS-styles (pbsurvey)” in your main TS-template at the part “Include static (from extensions):”. For more explanation about static extension templates read the section “Templates” in the TYPO3 document “Getting Started”. If you want to use your own CSS-styles for the extension, simply do not select the static extension template.
• Add a new page which shall contain the plugin. If the questionaire will not be held anonymously, choose a usergroup in 'Access' which users may enter the questionaire. Don't forget to add a page which contains a login-box plugin (standard 'Login form' or 'Better login- box). Read the manuals of these extensions.

Include static extension template¶

*** Important Note ***There is a major change between pbsurvey 1.0.0 and older versions: In pbsurvey 1.0.0 the default stylesheet is not included automatically.

To use the default CSS-stylesheet it needs to be included with the “Include static (from extensions)” feature.

Add the plugin¶

Go to the page which shall contain the plugin. Using the module 'Web > Page' you can add a content element to this page. Choose 'Questionaire' under 'Plugins' in the wizard 'New content element'. If not using the wizard, choose 'Insert plugin' from the Type-dropdown and select the option 'Questionaire' in the form field 'Plugin'. (See 'Configuration' for a explanation of the various fields. Warning : Do not use the option 'IP-address' in the select field 'Anonymous check' on the tab 'Access' unless you are aware what you are doing. Using this option can cause loss or overwriting of answers, because of a sudden IP change in a session or people who use the same IP address. Use this option only when you are certain all users have a different IP address which will not change, like in some internal networks.

How to design a questionaire.¶

When arranging a questionaire, a thorough design process generally goes in advance. The most important factor is to know what your customer, employee or member wants or thinks).

Statistics¶

Statistical calculations can be done several ways.

To calculate your statistics in statistical software like SPSS, or its Open Source concurrents PSPP or OpenStat, you can export all results to a file with comma separated values, a CSV file. A CSV-file is a standardized format which can be imported and processed in most of the spreadsheet and statistics software. To generate a CSV file, a separate extension, “Questionaire Export” (pbsurveyexport) is available. This extension will integrate itself in the backend module Web>Questionaire. See the manual of “Questionaire Export “for more details.

In the near future it will be possible to have statistics in the backend module as well. The development of this extension has already been started. The name of this extension will be “Questionaire Statistics” (pbsurveystatistics). With this module function you can have statistics like cross-tabular data and graphics.

Scoring¶

Scoring means you can do a test amongst your respondents. Depending on its score, the respondent will be redirected to a certain page, assigned by a minimum and maximum score. Is the score of the respondent higher than the minimum and lower or equal to the maximum, then the respondent will be redirected to this page. The score will be the total points collected by the given answers. These points need to be assigned to each answer in the “Answer wizard”

To enable scoring you must choose the option “Redirect to scoring pages” of the “Completion action” at the “Completion” tab of the plugin. When enabled, you also have to fill the “Scoring” tab of the plugin. At first, this tab will only provide you a dropdown box to enter a “NEW Scoring page”. When you select this option, you have to save the form to get the fields of a scoring page. In these fields you can enter the maximum score, that will be evaluated with the score of the respondent, and the page where the respondent will be redirected if his score matches.

Example:

The total points of the test the respondent can collect by answering all questions with answers with the highest points is 235. We want to have 5 different levels of scoring: Bad – Below average – Average – Above Average – Excellent. 235 diveded by 5 is 47. The first scoring page, Bad, has as maximum score 47 point, the second one, below average 94, the third, Average, 141 and so on.

47 – Bad94 – Below average141 – Average188 – Above average235 – Excellent

The respondent scores 165 points. With this score he gets at the “Above average” level and will be redirected to the corresponding page. The level “Above average” has as a minimum score 142 (the maximum of “Average” is 141) and a maximum of 188 points.

Scoring can only be done with the following question types:

• Choice - Multiple Answers (Checkboxes)
• Choice - Multiple Answers (Selectbox)
• Choice - One Answer (Dropdown)
• Choice - One Answer (Option Buttons)
• Matrix - Multiple Answers per Row (Checkboxes)
• Matrix - One Answer per Row (Option Buttons)

Remember that the scoring of multiple answer questions can raise the score dramatically when the respondent checks all the checkboxes. This way he/she can influence the result. The reason why these question types are made possible with scoring is that you can have, for instance, two answers which could be right and the others are not. You can assign points to the right answers and no points (zero) to the false ones. You can influence the amount of answers the respondent can check in the form of these question types.

For your convenience two parameters are send with the URL of the scoring page. These parameters are the total points a respondent can get in the test (tx_pbsurvey_pi1[total]) and the score of the respondent (ts_pbsurvey_pi1[score]). These parameters can be used when you provide your own plugin on the scoring pages.

FAQ¶

• Q: Why is the Captcha at the front of the survey and not at the end, like in mailforms? A: The goal of a Captcha is to prevent spamming a form on a website. A user has to answer the Captcha before any form is submitted to the website. A survey can be split into several pages. After submitting each page, the user answers will be stored immediately. So it doesn't make sense to put it at the end of the survey.
• Q: When I install and load the extension in TYPO3, I can't reach the backend module Web>Questionaire? A: This is a standard behaviour of TYPO3. After you install and load an extension in TYPO3, you have to logout and login again to make the backend module to work. Reloading the browser window won't do the trick.
• Q: What can I do with the results, gathered with pbsurvey. I can't see an option to export the results or calculate backend statistics A: Perhaps you've only installed the main extension pbsurvey. To export the results to a CSV file, you need to download the extension pbsurveyexport from the TER as well and load in into TYPO3. This way the backend module will get more functionality. In the future an extension for backend statistics will also be available.
• Q: I don't know how to read the exported results. How do I analyze these? A: Pbsurvey is written for users who know how to handle statistical data. If you don't know how to read the results, don't start a survey at all, buy a book and learn it, or ask a friend who knows how to handle this to do it for you. Maybe a hint: A lot of students on universities learn how to analyze statistical data with software called SPSS.

Rights & Permissions¶

The basics about the Rights & Permissions concepts of TYPO3 can be found in the "getting started" document: http://typo3.org/documentation/document- library/doc_tut_quickstart/Setting_up_user_perm/

for some advanced options see: http://typo3.org/documentation /document-library/doc_core_tsconfig/MOD/

FlexForm-configuration¶

Reference (TypoScript)¶

plugin.tx_pbsurvey_pi1 {
  templateFile = fileadmin/my_templates/pbsurvey.html
}

plugin.tx_pbsurvey_pi1 {
  pid = 23
}

plugin.tx_pbsurvey_pi1 {
  accessLevel = 0
}

plugin.tx_pbsurvey_pi1 {
  maximumResponses = 1000
}

plugin.tx_pbsurvey_pi1 {
  userResponses = 5
}

plugin.tx_pbsurvey_pi1 {
  daysForUpdate = 7
}

plugin.tx_pbsurvey_pi1 {
  validation = 1
}

plugin.tx_pbsurvey_pi1 {
  anonymous {
    mode = 1
  }
}

plugin.tx_pbsurvey_pi1 {
  anonymous {
    cookie_lifetime = 1
  }
}

plugin.tx_pbsurvey_pi1 {
  security {
    captcha = 1
  }
}

plugin.tx_pbsurvey_pi1 {
  completion {
    action = 2
  }
}

plugin.tx_pbsurvey_pi1 {
  completion {
    redirectPid = 233
  }
}

plugin.tx_pbsurvey_pi1 {
  completion {
    button {
      close = 1
    }
  }
}

plugin.tx_pbsurvey_pi1 {
  completion {
    button {
      continue = 1
    }
  }
}

plugin.tx_pbsurvey_pi1 {
  navigation {
    back = 0
  }
}

plugin.tx_pbsurvey_pi1 {
  navigation {
    cancel = 1
  }
}

plugin.tx_pbsurvey_pi1 {
  navigation {
    cancelPid = 233
  }
}

plugin.tx_pbsurvey_pi1 {
  numbering {
    page = 1
  }
}

plugin.tx_pbsurvey_pi1 {
  numbering {
    question = 2
  }
}

Template file¶

RealUrl and SimulateStaticDocuments¶

tx_pbsurvey works with default “typolink” functions to build links. It can be used with “SimulateStaticDocuments” and “RealUrl”.

No extra configuration is necessary when using RealUrl. Almost all data is send by 'POST' and not in the URL.

tx_pbsurvey is a USER_INT so doesn't use any caching.

Multilanguage Surveys¶

Since version 1.0.0 tx_pbsurvey supports the localization features introduced with TYPO3 3.7.0. You can build a true “one-tree-fits-all- languages” site without breaking this concept by using one pbsurvey sysfolder for all languages.

To integrate tx_pbsurvey in a multilanguage website, follow the steps described below:

Warning: First add all survey items to the sysfolder, assigned to this survey, in the default language. Make sure the survey is working perfectly in the default language. Test it first before entering translations. If you change items in the default language after you added translations, you have to delete the translations of this changed item, otherwise it is possible you get strange results. Especially Page Conditions, the answers and rows fields are sensitive for any changes. Fields that can be translated do not adapt themselves after you change the original default language field. You are warned!

Open the sysfolder where your survey items are located (Web > List) and create a “Alternative Page Language” for each language you want to present the survey in.

Check the “localization view” at the bottom of the page.

When you have assigned flags to each language, these flags will show up at the right of each survey item. You can click on them to localize a survey db-record in the chosen language. The flag icon is moved to the localization column to show that there is a translation record for this item.

Hint: If you don't want the localized survey records to be immediately visible on the website you can enable “Hide new localizations” in the extension configuration (see section “Installation”).

The titles of the survey records have been prepended with “[Translate to {language_label}]”.

Hint: Prepending titles with “[Translate to {language_label}]” can be disabled in the extension configuration. If this is disabled “(copy [#])” will be added to the titles of the localized records. This can be disabled too in the extension configuration.

Language = all: If you set the language in a survey record to “all” , this record will be displayed in all available languages. Although for some content elements in TYPO3 this is fine, it is not for a survey. Good survey results are based on a good understanding of questions by the visitors of your website. If they don't understand the default language completely, this could result into answers they did not want to enter. Be carefull with this one. For instance this is usefull when adding a pagebreak without any title, description or page condition.

Below you see a localized version of a survey item:

As you can notice, some fields are missing compared to the original default language item. These are field that don't need to be translated and will be extracted from the default language.

Below each field, available in the localization, the default language of this record is shown.

Sys_language_mode

Normally when you can translate items in TYPO3, you have the possibility to choose between different language modes. These will define if only translated records will be shown (strict mode) or display also the records in the default language that are not translated (default). tx_pbsurvey always shows its items in “strict” mode, to have a proper survey. This cannot be changed.

Exporting results¶

Since version 1.0.0 tx_pbsurvey itself has no longer an export function. The export module is available as a separate extension, Questionaire Export (pbsurveyexport), on the TER. I've separated the main questionaire extension from the export moduile because of future functionality like backend statistics. Therefore some people don't need the export module anymore. All extra backend modules like statistics will be available as extensions as well.

1¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

((Unknown Property))¶

EXT: Questionaire - 31