Login / Status
developer.Resource
Home . Documentation . Document Library . Extension Manuals
Sponsors
hosted by punkt.deTYPO3 and Open Source Magazine

1.6. Configuration

All configuration of the Questionaire can be done with the FlexForm of the extension, the “Constant Editor” or with the “TypoScript Object Browser”.

To change the configuration using the FlexForm, open the Content Element in “Web > Page” or “Web > List”. Below is the configuration of each tab.

Click on “Web > Template” to go to the “Constant Editor”, select a page which contains the “Root template” in the pagetree and click on “Constant Editor” in the upper right corner of the screen.

All configuration is available in the FlexForm and the Constant Editor. The FlexForm values will override values from TypoScript. To see the current TS settings for a page, click on “Template” in the “Web” menu, choose this page in the pagetree, and open the “TypoScript Object Browser” on this page.  More information about the  “TypoScript Object Browser” : http://typo3.org/documentation/document-library/doc_tut_quickstart/The_Object_Browser/

All default configuration of Questionaire is stored in the file ext_typoscript_setup.txt, which is in the folder of this extension.

FlexForm-configuration

FLEXFORM: Tab

Property

Description

General

Startingpoint

With the button “Browse for records” you can select the page or folder you made to store the questionaire items and results. If this field is empty, the items and results will be stored in the same page as the extension.

Template file

If you want to use your own  template file, please select one here in the TYPO3 Element Browser.

With the button “Browse for records” you can select the page or folder you made to store the questionaire items and results. If this field is empty, the items and results will be stored in the same page as the extension.

Template file

If you want to use your own  template file, please select one here in the TYPO3 Element Browser.

Template file

If you want to use your own  template file, please select one here in the TYPO3 Element Browser.

If you want to use your own  template file, please select one here in the TYPO3 Element Browser.

 

Access

Show Captcha before entering survey

A captcha can be used to prevent comment spam, guestbook spam, automated signups or any area of your website where you fear the evil spammers may target. If cheched a Captcha will be shown (Needs the freeCap CAPTCHA (sr_freecap) to be loaded)

Respondent Access Level

  1. Multiple Response: Respondents are allowed to enter the questionaire unlimited or within a configurable limit.See 'Maximum Responses' on the tab 'Other'.

  2. Single Response: Visitors can respond only once. They can update their previous questionaire, within a configurable time. See 'Days for Update' on the tab 'Other'.

  3. Single Response (Not Updateable): Visitors can respond only once. A previous entered questionaire can not be updated. If a respondent tries to login a second time, a message will be displayed the questionaire can only be entered once.

Anonymous check

  1. IP-address: The check is done by the IP-address of the user. This option will be especially used when you expect users with different non-changing IP-addresses. A lot of times company networks use only one IP address to connect to the Internet.

  1. Cookie: After the first submitted answer, a cookie will be set on the users computer with the result id and the amount of responses of this single user to one survey. A disadvantage is a user can delete its cookie from its own computer.

Cookie lifetime (in days)

The amount of days a cookie will reside on the users computer. Most of the time this lifetime needs to be the same amount as the lifetime of the survey.

A captcha can be used to prevent comment spam, guestbook spam, automated signups or any area of your website where you fear the evil spammers may target. If cheched a Captcha will be shown (Needs the freeCap CAPTCHA (sr_freecap) to be loaded)

Respondent Access Level

  1. Multiple Response: Respondents are allowed to enter the questionaire unlimited or within a configurable limit.See 'Maximum Responses' on the tab 'Other'.

  2. Single Response: Visitors can respond only once. They can update their previous questionaire, within a configurable time. See 'Days for Update' on the tab 'Other'.

  3. Single Response (Not Updateable): Visitors can respond only once. A previous entered questionaire can not be updated. If a respondent tries to login a second time, a message will be displayed the questionaire can only be entered once.

