Talenttic_survey/CATI_Tool
2
0
Fork 0
mirror of https://github.com/ACSPRI/queXS synced 2024-04-02 12:12:16 +00:00
Code Issues Releases Activity

Import from DCARF SVN

Browse Source
This commit is contained in:
azammitdcarf
2008-10-15 22:36:05 +00:00
parent 4f0b4f0bbb
commit 1445da495b
2237 changed files with 714445 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

166
include/limesurvey/locale/en/help/admin.html Normal file
View File

@@ -0,0 +1,166 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title></title>
</head>
<body style="background-color: rgb(229, 229, 229);">
<p>
<font style="font-size: 8pt; font-weight: 700;" face="Verdana">ADMINISTRATION:<br>
You are currently viewing the <u>general administration</u> section of LimeSurvey. You have not selected any surveys to view/edit.</font>
</p>
<p>
<font style="font-size: 8pt;" face="Verdana">From this point you can control the general setup of LimeSurvey, as well as <a href="#Adding%20a%20New%20Survey">create new surveys</a>, choose to view or edit existing surveys and modify your security settings and check that your database has all the required fields.</font>
</p>
<table style="border-collapse: collapse;" id="AutoNumber1" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><img style="border: 0px solid ; width: 20px; height: 20px;" src="../../../images/home.png" alt="Home"></font>
</td>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><strong>Home</strong> Click on this icon to close the current survey and view just the administration bar</font>
</td>
</tr>
<tr>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><img style="border: 0px solid ; width: 20px; height: 20px;" alt="Security" src="../../../images/security.png"></font>
</td>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><strong>Security</strong>: Click on this icon to change your security logins and setup</font>
</td>
</tr>
<tr>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><img style="border: 0px solid ; width: 20px; height: 20px;" alt="Bad Security" src="../../../images/badsecurity.png"></font>
</td>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><strong>Bad Security</strong>: If your security settings need to be initialised, this icon will display</font>
</td>
</tr>
<tr>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><img style="border: 0px solid ; width: 20px; height: 20px;" alt="Check Settings" src="../../../images/summary.png"></font>
</td>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><strong>Check Settings:</strong> Show a summary of current settings for LimeSurvey. You can change the administration language from here.</font>
</td>
</tr>
<tr>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><img style="border: 0px solid ; width: 20px; height: 20px;"
alt="Check Database" src="../../../images/checkdb.png"></font>
</td>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><strong>Check Database</strong>: Click here to perform a check on your database to ensure all required fields and tables exist.</font>
</td>
</tr>
<tr>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><img style="border: 0px solid ; width: 20px; height: 20px;"
alt="List Surveys" src="../../../images/surveylist.png"></font>
</td>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><strong>List Surveys</strong>: Displays a list with the surveys
created allong with the publication date and the status </font>
</td>
</tr>
<tr>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><img style="border: 0px solid ; width: 20px; height: 20px;" alt="Backup Database" src="../../../images/export.png"></font>
</td>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><strong>Backup Database:</strong> Dumps entire LimeSurvey database into a SQL file</font>
</td>
</tr>
<tr>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><img style="border: 0px solid ; width: 20px; height: 20px;" alt="Edit/Add Labelsets" src="../../../images/labels.png"></font>
</td>
<td valign="top">
<strong><font style="font-size: 8pt;" face="Verdana">Edit/Add Labelsets</font></strong><font style="font-size: 8pt;" face="Verdana">: Click here to edit, create or delete label sets used in the 'flexible' labels questions.</font>
</td>
</tr>
<tr>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><img style="border: 0px solid ; width: 20px; height: 20px;" alt="Template Editor" src="../../../images/templates.png"></font>
</td>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><strong>Template Editor:</strong> Click here to edit the LimeSurvey templates</font>
</td>
</tr>
<tr>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><img style="border: 0px solid ; width: 20px; height: 20px;" alt="Add Survey" src="../../../images/add.png"></font>
</td>
<td valign="top">
<font style="font-size: 8pt;" face="Verdana"><strong>Add Survey</strong>: Click here to create a new survey or import a survey from a file</font>
</td>
</tr>
</tbody>
</table>
<p>
<font style="font-size: 8pt;" face="Verdana"><a href="survey.html">Survey</a><br>
<a href="group.html">Group</a><br>
<a href="question.html">Question</a><br>
<a href="answer.html">Answer</a><br>
<br>
<br>
<u><strong><a id="Adding_a_New_Survey" name="Adding_a_New_Survey">Adding a New Survey</a></strong></u><br>
Click on <img style="border: 0px solid ; width: 20px; height: 20px;" alt="Add Survey" src="../../../images/add.png"> to create or import a new survey.</font>
</p>
<p>
<font style="font-size: 8pt;" face="Verdana">The 'add new survey' screen allows you to complete the basic details of your survey, as well as choose a number of presentation options, and general options. From this screen you can also import a survey exported previously.</font>
</p>
<p>
<font style="font-size: 8pt;" face="Verdana">Survey details include a <strong>Short Title</strong>: which is the short name of your survey, a <strong>Description</strong>: which is a detailed description of your survey and can be as long as you like, a <strong>Welcome Message</strong>: which is presented at the very beginning of surveys, the self-explanatory <strong>Administrator Name</strong> and <strong>Admin Email</strong> fields which are used to direct participants to the appropriate person with questions about the survey and are also used as the reply-to address when sending email invitations to your survey, a <strong>Fax To</strong>: field, which allows you to enter a fax number which will appear on your 'printable' survey.</font>
</p>
<p>
<font style="font-size: 8pt;" face="Verdana">The presentation options are <strong>Format</strong>: which lets you choose whether your survey will be presented as all questions in a single page, questions displayed by group, or questions displayed one web page at a time and <strong>Template</strong>: which gives you a list of pre-defined templates that set the look and feel of your survey.</font>
</p>
<p>
<font style="font-size: 8pt;" face="Verdana">The option <strong>Use Cookies?</strong> allows you to set some basic access controls over your survey if you are not using tokens. Setting this to 'Y' means that when a participant successfully submits their survey responses, a cookie is saved to their computer indicating that they have done so. The next time they attempt to complete the survey using the same computer they will not be able to do so. It should be noted that this is fairly basic, and not particularly clever access control. If two different people want to complete the survey using the same computer, this method will preclude them from doing so - only the first will be able to. If one person tries to complete the survey twice, but on different computers, they <u>will</u> be able to do so. So you should be aware of these issues before applying this option. It is helpful to provide some impediments to multiple responses by the same person but certainly not a foolproof solution.</font>
</p>
<p>
<font style="font-size: 8pt;" face="Verdana">The <strong>Notification:</strong> option sets whether LimeSurvey sends the administrator an email whenever a survey is completed. If you choose to receive notification emails, you can choose basic notification, or to have the full responses included. By default your survey will be <strong>Anonymous</strong>, however you can choose to make a survey Not Anonymous, which means that the responses are linked to your tokens table, and you can trace individual answers to a particular respondent.</font>
</p>
<p>
<font style="font-size: 8pt;" face="Verdana">The <strong>Invitation Email, Email Reminder</strong> and <strong>Confirmation Email</strong> text boxes allow you to set your preferred email messages which will be used if you use tokens with your survey.</font>
</p>
<p>
<font style="font-size: 8pt;" face="Verdana">If you <strong>Allow Public Registration:</strong>, and you create a tokens table with your survey, then the general public will be able to register to access the survey. They will be sent an email invitation, which you write in the <strong>Public Registration Email:</strong> textbox. When you allow public registration, if you want the public to also provide you with the additional "free form" fields in the tokens table, attribute_1 and attribute_2, you can give them nicer names using <strong>Token attribute names:</strong>.</font>
</p>
<p>
<font style="font-size: 8pt;" face="Verdana"><strong>Date Stamp</strong>: lets you add a time/date entry to every response so you can keep a record with each participants response of when they completed the survey and <strong>Language</strong>: lets you choose from any pre-existing language files for built-in answers and messages such as "Yes/No", "Male/Female" and so on. The <strong>Expiry Date</strong>: is the date at which your survey will cease to be publicly available. If you leave this field blank, the survey will never expire.</font>
</p>
<p>
<font style="font-size: 8pt;" face="Verdana"><strong>Finally, you can enter a URL</strong>: which will be presented at the end of the survey so you can direct participants to a web site of your choice after completing the survey, and a <strong>URL Description</strong>: which is the text to which the URL is attached.</font>
</p>
<p>
<font style="font-size: 8pt;" face="Verdana"><strong>Importing a Survey</strong><br>
You can use the file menu at the bottom of the screen to import a survey. Click on browse, choose the LimeSurvey *.sql file containing your survey and then click on the Import button.</font>
</p>
<p>
&nbsp;
</p>
</body>
</html>

89
include/limesurvey/locale/en/help/answer.html Normal file
View File

