@@ -618,8 +618,8 @@
trouble, post your problem and any error messages in the PHPSurveyor
forums on sourceforge.net and more likely than not someone will be able
to help you.
-
-
+
+
@@ -1007,823 +1007,878 @@
Creating
Surveys
-
-
-Creating a NEW SURVEY
-
-To create
-a new survey click on the  button at the right hand side of the
-administration button bar.
-
-The
-"Create New Survey" screen will appear below. Following is a
-description of each field:
-
-
-Title:
-This is the brief descriptive name of the survey (ie: "Enterprise
-Bargaining Survey 2003", or "Views on Ice Cream"). This title will be
-displayed on every page of the public survey script.
-
-Description:
-This allows you to enter a description of the survey. (ie: "A survey to
-collect your ideas on the next round of enterprise bargaining" or "A
-survey to find out the popularity of chocolate ice cream"). You can use
-html markup in this section.
-
-Welcome:
-This allows you to enter a message that will display when a participant
-first logs into your public survey screen. (ie: "Thank you for taking
-the time to participate in this survey..") You can use html markup in
-this section.
-
-Administrator:
-This is the name of the contact person who administrates the survey. It
-will be included in any emails sent out inviting participants to
-respond.
-
-Admin
-Email: This is the email address
-of the administrator (as above) and is used as the 'reply to:' address
-on any emails sent out.
-
-Fax
-To: This field is used to give a fax number on the
-"printable survey" - ie: when you want to send someone a hardcopy
-because they cannot use the online survey.
-
-Format:
-Choose from "One at a time", "Group at a time" or "All in one".
-
-
-One
-at a time Public survey will display one question per
-page.
-
-Group
-at a time Public survey will display all questions in a
-group per page.
-Group at a time surveys still have a separate "welcome" page and
-"submit" page, like "One at a time" surveys.
-
-All
-in one Public survey will display all questions in one
-single page
-All in one surveys do not have a "welcome" page or "submit" page - the
-welcome message and submit button all appear on the same page.
-
-Template:
-Choose from the installed templates in your system. The default
-template is rather dull, but functional. More information on creating
-your own templates is available in the PHPSurveyor
-Templates Guide
-
-Use
-Cookies?: If you choose "Use Cookies" and your survey
-does not use a tokens table to control participant access, then a
-cookie will be saved to the client computer of each survey participant
-once they have submitted a survey. This cookie will stop the same
-computer from accessing the survey more than once. There are inherent
-limitations in the 'security' strenght of such a system, but on a
-general basis it allows public surveys to retain some control over
-multiple entries.
-
-Allow
-Saves?: If you set this option to "Yes" then users can
-save unsubmitted surveys and return to them later.
-
-Show
-[<< Prev] button: This option defaults
-to yes, however if you set it to "No" then users will not have the
-option of moving to a previous page while completing the survey.
-
-Notification:
-Options to allow the administrator to be emailed when each individual
-survey response is saved. You can choose from:
-
-
-No
-email notification - self explanatory
-
-Basic
-email notification - an email is sent informing the
-administrator that a survey response has been saved
-
-Send
-email notification with response codes - sends the full
-answers to the survey after saving
-
-Anonymous:
-This allows you to determine whether responses to your survey are
-matched up with information from your surveys tokens table, or kept
-'anonymous'. The default is yes. If you choose "No" for anonymous, you
-must also have a tokens table for your survey when you activate it.
-
-Invitation
-Email Subject: The subject line for the invitation email
-that gets sent out when tokens are used with your survey.
-
-Invitation
-Email: This is the text for the invitation email that
-gets sent out when tokens are used with your survey. This is initially
-filled by the default invitation message (from the language files) but
-you can modify it to suit yourself. Of course if you don't plan to use
-tokens on your survey, whatever is in this field is irrelevent.
-You can use the following "form" fields to insert individualised
-information in each email:
-
-
-{FIRSTNAME}
-- gets replaced with the token table's "firstname" value
-
-{LASTNAME}
-- gets replaced with the token table's "lastname" value
-
-{SURVEYNAME}
-- gets replaced with your surveys name
-
-{SURVEYDESCRIPTION}
-- gets replaced with your surveys description
-
-{ATTRIBUTE_1}
-- gets replaced with the token table's "attribute_1" value
-
-{ATTRIBUTE_2}
-- gets replaced with the token table's "attribute_2" value
-
-{SURVEYURL}
-- gets replaced with the fully qualified URL to this particular survey
-
-Note
-that these "form fields" apply to the following email fields.
-
-Email
-Reminder Subject: The subject line for the reminder
-email that gets sent out from the tokens tool
-
-Email
-Reminder: This is the text for the reminder email that
-gets sent out when tokens are used with your survey. See "invitation
-email" for specific details on how this field is used.
-
-Confirmation
-Email Subject: When tokens are used, this is the subject
-line of the email that gets automatically sent to participants after
-completion of the survey
-
-Confirmation
-Email: This is the text of the email that gets sent to
-users after completion of the survey.
-
-Allow
-Public Registration: If you use tokens to control access
-to your survey, the only people who can use the survey are those who
-have an entry and a unique token from the token table. If you would
-like to use the tokens but allow public registration, use this field.
-Setting "Yes" to this will allow a visitor to your Survey URL to
-register their name and email address. The script will create a new
-entry in your tokens table for this person, then send them an
-invitation email. The script will ensure that only one person per email
-address can complete your survey.
-
-Public
-Registration Email Subject: This is the subject line for
-the invitation email sent to members of the public who register for a
-survey.
-
-Public
-Registration Email: This is the text for the invitation
-email sent to members of the public who register for a survey. The same
-"form fields" apply in this email as in the earlier ones.
-
-Token
-attribute names: The tokens table has two "spare" fields
-for storing additional information about users. When using the public
-registration system, you can use these two fields to give your
-attribute fields a nice name for the public. So, if you are using
-"attribute_1" to store the participants department name, you can label
-it appropriately.
-
-Datestamp?:
-This field allows you to determine whether the survey will datestamp
-all responses. If you choose "Yes", then when a response is submitted,
-a field will be included in that response indicating the time and date
-that the response was made. (See configuration settings for $timeadjust
-setting.)
-
-Language:
-A list of the possible language files will be shown next to this
-option. Changing the language setting here will change the default
-language used when participants use the public survey scripts (but will
-not change the administration language).
-
-Expires:
-This is the last date on which the public survey script will let people
-participate. (Read this twice... if you set it for the 31 of December,
-then people will no longer be able to use the survey script on the 1st
-of January).
-
-End
-URL: This URL will be presented as a link at the end of
-the survey, and allows you to direct your participants back to your
-home page (or, in fact, anywhere).
-
-URL
-Descrip: The description for the link using the End URL.
-
-Automatically
-Load URL when survey complete: If you choose "Yes" for
-this option, the script will automatically load the URL as set in "End
-URL" after completion of the survey, instead of displaying the usual
-"Completed" page. Do not use this if you are using assessments.
-
-Importing
-a Survey
If you have previously exported a
-survey, you can import it from the "New Survey" screen. Click on the
-browse button to choose the sql file, and then click on the
-button. The import process reads a
-'sql' file created by PHPSurveyor and 'intelligently' (I use the term
-advisedly) renumbers the survey, group, question, answer and condition
-id's so that they all match each other. See section on Exporting a Survey
-for more information.
-
-(B) Creating a NEW GROUP
-
-Before
-you can add any questions to your survey you must create a group.
-If you will only have one group in your survey, then how you name this
-group is irrelevant (except of course for show). If, however, you are
-going to have multiple groups, you should note that the survey
-questions will be displayed by group, and the groups
-will be displayed in alphabetical order. So,
-if you really need the groups to be displayed in a particular order,
-consider naming them with an alphabetic start such as "A)
-Questions about you" and "B) Questions about health".
-Doing it this way will ensure that your groups are displayed in order.
-If, for example, you entered the group names as "Questions
-about you" and "Questions about health",
-the "Questions about health" group will display
-first, because alphabetically it comes first. PHPSurveyor
-is designed to do this deliberately, because it allows you to add extra
-groups in later, and arrange their positioning by adjusting the title.
-For example, you could squeeze an extra group between the two by naming
-it "A1) Questions about your history".
-
You can create as many groups as you like.
-
-Groups
-can also include a "description". This field allows you to publish an
-explanatory note for any set of questions. If you add a description,
-then when the public are using the public survey system, they will be
-presented with that explanation before commencing any of the questions
-in that group. If you do not include any text here, then public
-participants will simply move on to the first question in the group
-with no stop.
-
-Create a
-new group by clicking on the icon in the Survey Button Bar.
-
-(C) Adding a QUESTION
-
-Once
-you have created your groups, you can start adding questions
-within each group. Create a new question by clicking on
-the add icon ()
-on the right hand side of the "Group" menu bar.
-
When adding a question, you will be asked for a "Question
-Code", the "Question", "Help" and a "Question Type". All new questions
-are assigned to the Group you were viewing when you clicked "Add
-Question", however you can change the group the question belongs too at
-a later point.
-
-
-Question
-Code: Your ID, or number or code for the
-question. This field is important, because the entry in this will
-determine the positioning of the question in your survey. Again,
-numbering this "Q1", and following questions "Q2" and "Q3" will ensure
-that they appear in the correct order. Using this system allows you to
-add in extra questions as an afterthought by giving them a code such as
-"Q1a". Try to be consistent with your coding in this field. Planning
-makes this process a lot easier.
-
-
-Question:
-This is the actual question being asked. There is no real limit to the
-length of the question here, however if you want to explain the
-question, leave that for the next field.
-
-Fields
-Within Questions
-TOKEN INFORMATION
-From PHPSurveyor release 0.98finalRC1 you can insert information/text
-from the tokens table into your question so that it can show context
-related information. For PHPSurveyor to do this, the survey needs to be
-set as NOT Anonymous (ie: tracked), and it needs to have a tokens table.
-
The fields available for this are:
-
-
-{TOKEN:FIRSTNAME}
-- inserts the value from the "firstname" field in the tokens table
-
-{TOKEN:LASTNAME}
-- inserts the value from the "lastname" field in the tokens table
-
-{TOKEN:EMAIL}
-- inserts the value from the "email" field in the tokens table
-
-{TOKEN:ATTRIBUTE_1}
-- inserts the value from the "attribute_1" field in the tokens table
-
-{TOKEN:ATTRIBUTE_2}
-- inserts the value from the "attribute_2" field in the tokens table
-
-To use
-this functionality you must type the field text into your question
-exactly as listed above. For example:
-
Hello {TOKEN:FIRSTNAME}. We sent an email to you
-using this address {TOKEN:EMAIL}. Is this correct?
-
If there are spaces or typing mistakes, the script will not
-replace your field with the appropriate information.
-
PREVIOUS ANSWERS
There
-is currently also the capacity to insert the answer of previous
-questions into the text of an answer with the following provisos:
-
-
-The
-question must have been answered in a previously displayed PAGE in the
-survey - answers to questions on the current page are not available
-
-You refer
-to the exact Survey ID, Group ID and Question ID for the question to
-which the answer was made - in the form: {INSERTANS:SIDXGIDXQID} - ie
-{INSERTANS:1X2X3}. How to find out the according ID? It's easy. Just
-navigate to the questions whose answer you would like to use and look
-at the adress-bar of your browser. If the URL is e.g. http://foobar.com/phpsurveyor/admin/admin.php?sid=1&gid=12&qid=8
-then you have to insert {INSERTANS:1X12X8}
-in the later question text.
-
-IMPORTANT:
-The capacity to use perviously provided answers in questions is
-currently only considered "proof of concept" and so should be used with
-caution as future releases of PHPSurveyor may involve significant
-changes in the way that it is used and/or works.
-
-
-Help:
-This is an optional field. It is useful if a question needs some
-explanation, or you want to explain how it should be answered. When you
-put text in this field, a "Question Mark" icon appears on the survey
-entry screens, and clicking on this allows the survey participant (or
-data entry person) to read the help.
-
-
-Question
-Type: This determines the type of response the
-survey allows. View the "Question
-Types" section for a description of the various options
-available.
-
-
-Validation:
-This feature is available on all free text type questions ("Short Free
-Text", "Long Free Text", "Date" or "Numerical"). You can use standard
-Perl Regex expressions in this field to validate the responses to the
-question, and if the responses don't validate against this expression,
-the user will be prompted to try again before they can progress.
-Perl Regex expressions must start and finish with a forward slash
-("/"). You can find a good library of regex expressions at http://www.regxlib.net/.
-These patterns will almost all work if surrounded with the forward
-slash.
-
Examples (note that these are all one line):
-
-- Email
-Validation:
-/(\w[-._\w]*\w@\w[-._\w]*\w\.\w{2,3})/
- -
-Australian Postcodes:
-/^[0-9]{4}/
- -
-US Phone Number:
-/^(?:\([2-9]\d{2}\)\
-?|[2-9]\d{2}(?:\-?|\ ?))[2-9]\d{2}[- ]?\d{4}$/
- -
-Australian Phone Number:
-/^(?:\([0]\d{1}\)\
-?|[0]\d{1}(?:\-?|\ ?))[8-9]\d{3}[- ]?\d{4}$/
- -
-US Postal Codes:
-/^[0-9]{5}([- /]?[0-9]{4})?$/
-
-
-
-Other?
-Depending upon your chosen 'question type' this option may appear. It
-allows you to specify that an "other" option be presented in some of
-the list question types.
-
-
-Mandatory?
-For all question types, except the text ones, this setting allows you
-to require users to answer the question, before they can move on to the
-next question.
-
-Question
-Attributes
This
-is a new feature as of PHPSurveyor release 0.99dev01.
-Question Attributes are an extensible way of adding extra controls to
-the presentation and/or workings of questions. Additional question
-attributes can be developed relatively easily by PHP programmers and
-added to the list of options for a question.
-Different question types have different possible question attributes.
-Each attribute can have a "value" attached to it. This value may
-indicate whether the attribute is applied or not (usually a "1" to
-apply), or it may indicate a value used by the attribute.
-
-
-display_columns:
-This attribute is available for radio button list and multiple choice
-type questions. It allows you to display the answers for the question
-in more than 1 column. Add this attribute, and a value indicating the
-number of columns you wish the question to use.
-
-
-hide_tip
-This attribute allows you to turn off the "tip" for certain question
-types. For example, List type questions will usually include a tip that
-says "Please choose one of the following". Adding the "hide_tip"
-attribute with any value will turn this tip off so that it will not
-display.
-
-
-random_order
-This attribute applies to any question type that has a list of possible
-answers. It causes PHPSurveyor to ignore the existing order of those
-answers, and instead it orders the answers randomly. It is important to
-note that this random order will be reordered each time the question is
-displayed, so if someone returns to a question, the order will probably
-be different from the first time they saw it. Having the answers
-display randomly is useful to remove the possibility of bias from
-answers to questions.
-
-
-code_filter
-Can be used to filter the answers displaying based on the answer to a
-previous question. The attribute was added for the purpose of being
-able to narrow down possible options.
-
-
-permission
-Currently unused attribute that will eventually be integrated with the
-public display of results, so you can indicate whether a questions
-results are public or not
-
-
-maximum_chars
-Available for text based questions. Allows you to set the maximum
-number of characters that can be entered for a text based question.
-Entering a value of, say, 20 will mean that the participant cannot
-enter any more than 20 characters as their answer.
-
-
-text_input_width
-Available for short text and numerical text type questions. Sets the
-width of the html text box, but does not limit the number of characters
-that can be entered.
-
-You can create as
-many questions as you like.
-
When you have created a question that uses pre-determined
-answers (ie: dropdown list) you can then add answers
-to that question.
-
-(D) Setting Conditions
-(Branching)
-
-A
-question can be set to display ONLY IF certain conditions are met. You
-can set these conditions by clicking on the 
-icon in
-the question button bar, when viewing a question.
-
-When you
-choose "Set Conditions" a new window will appear allowing you to delete
-or create conditions for the current question. An example is show below.
-
-
-
-|
-Condition
-Designer
- |
-
-
-
-
-
-
+
+
+ -
+
Creating
+ a NEW SURVEY
+ To create a new survey click on the
+ button
+ at the right hand side of the administration button bar.
+ The "Create New Survey" screen will
+ appear below. Following is a description of each field:
+
+ -
+
Title:
+ This is the brief descriptive name of the survey (ie: "Enterprise Bargaining
+ Survey 2003", or "Views on Ice Cream"). This title will be displayed
+ on every page of the public survey script.
+
+ -
+
Description:
+ This allows you to enter a description of the survey. (ie: "A survey
+ to collect your ideas on the next round of enterprise bargaining" or
+ "A survey to find out the popularity of chocolate ice cream"). You can
+ use html markup in this section.
+
+ -
+
Welcome:
+ This allows you to enter a message that will display when a participant
+ first logs into your public survey screen. (ie: "Thank you for taking
+ the time to participate in this survey..") You can use html markup in
+ this section.
+
+ -
+
Administrator:
+ This is the name of the contact person who administrates the survey.
+ It will be included in any emails sent out inviting participants to
+ respond.
+
+ -
+
Admin
+ Email: This is the email address of the administrator
+ (as above) and is used as the 'reply to:' address on any emails sent
+ out.
+
+ -
+
Fax
+ To: This field is used to give a fax number on the "printable
+ survey" - ie: when you want to send someone a hardcopy because they
+ cannot use the online survey.
+
+ -
+
Format:
+ Choose from "One at a time", "Group at a time" or "All in one".
+
+
+ -
+
One
+ at a time Public survey will display one question per page.
+
+
+ -
+
Group
+ at a time Public survey will display all questions in a
+ group per page.
+ Group at a time surveys still have a separate "welcome" page and
+ "submit" page, like "One at a time" surveys.
+
+ -
+
All
+ in one Public survey will display all questions in one
+ single page
+ All in one surveys do not have a "welcome" page or "submit" page
+ - the welcome message and submit button all appear on the same page.
+
+
+
+
+ -
+
Template:
+ Choose from the installed templates in your system. The default template
+ is rather dull, but functional. More information on creating your own
+ templates is available in the PHPSurveyor
+ Templates Guide
+
+ -
+
Use
+ Cookies?: If you choose "Use Cookies" and your survey does
+ not use a tokens table to control participant access, then a cookie
+ will be saved to the client computer of each survey participant once
+ they have submitted a survey. This cookie will stop the same computer
+ from accessing the survey more than once. There are inherent limitations
+ in the 'security' strenght of such a system, but on a general basis
+ it allows public surveys to retain some control over multiple entries.
+
+
+ -
+
Allow
+ Saves?: If you set this option to "Yes" then users can save
+ unsubmitted surveys and return to them later.
+
+ -
+
Show
+ [<< Prev] button: This option defaults to yes, however
+ if you set it to "No" then users will not have the option of moving
+ to a previous page while completing the survey.
+
+ -
+
Notification:
+ Options to allow the administrator to be emailed when each individual
+ survey response is saved. You can choose from:
+
+ -
+
No
+ email notification - self explanatory
+
+ -
+
Basic
+ email notification - an email is sent informing the administrator
+ that a survey response has been saved
+
+ -
+
Send
+ email notification with response codes - sends the full
+ answers to the survey after saving
+
+
+
+ -
+
Anonymous:
+ This allows you to determine whether responses to your survey are matched
+ up with information from your surveys tokens table, or kept 'anonymous'.
+ The default is yes. If you choose "No" for anonymous, you must also
+ have a tokens table for your survey when you activate it.
+
+
+ -
+
Invitation
+ Email Subject: The subject line for the invitation email that
+ gets sent out when tokens are used with your survey.
+
+ -
+
Invitation
+ Email: This is the text for the invitation email that gets
+ sent out when tokens are used with your survey. This is initially filled
+ by the default invitation message (from the language files) but you
+ can modify it to suit yourself. Of course if you don't plan to use tokens
+ on your survey, whatever is in this field is irrelevent.
+ You can use the following "form" fields to insert individualised information
+ in each email:
+
+ -
+
{FIRSTNAME}
+ - gets replaced with the token table's "firstname" value
+
+
+ -
+
{LASTNAME}
+ - gets replaced with the token table's "lastname" value
+
+
+ -
+
{SURVEYNAME}
+ - gets replaced with your surveys name
+
+ -
+
{SURVEYDESCRIPTION}
+ - gets replaced with your surveys description
+
+ -
+
{ATTRIBUTE_1}
+ - gets replaced with the token table's "attribute_1" value
+
+
+ -
+
{ATTRIBUTE_2}
+ - gets replaced with the token table's "attribute_2" value
+
+
+ -
+
{SURVEYURL} - gets replaced
+ with the fully qualified URL to this particular survey
+
+
+
+ Note
+ that these "form fields" apply to the following email fields.
+
+
+ -
+
Email
+ Reminder Subject: The subject line for the reminder email that
+ gets sent out from the tokens tool
+
+ -
+
Email
+ Reminder: This is the text for the reminder email that gets
+ sent out when tokens are used with your survey. See "invitation email"
+ for specific details on how this field is used.
+
+ -
+
Confirmation
+ Email Subject: When tokens are used, this is the subject line
+ of the email that gets automatically sent to participants after completion
+ of the survey
+
+ -
+
Confirmation
+ Email: This is the text of the email that gets sent to users
+ after completion of the survey.
+
+ -
+
Allow
+ Public Registration: If you use tokens to control access to
+ your survey, the only people who can use the survey are those who have
+ an entry and a unique token from the token table. If you would like
+ to use the tokens but allow public registration, use this field. Setting
+ "Yes" to this will allow a visitor to your Survey URL to register their
+ name and email address. The script will create a new entry in your tokens
+ table for this person, then send them an invitation email. The script
+ will ensure that only one person per email address can complete your
+ survey.
+
+ -
+
Public
+ Registration Email Subject: This is the subject line for the
+ invitation email sent to members of the public who register for a survey.
+
+
+ -
+
Public
+ Registration Email: This is the text for the invitation email
+ sent to members of the public who register for a survey. The same "form
+ fields" apply in this email as in the earlier ones.
+
+ -
+
Token
+ attribute names: The tokens table has two "spare" fields for
+ storing additional information about users. When using the public registration
+ system, you can use these two fields to give your attribute fields a
+ nice name for the public. So, if you are using "attribute_1" to store
+ the participants department name, you can label it appropriately.
+
+
+ -
+
Datestamp?:
+ This field allows you to determine whether the survey will datestamp
+ all responses. If you choose "Yes", then when a response is submitted,
+ a field will be included in that response indicating the time and date
+ that the response was made. (See configuration settings for $timeadjust
+ setting.)
+
+ -
+
Language:
+ A list of the possible language files will be shown next to this option.
+ Changing the language setting here will change the default language
+ used when participants use the public survey scripts (but will not change
+ the administration language).
+
+ -
+
Expires:
+ This is the last date on which the public survey script will let people
+ participate. (Read this twice... if you set it for the 31 of December,
+ then people will no longer be able to use the survey script on the 1st
+ of January).
+
+ -
+
End
+ URL: This URL will be presented as a link at the end of the
+ survey, and allows you to direct your participants back to your home
+ page (or, in fact, anywhere).
+
+ -
+
URL Descrip:
+ The description for the link using the End URL.
+
+ -
+
Automatically Load URL when
+ survey complete: If you choose "Yes" for this option, the script
+ will automatically load the URL as set in "End URL" after completion
+ of the survey, instead of displaying the usual "Completed" page. Do
+ not use this if you are using assessments.
+
+
+ Importing
+ a Survey
+ If you have previously exported a survey, you can import it from
+ the "New Survey" screen. Click on the browse button to choose the sql file,
+ and then click on the button. The import process
+ reads a 'sql' file created by PHPSurveyor and 'intelligently' (I use the
+ term advisedly) renumbers the survey, group, question, answer and condition
+ id's so that they all match each other. See section on Exporting
+ a Survey for more information.
+ (B)
+ Creating a NEW GROUP
+ Before you can add any questions
+ to your survey you must create a group. If you will only
+ have one group in your survey, then how you name this group is irrelevant
+ (except of course for show). If, however, you are going to have multiple
+ groups, you should note that the survey questions will be displayed by group,
+ and the groups will be displayed in alphabetical order.
+ So, if you really need the groups to be displayed in a particular order,
+ consider naming them with an alphabetic start such as "A) Questions about
+ you" and "B) Questions about health". Doing it this way will
+ ensure that your groups are displayed in order. If, for example, you entered
+ the group names as "Questions about you" and "Questions about
+ health", the "Questions about health" group will display first,
+ because alphabetically it comes first. PHPSurveyor is designed
+ to do this deliberately, because it allows you to add extra groups in later,
+ and arrange their positioning by adjusting the title. For example, you could
+ squeeze an extra group between the two by naming it "A1) Questions about
+ your history".
+
+ You can create as many groups as you like.
+ Groups can also include a "description".
+ This field allows you to publish an explanatory note for any set of questions.
+ If you add a description, then when the public are using the public survey
+ system, they will be presented with that explanation before commencing any
+ of the questions in that group. If you do not include any text here, then
+ public participants will simply move on to the first question in the group
+ with no stop.
+ Create a new group by clicking on
+ the
+ icon in the Survey Button Bar.
+ (C)
+ Adding a QUESTION
+ Once you have created your groups,
+ you can start adding questions within each group.
+ Create a new question by clicking on the add icon ()
+ on the right hand side of the "Group" menu bar.
+
+ When adding a question, you will be asked for a "Question Code", the "Question",
+ "Help" and a "Question Type". All new questions are assigned to the Group
+ you were viewing when you clicked "Add Question", however you can change
+ the group the question belongs too at a later point.
+
+
+ -
+
Question
+ Code: Your ID, or number or code for the question. This
+ field is important, because the entry in this will determine the positioning
+ of the question in your survey. Again, numbering this "Q1", and following
+ questions "Q2" and "Q3" will ensure that they appear in the correct
+ order. Using this system allows you to add in extra questions as an
+ afterthought by giving them a code such as "Q1a". Try to be consistent
+ with your coding in this field. Planning makes this process a lot easier.
+
+
+ -
+
Question:
+ This is the actual question being asked. There is no real limit to the
+ length of the question here, however if you want to explain the question,
+ leave that for the next field.
+ Fields
+ Within Questions
+ TOKEN INFORMATION
+ From PHPSurveyor release 0.98finalRC1 you can insert information/text
+ from the tokens table into your question so that it can show context
+ related information. For PHPSurveyor to do this, the survey needs to
+ be set as NOT Anonymous (ie: tracked), and it needs to have a tokens
+ table.
+
+ The fields available for this are:
+
+ -
+
{TOKEN:FIRSTNAME}
+ - inserts the value from the "firstname" field in the tokens table
+
+
+ -
+
{TOKEN:LASTNAME}
+ - inserts the value from the "lastname" field in the tokens table
+
+
+ -
+
{TOKEN:EMAIL}
+ - inserts the value from the "email" field in the tokens table
+
+
+ -
+
{TOKEN:ATTRIBUTE_1}
+ - inserts the value from the "attribute_1" field in the tokens table
+
+
+ -
+
{TOKEN:ATTRIBUTE_2} - inserts
+ the value from the "attribute_2" field in the tokens table
+
+
+
+ To
+ use this functionality you must type the field text into your question
+ exactly as listed above. For example:
+
+ Hello {TOKEN:FIRSTNAME}. We sent an email to you using this address
+ {TOKEN:EMAIL}. Is this correct?
+
+ If there are spaces or typing mistakes, the script will not replace
+ your field with the appropriate information.
+
+ PREVIOUS ANSWERS
+ There is currently also the capacity to insert the answer
+ of previous questions into the text of an answer with the following
+ provisos:
+
+ -
+
The
+ question must have been answered in a previously displayed PAGE
+ in the survey - answers to questions on the current page are not
+ available
+
+ -
+
You refer to the exact Survey
+ ID, Group ID and Question ID for the question to which the answer
+ was made - in the form: {INSERTANS:SIDXGIDXQID} - ie {INSERTANS:1X2X3}.
+ How to find out the according ID? It's easy. Just navigate to the
+ questions whose answer you would like to use and look at the adress-bar
+ of your browser. If the URL is e.g. http://foobar.com/phpsurveyor/admin/admin.php?sid=1&gid=12&qid=8
+ then you have to insert {INSERTANS:1X12X8}
+ in the later question text.
+
+
+
+ IMPORTANT:
+ The capacity to use perviously provided answers in questions is currently
+ only considered "proof of concept" and so should be used with caution
+ as future releases of PHPSurveyor may involve significant changes in
+ the way that it is used and/or works.
+
+
+ -
+
Help:
+ This is an optional field. It is useful if a question needs some explanation,
+ or you want to explain how it should be answered. When you put text
+ in this field, a "Question Mark" icon appears on the survey entry screens,
+ and clicking on this allows the survey participant (or data entry person)
+ to read the help.
+
+
+ -
+
Question
+ Type: This determines the type of response the survey allows.
+ View the "Question Types" section for
+ a description of the various options available.
+
+
+ -
+
Validation:
+ This feature is available on all free text type questions ("Short Free
+ Text", "Long Free Text", "Date" or "Numerical"). You can use standard
+ Perl Regex expressions in this field to validate the responses to the
+ question, and if the responses don't validate against this expression,
+ the user will be prompted to try again before they can progress.
+ Perl Regex expressions must start and finish with a forward slash ("/").
+ You can find a good library of regex expressions at http://www.regxlib.net/.
+ These patterns will almost all work if surrounded with the forward slash.
+
+ Examples (note that these are all one line):
+
+
+ - Email Validation:
+ /(\w[-._\w]*\w@\w[-._\w]*\w\.\w{2,3})/
+ - Australian Postcodes:
+ /^[0-9]{4}/
+ - US Phone Number:
+ /^(?:\([2-9]\d{2}\)\ ?|[2-9]\d{2}(?:\-?|\
+ ?))[2-9]\d{2}[- ]?\d{4}$/
+ - Australian Phone Number:
+ /^(?:\([0]\d{1}\)\ ?|[0]\d{1}(?:\-?|\
+ ?))[8-9]\d{3}[- ]?\d{4}$/
+ - US Postal Codes:
+ /^[0-9]{5}([- /]?[0-9]{4})?$/
+
+
+
+
+
+ -
+
Other?
+ Depending upon your chosen 'question type' this option may appear. It
+ allows you to specify that an "other" option be presented in some of
+ the list question types.
+
+
+ -
+
Mandatory? For
+ all question types, except the text ones, this setting allows you to
+ require users to answer the question, before they can move on to the
+ next question.
+
+
+ Question
+ Attributes
+ This is a new feature as of PHPSurveyor release 0.99dev01.
+ Question Attributes are an extensible way of adding extra controls
+ to the presentation and/or workings of questions. Additional question attributes
+ can be developed relatively easily by PHP programmers and added to the list
+ of options for a question.
+ Different question types have different possible question attributes. Each
+ attribute can have a "value" attached to it. This value may indicate whether
+ the attribute is applied or not (usually a "1" to apply), or it may indicate
+ a value used by the attribute.
+
+ -
+
display_columns:
+ This attribute is available for radio button list and multiple
+ choice type questions. It allows you to display the answers for the
+ question in more than 1 column. Add this attribute, and a value indicating
+ the number of columns you wish the question to use.
+
+
+ -
+
hide_tip
+ This attribute allows you to turn off the "tip" for certain
+ question types. For example, List type questions will usually include
+ a tip that says "Please choose one of the following". Adding the "hide_tip"
+ attribute with any value will turn this tip off so that it will not
+ display.
+
+
+ -
+
random_order
+ This attribute applies to any question type that has a list
+ of possible answers. It causes PHPSurveyor to ignore the existing order
+ of those answers, and instead it orders the answers randomly. It is
+ important to note that this random order will be reordered each time
+ the question is displayed, so if someone returns to a question, the
+ order will probably be different from the first time they saw it. Having
+ the answers display randomly is useful to remove the possibility of
+ bias from answers to questions.
+
+
+ -
+
code_filter
+ Can be used to filter the answers displaying based on the
+ answer to a previous question. The attribute was added for the purpose
+ of being able to narrow down possible options.
+
+
+ -
+
array_filter
+ Can be used to filter the answers of an array question which
+ are displaying based on the selection of answers on a multi option question.
+ The attribute was added for the purpose of being able to filter out
+ answers for ratings. Only availible on arrays, the value of this attribute
+ should be set to the question title of the multi option question.
+
+
+ -
+
permission
+ Currently unused attribute that will eventually be integrated
+ with the public display of results, so you can indicate whether a questions
+ results are public or not
+
+
+ -
+
maximum_chars
+ Available for text based questions. Allows you to set the
+ maximum number of characters that can be entered for a text based question.
+ Entering a value of, say, 20 will mean that the participant cannot enter
+ any more than 20 characters as their answer.
+
+
+ -
+
text_input_width
+ Available for short text and numerical text type questions.
+ Sets the width of the html text box, but does not limit the number of
+ characters that can be entered.
+
+
+ You can create as many questions as you
+ like.
+
+ When you have created a question that uses pre-determined answers (ie: dropdown
+ list) you can then add answers to that question.
+
+ (D)
+ Setting Conditions (Branching)
+ A question can be set to display
+ ONLY IF certain conditions are met. You can set these conditions by clicking
+ on the
+ icon in the question button bar,
+ when viewing a question.
+ When you choose "Set Conditions" a
+ new window will appear allowing you to delete or create conditions for the
+ current question. An example is show below.
+
+
+
+
+
+ | PHP
+ Surveyor |
+
+
+
+
+
+
+
+
+
+ | Condition
+ Designer |
+
+
+
+
+
+
+
+
+
+ 
+
+ 
+ Ver 0.99 |
+
+
+
+
+
+
+
+
Existing
Conditions
The top part of the window shows any conditions already set for this
@@ -1870,8 +1925,8 @@
Condition
|
-
-
+ |
+
|
Question
@@ -3311,8 +3366,8 @@
|
Y
|
-
-
+ |
+
|
Interpreter
@@ -3349,11 +3404,11 @@
|
USA
|
-
-
+ |
+
|
-
-
+ |
+
|
| |
|
IF
-