Anonymous check

  1. IP-address: The check is done by the IP-address of the user. This option will be especially used when you expect users with different non-changing IP-addresses. A lot of times company networks use only one IP address to connect to the Internet.

  1. Cookie: After the first submitted answer, a cookie will be set on the users computer with the result id and the amount of responses of this single user to one survey. A disadvantage is a user can delete its cookie from its own computer.

Cookie lifetime (in days)

The amount of days a cookie will reside on the users computer. Most of the time this lifetime needs to be the same amount as the lifetime of the survey.

Respondent Access Level

  1. Multiple Response: Respondents are allowed to enter the questionaire unlimited or within a configurable limit.See 'Maximum Responses' on the tab 'Other'.

  2. Single Response: Visitors can respond only once. They can update their previous questionaire, within a configurable time. See 'Days for Update' on the tab 'Other'.

  3. Single Response (Not Updateable): Visitors can respond only once. A previous entered questionaire can not be updated. If a respondent tries to login a second time, a message will be displayed the questionaire can only be entered once.

Anonymous check

  1. IP-address: The check is done by the IP-address of the user. This option will be especially used when you expect users with different non-changing IP-addresses. A lot of times company networks use only one IP address to connect to the Internet.

  1. Cookie: After the first submitted answer, a cookie will be set on the users computer with the result id and the amount of responses of this single user to one survey. A disadvantage is a user can delete its cookie from its own computer.

Cookie lifetime (in days)

The amount of days a cookie will reside on the users computer. Most of the time this lifetime needs to be the same amount as the lifetime of the survey.

  1. Multiple Response: Respondents are allowed to enter the questionaire unlimited or within a configurable limit.See 'Maximum Responses' on the tab 'Other'.

  2. Single Response: Visitors can respond only once. They can update their previous questionaire, within a configurable time. See 'Days for Update' on the tab 'Other'.

  3. Single Response (Not Updateable): Visitors can respond only once. A previous entered questionaire can not be updated. If a respondent tries to login a second time, a message will be displayed the questionaire can only be entered once.

Anonymous check

  1. IP-address: The check is done by the IP-address of the user. This option will be especially used when you expect users with different non-changing IP-addresses. A lot of times company networks use only one IP address to connect to the Internet.

  1. Cookie: After the first submitted answer, a cookie will be set on the users computer with the result id and the amount of responses of this single user to one survey. A disadvantage is a user can delete its cookie from its own computer.

Cookie lifetime (in days)

The amount of days a cookie will reside on the users computer. Most of the time this lifetime needs to be the same amount as the lifetime of the survey.

Anonymous check

  1. IP-address: The check is done by the IP-address of the user. This option will be especially used when you expect users with different non-changing IP-addresses. A lot of times company networks use only one IP address to connect to the Internet.

  1. Cookie: After the first submitted answer, a cookie will be set on the users computer with the result id and the amount of responses of this single user to one survey. A disadvantage is a user can delete its cookie from its own computer.

Cookie lifetime (in days)

The amount of days a cookie will reside on the users computer. Most of the time this lifetime needs to be the same amount as the lifetime of the survey.

  1. IP-address: The check is done by the IP-address of the user. This option will be especially used when you expect users with different non-changing IP-addresses. A lot of times company networks use only one IP address to connect to the Internet.

  1. Cookie: After the first submitted answer, a cookie will be set on the users computer with the result id and the amount of responses of this single user to one survey. A disadvantage is a user can delete its cookie from its own computer.

Cookie lifetime (in days)

The amount of days a cookie will reside on the users computer. Most of the time this lifetime needs to be the same amount as the lifetime of the survey.

Cookie lifetime (in days)

The amount of days a cookie will reside on the users computer. Most of the time this lifetime needs to be the same amount as the lifetime of the survey.

The amount of days a cookie will reside on the users computer. Most of the time this lifetime needs to be the same amount as the lifetime of the survey.

 

Completion