@@ -0,0 +1,89 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title></title>
</head>
<body style="background-color: rgb(229, 229, 229); direction: ltr;">
<p>
<font style="font-size: 8pt;" face="Verdana"><a href="admin.html">Administration</a><br>
<a href="survey.html">Survey</a></font><br>
<font style="font-size: 8pt;" face="Verdana"><a href="group.html">Group</a><br>
<a href="question.html">Question</a></font>
</p>
<p>
<font style="font-size: 8pt; font-weight: 700;" face="Verdana">You are currently viewing the <u>answer administration</u> section of LimeSurvey.</font>
</p>
<p>
<font style="font-size: 8pt;" face="Verdana">From this point you can view, edit and change the order of answers to this particular question of your survey.</font>
</p>
<table style="border-collapse: collapse;" id="AutoNumber1" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td colspan="2" align="right" bgcolor="#555555" height="8" valign="top">
<p align="left">
<font style="font-size: 8pt; font-weight: 700;" color="#FFFFFF" face="Verdana">Button Options:</font>
</p>
</td>
</tr>
<tr>
<td align="right" valign="top">
<input value="Up" style="font-size: 9px; font-family: verdana;" type="submit">
</td>
<td valign="top" width="100%">
<strong><font style="font-size: 8pt;" face="Verdana">Move Answer UP</font></strong><font style="font-size: 8pt;" face="Verdana">: Click on this to move the display order of this answer up.</font>
</td>
</tr>
<tr>
<td align="right" valign="top">
<font style="font-size: 8pt;" face="Verdana"><input value="Dn" style="font-size: 9px; font-family: verdana;" type="submit"></font>
</td>
<td valign="top" width="100%">
<strong><font style="font-size: 8pt;" face="Verdana">Move Answer DOWN</font></strong><font style="font-size: 8pt;" face="Verdana">: Click on this to move the display order of this answer down.</font>
</td>
</tr>
<tr>
<td align="right" valign="top">
<font style="font-size: 8pt;" face="Verdana"><input value="Save" style="font-size: 9px; font-family: verdana;" type="submit"></font>
</td>
<td valign="top" width="100%">
<strong><font style="font-size: 8pt;" face="Verdana">Save Changes to Answer</font></strong><font style="font-size: 8pt;" face="Verdana">: Click on this to save any changes you've made to this answer.</font>
</td>
</tr>
<tr>
<td align="right" valign="top">
<font style="font-size: 8pt;" face="Verdana"><input value="Del" style="font-size: 9px; font-family: verdana;" type="submit"></font>
</td>
<td valign="top" width="100%">
<strong><font style="font-size: 8pt;" face="Verdana">Delete Answer</font></strong><font style="font-size: 8pt;" face="Verdana">: Click on this delete this answer.</font>
</td>
</tr>
<tr>
<td align="right" valign="top">
<font style="font-size: 8pt;" face="Verdana"><input value="Add" style="font-size: 9px; font-family: verdana;" type="submit"></font>
</td>
<td valign="top" width="100%">
<strong><font style="font-size: 8pt;" face="Verdana">Add Answer</font></strong><font style="font-size: 8pt;" face="Verdana">: Click on this to add a new answer.</font>
</td>
</tr>
<tr>
<td align="right" valign="top">
<font style="font-size: 8pt;" face="Verdana"><input value="Fix Sort" style="font-size: 9px; font-family: verdana;" type="submit"></font>
</td>
<td valign="top" width="100%">
<font style="font-size: 8pt;" face="Verdana"><strong>Fix Sort Order</strong>: Click on this to fix any problems you may be having with the sort order of the answers.</font>
</td>
</tr>
</tbody>
</table>
</body>
</html>

80
include/limesurvey/locale/en/help/group.html Normal file
View File

@@ -0,0 +1,80 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title></title>
</head>
<body bgcolor="#E5E5E5">
<p>
<font face="Verdana" style="font-size: 8pt"><a href="admin.html">Administration</a><br>
<a href="survey.html">Survey</a></font>
</p>
<p>
<font face="Verdana" style="font-size: 8pt; font-weight: 700">GROUP:<br>
You are currently viewing the <u>group administration</u> section of LimeSurvey.</font>
</p>
<p>
<font face="Verdana" style="font-size: 8pt">From this point you can view and control this particular group of your survey. You can also <a href="#Adding%20a%20New%20Question">add new question</a>s to your group or select an existing question from this group to view or edit.</font>
</p>
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
<tr>
<td align="right" valign="top" colspan="2" bgcolor="#555555" height="8">
<p align="left">
<font face="Verdana" style="font-size: 8pt; font-weight: 700" color="#FFFFFF">Button Options:</font>
</p>
</td>
</tr>
<tr>
<td align="right" valign="top">
<font face="Verdana" size="1"><img border="0" src="../../../images/edit.png" width="20" height="20"></font>
</td>
<td width="100%" valign="top">
<font face="Verdana" style="font-size: 8pt"><strong>Edit Group</strong>: Click on this to edit details of the current group.</font>
</td>
</tr>
<tr>
<td align="right" valign="top">
<font face="Verdana" size="1"><img border="0" src="../../../images/delete.png" width="20" height="20"></font>
</td>
<td width="100%" valign="top">
<font face="Verdana" style="font-size: 8pt"><strong>Delete Group</strong>: Click on this to delete
your group. This button will only display if there are no questions in this group.</font>
</td>
</tr>
<tr>
<td align="right" valign="top">
<font face="Verdana" size="1"><img border="0" src="../../../images/reorder.png" width="20" height="20"></font>
</td>
<td width="100%" valign="top">
<font face="Verdana" style="font-size: 8pt"><strong>Reorder Questions</strong>: Click on this to reorder the
display of the questions in that group.</font>
<tr>
<td align="right" valign="top">
<font face="Verdana" size="1"><img border="0" src="../../../images/add.png" width="20" height="20"></font>
</td>
<td width="100%" valign="top">
<font face="Verdana" style="font-size: 8pt"><strong>Add Question</strong>: Click on this to add a new question to this group. This button will not be available if the survey has been activated.</font>
</td>
</tr>
</table>
<p>
<font face="Verdana" style="font-size: 8pt"><a href="group.html">Group</a><br>
<a href="question.html">Question</a><br>
<a href="answer.html">Answer</a></font>
</p>
<p>
<font face="Verdana" style="font-size: 8pt"><u><strong><a name="Adding a New Question">Adding a New Question</a></strong></u><br>
Click on <img border="0" src="../../../images/add.png" width="20" height="20"> to add a new question to your survey.</font>
</p>
<p>
<font face="Verdana" style="font-size: 8pt">You can add as many questions as you like to each group in your survey. When you click on the "Add New Question" icon, you will be presented with a screen that allows you to enter a <strong>Question Code</strong>: which is a required field, and is used to determine the order in which questions within a group are displayed. The question code can be up to 5 characters long. Questions are ordered by this code alphabetically. The <strong>Question</strong>: field can be as long as you like and will contain the actual question that is presented to the survey participant. In the <strong>Help:</strong> field you can type a help message that will appear below the question and its associated answer options. The <strong>Question Type</strong>: field is a selectable list that contains the different types of pre-defined questions available. A detailed explanation of these questions is provided in the instruction manual. You can set a question to <strong>Mandatory</strong>: to ensure that a participant cannot move away from that question, or submit a response, without having answered that question. Certain question types will also allow you to put a "Y" or "N" in the <strong>Other</strong>: field. In these cases, the question will have an additional answer, of "Other".</font>
</p>
</body>
</html>

0
include/limesurvey/locale/en/help/index.html Normal file
View File

52
include/limesurvey/locale/en/help/labels.html Normal file
View File

@@ -0,0 +1,52 @@
<body bgcolor="#E5E5E5">
<p><span style="font-weight: 700"><font face="Verdana" style="font-size: 8pt">
Label Set Administration</font></span><font face="Verdana" style="font-size: 8pt; font-weight: 700">:<br>
You are currently viewing the <u>Labels</u> section of the Label Sets
Administration Screen. </font></p>
<p><font face="Verdana" style="font-size: 8pt">From this point you can (usually)
add, remove or edit the labels within a 'label set'. Labels consist of a 'code',
and a 'title'. The code will not be visible to survey participants but is used
to save the response. You can modify the order in which the label titles appear
using the &quot;Up&quot; and &quot;Dn&quot; buttons. The highest placed label will appear at the
left, and the lowest place at the right.</font></p>
<p><font face="Verdana" style="font-size: 8pt">If a label set is being used by
an existing survey, this screen will display a warning suggesting that adding or
deleting items may cause unintended consequences. Because Label Sets can be
shared by more than one survey or question, modifying a label set should be
approached with caution to ensure that you don't mess up another survey you are
using.</font></p>
<p><font face="Verdana" style="font-size: 8pt">If a label set is being used by
an existing survey that has been activated, you will not be able to add, delete
or change the code of any entries. You will, however be able to modify the
&quot;Title&quot; text or change the order in which the titles appear.</font></p>
<p><font face="Verdana" style="font-size: 8pt">The following options are
available in the Labels Toolbar:</font></p>
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/edit.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Edit Label
Set: </font></strong><font face="Verdana" style="font-size: 8pt">
Click on this icon to edit the name of the labelset you are currently
viewing</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/delete.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Delete
</font></strong><font face="Verdana" style="font-size: 8pt">
<strong>Label Set</strong>: Click here to delete the entire label set including all
labels. Note that you cannot delete a label set that is currently being used
by any survey, whether active or not.</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/export.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Export</font></strong><font face="Verdana" style="font-size: 8pt"><strong> Label Set</strong>:
Click here to export the label set to a file for later use or sharing with
other LimeSurvey users</font></td>
</tr>
</table>
<p>&nbsp;</p>
<p>&nbsp;</p>

