mirror of
https://github.com/ACSPRI/queXS
synced 2024-04-02 12:12:16 +00:00
754 lines
30 KiB
HTML
754 lines
30 KiB
HTML
<!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 & 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"> Templates & 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"><center><font face='verdana' size='2'><b>{SURVEYNAME}</b></font><br /><br>
|
|
<font face='verdana' size='1'><u><i>{SURVEYDESCRIPTION}</u></i></center></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>
|
|
</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 "<head>"
|
|
tag, and should not contain the "<html>" tag. This 'very
|
|
beginning' of a standard html page is written by the scripts. Please
|
|
ensure that your startpage.pstpl files contains a <body> tag,
|
|
even though many browsers do not require strict adherence to the W3
|
|
HTML stanards, the LimeSurvey script needs to find a <body> 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" 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>
|
|
</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>
|
|
|
|
</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><img src='http://your.domain.com/surveyor/templates/mytemplate/me.jpg'></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><img src='{TEMPLATEURL}me.jpg'></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>
|
|
</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 <div class='scarey'> 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
|
|
= "";
|
|
// path to the header to include if any</span><br><span style="font-family: monospace;">$embedded_headerfunc = ""; // e.g. COM_siteHeader for geeklog</span><br><span style="font-family: monospace;">$embedded_footerfunc = ""; // 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 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> |