Completion Action

  1. Close the browser: This option is only advisable when the Questionaire is displayed in a popup window, otherwise some browsers will show a warning message the browser window will be closed.

  1. Display Message: Displays a message, entered in the field 'Completion Message', when the questionaire is completed.

  2. Redirect to another page: Redirect the respondent to another page, entered in the field 'Completion Page', when the questionaire is completed.

  3. Redirect to scoring pages. Redirect the respondent to a page based on its score. When selecting this option, you have to fill the “Scoring” tab as well.

Completion Page

Select a page with the TYPO3 Element Browser only when 'Display Message' or 'Redirect to another page' is selected in the 'Completion Action' dropdown. When 'Display Message' is chosen, also select 'Continue Button'.

Close Button

Display a button to close the browser window. Only possible when 'Display Message is selected in the dropdown 'Completion Action'.

Continue Button

If a message is displayed, a 'Continue' button can be shown. Also select a page in the field 'Completion Page'.

  1. Close the browser: This option is only advisable when the Questionaire is displayed in a popup window, otherwise some browsers will show a warning message the browser window will be closed.

  1. Display Message: Displays a message, entered in the field 'Completion Message', when the questionaire is completed.

  2. Redirect to another page: Redirect the respondent to another page, entered in the field 'Completion Page', when the questionaire is completed.

  3. Redirect to scoring pages. Redirect the respondent to a page based on its score. When selecting this option, you have to fill the “Scoring” tab as well.

Completion Page

Select a page with the TYPO3 Element Browser only when 'Display Message' or 'Redirect to another page' is selected in the 'Completion Action' dropdown. When 'Display Message' is chosen, also select 'Continue Button'.

Close Button

Display a button to close the browser window. Only possible when 'Display Message is selected in the dropdown 'Completion Action'.

Continue Button

If a message is displayed, a 'Continue' button can be shown. Also select a page in the field 'Completion Page'.

Completion Page

Select a page with the TYPO3 Element Browser only when 'Display Message' or 'Redirect to another page' is selected in the 'Completion Action' dropdown. When 'Display Message' is chosen, also select 'Continue Button'.

Close Button

Display a button to close the browser window. Only possible when 'Display Message is selected in the dropdown 'Completion Action'.

Continue Button

If a message is displayed, a 'Continue' button can be shown. Also select a page in the field 'Completion Page'.

Select a page with the TYPO3 Element Browser only when 'Display Message' or 'Redirect to another page' is selected in the 'Completion Action' dropdown. When 'Display Message' is chosen, also select 'Continue Button'.

Close Button

Display a button to close the browser window. Only possible when 'Display Message is selected in the dropdown 'Completion Action'.

Continue Button

If a message is displayed, a 'Continue' button can be shown. Also select a page in the field 'Completion Page'.

Close Button

Display a button to close the browser window. Only possible when 'Display Message is selected in the dropdown 'Completion Action'.

Continue Button

If a message is displayed, a 'Continue' button can be shown. Also select a page in the field 'Completion Page'.

Display a button to close the browser window. Only possible when 'Display Message is selected in the dropdown 'Completion Action'.

Continue Button

If a message is displayed, a 'Continue' button can be shown. Also select a page in the field 'Completion Page'.

Continue Button

If a message is displayed, a 'Continue' button can be shown. Also select a page in the field 'Completion Page'.

If a message is displayed, a 'Continue' button can be shown. Also select a page in the field 'Completion Page'.

 

Navigation

Back Button

Display a 'Back' button beneath each page to redirect the respondent back to the previous page in the questionaire.

Cancel Button

Display a 'Cancel' button and choose the action when a respondent presses the 'Cancel' button. Enter a page in the field 'Cancel Button Page' when you select 'Redirect to custom page'.

WARNING: When a respondent decides to cancel the questionaire, the previous answered questions will not be stored in the database. This is done because canceled questionaires can influence the total result.

Cancel Button Page

Select a page with the TYPO3 Element Browser where the respondent will be redirected when he/she presses the 'Cancel' button.