91
include/limesurvey/locale/en/help/labelsets.html Normal file
View File

@@ -0,0 +1,91 @@
<body bgcolor="#E5E5E5">
<p><span style="font-weight: 700"><font face="Verdana" style="font-size: 8pt">
Label Set Administration</font></span><font face="Verdana" style="font-size: 8pt; font-weight: 700">:<br>
You are currently viewing the <u>Label Sets Administration</u> section of LimeSurvey. </font></p>
<p><font face="Verdana" style="font-size: 8pt">From this point you can create,
edit or delete Label Sets for use in the 'flexible labels' question type(s).
Label Sets allow you to pre-define a series of options against which various
answers can be checked. For example, in may surveys you may want to ask the
participant for a response to a particular statement or scenario and give them a
list of choices for each one. An example is show below:</font></p>
<div align="left">
<table border="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber2" bgcolor="#FFFFFF">
<tr>
<td colspan="6">
<font face="Verdana" style="font-size: 8pt; font-weight:700">Please indicate the extent to
which you agree with the following statements:</font></td>
</tr>
<tr>
<td>&nbsp;</td>
<td width="65" align="center" valign="bottom"><font face="Verdana" size="1">Agree Strongly</font></td>
<td width="65" align="center" valign="bottom"><font face="Verdana" size="1">Agree Somewhat</font></td>
<td width="65" align="center" valign="bottom"><font face="Verdana" size="1">Neither Agree Nor Disagree</font></td>
<td width="65" align="center" valign="bottom"><font face="Verdana" size="1">Disagree Somewhat</font></td>
<td width="65" align="center" valign="bottom"><font face="Verdana" size="1">Disagree Strongly</font></td>
</tr>
<tr>
<td><font face="Verdana" size="1">I am a very strange person</font></td>
<td align="center" width="65"><input type='radio'></td>
<td align="center" width="65"><input type='radio'></td>
<td align="center" width="65"><input type='radio'></td>
<td align="center" width="65"><input type='radio'></td>
<td align="center" width="65"><input type='radio'></td>
</tr>
<tr>
<td><font face="Verdana" size="1">I love ice cream</font></td>
<td align="center" width="65"><input type='radio'></td>
<td align="center" width="65"><input type='radio'></td>
<td align="center" width="65"><input type='radio'></td>
<td align="center" width="65"><input type='radio'></td>
<td align="center" width="65"><input type='radio'></td>
</tr>
<tr>
<td><font face="Verdana" size="1">Green is a lovely colour</font></td>
<td align="center" width="65"><input type='radio'></td>
<td align="center" width="65"><input type='radio'></td>
<td align="center" width="65"><input type='radio'></td>
<td align="center" width="65"><input type='radio'></td>
<td align="center" width="65"><input type='radio'></td>
</tr>
</table>
</div>
<p><font style="font-size: 8pt" face="Verdana">Using Label Sets you can create
your own column headings for these sorts of questions.</font></p>
<p><font face="Verdana" style="font-size: 8pt">The following options are
available in the Label Sets Administration Toolbar:</font></p>
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/home.png" width="20" height="20"></font></td>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Home</strong> Click on this icon to return to the main LimeSurvey
administration screen</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/add.png" width="20" height="20"></font></td>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Add Label Set</strong>: Click here to create a new label set or import a label
set from
a file</font></td>
</tr>
</table>
<p><font face="Verdana" style="font-size: 8pt">
<br>
<u><strong><a name="Adding a New Labelset">Adding a New Labelset</a></strong></u><br>
Click on
<img border="0" src="../../../images/add.png" width="20" height="20"> to create or
import a new label set.</font></p>
<p><font face="Verdana" style="font-size: 8pt">A labelset requires just a name.
Each label set is also automatically given a unique &quot;LID&quot; (or Labelset InDex)
number. You can create a labelset with the same name as another label set,
although generally this is not recommended (as it tends to confuse things). The
label set will be distinguishable from any with a different name by its LID
number.</font></p>
<p><font face="Verdana" style="font-size: 8pt"><strong>Importing a Label Set</strong><br>
You can use the Import Label Set option at the bottom of the screen to import a
label set. Click
on browse, choose the LimeSurvey *.sql file containing your label set and then
click on the Import button.</font></p>
<p>&nbsp;</p>

87
include/limesurvey/locale/en/help/question.html Normal file
View File

@@ -0,0 +1,87 @@
<body bgcolor="#E5E5E5">
<p><font face="Verdana" style="font-size: 8pt"><a href="admin.html">
Administration</a><br>
<a href="survey.html">Survey</a></font><br>
<font face="Verdana" style="font-size: 8pt">
<a href="group.html">Group</a></font></p>
<p><font face="Verdana" style="font-size: 8pt; font-weight: 700">You are currently viewing the
<u>question
administration</u> section of LimeSurvey.</font></p>
<p><font face="Verdana" style="font-size: 8pt">From this point you can view and
edit this particular question of your survey. If your question can have
individual <a href="#Answers">answers</a> added, you can also do that from this screen.
You can also set conditions on whether a question displays or not by choosing
the <a href="#Conditions">conditions</a> icon at this screen.</font></p>
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
<tr>
<td align="right" valign="top" colspan="2" bgcolor="#555555" height="8">
<p align="left">
<font face="Verdana" style="font-size: 8pt; font-weight: 700" color="#FFFFFF">
Button Options:</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/edit.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Edit Question</strong>: Click on this to edit details of the current question.</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/delete.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Delete Question</strong>: Click on this to delete this question. This button will
only display if there are no answers attached to this question.</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/export.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Export Question</strong>: Click on this to export your question, including all
answers, to a file.</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/copy.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Copy Question</strong>: Click on this to make a copy of your current question, including all
answers, within the current survey.</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/conditions.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><strong>
<font face="Verdana" style="font-size: 8pt">Set Conditions</font></strong><font face="Verdana" style="font-size: 8pt">: Click on this to
use the condition designer and set conditions for this question.</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/answers.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><strong>
<font face="Verdana" style="font-size: 8pt">Answers</font></strong><font face="Verdana" style="font-size: 8pt">: Click on this
to add/edit/delete and modify the order of defined answers for your
question.</font></td>
</tr>
</table>
<p><font face="Verdana" style="font-size: 8pt">
<a href="answer.html">Answer</a></font></p>
<p>
<font face="Verdana" style="font-size: 8pt; font-weight: 700; text-decoration: underline">
<a name="Answers">Answers</a><br>
</font><font face="Verdana" style="font-size: 8pt">Click on the
<img border="0" src="../../../images/answers.png" width="20" height="20"> icon to
add, edit, move and delete answers to your question.</font></p>
<p><font face="Verdana" style="font-size: 8pt">This icon will only be available
when your question type is a List, Multiple Options or Array type question.
These types of questions require a series of answers entered.</font></p>
<p><font face="Verdana" style="font-size: 8pt"><u><strong><a name="Conditions">
Conditions</a></strong></u><br>
Click on the
<img border="0" src="../../../images/conditions.png" width="20" height="20"> icon
to set, edit or remove conditions that apply to your question.</font></p>
<p><font face="Verdana" style="font-size: 8pt">This icon will display the
'Condition Designer' window, which lets you set conditions on whether your
question will display or not. Setting a condition on a question means that the
question WILL NOT DISPLAY UNLESS THAT CONDITION IS MET.</font></p>

139
include/limesurvey/locale/en/help/survey.html Normal file
View File

@@ -0,0 +1,139 @@
<body bgcolor="#E5E5E5">
<p><font face="Verdana" style="font-size: 8pt"><a href="admin.html">
Administration</a></font></p>
<p><strong><font face="Verdana" style="font-size: 8pt">SURVEY:<br>
You are currently viewing the <u>survey
administration</u> section of LimeSurvey.</font></strong></p>
<p><font face="Verdana" style="font-size: 8pt">From this point you can view and control the
general setup of your survey. You can also <a href="#Adding a New Group">add new groups</a> or select an existing
group to view or edit.</font></p>
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
<tr>
<td align="right" valign="top" colspan="2" bgcolor="#555555" height="8">
<p align="left">
<font face="Verdana" style="font-size: 8pt; font-weight: 700" color="#FFFFFF">
Button Options:</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/active.png" width="20" height="20" align="left"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Survey Active</strong>: This icon will be displayed if your survey has been
activated and is ready to save responses.</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/deactivate.png" width="10" height="15"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>De-Activate Survey</strong>: Click on this to de-activate an active survey</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/inactive.png" width="20" height="20" align="left"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Survey Inactive</strong>: This icon will display if your survey has not been
activated</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/activate.png" width="10" height="15"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Activate Survey</strong>: Click on this to activate an inactive survey</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/do.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Do/Test Survey</strong>: Click on this to do the survey (or test it if the
survey is currently inactive)</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/dataentry.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>DataEntry</strong>: Click on this for the dataentry screen. This is designed
for dataentry of hard-copy survey responses</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/print.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Printable Version</strong>: Click on this to see a 'printable' version of the
survey.</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/edit.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Edit Survey</strong>: Click on this to edit details of the current survey.</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/reorder.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Order Groups</strong>: Re-Order the groups in that survey</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/delete.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Delete Survey</strong>: Click on this to delete your survey. This button will
only display if there are no groups.</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/export.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Export Survey</strong>: Click on this to export your survey including all
groups, questions, answers and conditions to a file.</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/browse.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Browse Results</strong>: Click on this to browse the responses to your survey.
This is only available if the survey is active.</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/tokens.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Tokens</strong>: Click on this manage tokens for the current survey.</font></td>
</tr>
<tr>
<td align="right" valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/add.png" width="20" height="20"></font></td>
<td width="100%" valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Add Group</strong>: Click on this to add a new question group to your survey.</font></td>
</tr>
</table>
<p><font face="Verdana" style="font-size: 8pt">
<a href="group.html">Group</a><br>
<a href="question.html">Question</a><br>
<a href="answer.html">Answer</a></font></p>
<p>
<font face="Verdana" style="font-size: 8pt; font-weight: 700; text-decoration: underline">
<a name="Adding a New Group">Adding a New Group</a><br>
</font><font face="Verdana" style="font-size: 8pt">Click on
<img border="0" src="../../../images/add.png" width="20" height="20"> to add a new
group to your survey.</font></p>
<p><font face="Verdana" style="font-size: 8pt">All surveys must have at least
one group. Groups are used to 'group' questions together into logical groupings.
A group has a name and a description. When you choose &quot;Add Group&quot; you will be
presented with a blank screen containing two fields to complete. <strong>Group Name</strong>:
The title of your group. This field must be completed, and it also determines
the order in which your group is displayed when the survey is being completed.
The groups are ordered alphabetically be Group Name, and so you should consider
naming groups in alphabetical order. eg: &quot;Section 1:) About you.&quot; , &quot;Section 2:)
Your views.&quot;.&nbsp; Group Description: This field is optional, and can be used
to give a description of the group that will be displayed to survey participants
as they complete the survey. If no group description is given, participants
completing surveys presented in a &quot;One at a time&quot; format, will not be shown
separate pages showing the group name and description.</font></p>

754
include/limesurvey/locale/en/help/templates.html Normal file
View File