Display a 'Back' button beneath each page to redirect the respondent back to the previous page in the questionaire.

Cancel Button

Display a 'Cancel' button and choose the action when a respondent presses the 'Cancel' button. Enter a page in the field 'Cancel Button Page' when you select 'Redirect to custom page'.

WARNING: When a respondent decides to cancel the questionaire, the previous answered questions will not be stored in the database. This is done because canceled questionaires can influence the total result.

Cancel Button Page

Select a page with the TYPO3 Element Browser where the respondent will be redirected when he/she presses the 'Cancel' button.

Cancel Button

Display a 'Cancel' button and choose the action when a respondent presses the 'Cancel' button. Enter a page in the field 'Cancel Button Page' when you select 'Redirect to custom page'.

WARNING: When a respondent decides to cancel the questionaire, the previous answered questions will not be stored in the database. This is done because canceled questionaires can influence the total result.

Cancel Button Page

Select a page with the TYPO3 Element Browser where the respondent will be redirected when he/she presses the 'Cancel' button.

Display a 'Cancel' button and choose the action when a respondent presses the 'Cancel' button. Enter a page in the field 'Cancel Button Page' when you select 'Redirect to custom page'.

WARNING: When a respondent decides to cancel the questionaire, the previous answered questions will not be stored in the database. This is done because canceled questionaires can influence the total result.

Cancel Button Page

Select a page with the TYPO3 Element Browser where the respondent will be redirected when he/she presses the 'Cancel' button.

Cancel Button Page

Select a page with the TYPO3 Element Browser where the respondent will be redirected when he/she presses the 'Cancel' button.

Select a page with the TYPO3 Element Browser where the respondent will be redirected when he/she presses the 'Cancel' button.

 

Numbering

Page Numbering

There are three methods to show the visitor the progress of the questionaire. The position of the page number depends on the template file of the extension. When using conditions in the questionaire, it is possible to skip some pages. See 'Conditions' for more information.

  1. Do not display page numbers

  1. Display progress as a progress bar: Display a percentage bar with the text 'Page X of Y'.

  2. Display progress in 'Page X of Y' format

  3. Display page number on each page: The page number will be displayed as 'Page X'.

Question Numbering

  1. Do not display question numbers:

  2. Number questions within the entire questionaire: Questions will be numbered throughout the entire questionaire.

  3. Number questions within each page: Numbering will start with 1 on every new page.

There are three methods to show the visitor the progress of the questionaire. The position of the page number depends on the template file of the extension. When using conditions in the questionaire, it is possible to skip some pages. See 'Conditions' for more information.

  1. Do not display page numbers

  1. Display progress as a progress bar: Display a percentage bar with the text 'Page X of Y'.

  2. Display progress in 'Page X of Y' format

  3. Display page number on each page: The page number will be displayed as 'Page X'.

Question Numbering

  1. Do not display question numbers:

  2. Number questions within the entire questionaire: Questions will be numbered throughout the entire questionaire.

  3. Number questions within each page: Numbering will start with 1 on every new page.

Question Numbering

  1. Do not display question numbers:

  2. Number questions within the entire questionaire: Questions will be numbered throughout the entire questionaire.

  3. Number questions within each page: Numbering will start with 1 on every new page.

  1. Do not display question numbers:

  2. Number questions within the entire questionaire: Questions will be numbered throughout the entire questionaire.

  3. Number questions within each page: Numbering will start with 1 on every new page.

 

Scoring

NEW “Scoring page”

Inserts a new scoring page. When selecting this option, save the form to see the new field.

Maximum score

Enter the maximum score of the scoring page. The score of the respondent will be evaluated with this integer as maximum and, if available, the lower integer from another scoring page as minimum.

Redirect to page

Select a page with the TYPO3 Element Browser where the respondent will be redirected when the score matches the minimum and maximum integer..

Inserts a new scoring page. When selecting this option, save the form to see the new field.

Maximum score

Enter the maximum score of the scoring page. The score of the respondent will be evaluated with this integer as maximum and, if available, the lower integer from another scoring page as minimum.

Redirect to page

Select a page with the TYPO3 Element Browser where the respondent will be redirected when the score matches the minimum and maximum integer..

Maximum score

Enter the maximum score of the scoring page. The score of the respondent will be evaluated with this integer as maximum and, if available, the lower integer from another scoring page as minimum.

Redirect to page

Select a page with the TYPO3 Element Browser where the respondent will be redirected when the score matches the minimum and maximum integer..

Enter the maximum score of the scoring page. The score of the respondent will be evaluated with this integer as maximum and, if available, the lower integer from another scoring page as minimum.

Redirect to page

Select a page with the TYPO3 Element Browser where the respondent will be redirected when the score matches the minimum and maximum integer..

Redirect to page

Select a page with the TYPO3 Element Browser where the respondent will be redirected when the score matches the minimum and maximum integer..

Select a page with the TYPO3 Element Browser where the respondent will be redirected when the score matches the minimum and maximum integer..

 

Other

Maximum Responses

Enter a numeric value for the maximum responses on the entire questionaire. When this amount is reached the questionaire will automatically close for future respondents. When a questionaire is closed, it will display a message. Leave at zero if the maximum responses is unlimited or if done anonymously.

Responses per user

If the respondent access level is set to 'Multiple Response' you can enter a limit here. When this limit is reached the respondent will be shown a message and can't enter the questionaire anymore.

Days for Update

Enter the amount of days in which the respondent is able to update his/hers previous response. This will only work when the 'Respondent Access Level' is set to 'Single Response'.

Form validation

Normally the form validation will be done on the client side with JavaScript. The processing will not be done on the server, so it doesn't take any valuable resources. However, when you have a website that has to be accessible, it is recommended to do the form validation on the server with PHP.

Enter a numeric value for the maximum responses on the entire questionaire. When this amount is reached the questionaire will automatically close for future respondents. When a questionaire is closed, it will display a message. Leave at zero if the maximum responses is unlimited or if done anonymously.

Responses per user

If the respondent access level is set to 'Multiple Response' you can enter a limit here. When this limit is reached the respondent will be shown a message and can't enter the questionaire anymore.

Days for Update

Enter the amount of days in which the respondent is able to update his/hers previous response. This will only work when the 'Respondent Access Level' is set to 'Single Response'.

Form validation

Normally the form validation will be done on the client side with JavaScript. The processing will not be done on the server, so it doesn't take any valuable resources. However, when you have a website that has to be accessible, it is recommended to do the form validation on the server with PHP.

Responses per user

If the respondent access level is set to 'Multiple Response' you can enter a limit here. When this limit is reached the respondent will be shown a message and can't enter the questionaire anymore.

Days for Update

Enter the amount of days in which the respondent is able to update his/hers previous response. This will only work when the 'Respondent Access Level' is set to 'Single Response'.

Form validation

Normally the form validation will be done on the client side with JavaScript. The processing will not be done on the server, so it doesn't take any valuable resources. However, when you have a website that has to be accessible, it is recommended to do the form validation on the server with PHP.

If the respondent access level is set to 'Multiple Response' you can enter a limit here. When this limit is reached the respondent will be shown a message and can't enter the questionaire anymore.

Days for Update

Enter the amount of days in which the respondent is able to update his/hers previous response. This will only work when the 'Respondent Access Level' is set to 'Single Response'.

Form validation

Normally the form validation will be done on the client side with JavaScript. The processing will not be done on the server, so it doesn't take any valuable resources. However, when you have a website that has to be accessible, it is recommended to do the form validation on the server with PHP.

Days for Update

Enter the amount of days in which the respondent is able to update his/hers previous response. This will only work when the 'Respondent Access Level' is set to 'Single Response'.

Form validation