@@ -0,0 +1,754 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html style="direction: ltr;" lang="en"><head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta http-equiv="content-script-type" content="text/javascript"><title>LimeSurvey Templates &amp; Style Guide</title>
<meta content="Jason Cleeland" name="author"></head>
<body>
<table style="border-collapse: collapse; font-family: Helvetica,Arial,sans-serif;" id="AutoNumber1" border="1" bordercolor="#111111" cellpadding="2" cellspacing="0" width="100%">
<tbody style="width: 1221px;"><tr><td bgcolor="#000000" width="100%"><p align="center">
<font color="#ffffff" size="5"><strong><span lang="en-au">PHP</span>S</strong></font><span lang="en-au"><font color="#ffffff" size="5"><strong>urveyor</strong></font></span> <span lang="en-au"><strong><font color="#ffffff" size="5">&nbsp;Templates &amp; Style Guide</font></strong></span>
</p></td></tr><tr>
<td bgcolor="#000000" width="100%">
<p align="center">
<font color="#ffffff" size="5"><strong><span lang="en-au"><br></span></strong></font><span lang="en-au"><strong><font color="#ffffff" size="5"></font></strong></span>
</p>
</td>
</tr>
<tr>
<td bgcolor="#e5e5e5" width="100%">
<p align="center">
<font size="4"><strong>INDEX</strong></font>
</p>
<div align="center">
<center>
<table style="border-collapse: collapse; width: 274px; height: 163px;" id="AutoNumber5" border="0" bordercolor="#111111" cellpadding="0" cellspacing="0">
<tbody><tr>
<td width="100%">
<ul>
<li>
<font size="2"><strong><a href="#Introduction">Introduction</a></strong></font>
</li>
<li>
<span lang="en-au"><strong><font size="2"><a href="#Location%20of%20Template%20Files">Location of Template Files</a></font></strong></span>
</li>
<li>
<span lang="en-au"><strong><font size="2"><a href="#Template%20Files">Template Files</a></font></strong></span>
</li>
<li>
<span lang="en-au"><strong><font size="2"><a href="#KEYWORDS">Keywords</a></font></strong></span>
</li>
<li>
<strong><a href="#CSS"><font size="2">CSS</font></a></strong>
</li>
<li>
<strong><font size="2"><a href="#Other%20Template%20Files">Other Template Files</a></font></strong></li><li><font size="2"><a style="font-weight: bold;" href="#specialties">Specialties for Developers</a><br></font></li>
</ul>
</td>
</tr>
</tbody></table>
</center>
</div>
</td>
</tr>
<tr>
<td width="100%">
<strong><u><font size="4"><span lang="en-au"><a name="Introduction" id="Introduction">Introduction</a></span></font></u></strong>
<p>
<font size="2"><span lang="en-au">LimeSurvey uses a series of template
files to create its public survey screens. The templating system used
by LimeSurvey is relatively basic, but allows fairly comprehensive
control over the look and style of your surveys.</span></font>
</p>
<p>
<span lang="en-au"><font size="2">The templates consist of standard
HTML code, within which you can put keywords surrounded by
curly-brackets that will be replaced during a survey with relevant
text. The following gives an example of the method:</font></span>
</p>
<div align="center">
<center>
<table style="border-collapse: collapse;" id="AutoNumber6" border="1" bordercolor="#111111" cellpadding="5" cellspacing="0" width="85%">
<tbody><tr>
<td bgcolor="#000000" width="100%">
<p align="center">
<strong><font color="#ffffff" size="2"><span lang="en-au">Template File</span></font></strong>
</p>
</td>
</tr>
<tr style="font-family: monospace;">
<td width="100%">
<span lang="en-au">&lt;center&gt;&lt;font face='verdana' size='2'&gt;&lt;b&gt;{SURVEYNAME}&lt;/b&gt;&lt;/font&gt;&lt;br /&gt;<br>
&lt;font face='verdana' size='1'&gt;&lt;u&gt;&lt;i&gt;{SURVEYDESCRIPTION}&lt;/u&gt;&lt;/i&gt;&lt;/center&gt;</span>
</td>
</tr>
<tr>
<td bgcolor="#000000" width="100%">
<p align="center">
<strong><span lang="en-au"><font color="#ffffff" size="2">Looks Like This</font></span></strong>
</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center">
<span lang="en-au"><font size="2"><strong>My New Survey<br></strong></font> <font size="1"><u><i>This is a survey written by me to find out what sort of chocolate people like.</i></u></font></span>
</p>
</td>
</tr>
</tbody></table>
</center>
</div>
<p>
<span lang="en-au"><font size="2">LimeSurvey comes with two templates, and we plan to make other templates by other people available.</font></span>
</p>
<p>
<span lang="en-au"><font size="2">These instructions may make the
template files within LimeSurvey seem overly complex. You will
probably find it easiest to create new template files by copying an
existing template to a new directory, and then playing around with the
files. It should start to make sense fairly quickly after that.<br>
&nbsp;</font></span>
</p>
</td>
</tr>
<tr>
<td width="100%">
<u><strong><span lang="en-au"><a name="Location of Template Files">Location of Template Files</a></span></strong></u>
<p>
<span lang="en-au"><font size="2">LimeSurvey expects templates to
exist in their own distinct sub-directory within a templates directory
that is kept in the public directory with the other LimeSurvey public
files.</font></span>
</p>
<p>
<span lang="en-au"><font size="2">To create a new template, you should
create a new directory in the templates directory and give the
directory the name you want the template to be. So, for example, if the
directory is called "Silly", that template will be called "Silly", and
will be available in the admin scripts under that name.</font></span>
</p>
<p>
<span lang="en-au"><font size="2">There should ALWAYS be a "default"
directory in the templates directory. This template is used by default
and as a fall-back if a template folder doesn't exist, or can't be
found. The "default" directory comes with the package.</font></span>
</p>
</td>
</tr>
<tr>
<td width="100%">
<u><strong><span lang="en-au"><a name="Template Files">Template Files</a></span></strong></u>
<p>
<span lang="en-au"><font size="2">The following template files are used to produce your public survey and must exist in any new template folder you create:</font></span>
</p>
<ul>
<li>
<span lang="en-au"><font size="2"><strong>startpage.pstpl<br></strong>
Produces the start of each html page. It starts at the "&lt;head&gt;"
tag, and should not contain the "&lt;html&gt;" tag. This 'very
beginning' of a standard html page is written by the scripts. Please
ensure that your startpage.pstpl files contains a &lt;body&gt; tag,
even though many browsers do not require strict adherence to the W3
HTML stanards, the LimeSurvey script needs to find a &lt;body&gt; tag,
to run certain javascript elements. It is not expected that many
'keywords' will be used in the startpage.pstpl file, however you may
wish to put the {SURVEYNAME} into the title.<br>
The startpage.pstpl file can contain code that ends in the
corresponding endpage.pstpl file, so you can start a table in this file
and close the table in the endpage.pstpl file.<br>
The startpage.pstpl and endpage.pstpl files wrap around every possible page used by LimeSurvey.</font></span>
</li>
<li>
<span lang="en-au"><font size="2"><strong>survey.pstpl<br></strong>
This template is the second used on most pages, and provides a space to
put the survey name and description. This template does not have a
corresponding 'closing' template, and subsequently you should close all
tags opened in this template file (ie: don't leave a table open here
because there is nowhere else to close it)</font></span>
</li>
<li>
<span lang="en-au"><font size="2"><strong>welcome.pstpl<br></strong>
This template is only used in the welcome screen (which is also on the
main page for 'all in one' surveys). You can use this to print out the
welcome text, and other information that should be provided in the
introduction. Like the 'survey.pstpl' file, there is no corresponding
'closing' template, so all tags opened in this template file should be
closed as well.</font></span>
</li>
<li>
<span lang="en-au"><font size="2"><strong>startgroup.pstpl<br></strong>
This template can provide a 'summary' wrap around for questions within
a group. It has a matching 'endgroup.pstpl' template that can be used
to close any opened tags in this file, so you can open a table within
this.</font></span>
</li>
<li>
<span lang="en-au"><font size="2"><strong>groupdescription.pstpl<br></strong>
This template file is used to display a description of a group. It is
separate to the startgroup.pstpl file because in a "question by
question" survey it will be displayed on its own unique page in between
groups, whereas in a "group by group" or "all in one" survey it
provides a header to the subsequent questions. groupdescription.pstpl
does not have a corresponding 'closing' template file, so all tags
should be closed.</font></span>
</li>
<li>
<span lang="en-au"><font size="2"><strong>question.pstpl<br></strong>
This file contains the question, answer and help text sections of your
survey, and in the "group by group" and "all in one" surveys this
template is cycled repeatedly with each question. There is no
corresponding closing file for this and all tags should be closed.</font></span>
</li>
<li>
<span lang="en-au"><font size="2"><strong>submit.pstpl</strong> (and <strong>privacy.pstpl</strong>)<strong><br></strong>
This page is the penultimate page for all types of survey (except the
"all in one" type) where the participant is given an option to review
questions before submitting their responses. It provides privacy
information where a survey is anonymous, which it extracts from the
privacy.pstpl file.</font></span>
</li>
<li>
<span lang="en-au"><font size="2"><strong>completed.pstpl<br></strong>
This page is displayed as the final page when the survey responses have
been saved and the survey is over. It can be used to display a
"forwarding link" as set in the survey setup.</font></span>
</li>
<li>
<span lang="en-au"><font size="2"><strong>endgroup.pstpl<br></strong> This file closes the group, and can be used to close off any tags opened in the startgroup.pstpl file</font></span>
</li>
<li>
<span lang="en-au"><font size="2"><strong>navigator.pstpl<br></strong>
This file contains the buttons that navigate through the survey,
"next", "prev", "last", "submit", "save so far"&nbsp; and the "clear
all" link. It is used in all pages except the completed page.</font></span>
</li>
</ul>
<div align="center">
<center>
<table style="border-collapse: collapse;" id="AutoNumber7" border="1" bordercolor="#111111" cellpadding="0" cellspacing="0" width="85%">
<tbody><tr>
<td bgcolor="#000000" width="100%">
<p align="center">
<strong><span lang="en-au"><font color="#ffffff" size="2">Page Structure / Template Use</font></span></strong>
</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center">
<font size="2"><span lang="en-au">The Welcome Page:</span></font>
</p>
<div align="center">
<center>
<table style="border-collapse: collapse;" id="AutoNumber8" border="1" bordercolor="#111111" cellpadding="2" cellspacing="0">
<tbody><tr>
<td align="center" bgcolor="#e5e5e5" width="100%">
<font size="2"><span lang="en-au">startpage.pstpl</span></font>
</td>
</tr>
<tr>
<td align="center" width="100%">
<font size="2"><span lang="en-au">welcome.pstpl</span></font>
</td>
</tr>
<tr>
<td align="center" bgcolor="#ccffcc" width="100%">
<font size="2"><span lang="en-au">navigator.pstpl</span></font>
</td>
</tr>
<tr>
<td align="center" bgcolor="#e5e5e5" width="100%">
<font size="2"><span lang="en-au">endpage.pstpl</span></font>
</td>
</tr>
</tbody></table>
</center>
</div>
<p align="center">
<span lang="en-au"><font size="2"></font></span></p><p align="center"><span lang="en-au"><font size="2">The Questions Pages:</font></span>
</p>
<div align="center">
<center>
<table style="border-collapse: collapse;" id="AutoNumber8" border="1" bordercolor="#111111" cellpadding="2" cellspacing="0">
<tbody><tr>
<td align="center" bgcolor="#e5e5e5" width="100%">
<font size="2"><span lang="en-au">startpage.pstpl</span></font>
</td>
</tr>
<tr>
<td align="center" bgcolor="#ffccff" width="100%">
<font size="2"><span lang="en-au">survey.pstpl</span></font>
</td>
</tr>
<tr>
<td align="center" bgcolor="#ffffcc" width="100%">
<span lang="en-au"><font size="2">startgroup</font></span><font size="2"><span lang="en-au">.pstpl</span></font>
</td>
</tr>
<tr>
<td align="center" width="100%">
<span lang="en-au"><font size="2">groupdescription</font></span><font size="2"><span lang="en-au">.pstpl</span></font>
</td>
</tr>
<tr>
<td align="center" width="100%">
<span lang="en-au"><font size="2">question</font></span><font size="2"><span lang="en-au">.pstpl</span></font>
</td>
</tr>
<tr>
<td align="center" bgcolor="#ffffcc" width="100%">
<span lang="en-au"><font size="2">endgroup.pstpl</font></span>
</td>
</tr>
<tr>
<td align="center" bgcolor="#ccffcc" width="100%">
<font size="2">navigator.pstpl</font>
</td>
</tr>
<tr>
<td align="center" bgcolor="#e5e5e5" width="100%">
<span lang="en-au"><font size="2">endpage.pstpl</font></span>
</td>
</tr>
</tbody></table>
</center>
</div>
<p align="center">
<span lang="en-au"><font size="2"></font></span></p><p align="center"><span lang="en-au"><font size="2">The Submit Page:</font></span>&nbsp;
</p>
<div align="center">
<center>
<table style="border-collapse: collapse;" id="AutoNumber8" border="1" bordercolor="#111111" cellpadding="2" cellspacing="0">
<tbody><tr>
<td align="center" bgcolor="#e5e5e5" width="100%">
<font size="2"><span lang="en-au">startpage.pstpl</span></font>
</td>
</tr>
<tr>
<td align="center" bgcolor="#ffccff" width="100%">
<font size="2"><span lang="en-au">survey.pstpl</span></font>
</td>
</tr>
<tr>
<td align="center" width="100%">
<span lang="en-au"><font size="2">submit</font></span><span lang="en-au"><font size="2">.pstpl<br></font> <font size="1">(privacy.pstpl)</font></span>
</td>
</tr>
<tr>
<td align="center" bgcolor="#ccffcc" width="100%">
<font size="2">navigator.pstpl</font>
</td>
</tr>
<tr>
<td align="center" bgcolor="#e5e5e5" width="100%">
<span lang="en-au"><font size="2">endpage.pstpl</font></span>
</td>
</tr>
</tbody></table>
</center>
</div>
<p align="center">
<span lang="en-au"><font size="2"></font></span></p><p align="center"><span lang="en-au"><font size="2">The Final Page:</font></span>
</p>
<div align="center">
<center>
<table style="border-collapse: collapse;" id="AutoNumber8" border="1" bordercolor="#111111" cellpadding="2" cellspacing="0">
<tbody><tr>
<td align="center" bgcolor="#e5e5e5" width="100%">
<font size="2"><span lang="en-au">startpage.pstpl</span></font>
</td>
</tr>
<tr>
<td align="center" width="100%">
<span lang="en-au"><font size="2">completed.pstpl</font></span>
</td>
</tr>
<tr>
<td align="center" bgcolor="#e5e5e5" width="100%">
<span lang="en-au"><font size="2">endpage.pstpl</font></span>
</td>
</tr>
</tbody></table>
</center>
</div><br>
<br>
</td>
</tr>
</tbody></table>
</center>
</div>
<p>
&nbsp;
</p>
</td>
</tr>
<tr>
<td width="100%">
<strong><u><span lang="en-au"><a name="KEYWORDS" id="KEYWORDS">KEYWORDS</a></span></u></strong>
<p>
<span lang="en-au"><font size="2">Keywords are words within a template
file that get replaced by survey information during a survey. The are
all surrounded by curly brackets (like this: {SURVEYNAME}</font></span>
</p>
<p>
<span lang="en-au"><font size="2">Any keyword can be placed in any
template file, although if the script has not yet developed the
replacement text it will simply be removed and nothing will display in
the survey. This means, for example, that it would be pointless to put
the {QUESTION} keyword in the startpage.pstpl file, because the scripts
will not yet have the question to put there.</font></span>
</p>
<p>
<span lang="en-au"><font size="2">The following table lists the keywords you can use, and the template files where they will work properly.</font></span>
</p>
<div align="center">
<center>
<table style="border-collapse: collapse; width: 85%; text-align: left; margin-left: auto; margin-right: auto;" id="AutoNumber9" border="1" bordercolor="#111111" cellpadding="1" cellspacing="0">
<tbody><tr>
<td align="center" bgcolor="#000000">
<span lang="en-au"><strong><font color="#ffffff" size="2">KEYWORD</font></strong></span>
</td>
<td align="center" bgcolor="#000000">
<span lang="en-au"><strong><font color="#ffffff" size="2">TEMPLATE FILES</font></strong></span>
</td>
<td align="center" bgcolor="#000000">
<strong><font color="#ffffff" size="2"><span lang="en-au">DESCRIPTION</span></font></strong>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<span lang="en-au"><font size="2">{SURVEYNAME}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">All files</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">The survey title</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{SURVEYDESCRIPTION}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">All files</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">The survey description</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{PERCENTCOMPLETE}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">survey.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">A small graph showing the percentage of the survey completed</font></span>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<span lang="en-au"><font size="2">{WELCOME}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">All files (mainly for welcome.pstpl)</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">The survey 'welcome' text</font></span>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<span lang="en-au"><font size="2">{NUMBEROFQUESTIONS}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">welcome.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Displays the total number of questions in the survey (just the number)</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{THEREAREXQUESTIONS}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">welcome.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Displays the sentence "There are X
questions in this survey" - from the relevant language file. The X is
replaced with the number of questions. Note that this will also work
appropriately for singular or plural. If there is only 1 question, it
will print "There is 1 question in this survey".</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{GROUPNAME}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">startgroup.pstpl, groupdescription.pstpl, endgroup.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Displays the current group name</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{GROUPDESCRIPTION}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">startgroup.pstpl, groupdescription.pstpl, endgroup.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Displays the current group description</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{QUESTION}</font></span>
</td>
<td valign="top">
<font size="2"><span lang="en-au">question.pstpl</span></font>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Displays the current question text</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{QUESTION_CODE}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">question.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Displays the current question code</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{ANSWER}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">question.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Presents the answer form for the current question</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{QUESTIONHELP}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">question.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Displays help text for the current question</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{NAVIGATOR}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">navigator.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Displays navigation buttons (next, prev, last)</font></span>
</td>
</tr>
<tr>
<td valign="top">
<font size="2">{CLEARALL}</font>
</td>
<td valign="top">
<font size="2">All files (but intended for navigator.pstpl)</font>
</td>
<td valign="top">
<font size="2">Displays the "Exit and Clear Results" link</font>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{SUBMITBUTTON}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">submit.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Displays the final submit button</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{COMPLETED}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">completed.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Displays the 'completed' message</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{URL}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">completed.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Displays the survey 'url' and 'url text'</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{PRIVACY}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">submit.pstpl</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Displays privacy information when survey is anonymous</font></span>
</td>
</tr>
<tr>
<td valign="top">
<span lang="en-au"><font size="2">{TEMPLATEURL}</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">All files</font></span>
</td>
<td valign="top">
<span lang="en-au"><font size="2">Replaces with the http URL location
of your template files. Use this of insertion of graphics into your
template. ie: instead of:<br></font> <big><font style="font-family: monospace;" size="1"><big>&lt;img src='http://your.domain.com/surveyor/templates/mytemplate/me.jpg'&gt;</big></font><span style="font-family: monospace;"> </span></big><font size="2"><br>
you could put<br></font> <big><font style="font-family: monospace;" size="1"><big>&lt;img src='{TEMPLATEURL}me.jpg'&gt;</big></font></big><font size="2"><br>
Note that the replacement string includes the trailing slash.</font></span>
</td>
</tr><tr><td style="vertical-align: top;"><small>{SAVE}</small></td><td><font size="2">All files (but intended for navigator.pstpl)</font></td><td><small>Displays
the 'Save your responses so far' button to offer the user to save and
come back later to continue the survey. If the Save option is
deactivated in the survey properties the tag will not be shown and
ignored.</small></td></tr>
</tbody></table>&nbsp;
</center>
</div>
</td>
</tr>
<tr>
<td width="100%">
<u><strong><a name="CSS" id="CSS">CSS / Cascading Style Sheets</a></strong></u>
<p>
<font size="2">Each "input" type in a survey has been given its own
class name, so that you can add CSS to your "startpage.pstpl" file, and
have some control over the appearance of form buttons and inputs. These
class names are as follows:</font>
</p>
<ul>
<li>
<font size="2"><strong>submit</strong> (Submit Buttons)</font>
</li>
<li>
<font size="2"><strong>text</strong> (Text Inputs - for short free text, date and numerical type)</font>
</li>
<li>
<font size="2"><strong>radio</strong> (Radio Buttons)</font>
</li>
<li>
<font size="2"><strong>checkbox</strong> (Check Boxes)</font>
</li>
<li>
<font size="2"><strong>select</strong> (Select / List Boxes)</font>
</li>
<li>
<font size="2"><strong>textarea</strong> (Large text inputs - for long free text)</font>
</li>
<li>
<font size="2"><strong>clearall</strong> (The "Exit and Clear Survey" link)</font>
</li>
<li>
<span lang="en-au"><font size="2"><strong>rank</strong> (The rank style
question. Doesn't set the colour of the select box or the text boxes
(these are set by relevant section above) but does allow changing of
background colour, text colour and size etc for the rest of the ranking
question)</font></span>
</li>
<li>
<font size="2"><strong>graph</strong> (The "percentage completed" graph table)</font>
</li>
<li>
<span lang="en-au"><font size="2"><strong>innergraph</strong> (The table inside the graph table - this contains the 0% and 100% text. Use this for changing the size of this text</font></span>
</li>
<li>
<span lang="en-au"><font size="2"><strong>question</strong> (General
settings for any question that is displayed within a table. Generally
you should use this to make sure that their font size and colour is the
same as you have used elsewhere as a default)</font></span>
</li>
<li>
<span lang="en-au"><font size="2"><strong>array1</strong> and <strong>array2</strong>
(These two styles are cycled when presenting the range of answers for
an array type question. This allows you to set an alternating
background colour for these question types. Array 1 is also used for
the column headings in these question types.</font></span>
</li>
<li>
<span lang="en-au"><strong><font size="2">errormandatory</font></strong> <font size="2">sets the colour and style of the "This question is mandatory" error message.</font></span>
</li>
</ul>
<p>
<font size="2">An example of using these classes with style sheets can be found in the "bubblegum" template that comes with the package.</font>
</p>
<p>
<font size="2">Of course, because you can edit all the other HTML
aspects, there's no reason why you should surround various parts of
your template with a &lt;div class='scarey'&gt; and then set your own
css with that.</font>
</p>
</td>
</tr>
<tr>
<td width="100%">
<u><strong><a name="Other Template Files">Other Template Files</a></strong></u>
<p>
<font size="2">The <i><strong>chart.jpg</strong></i> file is a simple
1pixel image file which is used to create the progress bar image in the
'PERCENTCOMPLETE' table. If it does not exist, LimeSurvey will use the
default 'maroon' coloured image in the public directory, however if you
want to create one to match your own colour scheme (which would make
sense really), then you should save it here. Remember it should be a
jpeg file, and 1 pixel x 1 pixel, in whichever colour you want.</font>
</p>
<p>
<font size="2">The <span lang="en-au"><i><strong>privacy.pstpl, invitationemail.pstpl, reminderemail.pstpl</strong></i> and</span> <i><strong>confirmationemail.pstpl</strong></i> <span lang="en-au">are
no longer used by LimeSurvey and defaults are instead set in the
applicable language files. The email messages can now be edited on a
survey by survey basis.</span></font>
</p>
</td>
</tr><tr><td><span style="font-weight: bold;"><a name="specialties"></a><strong><span style="text-decoration: underline;">Specialties for Developers</span></strong></span><br><br><small>Starting with version 0.99 LimeSurvey has integrated some user-made patches, which will be described here.</small><br><small><br><big><span style="font-weight: bold;">Basic CMS Integration support</span></big></small><br><small>To be able to integrate LimeSurvey into another CMS use the following options in config.php:<br><br></small><small><big><span style="font-family: monospace;">// Set $embedded to true and specify the header and footer functions if the survey is to be displayed embedded in a CMS</span></big><br><br></small><div style="margin-left: 40px;"><span style="font-family: monospace;">$embedded = false;</span><br><span style="font-family: monospace;">$embedded_inc
= "";&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; // path to the header to include if any</span><br><span style="font-family: monospace;">$embedded_headerfunc = "";&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; // e.g. COM_siteHeader for geeklog</span><br><span style="font-family: monospace;">$embedded_footerfunc = "";&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; // e.g. COM_siteFooter for geeklog</span><big style="font-family: monospace;"><span style="font-weight: bold;"></span></big><br></div><big style="font-family: monospace;"><span style="font-weight: bold;"></span></big><br><small>Set $embedded to true to enable CMS-embedding. By using the $embedded_inc variable you can include own php files.<br>By
setting $embedded_headerfunc oder $embedded_footerfunc you can call
functions from your included files that output the according headers or
footers instead of LimeSurveys own ones.<br></small><br><br><span style="font-weight: bold;">Support for your own Javascript functions</span><br><small>Some users may need to run Javascript on the survey pages, but calling
checkconditions() in the BODY element made it&nbsp;impossible to tie in any
custom code.<br>This call was replaced with a small JS function in the HEAD that sniffs
for the existence of checkconditions() and template_onload() before
calling each. <br>This way a template author can create his/her own
template_onload() function in the HEAD. </small>
<span style="font-weight: bold;"></span></td></tr>
</tbody></table>
</body></html>

354
include/limesurvey/locale/en/help/tokens.html Normal file
View File

@@ -0,0 +1,354 @@
<body bgcolor="#E5E5E5">
<p><font face="Verdana" style="font-size: 8pt; font-weight: 700">You are currently viewing the
<u>Token Control</u> section of LimeSurvey.</font></p>
<p><font face="Verdana" style="font-size: 8pt">From this point you can view and
edit the tokens for your survey.</font></p>
<p><font style="font-size: 8pt" face="Verdana"><a href="#What are tokens">What
are tokens</a><br>
<a href="#Display Tokens">Display Tokens</a><br>
<a href="#Add new token entry">Add New Token Entry</a><br>
<a href="#Import/Upload CSV File">Import/Upload CSV File</a><br>
<a href="#Email Invitation">Email Invitation</a></font><br>
<font style="font-size: 8pt" face="Verdana"><a href="#Send Reminder">Send
Reminder</a><br>
<a href="#Generate Tokens">Generate Tokens</a></font></p>
<p><font style="font-size: 8pt" face="Verdana">The following options are
available from the tokens control main menu bar:</font></p>
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/home.png" width="20" height="20"></font></td>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Home</strong> Click here to close the token control window and view the
standard administration screen for your survey.</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/summary.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Summary</font></strong><font face="Verdana" style="font-size: 8pt">: Click
here to view a sumary of entries in your tokens table, and to access some
general database administration features, such as:</font></td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top">
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="100%" id="AutoNumber2">
<tr>
<td colspan="2"><font face="Verdana" style="font-size: 8pt"><strong>Set all
entries to 'N' invitation sent</strong>: </font></td>
</tr>
<tr>
<td>&nbsp;</td>
<td><font face="Verdana" style="font-size: 8pt">Deletes all records of
invitations sent out. Usually done if something goes wrong with your
email of invitations and you want to try it again.</font></td>
</tr>
<tr>
<td colspan="2"><font face="Verdana" style="font-size: 8pt"><strong>Delete
all unique token numbers</strong>: </font></td>
</tr>
<tr>
<td>&nbsp;</td>
<td><font face="Verdana" style="font-size: 8pt">Delete all generated
token numbers</font></td>
</tr>
<tr>
<td colspan="2"><font face="Verdana" style="font-size: 8pt"><strong>Delete
all token entries</strong>: </font></td>
</tr>
<tr>
<td>&nbsp;</td>
<td><font face="Verdana" style="font-size: 8pt">Clear the tokens table
completely</font></td>
</tr>
<tr>
<td colspan="2"><font face="Verdana" style="font-size: 8pt"><strong>Drop
tokens table</strong>: </font></td>
</tr>
<tr>
<td>&nbsp;</td>
<td><font face="Verdana" style="font-size: 8pt">Remove tokens from your
survey. The survey would then be accessible to all.</font></td>
</tr>
</table>
</td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/document.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Display
Tokens</font></strong><font face="Verdana" style="font-size: 8pt">: Click here to
display all token entries</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/add.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Add new
token entry</font></strong><font face="Verdana" style="font-size: 8pt">: Click
here to add a new participant to the tokens table.</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/importcsv.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Import
Tokens File</font></strong><font face="Verdana" style="font-size: 8pt">: Click
here to import a CSV file containing names and email addresses. The CSV file
must be a standard comma delimited file with no quotations. The first row is
interpreted as a header row. Order of data should be: Firstname, Lastname,
Email, [token]. The token field is optional.</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/importldap.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Import
Users from LDAP</font></strong><font face="Verdana" style="font-size: 8pt">: Click
here to import a users' names and email addresses from an LDAP directory.
This feature has to be enabled by the administrator in config.php to be available.
It is also up to the administrator to setup Ldap queries in config-ldap.php.
</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/invite.png" width="20" height="20"></font></td>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Send email invitation</strong>: Click here to send email invitations to the
participants listed in your tokens table.</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/remind.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Send email
reminder</font></strong><font face="Verdana" style="font-size: 8pt">: Click here
to send email reminders to the participants listed in your tokens table.
Reminders are only sent to participants who have already been sent an
invitation.</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/tokenify.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Generate
Tokens</font></strong><font face="Verdana" style="font-size: 8pt">: Click here to
generate unique random token numbers for your participants. Although you can
manually create token numbers, or import them from a CSV file, it is usually
recommended that you use this feature as it ensures that there are no
duplicate entries.</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/delete.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Drop Tokens
Table</font></strong><font face="Verdana" style="font-size: 8pt">: Click here to
drop the tokens table and remove tokens from your survey. The survey would
then be accessible to all.</font></td>
</tr>
</table>
<p><font style="font-size: 8pt" face="Verdana"><strong><a name="What are tokens">What are &quot;tokens&quot;</a></strong><br>
Tokens are a system you can use to have a controlled survey. A controlled survey
allows you to have a list of 'participants', or people who have been invited to
respond to the survey, and then control their access to the survey. Each
participant is issued with a unique token number. This token number gives the
participant access to the survey.</font></p>
<p><font face="Verdana" style="font-size: 8pt">When tokens are activated for
your survey, the only people who can access the public survey are those who have
a 'token' that matches an entry in this table. Using the tokens control section
of LimeSurvey you can add, remove and modify these token entries.</font></p>
<p><font face="Verdana" style="font-size: 8pt">The LimeSurvey tokens system
allows you to track who has access to your survey, send out invitations and
reminders to those participants, and see if they have responded. If you make
your survey non-anonymous (or tracked) you can also match responses to the token
entry.</font></p>
<p><font face="Verdana" style="font-size: 8pt"><u><strong><a name="Display Tokens">
Display Tokens</a></strong></u><br>
When displaying tokens, you can see all your entries (in lots of 50, or as
determined by you). The top section of the display is the <strong><i>Data View
Control</i></strong> menu bar. This menu bar gives you the following options:</font></p>
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/databegin.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Show start</font></strong><font face="Verdana" style="font-size: 8pt">:
Click here to view entries from the beginning of your list.</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/databack.png" width="20" height="20"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Show last</font></strong><font face="Verdana" style="font-size: 8pt">:
Click here to view the previous lot of entries.</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/dataforward.png" width="20" height="20"></font></td>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<strong>Show next</strong>: Click here to view the next lot of entries.</font></td>
</tr>
<tr>
<td valign="top"><font face="Verdana" style="font-size: 8pt">
<img border="0" src="../../../images/dataend.png" width="20" height="20"></font></td>
<td valign="top"><font style="font-size: 8pt" face="Verdana">Show last<font style="font-size: 8pt">:
Click here to view the very last entries in your list.</font></font></td>
</tr>
</table>
<p>
<font style="font-size: 8pt" face="Verdana">You are also able to set the number
of tokens displayed, and the starting point of your records using the &quot;Records
Displayed:&quot; and &quot;Starting From:&quot; fields, then clicking on &quot;Show&quot;.</font></p>
<p>
<font face="Verdana" style="font-size: 8pt"><strong>Sorting Display</strong><br>
At the top of each column when
displaying tokens, is the name of the field and the 'sort' icon (<img src="../../../images/downarrow.png" width="16" height="16">).
Clicking on the sort icon will re-order the display of tokens, sorted
alphabetically by that column.</font></p>
<p>
<font face="Verdana" style="font-size: 8pt"><strong>Actions<br>
</strong>A set of actions can be performed with each individual token entry. These
actions are listed below:</font></p>
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
<tr>
<td valign="top"><font face="verdana" size="2">
<input title="Edit Token Entry" style="FONT-SIZE: 8px; WIDTH: 16px; HEIGHT: 16px; font-face: verdana" type="submit" value="E"></font></td>
<td valign="top"><font face="Verdana" style="font-size: 8pt"><strong>Edit Entry</strong>:
Click here to edit this entry.</font></td>
</tr>
<tr>
<td valign="top"><font face="verdana" size="2">
<input title="Delete Token Entry" style="FONT-SIZE: 8px; WIDTH: 16px; HEIGHT: 16px; font-face: verdana" type="submit" value="D"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Delete Entry</font></strong><font face="Verdana" style="font-size: 8pt">:
Click here to delete this entry.</font></td>
</tr>
<tr>
<td valign="top"><font face="verdana" size="2">
<input title="Do Survey" style="FONT-SIZE: 8px; WIDTH: 16px; HEIGHT: 16px; font-face: verdana" type="submit" value="S"></font></td>
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Do Survey</font></strong><font face="Verdana" style="font-size: 8pt">:
Click here to do the survey using this token.</font></td>
</tr>
<tr>
<td valign="top"><font face="verdana" size="2">
<input title="Send reminder email to this entry" style="FONT-SIZE: 8px; WIDTH: 16px; HEIGHT: 16px; font-face: verdana" type="submit" value="V"></font></td>
<td valign="top"><font style="font-size: 8pt" face="Verdana"><strong>View
Response</strong>:
Click here to view the response made by this participant (only available
where applicable).</font></td>
</tr>
<tr>
<td valign="top"><font face="verdana" size="2">
<input title="Send reminder email to this entry" style="FONT-SIZE: 8px; WIDTH: 16px; HEIGHT: 16px; font-face: verdana" type="submit" value="I"></font></td>
<td valign="top"><font style="font-size: 8pt" face="Verdana"><strong>Invite</strong>:
Click here to send an invitation to this participant only.</font></td>
</tr>
<tr>
<td valign="top"><font face="verdana" size="2">
<input title="Send reminder email to this entry" style="FONT-SIZE: 8px; WIDTH: 16px; HEIGHT: 16px; font-face: verdana" type="submit" value="R"></font></td>
<td valign="top"><font face="Verdana" style="font-size: 8pt"><strong>Reminder</strong>:
Click here to send a reminder invitation to this participant only.</font></td>
</tr>
</table>
<p>
<span style="font-weight: 700; text-decoration: underline">
<font face="Verdana" style="font-size: 8pt"><a name="Add new token entry">Add
new token entry</a></font></span><font face="Verdana" style="font-size: 8pt; font-weight: 700; text-decoration: underline"><br>
</font>
<font face="Verdana" style="font-size: 8pt; ">
With this screen you can create a new token entry, adding an extra participant
to the list of people who can access the survey. The fields available are:<br>
<strong>Firstname</strong>: The participants first name<br>
<strong>Lastname</strong>: The participants last name<br>
<strong>Email</strong>: The participants email address<br>
<strong>Token</strong>: The participants unique token. While you can create your own at
this point, it is better to use the &quot;Generate tokens&quot; feature later, and leave
this blank.<br>
<strong>Invite Sent?</strong>: If a &quot;Y&quot; is in this field, the participant will not be sent
an invitation email when you choose &quot;Invite&quot;. If anything else is in here, the
invitation email will be sent.<br>
<strong>Completed?</strong>: If a &quot;Y&quot; is in this field, the participant will not be able
to use the token. When a participant completes the survey, this field is changed
to &quot;Y&quot;.</font></p>
<p>
<font face="Verdana" style="font-size: 8pt">There are no mandatory fields in the
'add new token' screen. You can include as much or as little information as you
want. There is no duplicate entry control either, so it is possible to have the
same name over and over again.</font></p>
<p><font face="Verdana" style="font-size: 8pt"><u><strong>
<a name="Import/Upload CSV File">Import/Upload CSV File</a></strong></u><br>
With this feature you can import a CSV file containing names and email addresses
for use in your LimeSurvey survey. The CSV file must be saved as a comma
delimited file, without quotation marks and the very first line is always
interpreted as a header row, so if your file doesn't have a header row, the
first row will be lost! Your file should look something like this:</font></p>
<div align="center">
<center>
<table border="0" cellpadding="3" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="300" id="AutoNumber3" bgcolor="#C0C0C0">
<tr>
<td width="100%">Firstname, Lastname, Email, Token<br>
Jason, Cleeland, jason@cleeland.org, <br>
Bob, Jones, bob@cleeland.org,</td>
</tr>
</table>
</center>
</div>
<p><font face="Verdana" style="font-size: 8pt">Note that the final column
(token) is optional. You can import your own token numbers - this may be useful
if you want to use another methodology for generating tokens. For example, if
you are a membership based organisation you could import your members membership
number as their token.</font></p>
<p><u><strong><font face="Verdana" style="font-size: 8pt"><a name="Email Invitation">
Email Invitation</a></font></strong></u><font face="Verdana" style="font-size: 8pt"><br>
Use this feature to send invitation emails to all participants in your tokens
table. Before sending an email, LimeSurvey checks each entry to ensure that the
following conditions are met:<br>
a) Email address exists<br>
b) Token has been generated<br>
c) An invitation has not already been sent<br>
d) Participant has not yet completed the survey</font></p>
<p><font style="font-size: 8pt" face="Verdana">Each invitation is personalised,
and is merged with information from the tokens table. You are given the option
of modifying the subject and text of your email before it is sent out. To use
information from the tokens table in the body of your email, use the following
'merge' codes:<br>
{FIRSTNAME}: First name<br>
{LASTNAME}: Last name<br>
{SURVEYNAME}: The name of your survey<br>
{ADMINNAME}: The name of the survey administrator<br>
{ADMINEMAIL}: The email address of the survey administrator</font></p>
<p><font face="Verdana" style="font-size: 8pt">For example, if your message
reads &quot;Dear {FIRSTNAME} {LASTNAME} here is a survey called {SURVEYNAME} for you
to try. Love {ADMINNAME}&quot; The recipient will receive an email that looks
something like this: &quot;Dear Saddam Hussein here is a survey called What I Did On
My Holidays for you to try. Love Jason Cleeland&quot;.</font></p>
<p><font face="Verdana" style="font-size: 8pt"><u><strong><a name="Send Reminder">
Send Reminder</a></strong></u><br>
Use this feature to send reminder emails to all participants in your tokens
table. Before sending an email, LimeSurvey checks to ensure that the following
conditions are met:<br>
a) Email address exists<br>
b) Token has been generated<br>
c) An invitation has already been sent out<br>
d) Participant has not yet completed the survey</font></p>
<p><u><a name="Generate Tokens"><strong><font face="Verdana" style="font-size: 8pt">
Generate Tokens</font></strong></a></u><u><strong><a name="Generate Tokens"><font face="Verdana" style="font-size: 8pt"> </font>
</a></strong></u><font face="Verdana" style="font-size: 8pt"><br>
Use this feature to generate unique random token numbers for each entry in the
tokens table that does not have a token.</font></p>