Normally the form validation will be done on the client side with JavaScript. The processing will not be done on the server, so it doesn't take any valuable resources. However, when you have a website that has to be accessible, it is recommended to do the form validation on the server with PHP.

Enter the amount of days in which the respondent is able to update his/hers previous response. This will only work when the 'Respondent Access Level' is set to 'Single Response'.

Form validation

Normally the form validation will be done on the client side with JavaScript. The processing will not be done on the server, so it doesn't take any valuable resources. However, when you have a website that has to be accessible, it is recommended to do the form validation on the server with PHP.

Form validation

Normally the form validation will be done on the client side with JavaScript. The processing will not be done on the server, so it doesn't take any valuable resources. However, when you have a website that has to be accessible, it is recommended to do the form validation on the server with PHP.

Normally the form validation will be done on the client side with JavaScript. The processing will not be done on the server, so it doesn't take any valuable resources. However, when you have a website that has to be accessible, it is recommended to do the form validation on the server with PHP.

 

Reference (TypoScript)

Property:

Data type:

Description:

Default:

templateFile

resource

The HTML-template  (See example: pi1/template.html)

Example:

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

}

EXT:pbsurvey/pi1/template.html

pid

int

The page id (pid) where the questionaire items and results are stored. If this value is not set, the current page is used.

Example:

plugin.tx_pbsurvey_pi1 {
  pid = 23

}

accessLevel

int [0-2]

Enter a value from 0 to 2 for Respondent Access Level. This is only applicable when a non-anonymous survey is done.The following options are available:

0 = Multiple Response

1 = Single Response

2 = Single Response (Not Updateable)

Example:

plugin.tx_pbsurvey_pi1 {
  accessLevel = 0

}

0

maximumResponses

int

Enter the maximum number of responses for this survey. Leave at zero for unlimited responses.

Example:

plugin.tx_pbsurvey_pi1 {
  maximumResponses = 1000

}

0

userResponses

int

Enter the maximum number of responses per user. Leave at zero  for unlimited responses.

Example:

plugin.tx_pbsurvey_pi1 {
  userResponses = 5

}

0

daysForUpdate

int

Enter the number of days during which a respondent may update their response. This option only applies when tx_pbsurvey_pi1.accessLevel = 0.

Example:

plugin.tx_pbsurvey_pi1 {
  daysForUpdate = 7

}

60

validation

int

Defines the method used to validate the form. You can choose between client side javascript or server side PHP. The server side validation is especially handy when doing a survey that has to be accessible.

0 = client side JavaScript

1 = server side PHP

Example:

plugin.tx_pbsurvey_pi1 {
  validation = 1

}

0

-> anonymous.[options]

   

mode

Int [0-1]

Do a check by either IP address or a cookie if the user already responded to the survey. Both options can be used for all three access options.

Example:

plugin.tx_pbsurvey_pi1 {

  anonymous {

    mode = 1

  }

}

0

cookie_lifetime

Int

Amount of days the cookie will reside on the users computer.

Example:

plugin.tx_pbsurvey_pi1 {

  anonymous {

    cookie_lifetime = 1

  }

}

30

-> security.[options]

   

captcha

int

Questionaire is designed to work together with the extension freeCap Captcha (sr_freecap) from Stanislas Roland. When activating, be sure to install sr_freecap. The Captcha will be shown  BEFORE the survey.

Example:

plugin.tx_pbsurvey_pi1 {

  security {

    captcha = 1

  }

}

0

-> completion.[options]

   

action

int [0-2]

Action after completion. Below are the options:

0 = Close the browser

1 = Redirect to another page

2 = Display Message

3 = Redirect to scoring pages

Example:

plugin.tx_pbsurvey_pi1 {
  completion {
    action = 2

  }

}

0

redirectPid

int

Pid of the page that will be shown after the participant presses the 'Continue' button when the questionaire is finished or page that will be shown when action is set to 'Redirect to another page'.

Example:

plugin.tx_pbsurvey_pi1 {
  completion {
    redirectPid = 233

  }

}

-> completion.button.[options]

   

close

boolean

Displays a 'Close' button when  plugin.tx_pbsurvey.completion.action = 1

Example:

plugin.tx_pbsurvey_pi1 {
  completion {

    button {

      close = 1

    }

  }

}

0

continue

boolean

Displays a 'Continue' button when  plugin.tx_pbsurvey.completion.action = 1

Example:

plugin.tx_pbsurvey_pi1 {
  completion {

    button {

      continue = 1

    }

  }

}

0

-> navigation.[options]

   

back

boolean

If set to 0, a 'Back' button will not be displayed to return to the previous question.

Example:

plugin.tx_pbsurvey_pi1 {
  navigation {
    back = 0

  }

}

1

cancel

int [0-3]

Action to be taken when a participant clicks the 'Cancel' button.

These are the options:

0 = Do not display

1 = Close browser

2 = Redirect to end of questionaire

3 = Redirect to custom page

Example:

plugin.tx_pbsurvey_pi1 {
  navigation {
    cancel = 1

  }

}

2

cancelPid

int

Page where participant is redirected ifplugin.tx_pbsurvey_pi1.navigation.cancel = 3.

Example:

plugin.tx_pbsurvey_pi1 {
  navigation {
    cancelPid = 233

  }

}

-> numbering.[options]

   

page

int [0-3]

Method of numbering the pages.

0 = Do not display page numbers

1 = Display progress as progress bar

2 = Display progress in 'Page X of Y' format

3 = Display page number on each page

Example:

plugin.tx_pbsurvey_pi1 {
  numbering {
    page = 1

  }

}

2

question

int [0-2]

Method of numbering the questions.

0 = Do not display question numbers

1 = Number questions within entire questionaire

2 = Number questions within each page

Example:

plugin.tx_pbsurvey_pi1 {
  numbering {
    question = 2

  }

}

1

[tsref:(cObject)]

Template file

TEMPLATE: Marker

Property

###SURVEYFORM###

Wrap of the entire questionaire for display

###PROGRESSBAR###

Wrap in which the progress bar is build

###BACK_BUTTON###

Wrap in which the 'Back' button is build

###CANCEL_BUTTON###

Wrap in which the 'Cancel' button is build

###CLOSE_BUTTON###

Wrap in which the 'Close' button is build when the questionaire is completed

###CONTINUE_BUTTON###

Wrap in which the 'Continue' button is build when the questionaire is completed

###CAPTCHA###

Wrap in which the Captcha will be build.

###COMPLETION###

Wrap of the parts that should be displayed when the questionaire is completed.

###ERROR###

Wrap of the error screen

###NO_DATA###

Wrap of the screen that will be displayed when there is no data to show the visitor

###0### t/m ###22###

Wrap of each questionaire item. The numbers correspond with the numbers of each item explained in this manual.

-> SURVEYFORM.items

 

###PAGENUMBERING###

Position of the page numbering in the questionaire

###VALIDATIONERR###

Will be substituted with error messages if found any. Only with the server side validation.

###HEADER###

Position of the header and subtext

###URL###

URL to which the form has to be sent after submitting. Do NOT delete

###SUBMITVALUES###

Call to the client side JavaScript to check the participants input

###ITEMS###

Position of the questionaire items

###STAGE###

Internal counter

###VALIDATION###

Validation string used for server side validation.

###BACKBUTTON###

Position of the optional 'Back' button

###SUBMIT###

Local language of the 'Continue' button

###SUBMITVALUES###

Validation string used for Client side validation.

###CANCELBUTTON###

Position of the optional 'Cancel' button

-> PROGRESSBAR.items

 

###PERCENT###

Progress percentage of the questionaire

###BARTEXT###

Text which shows the progress as 'Page X of Y' in the progress bar

-> BACK_BUTTON.items

 

###BACK###

Local language of the 'Back' button

-> CANCEL_BUTTON.items

 

###CANCELTYPE###

Depending on its function this can be type=”submit” or type=”button”

###CANCEL###

Local language of the 'Cancel' button

###CANCELSCRIPT###

Depending on its function this will be filled with a piece of JavaScript

-> CLOSE_BUTTON.items

 

###CLOSE###

Local language of the 'Close' button

-> CONTINUE_BUTTON.items

 

###CONTINUE###

Local language of the 'Continue' button

###COMPLETE_CONTINUE###

URL of the page to redirect the participant to, when clicking the 'Continue' button

-> CAPTCHA.items

The following items are actually no markers from pbsurvey, but from the extension freeCap CAPTCHA (sr_freecap). When sr_freecap is installed and active, these markers will be filled with texts and an image from the sr_freecap extension. Pbsurvey is only providing the templatepart

 

###SR_FREECAP_NOTICE###

Short text what is Captcha all about

###SR_FREECAP_CANT_READ###

Link to generate another Captcha image when it is not readable

###SR_FREECAP_IMAGE###

Marker for the Captcha image

-> COMPLETION.items

 

###MESSAGE_TEXT###

Text to be displayed after completion of the questionaire

###MESSAGE_BUTTONS###

Optional buttons to be displayed below the message text

-> ERROR.items en -> NO_DATA.items

 

###MESSAGE_TEXT###

Text to be displayed when a error occurs

-> QUESTIONTYPE.items (1-16, 23)

The question types 1, 3, 4, and 5 are available in different variants. These can be identified with the addition behind the number. These additions are:

HOR: To display the answers with a horizontal alignment. (Radiobuttons or checkboxes)

VER: To display the answers with a vertical alignment (Radiobuttons or checkboxes)

DROP: To display a dropdown variant of the answers

 

###CURRENTITEM###

Question number

###QUESTION###

The question

###REQUIRED###

Wrap which displays its content when a answer is required

###COMMENT###

Wrap which displays its content when a answers depends on requirements

###COMMENT_COMMENT###

The text with the requirements

###SUB###

Wrap which displays its content when a subtext of the question is entered

###QUESTION_SUBTEXT###

The subtext of the question

###LIST###

Wrap to show the complete list of answers to a question

###COUNTER###

Counter for questions with multiple answers

###VALUE###

A single answer

###CHECKED###

To show a 'checked=”checked”' when the answer is on by default or at a update

###SELECTED###

To show a  'selected=”selected”' when the answer is on by default or at a update

###VALUE_NONE###

Text if there is a possible empty answer (Dropdown)

###ADDITIONALS###

Wrap which displays an optional additional answer

###ANSWERS_TEXT_ADDITONAL###

The text of the additional answer

###ADDITIONAL###

Textbox or area of the additional answer

###VALUE_NONE###

Local language of – None --

###SELECTBOX_HEIGHT###

Height of a selectbox in lines

###COLSPAN###

The amount of answer columns in a matrix question

###COLWIDTH###

Column width in a matrix question

###HEADER###

Wrap building the header row of a matrix question

###ROWS###

Wrap building all other rows of a matrix question

###ROWCLASS###

Class for each row in a matrix question. There is a different class for even and uneven rows

###ROW###

Name of the row entered on a single line in the item field 'Rows'

###COLUMNS###

Wrap to build all columns in a matrix question

###COL###

Name of the column, entered on a single line in the item field 'Enter the Answers'

-> PRESENTATION.items (17 - 21)

 

###VALUE###

Headline, Message or HTML entered in the presentation item

###ALIGN###

Horizontal alignment of the image on the screen

###IMAGE###

Image

-> PAGE BREAK AND CONDITIONS.item (22)

 

###TITLE###

Wrap of the page title

###PAGE_TITLE###

Page Title

###INTRODUCTION###

Wrap of  the page introduction

###PAGE_INTRODUCTION###

Page introduction

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.