56
include/limesurvey/locale/en/help/users.html Normal file
View File

@@ -0,0 +1,56 @@
<body bgcolor="#E5E5E5">
<p><font face="Verdana" style="font-size: 8pt; font-weight: 700">You are currently viewing the
<u>User Control</u> section of LimeSurvey.</font></p>
<p><font face="Verdana" style="font-size: 8pt">From this point you can view and
edit the security settings and user access rights for your script.</font></p>
<p><font face="Verdana" style="font-size: 8pt">LimeSurvey security settings
rely on the Apache directory security system. If you are not using the Apache
web surver, you cannot use these security settings and you should initialise
directory security using your servers standard methods.</font></p>
<p><font face="Verdana"><font style="font-size: 8pt"><u><strong>Initialising Security<br>
</strong></u>The first time you run security from LimeSurvey, it will 'initialise'
the security settings. When it 'initialises', it creates a '.htaccess' file in
your admin directory that restricts access to the admin directory to only those
users in the '.htpasswd' file. The initial username and password are determined by
the 'default' settings in your config.php file. Once you have initialised
security succesfully, your browser will ask for this username and password
before allowing you to continue using the administration scripts of LimeSurvey.</font></font></p>
<p><font face="Verdana" style="font-size: 8pt"><u><strong>Adding Users</strong></u><br>
Once you have initialised security and 'logged in', you will be able to view the
existing users on your system, add new users, delete users or modify users. This
is fairly straight forward. In the list of users that displays, click on the
&quot;edit&quot; button to modify an entry, or the &quot;del&quot; button to delete it. If there is
only one entry in the user table you will not be able to delete that.</font></p>
<p>
<font face="Verdana" style="font-size: 8pt; font-weight: 700; text-decoration: underline">
Turning Off Security<br>
</font><font face="Verdana" style="font-size: 8pt">To turn off LimeSurveys
security settings, click on the &quot;Turn Off Security&quot; button. This will delete the
htpasswd, htaccess file and all user information from the directories.</font></p>
<p><font face="Verdana" style="font-size: 8pt"><u><strong>Limitations of LimeSurvey
Security</strong></u><br>
Until a more flexible security system is implemented, it should be remembered
that the LimeSurvey security settings are an 'all-or-nothing' affair. Users
either have access to ALL administration functions, or they have none.
Eventually a system is planned that allows you to set levels of access. Note
especially that the user security feature is accessible to all users, including
the PLAIN-TEXT PASSWORDS.</font></p>
<p><font face="Verdana" style="font-size: 8pt"><u><strong>Troubleshooting</strong></u><br>
If you are having trouble setting up security:</font></p>
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
<tr>
<td valign="top"><font style="font-size: 8pt" face="Verdana">1.</font></td>
<td><font face="Verdana" style="font-size: 8pt">Make sure you have
read/write permissions in the admin directory. LimeSurvey needs to be able
to create a .htpasswd and .htaccess file here.</font></td>
</tr>
</table>
&nbsp;<p>&nbsp;</p>