https://www.limesurvey.org/api.php?action=feedcontributions&feedformat=atom&user=JcleelandLimeSurvey Manual - User contributions [en]2026-08-12T11:21:19ZUser contributionsMediaWiki 1.43.9https://www.limesurvey.org/manual/index.php?title=Workarounds:_Manipulating_a_survey_at_runtime_using_Javascript&diff=59826Workarounds: Manipulating a survey at runtime using Javascript2014-01-16T03:58:39Z<p>Jcleeland: /* Drag and Drop Ranking - Version 1.90 to 1.92 */</p>
<hr />
<div><br />
Often you want to manipulate certain elements of a survey at runtime. The only solution without touching the source code is to use JavaScript or jQuery which is shipped with LimeSurvey. Here are some examples to hide and style elements, validate user input or do calculations at runtime.<br />
<br />
Other workarounds can be found at<br />
* [[Workarounds: Survey behaviour]]<br />
* [[Workarounds: Question design, layout and templating]]<br />
<br />
<div class="simplebox"><center><br />'''Please keep in mind that these workarounds are not official LimeSurvey extensions - they are solutions that users have created for themselves.<br /><span style='color:#EE0000,#FFFFFF'>Therefore LimeSurvey can't offer guarantees or support for these solutions.</span><br />If you have questions, please contact the users that, thankfully, shared their solutions with the community.'''<br /><br /></center></div><br />
<br />
<div class="simplebox">Note: Version 1.92 implements many new features that make some existing workarounds obsolete. You can continue to use existing workarounds, but may want to consider switching over to using the new features (since those new features are officially supported, and the workarounds are not). Please review below for details of which are no longer needed.<br /><br /></div><br />
<br />
<div class="simplebox">Also Note: Version 1.92's Expression Manager (EM) may cause some of these work-arounds to fail. Any custom javascript included as a .js file will be fine. However, if you in-line your JavaScript code, you must make sure that you have a space after every opening (left) curly brace, and a space before every closing (right) curly brace. Otherwise, EM will think that the content between the curly braces is something it should parse and understand. I have fixed all of the work-arounds below that can be fixed (many did not follow those rules). However, some will continue to break. If a work-around contains a regular expression which contains curly braces (to indicate a range of repeats of a sub-expression), EM will try to process those curly braces, and thus break your regular expression. Strategies to continue to support that work-around functionality are discussed below.<br /><br /></div><br />
<br />
__TOC__<br />
<br />
=How to ''add'' a javascript workaround solution to this Wiki page?=<br />
<br />
Well, this is pretty easy. Click the edit icon and create your own headline within the javascript section starting with "'''!'''". Then add a short note about the version you have used when creating your workaround, you can copy/paste this code snippet <nowiki>''Tested with: (enter LimeSurvey version and maybe browser)''</nowiki>.<br />
<br />
Finally it's imported to mark all your code with code tags, other wise you might break this page.<br />
*Start tag: '''<nowiki><syntaxhighlight lang="php" enclose="div"></nowiki>'''<br />
*End tag: '''<nowiki></syntaxhighlight></nowiki>'''.<br />
<br />
=How to ''use'' Script (eg. JavaScript etc.) in LimeSurvey?=<br />
<br />
To use JavaScript within LimeSurvey, the XSS filter must be turned off and the code inserted in the source of a question or a group description.<br />
*Go to Global settings --> Security and set "Filter HTML for XSS" to "Off".<br />
* [http://docs.limesurvey.org/tiki-index.php?page=Adding+A+Question Add a new question]<br />
* Edit the question and click the "Source" button in the editor toolbar:<br />
<br />
[[File:editor_1.gif]]<br />
* Enter your script after the question text:<br />
<br />
[[File:editor_2.gif]]<br />
* Save the question<br />
<br />
A simple test to see if JavaScript is enabled is to echo an alert. Use this code:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
alert("Test!");<br />
<br />
</script></syntaxhighlight><br />
<br />
It is a good practice to use the jQuery $(document).ready function to prevent the code from executing until the page is fully loaded:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
alert("Test!");<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
It is also good practice to use jslint.com to get a good layout and design (e.q. no cluttering of name space)<br />
<br />
=Sum up input values using Javascript=<br />
<br />
''Tested with: ''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the sum() function in [[Expression Manager|Expression Manager]]. See this [[Expression Manager HowTos#Calculate assessment values at runtime and store the results in the survey data|HowTo example]].</div><br />
<br />
<div class="simplebox">Starting in Version 1.92, you also do no longer need to use SGQA (e.g. 45251X1X5) identifiers. Instead the code <code>{SGQ}</code> will automatically replaced by the current questions SGQA-codes.</div><br />
<br />
This is from a survey that is a invitation to a longer party, when the user clicks to the next page, the calculated results will be shown.<br />
<br />
If you wonder what the {INSERTANS:1X6X12} stuff is, look at [http://docs.limesurvey.org/tiki-index.php?page=SGQA+Identifier SGQA identifier] and [[Adding a question#Information from previous answers|Using information from previous answers]].<br />
<br />
<syntaxhighlight lang="html4strict" enclose="div"><br />
<br />
<div style="text-align: left">These are your answers:<br /><br />
<br />
<u></u><u></u><u></u><u></u><u>=<br />
<br />
<p><script LANGUAGE="JavaScript"><br />
<br />
partyprice = 3;<br />
<br />
beadclothprice = 3;<br />
<br />
breakfastprice = 7;<br />
<br />
lunchprice = 8;<br />
<br />
dinnerprice = 10;<br />
<br />
foodtotal = 0;<br />
<br />
var isreallytrue = "Yes";<br />
<br />
var noanswer = "No answer";<br />
<br />
document.write( "Can you come? = {INSERTANS:45251X1X1}<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X1}" == isreallytrue )<br />
<br />
{<br />
<br />
if ("{INSERTANS:45251X1X3}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X3}"; }<br />
<br />
partypeople = parseInt(answer);<br />
<br />
partytotal = partyprice * partypeople;<br />
<br />
document.write( "It's {INSERTANS:45251X1X3} persons who will come = " + partytotal + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X4}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X4}";}<br />
<br />
beadcloths = parseInt(answer);<br />
<br />
beadclothtotal = beadclothprice * beadcloths;<br />
<br />
document.write( "You want to borrow {INSERTANS:45251X1X4} beadcloths = " + beadclothtotal + "&euro;<BR>" );<br />
<br />
document.write( "Will you be there thursday? = {INSERTANS:45251X1X5}<BR>" );<br />
<br />
document.write( "On friday you will have these meals: <BR>" );<br />
<br />
if ("{INSERTANS:45251X1X71}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X71}";}<br />
<br />
breakfastfriday = parseInt(answer) * breakfastprice;<br />
<br />
document.write( "'''_ " + answer + " breakfeasts = " + breakfastfriday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X72}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X72}";}<br />
<br />
lunchfriday = parseInt(answer) * lunchprice ;<br />
<br />
document.write( "'''_ " + answer + " lunches = " + lunchfriday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X73}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X73}";}<br />
<br />
dinnerfriday = parseInt(answer)* dinnerprice ;<br />
<br />
document.write( "'''_ " + answer + " dinners = " + dinnerfriday + "&euro;<BR>" );<br />
<br />
foodtotal = breakfastfriday + lunchfriday + dinnerfriday;<br />
<br />
document.write( "Will you be there saturday? = {INSERTANS:45251X1X8}<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X8}" == isreallytrue )<br />
<br />
{<br />
<br />
document.write( "On saturday you will have these meals: <BR>" );<br />
<br />
if ("{INSERTANS:45251X1X91}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X91}"; }<br />
<br />
breakfastsaturday = parseInt(answer) * breakfastprice ;<br />
<br />
document.write("'''_ " + answer + " breakfeasts = " + breakfastsaturday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X92}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X92}"; }<br />
<br />
lunchsaturday = parseInt(answer) * lunchprice ;<br />
<br />
document.write( "'''_ " + answer + " lunches = " + lunchsaturday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X93}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X93}"; }<br />
<br />
dinnersaturday = parseInt(answer) * dinnerprice ;<br />
<br />
document.write( "'''_ " + answer + " dinners = " + dinnersaturday + "&euro;<BR>" );<br />
<br />
foodtotal = foodtotal + breakfastsaturday + lunchsaturday + dinnersaturday;<br />
<br />
}<br />
<br />
document.write( "Will you be there sunday? = {INSERTANS:45251X1X10}<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X10}" == isreallytrue )<br />
<br />
{<br />
<br />
document.write( "On sunday you will have these meals: <br>" );<br />
<br />
if ("{INSERTANS:45251X1X111}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X111}"; }<br />
<br />
breakfastsunday = parseInt(answer) * breakfastprice ;<br />
<br />
document.write( "'''_ " + answer + " breakfeasts = " + breakfastsunday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X112}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X112}"; }<br />
<br />
lunchsunday = parseInt(answer) * lunchprice ;<br />
<br />
document.write( "'''_ " + answer + " lunches = " + lunchsunday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X113}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X113}"; }<br />
<br />
dinnersunday = parseInt(answer) * dinnerprice ;<br />
<br />
document.write( "'''_ " + answer + " dinners = " + dinnersunday + "&euro;<p>" );<br />
<br />
foodtotal = foodtotal + breakfastsunday + lunchsunday + dinnersunday;<br />
<br />
}<br />
<br />
total = partytotal + beadclothtotal + foodtotal;<br />
<br />
document.write( "<h3>In total it will cost you " + total + "&euro;</h3><BR><br />
<br />
Put that sum in this bank account 1234 5678 9012" );<br />
<br />
}<br />
<br />
</SCRIPT></p><br />
<br />
</div></syntaxhighlight><br />
<br />
=Multiple Question Validation=<br />
<br />
''Tested with: ''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the min/max/equals_num_value attributes (to validate sums), or the em_validation_q function, which lets you refer to other variables when you validate the current question [[Expression Manager|Expression Manager]]. Such validations also work on the current page, and properly handle array_filter and cascading relevance.</div><br />
<br />
This workaround is in case you need to do some validation involving more than one question, it implies a very little JavaScript programming and the use of SGQA Identifiers; this should work on almost any version of LimeSurvey.<br />
<br />
Is easy to explain with an example, we need to do a survey of the percentage of males and females and we want to be sure that the sum is 100, to do this follow this steps (the necessary data that is not indicated in these instructions are not important i.e. question codes, etc.):<br />
#Create a new survey of type "group by group", set the "Show |<< Prev| button" to yes and note the SID.<br />
#Add a new group called "Group 1" and note the GID.<br />
#Add a new question "Percent of males" of type "numeric", make it mandatory and note the QID (we will refer to this as QID1).<br />
#Add a new question "Percent of females" of type "numeric", make it mandatory and note the QID (we will refer to this as QID2).<br />
#Add a new group called "Group 2"<br />
#Add a new non mandatory question, here is the trick the question text has to be (be sure to replace the SID, GID, QID1 and QID2<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script><br />
<br />
function validation()<br />
<br />
{<br />
<br />
if [[{INSERTANS:SIDXGIDXQID1}+{INSERTANS:SIDXGIDXQID2}) != 100)<br />
<br />
{<br />
<br />
alert("Your responses don't sum 100! Check them");<br />
<br />
document.limesurvey.move.value = 'moveprev';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
else<br />
<br />
{<br />
<br />
document.limesurvey.move.value = 'movelast';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
}<br />
<br />
setTimeout("validation()",250);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
But this will show shortly the question and will jump to the end page, a little weird for the survey taker but works.<br />
<br />
This is a proof of concept, and may have some problems, please if you notice something or improve it send me an e-mail to leochaton-limesurvey at yahoo dot com.<br />
<br />
This will work for 2 questions that you want to be the same. Works well for email and confirm email questions<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
function validation() {<br />
<br />
if ("{INSERTANS:SIDXGIDXQID}" != "{INSERTANS:SIDXGIDXQID}") {<br />
<br />
alert("Your responses don't match Check them"); document.limesurvey.move.value = 'moveprev';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
}<br />
<br />
setTimeout("validation()",250);<br />
<br />
</syntaxhighlight><br />
<br />
=Alternate exit=<br />
<br />
''Tested with: ''<br />
<br />
Using the same idea of the previous post, you can implement an alternate exit of your survey.<br />
<br />
This script should be in the first question to be displayed in a next page after the question that should trigger the alternate exit. In this example the question that trigger the alternate exit is a Yes/No question, if the user chooses no, he is redirected to another page.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
if ("{INSERTANS:SIDXGIDXQID}" == "No")<br />
<br />
{<br />
<br />
window.location="http://www.limesurvey.org";<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Custom onload function=<br />
<br />
''Tested with: 'All browsers', LimeSurvey 1.70 and up<br />
<br />
==General==<br />
<br />
This simple workaround describes how to '''add a custom Javascript code''' that is triggered right after the page is loaded. It may have numerous applications, especially when you deal with a custom JS/HTML code. It may be used to hide form elements (<input> tags), make them read-only, display alert messages, etc.<br />
<br />
To run any Javascript code right after page load use the Query ready() function. It will be executed when the page is being loaded. For example when you add the following code to one of your question definitions...:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
jQuery(document).ready(<br />
<br />
function(){<br />
<br />
alert('onload alert!');<br />
<br />
}<br />
<br />
);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
...it will display a pop-up message immediately after the page has been loaded.<br />
<br />
Some of the applications of this trick I've explored are:<br />
<br />
a) Hiding the form elements by calling in your Custom_On_Load:<br />
<br />
<syntaxhighlight lang="php" enclose="div">document.getElementById("answer73166X16X54").style.display='none';</syntaxhighlight><br />
<br />
Note: As of svn build 9755, you can now dynamically reference the questions input fields by using the {SGQ} keyword. You can rewrite the previous example like this:<br />
<br />
<syntaxhighlight lang="php" enclose="div">document.getElementById("answer{SGQ}").style.display='none';</syntaxhighlight><br />
<br />
this makes it a little easier when exporting surveys, so you don't have to worry about manually entering each questions SurveyGroupQuestion ID.<br />
<br />
b) Making the elements read only:<br />
<br />
<syntaxhighlight lang="php" enclose="div">document.getElementById("answer73166X16X54").readOnly=true;</syntaxhighlight> where the "answer73166X16X54" structure has been described in one of other workarounds above.<br />
<br />
c) For Hiding by a lot of elements by calling in your Customer_On_Load<br />
<br />
jQuery searchs in html document for input-fields with radio type, if his answer text empty then do the display css set to none.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
jQuery(document).ready(<br />
<br />
function() {<br />
<br />
jQuery('input:radio').each(<br />
<br />
function() {<br />
<br />
var s = jQuery(this);<br />
<br />
var c = s.parent().children('.answertext');<br />
<br />
for(var i=0; i < c.length; i++) {<br />
<br />
var a = jQuery(c[i]]);<br />
<br />
if(this.id </u> a.attr('for') && a.text() == '') {<br />
<br />
s.css({ 'display' : 'none' });<br />
<br />
a.css({ 'display' : 'none' });<br />
<br />
break;<br />
<br />
}<br />
<br />
}<br />
<br />
}<br />
<br />
)<br />
<br />
}<br />
<br />
);<br />
<br />
</syntaxhighlight><br />
<br />
==Advanced usage==<br />
<br />
If you want to place global Javascript code using the above jQuery(document).ready function then the best place to do this is the template javascript file template.js. You can edit this file using the template editor. Please be aware that placing it in the template javascript file will make the function available to all surveys using that template. If needed just create a new template copy for your survey.<br />
<br />
Alternatively you can place the jQuery(document).ready function in the group description to make a Javascript function only available to a certain question group.<br />
<br />
==Language-specific Javascript code==<br />
<br />
There is an easy way to find out the current language and execute according Javascript using jQuery: The <html> tag of any survey pages contains an 'lang' attribute which holds the current language code. You can read that language code by using the followin code<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
jQuery(document).ready(<br />
<br />
function(){<br />
<br />
languagecode=$('html').attr('lang');<br />
<br />
alert('This is the current language code: '+languagecode);<br />
<br />
}<br />
<br />
);<br />
<br />
</syntaxhighlight><br />
<br />
For an English survey the above code would show a messagebox with "This is the current language code: en"<br />
<br />
=Custom onload function in multi-language survey=<br />
<br />
''Tested with: 1.85+ (7253), IE 6/7, FireFox 3.0, Safari 3.2,''<br />
<br />
To use custom onload functions, as above, in multi-language surveys you must define the functions in the question source for '''all''' languages.<br />
<br />
While this initially seems to be a bit tedious, it actually can be useful - you can alter your onload functions depending on the language in use. For example, you can dynamically display alerts or element contents in the current language.<br />
<br />
=Skipping the welcome page=<br />
<br />
''Tested with: 1.85 (second code snippet)''<br />
<br />
<div class="simplebox">Note: As of version 1.91, there is a survey option letting you skip the welcome page, so this workaround is not needed.</div><br />
<br />
'''Solution 1:''' Include this Javascript in your welcome template, in the file welcome.pstpl for all welcome page, or in the source of the welcome text for one survey:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
jQuery(document).ready(function($) {<br />
<br />
document.limesurvey.move.value = 'movenext';<br />
<br />
document.limesurvey.submit(); });<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
It will reproduce the onclick event of the submit button and submit the form.<br />
<br />
Drawback of course is that users will see the page flashing up.<br />
<br />
Therefore, you may want to announce "... loading survey ..." as a description of your welcome page (in the admin interface when creating the survey), to pretend loading something big.<br />
<br />
'''Solution 2:'''<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
function custom_on_load(){<br />
<br />
document.limesurvey.move.value = 'movenext';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
window.setTimeout( 'custom_on_load()',1);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Filter answers of a question with the answer of another=<br />
<br />
===Method 1===<br />
<br />
''Tested with: 1.70 - 1.72''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the the array_filter attribute, or relevance equations in general.</div><br />
<br />
If you want to filter the answer of a question with another answer, you can use this workaround.<br />
<br />
First, use answer code like that: XX for the first question, and XXYYY for the second one.<br />
<br />
Answer of the second question filter if the 2 first letters are the answer of the first question.<br />
<br />
We use 1000X1X1 and 1000X1X2 for the example, question had to be on separate page (question by question for example).The second question had to be a dropdown list (we can do similar workaround, but droplis is the best). You can do this using JQuery. It leaves the answer in the select box, but disables it. You could also replace "disable" with "remove" to get rid of it altogether.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
var previousQuestionAnswer = "{INSERTANS:1000X1X1}";<br />
<br />
var currentQuestionID = "#answer1000X1X1"<br />
<br />
$(document).ready(function() {<br />
<br />
// See if the answer for the previous question matches an answer in the current question<br />
<br />
// (other than 'No Answer')<br />
<br />
// If so, disable it.<br />
<br />
if (previousQuestionAnswer!='No Answer') {<br />
<br />
$(currentQuestionID).children().each(function(index, Element)<br />
<br />
{<br />
<br />
if ($(this).attr('text') == previousQuestionAnswer)<br />
<br />
{ $(this).attr('disabled', true); }<br />
<br />
}<br />
<br />
);}<br />
<br />
}); // End of JQuery ready function<br />
<br />
</syntaxhighlight><br />
<br />
===Method 2===<br />
<br />
''Tested with 1.92 + Firefox 9.0''<br />
<br />
If you have a country, state, and city set of questions (or similar), you could code answer options as:<br />
<br />
'''Q1 Country''' ''Single choice list (ratio, dropdown)''<br />
<br />
X country#<br />
<br />
'''Q2 State''' ''Single choice list (dropdown)''<br />
<br />
XY state#<br />
<br />
'''Q3 City''' ''Single choice list (dropdown)''<br />
<br />
XYZZ city#<br />
<br />
Now you must put the following Javascript code in the source of question 2 (State):<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Get the countryCode (first character of the country)<br />
<br />
var countryCode = '{INSERTANS:1000X1X1}'.substr(0, 1).toUpperCase();<br />
<br />
// Loop through all dropdown options and remove those with codes not starting with the countryCode<br />
<br />
$('select[id<div class="simplebox">="answer"] option').each(function(i){<br />
<br />
if($(this).attr('value') && $(this).attr('value').substr(0, 1).toUpperCase() != countryCode) {<br />
<br />
$(this).remove();<br />
<br />
}<br />
<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
And the following code in the source of question 3 (City):<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Get the stateCode (two first characters of the state)<br />
<br />
var stateCode = '{INSERTANS:1000X1X2}'.substr(0, 2).toUpperCase();<br />
<br />
// Loop through all dropdown options and remove those with codes not starting with the stateCode<br />
<br />
$('select[id</div>="answer"] option').each(function(i){<br />
<br />
if($(this).attr('value') && $(this).attr('value').substr(0, 2).toUpperCase() != stateCode) {<br />
<br />
$(this).remove();<br />
<br />
}<br />
<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
Each question must be in different pages of survey to work, i.e. in a question by question survey, or in diferent groups in a group by group survey.<br />
<br />
Note that if you choose a two characters answer option code in the State question, i.e. a XYY answer option code, you must change the ''substr(0, 2)'' part of code in question 3 to ''substr(0, 3)''.<br />
<br />
=Filter answers of a multiple numeric type question=<br />
<br />
''Tested with: 1.90+''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the the array_filter attribute, or relevance equations in general. In 1.92, array_filter works with all questions that have sub-questions (e.g. also works for multiple numeric and multiple short text).</div><br />
<br />
If you want to filter a question of type "multiple numeric", you have to modify the workaround.<br />
<br />
Note that this workaround assumes that the code for each of the subquestions are a numeric sequence 1,2,3...<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function(){<br />
<br />
// Match elements with labels using htmlFor and a loop<br />
<br />
var labels = document.getElementsByTagName('LABEL');<br />
<br />
for (var i = 0; i < labels.length; i++) {<br />
<br />
if (labels[i].htmlFor != '') {<br />
<br />
var elem = document.getElementById(labels[i].htmlFor);<br />
<br />
if (elem)<br />
<br />
elem.label = labels[i];<br />
<br />
}<br />
<br />
}<br />
<br />
var answerFilter="{INSERTANS:96553X63X759}";<br />
<br />
for (i=0; i<30; i++){<br />
<br />
var iLabel = document.getElementById('answer96553X63X760'+(i+1]].label.innerHTML;<br />
<br />
if (answerFilter.search(iLabel) == -1){<br />
<br />
// Hide element<br />
<br />
$('#question760').find('li').eq(i).hide();<br />
<br />
// Set value of hidden elements to zero<br />
<br />
document.getElementById('answer96553X63X760'+(i+1)).value = 0;<br />
<br />
}<br />
<br />
}<br />
<br />
});</script><br />
<br />
</syntaxhighlight><br />
<br />
=Use an answer to prefill another question (default value)=<br />
<br />
''Tested with: 1.72''<br />
<br />
''And tested with: 1.91+''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the enhanced defaults feature, which lets you pre-fill most question types with default values. In 1.91, you could set defaults for list and multiple choice questions. In 1.92, you can set defaults for any text-entry question too. Moreover, the defaults can be [[Expression Manager|Expression Manager]] compatible equations or tailored text. Finally, with 1.92, defaults are properly managed even when set on the same page.</div><br />
<br />
This workaround gives you the ablility to use an answer to fill the default value for another question. It's explained for free text question type but can be adapted for another question type.<br />
<br />
We use SGQA identifier. For example, we use SGQA 1000X10X20 and 1000X10X21 to prefill 1000X11X30 and 1000X11X31. For the script to work, the question has to be on a different page.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answer1000X11X30').val('{INSERTANS:1000X10X20}');<br />
<br />
$('#answer1000X11X31').val('{INSERTANS:1000X10X21}');<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
If you want use two times the value of an integer input, you can also use this to prefill a question that you hide via CSS.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answer1000X2X2').val(parseInt('{INSERTANS:1000X1X1}')*2);<br />
<br />
$("#question2").hide();<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
Now you can use {INSERTANS:1000X2X2} for giving you twice the value of the user input from question 1.<br />
<br />
=Dynamic Sum=<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do with [[Expression Manager|Expression Manager]] using the sum() function. Not only will sums be dynamic, but they wille exclude irrelevant values, so you can array_filter a multiple numeric question and get the sum of just the answers that are visible. This [[Expression Manager HowTos#Calculate assessment values at runtime and store the results in the survey data|HowTo example]] demonstrates the dynamic sum feature.</div><br />
<br />
<div class="simplebox">Also note, as of version 1.92, the following workaround will fail, since it includes a a regular expression containing curly braces.</div><br />
<br />
This script is used with a "Multiple Options" type question calculate a total price based on how which checkboxes are selected. The prices are listed as part of the answer. The answers are set up like this: "USB Mouse ($20)". The script uses the number between the "($" and the ")" as the price for that item. You can adapt the script to if you need to change the currency or need to sum something other than money.<br />
<br />
This script works when used in a question-by-question format. It does not work when there are more than one question on a page. I think it can be adapted to work, but I haven't done the coding yet.<br />
<br />
Put the following code into body of your question:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script language=Javascript><br />
<br />
// General definitions<br />
<br />
// Define a regular expression to match the labels containing information about an answer<br />
<br />
// In LimeSurvey, these labels start with "answer..."<br />
<br />
var answerRegex = /^answer/;<br />
<br />
// Find all answer checkboxes in the document and set their<br />
<br />
// onchange events to updatePrice<br />
<br />
function Custom_On_Load()<br />
<br />
{<br />
<br />
// Find all input elements<br />
<br />
var inputList=document.getElementsByTagName("input");<br />
<br />
// Loop through each, looking for checkboxes<br />
<br />
var i;<br />
<br />
for( i=0; i< inputList.length;i++ )<br />
<br />
{<br />
<br />
// If input item does not have an ID, skip<br />
<br />
if (! (inputList[i].id)) { continue; }<br />
<br />
// Skip to next if ID doesn't start with "answer"<br />
<br />
if (!answerRegex.test(inputList[i].id)) { continue; }<br />
<br />
// Skip to next if not a checkbox<br />
<br />
if (inputList[i].type.toUpperCase()!='CHECKBOX') { continue; }<br />
<br />
// This is an answer checkbox!<br />
<br />
// Setup onchange event<br />
<br />
inputList[i].onclick = updatePrice;<br />
<br />
}<br />
<br />
// Load initial sum<br />
<br />
updatePrice();<br />
<br />
}<br />
<br />
function updatePrice()<br />
<br />
{<br />
<br />
var labels=document.getElementsByTagName("LABEL");<br />
<br />
// Define a regular expression to match a price inside parenthesis<br />
<br />
// For example: ($29) or ($29.54).<br />
<br />
// Set up<br />
<br />
priceRegex = /\(\$(\d*\.{0,1}\d+)\)/;<br />
<br />
// Loop through all the labels, looking for labels corresponding to<br />
<br />
// answers that have a price in them.<br />
<br />
var i;<br />
<br />
var total = 0;<br />
<br />
for( i=0; i<labels.length;i++ )<br />
<br />
{<br />
<br />
var myArray; // Define array used for regex matching<br />
<br />
var inputID; // Define field element<br />
<br />
// Get the ID of the field corresponding to the label using the<br />
<br />
// "htmlFor" attribute<br />
<br />
// (FYI, there are some labels that will have to be screened out<br />
<br />
// because they don't correspond to an answer)<br />
<br />
// Does the label start with "answer"?<br />
<br />
// If not: exit.<br />
<br />
if (!answerRegex.test(labels[i].htmlFor)) { continue; }<br />
<br />
// First make sure this element exists<br />
<br />
// If it doesn't, go to the next element<br />
<br />
// If it does, it will be defined in inputID<br />
<br />
if (! (inputID = document.getElementById(labels[i].htmlFor)) ) { continue; }<br />
<br />
// See if the corresponding answer is a checkbox that is checked.<br />
<br />
// If not, go to next label<br />
<br />
if (inputID.type.toUpperCase()!='CHECKBOX') { continue; }<br />
<br />
if (!inputID.checked) { continue; }<br />
<br />
// This is label for an answer.<br />
<br />
// The innerHTML will give us the text of the label<br />
<br />
// The price information will be in the form ($XX.XX)<br />
<br />
// which in contained in the label text.<br />
<br />
// Find a match for a decimal number inside the pattern "($" and ")"<br />
<br />
if [[myArray = priceRegex.exec(labels[i].innerHTML]] != null)<br />
<br />
{<br />
<br />
// Keep a running tally<br />
<br />
total += parseFloat(myArray[1]);<br />
<br />
}<br />
<br />
}<br />
<br />
// Update total price on form<br />
<br />
document.getElementById("totalPrice").value = "$" + formatCurrency(total);<br />
<br />
}<br />
<br />
function formatCurrency(num) {<br />
<br />
num = isNaN(num) || num <u> '' || num </u> null ? 0.00 : num;<br />
<br />
return parseFloat(num).toFixed(2);<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
Put the following code in the help section (or wherever you want the sum to appear):<br />
<br />
<syntaxhighlight lang="php" enclose="div">Total Cost for selected accessories: <input type="readonly" value="" id="totalPrice" /></syntaxhighlight><br />
<br />
=Focus on the first Input field=<br />
<br />
(''Tested with: LimeSurvey 1.80 / IE6/7, Firefox 3, Safari, Opera, chrome'')<br />
<br />
<div class="simplebox">As of version 1.91, there is a built-in JavaScript function called focusFirst() to focus on the first visible element. It uses jQuery, so is more robust than this example.</div><br />
<br />
Again an onload Function is needed for this tasks. I have done it the DOM way with compatibility to IE6/7.<br />
<br />
Put the following code into the startpage.pstpl of your template, right before the </head> closing tag:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
function focusFirst(Event)<br />
<br />
{<br />
<br />
var i=0;<br />
<br />
while(document.forms[0].elements[i].type == "hidden")<br />
<br />
{<br />
<br />
i++;<br />
<br />
}<br />
<br />
document.forms[0].elements[i].focus();<br />
<br />
return;<br />
<br />
}<br />
<br />
if(ie)<br />
<br />
{ window.attachEvent("onload", focusFirst); }<br />
<br />
else<br />
<br />
{ document.addEventListener("load", focusFirst, true); }<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
'''Note:''' I am using this with version 1.80. As changes happened to the templates in the last release, you might need to add the following before the code, if your template is older than 1.80 stable and does not include this:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
var ie = false;<br />
<br />
</script><br />
<br />
<br />
<br />
</syntaxhighlight><br />
<br />
You will need this for the var ie to be set. Without this var, the function will not work with ie.<br />
<br />
=Answer questions by keypress=<br />
<br />
(''Tested with: IE7, Firefox 3'')<br />
<br />
This workaround allow to answer the question on key 0-9 (0 is for the 10 answer).<br />
<br />
Follow issues are supported at the moment:<br />
*Yes-No Questions<br />
*List Questions (radio)<br />
*other radio questions<br />
<br />
In lists the answer limit is ten.<br />
<br />
You supply the template "endpage" of your template with the following script.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
jQuery(document).ready(function() {<br />
<br />
jQuery(document).bind('keypress', function(e){<br />
<br />
if (48 <= e.which && e.which <= 57) {<br />
<br />
jQuery('input:radio').each(function() {<br />
<br />
var v = jQuery(this).val();<br />
<br />
var c = (e.which <u> 48) ? 10 : e.which - 48;<br />
<br />
if(v </u> 'Y' || v <u> 'N') {<br />
<br />
v = (v </u> 'Y') ? 1 : 2;<br />
<br />
}<br />
<br />
if(v == c) {<br />
<br />
jQuery(this).click();<br />
<br />
jQuery('#limesurvey input:submit').click();<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
})<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Math notation in LimeSurvey=<br />
#download the js file from [http://mathcs.chapman.edu/~jipsen/mathml/asciimathdownload.html AsciiMath script]<br />
#copy it in the /scripts/ folder in your installation<br />
#modify the startpage.psptl of the template you want to use adding the reference to the script (if you use an older version make sure that you copy the template folder first!) for example:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" src="ASCIIMathML.js"><br />
<br />
</syntaxhighlight><br />
<br />
Use the notation where you need it!<br />
<br />
'''Note:''' If you use internet explorer or safari you will need to download the plugin as well, but firefox does the lot for you.<br />
<br />
Finally, if you are confident with the limesurvey structure you could add the editor which support math notation and change the reference to the editor you want to use in the configuration file. here is the [http://www.imathas.com/editordemo/demo.html link for a TinyMCE with math support].<br />
<br />
=Reverse array_filter (for pre-1.90)=<br />
<br />
''Tested with: 1.85+ (7253), IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
<div class="simplebox">Note: Version 1.91 natively supports this functionality via the array_filter_exclude advanced quation option.</div><br />
<br />
This can be used to filter the answers of an array question to be displayed based on the answers of a multi option question that were '''NOT''' selected. A possible application would be to have a multi-option question asking which products were purchased, followed by 2 array questions - one asking to rate the purchased products and another asking why the remaining products were not purchased. Another would be to ask about sessions attended at a conference as in [http://www.limesurvey.org/en/forum/5-can-i-do-this-with-limesurvey/27970-reverse-of-arrayfilter.html this forum thread] and pictured below. There is a live [http://www.partnersinc.biz/surveys//index.php?sid=43358&newtest=Y&lang=en demo here]<br />
<br />
[[File:sessions_645x344.gif]]<br />
<br />
We'll use the above example to explain the process as follows:<br />
#In group 1 - Create a ''SessionsAttended'' multi-options question<br />
#In group 1 - Create a ''SessionsNotAttended'' multi-options question with identical answers as ''SessionsAttended'' and hide it with styles or conditions<br />
#In group 2 - Create a ''RateSessionsAttended'' array question with an [http://docs.limesurvey.org/tiki-index.php?page=Question+attributes&structure;=English+Instructions+for+LimeSurvey#array_filter array_filter] based on ''SessionsAttended''<br />
#In group 2 - Create a ''ReasonNotAttended'' array question with an [http://docs.limesurvey.org/tiki-index.php?page=Question+attributes&structure;=English+Instructions+for+LimeSurvey#array_filter array_filter] based on ''SessionsNotAttended''<br />
#In group 1 - Place JavaScript/jQeury listeners on each of the checkboxes in ''SessionsAttended'' that would toggle the corresponding checkbox in ''SessionsNotAttended'' to the opposite state<br />
<br />
The JavaScript/jQuery code used would be:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
// The toggle function<br />
<br />
function toggle(q1, q2) {<br />
<br />
if ($(q1).attr('checked') == false ) {<br />
<br />
$(q2).attr('checked', true);<br />
<br />
}<br />
<br />
else {<br />
<br />
$(q2).attr('checked', false);<br />
<br />
}<br />
<br />
}<br />
<br />
// Initialize the SessionNotAttended checkboxes to "checked"<br />
<br />
toggle ('#answer11111X22X331', '#answer11111X22X441');<br />
<br />
toggle ('#answer11111X22X332', '#answer11111X22X442');<br />
<br />
toggle ('#answer11111X22X333', '#answer11111X22X443');<br />
<br />
toggle ('#answer11111X22X334', '#answer11111X22X444');<br />
<br />
// The jQuery listeners on the SessionAttended checkboxes<br />
<br />
// that toggle the SessionNotAttended checkboxes<br />
<br />
$('#answer11111X22X331').change(function() {<br />
<br />
toggle ('#answer11111X22X331', '#answer11111X22X441');<br />
<br />
});<br />
<br />
$('#answer11111X22X332').change(function() {<br />
<br />
toggle ('#answer11111X22X332', '#answer11111X22X442');<br />
<br />
});<br />
<br />
$('#answer11111X22X333').change(function() {<br />
<br />
toggle ('#answer11111X22X333', '#answer11111X22X443');<br />
<br />
});<br />
<br />
$('#answer11111X22X334').change(function() {<br />
<br />
toggle ('#answer11111X22X334', '#answer11111X22X444');<br />
<br />
});<br />
<br />
</syntaxhighlight><br />
<br />
Some notes about the code:<br />
*The code is in an onload function defined in the first question of group 1 - see [[Workarounds#Custom_onload_function|here]]<br />
*Both ''SessionsAttended'' and ''SessionsNotAttended'' must be in the same group for the toggling to work<br />
*This case only uses 4 checkboxes but could be expanded as required<br />
*In this case the survey ID is 11111, the group ID is 22, ''SessionsAttended'' ID is 33 and SessionsNotAttended ID is 44 - these would need to be modified for your survey<br />
*The toggle function looks for the state of a checkbox in ''SessionsAttended'' and sets the corresponding checkbox in ''SessionsNotAttended'' to the opposite state<br />
*The "Initialize" section sets the state of ''SessionsNotAttended'' checkboxes whenever we navigate to the group<br />
*The "Listener" section uses jQuery listeners to detect any change in the ''SessionsAttended'' checkboxes and then toggle the corresponding ''SessionsNotAttended'' checkbox<br />
<br />
Some general notes about the questions:<br />
*CSS can be used to hide ''SessionsNotAttended'' (div#question44 { display: none; }) if you don't want to use conditions (because maybe you've got [[Optional settings#Survey Behavior|$deletenonvalues set to 1]])<br />
*''RateSessionsAttended'' and ''ReasonNotAttended'' are another group to avoid things popping in and out of existence as ''SessionsAttended'' is answered<br />
*[[Setting conditions|Conditions]] are used to ensure that ''RateSessionsAttended'' only appears if some sessions are selected and ''ReasonNotAttended'' only appears if no sessions are selected<br />
<br />
=Filter Ranking Question With Multiple-Options (pre 1.92)=<br />
<br />
''Tested with: 1.90, IE 7/8, FireFox 3/4, Safari 5.0, Chrome 10.0''<br />
<br />
<div class="simplebox">As of version 1.92, most of this is easier to do using the the array_filter attribute, or relevance equations in general. They all work on the same page, and fully support cascading relevance.</div><br />
<br />
This workaround applies a filter to a ranking question based on the checked boxes of a previous multiple-options question. There are two methods - one for filter and ranking questions being on the same page and a slightly different one for the filter question being on a page before the ranking question.<br />
<br />
There is a [http://www.partnersinc.biz/surveys//index.php?sid=96314&newtest=Y&lang=en demo of both methods here].<br />
<br />
Implementation is as follows.<br />
<br />
'''FOR BOTH METHODS:'''<br />
*[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
*Place the following script in your template.js file. This function will be accessed by either method.<syntaxhighlight lang="javascript" enclose="div"><br />
// A function to filter choices in a ranking question<br />
function rankFilter(q1ID, q2ID, prevPage) {<br />
<br />
// If filter question is on a previous page, hide Q1 and check all "visible" boxes<br />
if(prevPage == 1) {<br />
$('#question'+q1ID+' li[id<div class="simplebox">="javatbd"]:visible input.checkbox').attr('checked', true);<br />
$('#question'+q1ID+'').hide();<br />
}<br />
<br />
handleChecked(q1ID, q2ID);<br />
$('#question'+q1ID+' input.checkbox').click(function() {<br />
handleChecked(q1ID, q2ID);<br />
});<br />
<br />
function handleChecked(q1ID, q2ID) {<br />
<br />
// Find the survey and group IDs<br />
if($( 'input#fieldnames' ).length != 0) {<br />
var fieldNames = $( 'input#fieldnames' ).attr('value');<br />
var tmp = fieldNames.split('X');<br />
var sID = tmp[0];<br />
var gID = tmp[1];<br />
}<br />
<br />
// Loop through all Q1 options<br />
$('#question'+q1ID+' input.checkbox').each(function(i) {<br />
<br />
// Find the answer code and value<br />
var tmp2 = $(this).attr('id').split('X'+gID+'X'+q1ID+'');<br />
var ansCode = tmp2[1];<br />
var ansTxt = $(this).next('label').text();<br />
<br />
// If option is checked and not in rank choices or output, add it to the rank choices<br />
if($(this).attr('checked') == true<br />
&& $('#question'+q2ID+' select.select option[value="'+ansCode+'"]').length == 0<br />
&& $('#question'+q2ID+' .output input[id</div>="fvalue_"][value="'+ansCode+'"]').length == 0) {<br />
$('<option value="'+ansCode+'">'+ansTxt+'</option>').appendTo('#question'+q2ID+' select.select');<br />
}<br />
<br />
// If option is unchecked...<br />
else if($(this).attr('checked') == false) {<br />
// Remove it from the rank choices<br />
$('#question'+q2ID+' select.select option[value="'+ansCode+'"]').remove();<br />
// Remove it from the rank output and reset hidden values<br />
$('#question'+q2ID+' .output input[id<div class="simplebox">="fvalue_"][value="'+ansCode+'"]').attr('value', '').siblings('input.text').val('').siblings('img').hide();<br />
}<br />
});<br />
<br />
// Clean up empty inputs in the rank output table<br />
$('#question'+q2ID+' .output table tr').each(function(i) {<br />
var nextRow = $(this).next('tr');<br />
if($('input.text', this).val() == '' && $('input.text', nextRow).val() != '') {<br />
$('input.text', this).val($('input.text', nextRow).val());<br />
$('input.text', nextRow).val('');<br />
$('input[id</div>="fvalue_"]', this).attr('value', $('input[id<div class="simplebox">="fvalue_"]', nextRow).attr('value'));<br />
$('input[id</div>="fvalue_"]', nextRow).attr('value', '');<br />
}<br />
});<br />
<br />
// Show the scissors for the last populated rank output row<br />
$('#question'+q2ID+' .output table img[id<div class="simplebox">="cut_"]').hide();<br />
$('#question'+q2ID+' .output table input.text[value!=""]:last').siblings('img[id</div>="cut_"]').show();<br />
<br />
// Hide extra rank output rows<br />
var optNum = $('#question'+q1ID+' input.checkbox:checked').length;<br />
$('#question'+q2ID+' .output table tr').hide();<br />
$('#question'+q2ID+' .output table tr:lt('+(optNum+1)+')').show();<br />
<br />
// Hide and clear the ranking question if there are less than 2 checked options in Q1<br />
if(optNum < 2) {<br />
$('#question'+q2ID+'').hide();<br />
$('#question'+q2ID+' input.text').val('');<br />
$('#question'+q2ID+' input[id<div class="simplebox">="fvalue_"]').attr('value', '');<br />
}<br />
else {<br />
$('#question'+q2ID+'').show();<br />
}<br />
<br />
// A workaround for the built in max-answers function<br />
$('#question'+q2ID+' select.select').attr('disabled', true);<br />
$('#question'+q2ID+' td.output tr:visible').each(function(i) {<br />
if($('input.text', this).val() == '') {<br />
$('#question'+q2ID+' select.select').attr('disabled', false);<br />
}<br />
});<br />
}<br />
<br />
// A listener to work around the built in max-answers function<br />
$('#question'+q2ID+' td.rank').click(function (event) {<br />
$('#question'+q2ID+' select.select').attr('disabled', true);<br />
$('#question'+q2ID+' td.item input.text').each(function(i) {<br />
if ($(this).val() == '') {<br />
$('#question'+q2ID+' select.select').attr('disabled', false);<br />
}<br />
});<br />
});<br />
}</syntaxhighlight><br />
<br />
'''FOR BOTH FILTER AND RANKING QUESTIONS ON SAME PAGE:'''<br />
*Create a multiple options question and a ranking question on the same page (in the same group).<br />
*Both questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Place the following script in the source of one of the questions.<br />
*Replace "MM" with the ID of the multiple options question and "RR" with the ID of the ranking question.<br />
*The function will hide the ranking question unless at least two options are selected in the multiple options question, in which case, it will only show the options selected.<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
rankFilter(MM, RR);<br />
});<br />
</script></syntaxhighlight><br />
<br />
'''FOR FILTER AND RANKING QUESTIONS ON SEPARATE PAGES:'''<br />
*Create a multiple options question on page 1.<br />
*Create a multiple options question and a ranking question on page 2.<br />
*All three questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Set the multiple options on page 2 to be filtered by the multiple options on page 1.<br />
*Place the following script in the source of one of the questions on page 2.<br />
*Replace "MM" with the ID of the multiple options question and "RR" with the ID of the ranking question. Do not modify the "1".<br />
*The function will hide the multiple options question. If at least 2 options were selected in the multiple options on page 1, the corresponding options will be checked in the hidden multiple options question which will then be used to control the display of the ranking question.<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function() {<br />
rankFilter(MM, RR, 1);<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Filter "Array by Column" Question With "Multiple-Options"=<br />
<br />
''Tested with: 1.91, IE 7/8, FireFox 3/4, Safari 5.0, Chrome 10.0''<br />
<br />
This workaround applies a filter to an "Array by Column" question based on the checked boxes of a previous multiple-options question. There are two methods - one for filter and array questions being on the same page and a slightly different one for the filter question being on a page before the array question.<br />
<br />
There is a [http://www.partnersinc.biz/surveys//index.php?sid=74213&newtest=Y&lang=en demo of both methods here].<br />
<br />
Implementation is as follows.<br />
<br />
'''FOR BOTH METHODS:'''<br />
*[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
*Place the following scripts in your template.js file. These functions will be accessed by either method.<syntaxhighlight lang="javascript" enclose="div"><br />
$(document).ready(function() {<br />
<br />
function filterArrByCol(qMultiOpt, qArray, prevPage) {<br />
<br />
// If filter question is on a previous page, hide Q1 and check all "visible" boxes<br />
if(prevPage == 1) {<br />
$('#question'+qMultiOpt+' li[id</div>="javatbd"]:visible input.checkbox').attr('checked', true);<br />
$('#question'+qMultiOpt+'').hide();<br />
}<br />
<br />
// Assign classes to the answer cells<br />
$('#question'+qArray+' table.question tbody td').each(function(i){<br />
var classArr = $(this).attr('class').split('answer_cell_00');<br />
var ansCode = classArr[1];<br />
$(this).addClass('ans-'+ansCode+' filtered');<br />
});<br />
<br />
// Assign classes to the answer label cells<br />
$('#question'+qArray+' table.question tbody tr:eq(0) td').each(function(i){<br />
var classArr2 = $(this).attr('class').split(' ans-');<br />
var ansCode2 = classArr2[1];<br />
$('#question'+qArray+' table.question thead tr:eq(0) th:eq('+i+')').addClass('ans-'+ansCode2+'');<br />
});<br />
<br />
// Fire the filter function on page load<br />
filterArr(qMultiOpt, qArray);<br />
<br />
// Listener on multi-opt checkboxes to fire the filter function<br />
$('#question'+qMultiOpt+' input.checkbox').click(function(){<br />
filterArr(qMultiOpt, qArray);<br />
});<br />
<br />
// On submit, clear all hidden radios of array<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
$('#question'+qArray+' td.filtered:hidden').each(function(i){<br />
$('input.radio', this).attr('checked', false);<br />
});<br />
return true;<br />
});<br />
}<br />
<br />
function filterArr(qMultiOpt, qArray) {<br />
<br />
if($('#question'+qMultiOpt+' input.checkbox:checked').length < 1) {<br />
// Hide the array if no multi-opt options are checked<br />
$('#question'+qArray+'').hide();<br />
}<br />
else {<br />
$('#question'+qArray+'').show();<br />
<br />
// Hide all columns of array<br />
$('#question'+qArray+' table.question tbody td, #question'+qArray+' table.question thead th').hide();<br />
<br />
// Loop through multi-opt checkboxes and, if checked, show corresponding column of array<br />
$('#question'+qMultiOpt+' input.checkbox').each(function(i){<br />
if($(this).attr('checked') == true) {<br />
var classArr3 = $(this).attr('id').split('X'+qMultiOpt);<br />
var ansCode3 = classArr3[1];<br />
$('#question'+qArray+' .ans-'+ansCode3+'').show();<br />
}<br />
});<br />
}<br />
}<br />
});</syntaxhighlight><br />
<br />
'''FOR BOTH FILTER AND ARRAY QUESTIONS ON SAME PAGE:'''<br />
*Create a multiple options question and an array-by-column question on the same page (in the same group).<br />
*Both questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Place the following script in the source of one of the questions.<br />
*Replace "MM" with the ID of the multiple options question and "AA" with the ID of the ranking question.<br />
*The function will hide the array question unless at least one option is selected in the multiple-options question, in which case, it will only show the corresponding array column(s).<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function() {<br />
filterArrByCol(MM, AA);<br />
});<br />
</script></syntaxhighlight><br />
<br />
'''FOR FILTER AND ARRAY QUESTIONS ON SEPARATE PAGES:'''<br />
*Create a multiple options question on page 1.<br />
*Create a multiple options question and an array-by-column question on page 2.<br />
*All three questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Set the multiple options on page 2 to be filtered by the multiple options on page 1.<br />
*Place the following script in the source of one of the questions on page 2.<br />
*Replace "MM" with the ID of the multiple options question and "AA" with the ID of the array question. Do not modify the "1".<br />
*The function will hide the multiple options question. If options were selected in the multiple options on page 1, the corresponding options will be checked in the hidden multiple options question which will then be used to control the display of the array columns.<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function() {<br />
filterArrByCol(MM, AA, 1);<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Auto-tabbing between text input fields=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
This is a workaround to facilitate auto-tabbing between text input questions in a single group using a [http://plugins.jquery.com/project/autotab jQuery plugin by Mathachew] and the Maximum characters attribute of questions.<br />
<br />
The behaviour will be: When the maximum number of characters has been entered into an input field, the focus (cursor) will be automatically moved to the next input field. When the backspace key is used to remove all characters from a field, the focus will be moved to the previous field. It's very useful in surveys having many text input questions to avoid having to manually tab or click between fields.<br />
<br />
You can view a small demo survey [http://www.partnersinc.biz/surveys//index.php?sid=11327&newtest=Y&lang=en here].<br />
<br />
Implementation is as follows:<br />
#Visit [http://plugins.jquery.com/autotabs http://plugins.jquery.com/autotabs], download the plugin script and save it as ''jquery.autotab-1.1b.js'' in the template folder.<br />
#Link to the script by placing ''<script type="text/javascript" src="{TEMPLATEURL}jquery.autotab-1.1b.js"></script>'' within the ''<head>'' tag of startpage.pstpl.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Create the text based questions that auto-tabbing is to be applied to. (All must be in the same group if you're using group by group presentation)<br />
#Define a Maximum characters attribute for all questions that the autotab is applied to.<br />
{{QS:maximum_chars}} <br />
#In the source of the first question of the group that contains the auto-tabbed questions, add the following code.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answerSSSSSXGGXAA').focus(); //initially focus on the first input<br />
<br />
$('#answerSSSSSXGGXAA').autotab({ target: 'answerSSSSSXGGXBB' });<br />
<br />
$('#answerSSSSSXGGXBB').autotab({ previous: 'answerSSSSSXGGXAA', target: 'answerSSSSSXGGXCC' });<br />
<br />
$('#answerSSSSSXGGXCC').autotab({ previous: 'answerSSSSSXGGXBB', target: 'answerSSSSSXGGXDD' });<br />
<br />
$('#answerSSSSSXGGXDD').autotab({ previous: 'answerSSSSSXGGXCC' });<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
This example has 4 fields to be auto-tabbed between - all instances of the following must be replaced to be compatible with your survey (See image below):<br />
*SSSSS -> Survey ID<br />
*GG -> Group ID<br />
*AA -> First question<br />
*BB -> Second question<br />
*CC -> Third question<br />
*DD -> Last question<br />
<br />
[[File:ids_343x252.gif]]<br />
<br />
The ''target'' parameter defines where the next input is and the ''previous'' parameter defines (you guessed it) the previous input.<br />
<br />
This plugin also has limited capability of formatting the input text - see comments in the plugin script.<br />
<br />
=Custom response listeners=<br />
<br />
''Tested with: 1.85+ (7253), IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
Listeners can be used to perform functions when a change in an input is detected. There are many uses such as the [[Workarounds#Reverse_array_filter|Reverse array_filter]] but a simple one would be to warn a respondent if they enter a value that may be too high.<br />
<br />
We can use the [http://docs.jquery.com/Events/change jQuery change( ) event] to fire a function whenever there is a change to the input. The function will look for an input value higher than 10 and, if found, will warn the respondent.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the script below in the source of one of the questions on the page where:<br />
**11111 is the survey ID<br />
**22 is the group ID<br />
**33 is the question ID<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answer11111X22X33').change(function() {<br />
<br />
if ( $('#answer11111X22X33').val() > 10 ) {<br />
alert ("That's an awful lot. Are you sure?");<br />
}<br />
});<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Text input masks=<br />
<br />
''Tested with: 1.90+, IE 7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
There may be instances where you would like to place a mask on a text input - for example only allowing respondents to enter the correct characters for a North American phone number ((###) ###-####) or a Canadian postal code (A1A 1A1) The [http://plugins.jquery.com/project/meioMask jQuery meioMask plugin by fabiomcosta] can be used to do this.<br />
<br />
The plugin has several pre-defined masks and supports custom masks. It also allows for pasting of input, allows default values and can auto-focus the next form element when the current input is completely filled. See [http://www.meiocodigo.com/projects/meiomask/ http://www.meiocodigo.com/projects/meiomask/] for more details on features and options.<br />
<br />
There is a small demo [http://www.partnersinc.biz/surveys//index.php?sid=36146&newtest=Y&lang=en here].<br />
<br />
Implementation for this demo was as follows:<br />
#Visit [http://www.meiocodigo.com/projects/meiomask/ http://www.meiocodigo.com/projects/meiomask/], download the latest plugin script and save it as jquery.meiomask.js in the template folder.<br />
#Link to the script by placing <script type="text/javascript" src="{TEMPLATEURL}jquery.meiomask.js" charset="utf-8"></script> within the <head> tag of startpage.pstpl.<br />
#Turn off $filterxsshtml to allow insertion of JavaScript in the questions. ([http://docs.limesurvey.org/tiki-index.php?page=Optional+settings&structure=English+Instructions+for+LimeSurvey#Filtering_dangerous_HTML_tags_in_survey_objects See documentation here])<br />
#Create the text input questions that the masks are to be applied to<br />
#In the source of the help section of the first question of the group that contains the masked inputs, add the following code. ([http://docs.limesurvey.org/tiki-index.php?page=Workarounds&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._ See How to use script here]) <br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() { <br />
<br />
// Define custom masks<br />
$.mask.masks = $.extend($.mask.masks,{<br />
customMask1:{ mask: 'a9a 9a9' }, // Canadian postal code<br />
// Maximum input of 9,999.99, reverse input, default value of 0.00 <br />
customMask2:{ mask: '99.999,9', type : 'reverse', defaultValue : '000' } <br />
});<br />
<br />
// Set the 'alt' attributes of the inputs<br />
$('#answer111111X22XAA').attr('alt', 'phone-us'); // a pre-defined mask <br />
$('#answer111111X22XBB').attr('alt', 'customMask1'); // a custom mask <br />
$('#answer111111X22XCC').attr('alt', 'customMask2'); // a custom mask <br />
$('#answer111111X22XDD').attr('alt', 'cc'); // a pre-defined mask for credit card<br />
<br />
// Tell the plugin to apply masks to these inputs<br />
$('input:#answer111111X22XAA').setMask();<br />
$('input:#answer111111X22XBB').setMask();<br />
$('input:#answer111111X22XCC').setMask();<br />
$('input:#answer111111X22XDD').setMask(); <br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
<br />
The first section defines two custom masks to be used - one for Canadian postal code with a format of A#A #A# and a second for a maximum amount of 9999.99 with reverse input (useful for cost inputs) and a default value of 0.00.<br />
<br />
The next section sets the "alt" attributes for the text inputs. This will tell meioMask which mask we will be applying to each input. By default meioMask looks at the alt attribute to find which mask to apply however this can be changed using the [http://www.meiocodigo.com/projects/meiomask/#mm_options mask options].<br />
<br />
In the final section we apply the masks to the inputs.<br />
<br />
This example has 4 inputs with masks on them - all instances of the following must be replaced to be compatible with your survey (See image below):<br />
<br />
*11111 -> Survey ID<br />
*22 -> Group ID<br />
*AA -> First question<br />
*BB -> Second question<br />
*CC -> Third question<br />
*DD -> Fourth question<br />
<br />
[[File:Ids 343x252.gif]]<br />
<br />
=Text input masks - second method=<br />
<br />
''Tested with: 1.91RC6+, FireFox 4.0''<br />
<br />
There may be instances where you would like to place a mask on a text input - for example only allowing respondents to enter the correct characters for a North American phone number ((###) ###-####) or a US social security number (###-##-####). The jQuery meioMask plugin by fabiomcosta is no longer supported but an alternative exists. The DigitalBush Masked Input Plugin is updated and simple to implement in LimeSurvey. See [http://digitalbush.com/projects/masked-input-plugin/ http://digitalbush.com/projects/masked-input-plugin/] for more details on features and options.<br />
<br />
Implementation as follows:<br />
<br />
#Visit [http://digitalbush.com/projects/masked-input-plugin/ http://digitalbush.com/projects/masked-input-plugin/], download the latest plugin script and save it as jquery.maskedinput.js in the template folder.<br />
#Link to the script by placing <script type="text/javascript" src="{TEMPLATEURL}jquery.maskedinput.js" charset="utf-8"></script> within the <head> tag of startpage.pstpl.<br />
#Turn off $filterxsshtml to allow insertion of JavaScript in the questions. ([http://docs.limesurvey.org/tiki-index.php?page=Optional+settings&structure=English+Instructions+for+LimeSurvey#Filtering_dangerous_HTML_tags_in_survey_objects See documentation here])<br />
#Create the text input questions that the masks are to be applied to<br />
#In the source of the help section of the first question of the group that contains the masked inputs, add the following code. ([http://docs.limesurvey.org/tiki-index.php?page=Workarounds&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._ See How to use script here]) <br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function($) { <br />
$("#answer55431X1X5").mask("999-99-9999",{ placeholder:"#" });<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
<br />
Replace the "#answer55431X1X5" with your survey ID, group ID, and question ID. You can change the mask format and change or eliminate the placeholder if you wish. If you have multiple questions in the same group, simply copy and paste the line that begins with "$" and change the code to what is needed for your application.<br />
<br />
=Select a random response to a "Multiple options" question for later use=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
This workaround allows you to randomly select one of the checked boxes in a "Multiple options" question and store it's label for later use in the survey. A possible use would be to have a question asking what products were purchased and then randomly selecting one of the products to ask further questions about.<br />
<br />
There is a small demo of the above example [http://www.partnersinc.biz/surveys//index.php?sid=81252&newtest=Y&lang=en here].<br />
<br />
Basically what we've done here is to put listeners on all of the checkboxes. If a change of state is detected in any of them the "randomResponse" function is called which loops through all of the checkboxes and if it finds a checked state, that box's label is added to an array. Then a random item is pulled from the array and used to populate the hidden question. This hidden question can then be drawn upon later in the survey using [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+Question#Information_from_previous_answers INSERTANS] or [http://docs.limesurvey.org/tiki-index.php?page=Setting+conditions&structure=English+Instructions+for+LimeSurvey Conditions].<br />
<br />
Implementation for this demo is as follows:<br />
<br />
#[http://docs.limesurvey.org/tiki-index.php?page=Workarounds%3A+Manipulating+a+survey+at+runtime+using+Javascript&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._in_LimeSurvey_ Set up your survey to use JavaScript].<br />
#Create a "Multiple options" question that we're going to randomly pick a checked box from<br />
#Create a text input question to store the label of the checked box in (we're going to hide this with JavaScript)<br />
#Place the script below in the source of one of the questions on the page. <br />
<br />
The following edits are required to implement this in your survey:<br />
<br />
*EDIT HERE (1) - 11111 -> Survey ID, 22 -> Group ID, 44 -> hidden question ID.<br />
*EDIT HERE (2) - 44 -> hidden question ID.<br />
*EDIT HERE (3) - 11111 -> Survey ID, 22 -> Group ID, 33 -> multiple option question ID, A/B/C/D/E/F -> multiple option answer codes. Also add or remove CBs for more or less checkboxes.<br />
*EDIT HERE (4) - add or remove CBs for more or less checkboxes.<br />
*EDIT HERE (5) - add or remove CBs for more or less checkboxes. <br />
<br />
For more info on these IDs see [http://docs.limesurvey.org/tiki-index.php?page=SGQA+identifier&structure=English+Instructions+for+LimeSurvey SGQA identifier].<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
//// Identify the hidden question input<br />
//// EDIT HERE (1) - replace with your hidden question input ID<br />
var hiddenInput = '#answer11111X22X44';<br />
<br />
//// Make the "hidden" question disappear<br />
//// EDIT HERE (2) - replace with your hidden question ID<br />
$('#question44').hide();<br />
<br />
//// Identify the checkboxes to be randomized<br />
//// EDIT HERE (3) - add or remove as required, <br />
//// replace with your checkbox IDs<br />
var CB1 = '#answer11111X22X33A';<br />
var CB2 = '#answer11111X22X33B';<br />
var CB3 = '#answer11111X22X33C';<br />
var CB4 = '#answer11111X22X33D';<br />
var CB5 = '#answer11111X22X33E';<br />
var CB6 = '#answer11111X22X33F';<br />
<br />
//// Create an array of all checkboxes to be randomized<br />
//// EDIT HERE (4) - add or remove CBs as required<br />
checkBoxes = new Array( CB1, CB2, CB3, CB4, CB5, CB6 );<br />
var checkBoxesLength = checkBoxes.length;<br />
<br />
//// The randomizing function - no editing required<br />
function randomResponse () {<br />
var boxLabels = new Array();<br />
<br />
// loop through all of the checkboxes and if they are checked, <br />
// add their label to the boxLabels array<br />
for( var i=0; i<checkBoxesLength; i++ ) {<br />
if ( $(checkBoxes[i]).attr('checked') == true ) {<br />
var cbid = checkBoxes[i].replace('#','');<br />
boxLabels.push( $( 'label[for=' + cbid + ']' ).html() );<br />
}<br />
}<br />
<br />
// find a random index of the responses array<br />
var randomNum = Math.floor(Math.random() * boxLabels.length); <br />
<br />
// populate the hidden question input with the <br />
// random input value<br />
$(hiddenInput).val( boxLabels[randomNum] ); <br />
}<br />
<br />
//// The listeners that will fire the randomize function if a <br />
//// change occurs in the checkboxes<br />
//// EDIT HERE (5) - add or remove CBs as required<br />
$(CB1).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB2).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB3).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB4).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB5).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB6).change(function() {<br />
randomResponse ();<br />
}); <br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
=Display secondary options in a "Multiple options" question=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows you to display secondary options in a "Multiple options" question if a primary option is checked as in the images below.<br />
<br />
Primary option not selected:<br /><br />
[[File:Secondary_options_1.jpg]]<br />
<br />
<br />
Primary option selected:<br /><br />
[[File:Secondary_options_2.jpg]]<br />
<br />
<br />
There is a small demo of the above example [http://www.partnersinc.biz/surveys//index.php?sid=11491&newtest=Y&lang=en here].<br />
<br />
We've put a listener on the primary answer ("Option 1" in the demo) that shows or hides the secondary answers depending on the state of the primary.<br />
<br />
Implementation for this demo is as follows:<br />
<br />
#[http://docs.limesurvey.org/tiki-index.php?page=Workarounds%3A+Manipulating+a+survey+at+runtime+using+Javascript&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._in_LimeSurvey_ Set up your survey to use JavaScript].<br />
#Create a "Multiple options" question including both the primary and secondary answers (in the order that you would like them displayed if all shown)<br />
#Add the following script to the source of the question.<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
/**** <br />
The following code puts a listener on an answer in a multiple options<br />
question (the primary answer) and if that answer is checked, a secondary <br />
level of answers is displayed.<br />
****/<br />
<br />
// --- 1 --- Indent the secondary answers a bit<br />
$( '#questionQQ li:eq(1)' ).css({ 'margin-left':'2.5em' });<br />
$( '#questionQQ li:eq(2)' ).css({ 'margin-left':'2.5em' });<br />
<br />
// --- 2 --- When the page loads, see if the primary answer is checked and if not, <br />
//hide and un-check all secondary answers<br />
if ($( '#answerSSSSSXGGXQQAA' ).attr('checked') == false ) {<br />
<br />
$( '#questionQQ li:eq(1)' ).hide();<br />
$( '#questionQQ li:eq(2)' ).hide();<br />
<br />
$( '#answerSSSSSXGGXQQBB' ).attr('checked', false);<br />
$( '#answerSSSSSXGGXQQCC' ).attr('checked', false);<br />
}<br />
<br />
// --- 3 --- Now put a listener on the primary answer to show or hide secondary answers <br />
// We need to use .click instead of .change cause IE won't cooperate<br />
$('#answerSSSSSXGGXQQAA').click(function (event) {<br />
<br />
// Have a look at the primary answer and hide/show the secondary answers accordingly<br />
if ($( '#answerSSSSSXGGXQQAA' ).attr('checked') == false ) {<br />
<br />
$( '#questionQQ li:eq(1)' ).hide();<br />
$( '#questionQQ li:eq(2)' ).hide();<br />
<br />
$( '#answerSSSSSXGGXQQBB' ).attr('checked', false);<br />
$( '#answerSSSSSXGGXQQCC' ).attr('checked', false);<br />
}<br />
else {<br />
<br />
$( '#questionQQ li:eq(1)' ).show();<br />
$( '#questionQQ li:eq(2)' ).show();<br />
} <br />
<br />
// The original functions of the click event<br />
cancelBubbleThis(event);<br />
checkconditions(this.value, this.name, this.type);<br />
}<br />
);<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
<br />
The following edits are required to implement this in your survey:<br />
<br />
'''Section 1:'''<br />
*This section indents the secondary answers to give the look of a list in a list when they're shown<br />
*'''QQ''' is your question ID<br />
*'''eq(1)''' and '''eq(2)''' are the index positions of your secondary options. Modify or add as necessary for the number and placement of secondary options in your question. Note that the index starts at 0 so '''eq(1)''' actually affects the second option in the full list and '''eq(2)''' affects the third. <br />
<br />
'''Section 2:'''<br />
*This section checks the state of the primary question when the page is loaded and if necessary hides the secondary questions. We need this in case users navigate away from and then back to the page.<br />
*Modify '''eq(1)''' and '''eq(2)''' as above.<br />
*'''SSSSS''' is your survey ID.<br />
*'''GG''' is your group ID.<br />
*'''QQ''' is your question ID.<br />
*'''AA''' is your primary answer code.<br />
*'''BB''' and '''CC''' are your secondary answer codes (add as necessary). <br />
<br />
'''Section 3:'''<br />
*This is the section that "listens" to the primary answer and reacts accordingly.<br />
*Edit as in section 2.<br />
<br />
For more info on these IDs see SGQA identifier(external link).<br />
<br />
This code could be tidied up and shortened a bit but I left it this way to make it easier to follow.<br />
<br />
=Minimum number of required answers in an array (pre 1.92)=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2,''<br />
<br />
<div class="simplebox">As of version 1.92 all array style questions have the min_answers and max_answers options, so this script is obsolete.</div><br />
<br />
This workaround allows you to specify a '''minimum number''' of answers required in an array question. It is an alternative to the "Mandatory" parameter which specifies that '''all''' answers are required. It could also be easily modified to specify a maximum number of answers.<br />
<br />
We accomplish this by placing an onload function in the source of the array question. This function hides the Next/Submit button and displays a warning element until it detects a minimum number of responses. It then hides the warning and shows the Next/Submit button.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=97166&newtest=Y&lang=en here].<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Set up the template to use custom onload functions. (See the [[Workarounds#Custom onload function|workaround here]])<br />
#In the source of the array question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Modify the ''SETTINGS'' section of the code as required.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
// Wait until the document is fully loaded<br />
$(document).ready(function() {<br />
<br />
/********************** SETTINGS **********************/<br />
// The text to appear in the warning element<br />
var warningText = 'Please answer at least 4 to continue';<br />
// The question ID<br />
var questionId = 137;<br />
// The minimum number of answers required<br />
var minNumber = 4;<br />
/******************************************************/<br />
<br />
// Create the warning element and place it after the submit button<br />
var el = document.createElement('div');<br />
el.setAttribute('id','warning');<br />
document.body.appendChild(el);<br />
$( '#warning' ).css({<br />
'border':'1px solid #333333',<br />
'width':'200px',<br />
'padding':'3px',<br />
'color':'red'<br />
});<br />
$('#warning').html(warningText);<br />
$('input[type="submit"]').after($('#warning'));<br />
<br />
// Detect the initial number of checked answers & display Next/Submit button accordingly<br />
var inputInitCount = 0;<br />
$('#question' + questionId + ' input').each(function(i) {<br />
if ($( this ).attr('checked') == true ) {<br />
inputInitCount++;<br />
}<br />
});<br />
if (inputInitCount > (minNumber - 1)) {<br />
$('input[type="submit"]').show();<br />
$('#warning').hide();<br />
}<br />
else {<br />
$('#warning').show();<br />
$('input[type="submit"]').hide();<br />
}<br />
<br />
// Listener to detect number of checked answers & display Next/Submit button accordingly<br />
$('#question' + questionId + ' input.radio, #question'+questionId+' tbody[id<div class="simplebox">="javatbd"] td').click(function() {<br />
var inputCount = 0;<br />
$('#question' + questionId + ' input.radio').each(function(i) {<br />
if ($( this ).attr('checked') == true ) {<br />
inputCount++;<br />
}<br />
});<br />
if (inputCount > (minNumber - 1)) {<br />
$('input[type="submit"]').show();<br />
$('#warning').hide();<br />
}<br />
else {<br />
$('#warning').show();<br />
$('input[type="submit"]').hide();<br />
}<br />
<br />
// The original functions of the click event<br />
checkconditions(this.value, this.name, this.type);<br />
});<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Minimum elapsed time before moving forward in survey=<br />
<br />
''Tested with: 1.91, IE 7/8, Firefox 7.0, Safari 3.2''<br />
<br />
This workaround interrupts the Next/Submit function and checks the amount of time elapsed since the page loaded. If the time is less than the minimum dictated, the respondent is alerted and not allowed to proceed. It is useful if you want to enforce a minimum amount of time spent viewing a page.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the script below in the source of one of the questions on the page, replacing "TT" with the minimum number of seconds required before advancing is allowed.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
minTime(TT);<br />
<br />
function minTime(minTime) {<br />
<br />
var startTime = new Date();<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
var endTime = new Date();<br />
<br />
if((endTime - startTime)/1000 <= minTime) {<br />
alert ('You must spend at least '+minTime+' seconds on the question.');<br />
return false;<br />
}<br />
else {<br />
return true;<br />
}<br />
});<br />
}<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
=Minimum number of characters in Long free text or Huge free text questions=<br />
<br />
''Tested with: 1.91, IE 7/8, Firefox 7.0, Safari 3.2''<br />
<br />
<div class="simplebox">As of version 1.91, you can use regular expression masks (validation) to specify the minimum number of required characters. However, even if the question is mandatory, it can still be blank.</div><br />
<br />
<div class="simplebox">As of version 1.92, if you make the question mandatory and use a validation mask to specify the minimum number of characters, then the user will be forced to answer the question. Note that unlike 1.91, they can submit their current answers, even if partially invalid (so they are stored in the database), but they will not ber able to proceed to the next page until they have passed all mandatory and validity checks.</div><br />
<br />
This workaround interrupts the Next/Submit function and checks the number of characters entered in a Long free text or Huge free text question. If the number is less than the minimum dictated, the respondent is alerted and not allowed to proceed.<br />
<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
<br />
#Place the script below in the source of one of the questions on the page, replace "QQ" with the question ID and "CC" with the minimum number of characters required before advancing is allowed.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
minChar(QQ, CC);<br />
<br />
function minChar(qID, minChars) {<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
if($('#question'+qID+' textarea').val().replace(/ /g,'').length < minChars) {<br />
<br />
alert ('You must enter at least '+minChars+' characters.');<br />
<br />
return false;<br />
<br />
}<br />
<br />
else {<br />
<br />
return true;<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Variable Length Array (Multi Flexible Text) question=<br />
<br />
''Tested with: 1.90+, IE 6/7/8, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows a respondent to add or remove rows of an Array (Multi Flexible Text) question. It's useful to avoid the page being cluttered with unnecessary array rows.<br />
<br />
A function is placed in the template.js file of your template (use template editor). This function hides all of the array rows except the first and inserts two elements that when clicked show or hide rows accordingly.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=53132&newtest=Y&lang=en here].<br />
<br />
It must be noted that you can not make this question Mandatory as the respondent will have no way to complete hidden fields. If you want the displayed fields to be mandatory you will need to validate them in another function or modify this function to only allow the addition of rows if all fields in the last row are completed and then disable those fields - that, however, is a little over the top for this example.<br />
<br />
Implementation is as follows:<br />
<br />
#Set up your survey to use JavaScript (See instructions [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|here]])<br />
<br />
#Add the following script to your ''template.js'' file.<br />
<br />
#Replace "QQ" in the function call at the end with the question ID.<br />
<br />
#Create one or more Array (Multi Flexible Text) questions<br />
<br />
#If you want to apply it to more arrays on the same page simply add more calls with the appropriate question IDs. (eg. varLengthArray(1); varLengthArray(2);...)<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div">$(document).ready(function() {<br />
<br />
// A function to add or remove rows of an Array (Multi Flexible)(Text) question<br />
function varLengthArray(qID) {<br />
<br />
if ($('#question'+qID+'').length > 0) {<br />
<br />
// The HTML content of the Add/Remove elements - modify as you wish<br />
var addContent = '[+]';<br />
var removeContent = '[-]';<br />
<br />
// Create the Add and Remove elements & insert them<br />
var el1 = document.createElement('div');<br />
el1.setAttribute('id','addButton'+qID);<br />
document.body.appendChild(el1);<br />
var el2 = document.createElement('div');<br />
el2.setAttribute('id','removeButton'+qID);<br />
document.body.appendChild(el2);<br />
<br />
// Move them to after the array<br />
$( 'div#addButton'+qID ).appendTo($( '#question' + qID + ' table.question' ).parent());<br />
$( 'div#removeButton'+qID ).appendTo($( '#question' + qID + ' table.question' ).parent());<br />
<br />
// Insert their HTML<br />
$( 'div#addButton'+qID ).html( addContent );<br />
$( 'div#removeButton'+qID ).html( removeContent );<br />
<br />
// Style the elements - you can modify here if you wish<br />
$( 'div#addButton'+qID ).css({<br />
'margin':'10px 0 0 10px',<br />
'padding':'1px',<br />
'text-align':'center',<br />
'font-weight':'bold',<br />
'width':'auto',<br />
'cursor':'pointer',<br />
'float':'left'<br />
});<br />
<br />
$( 'div#removeButton'+qID ).css({<br />
'margin':'10px 0 0 10px',<br />
'padding':'1px',<br />
'text-align':'center',<br />
'font-weight':'bold',<br />
'width':'auto',<br />
'cursor':'pointer',<br />
'float':'left'<br />
});<br />
<br />
// Initially hide the Remove element<br />
$( 'div#removeButton'+qID ).hide();<br />
<br />
// Call the functions below when clicked<br />
$( 'div#addButton'+qID ).click(function (event) {<br />
addRow(qID);<br />
});<br />
$( 'div#removeButton'+qID ).click(function (event) {<br />
removeRow(qID);<br />
});<br />
<br />
// Function to add a row, also shows the Remove element and hides the<br />
//Add element if all rows are shown<br />
function addRow(qID) {<br />
var arrayRow = '#question' + qID + ' table.question tbody';<br />
var rowCount = $( arrayRow ).size() - 1;<br />
$( arrayRow + '[name="hidden"]:first' ).attr('name', 'visible').show();<br />
$( 'div#removeButton'+qID ).show();<br />
if ( $( arrayRow + ':eq(' + rowCount + ')' ).attr('name') == 'visible' ) {<br />
$( 'div#addButton'+qID ).hide();<br />
}<br />
}<br />
<br />
// Function to remove a row, also clears the contents of the removed row,<br />
// shows the Add element if the last row is hidden and hides the Remove<br />
// element if only the first row is shown<br />
function removeRow(qID) {<br />
var arrayRow = '#question' + qID + ' table.question tbody';<br />
var rowCount = $( arrayRow ).size() - 1;<br />
$( arrayRow + '[name="visible"]:last input[type="text"]' ).val('');<br />
$( arrayRow + '[name="visible"]:last' ).attr('name', 'hidden').hide();<br />
$( 'div#addButton'+qID ).show();<br />
if ( $( arrayRow + ':eq(1)' ).attr('name') == 'hidden' ) {<br />
$( 'div#removeButton'+qID ).hide();<br />
}<br />
}<br />
<br />
// Just some initialization stuff<br />
var arrayRow = '#question' + qID + ' table.question tbody';<br />
var rowCount = '';<br />
<br />
// Initially hide all except first row or any rows with populated inputs<br />
$( arrayRow ).each(function(i) {<br />
if ( i > 0 ) {<br />
// We also need to give the hidden rows a name cause IE doesn't<br />
// recognize jQuery :visible selector consistently<br />
$( this ).attr('name', 'hidden').hide();<br />
<br />
$('input[type=text]', this).each(function(i) {<br />
if ($(this).attr('value') != '') {<br />
$(this).parents('tbody:eq(0)').attr('name', 'visible').show();<br />
$( 'div#removeButton'+qID ).show();<br />
}<br />
});<br />
rowCount = i;<br />
}<br />
});<br />
}<br />
}<br />
<br />
// Call the function with a question ID<br />
varLengthArray(QQ);<br />
<br />
});</syntaxhighlight><br />
<br />
=Expandable Array=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.5, Safari 3.2''<br />
<br />
This workaround allows you to present an array question incrementally. That is to say that initially only the first option (row) in the array is shown. When that option is answered the next is shown and so-on.<br />
<br />
A JavaScript function is placed in the source of the array question. This function hides all of the array rows except the first and then displays them as options are answered.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=94958&newtest=Y&lang=en here].<br />
<br />
The workaround supports following question types:<br />
*Array (flexible labels)<br />
*Array (flexible labels) by column<br />
*Array (Yes/No/Uncertain)<br />
*Array (Increase, Same, Decrease)<br />
*Array (Flexible Labels) dual scale<br />
*Array (10 point choice)<br />
<br />
Implementation is as follows:<br />
#Set up your survey to use JavaScript. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|documentation here]])<br />
#Create one or more Array questions<br />
#In the source of the first array question add the following script.<br />
#Replace "QQ" in the function call at the end of the script with the question ID of the array you would like to manipulate.<br />
#If you want to apply it to more arrays on the same page, simply add more calls with the appropriate question IDs. (eg. expandingArray(1); expandingArray(2);...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
// A function to show subsequent rows of an array as options are checked<br />
function expandingArray(qID) {<br />
<br />
// Build an array of the question rows<br />
var arrayRow = '#question' + qID + ' table.question tbody tr';<br />
<br />
// Initially hide all rows unless an input was previously checked<br />
$( arrayRow ).each(function(i) {<br />
<br />
if ( $( arrayRow + ':eq(' + i + ') input.radio:checked' ).length != 0 ) {<br />
$(this).attr('name', 'clickedRow');<br />
}<br />
else {<br />
$(this).attr('name', 'hidden').hide();<br />
}<br />
});<br />
<br />
// Now show the first hidden row<br />
addRow();<br />
<br />
// Add another row when an option is checked for the first time<br />
$( '#question' + qID + ' td.answer input.radio' ).click(function (event) {<br />
<br />
if ($(this).parents('tr:eq(0)').attr('name') != 'clickedRow') {<br />
addRow();<br />
$(this).parents('tr:eq(0)').attr('name', 'clickedRow');<br />
}<br />
<br />
// The original function of the click event<br />
checkconditions(this.value, this.name, this.type);<br />
});<br />
<br />
// Add another row when an table cell is clicked for the first time<br />
$( '#question' + qID + ' table.question tbody td' ).click(function (event) {<br />
<br />
if ($(this).parents('tr:eq(0)').attr('name') != 'clickedRow') {<br />
addRow();<br />
$(this).parents('tr:eq(0)').attr('name', 'clickedRow');<br />
}<br />
});<br />
<br />
// Function to add a row<br />
function addRow() {<br />
$( arrayRow + '[name="hidden"]:first' ).attr('name', 'visible').show();<br />
}<br />
}<br />
<br />
// Call the function with a question ID<br />
expandingArray(QQ);<br />
<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - Multiple Options & List (radio) questions - ENHANCED=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows the answers of Multiple Options & List (radio) questions to be randomized while always keeping as many answers at the end of the list as specified by the var insertitems=n, where n is the number of answers you want left unrandomized. It's useful if you want to randomize, say, the first 4 of your answers but always have the 5th to 7th displayed last as in the image below (assuming you assigned the number 3 to insertitems):<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
Some conditions on the use of this are:<br />
*For Select/radio type questions it will only work if the [[Optional settings#Survey Behavior|$shownoanswer option]] is set to 0 in config.php. ("No answer" is removed from the end of questions)<br />
*You must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more Multiple Options or List (radio) questions with sequential response codes. Set the [[Advanced question settings#random order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Set var insertitems=n (n = the number of items you want un-randomized)<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRand(11111, 22, 1); partRand(11111, 22, 2); ...)<br />
<br />
Onload code:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers except the last one in Multiple options and List/radio questions<br />
<br />
function partRand(sID, gID, qID) {<br />
<br />
//var to define how many lists to be added at the end<br />
<br />
var insertitems=3;<br />
<br />
// Find the number of answers<br />
<br />
var ansCount = ''<br />
<br />
lastitems=new Array();<br />
<br />
var liid=new Array();<br />
<br />
var $ul;<br />
<br />
var j=0;<br />
<br />
$( '#question' + qID + ' td.answer li' ).each(function(i) {<br />
<br />
ansCount = (i + 1);<br />
<br />
});<br />
<br />
$( '#question' + qID + ' td.answer li' ).each(function(i) {<br />
<br />
if(i>ansCount-(insertitems+1)){<br />
<br />
lastitems[j]=$(this).html();<br />
<br />
liid[j]=$(this).attr("id");<br />
<br />
j++;<br />
<br />
$(this).remove();<br />
<br />
}<br />
<br />
});<br />
<br />
$( '#question' + qID + ' td.answer li' ).each(function(i) {<br />
<br />
// get current ul<br />
<br />
$ul = $(this).parent();<br />
<br />
// get array of list items in current ul<br />
<br />
var $liArr = $ul.children('li');<br />
<br />
// sort array of list items in current ul randomly<br />
<br />
$liArr.sort(function(a,b){<br />
<br />
// Get a random number between 0 and 100<br />
<br />
var temp = parseInt( Math.random()*100 );<br />
<br />
// Get 1 or 0, whether temp is odd or even<br />
<br />
var isOddOrEven = temp%2;<br />
<br />
// Get +1 or -1, whether temp greater or smaller than 5<br />
<br />
var isPosOrNeg = temp>5 ? 1 : -1;<br />
<br />
// Return -1, 0, or +1<br />
<br />
return( isOddOrEven*isPosOrNeg );<br />
<br />
})<br />
<br />
// append list items to ul<br />
<br />
.appendTo($ul);<br />
<br />
});<br />
<br />
$.each(lastitems,function(i){<br />
<br />
$( $ul ).append("<li id="+liid[i]+">"+this+"</li>");<br />
<br />
});<br />
<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
<br />
partRand(SSSSS, GG, QQ);<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - Multiple Options & List (radio) questions=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows the answers of Multiple Options & List (radio) questions to be randomized while always keeping one answer at the end of the list. It's useful if you want to randomize, say, the first 4 of your answers but always have the fifth displayed last as in the image below:<br />
<br />
[[File:random_336x179gif.gif]]<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=89344&newtest=Y&lang=en here].<br />
<br />
Some conditions on the use of this are:<br />
*For Select/radio type questions it will only work if the [[Optional settings#Survey Behavior|$shownoanswer option]] is set to 0 in config.php. ("No answer" is removed from the end of questions)<br />
*You must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more Multiple Options or List (radio) questions with sequential response codes. Set the [[Advanced question settings#random_order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRand(11111, 22, 1); partRand(11111, 22, 2); ...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers except the last one in Multiple options and List/radio questions<br />
function partRand(sID, gID, qID) {<br />
<br />
// Find the number of answers<br />
var ansCount = ''<br />
$( 'div#question' + qID + ' td.answer li' ).each(function(i) {<br />
ansCount = (i + 1);<br />
});<br />
<br />
// Place the last answer created at the end of the list<br />
$( 'input#answer' + sID + 'X' + gID + 'X' + qID + ansCount + '' ).parent().appendTo($( '#question' + qID + ' td.answer ul' ));<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
partRand(SSSSS, GG, QQ);<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - List (dropdown) questions=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround, similar to the one above, allows the answers of List (dropdown) questions to be randomized while always keeping one answer at the end of the list. It's useful if you want to randomize, say, the first 4 of your answers but always have the fifth displayed last.<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=89344&newtest=Y&lang=en here].<br />
<br />
A condition is that you must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more List (dropdown) questions with sequential response codes. Set the [[Advanced question settings#random order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRandDD(11111, 22, 1); partRandDD(11111, 22, 2); ...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers<br />
//except the last one in List/dropdown questions<br />
function partRandDD(sID, gID, qID) {<br />
<br />
// Find the number of answers<br />
var ansCount = ''<br />
$( 'div#question' + qID + ' select option' ).each(function(i) {<br />
ansCount = i;<br />
});<br />
<br />
// Place the last answer created at the end of the list<br />
$( 'option[value="' + ansCount + '"]' ).appendTo($( 'div#question' + qID + ' select' ));<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
partRandDD(89344, 72, 244);<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - Multiple numerical input=<br />
<br />
''Tested with: 1.90+, Safari 5.1''<br />
<br />
This workaround, similar to the ones above, allows the answers of Multiple numerical input questions to be randomized while always keeping one answer at the end of the list. It's useful if you want to randomize, say, the first 4 of your answers but always have the fifth displayed last.<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
A condition is that you must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more Multiple numerical input question with sequential response codes. Set the [[Advanced question settings#random order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRandDD(11111, 22, 1); partRandDD(11111, 22, 2); ...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers except the last one in multiple numeric input questions<br />
function partRand(sID, gID, qID) {<br />
<br />
// Find the number of answers<br />
var ansCount = ''<br />
$( 'div#question' + qID + ' div.answers li' ).each(function(i) {<br />
ansCount = (i - 1);<br />
});<br />
<br />
// Place the last answer created at the end of the list - but before the first helping sum<br />
$( 'li#javatbd' + sID + 'X' + gID + 'X' + qID + ansCount + '' ).insertBefore($( 'div#question' + qID + ' div.answers li.multiplenumerichelp' ).first());<br />
<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
partRand(SID, GID, QID);<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
Using this solution for Multiple numerical input questions might be a bit more complicated than for other question types. All answers are organized in an unordered list (<nowiki><ul></nowiki>) structure. However, if advanced question settings like ''Equals sum value'' are used, LimeSurvey adds helping information (e.g. sum of all entries and remainder) to the same unordered list using the class ''multiplenumerichelp'' for these additional list items. The above example assumes that at least one of these list items is present and moves the last answer to the position right above the first helper item. Without such advanced settings, the code will most certainly need adaptation.<br />
<br />
=Making one (or more) rows of an array mandatory=<br />
<br />
''Tested with: 1.90+, IE 6/7, Firefox 3.0, Safari 3.2''<br />
<br />
This workaround allows you to define one or more rows of an array question as mandatory (instead of all of them which the "Mandatory" question setting does). It is [http://www.partnersinc.biz/surveys//index.php?sid=26842&newtest=Y&lang=en demonstrated here].<br />
<br />
A JavaScript function interrupts the submit function and checks if the inputs in the mandatory row(s) are populated. If not, an alert is popped up, the offending inputs are turned pink and the submit is aborted. Otherwise the submit goes ahead.<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions (see [[Optional settings#Security|documentation here]]).<br />
#Create the array question.<br />
#In the source of the array question add the following script (see [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]]).<br />
#Modify the warningText (line10)as required.<br />
#Replace "QQ" (lines 13 and 14) with the question ID and add calls as necessary for more rows - the example code renders rows 1 and 3 mandatory.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function () {<br />
<br />
// Interrupt the submit function<br />
$('form#limesurvey').submit(function () {<br />
<br />
// Override the built-in "disable navigation buttons" feature<br />
$('#moveprevbtn, #movenextbtn, #movesubmitbtn').attr('disabled', '');<br />
<br />
var empty = 0;<br />
var warningText = 'Please complete the highlighted inputs.';<br />
<br />
// Call the mandatory row function with question IDs and row numbers<br />
mandatoryRow(QQ, 1);<br />
mandatoryRow(QQ, 3);<br />
<br />
// A function to render rows of an array mandatory<br />
function mandatoryRow(qID, rowNum) {<br />
<br />
$('div#question' + qID + ' table.question tbody[id</div>="javatbd"]:eq(' + Number(rowNum - 1) + ') input[type="text"]').each(function (i) {<br />
<br />
if ($(this).val() == '') {<br />
$(this).css('background-color', 'pink');<br />
empty = 1;<br />
} <br />
else {<br />
$(this).css('background-color', '#FFFFFF');<br />
}<br />
});<br />
}<br />
<br />
if (empty == 1) {<br />
alert(warningText);<br />
return false;<br />
} <br />
else {<br />
return true;<br />
}<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Randomly displaying one of a few YouTube videos, and recording which was displayed=<br />
<br />
''Tested in 1.85+''<br />
<br />
Jason Cleeland has created and documented a method to randomly display one of a number of youtube videos in a single question, and save which one was displayed.<br />
<br />
http://www.aptigence.com.au/home/archives/23-Random-display-of-videos-in-a-question-2-YouTube.html<br />
<br />
=Randomly displaying one of a few pictures, and recording which was displayed=<br />
<br />
''Tested in 1.91+''<br />
<br />
The following steps allow you to randomly display one of a few pictures and record in the dataset which picture was displayed. We use four pictures in this example, but you can easily adapt these scripts according to your needs.<br />
<br />
1. Create a new sub-directory '''pic''' in your LimeSurvey folder.<br />
<br />
2. Copy four pictures (named ''1.jpg'', ''2.jpg'', ''3.jpg'', and ''4.jpg'') in this pic sub-directory.<br />
<br />
3. Deactivate the ''Filter HTML for XSS'' function in LimeSurvey's ''Global Settings''.<br />
<br />
4. Create a '''Short free text''' question where you want these pictures to be displayed.<br />
<br />
5. Figure out the [[SGQA identifier|SGQA Identifier]] of this question (e.g., 12345X67X89).<br />
<br />
6. Paste the following code as question text after activating the editor's ''Source'' view and replace both SSSSSXGGXQQ strings with your SGQA identifier:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
Please have a look at this picture:<br />
<br />
<br /><br />
<br />
<script><br />
<br />
$(document).ready(<br />
<br />
function(){<br />
<br />
// Find a random number (here between 1 and 4)<br />
<br />
var randNumber = Math.floor(Math.random()*4 + 1);<br />
<br />
// Save the number as answer of this question<br />
<br />
$('input#answerSSSSSXGGXQQ').val(randNumber);<br />
<br />
// Hide this answer field<br />
<br />
document.getElementById("answerSSSSSXGGXQQ").style.display='none';<br />
<br />
// Show the picture<br />
<br />
picString = '<img src="pic/' + String(randNumber) + '.jpg">';<br />
<br />
document.getElementById('pic').innerHTML = picString;<br />
<br />
}<br />
<br />
);</script><br />
<br />
<p><br />
<br />
</p><br />
<br />
<div id="pic"><br />
<br />
</div><br />
<br />
</syntaxhighlight><br />
<br />
If you want to display the number of this picture in a later question, use the following code as question text (don't forget to replace the SSSSSXGGXQQ string acordingly):<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
You saw picture number {INSERTANS:SSSSSXGGXQQ}.<br />
<br />
</syntaxhighlight><br />
<br />
Perhaps you want to display the same picture again in a later question, but a little bit smaller (100px width, 100px height)? Just paste the following code as question text after activating the editor's ''Source'' view, and replace the SSSSSXGGXQQ string acordingly:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
Here you see the picture again: <br><br />
<br />
<script><br />
<br />
$(document).ready(<br />
<br />
function(){<br />
<br />
// Get the picture number from previous question<br />
<br />
var randNumber = "{INSERTANS:SSSSSXGGXQQ}";<br />
<br />
// Show picture<br />
<br />
picString = '<img width="100" height="100" src="pic/' + String(randNumber) + '.jpg">';<br />
<br />
document.getElementById('pic').innerHTML = picString;<br />
<br />
}<br />
<br />
);</script><br />
<br />
<div id="pic"><br />
<br />
</div><br />
<br />
</syntaxhighlight><br />
<br />
=Multiple numerical input with max_num_value defined in token (personalized limit)=<br />
<br />
''Tested in 1.85+''<br />
<br />
<div class="simplebox">As of version 1.92, max_num_value can be an experession, so you can simply enter the {TOKEN} or other variable in that question attribute.</div><br />
<br />
To make personalized survey with multiple numerical input when max_num_value (Maximum sum value) is different for each user and is loaded from the token use following tricks:<br />
*Create 1st group with numerical input field (1000X10X11). "Limit"<br />
*Add java script into this question:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
function Custom_On_Load(){<br />
<br />
document.getElementById('answer1000X10X11').value='{TOKEN:ATTRIBUTE_1}';<br />
<br />
document.getElementById('answer1000X10X11').readOnly=1;<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
where:<br />
<br />
TOKEN:ATTRIBUTE_1 is individual limit defined in token.<br />
<br />
readOnly=1 // user shouldn't change it.<br />
*Create 2nd group with multiple numerical input and add "Max value from SGQA" with 1000X10X11 as argument.<br />
<br />
Note: If you don't want to show first field with numerical input (and show definied limit in different way) you can add 2 lines to above script to hide whole question:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
document.getElementById('question85').style.display='none';<br />
<br />
document.getElementById('display85').value='';<br />
<br />
</syntaxhighlight><br />
<br />
where:<br />
<br />
question85 and display85 are field names.<br />
<br />
Note: It's no possible to create it into one group, because all SGQA references can only refer to data on a previous page because when clicking next the answer is stored at the DB and the SGQA is replaced by querying the database.<br />
<br />
=Default values in array questions=<br />
<br />
''Tested with: 1.87+ (7557), IE 6/7, Firefox 3.5, Safari 3.2''<br />
<br />
<div class="simplebox">As of Version 1.92, many more question types support default values.</div><br />
<br />
This workaround uses JavaScript to allow you to pre-check default answers in all sub-questions of an array type question. You can select a column of the array to be checked as the page loads. The script first checks to see if a sub-question has already been answered and, if not, checks the default answer.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use script]].<br />
#Create the array question.<br />
#In the source of the array question add the following script.<br />
#Replace"QQ" with the question ID and "CC" with the column number to be checked.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// A function to pre-check a column of an array<br />
<br />
function checkedDefault(qID, column) {<br />
<br />
var checkedCol = column - 1;<br />
<br />
$('#question' + qID + ' table.question tbody tr').each(function(i) {<br />
<br />
if ($('input.radio[checked=true]', this).length == 0) {<br />
<br />
$('input.radio:eq(' + checkedCol + ')', this).attr('checked', true);<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
// Call the function with a question ID and column number<br />
<br />
checkedDefault(QQ, CC);<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Record group view time=<br />
<br />
''Tested with: 1.87+ (8518), IE 6/7, Firefox 3.5, Safari 3.2''<br />
<br />
<div class="simplebox">As of version 1.92, group view time is accurately recorded in the timings table if you choose the Record Timings survey option.</div><br />
<br />
This workaround uses JavaScript to populate a hidden question with the total time that a respondent views a group. If used in a group with only one question, it could be used to track the amount of time required to answer the question.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#In the group, create a short-text question. We will hide this later with JavaScript and populate it with the elapsed time.<br />
#Place the following script in the source of the short-text question.<br />
#Replace "QQ" in line 6 with the ID of the short-text question.<br />
<br />
The script populates the hidden question with the elapsed time since the group was opened. If a respondent leaves the group and then returns, the timer continues up from the elapsed time of the last visit.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function(){<br />
<br />
// call the functions with the hidden timer question ID<br />
<br />
runTimer(QQ);<br />
<br />
function runTimer(timeQID) {<br />
<br />
$('#question'+timeQID).hide();<br />
<br />
var initSec = '0';<br />
<br />
// Check for elapsed time from previous visits<br />
<br />
if ($('#question'+timeQID+' input.text').val()) {<br />
<br />
var initTime = $('#question'+timeQID+' input.text').val();<br />
<br />
initTimeArr = initTime.split(':');<br />
<br />
initSec = Number[[initTimeArr[0]*3600]]+Number[[initTimeArr[1]*60]]+Number(initTimeArr[2]);<br />
<br />
}<br />
<br />
// Run the timer update function<br />
<br />
recordTime(initSec, timeQID);<br />
<br />
}<br />
<br />
});<br />
<br />
// Timer update function<br />
<br />
function recordTime(elapsedSec, timeQID){<br />
<br />
elapsedSec++;<br />
<br />
var h = Math.floor(elapsedSec / 3600);<br />
<br />
var m = Math.floor(elapsedSec % 3600 / 60);<br />
<br />
var s = Math.floor(elapsedSec % 3600 % 60);<br />
<br />
var elapsedTime = [[h > 0 ? h + ":" : "00:") + (m > 0 ? (m < 10 ? "0" : "") + m + ":" : "00:") + (s < 10 ? "0" : "") + s);<br />
<br />
$('#question'+timeQID+' input.text').val(elapsedTime);<br />
<br />
// Run the timer update function every second<br />
<br />
setTimeout('recordTime('+elapsedSec+', '+timeQID+')',1000);<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Toggle visibility of groups=<br />
<br />
''Tested with: 1.90+, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
This workaround uses JavaScript to toggle the visibility of groups in an "all in one" survey. Initially the groups are hidden and there are links inserted to display the groups. It's useful to avoid the page being cluttered with many groups and lets the respondent focus on one at a time.<br />
<br />
It's [http://www.partnersinc.biz/surveys//index.php?sid=33613&newtest=Y&lang=en demonstrated here].<br />
<br />
Implementation is as follows:<br />
<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Set the survey to run in "all in one" mode.<br />
#Add your groups and questions.<br />
#Place the following script in the source of one of the questions in the first group.<br />
<br />
<br />
The comments in the script are pretty self-explanatory but it does the following:<br />
<br />
#initially hides all of the groups<br />
#inserts a link above each one to toggle its display<br />
#some styles are added to the clickable links but these could be done in template.css instead<br />
#shows any groups that have an unanswered mandatory after a submit attempt<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function(){<br />
<br />
// Insert show/hide divs before all group wrapper divs<br />
$('<div class="groupToggler"><span></span></div>').insertBefore('div[id^="group-"]');<br />
<br />
// Add some text to the show/hide divs<br />
$('.groupToggler span').each(function(i) {<br />
($( this ).text('Show/Hide Group '+(i+1)+''));<br />
});<br />
<br />
// Add some styles to the show/hide divs<br />
$('.groupToggler').css({<br />
'padding':'5px 0 10px 0',<br />
'text-align':'center'<br />
});<br />
$('.groupToggler span').css({<br />
'text-decoration':'underline', <br />
'cursor':'pointer'<br />
});<br />
<br />
// Add some hover effects to the show/hide divs<br />
$(".groupToggler span").hover(<br />
function () {<br />
$(this).css({<br />
'text-decoration':'none',<br />
'font-weight':'bold'<br />
});<br />
}, <br />
function () {<br />
$(this).css({<br />
'text-decoration':'underline',<br />
'font-weight':'normal'<br />
});<br />
}<br />
);<br />
<br />
// Initially hide all of the groups<br />
// Toggle their visibility when the show/hide is clicked<br />
$('.groupToggler span').click(function() {<br />
$(this).parent().next().toggle();<br />
return false;<br />
}).parent().next().hide();<br />
<br />
// Display any groups that have unanswered mandatories<br />
$('.errormandatory').parents('div[id^="group-"]').show();<br />
<br />
// Some tidying up<br />
$('h1').next().next().hide();<br />
$('.surveywelcome').css({'margin-bottom':'10px'});<br />
$('.surveywelcome').next().hide();<br />
$('.surveywelcome').next().next().hide();<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Use jQuery Autocomplete plugin to suggest answers for text inputs=<br />
<br />
== 1.90 and previous versions==<br />
<br />
''Tested with: 1.90+, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
This workaround uses the [http://docs.jquery.com/Plugins/Autocomplete jQuery Autocomplete] plugin to provide a respondent a list of suggested answers that the they can select from as they type in a text input.<br />
<br />
Although the plugin allows for much more complex applications, the two that I use most frequently are outlined below. The first method uses a relatively small list of suggestions that is stored in an array locally. The second is a little more complex - it uses a remote CSV file of suggestions that is accessed through AJAX an PHP.<br />
<br />
I've put together a small demonstration [http://www.partnersinc.biz/surveys//index.php?sid=78611&newtest=Y&lang=en here] and implementation is as follows.<br />
<br />
'''Both methods:'''<br />
*[http://docs.jquery.com/Plugins/Autocomplete Download the plugin]<br />
*Place the files ''jquery.autocomplete.css'' and ''jquery.autocomplete.js'' in your template directory<br />
*Add the following code inside the <head> element of startpage.pstpl<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}jquery.autocomplete.js"></script><br />
<link rel="stylesheet" type="text/css" href="{TEMPLATEURL}jquery.autocomplete.css" /></syntaxhighlight><br />
<br />
'''Method 1 ("States" question in the demo):'''<br />
*Create a text input question<br />
*Add the following script to the source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace the states with your list of suggestions (comma separated)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var q1ID = QQ;<br />
<br />
var states = "Alabama,Alaska,Arizona,Arkansas,California,Colorado,Connecticut,Delaware, District of Columbia,Florida,Georgia,Hawaii,Idaho,Illinois,Indiana,Iowa,Kansas,Kentucky, Louisiana,Maine,Montana,Nebraska,Nevada,New Hampshire,New Jersey,New Mexico,New York, North Carolina,North Dakota,Ohio,Oklahoma,Oregon,Maryland,Massachusetts,Michigan, Minnesota,Mississippi,Missouri,Pennsylvania,Rhode Island,South Carolina,South Dakota, Tennessee,Texas,Utah,Vermont,Virginia,Washington,West Virginia,Wisconsin,Wyoming".split(',');<br />
<br />
$('#question'+q1ID+' input.text').autocomplete(states, {<br />
matchContains: true,<br />
minChars: 0<br />
});<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Method 2 ("Countries" question in the demo):'''<br />
*Place the CSV file of suggestions in your template directory. <br />
*Place a PHP file containing the code below in your template directory<br />
*Replace "countries2.csv" with your CSV filename (you could make this more universal by passing the filename in the URL)<br />
*This file will grab the contents of the CSV and encode them in JSON format that the JavaScript can use<br />
*Place the JavaScript code below in ths source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace "templates/yourTemplate/countries.php" with the path to the PHP file (from LimeSurvey root)<br />
*This script will grab the jsonized data from the PHP file and load it into an array that the plugin can use<br />
<br />
PHP code:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><?php<br />
<br />
$countriesArr = array();<br />
<br />
$file_handle = fopen("countries2.csv", "r");<br />
<br />
while (!feof($file_handle) ) {<br />
$line_of_text = fgetcsv($file_handle);<br />
array_push($countriesArr, $line_of_text[0]);<br />
}<br />
<br />
fclose($file_handle);<br />
<br />
echo json_encode($countriesArr);<br />
<br />
?></syntaxhighlight><br />
<br />
JavaScript code:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var qID = QQ;<br />
var url = "templates/yourTemplate/countries.php";<br />
var countriesArr = new Array();<br />
<br />
$.getJSON(url,function(data){<br />
<br />
$(data).each(function(i, item){<br />
countriesArr.push(item);<br />
});<br />
<br />
$('#question'+qID+' input.text').autocomplete(countriesArr, {<br />
matchContains: true,<br />
minChars: 0<br />
});<br />
});<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
== 1.91 and later versions==<br />
<br />
''Tested with: 1.91+, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
This workaround uses the [http://jqueryui.com/demos/autocomplete/ Autocomplete widget] included with jQuery UI to provide a respondent a list of suggested answers that the they can select from as they type in a text input.<br />
<br />
Although the plugin allows for much more complex applications, the two that I use most frequently are outlined below. The first method uses a relatively small list of suggestions that is stored in an array locally. The second is a little more complex - it uses a remote CSV file of suggestions that is accessed through AJAX an PHP.<br />
<br />
'''Both methods:'''<br />
*Add the following styles to the end of your 'template.css' file<br />
<br />
<syntaxhighlight lang="css" enclose="div">/* Autocomplete styles */<br />
<br />
ul.ui-autocomplete {<br />
width: 250px !important;<br />
padding: 5px 10px;<br />
list-style: none;<br />
}</syntaxhighlight><br />
<br />
'''Method 1 (use local JavaScript array for data):'''<br />
*Create a text input question<br />
*Add the following script to the source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace the states with your list of suggestions (comma separated)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var q1ID = QQ;<br />
<br />
var states = "Alabama,Alaska,Arizona,Arkansas,California,Colorado,Connecticut,Delaware, District of Columbia,Florida,Georgia,Hawaii,Idaho,Illinois,Indiana,Iowa,Kansas,Kentucky, Louisiana,Maine,Montana,Nebraska,Nevada,New Hampshire,New Jersey,New Mexico,New York, North Carolina,North Dakota,Ohio,Oklahoma,Oregon,Maryland,Massachusetts,Michigan, Minnesota,Mississippi,Missouri,Pennsylvania,Rhode Island,South Carolina,South Dakota, Tennessee,Texas,Utah,Vermont,Virginia,Washington,West Virginia,Wisconsin,Wyoming".split(',');<br />
<br />
$('#question'+q1ID+' input.text').autocomplete({<br />
source: states<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Method 2 (use remote CSV file for data):'''<br />
*Place the CSV file of suggestions in your template directory<br />
*Place a PHP file containing the code below in your template directory<br />
*Replace "countries2.csv" with your CSV filename (you could make this more universal by passing the filename in the URL)<br />
*This file will grab the contents of the CSV and encode them in JSON format that the JavaScript can use<br />
*Place the JavaScript code below in ths source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace "templates/yourTemplate/countries.php" with the path to the PHP file (from LimeSurvey root)<br />
*This script will grab the jsonized data from the PHP file and load it into an array that the plugin can use<br />
<br />
PHP code:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><?php<br />
<br />
$countriesArr = array();<br />
<br />
$file_handle = fopen("countries2.csv", "r");<br />
<br />
while (!feof($file_handle) ) {<br />
$line_of_text = fgetcsv($file_handle);<br />
array_push($countriesArr, $line_of_text[0]);<br />
}<br />
<br />
fclose($file_handle);<br />
<br />
echo json_encode($countriesArr);<br />
<br />
?></syntaxhighlight><br />
<br />
JavaScript code:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var qID = QQ;<br />
var url = "templates/yourTemplate/countries.php";<br />
var dataArr = [];<br />
<br />
$.getJSON(url,function(data){<br />
<br />
$.each(data,function(i, item){<br />
dataArr.push(item);<br />
});<br />
<br />
$('#question'+qID+' input.text').autocomplete({<br />
source: dataArr<br />
});<br />
<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
== Use autocomplete to populate several fields==<br />
<br />
''Tested with: 1.91+, IE 7/8/9, Firefox 18''<br />
<br />
This workaround uses the [http://jqueryui.com/demos/autocomplete/ Autocomplete widget] included with jQuery UI and the [https://code.google.com/p/jquery-csv/source/browse/jquery.csv.js?r=f13189b2550a770ccaa777f1d747bc860b943fe7 jquery.csv.js] plugin to provide a respondent with a list of suggested answers as they type in a text input and then to automatically populate other fields depending on the selection.<br />
<br />
For example, if you have 3 questions - "Name", "ID" and "Email" - you can use this workaround to autocomplete the "Name" question and then the "ID" and "Email" questions can be automatically populated with values associated with the selected name.<br />
*Download the [https://code.google.com/p/jquery-csv/source/browse/jquery.csv.js?r=f13189b2550a770ccaa777f1d747bc860b943fe7 jquery.csv.js] plugin and place it in your template folder<br />
*If using LimeSurvey 1.9x, add the following line to your startpage.pstpl BEFORE the tag for template.js, if using 2.x, add it AFTER the {TEMPLATEJS} placeholder<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}jquery.csv.js"></script></syntaxhighlight><br />
*Create your CSV file with 3 columns (name, ID, email) as in this example and place it in your template folder<syntaxhighlight lang="php" enclose="div">Bob, Bob's ID, Bob's email<br />
<br />
Andy, Andy's ID, Andy's email<br />
<br />
Sam, Sam's ID, Sam's email<br />
<br />
Tony, Tony's ID, Tony's email<br />
<br />
Fred, Fred's ID, Fred's email</syntaxhighlight><br />
*Create your 3 questions - "Name", "ID" and "Email". They must be in the same group/page.<br />
*Add the following styles to the end of your 'template.css' file<syntaxhighlight lang="php" enclose="div">/* Autocomplete styles */<br />
<br />
ul.ui-autocomplete {<br />
<br />
width: 250px !important;<br />
<br />
padding: 5px 10px;<br />
<br />
list-style: none;<br />
<br />
}</syntaxhighlight><br />
*Add the following script to the source of one of the questions<br />
*Replace:<br />
**"NN" with the "Name" question ID<br />
**"II" with the "ID" question ID<br />
**"EE" with the "Email" question ID<br />
*Modify the path to your CSV file<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var qNameID = NN;<br />
<br />
var qIDID = II;<br />
<br />
var qEmailID = EE;<br />
<br />
var url = "upload/templates/yourTemplate/yourCsvFile.csv";<br />
<br />
// Create an array to hold the names<br />
var namesArr = new Array();<br />
<br />
// Grab the CSV contents<br />
$.get(url,function(data){<br />
<br />
// Convert CSV contents to an array of arrays<br />
fullArray = $.csv.toArrays(data);<br />
<br />
// Load the names array<br />
$(fullArray).each(function(i, item){<br />
namesArr.push(item[0]);<br />
});<br />
<br />
// Initialise the autocomplete plugin<br />
$('#question'+qNameID+' input.text').autocomplete({<br />
source: namesArr,<br />
// Event fired when a selection is made (ui.item.value refers to the selected item)<br />
select: function(event, ui) {<br />
// Find the "ID" and "Email" values associated with the selected name value and load those questions<br />
$(fullArray).each(function(i, item){<br />
if(item[0] == ui.item.value) {<br />
// The value from column 2 of the CSV<br />
$('#question'+qIDID+' input.text').val(item[1]);<br />
// The value from column 3 of the CSV<br />
$('#question'+qEmailID+' input.text').val(item[2]);<br />
}<br />
});<br />
}<br />
});<br />
});<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Drag and Drop Rankings {{Deprecated|2.0}} =<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }} <br />
<br />
==Drag and Drop Ranking - Version 1.90 to 1.92==<br />
<br />
''Tested with: 1.90+ & 1.91RC4, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }} <br />
<br />
This workaround is a modification of the workaround below and also uses [http://jqueryui.com/demos/sortable/#connect-lists JQuery connected sortables]. Thanks to the author of that workaround.<br />
<br />
[[File:Untitled-12.png]]<br />
<br />
Modifications include:<br />
*Allow for multiple drag-n-drop ranking questions on a page<br />
*Handle minimum and maximum answers settings<br />
*Allow double clicking of items to add or remove them from the ranking list<br />
*Work with the new shipped jQuery UI<br />
<br />
There is a '''[http://www.partnersinc.biz/surveys//index.php?sid=36981&newtest=Y&lang=en demonstrated here]'''.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the large script below in your template.js file.<br />
#Place the small script below in the source a ranking question, (this applies the "dragDropRank" function to the question). Replace "QQ" with the ranking [http://docs.limesurvey.org/SGQA+identifier&structure;=English+Instructions+for+LimeSurvey#General_Description question ID].<br />
**Note: the LimeSurvey translations will be automatically used for the "Choices" and "Rankings" header labels but can be overridden with custom labels - see the example calls below.<br />
#Insert the CSS below at the end of template.css (these styles are for the default template).<br />
<br />
NOTE: I have not tested this workaround with conditions.<br />
<br />
'''Code for template.js:'''<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
function dragDropRank(qID, choiceText, rankText) {<br />
<br />
if(!choiceText) {<br />
choiceText = $('#question'+qID+' td.label label').text();<br />
}<br />
if(!rankText) {<br />
rankText = $('#question'+qID+' td.output tr:first td:eq(1)').text();<br />
}<br />
<br />
//Add a class to the question<br />
$('#question'+qID+'').addClass('dragDropRanking');<br />
<br />
// Hide the original question in LimeSurvey (so that we can replace with drag and drop)<br />
$('#question'+qID+' .rank, #question'+qID+' .questionhelp').hide();<br />
<br />
// Turn off display of question (to override error checking built into LimeSurvey ranking question)<br />
//$('#display'+qID).val('off');<br />
<br />
// Add connected sortables elements to the question<br />
var htmlCode = '<table class="dragDropTable"> \<br />
<tbody> \<br />
<tr> \<br />
<td> \<br />
<span class="dragDropHeader choicesLabel">'+choiceText+'</span><br /> \<br />
<div class="ui-state-highlight dragDropChoices"> \<br />
<ul id="sortable1'+qID+'" class="connectedSortable'+qID+' dragDropChoiceList"> \<br />
<li>Choices</li> \<br />
</ul> \<br />
</div> \<br />
</td> \<br />
<td> \<br />
<span class="dragDropHeader rankingLabel">'+rankText+'</span><br /> \<br />
<div class="ui-state-highlight dragDropRanks"> \<br />
<ol id="sortable2'+qID+'" class="connectedSortable'+qID+' dragDropRankList"> \<br />
<li>Ranks</li> \<br />
</ol> \<br />
</div> \<br />
</td> \<br />
</tr> \<br />
</tbody> \<br />
</table>';<br />
$(htmlCode).insertAfter('#question'+qID+' table.rank');<br />
<br />
// Remove placeholder list items (have to have one item so that LimeSurvey doesn"t remove the <ul>)<br />
$('#sortable1'+qID+' li, #sortable2'+qID+' li').remove();<br />
<br />
// Load any previously-set values<br />
loadDragDropRank(qID);<br />
<br />
// Find the number of LimeSurvey ranking inputs ("Maximum answers")<br />
var maxAnswer = $('#question'+qID+' td.output input.text').length;<br />
<br />
// Set up the connected sortable<br />
$('#sortable1'+qID+', #sortable2'+qID+'').sortable({<br />
connectWith: '.connectedSortable'+qID+'',<br />
placeholder: 'ui-sortable-placeholder',<br />
helper: 'clone',<br />
revert: 50,<br />
receive: function(event, ui) {<br />
if($('#sortable2'+qID+' li').length > maxAnswer) {<br />
alert ('You can only rank a maximum of '+maxAnswer+' choices.');<br />
$(ui.sender).sortable('cancel');<br />
}<br />
},<br />
stop: function(event, ui) {<br />
$('#sortable1'+qID+'').sortable('refresh');<br />
$('#sortable2'+qID+'').sortable('refresh');<br />
updateDragDropRank(qID);<br />
}<br />
}).disableSelection();<br />
<br />
// Get the list of choices from the LimeSurvey question and copy them as items into the sortable choices list<br />
$('#CHOICES_' + qID).children().each(function(index, Element) {<br />
var liCode = '<li class="ui-state-default" id="choice_' + $(this).attr("value") + '">' + this.text + '</li>'<br />
$(liCode).appendTo('#sortable1'+qID+'');<br />
});<br />
<br />
// Allow users to double click to move to selections from list to list<br />
$('#sortable1'+qID+' li').live('dblclick', function() {<br />
if($('#sortable2'+qID+' li').length == maxAnswer) {<br />
alert ('You can only rank a maximum of '+maxAnswer+' choices.');<br />
return false;<br />
}<br />
else {<br />
$(this).appendTo('#sortable2'+qID+'');<br />
$('#sortable1'+qID+'').sortable('refresh');<br />
$('#sortable2'+qID+'').sortable('refresh');<br />
updateDragDropRank(qID);<br />
}<br />
});<br />
$('#sortable2'+qID+' li').live('dblclick', function() {<br />
$(this).appendTo('#sortable1'+qID+'');<br />
$('#sortable2'+qID+'').sortable('refresh');<br />
$('#sortable1'+qID+'').sortable('refresh');<br />
updateDragDropRank(qID);<br />
});<br />
}<br />
<br />
// This function copies the drag and drop sortable data into the LimeSurvey ranking list.<br />
function updateDragDropRank(qID) {<br />
<br />
// Reload the LimeSurvey choices select element<br />
var rankees = [];<br />
$('#sortable2'+qID+' li').each(function(index) {<br />
$(this).attr('value', index+1);<br />
<br />
// Get value of ranked item<br />
var liID = $(this).attr("id");<br />
liIDArray = liID.split('_');<br />
<br />
// Save to an array<br />
rankees[rankees.length] = { "r_name":$(this).text(),"r_value":liIDArray[1] };<br />
});<br />
$('#question'+qID+' input[name<div class="simplebox">="RANK_"]').each(function(index) {<br />
if (rankees.length > index) {<br />
$(this).val(rankees[index].r_name);<br />
$(this).next('input').attr('value', rankees[index].r_value);<br />
} else {<br />
$(this).val('');<br />
$(this).next().val('');<br />
}<br />
});<br />
<br />
// Reload the LimeSurvey choices select element (we need this for "Minimum answers" code)<br />
$('#question'+qID+' td.label select option').remove();<br />
$('#sortable1'+qID+' li').each(function(index) {<br />
var liText = $(this).text();<br />
var liID = $(this).attr('id');<br />
liIDArray = liID.split('_');<br />
var optionCode = '<option value="'+liIDArray[1]+'">'+liText+'</option>';<br />
$(optionCode).appendTo('#question'+qID+' td.label select');<br />
});<br />
<br />
// Hack for IE6<br />
if ($.browser.msie && $.browser.version.substr(0,1)<7) {<br />
$('#question'+qID+' select').show();<br />
$('#question'+qID+' select').hide();<br />
}<br />
}<br />
<br />
// This function is called on page load to see if there are any items already ranked (from a previous visit<br />
// or cached due to a page change. If so, the already-ranked items are loaded into the sortable list<br />
function loadDragDropRank(qID) {<br />
<br />
var rankees = [];<br />
<br />
// Loop through each item in the built-in LimeSurvey ranking list looking for non-empty values<br />
$('#question'+qID+' input[name</div>="RANK_"]').each(function(index) {<br />
<br />
// Check to see if the current item has a value<br />
if ($(this).val()) {<br />
<br />
// Item has a value - save to the array<br />
// Use this element to contain the name and the next for the value (numeric)<br />
rankees[rankees.length] = { "r_name":$(this).val(),"r_value":$(this).next().val() };<br />
}<br />
});<br />
<br />
// Now that we have a list of all the pre-ranked items, populate the sortable list<br />
// Note that the items *won"t* appear in the main list because LimeSurvey has removed them.<br />
$.each(rankees, function(index, value) {<br />
<br />
// Create the items in the sortable<br />
var liCode = '<li class="ui-state-default" id="choice_' + value.r_value + '">' + value.r_name + '</li>';<br />
$(liCode).appendTo('#sortable2'+qID+'');<br />
});<br />
}</syntaxhighlight><br />
<br />
'''Code in the source of the question(s) using the LimeSurvey translations for the "Choices" and "Rankings" element header labels''' (replace "QQ" with the ranking [http://docs.limesurvey.org/SGQA+identifier&structure;=English+Instructions+for+LimeSurvey#General_Description question ID]):<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
dragDropRank(QQ);<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Fix for later versions of 1.91+'''<br />
<br />
In my version of LimeSurvey 1.91+, build 11026, this drag-n-drop workaround was not saving the selections properly. I'm not sure if that's because of my template, or other jquery uses, but I fixed it by making the following modifications to the above code placed into template.js.<br />
<br />
If you're having problems (and it's definitely worth testing that the rankings are actually saving into your response table before proceeding with the survey) give this a try.<br />
<br />
In the 'updateDragDropRank(qID)' function, replace the line:<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$('#question'+qID+' input[name<div class="simplebox">="RANK_"]').each(function(index) {<br />
</syntaxhighlight><br />
with:<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$('#question'+qID+' input[name^="RANK_"]').each(function(index) {<br />
</syntaxhighlight><br />
<br />
In the 'loadDragDropRank(qID) function, replace the line:<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$('#question'+qID+' input[name</div>="RANK_"]').each(function(index) {<br />
</syntaxhighlight><br />
with:<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$('#question'+qID+' input[name^="RANK_"]').each(function(index) {<br />
</syntaxhighlight><br />
<br />
<br />
'''Code in the source of the question(s) using custom text for the "Choices" and "Rankings" element header labels''' (replace "QQ" with the ranking [http://docs.limesurvey.org/SGQA+identifier&structure;=English+Instructions+for+LimeSurvey#General_Description question ID]):<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
dragDropRank(QQ, 'Custom Choices Label', 'Custom Rankings Label');<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Styles for template.css:'''<br />
<br />
<syntaxhighlight lang="css" enclose="div"><br />
/* Drag-n-drop ranking styles */<br />
.dragDropTable {<br />
border: 0 none;<br />
border-collapse: collapse;<br />
width: 100%;<br />
}<br />
<br />
.dragDropTable td {<br />
vertical-align: top;<br />
width: 50%;<br />
padding-right: 20px;<br />
}<br />
<br />
.dragDropTable .dragDropHeader {<br />
font-weight: bold;<br />
}<br />
<br />
.dragDropTable .dragDropChoices,<br />
.dragDropTable .dragDropRanks {<br />
margin: 5px 0 0 0;<br />
background: transparent none;<br />
border: 0 none;<br />
}<br />
<br />
.dragDropTable .dragDropChoiceList,<br />
.dragDropTable .dragDropRankList {<br />
float: left;<br />
width: 100%;<br />
min-height: 2.4em;<br />
_height: 2.4em; /* IE6 and below hack */<br />
margin: 0;<br />
padding: 0;<br />
list-style-type: none;<br />
background: #FBFBFB none;<br />
border: 1px solid #CCCCCC;<br />
}<br />
<br />
.dragDropTable .dragDropChoiceList li,<br />
.dragDropTable .dragDropRankList li {<br />
margin: 3px;<br />
*margin-left: -13px; /* IE7 and below */<br />
padding: 3px;<br />
min-height: 1.3em;<br />
_height: 1.3em; /* IE6 and below hack */<br />
font-weight: normal;<br />
cursor: move;<br />
display: block; /* Force the li to full width */<br />
}</syntaxhighlight><br />
<br />
==Drag and Drop Ranking using Images - Version 1.90 to 1.92==<br />
<br />
''Tested with: 1.90+ & 1.91RC4, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }}<br />
<br />
This workaround works in conjunction with the above workaround to allow ranking of images.<br />
<br />
[[File:Untitled-11.png]]<br />
<br />
There is a '''[http://www.partnersinc.biz/surveys//index.php?sid=36981&newtest=Y&lang=en demonstrated here]'''.<br />
<br />
Implementation is as follows:<br />
<br />
1) Follow the above workaround to get basic drag-n-drop functionality in your ranking question.<br />
<br />
2) Insert your images in the ranking question text or help section after any text that you wish to have there (we'll move them later with JavaScript).<br />
<br />
3) Give the images '''EXACTLY''' the same IDs as the answer code you would like them to be associated with:[[File:Untitled-8.png]]<br />
<br />
4) Place the first script below in your template.js file.<br />
<br />
5) Place the second script below in the source the ranking question '''AFTER''' the initial call for the dragDropRank function from the workaround above. Replace "QQ" with the ID of the ranking question (this applies the "dragDropRankImages" function to the question).<br />
<br />
6) Insert the CSS below at the end of template.css. Replace "11" with your question ID. These styles are for the default template using 50x50px images (as in the demo) and may need to be modified for other templates or image sizes.<br />
<br />
'''Code for template.js:'''<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
function dragDropRankImages(qID) {<br />
<br />
$('.connectedSortable'+qID+' li').each(function(i) {<br />
<br />
// Remove any text in the sortable choice or rank items<br />
$(this).text('');<br />
<br />
// Move the images into the appropriate sortable list item<br />
var liID = $(this).attr('id');<br />
liIDArray = liID.split('_');<br />
$('#question'+qID+' img#'+liIDArray[1]+'').appendTo(this);<br />
});<br />
}</syntaxhighlight><br />
<br />
'''Code in the source of the question(s):'''<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
dragDropRankImages(QQ);<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Styles for template.css:'''<br />
<br />
<syntaxhighlight lang="css" enclose="div"><br />
<br />
/* Drag-n-drop for ranking images */<br />
#question11 .dragDropTable {<br />
width: auto;<br />
}<br />
<br />
#question11 .dragDropTable .dragDropChoiceList,<br />
#question11 .dragDropTable .dragDropRankList {<br />
min-height: 60px;<br />
_height: 60px; /* IE6 and below hack */<br />
width: auto;<br />
min-width: 60px;<br />
_width: 60px; /* IE6 and below hack */<br />
}<br />
<br />
#question11 .dragDropTable li {<br />
background: 0 none;<br />
border: 0 none;<br />
height: 50px;<br />
width: 50px;<br />
}<br />
<br />
#question11 .dragDropTable li img {<br />
margin: 0;<br />
padding: 0;<br />
border: 0 none;<br />
}</syntaxhighlight><br />
<br />
==Drag and Drop Ranking for iPad - Version 1.91 and newer==<br />
<br />
''Tested with: LimeSurvey 1.91, iPad 2''<br />
<br />
This workaround extends the above workarounds to work with the touch interface on iPads.<br />
<br />
1) Follow the [[Workarounds: Manipulating a survey at runtime using Javascript#Drag and Drop Ranking - Version 1.90 and newer|Drag and Drop Ranking - Version 1.90 and newer]] workaround above to get basic drag-n-drop functionality in your ranking question.<br />
<br />
2) Download the [https://github.com/furf/jquery-ui-touch-punch jQuery.ui.touch-punch.js plugin] and save it in your template directory.<br />
<br />
3) Replace this line in your startpage.pstpl:<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}template.js"></script></syntaxhighlight>With this:<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}jquery.ui.touch-punch.js"></script><br />
<br />
<script type="text/javascript" src="{TEMPLATEURL}template.js"></script></syntaxhighlight><br />
<br />
==Drag and Drop Ranking - Version 1.86==<br />
<br />
Tested with 1.86 on IE 7,8, FireFox 3, Chrome, and Safari 4<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }}<br />
<br />
This workaround uses [http://jqueryui.com/demos/sortable/#connect-lists JQuery connected sortables] to modify a ranking question and allow the survey taker to drag and drop choices instead of clicking. The nice thing is that the choices can be easily re-arranged or removed from the ranking, all by drag and drop.<br />
<br />
I used it for a voting application and some of the element names reflect that use.<br />
<br />
It looks best when some CSS is added to control the appearance of the boxers around each choice.<br />
<br />
[[File:drag-n-drop.png]]<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
// Question ID global variable<br />
var questionID;<br />
<br />
$(document).ready(function() {<br />
<br />
// Grab the question ID[[File:drag-n-drop.png]]<br />
// This is something with a class of "ranking" and an ID that starts with "questionXXXXX". The X's represent the question ID<br />
var entire_questionID = $(".ranking[id<div class="simplebox">='question']").attr('id');<br />
<br />
// Get just the question number (ID)<br />
var patt=/\d+$/;<br />
questionID=patt.exec(entire_questionID);<br />
<br />
// Hide the original quetion in LimeSurvey (so that we can replace with drag and drop)<br />
$(".rank, .questionhelp").hide();<br />
<br />
// Turn off display of question (to override error checking built into LimeSurvey ranking question)<br />
$("#display"+questionID).val("off");<br />
<br />
// Add connected sortables to the question<br />
var html_code = "<table style='border: medium none ; width: 770px; margin-left: auto; \<br />
margin-right: auto;'><tbody><tr><td style='width: 590px; vertical-align: top;'><h3>List of Candidates:</h3> \<br />
<div class='ui-state-highlight' style='margin: 5px; float: left;' id='ballot_list'> \<br />
<ul id='sortable1' class='connectedSortable'><li>Candidates</li></ul></div></td> \<br />
<td style='vertical-align: top;'><h3>Your selections:</h3><div class='ui-state-highlight' \<br />
style='margin: 5px; float: left;' id='voting_selections'><ol id='sortable2' class='connectedSortable'> \<br />
<li>Voting Area</li></ol></div></td></tr></tbody></table>";<br />
$(html_code).appendTo("#question" + questionID);<br />
<br />
// Remove list items (have to have one item so that LimeSurvey doesn't remove the <ul>)<br />
$("#sortable1 li, #sortable2 li").remove();<br />
<br />
// Load any previously-set values<br />
loadRanking();<br />
<br />
// Load jQuery UI<br />
$.getScript("/scripts/jquery/jquery-ui.js", function() {<br />
<br />
// After JQuery UI finishes loading, set up the connected sortable.<br />
$("#sortable1, #sortable2").sortable({<br />
connectWith: '.connectedSortable',<br />
placeholder: 'ui-sortable-placeholder',<br />
stop: function(event, ui) {<br />
$("#sortable1").sortable("refresh");<br />
$("#sortable2").sortable("refresh");<br />
updateRanking();<br />
}<br />
}).disableSelection();<br />
<br />
// Get the list of candidates from the built-in LimeSurvey question and copy them as items in sortable1<br />
$("#CHOICES_" + questionID).children().each(function(index, Element) {<br />
li_tag = "<li class='ui-state-default' id='choice_" + $(this).attr('value') + "'>" + this.text + "</li>"<br />
$(li_tag).appendTo("#sortable1"); } );<br />
<br />
// Make sure the submit button is showing<br />
$(":submit[value|=' Submit']").show();<br />
<br />
// Show a confirmation alert upon submit<br />
$("form").submit(function() {<br />
<br />
// Override the built-in "disable navigation buttons" feature<br />
$('#moveprevbtn, #movenextbtn, #movesubmitbtn').attr('disabled', '');<br />
var validated = confirm("Cast your ballot now?");<br />
if (validated) { return true; } else { return false; }<br />
});<br />
<br />
// Allow users to double click to move to selection list<br />
$("#sortable1 li").assignDblClick();<br />
}); // End of JQuery UI loading<br />
<br />
}); // End of JQuery ready function<br />
<br />
// Define the actions when an item is double clicked<br />
$.fn.assignDblClick = function() {<br />
$(this).dblclick(function(){<br />
$(this).appendTo('#sortable2');<br />
$("#sortable1").sortable("refresh");<br />
$("#sortable2").sortable("refresh");<br />
updateRanking();<br />
});<br />
}<br />
<br />
// This function copies the drag and drop sortable data into the standard LimeSurvey ranking structure.<br />
function updateRanking() {<br />
var rankees = [];<br />
$('#sortable2 li').each(function(index) {<br />
$(this).attr("value", index+1);<br />
<br />
// Get value of person<br />
li_tag = $(this).attr('id');<br />
li_tag_array = li_tag.split("_");<br />
<br />
// Save to an array<br />
rankees[rankees.length] = { 'r_name':$(this).text(),'r_value':li_tag_array[1] };<br />
});<br />
$("input[name</div>='RANK_']").each(function(index) {<br />
if (rankees.length > index) {<br />
$(this).val(rankees[index].r_name);<br />
$(this).next().val(rankees[index].r_value);<br />
} else {<br />
$(this).val("");<br />
$(this).next().val("");<br />
}<br />
});<br />
<br />
// Re-assign double click action to first list items and remove<br />
// double click action from section list items<br />
$('#sortable1 li').unbind('dblclick').assignDblClick();<br />
$('#sortable2 li').unbind('dblclick');<br />
}<br />
<br />
// This function is called on page load to see if there are any items already ranked (from a previous visit<br />
// or cached due to a page change. If so, the already-ranked items are loaded into the sortable list<br />
function loadRanking() {<br />
var rankees = [];<br />
<br />
// Loop through each item in the built-in LimeSurvey ranking list looking for non-empty values<br />
$("input[name<div class="simplebox">='RANK_']").each(function(index) {<br />
<br />
// Check to see if the current item has a value<br />
if ($(this).val()) {<br />
// Item has a value - save to the array<br />
// Use this element to contain the name and the next for the value (numeric)<br />
rankees[rankees.length] = { 'r_name':$(this).val(),'r_value':$(this).next().val() };<br />
}<br />
});<br />
<br />
// Now that we have a list of all the pre-ranked items, populate the sortable list<br />
// Note that the items *won't* appear in the main list because LimeSurvey has removed them.<br />
$.each(rankees, function(index, value) {<br />
// Create the items in the sortable<br />
li_tag = "<li class='ui-state-default' id='choice_" + value.r_value + "'>" + value.r_name + "</li>";<br />
$(li_tag).appendTo("#sortable2");<br />
});<br />
}</syntaxhighlight><br />
<br />
=Create MaxDiff question type=<br />
<br />
See the [[Workarounds: Question design, layout and templating|Question design, layout and templating]] section for a workaround that uses JavaScript to convert an '''''Array (flexible labels) by column''''' question into a [http://en.wikipedia.org/wiki/MaxDiff MaxDiff] question type.<br />
<br />
[[File:max_diff_596x253.gif]]<br />
<br />
=In a checkbox matrix, have the 'none' option in a row disable all other columns in that row=<br />
<br />
''Tested with: LimeSurvey 1.90+''<br />
<br />
The questionId parameter is the base ID of the question matrix (multiflexible).<br />
<br />
numColumns and numRows speak for themselves<br />
<br />
specialColumns is an array of the columns that have the special ability that when one of them<br />
<br />
is checked, none of the others can be checked. E.g., a 'none of these' and/or a 'do now know' option.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
numColumns=13;<br />
<br />
numRows=18;<br />
<br />
questionId='28417X2X24';<br />
<br />
specialColumns=[1,12,13];<br />
<br />
function action(obj){<br />
<br />
locator=obj.id.replace('cbox_'+questionId, '').split('_');<br />
<br />
row=locator[0];<br />
<br />
column=locator[1];<br />
<br />
//alert('Action for row,column='+row+','+column);<br />
<br />
my_id='#cbox_'+questionId+row+'_'+column+''<br />
<br />
if($(my_id).attr('checked') == false) {<br />
<br />
for( var i=1; i<=numColumns; i++ ) {<br />
<br />
if(i==column) continue;<br />
<br />
id='#cbox_'+questionId+row+'_'+i<br />
<br />
$(id).attr('disabled',false);<br />
<br />
}<br />
<br />
} else {<br />
<br />
for( var i=1; i<=numColumns; i++ ) {<br />
<br />
if(i==column) continue;<br />
<br />
id='#cbox_'+questionId+row+'_'+i<br />
<br />
aid='#answer'+questionId+row+'_'+i<br />
<br />
$(aid).val(0);<br />
<br />
$(id).attr('checked',false);<br />
<br />
$(id).attr('disabled',true);<br />
<br />
}<br />
<br />
}<br />
<br />
}<br />
<br />
function customOnLoad(){<br />
<br />
for( var row=1; row<=numRows; row++ ) {<br />
<br />
for( var k=0; k<specialColumns.length; k++ )<br />
<br />
{<br />
<br />
column=specialColumns[k];<br />
<br />
$('#cbox_'+questionId+row+'_'+column).change(function() {<br />
<br />
action(this);<br />
<br />
});<br />
<br />
}<br />
<br />
}<br />
<br />
}<br />
<br />
jQuery(document).ready(<br />
<br />
function(){<br />
<br />
customOnLoad();<br />
<br />
}<br />
<br />
);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Last Option In Array (Numbers) (Checkboxes) Row Excludes All Others=<br />
<br />
''Tested with: 2.05, IE 7-10, Firefox''<br />
<br />
This workaround uses JavaScript/jQuery to make the last option of each Array (Numbers) (Checkboxes) row exclude all other options in the same row.<br />
<br />
The script will uncheck all options in a row if the last option is checked and uncheck the last option in a row if any other options are checked.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the following script in the source of the array question.<br />
<br />
NOTE: Care should be taken when using this script and conditional questions on the same page.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"> <br />
$(document).ready(function() {<br />
// Call the exclude function using question ID<br />
excludeOpt ({QID});<br />
});<br />
<br />
// A function to make the last option in each array row exclusive<br />
function excludeOpt (qID) {<br />
<br />
var thisQuestion = $('#question'+qID)<br />
<br />
// Add some classes to the checkbox cells<br />
$('table.question tbody td', thisQuestion).addClass('normalOpt');<br />
$('table.question tbody tr', thisQuestion).each(function(i) {<br />
$('.normalOpt:last', this).removeClass('normalOpt').addClass('exlusiveOpt')<br />
});<br />
<br />
// A listener on the checkbox cells<br />
$('table.question tbody td', thisQuestion).click(function (event) {<br />
<br />
// Set some vars<br />
var thisRow = $(this).closest('tr');<br />
<br />
// Uncheck the appropriate boxes in a row<br />
if ($(this).hasClass('normalOpt')) {<br />
$('.exlusiveOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
else {<br />
$('.normalOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
});<br />
<br />
// A listener on the checkboxes<br />
$('table.question tbody td input[type=checkbox]', thisQuestion).click(function (event) {<br />
<br />
// Set some vars<br />
var thisRow = $(this).closest('tr');<br />
var thisCell = $(this).closest('td');<br />
<br />
// Uncheck the appropriate boxes in a row<br />
if ($(thisCell).hasClass('normalOpt')) {<br />
$('.exlusiveOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
else {<br />
$('.normalOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
});<br />
} <br />
</script></syntaxhighlight><br />
<br />
=Add Navigation Buttons (Next and Previous) To Top Of Page=<br />
<br />
''Tested with: 1.90+, IE 7/8, Firefox 3.6, Safari 3.2''<br />
<br />
Add the following to the end of template.js. It will insert a new div after the progress bar and then insert clones of the nav buttons in the new div.<br />
<br />
This example is for the default template in 1.90 or 1.91. The placement of the new div may need to be modified for other templates.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$(document).ready(function() {<br />
<br />
// Insert a new div after the progress bar<br />
$('<div id="navigator2" />').insertAfter('#progress-wrapper');<br />
<br />
// Style the new div<br />
$('#navigator2').css({<br />
'text-align':'center'<br />
});<br />
<br />
// Insert clones of the nav buttons in the new div<br />
$('input.submit:eq(0)').clone().appendTo('#navigator2');<br />
$('input.submit:eq(2)').clone().appendTo('#navigator2');<br />
<br />
// Give the new buttons some new IDs<br />
$('#navigator2 input.submit').each(function(i) {<br />
var oldID = $(this).attr('id');<br />
var newID = oldID + '2';<br />
$(this).attr('id', newID)<br />
});<br />
});</syntaxhighlight><br />
<br />
[[File:extra_buttons.png]]<br />
<br />
=How to ''add'' an opt out link to your survey=<br />
<br />
Tested with: 1.91+, Firefox 5.0<br />
<br />
This javascript inserts a link to opt out of the survey above the progress bar.<br />
<br />
[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]]<br />
<br />
Then insert the following code into to the source of a group description or a question. I used the group description.<br />
<br />
<syntaxhighlight lang="php" enclose="div"> <script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Find the survey ID<br />
if($('input#fieldnames').length != 0) {<br />
var fieldNames = $('input#fieldnames').attr('value');<br />
var tmp = fieldNames.split('X');<br />
var sID = tmp[0];<br />
}<br />
<br />
// Insert a new div after the progress bar<br />
$('<div id="optOutLink" />').insertBefore('#progress-wrapper');<br />
<br />
// Style the new div<br />
$('#optOutLink').css({<br />
'text-align':'center'<br />
});<br />
<br />
// Insert opt out url in the new div<br />
$('#optOutLink').html('<p><a href="optout.php?lang=en&sid;='+sID+'&token;={TOKEN}">Click here to opt out of this survey.</a></p><br>');<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Anonymously track respondents answers across multiple surveys=<br />
<br />
''Tested with: 1.91+ and 1.92+''<br />
<br />
This workaround uses JavaScript/jQuery to enable tracking of respondents across multiple surveys ensuring anonymity (it does not use tokens).<br />
<br />
To do this you have to use this question in all the surveys you want to link respondents answers.<br />
<br />
This workaround create an ID by asking some partial personal information (like initials, birth month ...). The ID will be encrypted using a one-way function (in this case SHA-1) and stored in a short text answer.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the following code in the source of a short text question.<br />
#Optional: you can also add other select field to avoid collisions (e.g. for large population sample)<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<p>This answers are used to generate your ID. These information will be encrypted, it will not be possible in any case to identify you neither from your answers nor from your ID.</p><br />
<br />
<table><br />
<br />
<tr><br />
<br />
<td>Initial of your name</td><br />
<br />
<td><br />
<br />
<select id="field1"><br />
<br />
<option value=""></option><br />
<br />
<option value="A">A</option><br />
<br />
<option value="B">B</option><br />
<br />
<option value="C">C</option><br />
<br />
<option value="D">D</option><br />
<br />
<option value="E">E</option><br />
<br />
<option value="F">F</option><br />
<br />
<option value="G">G</option><br />
<br />
<option value="H">H</option><br />
<br />
<option value="I">I</option><br />
<br />
<option value="J">J</option><br />
<br />
<option value="K">K</option><br />
<br />
<option value="L">L</option><br />
<br />
<option value="M">M</option><br />
<br />
<option value="N">N</option><br />
<br />
<option value="O">O</option><br />
<br />
<option value="P">P</option><br />
<br />
<option value="Q">Q</option><br />
<br />
<option value="R">R</option><br />
<br />
<option value="S">S</option><br />
<br />
<option value="T">T</option><br />
<br />
<option value="U">U</option><br />
<br />
<option value="V">V</option><br />
<br />
<option value="W">W</option><br />
<br />
<option value="X">X</option><br />
<br />
<option value="Y">Y</option><br />
<br />
<option value="Z">Z</option><br />
<br />
</select><br />
<br />
</td><br />
<br />
</tr><br />
<br />
<tr><br />
<br />
<td>Your birth month</td><br />
<br />
<td><br />
<br />
<select id="field2"><br />
<br />
<option value=""></option><br />
<br />
<option value="01">January</option><br />
<br />
<option value="02">February</option><br />
<br />
<option value="03">March</option><br />
<br />
<option value="04">April</option><br />
<br />
<option value="05">May</option><br />
<br />
<option value="06">June</option><br />
<br />
<option value="07">July</option><br />
<br />
<option value="08">August</option><br />
<br />
<option value="09">September</option><br />
<br />
<option value="10">October</option><br />
<br />
<option value="11">November</option><br />
<br />
<option value="12">December</option><br />
<br />
</select><br />
<br />
<td><br />
<br />
</tr><br />
<br />
</table><br />
<br />
<script type="text/javascript" src="http://crypto-js.googlecode.com/svn/tags/3.0.2/build/rollups/sha1.js"></script><br />
<br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
$("#answer{SGQ}").attr('readonly', 'readonly');<br />
<br />
//$("#answer{SGQ}").css('display', 'none'); //uncomment this line for not displaying the code<br />
<br />
});<br />
<br />
$('#field1, #field2').bind('change keyup', function() {<br />
<br />
if ($("#field1").val()=='' || $("#field2").val()=='')<br />
<br />
$("#answer{SGQ}").val('');<br />
<br />
else {<br />
<br />
var sha1 = CryptoJS.algo.SHA1.create();<br />
<br />
sha1.update($("#field1").val());<br />
<br />
sha1.update($("#field2").val());<br />
<br />
// sha1.update($("#otherfield").val());<br />
<br />
var hash = sha1.finalize();<br />
<br />
$("#answer{SGQ}").val(hash);<br />
<br />
}<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Check validity of international phone number in subquestion=<br />
<br />
''Tested with: 1.91+, Firefox 8, Chrome 15''<br />
<br />
As of version 1.92, you can use the core Validation querstion option to validate multiple short text and array text questions. Any question that fails that validation check will have its background color changed to red.<br />
<br />
Note, the below workaround will fail in version 1.92 because it contains a regular expression with curly braces. However, as described above, support for this feature is now built-in to version 1.92<br />
<br />
This workaround uses javascript to check the validity of an international phone number in a subquestion of multiple short text.<br />
<br />
Add the following code to the source of your question.<br />
<br />
Replace "QQ" with the question ID and "NN" with the row number that you want to validate.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Call the phone function with the question ID and the row number<br />
<br />
phoneTest(QQ, NN);<br />
<br />
function phoneTest(qID, inputNum) {<br />
<br />
// Interrupt next/submit function<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
// Some vars - modify as required<br />
<br />
var phoneMatch = /^[0-9,+,(), ,]{1,}(,[0-9]+){0,}$/;<br />
<br />
var msg1 = 'Please enter a valid phone number.';<br />
<br />
// Test the input<br />
<br />
var phoneInput = $('#question'+qID+' li:eq('+(inputNum-1)+') input.text').val();<br />
<br />
if(phoneInput != '' && !phoneMatch.test(phoneInput)) {<br />
<br />
alert(msg1);<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'pink' });<br />
<br />
return false;<br />
<br />
}<br />
<br />
else {<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'' });<br />
<br />
return true;<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
The regex is from: [http://www.regexlib.com/REDetails.aspx?regexp_id=1136 regexlib.com blank]<br />
<br />
=Check validity of email address in subquestion=<br />
<br />
'Tested with: 1.91+, Firefox 8, Chrome 15''<br />
<br />
<div class="simplebox">As of version 1.92, you can use the core Validation querstion option to validate multiple short text and array text questions. Any question that fails that validation check will have its background color changed to red.<br />Note, the below workaround will fail in version 1.92 because it contains a regular expression with curly braces. However, as described above, support for this feature is now built-in to version 1.92</div><br />
<br />
This workaround uses javascript to check the validity of an email address in a subquestion of multiple short text.<br />
<br />
Add the following code to the source of your question.<br />
<br />
Replace "QQ" with the question ID and "NN" with the row number that you want to validate.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Call the email function with the question ID and the row number<br />
<br />
emailTest(QQ, NN);<br />
<br />
function emailTest(qID, inputNum) {<br />
<br />
// Interrupt next/submit function<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
// Some vars - modify as required<br />
<br />
var emailMatch = /^[a-zA-Z0-9\_\-]+[a-zA-Z0-9\.\_\-]*@([a-zA-Z0-9\_\-]+\.)+([a-zA-Z]{2,4}|travel|museum)$/;<br />
<br />
var msg1 = 'Please enter a valid email address.';<br />
<br />
// Test the input<br />
<br />
var emailInput = $('#question'+qID+' li:eq('+(inputNum-1)+') input.text').val();<br />
<br />
if(emailInput != '' && !emailMatch.test(emailInput)) {<br />
<br />
alert(msg1);<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'pink' });<br />
<br />
return false;<br />
<br />
}<br />
<br />
else {<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'' });<br />
<br />
return true;<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
The regex is from: [http://www.regexlib.com/REDetails.aspx?regexp_id=1653 regexlib.com blank]<br />
<br />
=Hiding the help-text when it's empty=<br />
<br />
Tested with: 1.91+<br />
<br />
I had made a style in my template putting a border around my help-text. To avoid empty help-text to show up (and have lines instead of just 'nothing' when there was no help text, I used this piece of code in question.pstpl:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
var questionhelp="{QUESTIONHELP}";<br />
<br />
if (questionhelp=="") {<br />
<br />
document.write("");}<br />
<br />
else {<br />
<br />
document.write('<tr><td class="survey-question-help">'+ questionhelp +'</td></tr>');}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
it can probably be optimized but it worked for me<br />
<br />
=Disable or hide selected fields in a matrix question=<br />
<br />
''Tested with: 1.92+, IE 7/8/9, FireFox 12/13''<br />
<br />
TASK<br />
<br />
Hide or disable selected fields in a Matrix, so that users cannot make any input.<br />
<br />
(See example, where users should not make input into red framed fields)<br />
<br />
[[File:snap035.gif]]<br />
<br />
Fig. 1: Prevent users from input into first two fields (as an example)<br />
<br />
SOLUTION<br />
<br />
First find the name of the fields you want to hide / disable. In my case I used Firebug with firefox to figure that out.<br />
<br />
[[File:snap037.gif]]<br />
<br />
Fig. 2: Figure out the name(s) of the field(s)<br />
<br />
Then put the following script-code into the HTML-source code as described above:<br />
<br />
Note: you have to change the code to match the names of your fields!<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('input[name="69965X2X10SQ001_SQ001"]').attr('disabled', 'disabled');<br />
<br />
$('input[name="69965X2X10SQ001_SQ002"]').attr('hidden', 'hidden');<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
[[File:snap039.gif]]<br />
<br />
Fig. 3: Result: first field is diabled ("greyed out"), second one is completely hidden<br />
<br />
I think this way one can apply many other attributes to a field like color etc. But did not try that myself.<br />
<br />
Thanks to roB2009 for the input in the forum!<br />
<br />
=Add prefix or suffix to question type "Array (Texts)"=<br />
<br />
TASK<br />
<br />
Add a prefix or suffix to the text fields in questions of the "Array (Texts)" type.<br />
<br />
[[File:suffix.png]]<br />
<br />
Fig. 1: Suffix<br />
<br />
[[File:prefix.png]]<br />
<br />
Fig. 1: Prefix<br />
<br />
SOLUTION<br />
*Set up your survey to use JavaScript.<br />
*Add the following script to the source of the array. Replace "12345" with the array question ID and modify the suffixes/prefixes as required.<br />
*The function call must consist of a question ID followed by the suffixes for each column. Suffixes/Prefixes must be enclosed in quotes and comma separated.<br />
*In this example question ID 12345 will get an "in &euro;" suffix in the first column and an "in %" in the next 3 columns.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Call the function with the question ID followed by a comma-separated list of suffixes<br />
<br />
addSuffix(12345, 'in &euro;', 'in %', 'in %', 'in %');<br />
<br />
function addSuffix() {<br />
<br />
var qID = $(arguments)[0];<br />
<br />
// Assign some column-specific classes<br />
<br />
$('#question'+qID+' table.question tbody tr').each(function(i){<br />
<br />
$('td', this).each(function(i){<br />
<br />
$(this).addClass('answerCol-'+(i+1)+'');<br />
<br />
});<br />
<br />
});<br />
<br />
// Some styling<br />
<br />
$('#question'+qID+' table.question tbody input[type="text"]').css({<br />
<br />
'width': '50%'<br />
<br />
});<br />
<br />
// Insert the suffixes<br />
<br />
$(arguments).each(function(i, val){<br />
<br />
if(i > 0) {<br />
<br />
$('#question'+qID+' td.answerCol-'+i+' label').append(val);<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
For adding a prefix you need to substitute the following line in the code<br />
<br />
<syntaxhighlight lang="php" enclose="div">$('#question'+qID+' td.answerCol-'+i+' label').append(val);</syntaxhighlight><br />
<br />
with this<br />
<br />
<syntaxhighlight lang="php" enclose="div">$('#question'+qID+' td.answerCol-'+i+' label').prepend(val);</syntaxhighlight><br />
<br />
=Time question (Date question-like)=<br />
<br />
''Tested with: 1.92+''<br />
<br />
This workaround uses JavaScript/jQuery to build a Time question just like to the Date one.<br />
<br />
Implementation is as follows:<br />
#Download the file at [http://trentrichardson.com/examples/timepicker/jquery-ui-timepicker-addon.js trentrichardson.com/examples/timepicker/jquery-ui-timepicker-addon.js] and upload it to your survey.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the following code in the source of a short text question.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script src="/upload/surveys/{SID}/jquery-ui-timepicker-addon.js"></script><br />
<br />
<script><br />
<br />
$(document).ready(function(){<br />
<br />
$('#answer{SGQ}').timepicker({<br />
timeText: 'Time', //here translation<br />
hourText: 'hour', //here translation<br />
minuteText: 'minute', //here translation<br />
closeText: 'Done' //here translation<br />
});<br />
<br />
$('#answer{SGQ}').attr('readonly', 'readonly');<br />
<br />
$( "<style>"<br />
+".ui-widget-header, .ui-datepicker-current { display:none; }"<br />
+".ui-timepicker-div dl dt { height: 25px; margin-bottom: -25px; }"<br />
+".ui-timepicker-div dl dd { margin: 0 10px 10px 65px; }"<br />
+" }"<br />
+"</style>").appendTo( "head" );<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Calculating date difference=<br />
<br />
''Tested with: 1.92+ Build 120909''<br />
<br />
This workaround explains how calculate difference between two dates (in: days, weeks, months and years) and is based on this [http://ditio.net/2010/05/02/javascript-date-difference-calculation/ resource external].<br />
<br />
Requieres 2 groups and 'group by group' or 'question by question' presentation.<br />
<br />
Group 1 (2 date questions)<br />
*1st question - Question code: "DD"<br />
*2nd question - Question code: "D2"<br />
<br />
Group 2<br />
*1 numerical input question.<br />
<br />
This question retrieves the number of days between the 2 dates, and check if D2 is posterior than DD.<br />
<br />
All the requiered code have to be added in the source of this numerical question.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
/*<br />
<br />
Adapted from http://ditio.net/2010/05/02/javascript-date-difference-calculation/<br />
*/<br />
<br />
var DateDiff = {<br />
<br />
inDays: function(d1, d2) {<br />
<br />
var t2 = d2.getTime();<br />
<br />
var t1 = d1.getTime();<br />
<br />
return parseInt[[t2-t1)/(24*3600*1000]];<br />
<br />
},<br />
<br />
inWeeks: function(d1, d2) {<br />
<br />
var t2 = d2.getTime();<br />
<br />
var t1 = d1.getTime();<br />
<br />
return parseInt[[t2-t1)/(24*3600*1000*7]];<br />
<br />
},<br />
<br />
inMonths: function(d1, d2) {<br />
<br />
var d1Y = d1.getFullYear();<br />
<br />
var d2Y = d2.getFullYear();<br />
<br />
var d1M = d1.getMonth();<br />
<br />
var d2M = d2.getMonth();<br />
<br />
return (d2M+12*d2Y)-(d1M+12*d1Y);<br />
<br />
},<br />
<br />
inYears: function(d1, d2) {<br />
<br />
return d2.getFullYear()-d1.getFullYear();<br />
<br />
}<br />
<br />
}<br />
<br />
d1 = new Date({substr(DD,0,4)}, {substr(DD,5,2)}, {substr(DD,8,2)});<br />
<br />
d2 = new Date({substr(D2,0,4)}, {substr(D2,5,2)}, {substr(D2,8,2)});<br />
<br />
// Displays result<br />
<br />
document.write("<br />Number of <b>days</b>: "+DateDiff.inDays(d1, d2));<br />
<br />
document.write("<br />Number of <b>weeks</b>: "+DateDiff.inWeeks(d1, d2));<br />
<br />
document.write("<br />Number of <b>months</b>: "+DateDiff.inMonths(d1, d2));<br />
<br />
document.write("<br />Number of <b>years</b>: "+DateDiff.inYears(d1, d2));<br />
<br />
// filled the numerical input with number of days (or nights)<br />
<br />
var nDays = +DateDiff.inDays(d1, d2);<br />
<br />
jQuery(document).ready(function() {<br />
<br />
$(".numeric:eq(0) input.text").val(nDays);<br />
<br />
$(".numeric:eq(0) input.text").attr('readonly','readonly');<br />
<br />
// check if d2 > d1<br />
<br />
$('#movenextbtn').hide();<br />
<br />
$('#movesubmitbtn').hide();<br />
<br />
if(nDays >= 0){<br />
<br />
// automatic submit (uncomment if needed)<br />
<br />
// document.limesurvey.submit();<br />
<br />
// $('body').hide();<br />
<br />
}<br />
<br />
else alert("Check out date must be posterior than Check in\nPlease return to the previous page and edit your answers");<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=How to set minDate/maxDate based on other Datequestions=<br />
<br />
'' tested with Version 2.00+ Build 130708''<br />
<br />
QQ1 and QQ2 are the question identifiers. QQ2 gets as maxDate today and as minDate the date set in QQ1. The onClose event is needed because on document.ready the value of QQ1 is not yet known, although the value of today is.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function () {<br />
'use strict';<br />
var qID1 = QQ1,<br />
qID2 = QQ2,<br />
q1 = $('#question' + 'QQ1' + ' .popupdate'), <br />
q2 = $('#question' + 'QQ2' + ' .popupdate');<br />
<br />
//if q1 loses focus, its value is taken and used as minDate in q2 <br />
q1.datepicker("option", "onClose", function (datum){<br />
q2.datepicker( "option", "minDate", datum );<br />
});<br />
//q2 gets today as its maxDate<br />
q2.datepicker( 'option', 'maxDate', new Date() );<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
=Remove Question Help if empty=<br />
<br />
''Version 2.00+ Build 130513''<br />
<br />
Change your question.pstpl in your Template Editor so that the line looks like below. I've added the ID tag help_{question_number}.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<tr><td class="survey-question-help" id=help_{QUESTION_NUMBER}>{QUESTIONHELP}</td></tr><br />
</syntaxhighlight><br />
<br />
You can then add the following javascript at the end of question.pstpl. If the contents of the help tag is empty then hide the element.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script><br />
$(document).ready(function(){<br />
if($('#help_{QUESTION_NUMBER}').is(':empty')){<br />
$('#help_{QUESTION_NUMBER}').hide();<br />
}<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
= Implicit Association Test (IAT)=<br />
<br />
''Tested with: 2.0, IE 7-10, Firefox, Chrome, iPad''<br />
<br />
This workaround uses JavaScript to insert an IAT interface into an Array (Texts) question. The workaround prompts respondents to assign words or phrases using the "E" or "I" keys. In mobile devices, "E" and "I" buttons are provided.<br /><br /><br />
<br />
[[File:Iat_1.png]]<br /><br /><br />
<br />
Download a [[Media:Demo_IAT_Concept.zip|working template]] and [[Media:Demo_iat_concept.lss|working survey]].<br />
<br />
Implementation is as follows:<br />
<br />
1) [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
<br />
2) Create your Array (Texts) with sub-questions as follows:<br /><br />
- Y scale - all of your "attribut" words or phrases<br /><br />
- X scale - "Key Pressed" and "Elapsed Time (ms)"<br /><br />
[[File:Iat_2.jpg]]<br />
<br />
3) Insert your association terms and the other text elements for the interface into the Question Help section as depicted below. The text strings must be separated with "double pipes" (||) and you will need to place them in the following order:<br /><br />
- Left association term<br /><br />
- Right association term<br /><br />
- Instructional text<br /><br />
- Finished text<br /><br />
[[File:Iat_3.png]]<br />
<br />
4) Add the following to the end of template.js:<syntaxhighlight lang="javascript" enclose="div"><br />
// A plugin to insert an IAT interface<br />
function implicitAssociation(el, showAnswers) {<br />
<br />
$(el).each(function() {<br />
<br />
var thisQuestion = $(this);<br />
var thisQuestionHelp = $('img[src$="help.gif"]', thisQuestion).parent();<br />
var thisQuestionAnswers = $('table.question', thisQuestion).parent();<br />
var startTime = '';<br />
var endTime = ''; <br />
var agent = navigator.userAgent.toLowerCase();<br />
var mobile = false;<br />
if( /android|webos|iphone|ipad|ipod|blackberry/i.test(navigator.userAgent) ) { // Mobile devices<br />
mobile = true;<br />
}<br />
mobile = true;<br />
<br />
// Some classes<br />
$(thisQuestion).addClass('iatQuestion');<br />
$('.subquestion-list').addClass('unanswered');<br />
<br />
// Hide the question help element<br />
$(thisQuestionHelp).hide();<br />
<br />
// Hide the answers<br />
if(showAnswers != true) {<br />
$('table.question', thisQuestion).hide();<br />
}<br />
<br />
// Insert IAT display<br />
var iatTexts = $(thisQuestionHelp).text().split('||');<br />
var iatDisplayHTML = '<div class="iatWrapper">\<br />
<div class="iatLeftLabel">'+iatTexts[0]+'</div>\<br />
<div class="iatRightLabel">'+iatTexts[1]+'</div>\<br />
<div class="iatWord"></div>\<br />
<div class="iatInstructions">'+iatTexts[2]+'</div>\<br />
</div>\<br />
<div class="iatMobileButtonWrapper">\<br />
<div class="iatButton iatLeftButton">E</div>\<br />
<div class="iatButton iatRightButton">I</div>\<br />
<div style="width:100%; clear:both;"></div>\<br />
</div>';<br />
$(thisQuestionAnswers).prepend(iatDisplayHTML);<br />
<br />
// Show a word<br />
function iatShowWord() {<br />
$('div.iatWord', thisQuestion).text($('.subquestion-list.unanswered:first .answertext', thisQuestion).text());<br />
startTime = new Date();<br />
<br />
$(document).bind('keypress.iatKeypress', function(e) {<br />
if(e.which == 101 || e.which == 105) {<br />
var thisRow = $('.subquestion-list.unanswered:eq(0)', thisQuestion);<br />
$(thisRow).removeClass('unanswered');<br />
endTime = new Date();<br />
$('input[type="text"]:eq(1)', thisRow).val(endTime.valueOf() - startTime.valueOf());<br />
if(e.which == 101) {<br />
$('input[type="text"]:eq(0)', thisRow).val('E');<br />
}<br />
else {<br />
$('input[type="text"]:eq(0)', thisRow).val('I');<br />
}<br />
$(document).unbind('keypress.iatKeypress');<br />
if($('.subquestion-list.unanswered', thisQuestion).length > 0) {<br />
iatShowWord();<br />
}<br />
else {<br />
$('.iatLeftLabel, .iatWord, .iatRightLabel, .iatInstructions', thisQuestion).fadeOut('slow', function() {<br />
$('div.iatWord', thisQuestion).text(iatTexts[3]);<br />
$('.iatWord', thisQuestion).addClass('done').fadeIn('slow');<br />
});<br />
}<br />
}<br />
});<br />
}<br />
function iatShowWordMobile() {<br />
$('div.iatWord', thisQuestion).text($('.subquestion-list.unanswered:first .answertext', thisQuestion).text());<br />
startTime = new Date();<br />
<br />
$('.iatButton', thisQuestion).bind('click.iatButtonClick', function(e) {<br />
var thisRow = $('.subquestion-list.unanswered:eq(0)', thisQuestion);<br />
$(thisRow).removeClass('unanswered');<br />
endTime = new Date();<br />
$('input[type="text"]:eq(1)', thisRow).val(endTime.valueOf() - startTime.valueOf());<br />
$('input[type="text"]:eq(0)', thisRow).val($(this).text());<br />
$('.iatButton', thisQuestion).unbind('click.iatButtonClick');<br />
if($('.subquestion-list.unanswered', thisQuestion).length > 0) {<br />
iatShowWordMobile();<br />
}<br />
else {<br />
$('.iatLeftLabel, .iatWord, .iatRightLabel, .iatInstructions, .iatMobileButtonWrapper', thisQuestion).fadeOut('slow', function() {<br />
$('div.iatWord', thisQuestion).text(iatTexts[3]);<br />
$('.iatWord', thisQuestion).addClass('done').fadeIn('slow');<br />
});<br />
}<br />
});<br />
}<br />
<br />
// Start the IAT display<br />
if(mobile == true) { // Mobile devices<br />
$('.iatMobileButtonWrapper', thisQuestion).show();<br />
$('.iatButton', thisQuestion).bind('click.iatStartMobile', function(e) {<br />
$('.iatButton', thisQuestion).unbind('click.iatStartMobile');<br />
iatShowWordMobile();<br />
});<br />
}<br />
else {<br />
$(document).bind('keypress.iatStart', function(e) { // Non-mobile devices<br />
if(e.which == 101 || e.which == 105) {<br />
$(document).unbind('keypress.iatStart');<br />
iatShowWord();<br />
}<br />
});<br />
}<br />
});<br />
} </syntaxhighlight><br />
<br />
<br />5) Add the following to the end of template.css:<syntaxhighlight lang="css" enclose="div"><br />
/* IAT questions */<br />
<br />
.iatWrapper {<br />
position: relative;<br />
width: 600px;<br />
height: 300px;<br />
color: #FFFFFF;<br />
background-color: #000000;<br />
font-size: 21px;<br />
}<br />
<br />
.iatLeftLabel {<br />
float: left;<br />
padding: 10px;<br />
}<br />
<br />
.iatRightLabel {<br />
float: right;<br />
padding: 10px;<br />
}<br />
<br />
.iatWord {<br />
position: absolute;<br />
width: 100%;<br />
top: 35%;<br />
text-align: center;<br />
font-size: 36px;<br />
color:#0F0;<br />
}<br />
<br />
.iatWord.done {<br />
color:#FFFFFF;<br />
}<br />
<br />
.iatInstructions {<br />
position: absolute;<br />
width: 100%;<br />
bottom: 0px;<br />
padding-bottom: 10px;<br />
text-align: center;<br />
}<br />
<br />
.iatMobileButtonWrapper {<br />
display: none;<br />
position: relative;<br />
width: 600px;<br />
font-size: 36px;<br />
}<br />
<br />
.iatButton {<br />
float: left;<br />
margin: 20px;<br />
width: 100px;<br />
padding: 2px 0 5px 0;<br />
border: 5px solid #999;<br />
-moz-border-radius: 10px;<br />
-webkit-border-radius: 10px;<br />
-khtml-border-radius: 10px;<br />
border-radius: 10px;<br />
text-align: center;<br />
line-height: normal;<br />
cursor: pointer;<br />
}<br />
<br />
.iatLeftButton {<br />
float: left;<br />
}<br />
<br />
.iatRightButton {<br />
float: right;<br />
}</syntaxhighlight><br />
<br />
<br />6) To apply the plugin, add one of the two scripts below to the question source:<br /><br />
- With hidden answer table (for normally activated survey)<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"> <br />
$(document).ready(function() {<br />
// Apply the IAT plugin to this question<br />
implicitAssociation('#question{QID}');<br />
}); <br />
</script></syntaxhighlight><br />
- With visible answer table (for testing purposes)<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"> <br />
$(document).ready(function() {<br />
// Apply the IAT plugin to this question<br />
implicitAssociation('#question{QID}', true);<br />
}); <br />
</script></syntaxhighlight><br />
<br />
<br />
=Make multiple choice easier=<br />
<br />
''Tested with Version 2.00 in Chrome, FF, Safar, IE''<br />
<br />
The problem:<br />
We often have multiple choice question, where the user has to select 4 elements out of 78 possible answers or 3 out of 25 and so on.<br />
If we use pen and paper version for this questions, we noticed that the participants go through the whole list and if an answer doesn't suit on the first sight, they cross it out.<br />
<br />
The solution:<br />
The script gives the participant the possibility to cross out this answers in a digital way. The script adds a small "X" before the checkbox. When it is clicked, the label text of the checkbox turns grey.<br />
(see the attached screenshot for an example)<br />
<br />
Here is the script, just add it to help text<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript"><br />
<br />
/**<br />
* Small script that adds a "X" before a checkbox. <br />
* On click the text color of the label of the checkbox turns grey<br />
* If the user has to choose some answers from many options, he can "delete" answers, that on first sight looks wrong<br />
* Add the script to the question in Limesurvey (for example within the source code of the help text)<br />
*/<br />
<br />
//Define the X (standard is a X in capitals)<br />
var x = "X";<br />
css_class = "x";<br />
<br />
/*<br />
* Define the style of the X<br />
* Of course you can define the style in the stylesheet - if so, the script ignores the following settings<br />
* If there is a style, than set style var to 1<br />
*/<br />
var style = 0;<br />
var size = "12px";<br />
var weight = "bold";<br />
var color = "red";<br />
var cursor = "pointer";<br />
<br />
//element type - standard is a span element<br />
var type = "span";<br />
<br />
//Define the new font color of the checkbox label<br />
label_color = "#bfbfbf";<br />
<br />
<br />
//End of configuration - start of the function<br />
<br />
//Define the element that is added<br />
if(style == 1) {<br />
ele = "<"+type+" class='"+css_class+"'>"+x+"</"+type+">";<br />
}<br />
else {<br />
ele = "<"+type+" class='"+css_class+"' style='font-size:"+size+"; font-weight:"+weight+"; color:"+color+"; cursor:"+cursor+";'>"+x+"</"+type+">";<br />
}<br />
<br />
//Get the standard font-color of the used style<br />
st_color = $("label").css("color");<br />
<br />
//insert the X before the checkboxes<br />
$(document).ready(function() { <br />
$("li").each(function(){<br />
$(this).prepend(ele);<br />
});<br />
});<br />
<br />
//bind an eventhandler on the X (delegate is used, because Limesurvey uses an old jQuery version)<br />
var css_class_c = "."+css_class;<br />
$(document).delegate(css_class_c,"click",function() {<br />
var color_check = $(this).siblings("label").data("color");<br />
if(color_check != "true") {<br />
$(this).siblings("label").css("color",label_color).data("color","true");<br />
$(this).siblings('input').attr('checked', false);<br />
<br />
}<br />
else {<br />
$(this).siblings("label").css("color",st_color).data("color","false");<br />
<br />
}<br />
});<br />
<br />
$(".checkbox").click(function () {<br />
$(this).siblings("label").css("color",st_color).data("color","false");<br />
});<br />
<br />
</script><br />
</syntaxhighlight></div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Workarounds:_Manipulating_a_survey_at_runtime_using_Javascript&diff=59825Workarounds: Manipulating a survey at runtime using Javascript2014-01-16T03:58:01Z<p>Jcleeland: /* Drag and Drop Ranking - Version 1.90 to 1.92 */</p>
<hr />
<div><br />
Often you want to manipulate certain elements of a survey at runtime. The only solution without touching the source code is to use JavaScript or jQuery which is shipped with LimeSurvey. Here are some examples to hide and style elements, validate user input or do calculations at runtime.<br />
<br />
Other workarounds can be found at<br />
* [[Workarounds: Survey behaviour]]<br />
* [[Workarounds: Question design, layout and templating]]<br />
<br />
<div class="simplebox"><center><br />'''Please keep in mind that these workarounds are not official LimeSurvey extensions - they are solutions that users have created for themselves.<br /><span style='color:#EE0000,#FFFFFF'>Therefore LimeSurvey can't offer guarantees or support for these solutions.</span><br />If you have questions, please contact the users that, thankfully, shared their solutions with the community.'''<br /><br /></center></div><br />
<br />
<div class="simplebox">Note: Version 1.92 implements many new features that make some existing workarounds obsolete. You can continue to use existing workarounds, but may want to consider switching over to using the new features (since those new features are officially supported, and the workarounds are not). Please review below for details of which are no longer needed.<br /><br /></div><br />
<br />
<div class="simplebox">Also Note: Version 1.92's Expression Manager (EM) may cause some of these work-arounds to fail. Any custom javascript included as a .js file will be fine. However, if you in-line your JavaScript code, you must make sure that you have a space after every opening (left) curly brace, and a space before every closing (right) curly brace. Otherwise, EM will think that the content between the curly braces is something it should parse and understand. I have fixed all of the work-arounds below that can be fixed (many did not follow those rules). However, some will continue to break. If a work-around contains a regular expression which contains curly braces (to indicate a range of repeats of a sub-expression), EM will try to process those curly braces, and thus break your regular expression. Strategies to continue to support that work-around functionality are discussed below.<br /><br /></div><br />
<br />
__TOC__<br />
<br />
=How to ''add'' a javascript workaround solution to this Wiki page?=<br />
<br />
Well, this is pretty easy. Click the edit icon and create your own headline within the javascript section starting with "'''!'''". Then add a short note about the version you have used when creating your workaround, you can copy/paste this code snippet <nowiki>''Tested with: (enter LimeSurvey version and maybe browser)''</nowiki>.<br />
<br />
Finally it's imported to mark all your code with code tags, other wise you might break this page.<br />
*Start tag: '''<nowiki><syntaxhighlight lang="php" enclose="div"></nowiki>'''<br />
*End tag: '''<nowiki></syntaxhighlight></nowiki>'''.<br />
<br />
=How to ''use'' Script (eg. JavaScript etc.) in LimeSurvey?=<br />
<br />
To use JavaScript within LimeSurvey, the XSS filter must be turned off and the code inserted in the source of a question or a group description.<br />
*Go to Global settings --> Security and set "Filter HTML for XSS" to "Off".<br />
* [http://docs.limesurvey.org/tiki-index.php?page=Adding+A+Question Add a new question]<br />
* Edit the question and click the "Source" button in the editor toolbar:<br />
<br />
[[File:editor_1.gif]]<br />
* Enter your script after the question text:<br />
<br />
[[File:editor_2.gif]]<br />
* Save the question<br />
<br />
A simple test to see if JavaScript is enabled is to echo an alert. Use this code:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
alert("Test!");<br />
<br />
</script></syntaxhighlight><br />
<br />
It is a good practice to use the jQuery $(document).ready function to prevent the code from executing until the page is fully loaded:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
alert("Test!");<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
It is also good practice to use jslint.com to get a good layout and design (e.q. no cluttering of name space)<br />
<br />
=Sum up input values using Javascript=<br />
<br />
''Tested with: ''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the sum() function in [[Expression Manager|Expression Manager]]. See this [[Expression Manager HowTos#Calculate assessment values at runtime and store the results in the survey data|HowTo example]].</div><br />
<br />
<div class="simplebox">Starting in Version 1.92, you also do no longer need to use SGQA (e.g. 45251X1X5) identifiers. Instead the code <code>{SGQ}</code> will automatically replaced by the current questions SGQA-codes.</div><br />
<br />
This is from a survey that is a invitation to a longer party, when the user clicks to the next page, the calculated results will be shown.<br />
<br />
If you wonder what the {INSERTANS:1X6X12} stuff is, look at [http://docs.limesurvey.org/tiki-index.php?page=SGQA+Identifier SGQA identifier] and [[Adding a question#Information from previous answers|Using information from previous answers]].<br />
<br />
<syntaxhighlight lang="html4strict" enclose="div"><br />
<br />
<div style="text-align: left">These are your answers:<br /><br />
<br />
<u></u><u></u><u></u><u></u><u>=<br />
<br />
<p><script LANGUAGE="JavaScript"><br />
<br />
partyprice = 3;<br />
<br />
beadclothprice = 3;<br />
<br />
breakfastprice = 7;<br />
<br />
lunchprice = 8;<br />
<br />
dinnerprice = 10;<br />
<br />
foodtotal = 0;<br />
<br />
var isreallytrue = "Yes";<br />
<br />
var noanswer = "No answer";<br />
<br />
document.write( "Can you come? = {INSERTANS:45251X1X1}<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X1}" == isreallytrue )<br />
<br />
{<br />
<br />
if ("{INSERTANS:45251X1X3}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X3}"; }<br />
<br />
partypeople = parseInt(answer);<br />
<br />
partytotal = partyprice * partypeople;<br />
<br />
document.write( "It's {INSERTANS:45251X1X3} persons who will come = " + partytotal + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X4}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X4}";}<br />
<br />
beadcloths = parseInt(answer);<br />
<br />
beadclothtotal = beadclothprice * beadcloths;<br />
<br />
document.write( "You want to borrow {INSERTANS:45251X1X4} beadcloths = " + beadclothtotal + "&euro;<BR>" );<br />
<br />
document.write( "Will you be there thursday? = {INSERTANS:45251X1X5}<BR>" );<br />
<br />
document.write( "On friday you will have these meals: <BR>" );<br />
<br />
if ("{INSERTANS:45251X1X71}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X71}";}<br />
<br />
breakfastfriday = parseInt(answer) * breakfastprice;<br />
<br />
document.write( "'''_ " + answer + " breakfeasts = " + breakfastfriday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X72}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X72}";}<br />
<br />
lunchfriday = parseInt(answer) * lunchprice ;<br />
<br />
document.write( "'''_ " + answer + " lunches = " + lunchfriday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X73}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X73}";}<br />
<br />
dinnerfriday = parseInt(answer)* dinnerprice ;<br />
<br />
document.write( "'''_ " + answer + " dinners = " + dinnerfriday + "&euro;<BR>" );<br />
<br />
foodtotal = breakfastfriday + lunchfriday + dinnerfriday;<br />
<br />
document.write( "Will you be there saturday? = {INSERTANS:45251X1X8}<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X8}" == isreallytrue )<br />
<br />
{<br />
<br />
document.write( "On saturday you will have these meals: <BR>" );<br />
<br />
if ("{INSERTANS:45251X1X91}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X91}"; }<br />
<br />
breakfastsaturday = parseInt(answer) * breakfastprice ;<br />
<br />
document.write("'''_ " + answer + " breakfeasts = " + breakfastsaturday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X92}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X92}"; }<br />
<br />
lunchsaturday = parseInt(answer) * lunchprice ;<br />
<br />
document.write( "'''_ " + answer + " lunches = " + lunchsaturday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X93}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X93}"; }<br />
<br />
dinnersaturday = parseInt(answer) * dinnerprice ;<br />
<br />
document.write( "'''_ " + answer + " dinners = " + dinnersaturday + "&euro;<BR>" );<br />
<br />
foodtotal = foodtotal + breakfastsaturday + lunchsaturday + dinnersaturday;<br />
<br />
}<br />
<br />
document.write( "Will you be there sunday? = {INSERTANS:45251X1X10}<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X10}" == isreallytrue )<br />
<br />
{<br />
<br />
document.write( "On sunday you will have these meals: <br>" );<br />
<br />
if ("{INSERTANS:45251X1X111}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X111}"; }<br />
<br />
breakfastsunday = parseInt(answer) * breakfastprice ;<br />
<br />
document.write( "'''_ " + answer + " breakfeasts = " + breakfastsunday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X112}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X112}"; }<br />
<br />
lunchsunday = parseInt(answer) * lunchprice ;<br />
<br />
document.write( "'''_ " + answer + " lunches = " + lunchsunday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X113}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X113}"; }<br />
<br />
dinnersunday = parseInt(answer) * dinnerprice ;<br />
<br />
document.write( "'''_ " + answer + " dinners = " + dinnersunday + "&euro;<p>" );<br />
<br />
foodtotal = foodtotal + breakfastsunday + lunchsunday + dinnersunday;<br />
<br />
}<br />
<br />
total = partytotal + beadclothtotal + foodtotal;<br />
<br />
document.write( "<h3>In total it will cost you " + total + "&euro;</h3><BR><br />
<br />
Put that sum in this bank account 1234 5678 9012" );<br />
<br />
}<br />
<br />
</SCRIPT></p><br />
<br />
</div></syntaxhighlight><br />
<br />
=Multiple Question Validation=<br />
<br />
''Tested with: ''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the min/max/equals_num_value attributes (to validate sums), or the em_validation_q function, which lets you refer to other variables when you validate the current question [[Expression Manager|Expression Manager]]. Such validations also work on the current page, and properly handle array_filter and cascading relevance.</div><br />
<br />
This workaround is in case you need to do some validation involving more than one question, it implies a very little JavaScript programming and the use of SGQA Identifiers; this should work on almost any version of LimeSurvey.<br />
<br />
Is easy to explain with an example, we need to do a survey of the percentage of males and females and we want to be sure that the sum is 100, to do this follow this steps (the necessary data that is not indicated in these instructions are not important i.e. question codes, etc.):<br />
#Create a new survey of type "group by group", set the "Show |<< Prev| button" to yes and note the SID.<br />
#Add a new group called "Group 1" and note the GID.<br />
#Add a new question "Percent of males" of type "numeric", make it mandatory and note the QID (we will refer to this as QID1).<br />
#Add a new question "Percent of females" of type "numeric", make it mandatory and note the QID (we will refer to this as QID2).<br />
#Add a new group called "Group 2"<br />
#Add a new non mandatory question, here is the trick the question text has to be (be sure to replace the SID, GID, QID1 and QID2<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script><br />
<br />
function validation()<br />
<br />
{<br />
<br />
if [[{INSERTANS:SIDXGIDXQID1}+{INSERTANS:SIDXGIDXQID2}) != 100)<br />
<br />
{<br />
<br />
alert("Your responses don't sum 100! Check them");<br />
<br />
document.limesurvey.move.value = 'moveprev';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
else<br />
<br />
{<br />
<br />
document.limesurvey.move.value = 'movelast';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
}<br />
<br />
setTimeout("validation()",250);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
But this will show shortly the question and will jump to the end page, a little weird for the survey taker but works.<br />
<br />
This is a proof of concept, and may have some problems, please if you notice something or improve it send me an e-mail to leochaton-limesurvey at yahoo dot com.<br />
<br />
This will work for 2 questions that you want to be the same. Works well for email and confirm email questions<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
function validation() {<br />
<br />
if ("{INSERTANS:SIDXGIDXQID}" != "{INSERTANS:SIDXGIDXQID}") {<br />
<br />
alert("Your responses don't match Check them"); document.limesurvey.move.value = 'moveprev';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
}<br />
<br />
setTimeout("validation()",250);<br />
<br />
</syntaxhighlight><br />
<br />
=Alternate exit=<br />
<br />
''Tested with: ''<br />
<br />
Using the same idea of the previous post, you can implement an alternate exit of your survey.<br />
<br />
This script should be in the first question to be displayed in a next page after the question that should trigger the alternate exit. In this example the question that trigger the alternate exit is a Yes/No question, if the user chooses no, he is redirected to another page.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
if ("{INSERTANS:SIDXGIDXQID}" == "No")<br />
<br />
{<br />
<br />
window.location="http://www.limesurvey.org";<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Custom onload function=<br />
<br />
''Tested with: 'All browsers', LimeSurvey 1.70 and up<br />
<br />
==General==<br />
<br />
This simple workaround describes how to '''add a custom Javascript code''' that is triggered right after the page is loaded. It may have numerous applications, especially when you deal with a custom JS/HTML code. It may be used to hide form elements (<input> tags), make them read-only, display alert messages, etc.<br />
<br />
To run any Javascript code right after page load use the Query ready() function. It will be executed when the page is being loaded. For example when you add the following code to one of your question definitions...:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
jQuery(document).ready(<br />
<br />
function(){<br />
<br />
alert('onload alert!');<br />
<br />
}<br />
<br />
);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
...it will display a pop-up message immediately after the page has been loaded.<br />
<br />
Some of the applications of this trick I've explored are:<br />
<br />
a) Hiding the form elements by calling in your Custom_On_Load:<br />
<br />
<syntaxhighlight lang="php" enclose="div">document.getElementById("answer73166X16X54").style.display='none';</syntaxhighlight><br />
<br />
Note: As of svn build 9755, you can now dynamically reference the questions input fields by using the {SGQ} keyword. You can rewrite the previous example like this:<br />
<br />
<syntaxhighlight lang="php" enclose="div">document.getElementById("answer{SGQ}").style.display='none';</syntaxhighlight><br />
<br />
this makes it a little easier when exporting surveys, so you don't have to worry about manually entering each questions SurveyGroupQuestion ID.<br />
<br />
b) Making the elements read only:<br />
<br />
<syntaxhighlight lang="php" enclose="div">document.getElementById("answer73166X16X54").readOnly=true;</syntaxhighlight> where the "answer73166X16X54" structure has been described in one of other workarounds above.<br />
<br />
c) For Hiding by a lot of elements by calling in your Customer_On_Load<br />
<br />
jQuery searchs in html document for input-fields with radio type, if his answer text empty then do the display css set to none.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
jQuery(document).ready(<br />
<br />
function() {<br />
<br />
jQuery('input:radio').each(<br />
<br />
function() {<br />
<br />
var s = jQuery(this);<br />
<br />
var c = s.parent().children('.answertext');<br />
<br />
for(var i=0; i < c.length; i++) {<br />
<br />
var a = jQuery(c[i]]);<br />
<br />
if(this.id </u> a.attr('for') && a.text() == '') {<br />
<br />
s.css({ 'display' : 'none' });<br />
<br />
a.css({ 'display' : 'none' });<br />
<br />
break;<br />
<br />
}<br />
<br />
}<br />
<br />
}<br />
<br />
)<br />
<br />
}<br />
<br />
);<br />
<br />
</syntaxhighlight><br />
<br />
==Advanced usage==<br />
<br />
If you want to place global Javascript code using the above jQuery(document).ready function then the best place to do this is the template javascript file template.js. You can edit this file using the template editor. Please be aware that placing it in the template javascript file will make the function available to all surveys using that template. If needed just create a new template copy for your survey.<br />
<br />
Alternatively you can place the jQuery(document).ready function in the group description to make a Javascript function only available to a certain question group.<br />
<br />
==Language-specific Javascript code==<br />
<br />
There is an easy way to find out the current language and execute according Javascript using jQuery: The <html> tag of any survey pages contains an 'lang' attribute which holds the current language code. You can read that language code by using the followin code<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
jQuery(document).ready(<br />
<br />
function(){<br />
<br />
languagecode=$('html').attr('lang');<br />
<br />
alert('This is the current language code: '+languagecode);<br />
<br />
}<br />
<br />
);<br />
<br />
</syntaxhighlight><br />
<br />
For an English survey the above code would show a messagebox with "This is the current language code: en"<br />
<br />
=Custom onload function in multi-language survey=<br />
<br />
''Tested with: 1.85+ (7253), IE 6/7, FireFox 3.0, Safari 3.2,''<br />
<br />
To use custom onload functions, as above, in multi-language surveys you must define the functions in the question source for '''all''' languages.<br />
<br />
While this initially seems to be a bit tedious, it actually can be useful - you can alter your onload functions depending on the language in use. For example, you can dynamically display alerts or element contents in the current language.<br />
<br />
=Skipping the welcome page=<br />
<br />
''Tested with: 1.85 (second code snippet)''<br />
<br />
<div class="simplebox">Note: As of version 1.91, there is a survey option letting you skip the welcome page, so this workaround is not needed.</div><br />
<br />
'''Solution 1:''' Include this Javascript in your welcome template, in the file welcome.pstpl for all welcome page, or in the source of the welcome text for one survey:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
jQuery(document).ready(function($) {<br />
<br />
document.limesurvey.move.value = 'movenext';<br />
<br />
document.limesurvey.submit(); });<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
It will reproduce the onclick event of the submit button and submit the form.<br />
<br />
Drawback of course is that users will see the page flashing up.<br />
<br />
Therefore, you may want to announce "... loading survey ..." as a description of your welcome page (in the admin interface when creating the survey), to pretend loading something big.<br />
<br />
'''Solution 2:'''<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
function custom_on_load(){<br />
<br />
document.limesurvey.move.value = 'movenext';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
window.setTimeout( 'custom_on_load()',1);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Filter answers of a question with the answer of another=<br />
<br />
===Method 1===<br />
<br />
''Tested with: 1.70 - 1.72''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the the array_filter attribute, or relevance equations in general.</div><br />
<br />
If you want to filter the answer of a question with another answer, you can use this workaround.<br />
<br />
First, use answer code like that: XX for the first question, and XXYYY for the second one.<br />
<br />
Answer of the second question filter if the 2 first letters are the answer of the first question.<br />
<br />
We use 1000X1X1 and 1000X1X2 for the example, question had to be on separate page (question by question for example).The second question had to be a dropdown list (we can do similar workaround, but droplis is the best). You can do this using JQuery. It leaves the answer in the select box, but disables it. You could also replace "disable" with "remove" to get rid of it altogether.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
var previousQuestionAnswer = "{INSERTANS:1000X1X1}";<br />
<br />
var currentQuestionID = "#answer1000X1X1"<br />
<br />
$(document).ready(function() {<br />
<br />
// See if the answer for the previous question matches an answer in the current question<br />
<br />
// (other than 'No Answer')<br />
<br />
// If so, disable it.<br />
<br />
if (previousQuestionAnswer!='No Answer') {<br />
<br />
$(currentQuestionID).children().each(function(index, Element)<br />
<br />
{<br />
<br />
if ($(this).attr('text') == previousQuestionAnswer)<br />
<br />
{ $(this).attr('disabled', true); }<br />
<br />
}<br />
<br />
);}<br />
<br />
}); // End of JQuery ready function<br />
<br />
</syntaxhighlight><br />
<br />
===Method 2===<br />
<br />
''Tested with 1.92 + Firefox 9.0''<br />
<br />
If you have a country, state, and city set of questions (or similar), you could code answer options as:<br />
<br />
'''Q1 Country''' ''Single choice list (ratio, dropdown)''<br />
<br />
X country#<br />
<br />
'''Q2 State''' ''Single choice list (dropdown)''<br />
<br />
XY state#<br />
<br />
'''Q3 City''' ''Single choice list (dropdown)''<br />
<br />
XYZZ city#<br />
<br />
Now you must put the following Javascript code in the source of question 2 (State):<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Get the countryCode (first character of the country)<br />
<br />
var countryCode = '{INSERTANS:1000X1X1}'.substr(0, 1).toUpperCase();<br />
<br />
// Loop through all dropdown options and remove those with codes not starting with the countryCode<br />
<br />
$('select[id<div class="simplebox">="answer"] option').each(function(i){<br />
<br />
if($(this).attr('value') && $(this).attr('value').substr(0, 1).toUpperCase() != countryCode) {<br />
<br />
$(this).remove();<br />
<br />
}<br />
<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
And the following code in the source of question 3 (City):<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Get the stateCode (two first characters of the state)<br />
<br />
var stateCode = '{INSERTANS:1000X1X2}'.substr(0, 2).toUpperCase();<br />
<br />
// Loop through all dropdown options and remove those with codes not starting with the stateCode<br />
<br />
$('select[id</div>="answer"] option').each(function(i){<br />
<br />
if($(this).attr('value') && $(this).attr('value').substr(0, 2).toUpperCase() != stateCode) {<br />
<br />
$(this).remove();<br />
<br />
}<br />
<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
Each question must be in different pages of survey to work, i.e. in a question by question survey, or in diferent groups in a group by group survey.<br />
<br />
Note that if you choose a two characters answer option code in the State question, i.e. a XYY answer option code, you must change the ''substr(0, 2)'' part of code in question 3 to ''substr(0, 3)''.<br />
<br />
=Filter answers of a multiple numeric type question=<br />
<br />
''Tested with: 1.90+''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the the array_filter attribute, or relevance equations in general. In 1.92, array_filter works with all questions that have sub-questions (e.g. also works for multiple numeric and multiple short text).</div><br />
<br />
If you want to filter a question of type "multiple numeric", you have to modify the workaround.<br />
<br />
Note that this workaround assumes that the code for each of the subquestions are a numeric sequence 1,2,3...<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function(){<br />
<br />
// Match elements with labels using htmlFor and a loop<br />
<br />
var labels = document.getElementsByTagName('LABEL');<br />
<br />
for (var i = 0; i < labels.length; i++) {<br />
<br />
if (labels[i].htmlFor != '') {<br />
<br />
var elem = document.getElementById(labels[i].htmlFor);<br />
<br />
if (elem)<br />
<br />
elem.label = labels[i];<br />
<br />
}<br />
<br />
}<br />
<br />
var answerFilter="{INSERTANS:96553X63X759}";<br />
<br />
for (i=0; i<30; i++){<br />
<br />
var iLabel = document.getElementById('answer96553X63X760'+(i+1]].label.innerHTML;<br />
<br />
if (answerFilter.search(iLabel) == -1){<br />
<br />
// Hide element<br />
<br />
$('#question760').find('li').eq(i).hide();<br />
<br />
// Set value of hidden elements to zero<br />
<br />
document.getElementById('answer96553X63X760'+(i+1)).value = 0;<br />
<br />
}<br />
<br />
}<br />
<br />
});</script><br />
<br />
</syntaxhighlight><br />
<br />
=Use an answer to prefill another question (default value)=<br />
<br />
''Tested with: 1.72''<br />
<br />
''And tested with: 1.91+''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the enhanced defaults feature, which lets you pre-fill most question types with default values. In 1.91, you could set defaults for list and multiple choice questions. In 1.92, you can set defaults for any text-entry question too. Moreover, the defaults can be [[Expression Manager|Expression Manager]] compatible equations or tailored text. Finally, with 1.92, defaults are properly managed even when set on the same page.</div><br />
<br />
This workaround gives you the ablility to use an answer to fill the default value for another question. It's explained for free text question type but can be adapted for another question type.<br />
<br />
We use SGQA identifier. For example, we use SGQA 1000X10X20 and 1000X10X21 to prefill 1000X11X30 and 1000X11X31. For the script to work, the question has to be on a different page.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answer1000X11X30').val('{INSERTANS:1000X10X20}');<br />
<br />
$('#answer1000X11X31').val('{INSERTANS:1000X10X21}');<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
If you want use two times the value of an integer input, you can also use this to prefill a question that you hide via CSS.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answer1000X2X2').val(parseInt('{INSERTANS:1000X1X1}')*2);<br />
<br />
$("#question2").hide();<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
Now you can use {INSERTANS:1000X2X2} for giving you twice the value of the user input from question 1.<br />
<br />
=Dynamic Sum=<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do with [[Expression Manager|Expression Manager]] using the sum() function. Not only will sums be dynamic, but they wille exclude irrelevant values, so you can array_filter a multiple numeric question and get the sum of just the answers that are visible. This [[Expression Manager HowTos#Calculate assessment values at runtime and store the results in the survey data|HowTo example]] demonstrates the dynamic sum feature.</div><br />
<br />
<div class="simplebox">Also note, as of version 1.92, the following workaround will fail, since it includes a a regular expression containing curly braces.</div><br />
<br />
This script is used with a "Multiple Options" type question calculate a total price based on how which checkboxes are selected. The prices are listed as part of the answer. The answers are set up like this: "USB Mouse ($20)". The script uses the number between the "($" and the ")" as the price for that item. You can adapt the script to if you need to change the currency or need to sum something other than money.<br />
<br />
This script works when used in a question-by-question format. It does not work when there are more than one question on a page. I think it can be adapted to work, but I haven't done the coding yet.<br />
<br />
Put the following code into body of your question:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script language=Javascript><br />
<br />
// General definitions<br />
<br />
// Define a regular expression to match the labels containing information about an answer<br />
<br />
// In LimeSurvey, these labels start with "answer..."<br />
<br />
var answerRegex = /^answer/;<br />
<br />
// Find all answer checkboxes in the document and set their<br />
<br />
// onchange events to updatePrice<br />
<br />
function Custom_On_Load()<br />
<br />
{<br />
<br />
// Find all input elements<br />
<br />
var inputList=document.getElementsByTagName("input");<br />
<br />
// Loop through each, looking for checkboxes<br />
<br />
var i;<br />
<br />
for( i=0; i< inputList.length;i++ )<br />
<br />
{<br />
<br />
// If input item does not have an ID, skip<br />
<br />
if (! (inputList[i].id)) { continue; }<br />
<br />
// Skip to next if ID doesn't start with "answer"<br />
<br />
if (!answerRegex.test(inputList[i].id)) { continue; }<br />
<br />
// Skip to next if not a checkbox<br />
<br />
if (inputList[i].type.toUpperCase()!='CHECKBOX') { continue; }<br />
<br />
// This is an answer checkbox!<br />
<br />
// Setup onchange event<br />
<br />
inputList[i].onclick = updatePrice;<br />
<br />
}<br />
<br />
// Load initial sum<br />
<br />
updatePrice();<br />
<br />
}<br />
<br />
function updatePrice()<br />
<br />
{<br />
<br />
var labels=document.getElementsByTagName("LABEL");<br />
<br />
// Define a regular expression to match a price inside parenthesis<br />
<br />
// For example: ($29) or ($29.54).<br />
<br />
// Set up<br />
<br />
priceRegex = /\(\$(\d*\.{0,1}\d+)\)/;<br />
<br />
// Loop through all the labels, looking for labels corresponding to<br />
<br />
// answers that have a price in them.<br />
<br />
var i;<br />
<br />
var total = 0;<br />
<br />
for( i=0; i<labels.length;i++ )<br />
<br />
{<br />
<br />
var myArray; // Define array used for regex matching<br />
<br />
var inputID; // Define field element<br />
<br />
// Get the ID of the field corresponding to the label using the<br />
<br />
// "htmlFor" attribute<br />
<br />
// (FYI, there are some labels that will have to be screened out<br />
<br />
// because they don't correspond to an answer)<br />
<br />
// Does the label start with "answer"?<br />
<br />
// If not: exit.<br />
<br />
if (!answerRegex.test(labels[i].htmlFor)) { continue; }<br />
<br />
// First make sure this element exists<br />
<br />
// If it doesn't, go to the next element<br />
<br />
// If it does, it will be defined in inputID<br />
<br />
if (! (inputID = document.getElementById(labels[i].htmlFor)) ) { continue; }<br />
<br />
// See if the corresponding answer is a checkbox that is checked.<br />
<br />
// If not, go to next label<br />
<br />
if (inputID.type.toUpperCase()!='CHECKBOX') { continue; }<br />
<br />
if (!inputID.checked) { continue; }<br />
<br />
// This is label for an answer.<br />
<br />
// The innerHTML will give us the text of the label<br />
<br />
// The price information will be in the form ($XX.XX)<br />
<br />
// which in contained in the label text.<br />
<br />
// Find a match for a decimal number inside the pattern "($" and ")"<br />
<br />
if [[myArray = priceRegex.exec(labels[i].innerHTML]] != null)<br />
<br />
{<br />
<br />
// Keep a running tally<br />
<br />
total += parseFloat(myArray[1]);<br />
<br />
}<br />
<br />
}<br />
<br />
// Update total price on form<br />
<br />
document.getElementById("totalPrice").value = "$" + formatCurrency(total);<br />
<br />
}<br />
<br />
function formatCurrency(num) {<br />
<br />
num = isNaN(num) || num <u> '' || num </u> null ? 0.00 : num;<br />
<br />
return parseFloat(num).toFixed(2);<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
Put the following code in the help section (or wherever you want the sum to appear):<br />
<br />
<syntaxhighlight lang="php" enclose="div">Total Cost for selected accessories: <input type="readonly" value="" id="totalPrice" /></syntaxhighlight><br />
<br />
=Focus on the first Input field=<br />
<br />
(''Tested with: LimeSurvey 1.80 / IE6/7, Firefox 3, Safari, Opera, chrome'')<br />
<br />
<div class="simplebox">As of version 1.91, there is a built-in JavaScript function called focusFirst() to focus on the first visible element. It uses jQuery, so is more robust than this example.</div><br />
<br />
Again an onload Function is needed for this tasks. I have done it the DOM way with compatibility to IE6/7.<br />
<br />
Put the following code into the startpage.pstpl of your template, right before the </head> closing tag:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
function focusFirst(Event)<br />
<br />
{<br />
<br />
var i=0;<br />
<br />
while(document.forms[0].elements[i].type == "hidden")<br />
<br />
{<br />
<br />
i++;<br />
<br />
}<br />
<br />
document.forms[0].elements[i].focus();<br />
<br />
return;<br />
<br />
}<br />
<br />
if(ie)<br />
<br />
{ window.attachEvent("onload", focusFirst); }<br />
<br />
else<br />
<br />
{ document.addEventListener("load", focusFirst, true); }<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
'''Note:''' I am using this with version 1.80. As changes happened to the templates in the last release, you might need to add the following before the code, if your template is older than 1.80 stable and does not include this:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
var ie = false;<br />
<br />
</script><br />
<br />
<br />
<br />
</syntaxhighlight><br />
<br />
You will need this for the var ie to be set. Without this var, the function will not work with ie.<br />
<br />
=Answer questions by keypress=<br />
<br />
(''Tested with: IE7, Firefox 3'')<br />
<br />
This workaround allow to answer the question on key 0-9 (0 is for the 10 answer).<br />
<br />
Follow issues are supported at the moment:<br />
*Yes-No Questions<br />
*List Questions (radio)<br />
*other radio questions<br />
<br />
In lists the answer limit is ten.<br />
<br />
You supply the template "endpage" of your template with the following script.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
jQuery(document).ready(function() {<br />
<br />
jQuery(document).bind('keypress', function(e){<br />
<br />
if (48 <= e.which && e.which <= 57) {<br />
<br />
jQuery('input:radio').each(function() {<br />
<br />
var v = jQuery(this).val();<br />
<br />
var c = (e.which <u> 48) ? 10 : e.which - 48;<br />
<br />
if(v </u> 'Y' || v <u> 'N') {<br />
<br />
v = (v </u> 'Y') ? 1 : 2;<br />
<br />
}<br />
<br />
if(v == c) {<br />
<br />
jQuery(this).click();<br />
<br />
jQuery('#limesurvey input:submit').click();<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
})<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Math notation in LimeSurvey=<br />
#download the js file from [http://mathcs.chapman.edu/~jipsen/mathml/asciimathdownload.html AsciiMath script]<br />
#copy it in the /scripts/ folder in your installation<br />
#modify the startpage.psptl of the template you want to use adding the reference to the script (if you use an older version make sure that you copy the template folder first!) for example:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" src="ASCIIMathML.js"><br />
<br />
</syntaxhighlight><br />
<br />
Use the notation where you need it!<br />
<br />
'''Note:''' If you use internet explorer or safari you will need to download the plugin as well, but firefox does the lot for you.<br />
<br />
Finally, if you are confident with the limesurvey structure you could add the editor which support math notation and change the reference to the editor you want to use in the configuration file. here is the [http://www.imathas.com/editordemo/demo.html link for a TinyMCE with math support].<br />
<br />
=Reverse array_filter (for pre-1.90)=<br />
<br />
''Tested with: 1.85+ (7253), IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
<div class="simplebox">Note: Version 1.91 natively supports this functionality via the array_filter_exclude advanced quation option.</div><br />
<br />
This can be used to filter the answers of an array question to be displayed based on the answers of a multi option question that were '''NOT''' selected. A possible application would be to have a multi-option question asking which products were purchased, followed by 2 array questions - one asking to rate the purchased products and another asking why the remaining products were not purchased. Another would be to ask about sessions attended at a conference as in [http://www.limesurvey.org/en/forum/5-can-i-do-this-with-limesurvey/27970-reverse-of-arrayfilter.html this forum thread] and pictured below. There is a live [http://www.partnersinc.biz/surveys//index.php?sid=43358&newtest=Y&lang=en demo here]<br />
<br />
[[File:sessions_645x344.gif]]<br />
<br />
We'll use the above example to explain the process as follows:<br />
#In group 1 - Create a ''SessionsAttended'' multi-options question<br />
#In group 1 - Create a ''SessionsNotAttended'' multi-options question with identical answers as ''SessionsAttended'' and hide it with styles or conditions<br />
#In group 2 - Create a ''RateSessionsAttended'' array question with an [http://docs.limesurvey.org/tiki-index.php?page=Question+attributes&structure;=English+Instructions+for+LimeSurvey#array_filter array_filter] based on ''SessionsAttended''<br />
#In group 2 - Create a ''ReasonNotAttended'' array question with an [http://docs.limesurvey.org/tiki-index.php?page=Question+attributes&structure;=English+Instructions+for+LimeSurvey#array_filter array_filter] based on ''SessionsNotAttended''<br />
#In group 1 - Place JavaScript/jQeury listeners on each of the checkboxes in ''SessionsAttended'' that would toggle the corresponding checkbox in ''SessionsNotAttended'' to the opposite state<br />
<br />
The JavaScript/jQuery code used would be:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
// The toggle function<br />
<br />
function toggle(q1, q2) {<br />
<br />
if ($(q1).attr('checked') == false ) {<br />
<br />
$(q2).attr('checked', true);<br />
<br />
}<br />
<br />
else {<br />
<br />
$(q2).attr('checked', false);<br />
<br />
}<br />
<br />
}<br />
<br />
// Initialize the SessionNotAttended checkboxes to "checked"<br />
<br />
toggle ('#answer11111X22X331', '#answer11111X22X441');<br />
<br />
toggle ('#answer11111X22X332', '#answer11111X22X442');<br />
<br />
toggle ('#answer11111X22X333', '#answer11111X22X443');<br />
<br />
toggle ('#answer11111X22X334', '#answer11111X22X444');<br />
<br />
// The jQuery listeners on the SessionAttended checkboxes<br />
<br />
// that toggle the SessionNotAttended checkboxes<br />
<br />
$('#answer11111X22X331').change(function() {<br />
<br />
toggle ('#answer11111X22X331', '#answer11111X22X441');<br />
<br />
});<br />
<br />
$('#answer11111X22X332').change(function() {<br />
<br />
toggle ('#answer11111X22X332', '#answer11111X22X442');<br />
<br />
});<br />
<br />
$('#answer11111X22X333').change(function() {<br />
<br />
toggle ('#answer11111X22X333', '#answer11111X22X443');<br />
<br />
});<br />
<br />
$('#answer11111X22X334').change(function() {<br />
<br />
toggle ('#answer11111X22X334', '#answer11111X22X444');<br />
<br />
});<br />
<br />
</syntaxhighlight><br />
<br />
Some notes about the code:<br />
*The code is in an onload function defined in the first question of group 1 - see [[Workarounds#Custom_onload_function|here]]<br />
*Both ''SessionsAttended'' and ''SessionsNotAttended'' must be in the same group for the toggling to work<br />
*This case only uses 4 checkboxes but could be expanded as required<br />
*In this case the survey ID is 11111, the group ID is 22, ''SessionsAttended'' ID is 33 and SessionsNotAttended ID is 44 - these would need to be modified for your survey<br />
*The toggle function looks for the state of a checkbox in ''SessionsAttended'' and sets the corresponding checkbox in ''SessionsNotAttended'' to the opposite state<br />
*The "Initialize" section sets the state of ''SessionsNotAttended'' checkboxes whenever we navigate to the group<br />
*The "Listener" section uses jQuery listeners to detect any change in the ''SessionsAttended'' checkboxes and then toggle the corresponding ''SessionsNotAttended'' checkbox<br />
<br />
Some general notes about the questions:<br />
*CSS can be used to hide ''SessionsNotAttended'' (div#question44 { display: none; }) if you don't want to use conditions (because maybe you've got [[Optional settings#Survey Behavior|$deletenonvalues set to 1]])<br />
*''RateSessionsAttended'' and ''ReasonNotAttended'' are another group to avoid things popping in and out of existence as ''SessionsAttended'' is answered<br />
*[[Setting conditions|Conditions]] are used to ensure that ''RateSessionsAttended'' only appears if some sessions are selected and ''ReasonNotAttended'' only appears if no sessions are selected<br />
<br />
=Filter Ranking Question With Multiple-Options (pre 1.92)=<br />
<br />
''Tested with: 1.90, IE 7/8, FireFox 3/4, Safari 5.0, Chrome 10.0''<br />
<br />
<div class="simplebox">As of version 1.92, most of this is easier to do using the the array_filter attribute, or relevance equations in general. They all work on the same page, and fully support cascading relevance.</div><br />
<br />
This workaround applies a filter to a ranking question based on the checked boxes of a previous multiple-options question. There are two methods - one for filter and ranking questions being on the same page and a slightly different one for the filter question being on a page before the ranking question.<br />
<br />
There is a [http://www.partnersinc.biz/surveys//index.php?sid=96314&newtest=Y&lang=en demo of both methods here].<br />
<br />
Implementation is as follows.<br />
<br />
'''FOR BOTH METHODS:'''<br />
*[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
*Place the following script in your template.js file. This function will be accessed by either method.<syntaxhighlight lang="javascript" enclose="div"><br />
// A function to filter choices in a ranking question<br />
function rankFilter(q1ID, q2ID, prevPage) {<br />
<br />
// If filter question is on a previous page, hide Q1 and check all "visible" boxes<br />
if(prevPage == 1) {<br />
$('#question'+q1ID+' li[id<div class="simplebox">="javatbd"]:visible input.checkbox').attr('checked', true);<br />
$('#question'+q1ID+'').hide();<br />
}<br />
<br />
handleChecked(q1ID, q2ID);<br />
$('#question'+q1ID+' input.checkbox').click(function() {<br />
handleChecked(q1ID, q2ID);<br />
});<br />
<br />
function handleChecked(q1ID, q2ID) {<br />
<br />
// Find the survey and group IDs<br />
if($( 'input#fieldnames' ).length != 0) {<br />
var fieldNames = $( 'input#fieldnames' ).attr('value');<br />
var tmp = fieldNames.split('X');<br />
var sID = tmp[0];<br />
var gID = tmp[1];<br />
}<br />
<br />
// Loop through all Q1 options<br />
$('#question'+q1ID+' input.checkbox').each(function(i) {<br />
<br />
// Find the answer code and value<br />
var tmp2 = $(this).attr('id').split('X'+gID+'X'+q1ID+'');<br />
var ansCode = tmp2[1];<br />
var ansTxt = $(this).next('label').text();<br />
<br />
// If option is checked and not in rank choices or output, add it to the rank choices<br />
if($(this).attr('checked') == true<br />
&& $('#question'+q2ID+' select.select option[value="'+ansCode+'"]').length == 0<br />
&& $('#question'+q2ID+' .output input[id</div>="fvalue_"][value="'+ansCode+'"]').length == 0) {<br />
$('<option value="'+ansCode+'">'+ansTxt+'</option>').appendTo('#question'+q2ID+' select.select');<br />
}<br />
<br />
// If option is unchecked...<br />
else if($(this).attr('checked') == false) {<br />
// Remove it from the rank choices<br />
$('#question'+q2ID+' select.select option[value="'+ansCode+'"]').remove();<br />
// Remove it from the rank output and reset hidden values<br />
$('#question'+q2ID+' .output input[id<div class="simplebox">="fvalue_"][value="'+ansCode+'"]').attr('value', '').siblings('input.text').val('').siblings('img').hide();<br />
}<br />
});<br />
<br />
// Clean up empty inputs in the rank output table<br />
$('#question'+q2ID+' .output table tr').each(function(i) {<br />
var nextRow = $(this).next('tr');<br />
if($('input.text', this).val() == '' && $('input.text', nextRow).val() != '') {<br />
$('input.text', this).val($('input.text', nextRow).val());<br />
$('input.text', nextRow).val('');<br />
$('input[id</div>="fvalue_"]', this).attr('value', $('input[id<div class="simplebox">="fvalue_"]', nextRow).attr('value'));<br />
$('input[id</div>="fvalue_"]', nextRow).attr('value', '');<br />
}<br />
});<br />
<br />
// Show the scissors for the last populated rank output row<br />
$('#question'+q2ID+' .output table img[id<div class="simplebox">="cut_"]').hide();<br />
$('#question'+q2ID+' .output table input.text[value!=""]:last').siblings('img[id</div>="cut_"]').show();<br />
<br />
// Hide extra rank output rows<br />
var optNum = $('#question'+q1ID+' input.checkbox:checked').length;<br />
$('#question'+q2ID+' .output table tr').hide();<br />
$('#question'+q2ID+' .output table tr:lt('+(optNum+1)+')').show();<br />
<br />
// Hide and clear the ranking question if there are less than 2 checked options in Q1<br />
if(optNum < 2) {<br />
$('#question'+q2ID+'').hide();<br />
$('#question'+q2ID+' input.text').val('');<br />
$('#question'+q2ID+' input[id<div class="simplebox">="fvalue_"]').attr('value', '');<br />
}<br />
else {<br />
$('#question'+q2ID+'').show();<br />
}<br />
<br />
// A workaround for the built in max-answers function<br />
$('#question'+q2ID+' select.select').attr('disabled', true);<br />
$('#question'+q2ID+' td.output tr:visible').each(function(i) {<br />
if($('input.text', this).val() == '') {<br />
$('#question'+q2ID+' select.select').attr('disabled', false);<br />
}<br />
});<br />
}<br />
<br />
// A listener to work around the built in max-answers function<br />
$('#question'+q2ID+' td.rank').click(function (event) {<br />
$('#question'+q2ID+' select.select').attr('disabled', true);<br />
$('#question'+q2ID+' td.item input.text').each(function(i) {<br />
if ($(this).val() == '') {<br />
$('#question'+q2ID+' select.select').attr('disabled', false);<br />
}<br />
});<br />
});<br />
}</syntaxhighlight><br />
<br />
'''FOR BOTH FILTER AND RANKING QUESTIONS ON SAME PAGE:'''<br />
*Create a multiple options question and a ranking question on the same page (in the same group).<br />
*Both questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Place the following script in the source of one of the questions.<br />
*Replace "MM" with the ID of the multiple options question and "RR" with the ID of the ranking question.<br />
*The function will hide the ranking question unless at least two options are selected in the multiple options question, in which case, it will only show the options selected.<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
rankFilter(MM, RR);<br />
});<br />
</script></syntaxhighlight><br />
<br />
'''FOR FILTER AND RANKING QUESTIONS ON SEPARATE PAGES:'''<br />
*Create a multiple options question on page 1.<br />
*Create a multiple options question and a ranking question on page 2.<br />
*All three questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Set the multiple options on page 2 to be filtered by the multiple options on page 1.<br />
*Place the following script in the source of one of the questions on page 2.<br />
*Replace "MM" with the ID of the multiple options question and "RR" with the ID of the ranking question. Do not modify the "1".<br />
*The function will hide the multiple options question. If at least 2 options were selected in the multiple options on page 1, the corresponding options will be checked in the hidden multiple options question which will then be used to control the display of the ranking question.<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function() {<br />
rankFilter(MM, RR, 1);<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Filter "Array by Column" Question With "Multiple-Options"=<br />
<br />
''Tested with: 1.91, IE 7/8, FireFox 3/4, Safari 5.0, Chrome 10.0''<br />
<br />
This workaround applies a filter to an "Array by Column" question based on the checked boxes of a previous multiple-options question. There are two methods - one for filter and array questions being on the same page and a slightly different one for the filter question being on a page before the array question.<br />
<br />
There is a [http://www.partnersinc.biz/surveys//index.php?sid=74213&newtest=Y&lang=en demo of both methods here].<br />
<br />
Implementation is as follows.<br />
<br />
'''FOR BOTH METHODS:'''<br />
*[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
*Place the following scripts in your template.js file. These functions will be accessed by either method.<syntaxhighlight lang="javascript" enclose="div"><br />
$(document).ready(function() {<br />
<br />
function filterArrByCol(qMultiOpt, qArray, prevPage) {<br />
<br />
// If filter question is on a previous page, hide Q1 and check all "visible" boxes<br />
if(prevPage == 1) {<br />
$('#question'+qMultiOpt+' li[id</div>="javatbd"]:visible input.checkbox').attr('checked', true);<br />
$('#question'+qMultiOpt+'').hide();<br />
}<br />
<br />
// Assign classes to the answer cells<br />
$('#question'+qArray+' table.question tbody td').each(function(i){<br />
var classArr = $(this).attr('class').split('answer_cell_00');<br />
var ansCode = classArr[1];<br />
$(this).addClass('ans-'+ansCode+' filtered');<br />
});<br />
<br />
// Assign classes to the answer label cells<br />
$('#question'+qArray+' table.question tbody tr:eq(0) td').each(function(i){<br />
var classArr2 = $(this).attr('class').split(' ans-');<br />
var ansCode2 = classArr2[1];<br />
$('#question'+qArray+' table.question thead tr:eq(0) th:eq('+i+')').addClass('ans-'+ansCode2+'');<br />
});<br />
<br />
// Fire the filter function on page load<br />
filterArr(qMultiOpt, qArray);<br />
<br />
// Listener on multi-opt checkboxes to fire the filter function<br />
$('#question'+qMultiOpt+' input.checkbox').click(function(){<br />
filterArr(qMultiOpt, qArray);<br />
});<br />
<br />
// On submit, clear all hidden radios of array<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
$('#question'+qArray+' td.filtered:hidden').each(function(i){<br />
$('input.radio', this).attr('checked', false);<br />
});<br />
return true;<br />
});<br />
}<br />
<br />
function filterArr(qMultiOpt, qArray) {<br />
<br />
if($('#question'+qMultiOpt+' input.checkbox:checked').length < 1) {<br />
// Hide the array if no multi-opt options are checked<br />
$('#question'+qArray+'').hide();<br />
}<br />
else {<br />
$('#question'+qArray+'').show();<br />
<br />
// Hide all columns of array<br />
$('#question'+qArray+' table.question tbody td, #question'+qArray+' table.question thead th').hide();<br />
<br />
// Loop through multi-opt checkboxes and, if checked, show corresponding column of array<br />
$('#question'+qMultiOpt+' input.checkbox').each(function(i){<br />
if($(this).attr('checked') == true) {<br />
var classArr3 = $(this).attr('id').split('X'+qMultiOpt);<br />
var ansCode3 = classArr3[1];<br />
$('#question'+qArray+' .ans-'+ansCode3+'').show();<br />
}<br />
});<br />
}<br />
}<br />
});</syntaxhighlight><br />
<br />
'''FOR BOTH FILTER AND ARRAY QUESTIONS ON SAME PAGE:'''<br />
*Create a multiple options question and an array-by-column question on the same page (in the same group).<br />
*Both questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Place the following script in the source of one of the questions.<br />
*Replace "MM" with the ID of the multiple options question and "AA" with the ID of the ranking question.<br />
*The function will hide the array question unless at least one option is selected in the multiple-options question, in which case, it will only show the corresponding array column(s).<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function() {<br />
filterArrByCol(MM, AA);<br />
});<br />
</script></syntaxhighlight><br />
<br />
'''FOR FILTER AND ARRAY QUESTIONS ON SEPARATE PAGES:'''<br />
*Create a multiple options question on page 1.<br />
*Create a multiple options question and an array-by-column question on page 2.<br />
*All three questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Set the multiple options on page 2 to be filtered by the multiple options on page 1.<br />
*Place the following script in the source of one of the questions on page 2.<br />
*Replace "MM" with the ID of the multiple options question and "AA" with the ID of the array question. Do not modify the "1".<br />
*The function will hide the multiple options question. If options were selected in the multiple options on page 1, the corresponding options will be checked in the hidden multiple options question which will then be used to control the display of the array columns.<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function() {<br />
filterArrByCol(MM, AA, 1);<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Auto-tabbing between text input fields=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
This is a workaround to facilitate auto-tabbing between text input questions in a single group using a [http://plugins.jquery.com/project/autotab jQuery plugin by Mathachew] and the Maximum characters attribute of questions.<br />
<br />
The behaviour will be: When the maximum number of characters has been entered into an input field, the focus (cursor) will be automatically moved to the next input field. When the backspace key is used to remove all characters from a field, the focus will be moved to the previous field. It's very useful in surveys having many text input questions to avoid having to manually tab or click between fields.<br />
<br />
You can view a small demo survey [http://www.partnersinc.biz/surveys//index.php?sid=11327&newtest=Y&lang=en here].<br />
<br />
Implementation is as follows:<br />
#Visit [http://plugins.jquery.com/autotabs http://plugins.jquery.com/autotabs], download the plugin script and save it as ''jquery.autotab-1.1b.js'' in the template folder.<br />
#Link to the script by placing ''<script type="text/javascript" src="{TEMPLATEURL}jquery.autotab-1.1b.js"></script>'' within the ''<head>'' tag of startpage.pstpl.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Create the text based questions that auto-tabbing is to be applied to. (All must be in the same group if you're using group by group presentation)<br />
#Define a Maximum characters attribute for all questions that the autotab is applied to.<br />
{{QS:maximum_chars}} <br />
#In the source of the first question of the group that contains the auto-tabbed questions, add the following code.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answerSSSSSXGGXAA').focus(); //initially focus on the first input<br />
<br />
$('#answerSSSSSXGGXAA').autotab({ target: 'answerSSSSSXGGXBB' });<br />
<br />
$('#answerSSSSSXGGXBB').autotab({ previous: 'answerSSSSSXGGXAA', target: 'answerSSSSSXGGXCC' });<br />
<br />
$('#answerSSSSSXGGXCC').autotab({ previous: 'answerSSSSSXGGXBB', target: 'answerSSSSSXGGXDD' });<br />
<br />
$('#answerSSSSSXGGXDD').autotab({ previous: 'answerSSSSSXGGXCC' });<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
This example has 4 fields to be auto-tabbed between - all instances of the following must be replaced to be compatible with your survey (See image below):<br />
*SSSSS -> Survey ID<br />
*GG -> Group ID<br />
*AA -> First question<br />
*BB -> Second question<br />
*CC -> Third question<br />
*DD -> Last question<br />
<br />
[[File:ids_343x252.gif]]<br />
<br />
The ''target'' parameter defines where the next input is and the ''previous'' parameter defines (you guessed it) the previous input.<br />
<br />
This plugin also has limited capability of formatting the input text - see comments in the plugin script.<br />
<br />
=Custom response listeners=<br />
<br />
''Tested with: 1.85+ (7253), IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
Listeners can be used to perform functions when a change in an input is detected. There are many uses such as the [[Workarounds#Reverse_array_filter|Reverse array_filter]] but a simple one would be to warn a respondent if they enter a value that may be too high.<br />
<br />
We can use the [http://docs.jquery.com/Events/change jQuery change( ) event] to fire a function whenever there is a change to the input. The function will look for an input value higher than 10 and, if found, will warn the respondent.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the script below in the source of one of the questions on the page where:<br />
**11111 is the survey ID<br />
**22 is the group ID<br />
**33 is the question ID<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answer11111X22X33').change(function() {<br />
<br />
if ( $('#answer11111X22X33').val() > 10 ) {<br />
alert ("That's an awful lot. Are you sure?");<br />
}<br />
});<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Text input masks=<br />
<br />
''Tested with: 1.90+, IE 7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
There may be instances where you would like to place a mask on a text input - for example only allowing respondents to enter the correct characters for a North American phone number ((###) ###-####) or a Canadian postal code (A1A 1A1) The [http://plugins.jquery.com/project/meioMask jQuery meioMask plugin by fabiomcosta] can be used to do this.<br />
<br />
The plugin has several pre-defined masks and supports custom masks. It also allows for pasting of input, allows default values and can auto-focus the next form element when the current input is completely filled. See [http://www.meiocodigo.com/projects/meiomask/ http://www.meiocodigo.com/projects/meiomask/] for more details on features and options.<br />
<br />
There is a small demo [http://www.partnersinc.biz/surveys//index.php?sid=36146&newtest=Y&lang=en here].<br />
<br />
Implementation for this demo was as follows:<br />
#Visit [http://www.meiocodigo.com/projects/meiomask/ http://www.meiocodigo.com/projects/meiomask/], download the latest plugin script and save it as jquery.meiomask.js in the template folder.<br />
#Link to the script by placing <script type="text/javascript" src="{TEMPLATEURL}jquery.meiomask.js" charset="utf-8"></script> within the <head> tag of startpage.pstpl.<br />
#Turn off $filterxsshtml to allow insertion of JavaScript in the questions. ([http://docs.limesurvey.org/tiki-index.php?page=Optional+settings&structure=English+Instructions+for+LimeSurvey#Filtering_dangerous_HTML_tags_in_survey_objects See documentation here])<br />
#Create the text input questions that the masks are to be applied to<br />
#In the source of the help section of the first question of the group that contains the masked inputs, add the following code. ([http://docs.limesurvey.org/tiki-index.php?page=Workarounds&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._ See How to use script here]) <br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() { <br />
<br />
// Define custom masks<br />
$.mask.masks = $.extend($.mask.masks,{<br />
customMask1:{ mask: 'a9a 9a9' }, // Canadian postal code<br />
// Maximum input of 9,999.99, reverse input, default value of 0.00 <br />
customMask2:{ mask: '99.999,9', type : 'reverse', defaultValue : '000' } <br />
});<br />
<br />
// Set the 'alt' attributes of the inputs<br />
$('#answer111111X22XAA').attr('alt', 'phone-us'); // a pre-defined mask <br />
$('#answer111111X22XBB').attr('alt', 'customMask1'); // a custom mask <br />
$('#answer111111X22XCC').attr('alt', 'customMask2'); // a custom mask <br />
$('#answer111111X22XDD').attr('alt', 'cc'); // a pre-defined mask for credit card<br />
<br />
// Tell the plugin to apply masks to these inputs<br />
$('input:#answer111111X22XAA').setMask();<br />
$('input:#answer111111X22XBB').setMask();<br />
$('input:#answer111111X22XCC').setMask();<br />
$('input:#answer111111X22XDD').setMask(); <br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
<br />
The first section defines two custom masks to be used - one for Canadian postal code with a format of A#A #A# and a second for a maximum amount of 9999.99 with reverse input (useful for cost inputs) and a default value of 0.00.<br />
<br />
The next section sets the "alt" attributes for the text inputs. This will tell meioMask which mask we will be applying to each input. By default meioMask looks at the alt attribute to find which mask to apply however this can be changed using the [http://www.meiocodigo.com/projects/meiomask/#mm_options mask options].<br />
<br />
In the final section we apply the masks to the inputs.<br />
<br />
This example has 4 inputs with masks on them - all instances of the following must be replaced to be compatible with your survey (See image below):<br />
<br />
*11111 -> Survey ID<br />
*22 -> Group ID<br />
*AA -> First question<br />
*BB -> Second question<br />
*CC -> Third question<br />
*DD -> Fourth question<br />
<br />
[[File:Ids 343x252.gif]]<br />
<br />
=Text input masks - second method=<br />
<br />
''Tested with: 1.91RC6+, FireFox 4.0''<br />
<br />
There may be instances where you would like to place a mask on a text input - for example only allowing respondents to enter the correct characters for a North American phone number ((###) ###-####) or a US social security number (###-##-####). The jQuery meioMask plugin by fabiomcosta is no longer supported but an alternative exists. The DigitalBush Masked Input Plugin is updated and simple to implement in LimeSurvey. See [http://digitalbush.com/projects/masked-input-plugin/ http://digitalbush.com/projects/masked-input-plugin/] for more details on features and options.<br />
<br />
Implementation as follows:<br />
<br />
#Visit [http://digitalbush.com/projects/masked-input-plugin/ http://digitalbush.com/projects/masked-input-plugin/], download the latest plugin script and save it as jquery.maskedinput.js in the template folder.<br />
#Link to the script by placing <script type="text/javascript" src="{TEMPLATEURL}jquery.maskedinput.js" charset="utf-8"></script> within the <head> tag of startpage.pstpl.<br />
#Turn off $filterxsshtml to allow insertion of JavaScript in the questions. ([http://docs.limesurvey.org/tiki-index.php?page=Optional+settings&structure=English+Instructions+for+LimeSurvey#Filtering_dangerous_HTML_tags_in_survey_objects See documentation here])<br />
#Create the text input questions that the masks are to be applied to<br />
#In the source of the help section of the first question of the group that contains the masked inputs, add the following code. ([http://docs.limesurvey.org/tiki-index.php?page=Workarounds&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._ See How to use script here]) <br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function($) { <br />
$("#answer55431X1X5").mask("999-99-9999",{ placeholder:"#" });<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
<br />
Replace the "#answer55431X1X5" with your survey ID, group ID, and question ID. You can change the mask format and change or eliminate the placeholder if you wish. If you have multiple questions in the same group, simply copy and paste the line that begins with "$" and change the code to what is needed for your application.<br />
<br />
=Select a random response to a "Multiple options" question for later use=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
This workaround allows you to randomly select one of the checked boxes in a "Multiple options" question and store it's label for later use in the survey. A possible use would be to have a question asking what products were purchased and then randomly selecting one of the products to ask further questions about.<br />
<br />
There is a small demo of the above example [http://www.partnersinc.biz/surveys//index.php?sid=81252&newtest=Y&lang=en here].<br />
<br />
Basically what we've done here is to put listeners on all of the checkboxes. If a change of state is detected in any of them the "randomResponse" function is called which loops through all of the checkboxes and if it finds a checked state, that box's label is added to an array. Then a random item is pulled from the array and used to populate the hidden question. This hidden question can then be drawn upon later in the survey using [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+Question#Information_from_previous_answers INSERTANS] or [http://docs.limesurvey.org/tiki-index.php?page=Setting+conditions&structure=English+Instructions+for+LimeSurvey Conditions].<br />
<br />
Implementation for this demo is as follows:<br />
<br />
#[http://docs.limesurvey.org/tiki-index.php?page=Workarounds%3A+Manipulating+a+survey+at+runtime+using+Javascript&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._in_LimeSurvey_ Set up your survey to use JavaScript].<br />
#Create a "Multiple options" question that we're going to randomly pick a checked box from<br />
#Create a text input question to store the label of the checked box in (we're going to hide this with JavaScript)<br />
#Place the script below in the source of one of the questions on the page. <br />
<br />
The following edits are required to implement this in your survey:<br />
<br />
*EDIT HERE (1) - 11111 -> Survey ID, 22 -> Group ID, 44 -> hidden question ID.<br />
*EDIT HERE (2) - 44 -> hidden question ID.<br />
*EDIT HERE (3) - 11111 -> Survey ID, 22 -> Group ID, 33 -> multiple option question ID, A/B/C/D/E/F -> multiple option answer codes. Also add or remove CBs for more or less checkboxes.<br />
*EDIT HERE (4) - add or remove CBs for more or less checkboxes.<br />
*EDIT HERE (5) - add or remove CBs for more or less checkboxes. <br />
<br />
For more info on these IDs see [http://docs.limesurvey.org/tiki-index.php?page=SGQA+identifier&structure=English+Instructions+for+LimeSurvey SGQA identifier].<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
//// Identify the hidden question input<br />
//// EDIT HERE (1) - replace with your hidden question input ID<br />
var hiddenInput = '#answer11111X22X44';<br />
<br />
//// Make the "hidden" question disappear<br />
//// EDIT HERE (2) - replace with your hidden question ID<br />
$('#question44').hide();<br />
<br />
//// Identify the checkboxes to be randomized<br />
//// EDIT HERE (3) - add or remove as required, <br />
//// replace with your checkbox IDs<br />
var CB1 = '#answer11111X22X33A';<br />
var CB2 = '#answer11111X22X33B';<br />
var CB3 = '#answer11111X22X33C';<br />
var CB4 = '#answer11111X22X33D';<br />
var CB5 = '#answer11111X22X33E';<br />
var CB6 = '#answer11111X22X33F';<br />
<br />
//// Create an array of all checkboxes to be randomized<br />
//// EDIT HERE (4) - add or remove CBs as required<br />
checkBoxes = new Array( CB1, CB2, CB3, CB4, CB5, CB6 );<br />
var checkBoxesLength = checkBoxes.length;<br />
<br />
//// The randomizing function - no editing required<br />
function randomResponse () {<br />
var boxLabels = new Array();<br />
<br />
// loop through all of the checkboxes and if they are checked, <br />
// add their label to the boxLabels array<br />
for( var i=0; i<checkBoxesLength; i++ ) {<br />
if ( $(checkBoxes[i]).attr('checked') == true ) {<br />
var cbid = checkBoxes[i].replace('#','');<br />
boxLabels.push( $( 'label[for=' + cbid + ']' ).html() );<br />
}<br />
}<br />
<br />
// find a random index of the responses array<br />
var randomNum = Math.floor(Math.random() * boxLabels.length); <br />
<br />
// populate the hidden question input with the <br />
// random input value<br />
$(hiddenInput).val( boxLabels[randomNum] ); <br />
}<br />
<br />
//// The listeners that will fire the randomize function if a <br />
//// change occurs in the checkboxes<br />
//// EDIT HERE (5) - add or remove CBs as required<br />
$(CB1).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB2).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB3).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB4).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB5).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB6).change(function() {<br />
randomResponse ();<br />
}); <br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
=Display secondary options in a "Multiple options" question=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows you to display secondary options in a "Multiple options" question if a primary option is checked as in the images below.<br />
<br />
Primary option not selected:<br /><br />
[[File:Secondary_options_1.jpg]]<br />
<br />
<br />
Primary option selected:<br /><br />
[[File:Secondary_options_2.jpg]]<br />
<br />
<br />
There is a small demo of the above example [http://www.partnersinc.biz/surveys//index.php?sid=11491&newtest=Y&lang=en here].<br />
<br />
We've put a listener on the primary answer ("Option 1" in the demo) that shows or hides the secondary answers depending on the state of the primary.<br />
<br />
Implementation for this demo is as follows:<br />
<br />
#[http://docs.limesurvey.org/tiki-index.php?page=Workarounds%3A+Manipulating+a+survey+at+runtime+using+Javascript&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._in_LimeSurvey_ Set up your survey to use JavaScript].<br />
#Create a "Multiple options" question including both the primary and secondary answers (in the order that you would like them displayed if all shown)<br />
#Add the following script to the source of the question.<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
/**** <br />
The following code puts a listener on an answer in a multiple options<br />
question (the primary answer) and if that answer is checked, a secondary <br />
level of answers is displayed.<br />
****/<br />
<br />
// --- 1 --- Indent the secondary answers a bit<br />
$( '#questionQQ li:eq(1)' ).css({ 'margin-left':'2.5em' });<br />
$( '#questionQQ li:eq(2)' ).css({ 'margin-left':'2.5em' });<br />
<br />
// --- 2 --- When the page loads, see if the primary answer is checked and if not, <br />
//hide and un-check all secondary answers<br />
if ($( '#answerSSSSSXGGXQQAA' ).attr('checked') == false ) {<br />
<br />
$( '#questionQQ li:eq(1)' ).hide();<br />
$( '#questionQQ li:eq(2)' ).hide();<br />
<br />
$( '#answerSSSSSXGGXQQBB' ).attr('checked', false);<br />
$( '#answerSSSSSXGGXQQCC' ).attr('checked', false);<br />
}<br />
<br />
// --- 3 --- Now put a listener on the primary answer to show or hide secondary answers <br />
// We need to use .click instead of .change cause IE won't cooperate<br />
$('#answerSSSSSXGGXQQAA').click(function (event) {<br />
<br />
// Have a look at the primary answer and hide/show the secondary answers accordingly<br />
if ($( '#answerSSSSSXGGXQQAA' ).attr('checked') == false ) {<br />
<br />
$( '#questionQQ li:eq(1)' ).hide();<br />
$( '#questionQQ li:eq(2)' ).hide();<br />
<br />
$( '#answerSSSSSXGGXQQBB' ).attr('checked', false);<br />
$( '#answerSSSSSXGGXQQCC' ).attr('checked', false);<br />
}<br />
else {<br />
<br />
$( '#questionQQ li:eq(1)' ).show();<br />
$( '#questionQQ li:eq(2)' ).show();<br />
} <br />
<br />
// The original functions of the click event<br />
cancelBubbleThis(event);<br />
checkconditions(this.value, this.name, this.type);<br />
}<br />
);<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
<br />
The following edits are required to implement this in your survey:<br />
<br />
'''Section 1:'''<br />
*This section indents the secondary answers to give the look of a list in a list when they're shown<br />
*'''QQ''' is your question ID<br />
*'''eq(1)''' and '''eq(2)''' are the index positions of your secondary options. Modify or add as necessary for the number and placement of secondary options in your question. Note that the index starts at 0 so '''eq(1)''' actually affects the second option in the full list and '''eq(2)''' affects the third. <br />
<br />
'''Section 2:'''<br />
*This section checks the state of the primary question when the page is loaded and if necessary hides the secondary questions. We need this in case users navigate away from and then back to the page.<br />
*Modify '''eq(1)''' and '''eq(2)''' as above.<br />
*'''SSSSS''' is your survey ID.<br />
*'''GG''' is your group ID.<br />
*'''QQ''' is your question ID.<br />
*'''AA''' is your primary answer code.<br />
*'''BB''' and '''CC''' are your secondary answer codes (add as necessary). <br />
<br />
'''Section 3:'''<br />
*This is the section that "listens" to the primary answer and reacts accordingly.<br />
*Edit as in section 2.<br />
<br />
For more info on these IDs see SGQA identifier(external link).<br />
<br />
This code could be tidied up and shortened a bit but I left it this way to make it easier to follow.<br />
<br />
=Minimum number of required answers in an array (pre 1.92)=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2,''<br />
<br />
<div class="simplebox">As of version 1.92 all array style questions have the min_answers and max_answers options, so this script is obsolete.</div><br />
<br />
This workaround allows you to specify a '''minimum number''' of answers required in an array question. It is an alternative to the "Mandatory" parameter which specifies that '''all''' answers are required. It could also be easily modified to specify a maximum number of answers.<br />
<br />
We accomplish this by placing an onload function in the source of the array question. This function hides the Next/Submit button and displays a warning element until it detects a minimum number of responses. It then hides the warning and shows the Next/Submit button.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=97166&newtest=Y&lang=en here].<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Set up the template to use custom onload functions. (See the [[Workarounds#Custom onload function|workaround here]])<br />
#In the source of the array question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Modify the ''SETTINGS'' section of the code as required.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
// Wait until the document is fully loaded<br />
$(document).ready(function() {<br />
<br />
/********************** SETTINGS **********************/<br />
// The text to appear in the warning element<br />
var warningText = 'Please answer at least 4 to continue';<br />
// The question ID<br />
var questionId = 137;<br />
// The minimum number of answers required<br />
var minNumber = 4;<br />
/******************************************************/<br />
<br />
// Create the warning element and place it after the submit button<br />
var el = document.createElement('div');<br />
el.setAttribute('id','warning');<br />
document.body.appendChild(el);<br />
$( '#warning' ).css({<br />
'border':'1px solid #333333',<br />
'width':'200px',<br />
'padding':'3px',<br />
'color':'red'<br />
});<br />
$('#warning').html(warningText);<br />
$('input[type="submit"]').after($('#warning'));<br />
<br />
// Detect the initial number of checked answers & display Next/Submit button accordingly<br />
var inputInitCount = 0;<br />
$('#question' + questionId + ' input').each(function(i) {<br />
if ($( this ).attr('checked') == true ) {<br />
inputInitCount++;<br />
}<br />
});<br />
if (inputInitCount > (minNumber - 1)) {<br />
$('input[type="submit"]').show();<br />
$('#warning').hide();<br />
}<br />
else {<br />
$('#warning').show();<br />
$('input[type="submit"]').hide();<br />
}<br />
<br />
// Listener to detect number of checked answers & display Next/Submit button accordingly<br />
$('#question' + questionId + ' input.radio, #question'+questionId+' tbody[id<div class="simplebox">="javatbd"] td').click(function() {<br />
var inputCount = 0;<br />
$('#question' + questionId + ' input.radio').each(function(i) {<br />
if ($( this ).attr('checked') == true ) {<br />
inputCount++;<br />
}<br />
});<br />
if (inputCount > (minNumber - 1)) {<br />
$('input[type="submit"]').show();<br />
$('#warning').hide();<br />
}<br />
else {<br />
$('#warning').show();<br />
$('input[type="submit"]').hide();<br />
}<br />
<br />
// The original functions of the click event<br />
checkconditions(this.value, this.name, this.type);<br />
});<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Minimum elapsed time before moving forward in survey=<br />
<br />
''Tested with: 1.91, IE 7/8, Firefox 7.0, Safari 3.2''<br />
<br />
This workaround interrupts the Next/Submit function and checks the amount of time elapsed since the page loaded. If the time is less than the minimum dictated, the respondent is alerted and not allowed to proceed. It is useful if you want to enforce a minimum amount of time spent viewing a page.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the script below in the source of one of the questions on the page, replacing "TT" with the minimum number of seconds required before advancing is allowed.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
minTime(TT);<br />
<br />
function minTime(minTime) {<br />
<br />
var startTime = new Date();<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
var endTime = new Date();<br />
<br />
if((endTime - startTime)/1000 <= minTime) {<br />
alert ('You must spend at least '+minTime+' seconds on the question.');<br />
return false;<br />
}<br />
else {<br />
return true;<br />
}<br />
});<br />
}<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
=Minimum number of characters in Long free text or Huge free text questions=<br />
<br />
''Tested with: 1.91, IE 7/8, Firefox 7.0, Safari 3.2''<br />
<br />
<div class="simplebox">As of version 1.91, you can use regular expression masks (validation) to specify the minimum number of required characters. However, even if the question is mandatory, it can still be blank.</div><br />
<br />
<div class="simplebox">As of version 1.92, if you make the question mandatory and use a validation mask to specify the minimum number of characters, then the user will be forced to answer the question. Note that unlike 1.91, they can submit their current answers, even if partially invalid (so they are stored in the database), but they will not ber able to proceed to the next page until they have passed all mandatory and validity checks.</div><br />
<br />
This workaround interrupts the Next/Submit function and checks the number of characters entered in a Long free text or Huge free text question. If the number is less than the minimum dictated, the respondent is alerted and not allowed to proceed.<br />
<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
<br />
#Place the script below in the source of one of the questions on the page, replace "QQ" with the question ID and "CC" with the minimum number of characters required before advancing is allowed.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
minChar(QQ, CC);<br />
<br />
function minChar(qID, minChars) {<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
if($('#question'+qID+' textarea').val().replace(/ /g,'').length < minChars) {<br />
<br />
alert ('You must enter at least '+minChars+' characters.');<br />
<br />
return false;<br />
<br />
}<br />
<br />
else {<br />
<br />
return true;<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Variable Length Array (Multi Flexible Text) question=<br />
<br />
''Tested with: 1.90+, IE 6/7/8, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows a respondent to add or remove rows of an Array (Multi Flexible Text) question. It's useful to avoid the page being cluttered with unnecessary array rows.<br />
<br />
A function is placed in the template.js file of your template (use template editor). This function hides all of the array rows except the first and inserts two elements that when clicked show or hide rows accordingly.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=53132&newtest=Y&lang=en here].<br />
<br />
It must be noted that you can not make this question Mandatory as the respondent will have no way to complete hidden fields. If you want the displayed fields to be mandatory you will need to validate them in another function or modify this function to only allow the addition of rows if all fields in the last row are completed and then disable those fields - that, however, is a little over the top for this example.<br />
<br />
Implementation is as follows:<br />
<br />
#Set up your survey to use JavaScript (See instructions [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|here]])<br />
<br />
#Add the following script to your ''template.js'' file.<br />
<br />
#Replace "QQ" in the function call at the end with the question ID.<br />
<br />
#Create one or more Array (Multi Flexible Text) questions<br />
<br />
#If you want to apply it to more arrays on the same page simply add more calls with the appropriate question IDs. (eg. varLengthArray(1); varLengthArray(2);...)<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div">$(document).ready(function() {<br />
<br />
// A function to add or remove rows of an Array (Multi Flexible)(Text) question<br />
function varLengthArray(qID) {<br />
<br />
if ($('#question'+qID+'').length > 0) {<br />
<br />
// The HTML content of the Add/Remove elements - modify as you wish<br />
var addContent = '[+]';<br />
var removeContent = '[-]';<br />
<br />
// Create the Add and Remove elements & insert them<br />
var el1 = document.createElement('div');<br />
el1.setAttribute('id','addButton'+qID);<br />
document.body.appendChild(el1);<br />
var el2 = document.createElement('div');<br />
el2.setAttribute('id','removeButton'+qID);<br />
document.body.appendChild(el2);<br />
<br />
// Move them to after the array<br />
$( 'div#addButton'+qID ).appendTo($( '#question' + qID + ' table.question' ).parent());<br />
$( 'div#removeButton'+qID ).appendTo($( '#question' + qID + ' table.question' ).parent());<br />
<br />
// Insert their HTML<br />
$( 'div#addButton'+qID ).html( addContent );<br />
$( 'div#removeButton'+qID ).html( removeContent );<br />
<br />
// Style the elements - you can modify here if you wish<br />
$( 'div#addButton'+qID ).css({<br />
'margin':'10px 0 0 10px',<br />
'padding':'1px',<br />
'text-align':'center',<br />
'font-weight':'bold',<br />
'width':'auto',<br />
'cursor':'pointer',<br />
'float':'left'<br />
});<br />
<br />
$( 'div#removeButton'+qID ).css({<br />
'margin':'10px 0 0 10px',<br />
'padding':'1px',<br />
'text-align':'center',<br />
'font-weight':'bold',<br />
'width':'auto',<br />
'cursor':'pointer',<br />
'float':'left'<br />
});<br />
<br />
// Initially hide the Remove element<br />
$( 'div#removeButton'+qID ).hide();<br />
<br />
// Call the functions below when clicked<br />
$( 'div#addButton'+qID ).click(function (event) {<br />
addRow(qID);<br />
});<br />
$( 'div#removeButton'+qID ).click(function (event) {<br />
removeRow(qID);<br />
});<br />
<br />
// Function to add a row, also shows the Remove element and hides the<br />
//Add element if all rows are shown<br />
function addRow(qID) {<br />
var arrayRow = '#question' + qID + ' table.question tbody';<br />
var rowCount = $( arrayRow ).size() - 1;<br />
$( arrayRow + '[name="hidden"]:first' ).attr('name', 'visible').show();<br />
$( 'div#removeButton'+qID ).show();<br />
if ( $( arrayRow + ':eq(' + rowCount + ')' ).attr('name') == 'visible' ) {<br />
$( 'div#addButton'+qID ).hide();<br />
}<br />
}<br />
<br />
// Function to remove a row, also clears the contents of the removed row,<br />
// shows the Add element if the last row is hidden and hides the Remove<br />
// element if only the first row is shown<br />
function removeRow(qID) {<br />
var arrayRow = '#question' + qID + ' table.question tbody';<br />
var rowCount = $( arrayRow ).size() - 1;<br />
$( arrayRow + '[name="visible"]:last input[type="text"]' ).val('');<br />
$( arrayRow + '[name="visible"]:last' ).attr('name', 'hidden').hide();<br />
$( 'div#addButton'+qID ).show();<br />
if ( $( arrayRow + ':eq(1)' ).attr('name') == 'hidden' ) {<br />
$( 'div#removeButton'+qID ).hide();<br />
}<br />
}<br />
<br />
// Just some initialization stuff<br />
var arrayRow = '#question' + qID + ' table.question tbody';<br />
var rowCount = '';<br />
<br />
// Initially hide all except first row or any rows with populated inputs<br />
$( arrayRow ).each(function(i) {<br />
if ( i > 0 ) {<br />
// We also need to give the hidden rows a name cause IE doesn't<br />
// recognize jQuery :visible selector consistently<br />
$( this ).attr('name', 'hidden').hide();<br />
<br />
$('input[type=text]', this).each(function(i) {<br />
if ($(this).attr('value') != '') {<br />
$(this).parents('tbody:eq(0)').attr('name', 'visible').show();<br />
$( 'div#removeButton'+qID ).show();<br />
}<br />
});<br />
rowCount = i;<br />
}<br />
});<br />
}<br />
}<br />
<br />
// Call the function with a question ID<br />
varLengthArray(QQ);<br />
<br />
});</syntaxhighlight><br />
<br />
=Expandable Array=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.5, Safari 3.2''<br />
<br />
This workaround allows you to present an array question incrementally. That is to say that initially only the first option (row) in the array is shown. When that option is answered the next is shown and so-on.<br />
<br />
A JavaScript function is placed in the source of the array question. This function hides all of the array rows except the first and then displays them as options are answered.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=94958&newtest=Y&lang=en here].<br />
<br />
The workaround supports following question types:<br />
*Array (flexible labels)<br />
*Array (flexible labels) by column<br />
*Array (Yes/No/Uncertain)<br />
*Array (Increase, Same, Decrease)<br />
*Array (Flexible Labels) dual scale<br />
*Array (10 point choice)<br />
<br />
Implementation is as follows:<br />
#Set up your survey to use JavaScript. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|documentation here]])<br />
#Create one or more Array questions<br />
#In the source of the first array question add the following script.<br />
#Replace "QQ" in the function call at the end of the script with the question ID of the array you would like to manipulate.<br />
#If you want to apply it to more arrays on the same page, simply add more calls with the appropriate question IDs. (eg. expandingArray(1); expandingArray(2);...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
// A function to show subsequent rows of an array as options are checked<br />
function expandingArray(qID) {<br />
<br />
// Build an array of the question rows<br />
var arrayRow = '#question' + qID + ' table.question tbody tr';<br />
<br />
// Initially hide all rows unless an input was previously checked<br />
$( arrayRow ).each(function(i) {<br />
<br />
if ( $( arrayRow + ':eq(' + i + ') input.radio:checked' ).length != 0 ) {<br />
$(this).attr('name', 'clickedRow');<br />
}<br />
else {<br />
$(this).attr('name', 'hidden').hide();<br />
}<br />
});<br />
<br />
// Now show the first hidden row<br />
addRow();<br />
<br />
// Add another row when an option is checked for the first time<br />
$( '#question' + qID + ' td.answer input.radio' ).click(function (event) {<br />
<br />
if ($(this).parents('tr:eq(0)').attr('name') != 'clickedRow') {<br />
addRow();<br />
$(this).parents('tr:eq(0)').attr('name', 'clickedRow');<br />
}<br />
<br />
// The original function of the click event<br />
checkconditions(this.value, this.name, this.type);<br />
});<br />
<br />
// Add another row when an table cell is clicked for the first time<br />
$( '#question' + qID + ' table.question tbody td' ).click(function (event) {<br />
<br />
if ($(this).parents('tr:eq(0)').attr('name') != 'clickedRow') {<br />
addRow();<br />
$(this).parents('tr:eq(0)').attr('name', 'clickedRow');<br />
}<br />
});<br />
<br />
// Function to add a row<br />
function addRow() {<br />
$( arrayRow + '[name="hidden"]:first' ).attr('name', 'visible').show();<br />
}<br />
}<br />
<br />
// Call the function with a question ID<br />
expandingArray(QQ);<br />
<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - Multiple Options & List (radio) questions - ENHANCED=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows the answers of Multiple Options & List (radio) questions to be randomized while always keeping as many answers at the end of the list as specified by the var insertitems=n, where n is the number of answers you want left unrandomized. It's useful if you want to randomize, say, the first 4 of your answers but always have the 5th to 7th displayed last as in the image below (assuming you assigned the number 3 to insertitems):<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
Some conditions on the use of this are:<br />
*For Select/radio type questions it will only work if the [[Optional settings#Survey Behavior|$shownoanswer option]] is set to 0 in config.php. ("No answer" is removed from the end of questions)<br />
*You must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more Multiple Options or List (radio) questions with sequential response codes. Set the [[Advanced question settings#random order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Set var insertitems=n (n = the number of items you want un-randomized)<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRand(11111, 22, 1); partRand(11111, 22, 2); ...)<br />
<br />
Onload code:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers except the last one in Multiple options and List/radio questions<br />
<br />
function partRand(sID, gID, qID) {<br />
<br />
//var to define how many lists to be added at the end<br />
<br />
var insertitems=3;<br />
<br />
// Find the number of answers<br />
<br />
var ansCount = ''<br />
<br />
lastitems=new Array();<br />
<br />
var liid=new Array();<br />
<br />
var $ul;<br />
<br />
var j=0;<br />
<br />
$( '#question' + qID + ' td.answer li' ).each(function(i) {<br />
<br />
ansCount = (i + 1);<br />
<br />
});<br />
<br />
$( '#question' + qID + ' td.answer li' ).each(function(i) {<br />
<br />
if(i>ansCount-(insertitems+1)){<br />
<br />
lastitems[j]=$(this).html();<br />
<br />
liid[j]=$(this).attr("id");<br />
<br />
j++;<br />
<br />
$(this).remove();<br />
<br />
}<br />
<br />
});<br />
<br />
$( '#question' + qID + ' td.answer li' ).each(function(i) {<br />
<br />
// get current ul<br />
<br />
$ul = $(this).parent();<br />
<br />
// get array of list items in current ul<br />
<br />
var $liArr = $ul.children('li');<br />
<br />
// sort array of list items in current ul randomly<br />
<br />
$liArr.sort(function(a,b){<br />
<br />
// Get a random number between 0 and 100<br />
<br />
var temp = parseInt( Math.random()*100 );<br />
<br />
// Get 1 or 0, whether temp is odd or even<br />
<br />
var isOddOrEven = temp%2;<br />
<br />
// Get +1 or -1, whether temp greater or smaller than 5<br />
<br />
var isPosOrNeg = temp>5 ? 1 : -1;<br />
<br />
// Return -1, 0, or +1<br />
<br />
return( isOddOrEven*isPosOrNeg );<br />
<br />
})<br />
<br />
// append list items to ul<br />
<br />
.appendTo($ul);<br />
<br />
});<br />
<br />
$.each(lastitems,function(i){<br />
<br />
$( $ul ).append("<li id="+liid[i]+">"+this+"</li>");<br />
<br />
});<br />
<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
<br />
partRand(SSSSS, GG, QQ);<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - Multiple Options & List (radio) questions=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows the answers of Multiple Options & List (radio) questions to be randomized while always keeping one answer at the end of the list. It's useful if you want to randomize, say, the first 4 of your answers but always have the fifth displayed last as in the image below:<br />
<br />
[[File:random_336x179gif.gif]]<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=89344&newtest=Y&lang=en here].<br />
<br />
Some conditions on the use of this are:<br />
*For Select/radio type questions it will only work if the [[Optional settings#Survey Behavior|$shownoanswer option]] is set to 0 in config.php. ("No answer" is removed from the end of questions)<br />
*You must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more Multiple Options or List (radio) questions with sequential response codes. Set the [[Advanced question settings#random_order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRand(11111, 22, 1); partRand(11111, 22, 2); ...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers except the last one in Multiple options and List/radio questions<br />
function partRand(sID, gID, qID) {<br />
<br />
// Find the number of answers<br />
var ansCount = ''<br />
$( 'div#question' + qID + ' td.answer li' ).each(function(i) {<br />
ansCount = (i + 1);<br />
});<br />
<br />
// Place the last answer created at the end of the list<br />
$( 'input#answer' + sID + 'X' + gID + 'X' + qID + ansCount + '' ).parent().appendTo($( '#question' + qID + ' td.answer ul' ));<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
partRand(SSSSS, GG, QQ);<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - List (dropdown) questions=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround, similar to the one above, allows the answers of List (dropdown) questions to be randomized while always keeping one answer at the end of the list. It's useful if you want to randomize, say, the first 4 of your answers but always have the fifth displayed last.<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=89344&newtest=Y&lang=en here].<br />
<br />
A condition is that you must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more List (dropdown) questions with sequential response codes. Set the [[Advanced question settings#random order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRandDD(11111, 22, 1); partRandDD(11111, 22, 2); ...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers<br />
//except the last one in List/dropdown questions<br />
function partRandDD(sID, gID, qID) {<br />
<br />
// Find the number of answers<br />
var ansCount = ''<br />
$( 'div#question' + qID + ' select option' ).each(function(i) {<br />
ansCount = i;<br />
});<br />
<br />
// Place the last answer created at the end of the list<br />
$( 'option[value="' + ansCount + '"]' ).appendTo($( 'div#question' + qID + ' select' ));<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
partRandDD(89344, 72, 244);<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - Multiple numerical input=<br />
<br />
''Tested with: 1.90+, Safari 5.1''<br />
<br />
This workaround, similar to the ones above, allows the answers of Multiple numerical input questions to be randomized while always keeping one answer at the end of the list. It's useful if you want to randomize, say, the first 4 of your answers but always have the fifth displayed last.<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
A condition is that you must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more Multiple numerical input question with sequential response codes. Set the [[Advanced question settings#random order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRandDD(11111, 22, 1); partRandDD(11111, 22, 2); ...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers except the last one in multiple numeric input questions<br />
function partRand(sID, gID, qID) {<br />
<br />
// Find the number of answers<br />
var ansCount = ''<br />
$( 'div#question' + qID + ' div.answers li' ).each(function(i) {<br />
ansCount = (i - 1);<br />
});<br />
<br />
// Place the last answer created at the end of the list - but before the first helping sum<br />
$( 'li#javatbd' + sID + 'X' + gID + 'X' + qID + ansCount + '' ).insertBefore($( 'div#question' + qID + ' div.answers li.multiplenumerichelp' ).first());<br />
<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
partRand(SID, GID, QID);<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
Using this solution for Multiple numerical input questions might be a bit more complicated than for other question types. All answers are organized in an unordered list (<nowiki><ul></nowiki>) structure. However, if advanced question settings like ''Equals sum value'' are used, LimeSurvey adds helping information (e.g. sum of all entries and remainder) to the same unordered list using the class ''multiplenumerichelp'' for these additional list items. The above example assumes that at least one of these list items is present and moves the last answer to the position right above the first helper item. Without such advanced settings, the code will most certainly need adaptation.<br />
<br />
=Making one (or more) rows of an array mandatory=<br />
<br />
''Tested with: 1.90+, IE 6/7, Firefox 3.0, Safari 3.2''<br />
<br />
This workaround allows you to define one or more rows of an array question as mandatory (instead of all of them which the "Mandatory" question setting does). It is [http://www.partnersinc.biz/surveys//index.php?sid=26842&newtest=Y&lang=en demonstrated here].<br />
<br />
A JavaScript function interrupts the submit function and checks if the inputs in the mandatory row(s) are populated. If not, an alert is popped up, the offending inputs are turned pink and the submit is aborted. Otherwise the submit goes ahead.<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions (see [[Optional settings#Security|documentation here]]).<br />
#Create the array question.<br />
#In the source of the array question add the following script (see [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]]).<br />
#Modify the warningText (line10)as required.<br />
#Replace "QQ" (lines 13 and 14) with the question ID and add calls as necessary for more rows - the example code renders rows 1 and 3 mandatory.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function () {<br />
<br />
// Interrupt the submit function<br />
$('form#limesurvey').submit(function () {<br />
<br />
// Override the built-in "disable navigation buttons" feature<br />
$('#moveprevbtn, #movenextbtn, #movesubmitbtn').attr('disabled', '');<br />
<br />
var empty = 0;<br />
var warningText = 'Please complete the highlighted inputs.';<br />
<br />
// Call the mandatory row function with question IDs and row numbers<br />
mandatoryRow(QQ, 1);<br />
mandatoryRow(QQ, 3);<br />
<br />
// A function to render rows of an array mandatory<br />
function mandatoryRow(qID, rowNum) {<br />
<br />
$('div#question' + qID + ' table.question tbody[id</div>="javatbd"]:eq(' + Number(rowNum - 1) + ') input[type="text"]').each(function (i) {<br />
<br />
if ($(this).val() == '') {<br />
$(this).css('background-color', 'pink');<br />
empty = 1;<br />
} <br />
else {<br />
$(this).css('background-color', '#FFFFFF');<br />
}<br />
});<br />
}<br />
<br />
if (empty == 1) {<br />
alert(warningText);<br />
return false;<br />
} <br />
else {<br />
return true;<br />
}<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Randomly displaying one of a few YouTube videos, and recording which was displayed=<br />
<br />
''Tested in 1.85+''<br />
<br />
Jason Cleeland has created and documented a method to randomly display one of a number of youtube videos in a single question, and save which one was displayed.<br />
<br />
http://www.aptigence.com.au/home/archives/23-Random-display-of-videos-in-a-question-2-YouTube.html<br />
<br />
=Randomly displaying one of a few pictures, and recording which was displayed=<br />
<br />
''Tested in 1.91+''<br />
<br />
The following steps allow you to randomly display one of a few pictures and record in the dataset which picture was displayed. We use four pictures in this example, but you can easily adapt these scripts according to your needs.<br />
<br />
1. Create a new sub-directory '''pic''' in your LimeSurvey folder.<br />
<br />
2. Copy four pictures (named ''1.jpg'', ''2.jpg'', ''3.jpg'', and ''4.jpg'') in this pic sub-directory.<br />
<br />
3. Deactivate the ''Filter HTML for XSS'' function in LimeSurvey's ''Global Settings''.<br />
<br />
4. Create a '''Short free text''' question where you want these pictures to be displayed.<br />
<br />
5. Figure out the [[SGQA identifier|SGQA Identifier]] of this question (e.g., 12345X67X89).<br />
<br />
6. Paste the following code as question text after activating the editor's ''Source'' view and replace both SSSSSXGGXQQ strings with your SGQA identifier:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
Please have a look at this picture:<br />
<br />
<br /><br />
<br />
<script><br />
<br />
$(document).ready(<br />
<br />
function(){<br />
<br />
// Find a random number (here between 1 and 4)<br />
<br />
var randNumber = Math.floor(Math.random()*4 + 1);<br />
<br />
// Save the number as answer of this question<br />
<br />
$('input#answerSSSSSXGGXQQ').val(randNumber);<br />
<br />
// Hide this answer field<br />
<br />
document.getElementById("answerSSSSSXGGXQQ").style.display='none';<br />
<br />
// Show the picture<br />
<br />
picString = '<img src="pic/' + String(randNumber) + '.jpg">';<br />
<br />
document.getElementById('pic').innerHTML = picString;<br />
<br />
}<br />
<br />
);</script><br />
<br />
<p><br />
<br />
</p><br />
<br />
<div id="pic"><br />
<br />
</div><br />
<br />
</syntaxhighlight><br />
<br />
If you want to display the number of this picture in a later question, use the following code as question text (don't forget to replace the SSSSSXGGXQQ string acordingly):<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
You saw picture number {INSERTANS:SSSSSXGGXQQ}.<br />
<br />
</syntaxhighlight><br />
<br />
Perhaps you want to display the same picture again in a later question, but a little bit smaller (100px width, 100px height)? Just paste the following code as question text after activating the editor's ''Source'' view, and replace the SSSSSXGGXQQ string acordingly:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
Here you see the picture again: <br><br />
<br />
<script><br />
<br />
$(document).ready(<br />
<br />
function(){<br />
<br />
// Get the picture number from previous question<br />
<br />
var randNumber = "{INSERTANS:SSSSSXGGXQQ}";<br />
<br />
// Show picture<br />
<br />
picString = '<img width="100" height="100" src="pic/' + String(randNumber) + '.jpg">';<br />
<br />
document.getElementById('pic').innerHTML = picString;<br />
<br />
}<br />
<br />
);</script><br />
<br />
<div id="pic"><br />
<br />
</div><br />
<br />
</syntaxhighlight><br />
<br />
=Multiple numerical input with max_num_value defined in token (personalized limit)=<br />
<br />
''Tested in 1.85+''<br />
<br />
<div class="simplebox">As of version 1.92, max_num_value can be an experession, so you can simply enter the {TOKEN} or other variable in that question attribute.</div><br />
<br />
To make personalized survey with multiple numerical input when max_num_value (Maximum sum value) is different for each user and is loaded from the token use following tricks:<br />
*Create 1st group with numerical input field (1000X10X11). "Limit"<br />
*Add java script into this question:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
function Custom_On_Load(){<br />
<br />
document.getElementById('answer1000X10X11').value='{TOKEN:ATTRIBUTE_1}';<br />
<br />
document.getElementById('answer1000X10X11').readOnly=1;<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
where:<br />
<br />
TOKEN:ATTRIBUTE_1 is individual limit defined in token.<br />
<br />
readOnly=1 // user shouldn't change it.<br />
*Create 2nd group with multiple numerical input and add "Max value from SGQA" with 1000X10X11 as argument.<br />
<br />
Note: If you don't want to show first field with numerical input (and show definied limit in different way) you can add 2 lines to above script to hide whole question:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
document.getElementById('question85').style.display='none';<br />
<br />
document.getElementById('display85').value='';<br />
<br />
</syntaxhighlight><br />
<br />
where:<br />
<br />
question85 and display85 are field names.<br />
<br />
Note: It's no possible to create it into one group, because all SGQA references can only refer to data on a previous page because when clicking next the answer is stored at the DB and the SGQA is replaced by querying the database.<br />
<br />
=Default values in array questions=<br />
<br />
''Tested with: 1.87+ (7557), IE 6/7, Firefox 3.5, Safari 3.2''<br />
<br />
<div class="simplebox">As of Version 1.92, many more question types support default values.</div><br />
<br />
This workaround uses JavaScript to allow you to pre-check default answers in all sub-questions of an array type question. You can select a column of the array to be checked as the page loads. The script first checks to see if a sub-question has already been answered and, if not, checks the default answer.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use script]].<br />
#Create the array question.<br />
#In the source of the array question add the following script.<br />
#Replace"QQ" with the question ID and "CC" with the column number to be checked.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// A function to pre-check a column of an array<br />
<br />
function checkedDefault(qID, column) {<br />
<br />
var checkedCol = column - 1;<br />
<br />
$('#question' + qID + ' table.question tbody tr').each(function(i) {<br />
<br />
if ($('input.radio[checked=true]', this).length == 0) {<br />
<br />
$('input.radio:eq(' + checkedCol + ')', this).attr('checked', true);<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
// Call the function with a question ID and column number<br />
<br />
checkedDefault(QQ, CC);<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Record group view time=<br />
<br />
''Tested with: 1.87+ (8518), IE 6/7, Firefox 3.5, Safari 3.2''<br />
<br />
<div class="simplebox">As of version 1.92, group view time is accurately recorded in the timings table if you choose the Record Timings survey option.</div><br />
<br />
This workaround uses JavaScript to populate a hidden question with the total time that a respondent views a group. If used in a group with only one question, it could be used to track the amount of time required to answer the question.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#In the group, create a short-text question. We will hide this later with JavaScript and populate it with the elapsed time.<br />
#Place the following script in the source of the short-text question.<br />
#Replace "QQ" in line 6 with the ID of the short-text question.<br />
<br />
The script populates the hidden question with the elapsed time since the group was opened. If a respondent leaves the group and then returns, the timer continues up from the elapsed time of the last visit.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function(){<br />
<br />
// call the functions with the hidden timer question ID<br />
<br />
runTimer(QQ);<br />
<br />
function runTimer(timeQID) {<br />
<br />
$('#question'+timeQID).hide();<br />
<br />
var initSec = '0';<br />
<br />
// Check for elapsed time from previous visits<br />
<br />
if ($('#question'+timeQID+' input.text').val()) {<br />
<br />
var initTime = $('#question'+timeQID+' input.text').val();<br />
<br />
initTimeArr = initTime.split(':');<br />
<br />
initSec = Number[[initTimeArr[0]*3600]]+Number[[initTimeArr[1]*60]]+Number(initTimeArr[2]);<br />
<br />
}<br />
<br />
// Run the timer update function<br />
<br />
recordTime(initSec, timeQID);<br />
<br />
}<br />
<br />
});<br />
<br />
// Timer update function<br />
<br />
function recordTime(elapsedSec, timeQID){<br />
<br />
elapsedSec++;<br />
<br />
var h = Math.floor(elapsedSec / 3600);<br />
<br />
var m = Math.floor(elapsedSec % 3600 / 60);<br />
<br />
var s = Math.floor(elapsedSec % 3600 % 60);<br />
<br />
var elapsedTime = [[h > 0 ? h + ":" : "00:") + (m > 0 ? (m < 10 ? "0" : "") + m + ":" : "00:") + (s < 10 ? "0" : "") + s);<br />
<br />
$('#question'+timeQID+' input.text').val(elapsedTime);<br />
<br />
// Run the timer update function every second<br />
<br />
setTimeout('recordTime('+elapsedSec+', '+timeQID+')',1000);<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Toggle visibility of groups=<br />
<br />
''Tested with: 1.90+, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
This workaround uses JavaScript to toggle the visibility of groups in an "all in one" survey. Initially the groups are hidden and there are links inserted to display the groups. It's useful to avoid the page being cluttered with many groups and lets the respondent focus on one at a time.<br />
<br />
It's [http://www.partnersinc.biz/surveys//index.php?sid=33613&newtest=Y&lang=en demonstrated here].<br />
<br />
Implementation is as follows:<br />
<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Set the survey to run in "all in one" mode.<br />
#Add your groups and questions.<br />
#Place the following script in the source of one of the questions in the first group.<br />
<br />
<br />
The comments in the script are pretty self-explanatory but it does the following:<br />
<br />
#initially hides all of the groups<br />
#inserts a link above each one to toggle its display<br />
#some styles are added to the clickable links but these could be done in template.css instead<br />
#shows any groups that have an unanswered mandatory after a submit attempt<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function(){<br />
<br />
// Insert show/hide divs before all group wrapper divs<br />
$('<div class="groupToggler"><span></span></div>').insertBefore('div[id^="group-"]');<br />
<br />
// Add some text to the show/hide divs<br />
$('.groupToggler span').each(function(i) {<br />
($( this ).text('Show/Hide Group '+(i+1)+''));<br />
});<br />
<br />
// Add some styles to the show/hide divs<br />
$('.groupToggler').css({<br />
'padding':'5px 0 10px 0',<br />
'text-align':'center'<br />
});<br />
$('.groupToggler span').css({<br />
'text-decoration':'underline', <br />
'cursor':'pointer'<br />
});<br />
<br />
// Add some hover effects to the show/hide divs<br />
$(".groupToggler span").hover(<br />
function () {<br />
$(this).css({<br />
'text-decoration':'none',<br />
'font-weight':'bold'<br />
});<br />
}, <br />
function () {<br />
$(this).css({<br />
'text-decoration':'underline',<br />
'font-weight':'normal'<br />
});<br />
}<br />
);<br />
<br />
// Initially hide all of the groups<br />
// Toggle their visibility when the show/hide is clicked<br />
$('.groupToggler span').click(function() {<br />
$(this).parent().next().toggle();<br />
return false;<br />
}).parent().next().hide();<br />
<br />
// Display any groups that have unanswered mandatories<br />
$('.errormandatory').parents('div[id^="group-"]').show();<br />
<br />
// Some tidying up<br />
$('h1').next().next().hide();<br />
$('.surveywelcome').css({'margin-bottom':'10px'});<br />
$('.surveywelcome').next().hide();<br />
$('.surveywelcome').next().next().hide();<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Use jQuery Autocomplete plugin to suggest answers for text inputs=<br />
<br />
== 1.90 and previous versions==<br />
<br />
''Tested with: 1.90+, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
This workaround uses the [http://docs.jquery.com/Plugins/Autocomplete jQuery Autocomplete] plugin to provide a respondent a list of suggested answers that the they can select from as they type in a text input.<br />
<br />
Although the plugin allows for much more complex applications, the two that I use most frequently are outlined below. The first method uses a relatively small list of suggestions that is stored in an array locally. The second is a little more complex - it uses a remote CSV file of suggestions that is accessed through AJAX an PHP.<br />
<br />
I've put together a small demonstration [http://www.partnersinc.biz/surveys//index.php?sid=78611&newtest=Y&lang=en here] and implementation is as follows.<br />
<br />
'''Both methods:'''<br />
*[http://docs.jquery.com/Plugins/Autocomplete Download the plugin]<br />
*Place the files ''jquery.autocomplete.css'' and ''jquery.autocomplete.js'' in your template directory<br />
*Add the following code inside the <head> element of startpage.pstpl<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}jquery.autocomplete.js"></script><br />
<link rel="stylesheet" type="text/css" href="{TEMPLATEURL}jquery.autocomplete.css" /></syntaxhighlight><br />
<br />
'''Method 1 ("States" question in the demo):'''<br />
*Create a text input question<br />
*Add the following script to the source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace the states with your list of suggestions (comma separated)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var q1ID = QQ;<br />
<br />
var states = "Alabama,Alaska,Arizona,Arkansas,California,Colorado,Connecticut,Delaware, District of Columbia,Florida,Georgia,Hawaii,Idaho,Illinois,Indiana,Iowa,Kansas,Kentucky, Louisiana,Maine,Montana,Nebraska,Nevada,New Hampshire,New Jersey,New Mexico,New York, North Carolina,North Dakota,Ohio,Oklahoma,Oregon,Maryland,Massachusetts,Michigan, Minnesota,Mississippi,Missouri,Pennsylvania,Rhode Island,South Carolina,South Dakota, Tennessee,Texas,Utah,Vermont,Virginia,Washington,West Virginia,Wisconsin,Wyoming".split(',');<br />
<br />
$('#question'+q1ID+' input.text').autocomplete(states, {<br />
matchContains: true,<br />
minChars: 0<br />
});<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Method 2 ("Countries" question in the demo):'''<br />
*Place the CSV file of suggestions in your template directory. <br />
*Place a PHP file containing the code below in your template directory<br />
*Replace "countries2.csv" with your CSV filename (you could make this more universal by passing the filename in the URL)<br />
*This file will grab the contents of the CSV and encode them in JSON format that the JavaScript can use<br />
*Place the JavaScript code below in ths source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace "templates/yourTemplate/countries.php" with the path to the PHP file (from LimeSurvey root)<br />
*This script will grab the jsonized data from the PHP file and load it into an array that the plugin can use<br />
<br />
PHP code:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><?php<br />
<br />
$countriesArr = array();<br />
<br />
$file_handle = fopen("countries2.csv", "r");<br />
<br />
while (!feof($file_handle) ) {<br />
$line_of_text = fgetcsv($file_handle);<br />
array_push($countriesArr, $line_of_text[0]);<br />
}<br />
<br />
fclose($file_handle);<br />
<br />
echo json_encode($countriesArr);<br />
<br />
?></syntaxhighlight><br />
<br />
JavaScript code:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var qID = QQ;<br />
var url = "templates/yourTemplate/countries.php";<br />
var countriesArr = new Array();<br />
<br />
$.getJSON(url,function(data){<br />
<br />
$(data).each(function(i, item){<br />
countriesArr.push(item);<br />
});<br />
<br />
$('#question'+qID+' input.text').autocomplete(countriesArr, {<br />
matchContains: true,<br />
minChars: 0<br />
});<br />
});<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
== 1.91 and later versions==<br />
<br />
''Tested with: 1.91+, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
This workaround uses the [http://jqueryui.com/demos/autocomplete/ Autocomplete widget] included with jQuery UI to provide a respondent a list of suggested answers that the they can select from as they type in a text input.<br />
<br />
Although the plugin allows for much more complex applications, the two that I use most frequently are outlined below. The first method uses a relatively small list of suggestions that is stored in an array locally. The second is a little more complex - it uses a remote CSV file of suggestions that is accessed through AJAX an PHP.<br />
<br />
'''Both methods:'''<br />
*Add the following styles to the end of your 'template.css' file<br />
<br />
<syntaxhighlight lang="css" enclose="div">/* Autocomplete styles */<br />
<br />
ul.ui-autocomplete {<br />
width: 250px !important;<br />
padding: 5px 10px;<br />
list-style: none;<br />
}</syntaxhighlight><br />
<br />
'''Method 1 (use local JavaScript array for data):'''<br />
*Create a text input question<br />
*Add the following script to the source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace the states with your list of suggestions (comma separated)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var q1ID = QQ;<br />
<br />
var states = "Alabama,Alaska,Arizona,Arkansas,California,Colorado,Connecticut,Delaware, District of Columbia,Florida,Georgia,Hawaii,Idaho,Illinois,Indiana,Iowa,Kansas,Kentucky, Louisiana,Maine,Montana,Nebraska,Nevada,New Hampshire,New Jersey,New Mexico,New York, North Carolina,North Dakota,Ohio,Oklahoma,Oregon,Maryland,Massachusetts,Michigan, Minnesota,Mississippi,Missouri,Pennsylvania,Rhode Island,South Carolina,South Dakota, Tennessee,Texas,Utah,Vermont,Virginia,Washington,West Virginia,Wisconsin,Wyoming".split(',');<br />
<br />
$('#question'+q1ID+' input.text').autocomplete({<br />
source: states<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Method 2 (use remote CSV file for data):'''<br />
*Place the CSV file of suggestions in your template directory<br />
*Place a PHP file containing the code below in your template directory<br />
*Replace "countries2.csv" with your CSV filename (you could make this more universal by passing the filename in the URL)<br />
*This file will grab the contents of the CSV and encode them in JSON format that the JavaScript can use<br />
*Place the JavaScript code below in ths source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace "templates/yourTemplate/countries.php" with the path to the PHP file (from LimeSurvey root)<br />
*This script will grab the jsonized data from the PHP file and load it into an array that the plugin can use<br />
<br />
PHP code:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><?php<br />
<br />
$countriesArr = array();<br />
<br />
$file_handle = fopen("countries2.csv", "r");<br />
<br />
while (!feof($file_handle) ) {<br />
$line_of_text = fgetcsv($file_handle);<br />
array_push($countriesArr, $line_of_text[0]);<br />
}<br />
<br />
fclose($file_handle);<br />
<br />
echo json_encode($countriesArr);<br />
<br />
?></syntaxhighlight><br />
<br />
JavaScript code:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var qID = QQ;<br />
var url = "templates/yourTemplate/countries.php";<br />
var dataArr = [];<br />
<br />
$.getJSON(url,function(data){<br />
<br />
$.each(data,function(i, item){<br />
dataArr.push(item);<br />
});<br />
<br />
$('#question'+qID+' input.text').autocomplete({<br />
source: dataArr<br />
});<br />
<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
== Use autocomplete to populate several fields==<br />
<br />
''Tested with: 1.91+, IE 7/8/9, Firefox 18''<br />
<br />
This workaround uses the [http://jqueryui.com/demos/autocomplete/ Autocomplete widget] included with jQuery UI and the [https://code.google.com/p/jquery-csv/source/browse/jquery.csv.js?r=f13189b2550a770ccaa777f1d747bc860b943fe7 jquery.csv.js] plugin to provide a respondent with a list of suggested answers as they type in a text input and then to automatically populate other fields depending on the selection.<br />
<br />
For example, if you have 3 questions - "Name", "ID" and "Email" - you can use this workaround to autocomplete the "Name" question and then the "ID" and "Email" questions can be automatically populated with values associated with the selected name.<br />
*Download the [https://code.google.com/p/jquery-csv/source/browse/jquery.csv.js?r=f13189b2550a770ccaa777f1d747bc860b943fe7 jquery.csv.js] plugin and place it in your template folder<br />
*If using LimeSurvey 1.9x, add the following line to your startpage.pstpl BEFORE the tag for template.js, if using 2.x, add it AFTER the {TEMPLATEJS} placeholder<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}jquery.csv.js"></script></syntaxhighlight><br />
*Create your CSV file with 3 columns (name, ID, email) as in this example and place it in your template folder<syntaxhighlight lang="php" enclose="div">Bob, Bob's ID, Bob's email<br />
<br />
Andy, Andy's ID, Andy's email<br />
<br />
Sam, Sam's ID, Sam's email<br />
<br />
Tony, Tony's ID, Tony's email<br />
<br />
Fred, Fred's ID, Fred's email</syntaxhighlight><br />
*Create your 3 questions - "Name", "ID" and "Email". They must be in the same group/page.<br />
*Add the following styles to the end of your 'template.css' file<syntaxhighlight lang="php" enclose="div">/* Autocomplete styles */<br />
<br />
ul.ui-autocomplete {<br />
<br />
width: 250px !important;<br />
<br />
padding: 5px 10px;<br />
<br />
list-style: none;<br />
<br />
}</syntaxhighlight><br />
*Add the following script to the source of one of the questions<br />
*Replace:<br />
**"NN" with the "Name" question ID<br />
**"II" with the "ID" question ID<br />
**"EE" with the "Email" question ID<br />
*Modify the path to your CSV file<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var qNameID = NN;<br />
<br />
var qIDID = II;<br />
<br />
var qEmailID = EE;<br />
<br />
var url = "upload/templates/yourTemplate/yourCsvFile.csv";<br />
<br />
// Create an array to hold the names<br />
var namesArr = new Array();<br />
<br />
// Grab the CSV contents<br />
$.get(url,function(data){<br />
<br />
// Convert CSV contents to an array of arrays<br />
fullArray = $.csv.toArrays(data);<br />
<br />
// Load the names array<br />
$(fullArray).each(function(i, item){<br />
namesArr.push(item[0]);<br />
});<br />
<br />
// Initialise the autocomplete plugin<br />
$('#question'+qNameID+' input.text').autocomplete({<br />
source: namesArr,<br />
// Event fired when a selection is made (ui.item.value refers to the selected item)<br />
select: function(event, ui) {<br />
// Find the "ID" and "Email" values associated with the selected name value and load those questions<br />
$(fullArray).each(function(i, item){<br />
if(item[0] == ui.item.value) {<br />
// The value from column 2 of the CSV<br />
$('#question'+qIDID+' input.text').val(item[1]);<br />
// The value from column 3 of the CSV<br />
$('#question'+qEmailID+' input.text').val(item[2]);<br />
}<br />
});<br />
}<br />
});<br />
});<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Drag and Drop Rankings {{Deprecated|2.0}} =<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }} <br />
<br />
==Drag and Drop Ranking - Version 1.90 to 1.92==<br />
<br />
''Tested with: 1.90+ & 1.91RC4, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }} <br />
<br />
This workaround is a modification of the workaround below and also uses [http://jqueryui.com/demos/sortable/#connect-lists JQuery connected sortables]. Thanks to the author of that workaround.<br />
<br />
[[File:Untitled-12.png]]<br />
<br />
Modifications include:<br />
*Allow for multiple drag-n-drop ranking questions on a page<br />
*Handle minimum and maximum answers settings<br />
*Allow double clicking of items to add or remove them from the ranking list<br />
*Work with the new shipped jQuery UI<br />
<br />
There is a '''[http://www.partnersinc.biz/surveys//index.php?sid=36981&newtest=Y&lang=en demonstrated here]'''.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the large script below in your template.js file.<br />
#Place the small script below in the source a ranking question, (this applies the "dragDropRank" function to the question). Replace "QQ" with the ranking [http://docs.limesurvey.org/SGQA+identifier&structure;=English+Instructions+for+LimeSurvey#General_Description question ID].<br />
**Note: the LimeSurvey translations will be automatically used for the "Choices" and "Rankings" header labels but can be overridden with custom labels - see the example calls below.<br />
#Insert the CSS below at the end of template.css (these styles are for the default template).<br />
<br />
NOTE: I have not tested this workaround with conditions.<br />
<br />
'''Code for template.js:'''<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
function dragDropRank(qID, choiceText, rankText) {<br />
<br />
if(!choiceText) {<br />
choiceText = $('#question'+qID+' td.label label').text();<br />
}<br />
if(!rankText) {<br />
rankText = $('#question'+qID+' td.output tr:first td:eq(1)').text();<br />
}<br />
<br />
//Add a class to the question<br />
$('#question'+qID+'').addClass('dragDropRanking');<br />
<br />
// Hide the original question in LimeSurvey (so that we can replace with drag and drop)<br />
$('#question'+qID+' .rank, #question'+qID+' .questionhelp').hide();<br />
<br />
// Turn off display of question (to override error checking built into LimeSurvey ranking question)<br />
//$('#display'+qID).val('off');<br />
<br />
// Add connected sortables elements to the question<br />
var htmlCode = '<table class="dragDropTable"> \<br />
<tbody> \<br />
<tr> \<br />
<td> \<br />
<span class="dragDropHeader choicesLabel">'+choiceText+'</span><br /> \<br />
<div class="ui-state-highlight dragDropChoices"> \<br />
<ul id="sortable1'+qID+'" class="connectedSortable'+qID+' dragDropChoiceList"> \<br />
<li>Choices</li> \<br />
</ul> \<br />
</div> \<br />
</td> \<br />
<td> \<br />
<span class="dragDropHeader rankingLabel">'+rankText+'</span><br /> \<br />
<div class="ui-state-highlight dragDropRanks"> \<br />
<ol id="sortable2'+qID+'" class="connectedSortable'+qID+' dragDropRankList"> \<br />
<li>Ranks</li> \<br />
</ol> \<br />
</div> \<br />
</td> \<br />
</tr> \<br />
</tbody> \<br />
</table>';<br />
$(htmlCode).insertAfter('#question'+qID+' table.rank');<br />
<br />
// Remove placeholder list items (have to have one item so that LimeSurvey doesn"t remove the <ul>)<br />
$('#sortable1'+qID+' li, #sortable2'+qID+' li').remove();<br />
<br />
// Load any previously-set values<br />
loadDragDropRank(qID);<br />
<br />
// Find the number of LimeSurvey ranking inputs ("Maximum answers")<br />
var maxAnswer = $('#question'+qID+' td.output input.text').length;<br />
<br />
// Set up the connected sortable<br />
$('#sortable1'+qID+', #sortable2'+qID+'').sortable({<br />
connectWith: '.connectedSortable'+qID+'',<br />
placeholder: 'ui-sortable-placeholder',<br />
helper: 'clone',<br />
revert: 50,<br />
receive: function(event, ui) {<br />
if($('#sortable2'+qID+' li').length > maxAnswer) {<br />
alert ('You can only rank a maximum of '+maxAnswer+' choices.');<br />
$(ui.sender).sortable('cancel');<br />
}<br />
},<br />
stop: function(event, ui) {<br />
$('#sortable1'+qID+'').sortable('refresh');<br />
$('#sortable2'+qID+'').sortable('refresh');<br />
updateDragDropRank(qID);<br />
}<br />
}).disableSelection();<br />
<br />
// Get the list of choices from the LimeSurvey question and copy them as items into the sortable choices list<br />
$('#CHOICES_' + qID).children().each(function(index, Element) {<br />
var liCode = '<li class="ui-state-default" id="choice_' + $(this).attr("value") + '">' + this.text + '</li>'<br />
$(liCode).appendTo('#sortable1'+qID+'');<br />
});<br />
<br />
// Allow users to double click to move to selections from list to list<br />
$('#sortable1'+qID+' li').live('dblclick', function() {<br />
if($('#sortable2'+qID+' li').length == maxAnswer) {<br />
alert ('You can only rank a maximum of '+maxAnswer+' choices.');<br />
return false;<br />
}<br />
else {<br />
$(this).appendTo('#sortable2'+qID+'');<br />
$('#sortable1'+qID+'').sortable('refresh');<br />
$('#sortable2'+qID+'').sortable('refresh');<br />
updateDragDropRank(qID);<br />
}<br />
});<br />
$('#sortable2'+qID+' li').live('dblclick', function() {<br />
$(this).appendTo('#sortable1'+qID+'');<br />
$('#sortable2'+qID+'').sortable('refresh');<br />
$('#sortable1'+qID+'').sortable('refresh');<br />
updateDragDropRank(qID);<br />
});<br />
}<br />
<br />
// This function copies the drag and drop sortable data into the LimeSurvey ranking list.<br />
function updateDragDropRank(qID) {<br />
<br />
// Reload the LimeSurvey choices select element<br />
var rankees = [];<br />
$('#sortable2'+qID+' li').each(function(index) {<br />
$(this).attr('value', index+1);<br />
<br />
// Get value of ranked item<br />
var liID = $(this).attr("id");<br />
liIDArray = liID.split('_');<br />
<br />
// Save to an array<br />
rankees[rankees.length] = { "r_name":$(this).text(),"r_value":liIDArray[1] };<br />
});<br />
$('#question'+qID+' input[name<div class="simplebox">="RANK_"]').each(function(index) {<br />
if (rankees.length > index) {<br />
$(this).val(rankees[index].r_name);<br />
$(this).next('input').attr('value', rankees[index].r_value);<br />
} else {<br />
$(this).val('');<br />
$(this).next().val('');<br />
}<br />
});<br />
<br />
// Reload the LimeSurvey choices select element (we need this for "Minimum answers" code)<br />
$('#question'+qID+' td.label select option').remove();<br />
$('#sortable1'+qID+' li').each(function(index) {<br />
var liText = $(this).text();<br />
var liID = $(this).attr('id');<br />
liIDArray = liID.split('_');<br />
var optionCode = '<option value="'+liIDArray[1]+'">'+liText+'</option>';<br />
$(optionCode).appendTo('#question'+qID+' td.label select');<br />
});<br />
<br />
// Hack for IE6<br />
if ($.browser.msie && $.browser.version.substr(0,1)<7) {<br />
$('#question'+qID+' select').show();<br />
$('#question'+qID+' select').hide();<br />
}<br />
}<br />
<br />
// This function is called on page load to see if there are any items already ranked (from a previous visit<br />
// or cached due to a page change. If so, the already-ranked items are loaded into the sortable list<br />
function loadDragDropRank(qID) {<br />
<br />
var rankees = [];<br />
<br />
// Loop through each item in the built-in LimeSurvey ranking list looking for non-empty values<br />
$('#question'+qID+' input[name</div>="RANK_"]').each(function(index) {<br />
<br />
// Check to see if the current item has a value<br />
if ($(this).val()) {<br />
<br />
// Item has a value - save to the array<br />
// Use this element to contain the name and the next for the value (numeric)<br />
rankees[rankees.length] = { "r_name":$(this).val(),"r_value":$(this).next().val() };<br />
}<br />
});<br />
<br />
// Now that we have a list of all the pre-ranked items, populate the sortable list<br />
// Note that the items *won"t* appear in the main list because LimeSurvey has removed them.<br />
$.each(rankees, function(index, value) {<br />
<br />
// Create the items in the sortable<br />
var liCode = '<li class="ui-state-default" id="choice_' + value.r_value + '">' + value.r_name + '</li>';<br />
$(liCode).appendTo('#sortable2'+qID+'');<br />
});<br />
}</syntaxhighlight><br />
<br />
'''Code in the source of the question(s) using the LimeSurvey translations for the "Choices" and "Rankings" element header labels''' (replace "QQ" with the ranking [http://docs.limesurvey.org/SGQA+identifier&structure;=English+Instructions+for+LimeSurvey#General_Description question ID]):<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
dragDropRank(QQ);<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Fix for later versions of 1.91+'''<br />
In my version of LimeSurvey 1.91+, build 11026, this drag-n-drop workaround was not saving the selections properly. I'm not sure if that's because of my template, or other jquery uses, but I fixed it by making the following modifications to the above code placed into template.js.<br />
<br />
If you're having problems (and it's definitely worth testing that the rankings are actually saving into your response table before proceeding with the survey) give this a try.<br />
<br />
In the 'updateDragDropRank(qID)' function, replace the line:<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$('#question'+qID+' input[name<div class="simplebox">="RANK_"]').each(function(index) {<br />
</syntaxhighlight><br />
with:<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$('#question'+qID+' input[name^="RANK_"]').each(function(index) {<br />
</syntaxhighlight><br />
<br />
In the 'loadDragDropRank(qID) function, replace the line:<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$('#question'+qID+' input[name</div>="RANK_"]').each(function(index) {<br />
</syntaxhighlight><br />
with:<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$('#question'+qID+' input[name^="RANK_"]').each(function(index) {<br />
</syntaxhighlight><br />
<br />
<br />
'''Code in the source of the question(s) using custom text for the "Choices" and "Rankings" element header labels''' (replace "QQ" with the ranking [http://docs.limesurvey.org/SGQA+identifier&structure;=English+Instructions+for+LimeSurvey#General_Description question ID]):<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
dragDropRank(QQ, 'Custom Choices Label', 'Custom Rankings Label');<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Styles for template.css:'''<br />
<br />
<syntaxhighlight lang="css" enclose="div"><br />
/* Drag-n-drop ranking styles */<br />
.dragDropTable {<br />
border: 0 none;<br />
border-collapse: collapse;<br />
width: 100%;<br />
}<br />
<br />
.dragDropTable td {<br />
vertical-align: top;<br />
width: 50%;<br />
padding-right: 20px;<br />
}<br />
<br />
.dragDropTable .dragDropHeader {<br />
font-weight: bold;<br />
}<br />
<br />
.dragDropTable .dragDropChoices,<br />
.dragDropTable .dragDropRanks {<br />
margin: 5px 0 0 0;<br />
background: transparent none;<br />
border: 0 none;<br />
}<br />
<br />
.dragDropTable .dragDropChoiceList,<br />
.dragDropTable .dragDropRankList {<br />
float: left;<br />
width: 100%;<br />
min-height: 2.4em;<br />
_height: 2.4em; /* IE6 and below hack */<br />
margin: 0;<br />
padding: 0;<br />
list-style-type: none;<br />
background: #FBFBFB none;<br />
border: 1px solid #CCCCCC;<br />
}<br />
<br />
.dragDropTable .dragDropChoiceList li,<br />
.dragDropTable .dragDropRankList li {<br />
margin: 3px;<br />
*margin-left: -13px; /* IE7 and below */<br />
padding: 3px;<br />
min-height: 1.3em;<br />
_height: 1.3em; /* IE6 and below hack */<br />
font-weight: normal;<br />
cursor: move;<br />
display: block; /* Force the li to full width */<br />
}</syntaxhighlight><br />
<br />
==Drag and Drop Ranking using Images - Version 1.90 to 1.92==<br />
<br />
''Tested with: 1.90+ & 1.91RC4, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }}<br />
<br />
This workaround works in conjunction with the above workaround to allow ranking of images.<br />
<br />
[[File:Untitled-11.png]]<br />
<br />
There is a '''[http://www.partnersinc.biz/surveys//index.php?sid=36981&newtest=Y&lang=en demonstrated here]'''.<br />
<br />
Implementation is as follows:<br />
<br />
1) Follow the above workaround to get basic drag-n-drop functionality in your ranking question.<br />
<br />
2) Insert your images in the ranking question text or help section after any text that you wish to have there (we'll move them later with JavaScript).<br />
<br />
3) Give the images '''EXACTLY''' the same IDs as the answer code you would like them to be associated with:[[File:Untitled-8.png]]<br />
<br />
4) Place the first script below in your template.js file.<br />
<br />
5) Place the second script below in the source the ranking question '''AFTER''' the initial call for the dragDropRank function from the workaround above. Replace "QQ" with the ID of the ranking question (this applies the "dragDropRankImages" function to the question).<br />
<br />
6) Insert the CSS below at the end of template.css. Replace "11" with your question ID. These styles are for the default template using 50x50px images (as in the demo) and may need to be modified for other templates or image sizes.<br />
<br />
'''Code for template.js:'''<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
function dragDropRankImages(qID) {<br />
<br />
$('.connectedSortable'+qID+' li').each(function(i) {<br />
<br />
// Remove any text in the sortable choice or rank items<br />
$(this).text('');<br />
<br />
// Move the images into the appropriate sortable list item<br />
var liID = $(this).attr('id');<br />
liIDArray = liID.split('_');<br />
$('#question'+qID+' img#'+liIDArray[1]+'').appendTo(this);<br />
});<br />
}</syntaxhighlight><br />
<br />
'''Code in the source of the question(s):'''<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
dragDropRankImages(QQ);<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Styles for template.css:'''<br />
<br />
<syntaxhighlight lang="css" enclose="div"><br />
<br />
/* Drag-n-drop for ranking images */<br />
#question11 .dragDropTable {<br />
width: auto;<br />
}<br />
<br />
#question11 .dragDropTable .dragDropChoiceList,<br />
#question11 .dragDropTable .dragDropRankList {<br />
min-height: 60px;<br />
_height: 60px; /* IE6 and below hack */<br />
width: auto;<br />
min-width: 60px;<br />
_width: 60px; /* IE6 and below hack */<br />
}<br />
<br />
#question11 .dragDropTable li {<br />
background: 0 none;<br />
border: 0 none;<br />
height: 50px;<br />
width: 50px;<br />
}<br />
<br />
#question11 .dragDropTable li img {<br />
margin: 0;<br />
padding: 0;<br />
border: 0 none;<br />
}</syntaxhighlight><br />
<br />
==Drag and Drop Ranking for iPad - Version 1.91 and newer==<br />
<br />
''Tested with: LimeSurvey 1.91, iPad 2''<br />
<br />
This workaround extends the above workarounds to work with the touch interface on iPads.<br />
<br />
1) Follow the [[Workarounds: Manipulating a survey at runtime using Javascript#Drag and Drop Ranking - Version 1.90 and newer|Drag and Drop Ranking - Version 1.90 and newer]] workaround above to get basic drag-n-drop functionality in your ranking question.<br />
<br />
2) Download the [https://github.com/furf/jquery-ui-touch-punch jQuery.ui.touch-punch.js plugin] and save it in your template directory.<br />
<br />
3) Replace this line in your startpage.pstpl:<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}template.js"></script></syntaxhighlight>With this:<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}jquery.ui.touch-punch.js"></script><br />
<br />
<script type="text/javascript" src="{TEMPLATEURL}template.js"></script></syntaxhighlight><br />
<br />
==Drag and Drop Ranking - Version 1.86==<br />
<br />
Tested with 1.86 on IE 7,8, FireFox 3, Chrome, and Safari 4<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }}<br />
<br />
This workaround uses [http://jqueryui.com/demos/sortable/#connect-lists JQuery connected sortables] to modify a ranking question and allow the survey taker to drag and drop choices instead of clicking. The nice thing is that the choices can be easily re-arranged or removed from the ranking, all by drag and drop.<br />
<br />
I used it for a voting application and some of the element names reflect that use.<br />
<br />
It looks best when some CSS is added to control the appearance of the boxers around each choice.<br />
<br />
[[File:drag-n-drop.png]]<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
// Question ID global variable<br />
var questionID;<br />
<br />
$(document).ready(function() {<br />
<br />
// Grab the question ID[[File:drag-n-drop.png]]<br />
// This is something with a class of "ranking" and an ID that starts with "questionXXXXX". The X's represent the question ID<br />
var entire_questionID = $(".ranking[id<div class="simplebox">='question']").attr('id');<br />
<br />
// Get just the question number (ID)<br />
var patt=/\d+$/;<br />
questionID=patt.exec(entire_questionID);<br />
<br />
// Hide the original quetion in LimeSurvey (so that we can replace with drag and drop)<br />
$(".rank, .questionhelp").hide();<br />
<br />
// Turn off display of question (to override error checking built into LimeSurvey ranking question)<br />
$("#display"+questionID).val("off");<br />
<br />
// Add connected sortables to the question<br />
var html_code = "<table style='border: medium none ; width: 770px; margin-left: auto; \<br />
margin-right: auto;'><tbody><tr><td style='width: 590px; vertical-align: top;'><h3>List of Candidates:</h3> \<br />
<div class='ui-state-highlight' style='margin: 5px; float: left;' id='ballot_list'> \<br />
<ul id='sortable1' class='connectedSortable'><li>Candidates</li></ul></div></td> \<br />
<td style='vertical-align: top;'><h3>Your selections:</h3><div class='ui-state-highlight' \<br />
style='margin: 5px; float: left;' id='voting_selections'><ol id='sortable2' class='connectedSortable'> \<br />
<li>Voting Area</li></ol></div></td></tr></tbody></table>";<br />
$(html_code).appendTo("#question" + questionID);<br />
<br />
// Remove list items (have to have one item so that LimeSurvey doesn't remove the <ul>)<br />
$("#sortable1 li, #sortable2 li").remove();<br />
<br />
// Load any previously-set values<br />
loadRanking();<br />
<br />
// Load jQuery UI<br />
$.getScript("/scripts/jquery/jquery-ui.js", function() {<br />
<br />
// After JQuery UI finishes loading, set up the connected sortable.<br />
$("#sortable1, #sortable2").sortable({<br />
connectWith: '.connectedSortable',<br />
placeholder: 'ui-sortable-placeholder',<br />
stop: function(event, ui) {<br />
$("#sortable1").sortable("refresh");<br />
$("#sortable2").sortable("refresh");<br />
updateRanking();<br />
}<br />
}).disableSelection();<br />
<br />
// Get the list of candidates from the built-in LimeSurvey question and copy them as items in sortable1<br />
$("#CHOICES_" + questionID).children().each(function(index, Element) {<br />
li_tag = "<li class='ui-state-default' id='choice_" + $(this).attr('value') + "'>" + this.text + "</li>"<br />
$(li_tag).appendTo("#sortable1"); } );<br />
<br />
// Make sure the submit button is showing<br />
$(":submit[value|=' Submit']").show();<br />
<br />
// Show a confirmation alert upon submit<br />
$("form").submit(function() {<br />
<br />
// Override the built-in "disable navigation buttons" feature<br />
$('#moveprevbtn, #movenextbtn, #movesubmitbtn').attr('disabled', '');<br />
var validated = confirm("Cast your ballot now?");<br />
if (validated) { return true; } else { return false; }<br />
});<br />
<br />
// Allow users to double click to move to selection list<br />
$("#sortable1 li").assignDblClick();<br />
}); // End of JQuery UI loading<br />
<br />
}); // End of JQuery ready function<br />
<br />
// Define the actions when an item is double clicked<br />
$.fn.assignDblClick = function() {<br />
$(this).dblclick(function(){<br />
$(this).appendTo('#sortable2');<br />
$("#sortable1").sortable("refresh");<br />
$("#sortable2").sortable("refresh");<br />
updateRanking();<br />
});<br />
}<br />
<br />
// This function copies the drag and drop sortable data into the standard LimeSurvey ranking structure.<br />
function updateRanking() {<br />
var rankees = [];<br />
$('#sortable2 li').each(function(index) {<br />
$(this).attr("value", index+1);<br />
<br />
// Get value of person<br />
li_tag = $(this).attr('id');<br />
li_tag_array = li_tag.split("_");<br />
<br />
// Save to an array<br />
rankees[rankees.length] = { 'r_name':$(this).text(),'r_value':li_tag_array[1] };<br />
});<br />
$("input[name</div>='RANK_']").each(function(index) {<br />
if (rankees.length > index) {<br />
$(this).val(rankees[index].r_name);<br />
$(this).next().val(rankees[index].r_value);<br />
} else {<br />
$(this).val("");<br />
$(this).next().val("");<br />
}<br />
});<br />
<br />
// Re-assign double click action to first list items and remove<br />
// double click action from section list items<br />
$('#sortable1 li').unbind('dblclick').assignDblClick();<br />
$('#sortable2 li').unbind('dblclick');<br />
}<br />
<br />
// This function is called on page load to see if there are any items already ranked (from a previous visit<br />
// or cached due to a page change. If so, the already-ranked items are loaded into the sortable list<br />
function loadRanking() {<br />
var rankees = [];<br />
<br />
// Loop through each item in the built-in LimeSurvey ranking list looking for non-empty values<br />
$("input[name<div class="simplebox">='RANK_']").each(function(index) {<br />
<br />
// Check to see if the current item has a value<br />
if ($(this).val()) {<br />
// Item has a value - save to the array<br />
// Use this element to contain the name and the next for the value (numeric)<br />
rankees[rankees.length] = { 'r_name':$(this).val(),'r_value':$(this).next().val() };<br />
}<br />
});<br />
<br />
// Now that we have a list of all the pre-ranked items, populate the sortable list<br />
// Note that the items *won't* appear in the main list because LimeSurvey has removed them.<br />
$.each(rankees, function(index, value) {<br />
// Create the items in the sortable<br />
li_tag = "<li class='ui-state-default' id='choice_" + value.r_value + "'>" + value.r_name + "</li>";<br />
$(li_tag).appendTo("#sortable2");<br />
});<br />
}</syntaxhighlight><br />
<br />
=Create MaxDiff question type=<br />
<br />
See the [[Workarounds: Question design, layout and templating|Question design, layout and templating]] section for a workaround that uses JavaScript to convert an '''''Array (flexible labels) by column''''' question into a [http://en.wikipedia.org/wiki/MaxDiff MaxDiff] question type.<br />
<br />
[[File:max_diff_596x253.gif]]<br />
<br />
=In a checkbox matrix, have the 'none' option in a row disable all other columns in that row=<br />
<br />
''Tested with: LimeSurvey 1.90+''<br />
<br />
The questionId parameter is the base ID of the question matrix (multiflexible).<br />
<br />
numColumns and numRows speak for themselves<br />
<br />
specialColumns is an array of the columns that have the special ability that when one of them<br />
<br />
is checked, none of the others can be checked. E.g., a 'none of these' and/or a 'do now know' option.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
numColumns=13;<br />
<br />
numRows=18;<br />
<br />
questionId='28417X2X24';<br />
<br />
specialColumns=[1,12,13];<br />
<br />
function action(obj){<br />
<br />
locator=obj.id.replace('cbox_'+questionId, '').split('_');<br />
<br />
row=locator[0];<br />
<br />
column=locator[1];<br />
<br />
//alert('Action for row,column='+row+','+column);<br />
<br />
my_id='#cbox_'+questionId+row+'_'+column+''<br />
<br />
if($(my_id).attr('checked') == false) {<br />
<br />
for( var i=1; i<=numColumns; i++ ) {<br />
<br />
if(i==column) continue;<br />
<br />
id='#cbox_'+questionId+row+'_'+i<br />
<br />
$(id).attr('disabled',false);<br />
<br />
}<br />
<br />
} else {<br />
<br />
for( var i=1; i<=numColumns; i++ ) {<br />
<br />
if(i==column) continue;<br />
<br />
id='#cbox_'+questionId+row+'_'+i<br />
<br />
aid='#answer'+questionId+row+'_'+i<br />
<br />
$(aid).val(0);<br />
<br />
$(id).attr('checked',false);<br />
<br />
$(id).attr('disabled',true);<br />
<br />
}<br />
<br />
}<br />
<br />
}<br />
<br />
function customOnLoad(){<br />
<br />
for( var row=1; row<=numRows; row++ ) {<br />
<br />
for( var k=0; k<specialColumns.length; k++ )<br />
<br />
{<br />
<br />
column=specialColumns[k];<br />
<br />
$('#cbox_'+questionId+row+'_'+column).change(function() {<br />
<br />
action(this);<br />
<br />
});<br />
<br />
}<br />
<br />
}<br />
<br />
}<br />
<br />
jQuery(document).ready(<br />
<br />
function(){<br />
<br />
customOnLoad();<br />
<br />
}<br />
<br />
);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Last Option In Array (Numbers) (Checkboxes) Row Excludes All Others=<br />
<br />
''Tested with: 2.05, IE 7-10, Firefox''<br />
<br />
This workaround uses JavaScript/jQuery to make the last option of each Array (Numbers) (Checkboxes) row exclude all other options in the same row.<br />
<br />
The script will uncheck all options in a row if the last option is checked and uncheck the last option in a row if any other options are checked.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the following script in the source of the array question.<br />
<br />
NOTE: Care should be taken when using this script and conditional questions on the same page.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"> <br />
$(document).ready(function() {<br />
// Call the exclude function using question ID<br />
excludeOpt ({QID});<br />
});<br />
<br />
// A function to make the last option in each array row exclusive<br />
function excludeOpt (qID) {<br />
<br />
var thisQuestion = $('#question'+qID)<br />
<br />
// Add some classes to the checkbox cells<br />
$('table.question tbody td', thisQuestion).addClass('normalOpt');<br />
$('table.question tbody tr', thisQuestion).each(function(i) {<br />
$('.normalOpt:last', this).removeClass('normalOpt').addClass('exlusiveOpt')<br />
});<br />
<br />
// A listener on the checkbox cells<br />
$('table.question tbody td', thisQuestion).click(function (event) {<br />
<br />
// Set some vars<br />
var thisRow = $(this).closest('tr');<br />
<br />
// Uncheck the appropriate boxes in a row<br />
if ($(this).hasClass('normalOpt')) {<br />
$('.exlusiveOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
else {<br />
$('.normalOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
});<br />
<br />
// A listener on the checkboxes<br />
$('table.question tbody td input[type=checkbox]', thisQuestion).click(function (event) {<br />
<br />
// Set some vars<br />
var thisRow = $(this).closest('tr');<br />
var thisCell = $(this).closest('td');<br />
<br />
// Uncheck the appropriate boxes in a row<br />
if ($(thisCell).hasClass('normalOpt')) {<br />
$('.exlusiveOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
else {<br />
$('.normalOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
});<br />
} <br />
</script></syntaxhighlight><br />
<br />
=Add Navigation Buttons (Next and Previous) To Top Of Page=<br />
<br />
''Tested with: 1.90+, IE 7/8, Firefox 3.6, Safari 3.2''<br />
<br />
Add the following to the end of template.js. It will insert a new div after the progress bar and then insert clones of the nav buttons in the new div.<br />
<br />
This example is for the default template in 1.90 or 1.91. The placement of the new div may need to be modified for other templates.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$(document).ready(function() {<br />
<br />
// Insert a new div after the progress bar<br />
$('<div id="navigator2" />').insertAfter('#progress-wrapper');<br />
<br />
// Style the new div<br />
$('#navigator2').css({<br />
'text-align':'center'<br />
});<br />
<br />
// Insert clones of the nav buttons in the new div<br />
$('input.submit:eq(0)').clone().appendTo('#navigator2');<br />
$('input.submit:eq(2)').clone().appendTo('#navigator2');<br />
<br />
// Give the new buttons some new IDs<br />
$('#navigator2 input.submit').each(function(i) {<br />
var oldID = $(this).attr('id');<br />
var newID = oldID + '2';<br />
$(this).attr('id', newID)<br />
});<br />
});</syntaxhighlight><br />
<br />
[[File:extra_buttons.png]]<br />
<br />
=How to ''add'' an opt out link to your survey=<br />
<br />
Tested with: 1.91+, Firefox 5.0<br />
<br />
This javascript inserts a link to opt out of the survey above the progress bar.<br />
<br />
[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]]<br />
<br />
Then insert the following code into to the source of a group description or a question. I used the group description.<br />
<br />
<syntaxhighlight lang="php" enclose="div"> <script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Find the survey ID<br />
if($('input#fieldnames').length != 0) {<br />
var fieldNames = $('input#fieldnames').attr('value');<br />
var tmp = fieldNames.split('X');<br />
var sID = tmp[0];<br />
}<br />
<br />
// Insert a new div after the progress bar<br />
$('<div id="optOutLink" />').insertBefore('#progress-wrapper');<br />
<br />
// Style the new div<br />
$('#optOutLink').css({<br />
'text-align':'center'<br />
});<br />
<br />
// Insert opt out url in the new div<br />
$('#optOutLink').html('<p><a href="optout.php?lang=en&sid;='+sID+'&token;={TOKEN}">Click here to opt out of this survey.</a></p><br>');<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Anonymously track respondents answers across multiple surveys=<br />
<br />
''Tested with: 1.91+ and 1.92+''<br />
<br />
This workaround uses JavaScript/jQuery to enable tracking of respondents across multiple surveys ensuring anonymity (it does not use tokens).<br />
<br />
To do this you have to use this question in all the surveys you want to link respondents answers.<br />
<br />
This workaround create an ID by asking some partial personal information (like initials, birth month ...). The ID will be encrypted using a one-way function (in this case SHA-1) and stored in a short text answer.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the following code in the source of a short text question.<br />
#Optional: you can also add other select field to avoid collisions (e.g. for large population sample)<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<p>This answers are used to generate your ID. These information will be encrypted, it will not be possible in any case to identify you neither from your answers nor from your ID.</p><br />
<br />
<table><br />
<br />
<tr><br />
<br />
<td>Initial of your name</td><br />
<br />
<td><br />
<br />
<select id="field1"><br />
<br />
<option value=""></option><br />
<br />
<option value="A">A</option><br />
<br />
<option value="B">B</option><br />
<br />
<option value="C">C</option><br />
<br />
<option value="D">D</option><br />
<br />
<option value="E">E</option><br />
<br />
<option value="F">F</option><br />
<br />
<option value="G">G</option><br />
<br />
<option value="H">H</option><br />
<br />
<option value="I">I</option><br />
<br />
<option value="J">J</option><br />
<br />
<option value="K">K</option><br />
<br />
<option value="L">L</option><br />
<br />
<option value="M">M</option><br />
<br />
<option value="N">N</option><br />
<br />
<option value="O">O</option><br />
<br />
<option value="P">P</option><br />
<br />
<option value="Q">Q</option><br />
<br />
<option value="R">R</option><br />
<br />
<option value="S">S</option><br />
<br />
<option value="T">T</option><br />
<br />
<option value="U">U</option><br />
<br />
<option value="V">V</option><br />
<br />
<option value="W">W</option><br />
<br />
<option value="X">X</option><br />
<br />
<option value="Y">Y</option><br />
<br />
<option value="Z">Z</option><br />
<br />
</select><br />
<br />
</td><br />
<br />
</tr><br />
<br />
<tr><br />
<br />
<td>Your birth month</td><br />
<br />
<td><br />
<br />
<select id="field2"><br />
<br />
<option value=""></option><br />
<br />
<option value="01">January</option><br />
<br />
<option value="02">February</option><br />
<br />
<option value="03">March</option><br />
<br />
<option value="04">April</option><br />
<br />
<option value="05">May</option><br />
<br />
<option value="06">June</option><br />
<br />
<option value="07">July</option><br />
<br />
<option value="08">August</option><br />
<br />
<option value="09">September</option><br />
<br />
<option value="10">October</option><br />
<br />
<option value="11">November</option><br />
<br />
<option value="12">December</option><br />
<br />
</select><br />
<br />
<td><br />
<br />
</tr><br />
<br />
</table><br />
<br />
<script type="text/javascript" src="http://crypto-js.googlecode.com/svn/tags/3.0.2/build/rollups/sha1.js"></script><br />
<br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
$("#answer{SGQ}").attr('readonly', 'readonly');<br />
<br />
//$("#answer{SGQ}").css('display', 'none'); //uncomment this line for not displaying the code<br />
<br />
});<br />
<br />
$('#field1, #field2').bind('change keyup', function() {<br />
<br />
if ($("#field1").val()=='' || $("#field2").val()=='')<br />
<br />
$("#answer{SGQ}").val('');<br />
<br />
else {<br />
<br />
var sha1 = CryptoJS.algo.SHA1.create();<br />
<br />
sha1.update($("#field1").val());<br />
<br />
sha1.update($("#field2").val());<br />
<br />
// sha1.update($("#otherfield").val());<br />
<br />
var hash = sha1.finalize();<br />
<br />
$("#answer{SGQ}").val(hash);<br />
<br />
}<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Check validity of international phone number in subquestion=<br />
<br />
''Tested with: 1.91+, Firefox 8, Chrome 15''<br />
<br />
As of version 1.92, you can use the core Validation querstion option to validate multiple short text and array text questions. Any question that fails that validation check will have its background color changed to red.<br />
<br />
Note, the below workaround will fail in version 1.92 because it contains a regular expression with curly braces. However, as described above, support for this feature is now built-in to version 1.92<br />
<br />
This workaround uses javascript to check the validity of an international phone number in a subquestion of multiple short text.<br />
<br />
Add the following code to the source of your question.<br />
<br />
Replace "QQ" with the question ID and "NN" with the row number that you want to validate.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Call the phone function with the question ID and the row number<br />
<br />
phoneTest(QQ, NN);<br />
<br />
function phoneTest(qID, inputNum) {<br />
<br />
// Interrupt next/submit function<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
// Some vars - modify as required<br />
<br />
var phoneMatch = /^[0-9,+,(), ,]{1,}(,[0-9]+){0,}$/;<br />
<br />
var msg1 = 'Please enter a valid phone number.';<br />
<br />
// Test the input<br />
<br />
var phoneInput = $('#question'+qID+' li:eq('+(inputNum-1)+') input.text').val();<br />
<br />
if(phoneInput != '' && !phoneMatch.test(phoneInput)) {<br />
<br />
alert(msg1);<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'pink' });<br />
<br />
return false;<br />
<br />
}<br />
<br />
else {<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'' });<br />
<br />
return true;<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
The regex is from: [http://www.regexlib.com/REDetails.aspx?regexp_id=1136 regexlib.com blank]<br />
<br />
=Check validity of email address in subquestion=<br />
<br />
'Tested with: 1.91+, Firefox 8, Chrome 15''<br />
<br />
<div class="simplebox">As of version 1.92, you can use the core Validation querstion option to validate multiple short text and array text questions. Any question that fails that validation check will have its background color changed to red.<br />Note, the below workaround will fail in version 1.92 because it contains a regular expression with curly braces. However, as described above, support for this feature is now built-in to version 1.92</div><br />
<br />
This workaround uses javascript to check the validity of an email address in a subquestion of multiple short text.<br />
<br />
Add the following code to the source of your question.<br />
<br />
Replace "QQ" with the question ID and "NN" with the row number that you want to validate.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Call the email function with the question ID and the row number<br />
<br />
emailTest(QQ, NN);<br />
<br />
function emailTest(qID, inputNum) {<br />
<br />
// Interrupt next/submit function<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
// Some vars - modify as required<br />
<br />
var emailMatch = /^[a-zA-Z0-9\_\-]+[a-zA-Z0-9\.\_\-]*@([a-zA-Z0-9\_\-]+\.)+([a-zA-Z]{2,4}|travel|museum)$/;<br />
<br />
var msg1 = 'Please enter a valid email address.';<br />
<br />
// Test the input<br />
<br />
var emailInput = $('#question'+qID+' li:eq('+(inputNum-1)+') input.text').val();<br />
<br />
if(emailInput != '' && !emailMatch.test(emailInput)) {<br />
<br />
alert(msg1);<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'pink' });<br />
<br />
return false;<br />
<br />
}<br />
<br />
else {<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'' });<br />
<br />
return true;<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
The regex is from: [http://www.regexlib.com/REDetails.aspx?regexp_id=1653 regexlib.com blank]<br />
<br />
=Hiding the help-text when it's empty=<br />
<br />
Tested with: 1.91+<br />
<br />
I had made a style in my template putting a border around my help-text. To avoid empty help-text to show up (and have lines instead of just 'nothing' when there was no help text, I used this piece of code in question.pstpl:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
var questionhelp="{QUESTIONHELP}";<br />
<br />
if (questionhelp=="") {<br />
<br />
document.write("");}<br />
<br />
else {<br />
<br />
document.write('<tr><td class="survey-question-help">'+ questionhelp +'</td></tr>');}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
it can probably be optimized but it worked for me<br />
<br />
=Disable or hide selected fields in a matrix question=<br />
<br />
''Tested with: 1.92+, IE 7/8/9, FireFox 12/13''<br />
<br />
TASK<br />
<br />
Hide or disable selected fields in a Matrix, so that users cannot make any input.<br />
<br />
(See example, where users should not make input into red framed fields)<br />
<br />
[[File:snap035.gif]]<br />
<br />
Fig. 1: Prevent users from input into first two fields (as an example)<br />
<br />
SOLUTION<br />
<br />
First find the name of the fields you want to hide / disable. In my case I used Firebug with firefox to figure that out.<br />
<br />
[[File:snap037.gif]]<br />
<br />
Fig. 2: Figure out the name(s) of the field(s)<br />
<br />
Then put the following script-code into the HTML-source code as described above:<br />
<br />
Note: you have to change the code to match the names of your fields!<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('input[name="69965X2X10SQ001_SQ001"]').attr('disabled', 'disabled');<br />
<br />
$('input[name="69965X2X10SQ001_SQ002"]').attr('hidden', 'hidden');<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
[[File:snap039.gif]]<br />
<br />
Fig. 3: Result: first field is diabled ("greyed out"), second one is completely hidden<br />
<br />
I think this way one can apply many other attributes to a field like color etc. But did not try that myself.<br />
<br />
Thanks to roB2009 for the input in the forum!<br />
<br />
=Add prefix or suffix to question type "Array (Texts)"=<br />
<br />
TASK<br />
<br />
Add a prefix or suffix to the text fields in questions of the "Array (Texts)" type.<br />
<br />
[[File:suffix.png]]<br />
<br />
Fig. 1: Suffix<br />
<br />
[[File:prefix.png]]<br />
<br />
Fig. 1: Prefix<br />
<br />
SOLUTION<br />
*Set up your survey to use JavaScript.<br />
*Add the following script to the source of the array. Replace "12345" with the array question ID and modify the suffixes/prefixes as required.<br />
*The function call must consist of a question ID followed by the suffixes for each column. Suffixes/Prefixes must be enclosed in quotes and comma separated.<br />
*In this example question ID 12345 will get an "in &euro;" suffix in the first column and an "in %" in the next 3 columns.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Call the function with the question ID followed by a comma-separated list of suffixes<br />
<br />
addSuffix(12345, 'in &euro;', 'in %', 'in %', 'in %');<br />
<br />
function addSuffix() {<br />
<br />
var qID = $(arguments)[0];<br />
<br />
// Assign some column-specific classes<br />
<br />
$('#question'+qID+' table.question tbody tr').each(function(i){<br />
<br />
$('td', this).each(function(i){<br />
<br />
$(this).addClass('answerCol-'+(i+1)+'');<br />
<br />
});<br />
<br />
});<br />
<br />
// Some styling<br />
<br />
$('#question'+qID+' table.question tbody input[type="text"]').css({<br />
<br />
'width': '50%'<br />
<br />
});<br />
<br />
// Insert the suffixes<br />
<br />
$(arguments).each(function(i, val){<br />
<br />
if(i > 0) {<br />
<br />
$('#question'+qID+' td.answerCol-'+i+' label').append(val);<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
For adding a prefix you need to substitute the following line in the code<br />
<br />
<syntaxhighlight lang="php" enclose="div">$('#question'+qID+' td.answerCol-'+i+' label').append(val);</syntaxhighlight><br />
<br />
with this<br />
<br />
<syntaxhighlight lang="php" enclose="div">$('#question'+qID+' td.answerCol-'+i+' label').prepend(val);</syntaxhighlight><br />
<br />
=Time question (Date question-like)=<br />
<br />
''Tested with: 1.92+''<br />
<br />
This workaround uses JavaScript/jQuery to build a Time question just like to the Date one.<br />
<br />
Implementation is as follows:<br />
#Download the file at [http://trentrichardson.com/examples/timepicker/jquery-ui-timepicker-addon.js trentrichardson.com/examples/timepicker/jquery-ui-timepicker-addon.js] and upload it to your survey.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the following code in the source of a short text question.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script src="/upload/surveys/{SID}/jquery-ui-timepicker-addon.js"></script><br />
<br />
<script><br />
<br />
$(document).ready(function(){<br />
<br />
$('#answer{SGQ}').timepicker({<br />
timeText: 'Time', //here translation<br />
hourText: 'hour', //here translation<br />
minuteText: 'minute', //here translation<br />
closeText: 'Done' //here translation<br />
});<br />
<br />
$('#answer{SGQ}').attr('readonly', 'readonly');<br />
<br />
$( "<style>"<br />
+".ui-widget-header, .ui-datepicker-current { display:none; }"<br />
+".ui-timepicker-div dl dt { height: 25px; margin-bottom: -25px; }"<br />
+".ui-timepicker-div dl dd { margin: 0 10px 10px 65px; }"<br />
+" }"<br />
+"</style>").appendTo( "head" );<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Calculating date difference=<br />
<br />
''Tested with: 1.92+ Build 120909''<br />
<br />
This workaround explains how calculate difference between two dates (in: days, weeks, months and years) and is based on this [http://ditio.net/2010/05/02/javascript-date-difference-calculation/ resource external].<br />
<br />
Requieres 2 groups and 'group by group' or 'question by question' presentation.<br />
<br />
Group 1 (2 date questions)<br />
*1st question - Question code: "DD"<br />
*2nd question - Question code: "D2"<br />
<br />
Group 2<br />
*1 numerical input question.<br />
<br />
This question retrieves the number of days between the 2 dates, and check if D2 is posterior than DD.<br />
<br />
All the requiered code have to be added in the source of this numerical question.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
/*<br />
<br />
Adapted from http://ditio.net/2010/05/02/javascript-date-difference-calculation/<br />
*/<br />
<br />
var DateDiff = {<br />
<br />
inDays: function(d1, d2) {<br />
<br />
var t2 = d2.getTime();<br />
<br />
var t1 = d1.getTime();<br />
<br />
return parseInt[[t2-t1)/(24*3600*1000]];<br />
<br />
},<br />
<br />
inWeeks: function(d1, d2) {<br />
<br />
var t2 = d2.getTime();<br />
<br />
var t1 = d1.getTime();<br />
<br />
return parseInt[[t2-t1)/(24*3600*1000*7]];<br />
<br />
},<br />
<br />
inMonths: function(d1, d2) {<br />
<br />
var d1Y = d1.getFullYear();<br />
<br />
var d2Y = d2.getFullYear();<br />
<br />
var d1M = d1.getMonth();<br />
<br />
var d2M = d2.getMonth();<br />
<br />
return (d2M+12*d2Y)-(d1M+12*d1Y);<br />
<br />
},<br />
<br />
inYears: function(d1, d2) {<br />
<br />
return d2.getFullYear()-d1.getFullYear();<br />
<br />
}<br />
<br />
}<br />
<br />
d1 = new Date({substr(DD,0,4)}, {substr(DD,5,2)}, {substr(DD,8,2)});<br />
<br />
d2 = new Date({substr(D2,0,4)}, {substr(D2,5,2)}, {substr(D2,8,2)});<br />
<br />
// Displays result<br />
<br />
document.write("<br />Number of <b>days</b>: "+DateDiff.inDays(d1, d2));<br />
<br />
document.write("<br />Number of <b>weeks</b>: "+DateDiff.inWeeks(d1, d2));<br />
<br />
document.write("<br />Number of <b>months</b>: "+DateDiff.inMonths(d1, d2));<br />
<br />
document.write("<br />Number of <b>years</b>: "+DateDiff.inYears(d1, d2));<br />
<br />
// filled the numerical input with number of days (or nights)<br />
<br />
var nDays = +DateDiff.inDays(d1, d2);<br />
<br />
jQuery(document).ready(function() {<br />
<br />
$(".numeric:eq(0) input.text").val(nDays);<br />
<br />
$(".numeric:eq(0) input.text").attr('readonly','readonly');<br />
<br />
// check if d2 > d1<br />
<br />
$('#movenextbtn').hide();<br />
<br />
$('#movesubmitbtn').hide();<br />
<br />
if(nDays >= 0){<br />
<br />
// automatic submit (uncomment if needed)<br />
<br />
// document.limesurvey.submit();<br />
<br />
// $('body').hide();<br />
<br />
}<br />
<br />
else alert("Check out date must be posterior than Check in\nPlease return to the previous page and edit your answers");<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=How to set minDate/maxDate based on other Datequestions=<br />
<br />
'' tested with Version 2.00+ Build 130708''<br />
<br />
QQ1 and QQ2 are the question identifiers. QQ2 gets as maxDate today and as minDate the date set in QQ1. The onClose event is needed because on document.ready the value of QQ1 is not yet known, although the value of today is.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function () {<br />
'use strict';<br />
var qID1 = QQ1,<br />
qID2 = QQ2,<br />
q1 = $('#question' + 'QQ1' + ' .popupdate'), <br />
q2 = $('#question' + 'QQ2' + ' .popupdate');<br />
<br />
//if q1 loses focus, its value is taken and used as minDate in q2 <br />
q1.datepicker("option", "onClose", function (datum){<br />
q2.datepicker( "option", "minDate", datum );<br />
});<br />
//q2 gets today as its maxDate<br />
q2.datepicker( 'option', 'maxDate', new Date() );<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
=Remove Question Help if empty=<br />
<br />
''Version 2.00+ Build 130513''<br />
<br />
Change your question.pstpl in your Template Editor so that the line looks like below. I've added the ID tag help_{question_number}.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<tr><td class="survey-question-help" id=help_{QUESTION_NUMBER}>{QUESTIONHELP}</td></tr><br />
</syntaxhighlight><br />
<br />
You can then add the following javascript at the end of question.pstpl. If the contents of the help tag is empty then hide the element.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script><br />
$(document).ready(function(){<br />
if($('#help_{QUESTION_NUMBER}').is(':empty')){<br />
$('#help_{QUESTION_NUMBER}').hide();<br />
}<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
= Implicit Association Test (IAT)=<br />
<br />
''Tested with: 2.0, IE 7-10, Firefox, Chrome, iPad''<br />
<br />
This workaround uses JavaScript to insert an IAT interface into an Array (Texts) question. The workaround prompts respondents to assign words or phrases using the "E" or "I" keys. In mobile devices, "E" and "I" buttons are provided.<br /><br /><br />
<br />
[[File:Iat_1.png]]<br /><br /><br />
<br />
Download a [[Media:Demo_IAT_Concept.zip|working template]] and [[Media:Demo_iat_concept.lss|working survey]].<br />
<br />
Implementation is as follows:<br />
<br />
1) [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
<br />
2) Create your Array (Texts) with sub-questions as follows:<br /><br />
- Y scale - all of your "attribut" words or phrases<br /><br />
- X scale - "Key Pressed" and "Elapsed Time (ms)"<br /><br />
[[File:Iat_2.jpg]]<br />
<br />
3) Insert your association terms and the other text elements for the interface into the Question Help section as depicted below. The text strings must be separated with "double pipes" (||) and you will need to place them in the following order:<br /><br />
- Left association term<br /><br />
- Right association term<br /><br />
- Instructional text<br /><br />
- Finished text<br /><br />
[[File:Iat_3.png]]<br />
<br />
4) Add the following to the end of template.js:<syntaxhighlight lang="javascript" enclose="div"><br />
// A plugin to insert an IAT interface<br />
function implicitAssociation(el, showAnswers) {<br />
<br />
$(el).each(function() {<br />
<br />
var thisQuestion = $(this);<br />
var thisQuestionHelp = $('img[src$="help.gif"]', thisQuestion).parent();<br />
var thisQuestionAnswers = $('table.question', thisQuestion).parent();<br />
var startTime = '';<br />
var endTime = ''; <br />
var agent = navigator.userAgent.toLowerCase();<br />
var mobile = false;<br />
if( /android|webos|iphone|ipad|ipod|blackberry/i.test(navigator.userAgent) ) { // Mobile devices<br />
mobile = true;<br />
}<br />
mobile = true;<br />
<br />
// Some classes<br />
$(thisQuestion).addClass('iatQuestion');<br />
$('.subquestion-list').addClass('unanswered');<br />
<br />
// Hide the question help element<br />
$(thisQuestionHelp).hide();<br />
<br />
// Hide the answers<br />
if(showAnswers != true) {<br />
$('table.question', thisQuestion).hide();<br />
}<br />
<br />
// Insert IAT display<br />
var iatTexts = $(thisQuestionHelp).text().split('||');<br />
var iatDisplayHTML = '<div class="iatWrapper">\<br />
<div class="iatLeftLabel">'+iatTexts[0]+'</div>\<br />
<div class="iatRightLabel">'+iatTexts[1]+'</div>\<br />
<div class="iatWord"></div>\<br />
<div class="iatInstructions">'+iatTexts[2]+'</div>\<br />
</div>\<br />
<div class="iatMobileButtonWrapper">\<br />
<div class="iatButton iatLeftButton">E</div>\<br />
<div class="iatButton iatRightButton">I</div>\<br />
<div style="width:100%; clear:both;"></div>\<br />
</div>';<br />
$(thisQuestionAnswers).prepend(iatDisplayHTML);<br />
<br />
// Show a word<br />
function iatShowWord() {<br />
$('div.iatWord', thisQuestion).text($('.subquestion-list.unanswered:first .answertext', thisQuestion).text());<br />
startTime = new Date();<br />
<br />
$(document).bind('keypress.iatKeypress', function(e) {<br />
if(e.which == 101 || e.which == 105) {<br />
var thisRow = $('.subquestion-list.unanswered:eq(0)', thisQuestion);<br />
$(thisRow).removeClass('unanswered');<br />
endTime = new Date();<br />
$('input[type="text"]:eq(1)', thisRow).val(endTime.valueOf() - startTime.valueOf());<br />
if(e.which == 101) {<br />
$('input[type="text"]:eq(0)', thisRow).val('E');<br />
}<br />
else {<br />
$('input[type="text"]:eq(0)', thisRow).val('I');<br />
}<br />
$(document).unbind('keypress.iatKeypress');<br />
if($('.subquestion-list.unanswered', thisQuestion).length > 0) {<br />
iatShowWord();<br />
}<br />
else {<br />
$('.iatLeftLabel, .iatWord, .iatRightLabel, .iatInstructions', thisQuestion).fadeOut('slow', function() {<br />
$('div.iatWord', thisQuestion).text(iatTexts[3]);<br />
$('.iatWord', thisQuestion).addClass('done').fadeIn('slow');<br />
});<br />
}<br />
}<br />
});<br />
}<br />
function iatShowWordMobile() {<br />
$('div.iatWord', thisQuestion).text($('.subquestion-list.unanswered:first .answertext', thisQuestion).text());<br />
startTime = new Date();<br />
<br />
$('.iatButton', thisQuestion).bind('click.iatButtonClick', function(e) {<br />
var thisRow = $('.subquestion-list.unanswered:eq(0)', thisQuestion);<br />
$(thisRow).removeClass('unanswered');<br />
endTime = new Date();<br />
$('input[type="text"]:eq(1)', thisRow).val(endTime.valueOf() - startTime.valueOf());<br />
$('input[type="text"]:eq(0)', thisRow).val($(this).text());<br />
$('.iatButton', thisQuestion).unbind('click.iatButtonClick');<br />
if($('.subquestion-list.unanswered', thisQuestion).length > 0) {<br />
iatShowWordMobile();<br />
}<br />
else {<br />
$('.iatLeftLabel, .iatWord, .iatRightLabel, .iatInstructions, .iatMobileButtonWrapper', thisQuestion).fadeOut('slow', function() {<br />
$('div.iatWord', thisQuestion).text(iatTexts[3]);<br />
$('.iatWord', thisQuestion).addClass('done').fadeIn('slow');<br />
});<br />
}<br />
});<br />
}<br />
<br />
// Start the IAT display<br />
if(mobile == true) { // Mobile devices<br />
$('.iatMobileButtonWrapper', thisQuestion).show();<br />
$('.iatButton', thisQuestion).bind('click.iatStartMobile', function(e) {<br />
$('.iatButton', thisQuestion).unbind('click.iatStartMobile');<br />
iatShowWordMobile();<br />
});<br />
}<br />
else {<br />
$(document).bind('keypress.iatStart', function(e) { // Non-mobile devices<br />
if(e.which == 101 || e.which == 105) {<br />
$(document).unbind('keypress.iatStart');<br />
iatShowWord();<br />
}<br />
});<br />
}<br />
});<br />
} </syntaxhighlight><br />
<br />
<br />5) Add the following to the end of template.css:<syntaxhighlight lang="css" enclose="div"><br />
/* IAT questions */<br />
<br />
.iatWrapper {<br />
position: relative;<br />
width: 600px;<br />
height: 300px;<br />
color: #FFFFFF;<br />
background-color: #000000;<br />
font-size: 21px;<br />
}<br />
<br />
.iatLeftLabel {<br />
float: left;<br />
padding: 10px;<br />
}<br />
<br />
.iatRightLabel {<br />
float: right;<br />
padding: 10px;<br />
}<br />
<br />
.iatWord {<br />
position: absolute;<br />
width: 100%;<br />
top: 35%;<br />
text-align: center;<br />
font-size: 36px;<br />
color:#0F0;<br />
}<br />
<br />
.iatWord.done {<br />
color:#FFFFFF;<br />
}<br />
<br />
.iatInstructions {<br />
position: absolute;<br />
width: 100%;<br />
bottom: 0px;<br />
padding-bottom: 10px;<br />
text-align: center;<br />
}<br />
<br />
.iatMobileButtonWrapper {<br />
display: none;<br />
position: relative;<br />
width: 600px;<br />
font-size: 36px;<br />
}<br />
<br />
.iatButton {<br />
float: left;<br />
margin: 20px;<br />
width: 100px;<br />
padding: 2px 0 5px 0;<br />
border: 5px solid #999;<br />
-moz-border-radius: 10px;<br />
-webkit-border-radius: 10px;<br />
-khtml-border-radius: 10px;<br />
border-radius: 10px;<br />
text-align: center;<br />
line-height: normal;<br />
cursor: pointer;<br />
}<br />
<br />
.iatLeftButton {<br />
float: left;<br />
}<br />
<br />
.iatRightButton {<br />
float: right;<br />
}</syntaxhighlight><br />
<br />
<br />6) To apply the plugin, add one of the two scripts below to the question source:<br /><br />
- With hidden answer table (for normally activated survey)<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"> <br />
$(document).ready(function() {<br />
// Apply the IAT plugin to this question<br />
implicitAssociation('#question{QID}');<br />
}); <br />
</script></syntaxhighlight><br />
- With visible answer table (for testing purposes)<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"> <br />
$(document).ready(function() {<br />
// Apply the IAT plugin to this question<br />
implicitAssociation('#question{QID}', true);<br />
}); <br />
</script></syntaxhighlight><br />
<br />
<br />
=Make multiple choice easier=<br />
<br />
''Tested with Version 2.00 in Chrome, FF, Safar, IE''<br />
<br />
The problem:<br />
We often have multiple choice question, where the user has to select 4 elements out of 78 possible answers or 3 out of 25 and so on.<br />
If we use pen and paper version for this questions, we noticed that the participants go through the whole list and if an answer doesn't suit on the first sight, they cross it out.<br />
<br />
The solution:<br />
The script gives the participant the possibility to cross out this answers in a digital way. The script adds a small "X" before the checkbox. When it is clicked, the label text of the checkbox turns grey.<br />
(see the attached screenshot for an example)<br />
<br />
Here is the script, just add it to help text<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript"><br />
<br />
/**<br />
* Small script that adds a "X" before a checkbox. <br />
* On click the text color of the label of the checkbox turns grey<br />
* If the user has to choose some answers from many options, he can "delete" answers, that on first sight looks wrong<br />
* Add the script to the question in Limesurvey (for example within the source code of the help text)<br />
*/<br />
<br />
//Define the X (standard is a X in capitals)<br />
var x = "X";<br />
css_class = "x";<br />
<br />
/*<br />
* Define the style of the X<br />
* Of course you can define the style in the stylesheet - if so, the script ignores the following settings<br />
* If there is a style, than set style var to 1<br />
*/<br />
var style = 0;<br />
var size = "12px";<br />
var weight = "bold";<br />
var color = "red";<br />
var cursor = "pointer";<br />
<br />
//element type - standard is a span element<br />
var type = "span";<br />
<br />
//Define the new font color of the checkbox label<br />
label_color = "#bfbfbf";<br />
<br />
<br />
//End of configuration - start of the function<br />
<br />
//Define the element that is added<br />
if(style == 1) {<br />
ele = "<"+type+" class='"+css_class+"'>"+x+"</"+type+">";<br />
}<br />
else {<br />
ele = "<"+type+" class='"+css_class+"' style='font-size:"+size+"; font-weight:"+weight+"; color:"+color+"; cursor:"+cursor+";'>"+x+"</"+type+">";<br />
}<br />
<br />
//Get the standard font-color of the used style<br />
st_color = $("label").css("color");<br />
<br />
//insert the X before the checkboxes<br />
$(document).ready(function() { <br />
$("li").each(function(){<br />
$(this).prepend(ele);<br />
});<br />
});<br />
<br />
//bind an eventhandler on the X (delegate is used, because Limesurvey uses an old jQuery version)<br />
var css_class_c = "."+css_class;<br />
$(document).delegate(css_class_c,"click",function() {<br />
var color_check = $(this).siblings("label").data("color");<br />
if(color_check != "true") {<br />
$(this).siblings("label").css("color",label_color).data("color","true");<br />
$(this).siblings('input').attr('checked', false);<br />
<br />
}<br />
else {<br />
$(this).siblings("label").css("color",st_color).data("color","false");<br />
<br />
}<br />
});<br />
<br />
$(".checkbox").click(function () {<br />
$(this).siblings("label").css("color",st_color).data("color","false");<br />
});<br />
<br />
</script><br />
</syntaxhighlight></div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Workarounds:_Manipulating_a_survey_at_runtime_using_Javascript&diff=59824Workarounds: Manipulating a survey at runtime using Javascript2014-01-16T03:57:00Z<p>Jcleeland: /* Drag and Drop Ranking - Version 1.90 to 1.92 */</p>
<hr />
<div><br />
Often you want to manipulate certain elements of a survey at runtime. The only solution without touching the source code is to use JavaScript or jQuery which is shipped with LimeSurvey. Here are some examples to hide and style elements, validate user input or do calculations at runtime.<br />
<br />
Other workarounds can be found at<br />
* [[Workarounds: Survey behaviour]]<br />
* [[Workarounds: Question design, layout and templating]]<br />
<br />
<div class="simplebox"><center><br />'''Please keep in mind that these workarounds are not official LimeSurvey extensions - they are solutions that users have created for themselves.<br /><span style='color:#EE0000,#FFFFFF'>Therefore LimeSurvey can't offer guarantees or support for these solutions.</span><br />If you have questions, please contact the users that, thankfully, shared their solutions with the community.'''<br /><br /></center></div><br />
<br />
<div class="simplebox">Note: Version 1.92 implements many new features that make some existing workarounds obsolete. You can continue to use existing workarounds, but may want to consider switching over to using the new features (since those new features are officially supported, and the workarounds are not). Please review below for details of which are no longer needed.<br /><br /></div><br />
<br />
<div class="simplebox">Also Note: Version 1.92's Expression Manager (EM) may cause some of these work-arounds to fail. Any custom javascript included as a .js file will be fine. However, if you in-line your JavaScript code, you must make sure that you have a space after every opening (left) curly brace, and a space before every closing (right) curly brace. Otherwise, EM will think that the content between the curly braces is something it should parse and understand. I have fixed all of the work-arounds below that can be fixed (many did not follow those rules). However, some will continue to break. If a work-around contains a regular expression which contains curly braces (to indicate a range of repeats of a sub-expression), EM will try to process those curly braces, and thus break your regular expression. Strategies to continue to support that work-around functionality are discussed below.<br /><br /></div><br />
<br />
__TOC__<br />
<br />
=How to ''add'' a javascript workaround solution to this Wiki page?=<br />
<br />
Well, this is pretty easy. Click the edit icon and create your own headline within the javascript section starting with "'''!'''". Then add a short note about the version you have used when creating your workaround, you can copy/paste this code snippet <nowiki>''Tested with: (enter LimeSurvey version and maybe browser)''</nowiki>.<br />
<br />
Finally it's imported to mark all your code with code tags, other wise you might break this page.<br />
*Start tag: '''<nowiki><syntaxhighlight lang="php" enclose="div"></nowiki>'''<br />
*End tag: '''<nowiki></syntaxhighlight></nowiki>'''.<br />
<br />
=How to ''use'' Script (eg. JavaScript etc.) in LimeSurvey?=<br />
<br />
To use JavaScript within LimeSurvey, the XSS filter must be turned off and the code inserted in the source of a question or a group description.<br />
*Go to Global settings --> Security and set "Filter HTML for XSS" to "Off".<br />
* [http://docs.limesurvey.org/tiki-index.php?page=Adding+A+Question Add a new question]<br />
* Edit the question and click the "Source" button in the editor toolbar:<br />
<br />
[[File:editor_1.gif]]<br />
* Enter your script after the question text:<br />
<br />
[[File:editor_2.gif]]<br />
* Save the question<br />
<br />
A simple test to see if JavaScript is enabled is to echo an alert. Use this code:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
alert("Test!");<br />
<br />
</script></syntaxhighlight><br />
<br />
It is a good practice to use the jQuery $(document).ready function to prevent the code from executing until the page is fully loaded:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
alert("Test!");<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
It is also good practice to use jslint.com to get a good layout and design (e.q. no cluttering of name space)<br />
<br />
=Sum up input values using Javascript=<br />
<br />
''Tested with: ''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the sum() function in [[Expression Manager|Expression Manager]]. See this [[Expression Manager HowTos#Calculate assessment values at runtime and store the results in the survey data|HowTo example]].</div><br />
<br />
<div class="simplebox">Starting in Version 1.92, you also do no longer need to use SGQA (e.g. 45251X1X5) identifiers. Instead the code <code>{SGQ}</code> will automatically replaced by the current questions SGQA-codes.</div><br />
<br />
This is from a survey that is a invitation to a longer party, when the user clicks to the next page, the calculated results will be shown.<br />
<br />
If you wonder what the {INSERTANS:1X6X12} stuff is, look at [http://docs.limesurvey.org/tiki-index.php?page=SGQA+Identifier SGQA identifier] and [[Adding a question#Information from previous answers|Using information from previous answers]].<br />
<br />
<syntaxhighlight lang="html4strict" enclose="div"><br />
<br />
<div style="text-align: left">These are your answers:<br /><br />
<br />
<u></u><u></u><u></u><u></u><u>=<br />
<br />
<p><script LANGUAGE="JavaScript"><br />
<br />
partyprice = 3;<br />
<br />
beadclothprice = 3;<br />
<br />
breakfastprice = 7;<br />
<br />
lunchprice = 8;<br />
<br />
dinnerprice = 10;<br />
<br />
foodtotal = 0;<br />
<br />
var isreallytrue = "Yes";<br />
<br />
var noanswer = "No answer";<br />
<br />
document.write( "Can you come? = {INSERTANS:45251X1X1}<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X1}" == isreallytrue )<br />
<br />
{<br />
<br />
if ("{INSERTANS:45251X1X3}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X3}"; }<br />
<br />
partypeople = parseInt(answer);<br />
<br />
partytotal = partyprice * partypeople;<br />
<br />
document.write( "It's {INSERTANS:45251X1X3} persons who will come = " + partytotal + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X4}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X4}";}<br />
<br />
beadcloths = parseInt(answer);<br />
<br />
beadclothtotal = beadclothprice * beadcloths;<br />
<br />
document.write( "You want to borrow {INSERTANS:45251X1X4} beadcloths = " + beadclothtotal + "&euro;<BR>" );<br />
<br />
document.write( "Will you be there thursday? = {INSERTANS:45251X1X5}<BR>" );<br />
<br />
document.write( "On friday you will have these meals: <BR>" );<br />
<br />
if ("{INSERTANS:45251X1X71}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X71}";}<br />
<br />
breakfastfriday = parseInt(answer) * breakfastprice;<br />
<br />
document.write( "'''_ " + answer + " breakfeasts = " + breakfastfriday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X72}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X72}";}<br />
<br />
lunchfriday = parseInt(answer) * lunchprice ;<br />
<br />
document.write( "'''_ " + answer + " lunches = " + lunchfriday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X73}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X73}";}<br />
<br />
dinnerfriday = parseInt(answer)* dinnerprice ;<br />
<br />
document.write( "'''_ " + answer + " dinners = " + dinnerfriday + "&euro;<BR>" );<br />
<br />
foodtotal = breakfastfriday + lunchfriday + dinnerfriday;<br />
<br />
document.write( "Will you be there saturday? = {INSERTANS:45251X1X8}<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X8}" == isreallytrue )<br />
<br />
{<br />
<br />
document.write( "On saturday you will have these meals: <BR>" );<br />
<br />
if ("{INSERTANS:45251X1X91}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X91}"; }<br />
<br />
breakfastsaturday = parseInt(answer) * breakfastprice ;<br />
<br />
document.write("'''_ " + answer + " breakfeasts = " + breakfastsaturday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X92}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X92}"; }<br />
<br />
lunchsaturday = parseInt(answer) * lunchprice ;<br />
<br />
document.write( "'''_ " + answer + " lunches = " + lunchsaturday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X93}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X93}"; }<br />
<br />
dinnersaturday = parseInt(answer) * dinnerprice ;<br />
<br />
document.write( "'''_ " + answer + " dinners = " + dinnersaturday + "&euro;<BR>" );<br />
<br />
foodtotal = foodtotal + breakfastsaturday + lunchsaturday + dinnersaturday;<br />
<br />
}<br />
<br />
document.write( "Will you be there sunday? = {INSERTANS:45251X1X10}<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X10}" == isreallytrue )<br />
<br />
{<br />
<br />
document.write( "On sunday you will have these meals: <br>" );<br />
<br />
if ("{INSERTANS:45251X1X111}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X111}"; }<br />
<br />
breakfastsunday = parseInt(answer) * breakfastprice ;<br />
<br />
document.write( "'''_ " + answer + " breakfeasts = " + breakfastsunday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X112}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X112}"; }<br />
<br />
lunchsunday = parseInt(answer) * lunchprice ;<br />
<br />
document.write( "'''_ " + answer + " lunches = " + lunchsunday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X113}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X113}"; }<br />
<br />
dinnersunday = parseInt(answer) * dinnerprice ;<br />
<br />
document.write( "'''_ " + answer + " dinners = " + dinnersunday + "&euro;<p>" );<br />
<br />
foodtotal = foodtotal + breakfastsunday + lunchsunday + dinnersunday;<br />
<br />
}<br />
<br />
total = partytotal + beadclothtotal + foodtotal;<br />
<br />
document.write( "<h3>In total it will cost you " + total + "&euro;</h3><BR><br />
<br />
Put that sum in this bank account 1234 5678 9012" );<br />
<br />
}<br />
<br />
</SCRIPT></p><br />
<br />
</div></syntaxhighlight><br />
<br />
=Multiple Question Validation=<br />
<br />
''Tested with: ''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the min/max/equals_num_value attributes (to validate sums), or the em_validation_q function, which lets you refer to other variables when you validate the current question [[Expression Manager|Expression Manager]]. Such validations also work on the current page, and properly handle array_filter and cascading relevance.</div><br />
<br />
This workaround is in case you need to do some validation involving more than one question, it implies a very little JavaScript programming and the use of SGQA Identifiers; this should work on almost any version of LimeSurvey.<br />
<br />
Is easy to explain with an example, we need to do a survey of the percentage of males and females and we want to be sure that the sum is 100, to do this follow this steps (the necessary data that is not indicated in these instructions are not important i.e. question codes, etc.):<br />
#Create a new survey of type "group by group", set the "Show |<< Prev| button" to yes and note the SID.<br />
#Add a new group called "Group 1" and note the GID.<br />
#Add a new question "Percent of males" of type "numeric", make it mandatory and note the QID (we will refer to this as QID1).<br />
#Add a new question "Percent of females" of type "numeric", make it mandatory and note the QID (we will refer to this as QID2).<br />
#Add a new group called "Group 2"<br />
#Add a new non mandatory question, here is the trick the question text has to be (be sure to replace the SID, GID, QID1 and QID2<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script><br />
<br />
function validation()<br />
<br />
{<br />
<br />
if [[{INSERTANS:SIDXGIDXQID1}+{INSERTANS:SIDXGIDXQID2}) != 100)<br />
<br />
{<br />
<br />
alert("Your responses don't sum 100! Check them");<br />
<br />
document.limesurvey.move.value = 'moveprev';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
else<br />
<br />
{<br />
<br />
document.limesurvey.move.value = 'movelast';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
}<br />
<br />
setTimeout("validation()",250);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
But this will show shortly the question and will jump to the end page, a little weird for the survey taker but works.<br />
<br />
This is a proof of concept, and may have some problems, please if you notice something or improve it send me an e-mail to leochaton-limesurvey at yahoo dot com.<br />
<br />
This will work for 2 questions that you want to be the same. Works well for email and confirm email questions<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
function validation() {<br />
<br />
if ("{INSERTANS:SIDXGIDXQID}" != "{INSERTANS:SIDXGIDXQID}") {<br />
<br />
alert("Your responses don't match Check them"); document.limesurvey.move.value = 'moveprev';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
}<br />
<br />
setTimeout("validation()",250);<br />
<br />
</syntaxhighlight><br />
<br />
=Alternate exit=<br />
<br />
''Tested with: ''<br />
<br />
Using the same idea of the previous post, you can implement an alternate exit of your survey.<br />
<br />
This script should be in the first question to be displayed in a next page after the question that should trigger the alternate exit. In this example the question that trigger the alternate exit is a Yes/No question, if the user chooses no, he is redirected to another page.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
if ("{INSERTANS:SIDXGIDXQID}" == "No")<br />
<br />
{<br />
<br />
window.location="http://www.limesurvey.org";<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Custom onload function=<br />
<br />
''Tested with: 'All browsers', LimeSurvey 1.70 and up<br />
<br />
==General==<br />
<br />
This simple workaround describes how to '''add a custom Javascript code''' that is triggered right after the page is loaded. It may have numerous applications, especially when you deal with a custom JS/HTML code. It may be used to hide form elements (<input> tags), make them read-only, display alert messages, etc.<br />
<br />
To run any Javascript code right after page load use the Query ready() function. It will be executed when the page is being loaded. For example when you add the following code to one of your question definitions...:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
jQuery(document).ready(<br />
<br />
function(){<br />
<br />
alert('onload alert!');<br />
<br />
}<br />
<br />
);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
...it will display a pop-up message immediately after the page has been loaded.<br />
<br />
Some of the applications of this trick I've explored are:<br />
<br />
a) Hiding the form elements by calling in your Custom_On_Load:<br />
<br />
<syntaxhighlight lang="php" enclose="div">document.getElementById("answer73166X16X54").style.display='none';</syntaxhighlight><br />
<br />
Note: As of svn build 9755, you can now dynamically reference the questions input fields by using the {SGQ} keyword. You can rewrite the previous example like this:<br />
<br />
<syntaxhighlight lang="php" enclose="div">document.getElementById("answer{SGQ}").style.display='none';</syntaxhighlight><br />
<br />
this makes it a little easier when exporting surveys, so you don't have to worry about manually entering each questions SurveyGroupQuestion ID.<br />
<br />
b) Making the elements read only:<br />
<br />
<syntaxhighlight lang="php" enclose="div">document.getElementById("answer73166X16X54").readOnly=true;</syntaxhighlight> where the "answer73166X16X54" structure has been described in one of other workarounds above.<br />
<br />
c) For Hiding by a lot of elements by calling in your Customer_On_Load<br />
<br />
jQuery searchs in html document for input-fields with radio type, if his answer text empty then do the display css set to none.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
jQuery(document).ready(<br />
<br />
function() {<br />
<br />
jQuery('input:radio').each(<br />
<br />
function() {<br />
<br />
var s = jQuery(this);<br />
<br />
var c = s.parent().children('.answertext');<br />
<br />
for(var i=0; i < c.length; i++) {<br />
<br />
var a = jQuery(c[i]]);<br />
<br />
if(this.id </u> a.attr('for') && a.text() == '') {<br />
<br />
s.css({ 'display' : 'none' });<br />
<br />
a.css({ 'display' : 'none' });<br />
<br />
break;<br />
<br />
}<br />
<br />
}<br />
<br />
}<br />
<br />
)<br />
<br />
}<br />
<br />
);<br />
<br />
</syntaxhighlight><br />
<br />
==Advanced usage==<br />
<br />
If you want to place global Javascript code using the above jQuery(document).ready function then the best place to do this is the template javascript file template.js. You can edit this file using the template editor. Please be aware that placing it in the template javascript file will make the function available to all surveys using that template. If needed just create a new template copy for your survey.<br />
<br />
Alternatively you can place the jQuery(document).ready function in the group description to make a Javascript function only available to a certain question group.<br />
<br />
==Language-specific Javascript code==<br />
<br />
There is an easy way to find out the current language and execute according Javascript using jQuery: The <html> tag of any survey pages contains an 'lang' attribute which holds the current language code. You can read that language code by using the followin code<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
jQuery(document).ready(<br />
<br />
function(){<br />
<br />
languagecode=$('html').attr('lang');<br />
<br />
alert('This is the current language code: '+languagecode);<br />
<br />
}<br />
<br />
);<br />
<br />
</syntaxhighlight><br />
<br />
For an English survey the above code would show a messagebox with "This is the current language code: en"<br />
<br />
=Custom onload function in multi-language survey=<br />
<br />
''Tested with: 1.85+ (7253), IE 6/7, FireFox 3.0, Safari 3.2,''<br />
<br />
To use custom onload functions, as above, in multi-language surveys you must define the functions in the question source for '''all''' languages.<br />
<br />
While this initially seems to be a bit tedious, it actually can be useful - you can alter your onload functions depending on the language in use. For example, you can dynamically display alerts or element contents in the current language.<br />
<br />
=Skipping the welcome page=<br />
<br />
''Tested with: 1.85 (second code snippet)''<br />
<br />
<div class="simplebox">Note: As of version 1.91, there is a survey option letting you skip the welcome page, so this workaround is not needed.</div><br />
<br />
'''Solution 1:''' Include this Javascript in your welcome template, in the file welcome.pstpl for all welcome page, or in the source of the welcome text for one survey:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
jQuery(document).ready(function($) {<br />
<br />
document.limesurvey.move.value = 'movenext';<br />
<br />
document.limesurvey.submit(); });<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
It will reproduce the onclick event of the submit button and submit the form.<br />
<br />
Drawback of course is that users will see the page flashing up.<br />
<br />
Therefore, you may want to announce "... loading survey ..." as a description of your welcome page (in the admin interface when creating the survey), to pretend loading something big.<br />
<br />
'''Solution 2:'''<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
function custom_on_load(){<br />
<br />
document.limesurvey.move.value = 'movenext';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
window.setTimeout( 'custom_on_load()',1);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Filter answers of a question with the answer of another=<br />
<br />
===Method 1===<br />
<br />
''Tested with: 1.70 - 1.72''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the the array_filter attribute, or relevance equations in general.</div><br />
<br />
If you want to filter the answer of a question with another answer, you can use this workaround.<br />
<br />
First, use answer code like that: XX for the first question, and XXYYY for the second one.<br />
<br />
Answer of the second question filter if the 2 first letters are the answer of the first question.<br />
<br />
We use 1000X1X1 and 1000X1X2 for the example, question had to be on separate page (question by question for example).The second question had to be a dropdown list (we can do similar workaround, but droplis is the best). You can do this using JQuery. It leaves the answer in the select box, but disables it. You could also replace "disable" with "remove" to get rid of it altogether.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
var previousQuestionAnswer = "{INSERTANS:1000X1X1}";<br />
<br />
var currentQuestionID = "#answer1000X1X1"<br />
<br />
$(document).ready(function() {<br />
<br />
// See if the answer for the previous question matches an answer in the current question<br />
<br />
// (other than 'No Answer')<br />
<br />
// If so, disable it.<br />
<br />
if (previousQuestionAnswer!='No Answer') {<br />
<br />
$(currentQuestionID).children().each(function(index, Element)<br />
<br />
{<br />
<br />
if ($(this).attr('text') == previousQuestionAnswer)<br />
<br />
{ $(this).attr('disabled', true); }<br />
<br />
}<br />
<br />
);}<br />
<br />
}); // End of JQuery ready function<br />
<br />
</syntaxhighlight><br />
<br />
===Method 2===<br />
<br />
''Tested with 1.92 + Firefox 9.0''<br />
<br />
If you have a country, state, and city set of questions (or similar), you could code answer options as:<br />
<br />
'''Q1 Country''' ''Single choice list (ratio, dropdown)''<br />
<br />
X country#<br />
<br />
'''Q2 State''' ''Single choice list (dropdown)''<br />
<br />
XY state#<br />
<br />
'''Q3 City''' ''Single choice list (dropdown)''<br />
<br />
XYZZ city#<br />
<br />
Now you must put the following Javascript code in the source of question 2 (State):<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Get the countryCode (first character of the country)<br />
<br />
var countryCode = '{INSERTANS:1000X1X1}'.substr(0, 1).toUpperCase();<br />
<br />
// Loop through all dropdown options and remove those with codes not starting with the countryCode<br />
<br />
$('select[id<div class="simplebox">="answer"] option').each(function(i){<br />
<br />
if($(this).attr('value') && $(this).attr('value').substr(0, 1).toUpperCase() != countryCode) {<br />
<br />
$(this).remove();<br />
<br />
}<br />
<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
And the following code in the source of question 3 (City):<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Get the stateCode (two first characters of the state)<br />
<br />
var stateCode = '{INSERTANS:1000X1X2}'.substr(0, 2).toUpperCase();<br />
<br />
// Loop through all dropdown options and remove those with codes not starting with the stateCode<br />
<br />
$('select[id</div>="answer"] option').each(function(i){<br />
<br />
if($(this).attr('value') && $(this).attr('value').substr(0, 2).toUpperCase() != stateCode) {<br />
<br />
$(this).remove();<br />
<br />
}<br />
<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
Each question must be in different pages of survey to work, i.e. in a question by question survey, or in diferent groups in a group by group survey.<br />
<br />
Note that if you choose a two characters answer option code in the State question, i.e. a XYY answer option code, you must change the ''substr(0, 2)'' part of code in question 3 to ''substr(0, 3)''.<br />
<br />
=Filter answers of a multiple numeric type question=<br />
<br />
''Tested with: 1.90+''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the the array_filter attribute, or relevance equations in general. In 1.92, array_filter works with all questions that have sub-questions (e.g. also works for multiple numeric and multiple short text).</div><br />
<br />
If you want to filter a question of type "multiple numeric", you have to modify the workaround.<br />
<br />
Note that this workaround assumes that the code for each of the subquestions are a numeric sequence 1,2,3...<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function(){<br />
<br />
// Match elements with labels using htmlFor and a loop<br />
<br />
var labels = document.getElementsByTagName('LABEL');<br />
<br />
for (var i = 0; i < labels.length; i++) {<br />
<br />
if (labels[i].htmlFor != '') {<br />
<br />
var elem = document.getElementById(labels[i].htmlFor);<br />
<br />
if (elem)<br />
<br />
elem.label = labels[i];<br />
<br />
}<br />
<br />
}<br />
<br />
var answerFilter="{INSERTANS:96553X63X759}";<br />
<br />
for (i=0; i<30; i++){<br />
<br />
var iLabel = document.getElementById('answer96553X63X760'+(i+1]].label.innerHTML;<br />
<br />
if (answerFilter.search(iLabel) == -1){<br />
<br />
// Hide element<br />
<br />
$('#question760').find('li').eq(i).hide();<br />
<br />
// Set value of hidden elements to zero<br />
<br />
document.getElementById('answer96553X63X760'+(i+1)).value = 0;<br />
<br />
}<br />
<br />
}<br />
<br />
});</script><br />
<br />
</syntaxhighlight><br />
<br />
=Use an answer to prefill another question (default value)=<br />
<br />
''Tested with: 1.72''<br />
<br />
''And tested with: 1.91+''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the enhanced defaults feature, which lets you pre-fill most question types with default values. In 1.91, you could set defaults for list and multiple choice questions. In 1.92, you can set defaults for any text-entry question too. Moreover, the defaults can be [[Expression Manager|Expression Manager]] compatible equations or tailored text. Finally, with 1.92, defaults are properly managed even when set on the same page.</div><br />
<br />
This workaround gives you the ablility to use an answer to fill the default value for another question. It's explained for free text question type but can be adapted for another question type.<br />
<br />
We use SGQA identifier. For example, we use SGQA 1000X10X20 and 1000X10X21 to prefill 1000X11X30 and 1000X11X31. For the script to work, the question has to be on a different page.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answer1000X11X30').val('{INSERTANS:1000X10X20}');<br />
<br />
$('#answer1000X11X31').val('{INSERTANS:1000X10X21}');<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
If you want use two times the value of an integer input, you can also use this to prefill a question that you hide via CSS.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answer1000X2X2').val(parseInt('{INSERTANS:1000X1X1}')*2);<br />
<br />
$("#question2").hide();<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
Now you can use {INSERTANS:1000X2X2} for giving you twice the value of the user input from question 1.<br />
<br />
=Dynamic Sum=<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do with [[Expression Manager|Expression Manager]] using the sum() function. Not only will sums be dynamic, but they wille exclude irrelevant values, so you can array_filter a multiple numeric question and get the sum of just the answers that are visible. This [[Expression Manager HowTos#Calculate assessment values at runtime and store the results in the survey data|HowTo example]] demonstrates the dynamic sum feature.</div><br />
<br />
<div class="simplebox">Also note, as of version 1.92, the following workaround will fail, since it includes a a regular expression containing curly braces.</div><br />
<br />
This script is used with a "Multiple Options" type question calculate a total price based on how which checkboxes are selected. The prices are listed as part of the answer. The answers are set up like this: "USB Mouse ($20)". The script uses the number between the "($" and the ")" as the price for that item. You can adapt the script to if you need to change the currency or need to sum something other than money.<br />
<br />
This script works when used in a question-by-question format. It does not work when there are more than one question on a page. I think it can be adapted to work, but I haven't done the coding yet.<br />
<br />
Put the following code into body of your question:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script language=Javascript><br />
<br />
// General definitions<br />
<br />
// Define a regular expression to match the labels containing information about an answer<br />
<br />
// In LimeSurvey, these labels start with "answer..."<br />
<br />
var answerRegex = /^answer/;<br />
<br />
// Find all answer checkboxes in the document and set their<br />
<br />
// onchange events to updatePrice<br />
<br />
function Custom_On_Load()<br />
<br />
{<br />
<br />
// Find all input elements<br />
<br />
var inputList=document.getElementsByTagName("input");<br />
<br />
// Loop through each, looking for checkboxes<br />
<br />
var i;<br />
<br />
for( i=0; i< inputList.length;i++ )<br />
<br />
{<br />
<br />
// If input item does not have an ID, skip<br />
<br />
if (! (inputList[i].id)) { continue; }<br />
<br />
// Skip to next if ID doesn't start with "answer"<br />
<br />
if (!answerRegex.test(inputList[i].id)) { continue; }<br />
<br />
// Skip to next if not a checkbox<br />
<br />
if (inputList[i].type.toUpperCase()!='CHECKBOX') { continue; }<br />
<br />
// This is an answer checkbox!<br />
<br />
// Setup onchange event<br />
<br />
inputList[i].onclick = updatePrice;<br />
<br />
}<br />
<br />
// Load initial sum<br />
<br />
updatePrice();<br />
<br />
}<br />
<br />
function updatePrice()<br />
<br />
{<br />
<br />
var labels=document.getElementsByTagName("LABEL");<br />
<br />
// Define a regular expression to match a price inside parenthesis<br />
<br />
// For example: ($29) or ($29.54).<br />
<br />
// Set up<br />
<br />
priceRegex = /\(\$(\d*\.{0,1}\d+)\)/;<br />
<br />
// Loop through all the labels, looking for labels corresponding to<br />
<br />
// answers that have a price in them.<br />
<br />
var i;<br />
<br />
var total = 0;<br />
<br />
for( i=0; i<labels.length;i++ )<br />
<br />
{<br />
<br />
var myArray; // Define array used for regex matching<br />
<br />
var inputID; // Define field element<br />
<br />
// Get the ID of the field corresponding to the label using the<br />
<br />
// "htmlFor" attribute<br />
<br />
// (FYI, there are some labels that will have to be screened out<br />
<br />
// because they don't correspond to an answer)<br />
<br />
// Does the label start with "answer"?<br />
<br />
// If not: exit.<br />
<br />
if (!answerRegex.test(labels[i].htmlFor)) { continue; }<br />
<br />
// First make sure this element exists<br />
<br />
// If it doesn't, go to the next element<br />
<br />
// If it does, it will be defined in inputID<br />
<br />
if (! (inputID = document.getElementById(labels[i].htmlFor)) ) { continue; }<br />
<br />
// See if the corresponding answer is a checkbox that is checked.<br />
<br />
// If not, go to next label<br />
<br />
if (inputID.type.toUpperCase()!='CHECKBOX') { continue; }<br />
<br />
if (!inputID.checked) { continue; }<br />
<br />
// This is label for an answer.<br />
<br />
// The innerHTML will give us the text of the label<br />
<br />
// The price information will be in the form ($XX.XX)<br />
<br />
// which in contained in the label text.<br />
<br />
// Find a match for a decimal number inside the pattern "($" and ")"<br />
<br />
if [[myArray = priceRegex.exec(labels[i].innerHTML]] != null)<br />
<br />
{<br />
<br />
// Keep a running tally<br />
<br />
total += parseFloat(myArray[1]);<br />
<br />
}<br />
<br />
}<br />
<br />
// Update total price on form<br />
<br />
document.getElementById("totalPrice").value = "$" + formatCurrency(total);<br />
<br />
}<br />
<br />
function formatCurrency(num) {<br />
<br />
num = isNaN(num) || num <u> '' || num </u> null ? 0.00 : num;<br />
<br />
return parseFloat(num).toFixed(2);<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
Put the following code in the help section (or wherever you want the sum to appear):<br />
<br />
<syntaxhighlight lang="php" enclose="div">Total Cost for selected accessories: <input type="readonly" value="" id="totalPrice" /></syntaxhighlight><br />
<br />
=Focus on the first Input field=<br />
<br />
(''Tested with: LimeSurvey 1.80 / IE6/7, Firefox 3, Safari, Opera, chrome'')<br />
<br />
<div class="simplebox">As of version 1.91, there is a built-in JavaScript function called focusFirst() to focus on the first visible element. It uses jQuery, so is more robust than this example.</div><br />
<br />
Again an onload Function is needed for this tasks. I have done it the DOM way with compatibility to IE6/7.<br />
<br />
Put the following code into the startpage.pstpl of your template, right before the </head> closing tag:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
function focusFirst(Event)<br />
<br />
{<br />
<br />
var i=0;<br />
<br />
while(document.forms[0].elements[i].type == "hidden")<br />
<br />
{<br />
<br />
i++;<br />
<br />
}<br />
<br />
document.forms[0].elements[i].focus();<br />
<br />
return;<br />
<br />
}<br />
<br />
if(ie)<br />
<br />
{ window.attachEvent("onload", focusFirst); }<br />
<br />
else<br />
<br />
{ document.addEventListener("load", focusFirst, true); }<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
'''Note:''' I am using this with version 1.80. As changes happened to the templates in the last release, you might need to add the following before the code, if your template is older than 1.80 stable and does not include this:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
var ie = false;<br />
<br />
</script><br />
<br />
<br />
<br />
</syntaxhighlight><br />
<br />
You will need this for the var ie to be set. Without this var, the function will not work with ie.<br />
<br />
=Answer questions by keypress=<br />
<br />
(''Tested with: IE7, Firefox 3'')<br />
<br />
This workaround allow to answer the question on key 0-9 (0 is for the 10 answer).<br />
<br />
Follow issues are supported at the moment:<br />
*Yes-No Questions<br />
*List Questions (radio)<br />
*other radio questions<br />
<br />
In lists the answer limit is ten.<br />
<br />
You supply the template "endpage" of your template with the following script.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
jQuery(document).ready(function() {<br />
<br />
jQuery(document).bind('keypress', function(e){<br />
<br />
if (48 <= e.which && e.which <= 57) {<br />
<br />
jQuery('input:radio').each(function() {<br />
<br />
var v = jQuery(this).val();<br />
<br />
var c = (e.which <u> 48) ? 10 : e.which - 48;<br />
<br />
if(v </u> 'Y' || v <u> 'N') {<br />
<br />
v = (v </u> 'Y') ? 1 : 2;<br />
<br />
}<br />
<br />
if(v == c) {<br />
<br />
jQuery(this).click();<br />
<br />
jQuery('#limesurvey input:submit').click();<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
})<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Math notation in LimeSurvey=<br />
#download the js file from [http://mathcs.chapman.edu/~jipsen/mathml/asciimathdownload.html AsciiMath script]<br />
#copy it in the /scripts/ folder in your installation<br />
#modify the startpage.psptl of the template you want to use adding the reference to the script (if you use an older version make sure that you copy the template folder first!) for example:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" src="ASCIIMathML.js"><br />
<br />
</syntaxhighlight><br />
<br />
Use the notation where you need it!<br />
<br />
'''Note:''' If you use internet explorer or safari you will need to download the plugin as well, but firefox does the lot for you.<br />
<br />
Finally, if you are confident with the limesurvey structure you could add the editor which support math notation and change the reference to the editor you want to use in the configuration file. here is the [http://www.imathas.com/editordemo/demo.html link for a TinyMCE with math support].<br />
<br />
=Reverse array_filter (for pre-1.90)=<br />
<br />
''Tested with: 1.85+ (7253), IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
<div class="simplebox">Note: Version 1.91 natively supports this functionality via the array_filter_exclude advanced quation option.</div><br />
<br />
This can be used to filter the answers of an array question to be displayed based on the answers of a multi option question that were '''NOT''' selected. A possible application would be to have a multi-option question asking which products were purchased, followed by 2 array questions - one asking to rate the purchased products and another asking why the remaining products were not purchased. Another would be to ask about sessions attended at a conference as in [http://www.limesurvey.org/en/forum/5-can-i-do-this-with-limesurvey/27970-reverse-of-arrayfilter.html this forum thread] and pictured below. There is a live [http://www.partnersinc.biz/surveys//index.php?sid=43358&newtest=Y&lang=en demo here]<br />
<br />
[[File:sessions_645x344.gif]]<br />
<br />
We'll use the above example to explain the process as follows:<br />
#In group 1 - Create a ''SessionsAttended'' multi-options question<br />
#In group 1 - Create a ''SessionsNotAttended'' multi-options question with identical answers as ''SessionsAttended'' and hide it with styles or conditions<br />
#In group 2 - Create a ''RateSessionsAttended'' array question with an [http://docs.limesurvey.org/tiki-index.php?page=Question+attributes&structure;=English+Instructions+for+LimeSurvey#array_filter array_filter] based on ''SessionsAttended''<br />
#In group 2 - Create a ''ReasonNotAttended'' array question with an [http://docs.limesurvey.org/tiki-index.php?page=Question+attributes&structure;=English+Instructions+for+LimeSurvey#array_filter array_filter] based on ''SessionsNotAttended''<br />
#In group 1 - Place JavaScript/jQeury listeners on each of the checkboxes in ''SessionsAttended'' that would toggle the corresponding checkbox in ''SessionsNotAttended'' to the opposite state<br />
<br />
The JavaScript/jQuery code used would be:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
// The toggle function<br />
<br />
function toggle(q1, q2) {<br />
<br />
if ($(q1).attr('checked') == false ) {<br />
<br />
$(q2).attr('checked', true);<br />
<br />
}<br />
<br />
else {<br />
<br />
$(q2).attr('checked', false);<br />
<br />
}<br />
<br />
}<br />
<br />
// Initialize the SessionNotAttended checkboxes to "checked"<br />
<br />
toggle ('#answer11111X22X331', '#answer11111X22X441');<br />
<br />
toggle ('#answer11111X22X332', '#answer11111X22X442');<br />
<br />
toggle ('#answer11111X22X333', '#answer11111X22X443');<br />
<br />
toggle ('#answer11111X22X334', '#answer11111X22X444');<br />
<br />
// The jQuery listeners on the SessionAttended checkboxes<br />
<br />
// that toggle the SessionNotAttended checkboxes<br />
<br />
$('#answer11111X22X331').change(function() {<br />
<br />
toggle ('#answer11111X22X331', '#answer11111X22X441');<br />
<br />
});<br />
<br />
$('#answer11111X22X332').change(function() {<br />
<br />
toggle ('#answer11111X22X332', '#answer11111X22X442');<br />
<br />
});<br />
<br />
$('#answer11111X22X333').change(function() {<br />
<br />
toggle ('#answer11111X22X333', '#answer11111X22X443');<br />
<br />
});<br />
<br />
$('#answer11111X22X334').change(function() {<br />
<br />
toggle ('#answer11111X22X334', '#answer11111X22X444');<br />
<br />
});<br />
<br />
</syntaxhighlight><br />
<br />
Some notes about the code:<br />
*The code is in an onload function defined in the first question of group 1 - see [[Workarounds#Custom_onload_function|here]]<br />
*Both ''SessionsAttended'' and ''SessionsNotAttended'' must be in the same group for the toggling to work<br />
*This case only uses 4 checkboxes but could be expanded as required<br />
*In this case the survey ID is 11111, the group ID is 22, ''SessionsAttended'' ID is 33 and SessionsNotAttended ID is 44 - these would need to be modified for your survey<br />
*The toggle function looks for the state of a checkbox in ''SessionsAttended'' and sets the corresponding checkbox in ''SessionsNotAttended'' to the opposite state<br />
*The "Initialize" section sets the state of ''SessionsNotAttended'' checkboxes whenever we navigate to the group<br />
*The "Listener" section uses jQuery listeners to detect any change in the ''SessionsAttended'' checkboxes and then toggle the corresponding ''SessionsNotAttended'' checkbox<br />
<br />
Some general notes about the questions:<br />
*CSS can be used to hide ''SessionsNotAttended'' (div#question44 { display: none; }) if you don't want to use conditions (because maybe you've got [[Optional settings#Survey Behavior|$deletenonvalues set to 1]])<br />
*''RateSessionsAttended'' and ''ReasonNotAttended'' are another group to avoid things popping in and out of existence as ''SessionsAttended'' is answered<br />
*[[Setting conditions|Conditions]] are used to ensure that ''RateSessionsAttended'' only appears if some sessions are selected and ''ReasonNotAttended'' only appears if no sessions are selected<br />
<br />
=Filter Ranking Question With Multiple-Options (pre 1.92)=<br />
<br />
''Tested with: 1.90, IE 7/8, FireFox 3/4, Safari 5.0, Chrome 10.0''<br />
<br />
<div class="simplebox">As of version 1.92, most of this is easier to do using the the array_filter attribute, or relevance equations in general. They all work on the same page, and fully support cascading relevance.</div><br />
<br />
This workaround applies a filter to a ranking question based on the checked boxes of a previous multiple-options question. There are two methods - one for filter and ranking questions being on the same page and a slightly different one for the filter question being on a page before the ranking question.<br />
<br />
There is a [http://www.partnersinc.biz/surveys//index.php?sid=96314&newtest=Y&lang=en demo of both methods here].<br />
<br />
Implementation is as follows.<br />
<br />
'''FOR BOTH METHODS:'''<br />
*[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
*Place the following script in your template.js file. This function will be accessed by either method.<syntaxhighlight lang="javascript" enclose="div"><br />
// A function to filter choices in a ranking question<br />
function rankFilter(q1ID, q2ID, prevPage) {<br />
<br />
// If filter question is on a previous page, hide Q1 and check all "visible" boxes<br />
if(prevPage == 1) {<br />
$('#question'+q1ID+' li[id<div class="simplebox">="javatbd"]:visible input.checkbox').attr('checked', true);<br />
$('#question'+q1ID+'').hide();<br />
}<br />
<br />
handleChecked(q1ID, q2ID);<br />
$('#question'+q1ID+' input.checkbox').click(function() {<br />
handleChecked(q1ID, q2ID);<br />
});<br />
<br />
function handleChecked(q1ID, q2ID) {<br />
<br />
// Find the survey and group IDs<br />
if($( 'input#fieldnames' ).length != 0) {<br />
var fieldNames = $( 'input#fieldnames' ).attr('value');<br />
var tmp = fieldNames.split('X');<br />
var sID = tmp[0];<br />
var gID = tmp[1];<br />
}<br />
<br />
// Loop through all Q1 options<br />
$('#question'+q1ID+' input.checkbox').each(function(i) {<br />
<br />
// Find the answer code and value<br />
var tmp2 = $(this).attr('id').split('X'+gID+'X'+q1ID+'');<br />
var ansCode = tmp2[1];<br />
var ansTxt = $(this).next('label').text();<br />
<br />
// If option is checked and not in rank choices or output, add it to the rank choices<br />
if($(this).attr('checked') == true<br />
&& $('#question'+q2ID+' select.select option[value="'+ansCode+'"]').length == 0<br />
&& $('#question'+q2ID+' .output input[id</div>="fvalue_"][value="'+ansCode+'"]').length == 0) {<br />
$('<option value="'+ansCode+'">'+ansTxt+'</option>').appendTo('#question'+q2ID+' select.select');<br />
}<br />
<br />
// If option is unchecked...<br />
else if($(this).attr('checked') == false) {<br />
// Remove it from the rank choices<br />
$('#question'+q2ID+' select.select option[value="'+ansCode+'"]').remove();<br />
// Remove it from the rank output and reset hidden values<br />
$('#question'+q2ID+' .output input[id<div class="simplebox">="fvalue_"][value="'+ansCode+'"]').attr('value', '').siblings('input.text').val('').siblings('img').hide();<br />
}<br />
});<br />
<br />
// Clean up empty inputs in the rank output table<br />
$('#question'+q2ID+' .output table tr').each(function(i) {<br />
var nextRow = $(this).next('tr');<br />
if($('input.text', this).val() == '' && $('input.text', nextRow).val() != '') {<br />
$('input.text', this).val($('input.text', nextRow).val());<br />
$('input.text', nextRow).val('');<br />
$('input[id</div>="fvalue_"]', this).attr('value', $('input[id<div class="simplebox">="fvalue_"]', nextRow).attr('value'));<br />
$('input[id</div>="fvalue_"]', nextRow).attr('value', '');<br />
}<br />
});<br />
<br />
// Show the scissors for the last populated rank output row<br />
$('#question'+q2ID+' .output table img[id<div class="simplebox">="cut_"]').hide();<br />
$('#question'+q2ID+' .output table input.text[value!=""]:last').siblings('img[id</div>="cut_"]').show();<br />
<br />
// Hide extra rank output rows<br />
var optNum = $('#question'+q1ID+' input.checkbox:checked').length;<br />
$('#question'+q2ID+' .output table tr').hide();<br />
$('#question'+q2ID+' .output table tr:lt('+(optNum+1)+')').show();<br />
<br />
// Hide and clear the ranking question if there are less than 2 checked options in Q1<br />
if(optNum < 2) {<br />
$('#question'+q2ID+'').hide();<br />
$('#question'+q2ID+' input.text').val('');<br />
$('#question'+q2ID+' input[id<div class="simplebox">="fvalue_"]').attr('value', '');<br />
}<br />
else {<br />
$('#question'+q2ID+'').show();<br />
}<br />
<br />
// A workaround for the built in max-answers function<br />
$('#question'+q2ID+' select.select').attr('disabled', true);<br />
$('#question'+q2ID+' td.output tr:visible').each(function(i) {<br />
if($('input.text', this).val() == '') {<br />
$('#question'+q2ID+' select.select').attr('disabled', false);<br />
}<br />
});<br />
}<br />
<br />
// A listener to work around the built in max-answers function<br />
$('#question'+q2ID+' td.rank').click(function (event) {<br />
$('#question'+q2ID+' select.select').attr('disabled', true);<br />
$('#question'+q2ID+' td.item input.text').each(function(i) {<br />
if ($(this).val() == '') {<br />
$('#question'+q2ID+' select.select').attr('disabled', false);<br />
}<br />
});<br />
});<br />
}</syntaxhighlight><br />
<br />
'''FOR BOTH FILTER AND RANKING QUESTIONS ON SAME PAGE:'''<br />
*Create a multiple options question and a ranking question on the same page (in the same group).<br />
*Both questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Place the following script in the source of one of the questions.<br />
*Replace "MM" with the ID of the multiple options question and "RR" with the ID of the ranking question.<br />
*The function will hide the ranking question unless at least two options are selected in the multiple options question, in which case, it will only show the options selected.<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
rankFilter(MM, RR);<br />
});<br />
</script></syntaxhighlight><br />
<br />
'''FOR FILTER AND RANKING QUESTIONS ON SEPARATE PAGES:'''<br />
*Create a multiple options question on page 1.<br />
*Create a multiple options question and a ranking question on page 2.<br />
*All three questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Set the multiple options on page 2 to be filtered by the multiple options on page 1.<br />
*Place the following script in the source of one of the questions on page 2.<br />
*Replace "MM" with the ID of the multiple options question and "RR" with the ID of the ranking question. Do not modify the "1".<br />
*The function will hide the multiple options question. If at least 2 options were selected in the multiple options on page 1, the corresponding options will be checked in the hidden multiple options question which will then be used to control the display of the ranking question.<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function() {<br />
rankFilter(MM, RR, 1);<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Filter "Array by Column" Question With "Multiple-Options"=<br />
<br />
''Tested with: 1.91, IE 7/8, FireFox 3/4, Safari 5.0, Chrome 10.0''<br />
<br />
This workaround applies a filter to an "Array by Column" question based on the checked boxes of a previous multiple-options question. There are two methods - one for filter and array questions being on the same page and a slightly different one for the filter question being on a page before the array question.<br />
<br />
There is a [http://www.partnersinc.biz/surveys//index.php?sid=74213&newtest=Y&lang=en demo of both methods here].<br />
<br />
Implementation is as follows.<br />
<br />
'''FOR BOTH METHODS:'''<br />
*[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
*Place the following scripts in your template.js file. These functions will be accessed by either method.<syntaxhighlight lang="javascript" enclose="div"><br />
$(document).ready(function() {<br />
<br />
function filterArrByCol(qMultiOpt, qArray, prevPage) {<br />
<br />
// If filter question is on a previous page, hide Q1 and check all "visible" boxes<br />
if(prevPage == 1) {<br />
$('#question'+qMultiOpt+' li[id</div>="javatbd"]:visible input.checkbox').attr('checked', true);<br />
$('#question'+qMultiOpt+'').hide();<br />
}<br />
<br />
// Assign classes to the answer cells<br />
$('#question'+qArray+' table.question tbody td').each(function(i){<br />
var classArr = $(this).attr('class').split('answer_cell_00');<br />
var ansCode = classArr[1];<br />
$(this).addClass('ans-'+ansCode+' filtered');<br />
});<br />
<br />
// Assign classes to the answer label cells<br />
$('#question'+qArray+' table.question tbody tr:eq(0) td').each(function(i){<br />
var classArr2 = $(this).attr('class').split(' ans-');<br />
var ansCode2 = classArr2[1];<br />
$('#question'+qArray+' table.question thead tr:eq(0) th:eq('+i+')').addClass('ans-'+ansCode2+'');<br />
});<br />
<br />
// Fire the filter function on page load<br />
filterArr(qMultiOpt, qArray);<br />
<br />
// Listener on multi-opt checkboxes to fire the filter function<br />
$('#question'+qMultiOpt+' input.checkbox').click(function(){<br />
filterArr(qMultiOpt, qArray);<br />
});<br />
<br />
// On submit, clear all hidden radios of array<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
$('#question'+qArray+' td.filtered:hidden').each(function(i){<br />
$('input.radio', this).attr('checked', false);<br />
});<br />
return true;<br />
});<br />
}<br />
<br />
function filterArr(qMultiOpt, qArray) {<br />
<br />
if($('#question'+qMultiOpt+' input.checkbox:checked').length < 1) {<br />
// Hide the array if no multi-opt options are checked<br />
$('#question'+qArray+'').hide();<br />
}<br />
else {<br />
$('#question'+qArray+'').show();<br />
<br />
// Hide all columns of array<br />
$('#question'+qArray+' table.question tbody td, #question'+qArray+' table.question thead th').hide();<br />
<br />
// Loop through multi-opt checkboxes and, if checked, show corresponding column of array<br />
$('#question'+qMultiOpt+' input.checkbox').each(function(i){<br />
if($(this).attr('checked') == true) {<br />
var classArr3 = $(this).attr('id').split('X'+qMultiOpt);<br />
var ansCode3 = classArr3[1];<br />
$('#question'+qArray+' .ans-'+ansCode3+'').show();<br />
}<br />
});<br />
}<br />
}<br />
});</syntaxhighlight><br />
<br />
'''FOR BOTH FILTER AND ARRAY QUESTIONS ON SAME PAGE:'''<br />
*Create a multiple options question and an array-by-column question on the same page (in the same group).<br />
*Both questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Place the following script in the source of one of the questions.<br />
*Replace "MM" with the ID of the multiple options question and "AA" with the ID of the ranking question.<br />
*The function will hide the array question unless at least one option is selected in the multiple-options question, in which case, it will only show the corresponding array column(s).<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function() {<br />
filterArrByCol(MM, AA);<br />
});<br />
</script></syntaxhighlight><br />
<br />
'''FOR FILTER AND ARRAY QUESTIONS ON SEPARATE PAGES:'''<br />
*Create a multiple options question on page 1.<br />
*Create a multiple options question and an array-by-column question on page 2.<br />
*All three questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Set the multiple options on page 2 to be filtered by the multiple options on page 1.<br />
*Place the following script in the source of one of the questions on page 2.<br />
*Replace "MM" with the ID of the multiple options question and "AA" with the ID of the array question. Do not modify the "1".<br />
*The function will hide the multiple options question. If options were selected in the multiple options on page 1, the corresponding options will be checked in the hidden multiple options question which will then be used to control the display of the array columns.<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function() {<br />
filterArrByCol(MM, AA, 1);<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Auto-tabbing between text input fields=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
This is a workaround to facilitate auto-tabbing between text input questions in a single group using a [http://plugins.jquery.com/project/autotab jQuery plugin by Mathachew] and the Maximum characters attribute of questions.<br />
<br />
The behaviour will be: When the maximum number of characters has been entered into an input field, the focus (cursor) will be automatically moved to the next input field. When the backspace key is used to remove all characters from a field, the focus will be moved to the previous field. It's very useful in surveys having many text input questions to avoid having to manually tab or click between fields.<br />
<br />
You can view a small demo survey [http://www.partnersinc.biz/surveys//index.php?sid=11327&newtest=Y&lang=en here].<br />
<br />
Implementation is as follows:<br />
#Visit [http://plugins.jquery.com/autotabs http://plugins.jquery.com/autotabs], download the plugin script and save it as ''jquery.autotab-1.1b.js'' in the template folder.<br />
#Link to the script by placing ''<script type="text/javascript" src="{TEMPLATEURL}jquery.autotab-1.1b.js"></script>'' within the ''<head>'' tag of startpage.pstpl.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Create the text based questions that auto-tabbing is to be applied to. (All must be in the same group if you're using group by group presentation)<br />
#Define a Maximum characters attribute for all questions that the autotab is applied to.<br />
{{QS:maximum_chars}} <br />
#In the source of the first question of the group that contains the auto-tabbed questions, add the following code.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answerSSSSSXGGXAA').focus(); //initially focus on the first input<br />
<br />
$('#answerSSSSSXGGXAA').autotab({ target: 'answerSSSSSXGGXBB' });<br />
<br />
$('#answerSSSSSXGGXBB').autotab({ previous: 'answerSSSSSXGGXAA', target: 'answerSSSSSXGGXCC' });<br />
<br />
$('#answerSSSSSXGGXCC').autotab({ previous: 'answerSSSSSXGGXBB', target: 'answerSSSSSXGGXDD' });<br />
<br />
$('#answerSSSSSXGGXDD').autotab({ previous: 'answerSSSSSXGGXCC' });<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
This example has 4 fields to be auto-tabbed between - all instances of the following must be replaced to be compatible with your survey (See image below):<br />
*SSSSS -> Survey ID<br />
*GG -> Group ID<br />
*AA -> First question<br />
*BB -> Second question<br />
*CC -> Third question<br />
*DD -> Last question<br />
<br />
[[File:ids_343x252.gif]]<br />
<br />
The ''target'' parameter defines where the next input is and the ''previous'' parameter defines (you guessed it) the previous input.<br />
<br />
This plugin also has limited capability of formatting the input text - see comments in the plugin script.<br />
<br />
=Custom response listeners=<br />
<br />
''Tested with: 1.85+ (7253), IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
Listeners can be used to perform functions when a change in an input is detected. There are many uses such as the [[Workarounds#Reverse_array_filter|Reverse array_filter]] but a simple one would be to warn a respondent if they enter a value that may be too high.<br />
<br />
We can use the [http://docs.jquery.com/Events/change jQuery change( ) event] to fire a function whenever there is a change to the input. The function will look for an input value higher than 10 and, if found, will warn the respondent.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the script below in the source of one of the questions on the page where:<br />
**11111 is the survey ID<br />
**22 is the group ID<br />
**33 is the question ID<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answer11111X22X33').change(function() {<br />
<br />
if ( $('#answer11111X22X33').val() > 10 ) {<br />
alert ("That's an awful lot. Are you sure?");<br />
}<br />
});<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Text input masks=<br />
<br />
''Tested with: 1.90+, IE 7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
There may be instances where you would like to place a mask on a text input - for example only allowing respondents to enter the correct characters for a North American phone number ((###) ###-####) or a Canadian postal code (A1A 1A1) The [http://plugins.jquery.com/project/meioMask jQuery meioMask plugin by fabiomcosta] can be used to do this.<br />
<br />
The plugin has several pre-defined masks and supports custom masks. It also allows for pasting of input, allows default values and can auto-focus the next form element when the current input is completely filled. See [http://www.meiocodigo.com/projects/meiomask/ http://www.meiocodigo.com/projects/meiomask/] for more details on features and options.<br />
<br />
There is a small demo [http://www.partnersinc.biz/surveys//index.php?sid=36146&newtest=Y&lang=en here].<br />
<br />
Implementation for this demo was as follows:<br />
#Visit [http://www.meiocodigo.com/projects/meiomask/ http://www.meiocodigo.com/projects/meiomask/], download the latest plugin script and save it as jquery.meiomask.js in the template folder.<br />
#Link to the script by placing <script type="text/javascript" src="{TEMPLATEURL}jquery.meiomask.js" charset="utf-8"></script> within the <head> tag of startpage.pstpl.<br />
#Turn off $filterxsshtml to allow insertion of JavaScript in the questions. ([http://docs.limesurvey.org/tiki-index.php?page=Optional+settings&structure=English+Instructions+for+LimeSurvey#Filtering_dangerous_HTML_tags_in_survey_objects See documentation here])<br />
#Create the text input questions that the masks are to be applied to<br />
#In the source of the help section of the first question of the group that contains the masked inputs, add the following code. ([http://docs.limesurvey.org/tiki-index.php?page=Workarounds&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._ See How to use script here]) <br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() { <br />
<br />
// Define custom masks<br />
$.mask.masks = $.extend($.mask.masks,{<br />
customMask1:{ mask: 'a9a 9a9' }, // Canadian postal code<br />
// Maximum input of 9,999.99, reverse input, default value of 0.00 <br />
customMask2:{ mask: '99.999,9', type : 'reverse', defaultValue : '000' } <br />
});<br />
<br />
// Set the 'alt' attributes of the inputs<br />
$('#answer111111X22XAA').attr('alt', 'phone-us'); // a pre-defined mask <br />
$('#answer111111X22XBB').attr('alt', 'customMask1'); // a custom mask <br />
$('#answer111111X22XCC').attr('alt', 'customMask2'); // a custom mask <br />
$('#answer111111X22XDD').attr('alt', 'cc'); // a pre-defined mask for credit card<br />
<br />
// Tell the plugin to apply masks to these inputs<br />
$('input:#answer111111X22XAA').setMask();<br />
$('input:#answer111111X22XBB').setMask();<br />
$('input:#answer111111X22XCC').setMask();<br />
$('input:#answer111111X22XDD').setMask(); <br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
<br />
The first section defines two custom masks to be used - one for Canadian postal code with a format of A#A #A# and a second for a maximum amount of 9999.99 with reverse input (useful for cost inputs) and a default value of 0.00.<br />
<br />
The next section sets the "alt" attributes for the text inputs. This will tell meioMask which mask we will be applying to each input. By default meioMask looks at the alt attribute to find which mask to apply however this can be changed using the [http://www.meiocodigo.com/projects/meiomask/#mm_options mask options].<br />
<br />
In the final section we apply the masks to the inputs.<br />
<br />
This example has 4 inputs with masks on them - all instances of the following must be replaced to be compatible with your survey (See image below):<br />
<br />
*11111 -> Survey ID<br />
*22 -> Group ID<br />
*AA -> First question<br />
*BB -> Second question<br />
*CC -> Third question<br />
*DD -> Fourth question<br />
<br />
[[File:Ids 343x252.gif]]<br />
<br />
=Text input masks - second method=<br />
<br />
''Tested with: 1.91RC6+, FireFox 4.0''<br />
<br />
There may be instances where you would like to place a mask on a text input - for example only allowing respondents to enter the correct characters for a North American phone number ((###) ###-####) or a US social security number (###-##-####). The jQuery meioMask plugin by fabiomcosta is no longer supported but an alternative exists. The DigitalBush Masked Input Plugin is updated and simple to implement in LimeSurvey. See [http://digitalbush.com/projects/masked-input-plugin/ http://digitalbush.com/projects/masked-input-plugin/] for more details on features and options.<br />
<br />
Implementation as follows:<br />
<br />
#Visit [http://digitalbush.com/projects/masked-input-plugin/ http://digitalbush.com/projects/masked-input-plugin/], download the latest plugin script and save it as jquery.maskedinput.js in the template folder.<br />
#Link to the script by placing <script type="text/javascript" src="{TEMPLATEURL}jquery.maskedinput.js" charset="utf-8"></script> within the <head> tag of startpage.pstpl.<br />
#Turn off $filterxsshtml to allow insertion of JavaScript in the questions. ([http://docs.limesurvey.org/tiki-index.php?page=Optional+settings&structure=English+Instructions+for+LimeSurvey#Filtering_dangerous_HTML_tags_in_survey_objects See documentation here])<br />
#Create the text input questions that the masks are to be applied to<br />
#In the source of the help section of the first question of the group that contains the masked inputs, add the following code. ([http://docs.limesurvey.org/tiki-index.php?page=Workarounds&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._ See How to use script here]) <br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function($) { <br />
$("#answer55431X1X5").mask("999-99-9999",{ placeholder:"#" });<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
<br />
Replace the "#answer55431X1X5" with your survey ID, group ID, and question ID. You can change the mask format and change or eliminate the placeholder if you wish. If you have multiple questions in the same group, simply copy and paste the line that begins with "$" and change the code to what is needed for your application.<br />
<br />
=Select a random response to a "Multiple options" question for later use=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
This workaround allows you to randomly select one of the checked boxes in a "Multiple options" question and store it's label for later use in the survey. A possible use would be to have a question asking what products were purchased and then randomly selecting one of the products to ask further questions about.<br />
<br />
There is a small demo of the above example [http://www.partnersinc.biz/surveys//index.php?sid=81252&newtest=Y&lang=en here].<br />
<br />
Basically what we've done here is to put listeners on all of the checkboxes. If a change of state is detected in any of them the "randomResponse" function is called which loops through all of the checkboxes and if it finds a checked state, that box's label is added to an array. Then a random item is pulled from the array and used to populate the hidden question. This hidden question can then be drawn upon later in the survey using [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+Question#Information_from_previous_answers INSERTANS] or [http://docs.limesurvey.org/tiki-index.php?page=Setting+conditions&structure=English+Instructions+for+LimeSurvey Conditions].<br />
<br />
Implementation for this demo is as follows:<br />
<br />
#[http://docs.limesurvey.org/tiki-index.php?page=Workarounds%3A+Manipulating+a+survey+at+runtime+using+Javascript&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._in_LimeSurvey_ Set up your survey to use JavaScript].<br />
#Create a "Multiple options" question that we're going to randomly pick a checked box from<br />
#Create a text input question to store the label of the checked box in (we're going to hide this with JavaScript)<br />
#Place the script below in the source of one of the questions on the page. <br />
<br />
The following edits are required to implement this in your survey:<br />
<br />
*EDIT HERE (1) - 11111 -> Survey ID, 22 -> Group ID, 44 -> hidden question ID.<br />
*EDIT HERE (2) - 44 -> hidden question ID.<br />
*EDIT HERE (3) - 11111 -> Survey ID, 22 -> Group ID, 33 -> multiple option question ID, A/B/C/D/E/F -> multiple option answer codes. Also add or remove CBs for more or less checkboxes.<br />
*EDIT HERE (4) - add or remove CBs for more or less checkboxes.<br />
*EDIT HERE (5) - add or remove CBs for more or less checkboxes. <br />
<br />
For more info on these IDs see [http://docs.limesurvey.org/tiki-index.php?page=SGQA+identifier&structure=English+Instructions+for+LimeSurvey SGQA identifier].<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
//// Identify the hidden question input<br />
//// EDIT HERE (1) - replace with your hidden question input ID<br />
var hiddenInput = '#answer11111X22X44';<br />
<br />
//// Make the "hidden" question disappear<br />
//// EDIT HERE (2) - replace with your hidden question ID<br />
$('#question44').hide();<br />
<br />
//// Identify the checkboxes to be randomized<br />
//// EDIT HERE (3) - add or remove as required, <br />
//// replace with your checkbox IDs<br />
var CB1 = '#answer11111X22X33A';<br />
var CB2 = '#answer11111X22X33B';<br />
var CB3 = '#answer11111X22X33C';<br />
var CB4 = '#answer11111X22X33D';<br />
var CB5 = '#answer11111X22X33E';<br />
var CB6 = '#answer11111X22X33F';<br />
<br />
//// Create an array of all checkboxes to be randomized<br />
//// EDIT HERE (4) - add or remove CBs as required<br />
checkBoxes = new Array( CB1, CB2, CB3, CB4, CB5, CB6 );<br />
var checkBoxesLength = checkBoxes.length;<br />
<br />
//// The randomizing function - no editing required<br />
function randomResponse () {<br />
var boxLabels = new Array();<br />
<br />
// loop through all of the checkboxes and if they are checked, <br />
// add their label to the boxLabels array<br />
for( var i=0; i<checkBoxesLength; i++ ) {<br />
if ( $(checkBoxes[i]).attr('checked') == true ) {<br />
var cbid = checkBoxes[i].replace('#','');<br />
boxLabels.push( $( 'label[for=' + cbid + ']' ).html() );<br />
}<br />
}<br />
<br />
// find a random index of the responses array<br />
var randomNum = Math.floor(Math.random() * boxLabels.length); <br />
<br />
// populate the hidden question input with the <br />
// random input value<br />
$(hiddenInput).val( boxLabels[randomNum] ); <br />
}<br />
<br />
//// The listeners that will fire the randomize function if a <br />
//// change occurs in the checkboxes<br />
//// EDIT HERE (5) - add or remove CBs as required<br />
$(CB1).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB2).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB3).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB4).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB5).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB6).change(function() {<br />
randomResponse ();<br />
}); <br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
=Display secondary options in a "Multiple options" question=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows you to display secondary options in a "Multiple options" question if a primary option is checked as in the images below.<br />
<br />
Primary option not selected:<br /><br />
[[File:Secondary_options_1.jpg]]<br />
<br />
<br />
Primary option selected:<br /><br />
[[File:Secondary_options_2.jpg]]<br />
<br />
<br />
There is a small demo of the above example [http://www.partnersinc.biz/surveys//index.php?sid=11491&newtest=Y&lang=en here].<br />
<br />
We've put a listener on the primary answer ("Option 1" in the demo) that shows or hides the secondary answers depending on the state of the primary.<br />
<br />
Implementation for this demo is as follows:<br />
<br />
#[http://docs.limesurvey.org/tiki-index.php?page=Workarounds%3A+Manipulating+a+survey+at+runtime+using+Javascript&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._in_LimeSurvey_ Set up your survey to use JavaScript].<br />
#Create a "Multiple options" question including both the primary and secondary answers (in the order that you would like them displayed if all shown)<br />
#Add the following script to the source of the question.<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
/**** <br />
The following code puts a listener on an answer in a multiple options<br />
question (the primary answer) and if that answer is checked, a secondary <br />
level of answers is displayed.<br />
****/<br />
<br />
// --- 1 --- Indent the secondary answers a bit<br />
$( '#questionQQ li:eq(1)' ).css({ 'margin-left':'2.5em' });<br />
$( '#questionQQ li:eq(2)' ).css({ 'margin-left':'2.5em' });<br />
<br />
// --- 2 --- When the page loads, see if the primary answer is checked and if not, <br />
//hide and un-check all secondary answers<br />
if ($( '#answerSSSSSXGGXQQAA' ).attr('checked') == false ) {<br />
<br />
$( '#questionQQ li:eq(1)' ).hide();<br />
$( '#questionQQ li:eq(2)' ).hide();<br />
<br />
$( '#answerSSSSSXGGXQQBB' ).attr('checked', false);<br />
$( '#answerSSSSSXGGXQQCC' ).attr('checked', false);<br />
}<br />
<br />
// --- 3 --- Now put a listener on the primary answer to show or hide secondary answers <br />
// We need to use .click instead of .change cause IE won't cooperate<br />
$('#answerSSSSSXGGXQQAA').click(function (event) {<br />
<br />
// Have a look at the primary answer and hide/show the secondary answers accordingly<br />
if ($( '#answerSSSSSXGGXQQAA' ).attr('checked') == false ) {<br />
<br />
$( '#questionQQ li:eq(1)' ).hide();<br />
$( '#questionQQ li:eq(2)' ).hide();<br />
<br />
$( '#answerSSSSSXGGXQQBB' ).attr('checked', false);<br />
$( '#answerSSSSSXGGXQQCC' ).attr('checked', false);<br />
}<br />
else {<br />
<br />
$( '#questionQQ li:eq(1)' ).show();<br />
$( '#questionQQ li:eq(2)' ).show();<br />
} <br />
<br />
// The original functions of the click event<br />
cancelBubbleThis(event);<br />
checkconditions(this.value, this.name, this.type);<br />
}<br />
);<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
<br />
The following edits are required to implement this in your survey:<br />
<br />
'''Section 1:'''<br />
*This section indents the secondary answers to give the look of a list in a list when they're shown<br />
*'''QQ''' is your question ID<br />
*'''eq(1)''' and '''eq(2)''' are the index positions of your secondary options. Modify or add as necessary for the number and placement of secondary options in your question. Note that the index starts at 0 so '''eq(1)''' actually affects the second option in the full list and '''eq(2)''' affects the third. <br />
<br />
'''Section 2:'''<br />
*This section checks the state of the primary question when the page is loaded and if necessary hides the secondary questions. We need this in case users navigate away from and then back to the page.<br />
*Modify '''eq(1)''' and '''eq(2)''' as above.<br />
*'''SSSSS''' is your survey ID.<br />
*'''GG''' is your group ID.<br />
*'''QQ''' is your question ID.<br />
*'''AA''' is your primary answer code.<br />
*'''BB''' and '''CC''' are your secondary answer codes (add as necessary). <br />
<br />
'''Section 3:'''<br />
*This is the section that "listens" to the primary answer and reacts accordingly.<br />
*Edit as in section 2.<br />
<br />
For more info on these IDs see SGQA identifier(external link).<br />
<br />
This code could be tidied up and shortened a bit but I left it this way to make it easier to follow.<br />
<br />
=Minimum number of required answers in an array (pre 1.92)=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2,''<br />
<br />
<div class="simplebox">As of version 1.92 all array style questions have the min_answers and max_answers options, so this script is obsolete.</div><br />
<br />
This workaround allows you to specify a '''minimum number''' of answers required in an array question. It is an alternative to the "Mandatory" parameter which specifies that '''all''' answers are required. It could also be easily modified to specify a maximum number of answers.<br />
<br />
We accomplish this by placing an onload function in the source of the array question. This function hides the Next/Submit button and displays a warning element until it detects a minimum number of responses. It then hides the warning and shows the Next/Submit button.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=97166&newtest=Y&lang=en here].<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Set up the template to use custom onload functions. (See the [[Workarounds#Custom onload function|workaround here]])<br />
#In the source of the array question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Modify the ''SETTINGS'' section of the code as required.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
// Wait until the document is fully loaded<br />
$(document).ready(function() {<br />
<br />
/********************** SETTINGS **********************/<br />
// The text to appear in the warning element<br />
var warningText = 'Please answer at least 4 to continue';<br />
// The question ID<br />
var questionId = 137;<br />
// The minimum number of answers required<br />
var minNumber = 4;<br />
/******************************************************/<br />
<br />
// Create the warning element and place it after the submit button<br />
var el = document.createElement('div');<br />
el.setAttribute('id','warning');<br />
document.body.appendChild(el);<br />
$( '#warning' ).css({<br />
'border':'1px solid #333333',<br />
'width':'200px',<br />
'padding':'3px',<br />
'color':'red'<br />
});<br />
$('#warning').html(warningText);<br />
$('input[type="submit"]').after($('#warning'));<br />
<br />
// Detect the initial number of checked answers & display Next/Submit button accordingly<br />
var inputInitCount = 0;<br />
$('#question' + questionId + ' input').each(function(i) {<br />
if ($( this ).attr('checked') == true ) {<br />
inputInitCount++;<br />
}<br />
});<br />
if (inputInitCount > (minNumber - 1)) {<br />
$('input[type="submit"]').show();<br />
$('#warning').hide();<br />
}<br />
else {<br />
$('#warning').show();<br />
$('input[type="submit"]').hide();<br />
}<br />
<br />
// Listener to detect number of checked answers & display Next/Submit button accordingly<br />
$('#question' + questionId + ' input.radio, #question'+questionId+' tbody[id<div class="simplebox">="javatbd"] td').click(function() {<br />
var inputCount = 0;<br />
$('#question' + questionId + ' input.radio').each(function(i) {<br />
if ($( this ).attr('checked') == true ) {<br />
inputCount++;<br />
}<br />
});<br />
if (inputCount > (minNumber - 1)) {<br />
$('input[type="submit"]').show();<br />
$('#warning').hide();<br />
}<br />
else {<br />
$('#warning').show();<br />
$('input[type="submit"]').hide();<br />
}<br />
<br />
// The original functions of the click event<br />
checkconditions(this.value, this.name, this.type);<br />
});<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Minimum elapsed time before moving forward in survey=<br />
<br />
''Tested with: 1.91, IE 7/8, Firefox 7.0, Safari 3.2''<br />
<br />
This workaround interrupts the Next/Submit function and checks the amount of time elapsed since the page loaded. If the time is less than the minimum dictated, the respondent is alerted and not allowed to proceed. It is useful if you want to enforce a minimum amount of time spent viewing a page.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the script below in the source of one of the questions on the page, replacing "TT" with the minimum number of seconds required before advancing is allowed.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
minTime(TT);<br />
<br />
function minTime(minTime) {<br />
<br />
var startTime = new Date();<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
var endTime = new Date();<br />
<br />
if((endTime - startTime)/1000 <= minTime) {<br />
alert ('You must spend at least '+minTime+' seconds on the question.');<br />
return false;<br />
}<br />
else {<br />
return true;<br />
}<br />
});<br />
}<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
=Minimum number of characters in Long free text or Huge free text questions=<br />
<br />
''Tested with: 1.91, IE 7/8, Firefox 7.0, Safari 3.2''<br />
<br />
<div class="simplebox">As of version 1.91, you can use regular expression masks (validation) to specify the minimum number of required characters. However, even if the question is mandatory, it can still be blank.</div><br />
<br />
<div class="simplebox">As of version 1.92, if you make the question mandatory and use a validation mask to specify the minimum number of characters, then the user will be forced to answer the question. Note that unlike 1.91, they can submit their current answers, even if partially invalid (so they are stored in the database), but they will not ber able to proceed to the next page until they have passed all mandatory and validity checks.</div><br />
<br />
This workaround interrupts the Next/Submit function and checks the number of characters entered in a Long free text or Huge free text question. If the number is less than the minimum dictated, the respondent is alerted and not allowed to proceed.<br />
<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
<br />
#Place the script below in the source of one of the questions on the page, replace "QQ" with the question ID and "CC" with the minimum number of characters required before advancing is allowed.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
minChar(QQ, CC);<br />
<br />
function minChar(qID, minChars) {<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
if($('#question'+qID+' textarea').val().replace(/ /g,'').length < minChars) {<br />
<br />
alert ('You must enter at least '+minChars+' characters.');<br />
<br />
return false;<br />
<br />
}<br />
<br />
else {<br />
<br />
return true;<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Variable Length Array (Multi Flexible Text) question=<br />
<br />
''Tested with: 1.90+, IE 6/7/8, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows a respondent to add or remove rows of an Array (Multi Flexible Text) question. It's useful to avoid the page being cluttered with unnecessary array rows.<br />
<br />
A function is placed in the template.js file of your template (use template editor). This function hides all of the array rows except the first and inserts two elements that when clicked show or hide rows accordingly.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=53132&newtest=Y&lang=en here].<br />
<br />
It must be noted that you can not make this question Mandatory as the respondent will have no way to complete hidden fields. If you want the displayed fields to be mandatory you will need to validate them in another function or modify this function to only allow the addition of rows if all fields in the last row are completed and then disable those fields - that, however, is a little over the top for this example.<br />
<br />
Implementation is as follows:<br />
<br />
#Set up your survey to use JavaScript (See instructions [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|here]])<br />
<br />
#Add the following script to your ''template.js'' file.<br />
<br />
#Replace "QQ" in the function call at the end with the question ID.<br />
<br />
#Create one or more Array (Multi Flexible Text) questions<br />
<br />
#If you want to apply it to more arrays on the same page simply add more calls with the appropriate question IDs. (eg. varLengthArray(1); varLengthArray(2);...)<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div">$(document).ready(function() {<br />
<br />
// A function to add or remove rows of an Array (Multi Flexible)(Text) question<br />
function varLengthArray(qID) {<br />
<br />
if ($('#question'+qID+'').length > 0) {<br />
<br />
// The HTML content of the Add/Remove elements - modify as you wish<br />
var addContent = '[+]';<br />
var removeContent = '[-]';<br />
<br />
// Create the Add and Remove elements & insert them<br />
var el1 = document.createElement('div');<br />
el1.setAttribute('id','addButton'+qID);<br />
document.body.appendChild(el1);<br />
var el2 = document.createElement('div');<br />
el2.setAttribute('id','removeButton'+qID);<br />
document.body.appendChild(el2);<br />
<br />
// Move them to after the array<br />
$( 'div#addButton'+qID ).appendTo($( '#question' + qID + ' table.question' ).parent());<br />
$( 'div#removeButton'+qID ).appendTo($( '#question' + qID + ' table.question' ).parent());<br />
<br />
// Insert their HTML<br />
$( 'div#addButton'+qID ).html( addContent );<br />
$( 'div#removeButton'+qID ).html( removeContent );<br />
<br />
// Style the elements - you can modify here if you wish<br />
$( 'div#addButton'+qID ).css({<br />
'margin':'10px 0 0 10px',<br />
'padding':'1px',<br />
'text-align':'center',<br />
'font-weight':'bold',<br />
'width':'auto',<br />
'cursor':'pointer',<br />
'float':'left'<br />
});<br />
<br />
$( 'div#removeButton'+qID ).css({<br />
'margin':'10px 0 0 10px',<br />
'padding':'1px',<br />
'text-align':'center',<br />
'font-weight':'bold',<br />
'width':'auto',<br />
'cursor':'pointer',<br />
'float':'left'<br />
});<br />
<br />
// Initially hide the Remove element<br />
$( 'div#removeButton'+qID ).hide();<br />
<br />
// Call the functions below when clicked<br />
$( 'div#addButton'+qID ).click(function (event) {<br />
addRow(qID);<br />
});<br />
$( 'div#removeButton'+qID ).click(function (event) {<br />
removeRow(qID);<br />
});<br />
<br />
// Function to add a row, also shows the Remove element and hides the<br />
//Add element if all rows are shown<br />
function addRow(qID) {<br />
var arrayRow = '#question' + qID + ' table.question tbody';<br />
var rowCount = $( arrayRow ).size() - 1;<br />
$( arrayRow + '[name="hidden"]:first' ).attr('name', 'visible').show();<br />
$( 'div#removeButton'+qID ).show();<br />
if ( $( arrayRow + ':eq(' + rowCount + ')' ).attr('name') == 'visible' ) {<br />
$( 'div#addButton'+qID ).hide();<br />
}<br />
}<br />
<br />
// Function to remove a row, also clears the contents of the removed row,<br />
// shows the Add element if the last row is hidden and hides the Remove<br />
// element if only the first row is shown<br />
function removeRow(qID) {<br />
var arrayRow = '#question' + qID + ' table.question tbody';<br />
var rowCount = $( arrayRow ).size() - 1;<br />
$( arrayRow + '[name="visible"]:last input[type="text"]' ).val('');<br />
$( arrayRow + '[name="visible"]:last' ).attr('name', 'hidden').hide();<br />
$( 'div#addButton'+qID ).show();<br />
if ( $( arrayRow + ':eq(1)' ).attr('name') == 'hidden' ) {<br />
$( 'div#removeButton'+qID ).hide();<br />
}<br />
}<br />
<br />
// Just some initialization stuff<br />
var arrayRow = '#question' + qID + ' table.question tbody';<br />
var rowCount = '';<br />
<br />
// Initially hide all except first row or any rows with populated inputs<br />
$( arrayRow ).each(function(i) {<br />
if ( i > 0 ) {<br />
// We also need to give the hidden rows a name cause IE doesn't<br />
// recognize jQuery :visible selector consistently<br />
$( this ).attr('name', 'hidden').hide();<br />
<br />
$('input[type=text]', this).each(function(i) {<br />
if ($(this).attr('value') != '') {<br />
$(this).parents('tbody:eq(0)').attr('name', 'visible').show();<br />
$( 'div#removeButton'+qID ).show();<br />
}<br />
});<br />
rowCount = i;<br />
}<br />
});<br />
}<br />
}<br />
<br />
// Call the function with a question ID<br />
varLengthArray(QQ);<br />
<br />
});</syntaxhighlight><br />
<br />
=Expandable Array=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.5, Safari 3.2''<br />
<br />
This workaround allows you to present an array question incrementally. That is to say that initially only the first option (row) in the array is shown. When that option is answered the next is shown and so-on.<br />
<br />
A JavaScript function is placed in the source of the array question. This function hides all of the array rows except the first and then displays them as options are answered.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=94958&newtest=Y&lang=en here].<br />
<br />
The workaround supports following question types:<br />
*Array (flexible labels)<br />
*Array (flexible labels) by column<br />
*Array (Yes/No/Uncertain)<br />
*Array (Increase, Same, Decrease)<br />
*Array (Flexible Labels) dual scale<br />
*Array (10 point choice)<br />
<br />
Implementation is as follows:<br />
#Set up your survey to use JavaScript. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|documentation here]])<br />
#Create one or more Array questions<br />
#In the source of the first array question add the following script.<br />
#Replace "QQ" in the function call at the end of the script with the question ID of the array you would like to manipulate.<br />
#If you want to apply it to more arrays on the same page, simply add more calls with the appropriate question IDs. (eg. expandingArray(1); expandingArray(2);...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
// A function to show subsequent rows of an array as options are checked<br />
function expandingArray(qID) {<br />
<br />
// Build an array of the question rows<br />
var arrayRow = '#question' + qID + ' table.question tbody tr';<br />
<br />
// Initially hide all rows unless an input was previously checked<br />
$( arrayRow ).each(function(i) {<br />
<br />
if ( $( arrayRow + ':eq(' + i + ') input.radio:checked' ).length != 0 ) {<br />
$(this).attr('name', 'clickedRow');<br />
}<br />
else {<br />
$(this).attr('name', 'hidden').hide();<br />
}<br />
});<br />
<br />
// Now show the first hidden row<br />
addRow();<br />
<br />
// Add another row when an option is checked for the first time<br />
$( '#question' + qID + ' td.answer input.radio' ).click(function (event) {<br />
<br />
if ($(this).parents('tr:eq(0)').attr('name') != 'clickedRow') {<br />
addRow();<br />
$(this).parents('tr:eq(0)').attr('name', 'clickedRow');<br />
}<br />
<br />
// The original function of the click event<br />
checkconditions(this.value, this.name, this.type);<br />
});<br />
<br />
// Add another row when an table cell is clicked for the first time<br />
$( '#question' + qID + ' table.question tbody td' ).click(function (event) {<br />
<br />
if ($(this).parents('tr:eq(0)').attr('name') != 'clickedRow') {<br />
addRow();<br />
$(this).parents('tr:eq(0)').attr('name', 'clickedRow');<br />
}<br />
});<br />
<br />
// Function to add a row<br />
function addRow() {<br />
$( arrayRow + '[name="hidden"]:first' ).attr('name', 'visible').show();<br />
}<br />
}<br />
<br />
// Call the function with a question ID<br />
expandingArray(QQ);<br />
<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - Multiple Options & List (radio) questions - ENHANCED=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows the answers of Multiple Options & List (radio) questions to be randomized while always keeping as many answers at the end of the list as specified by the var insertitems=n, where n is the number of answers you want left unrandomized. It's useful if you want to randomize, say, the first 4 of your answers but always have the 5th to 7th displayed last as in the image below (assuming you assigned the number 3 to insertitems):<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
Some conditions on the use of this are:<br />
*For Select/radio type questions it will only work if the [[Optional settings#Survey Behavior|$shownoanswer option]] is set to 0 in config.php. ("No answer" is removed from the end of questions)<br />
*You must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more Multiple Options or List (radio) questions with sequential response codes. Set the [[Advanced question settings#random order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Set var insertitems=n (n = the number of items you want un-randomized)<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRand(11111, 22, 1); partRand(11111, 22, 2); ...)<br />
<br />
Onload code:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers except the last one in Multiple options and List/radio questions<br />
<br />
function partRand(sID, gID, qID) {<br />
<br />
//var to define how many lists to be added at the end<br />
<br />
var insertitems=3;<br />
<br />
// Find the number of answers<br />
<br />
var ansCount = ''<br />
<br />
lastitems=new Array();<br />
<br />
var liid=new Array();<br />
<br />
var $ul;<br />
<br />
var j=0;<br />
<br />
$( '#question' + qID + ' td.answer li' ).each(function(i) {<br />
<br />
ansCount = (i + 1);<br />
<br />
});<br />
<br />
$( '#question' + qID + ' td.answer li' ).each(function(i) {<br />
<br />
if(i>ansCount-(insertitems+1)){<br />
<br />
lastitems[j]=$(this).html();<br />
<br />
liid[j]=$(this).attr("id");<br />
<br />
j++;<br />
<br />
$(this).remove();<br />
<br />
}<br />
<br />
});<br />
<br />
$( '#question' + qID + ' td.answer li' ).each(function(i) {<br />
<br />
// get current ul<br />
<br />
$ul = $(this).parent();<br />
<br />
// get array of list items in current ul<br />
<br />
var $liArr = $ul.children('li');<br />
<br />
// sort array of list items in current ul randomly<br />
<br />
$liArr.sort(function(a,b){<br />
<br />
// Get a random number between 0 and 100<br />
<br />
var temp = parseInt( Math.random()*100 );<br />
<br />
// Get 1 or 0, whether temp is odd or even<br />
<br />
var isOddOrEven = temp%2;<br />
<br />
// Get +1 or -1, whether temp greater or smaller than 5<br />
<br />
var isPosOrNeg = temp>5 ? 1 : -1;<br />
<br />
// Return -1, 0, or +1<br />
<br />
return( isOddOrEven*isPosOrNeg );<br />
<br />
})<br />
<br />
// append list items to ul<br />
<br />
.appendTo($ul);<br />
<br />
});<br />
<br />
$.each(lastitems,function(i){<br />
<br />
$( $ul ).append("<li id="+liid[i]+">"+this+"</li>");<br />
<br />
});<br />
<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
<br />
partRand(SSSSS, GG, QQ);<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - Multiple Options & List (radio) questions=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows the answers of Multiple Options & List (radio) questions to be randomized while always keeping one answer at the end of the list. It's useful if you want to randomize, say, the first 4 of your answers but always have the fifth displayed last as in the image below:<br />
<br />
[[File:random_336x179gif.gif]]<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=89344&newtest=Y&lang=en here].<br />
<br />
Some conditions on the use of this are:<br />
*For Select/radio type questions it will only work if the [[Optional settings#Survey Behavior|$shownoanswer option]] is set to 0 in config.php. ("No answer" is removed from the end of questions)<br />
*You must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more Multiple Options or List (radio) questions with sequential response codes. Set the [[Advanced question settings#random_order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRand(11111, 22, 1); partRand(11111, 22, 2); ...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers except the last one in Multiple options and List/radio questions<br />
function partRand(sID, gID, qID) {<br />
<br />
// Find the number of answers<br />
var ansCount = ''<br />
$( 'div#question' + qID + ' td.answer li' ).each(function(i) {<br />
ansCount = (i + 1);<br />
});<br />
<br />
// Place the last answer created at the end of the list<br />
$( 'input#answer' + sID + 'X' + gID + 'X' + qID + ansCount + '' ).parent().appendTo($( '#question' + qID + ' td.answer ul' ));<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
partRand(SSSSS, GG, QQ);<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - List (dropdown) questions=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround, similar to the one above, allows the answers of List (dropdown) questions to be randomized while always keeping one answer at the end of the list. It's useful if you want to randomize, say, the first 4 of your answers but always have the fifth displayed last.<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=89344&newtest=Y&lang=en here].<br />
<br />
A condition is that you must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more List (dropdown) questions with sequential response codes. Set the [[Advanced question settings#random order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRandDD(11111, 22, 1); partRandDD(11111, 22, 2); ...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers<br />
//except the last one in List/dropdown questions<br />
function partRandDD(sID, gID, qID) {<br />
<br />
// Find the number of answers<br />
var ansCount = ''<br />
$( 'div#question' + qID + ' select option' ).each(function(i) {<br />
ansCount = i;<br />
});<br />
<br />
// Place the last answer created at the end of the list<br />
$( 'option[value="' + ansCount + '"]' ).appendTo($( 'div#question' + qID + ' select' ));<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
partRandDD(89344, 72, 244);<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - Multiple numerical input=<br />
<br />
''Tested with: 1.90+, Safari 5.1''<br />
<br />
This workaround, similar to the ones above, allows the answers of Multiple numerical input questions to be randomized while always keeping one answer at the end of the list. It's useful if you want to randomize, say, the first 4 of your answers but always have the fifth displayed last.<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
A condition is that you must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more Multiple numerical input question with sequential response codes. Set the [[Advanced question settings#random order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRandDD(11111, 22, 1); partRandDD(11111, 22, 2); ...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers except the last one in multiple numeric input questions<br />
function partRand(sID, gID, qID) {<br />
<br />
// Find the number of answers<br />
var ansCount = ''<br />
$( 'div#question' + qID + ' div.answers li' ).each(function(i) {<br />
ansCount = (i - 1);<br />
});<br />
<br />
// Place the last answer created at the end of the list - but before the first helping sum<br />
$( 'li#javatbd' + sID + 'X' + gID + 'X' + qID + ansCount + '' ).insertBefore($( 'div#question' + qID + ' div.answers li.multiplenumerichelp' ).first());<br />
<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
partRand(SID, GID, QID);<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
Using this solution for Multiple numerical input questions might be a bit more complicated than for other question types. All answers are organized in an unordered list (<nowiki><ul></nowiki>) structure. However, if advanced question settings like ''Equals sum value'' are used, LimeSurvey adds helping information (e.g. sum of all entries and remainder) to the same unordered list using the class ''multiplenumerichelp'' for these additional list items. The above example assumes that at least one of these list items is present and moves the last answer to the position right above the first helper item. Without such advanced settings, the code will most certainly need adaptation.<br />
<br />
=Making one (or more) rows of an array mandatory=<br />
<br />
''Tested with: 1.90+, IE 6/7, Firefox 3.0, Safari 3.2''<br />
<br />
This workaround allows you to define one or more rows of an array question as mandatory (instead of all of them which the "Mandatory" question setting does). It is [http://www.partnersinc.biz/surveys//index.php?sid=26842&newtest=Y&lang=en demonstrated here].<br />
<br />
A JavaScript function interrupts the submit function and checks if the inputs in the mandatory row(s) are populated. If not, an alert is popped up, the offending inputs are turned pink and the submit is aborted. Otherwise the submit goes ahead.<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions (see [[Optional settings#Security|documentation here]]).<br />
#Create the array question.<br />
#In the source of the array question add the following script (see [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]]).<br />
#Modify the warningText (line10)as required.<br />
#Replace "QQ" (lines 13 and 14) with the question ID and add calls as necessary for more rows - the example code renders rows 1 and 3 mandatory.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function () {<br />
<br />
// Interrupt the submit function<br />
$('form#limesurvey').submit(function () {<br />
<br />
// Override the built-in "disable navigation buttons" feature<br />
$('#moveprevbtn, #movenextbtn, #movesubmitbtn').attr('disabled', '');<br />
<br />
var empty = 0;<br />
var warningText = 'Please complete the highlighted inputs.';<br />
<br />
// Call the mandatory row function with question IDs and row numbers<br />
mandatoryRow(QQ, 1);<br />
mandatoryRow(QQ, 3);<br />
<br />
// A function to render rows of an array mandatory<br />
function mandatoryRow(qID, rowNum) {<br />
<br />
$('div#question' + qID + ' table.question tbody[id</div>="javatbd"]:eq(' + Number(rowNum - 1) + ') input[type="text"]').each(function (i) {<br />
<br />
if ($(this).val() == '') {<br />
$(this).css('background-color', 'pink');<br />
empty = 1;<br />
} <br />
else {<br />
$(this).css('background-color', '#FFFFFF');<br />
}<br />
});<br />
}<br />
<br />
if (empty == 1) {<br />
alert(warningText);<br />
return false;<br />
} <br />
else {<br />
return true;<br />
}<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Randomly displaying one of a few YouTube videos, and recording which was displayed=<br />
<br />
''Tested in 1.85+''<br />
<br />
Jason Cleeland has created and documented a method to randomly display one of a number of youtube videos in a single question, and save which one was displayed.<br />
<br />
http://www.aptigence.com.au/home/archives/23-Random-display-of-videos-in-a-question-2-YouTube.html<br />
<br />
=Randomly displaying one of a few pictures, and recording which was displayed=<br />
<br />
''Tested in 1.91+''<br />
<br />
The following steps allow you to randomly display one of a few pictures and record in the dataset which picture was displayed. We use four pictures in this example, but you can easily adapt these scripts according to your needs.<br />
<br />
1. Create a new sub-directory '''pic''' in your LimeSurvey folder.<br />
<br />
2. Copy four pictures (named ''1.jpg'', ''2.jpg'', ''3.jpg'', and ''4.jpg'') in this pic sub-directory.<br />
<br />
3. Deactivate the ''Filter HTML for XSS'' function in LimeSurvey's ''Global Settings''.<br />
<br />
4. Create a '''Short free text''' question where you want these pictures to be displayed.<br />
<br />
5. Figure out the [[SGQA identifier|SGQA Identifier]] of this question (e.g., 12345X67X89).<br />
<br />
6. Paste the following code as question text after activating the editor's ''Source'' view and replace both SSSSSXGGXQQ strings with your SGQA identifier:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
Please have a look at this picture:<br />
<br />
<br /><br />
<br />
<script><br />
<br />
$(document).ready(<br />
<br />
function(){<br />
<br />
// Find a random number (here between 1 and 4)<br />
<br />
var randNumber = Math.floor(Math.random()*4 + 1);<br />
<br />
// Save the number as answer of this question<br />
<br />
$('input#answerSSSSSXGGXQQ').val(randNumber);<br />
<br />
// Hide this answer field<br />
<br />
document.getElementById("answerSSSSSXGGXQQ").style.display='none';<br />
<br />
// Show the picture<br />
<br />
picString = '<img src="pic/' + String(randNumber) + '.jpg">';<br />
<br />
document.getElementById('pic').innerHTML = picString;<br />
<br />
}<br />
<br />
);</script><br />
<br />
<p><br />
<br />
</p><br />
<br />
<div id="pic"><br />
<br />
</div><br />
<br />
</syntaxhighlight><br />
<br />
If you want to display the number of this picture in a later question, use the following code as question text (don't forget to replace the SSSSSXGGXQQ string acordingly):<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
You saw picture number {INSERTANS:SSSSSXGGXQQ}.<br />
<br />
</syntaxhighlight><br />
<br />
Perhaps you want to display the same picture again in a later question, but a little bit smaller (100px width, 100px height)? Just paste the following code as question text after activating the editor's ''Source'' view, and replace the SSSSSXGGXQQ string acordingly:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
Here you see the picture again: <br><br />
<br />
<script><br />
<br />
$(document).ready(<br />
<br />
function(){<br />
<br />
// Get the picture number from previous question<br />
<br />
var randNumber = "{INSERTANS:SSSSSXGGXQQ}";<br />
<br />
// Show picture<br />
<br />
picString = '<img width="100" height="100" src="pic/' + String(randNumber) + '.jpg">';<br />
<br />
document.getElementById('pic').innerHTML = picString;<br />
<br />
}<br />
<br />
);</script><br />
<br />
<div id="pic"><br />
<br />
</div><br />
<br />
</syntaxhighlight><br />
<br />
=Multiple numerical input with max_num_value defined in token (personalized limit)=<br />
<br />
''Tested in 1.85+''<br />
<br />
<div class="simplebox">As of version 1.92, max_num_value can be an experession, so you can simply enter the {TOKEN} or other variable in that question attribute.</div><br />
<br />
To make personalized survey with multiple numerical input when max_num_value (Maximum sum value) is different for each user and is loaded from the token use following tricks:<br />
*Create 1st group with numerical input field (1000X10X11). "Limit"<br />
*Add java script into this question:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
function Custom_On_Load(){<br />
<br />
document.getElementById('answer1000X10X11').value='{TOKEN:ATTRIBUTE_1}';<br />
<br />
document.getElementById('answer1000X10X11').readOnly=1;<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
where:<br />
<br />
TOKEN:ATTRIBUTE_1 is individual limit defined in token.<br />
<br />
readOnly=1 // user shouldn't change it.<br />
*Create 2nd group with multiple numerical input and add "Max value from SGQA" with 1000X10X11 as argument.<br />
<br />
Note: If you don't want to show first field with numerical input (and show definied limit in different way) you can add 2 lines to above script to hide whole question:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
document.getElementById('question85').style.display='none';<br />
<br />
document.getElementById('display85').value='';<br />
<br />
</syntaxhighlight><br />
<br />
where:<br />
<br />
question85 and display85 are field names.<br />
<br />
Note: It's no possible to create it into one group, because all SGQA references can only refer to data on a previous page because when clicking next the answer is stored at the DB and the SGQA is replaced by querying the database.<br />
<br />
=Default values in array questions=<br />
<br />
''Tested with: 1.87+ (7557), IE 6/7, Firefox 3.5, Safari 3.2''<br />
<br />
<div class="simplebox">As of Version 1.92, many more question types support default values.</div><br />
<br />
This workaround uses JavaScript to allow you to pre-check default answers in all sub-questions of an array type question. You can select a column of the array to be checked as the page loads. The script first checks to see if a sub-question has already been answered and, if not, checks the default answer.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use script]].<br />
#Create the array question.<br />
#In the source of the array question add the following script.<br />
#Replace"QQ" with the question ID and "CC" with the column number to be checked.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// A function to pre-check a column of an array<br />
<br />
function checkedDefault(qID, column) {<br />
<br />
var checkedCol = column - 1;<br />
<br />
$('#question' + qID + ' table.question tbody tr').each(function(i) {<br />
<br />
if ($('input.radio[checked=true]', this).length == 0) {<br />
<br />
$('input.radio:eq(' + checkedCol + ')', this).attr('checked', true);<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
// Call the function with a question ID and column number<br />
<br />
checkedDefault(QQ, CC);<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Record group view time=<br />
<br />
''Tested with: 1.87+ (8518), IE 6/7, Firefox 3.5, Safari 3.2''<br />
<br />
<div class="simplebox">As of version 1.92, group view time is accurately recorded in the timings table if you choose the Record Timings survey option.</div><br />
<br />
This workaround uses JavaScript to populate a hidden question with the total time that a respondent views a group. If used in a group with only one question, it could be used to track the amount of time required to answer the question.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#In the group, create a short-text question. We will hide this later with JavaScript and populate it with the elapsed time.<br />
#Place the following script in the source of the short-text question.<br />
#Replace "QQ" in line 6 with the ID of the short-text question.<br />
<br />
The script populates the hidden question with the elapsed time since the group was opened. If a respondent leaves the group and then returns, the timer continues up from the elapsed time of the last visit.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function(){<br />
<br />
// call the functions with the hidden timer question ID<br />
<br />
runTimer(QQ);<br />
<br />
function runTimer(timeQID) {<br />
<br />
$('#question'+timeQID).hide();<br />
<br />
var initSec = '0';<br />
<br />
// Check for elapsed time from previous visits<br />
<br />
if ($('#question'+timeQID+' input.text').val()) {<br />
<br />
var initTime = $('#question'+timeQID+' input.text').val();<br />
<br />
initTimeArr = initTime.split(':');<br />
<br />
initSec = Number[[initTimeArr[0]*3600]]+Number[[initTimeArr[1]*60]]+Number(initTimeArr[2]);<br />
<br />
}<br />
<br />
// Run the timer update function<br />
<br />
recordTime(initSec, timeQID);<br />
<br />
}<br />
<br />
});<br />
<br />
// Timer update function<br />
<br />
function recordTime(elapsedSec, timeQID){<br />
<br />
elapsedSec++;<br />
<br />
var h = Math.floor(elapsedSec / 3600);<br />
<br />
var m = Math.floor(elapsedSec % 3600 / 60);<br />
<br />
var s = Math.floor(elapsedSec % 3600 % 60);<br />
<br />
var elapsedTime = [[h > 0 ? h + ":" : "00:") + (m > 0 ? (m < 10 ? "0" : "") + m + ":" : "00:") + (s < 10 ? "0" : "") + s);<br />
<br />
$('#question'+timeQID+' input.text').val(elapsedTime);<br />
<br />
// Run the timer update function every second<br />
<br />
setTimeout('recordTime('+elapsedSec+', '+timeQID+')',1000);<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Toggle visibility of groups=<br />
<br />
''Tested with: 1.90+, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
This workaround uses JavaScript to toggle the visibility of groups in an "all in one" survey. Initially the groups are hidden and there are links inserted to display the groups. It's useful to avoid the page being cluttered with many groups and lets the respondent focus on one at a time.<br />
<br />
It's [http://www.partnersinc.biz/surveys//index.php?sid=33613&newtest=Y&lang=en demonstrated here].<br />
<br />
Implementation is as follows:<br />
<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Set the survey to run in "all in one" mode.<br />
#Add your groups and questions.<br />
#Place the following script in the source of one of the questions in the first group.<br />
<br />
<br />
The comments in the script are pretty self-explanatory but it does the following:<br />
<br />
#initially hides all of the groups<br />
#inserts a link above each one to toggle its display<br />
#some styles are added to the clickable links but these could be done in template.css instead<br />
#shows any groups that have an unanswered mandatory after a submit attempt<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function(){<br />
<br />
// Insert show/hide divs before all group wrapper divs<br />
$('<div class="groupToggler"><span></span></div>').insertBefore('div[id^="group-"]');<br />
<br />
// Add some text to the show/hide divs<br />
$('.groupToggler span').each(function(i) {<br />
($( this ).text('Show/Hide Group '+(i+1)+''));<br />
});<br />
<br />
// Add some styles to the show/hide divs<br />
$('.groupToggler').css({<br />
'padding':'5px 0 10px 0',<br />
'text-align':'center'<br />
});<br />
$('.groupToggler span').css({<br />
'text-decoration':'underline', <br />
'cursor':'pointer'<br />
});<br />
<br />
// Add some hover effects to the show/hide divs<br />
$(".groupToggler span").hover(<br />
function () {<br />
$(this).css({<br />
'text-decoration':'none',<br />
'font-weight':'bold'<br />
});<br />
}, <br />
function () {<br />
$(this).css({<br />
'text-decoration':'underline',<br />
'font-weight':'normal'<br />
});<br />
}<br />
);<br />
<br />
// Initially hide all of the groups<br />
// Toggle their visibility when the show/hide is clicked<br />
$('.groupToggler span').click(function() {<br />
$(this).parent().next().toggle();<br />
return false;<br />
}).parent().next().hide();<br />
<br />
// Display any groups that have unanswered mandatories<br />
$('.errormandatory').parents('div[id^="group-"]').show();<br />
<br />
// Some tidying up<br />
$('h1').next().next().hide();<br />
$('.surveywelcome').css({'margin-bottom':'10px'});<br />
$('.surveywelcome').next().hide();<br />
$('.surveywelcome').next().next().hide();<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Use jQuery Autocomplete plugin to suggest answers for text inputs=<br />
<br />
== 1.90 and previous versions==<br />
<br />
''Tested with: 1.90+, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
This workaround uses the [http://docs.jquery.com/Plugins/Autocomplete jQuery Autocomplete] plugin to provide a respondent a list of suggested answers that the they can select from as they type in a text input.<br />
<br />
Although the plugin allows for much more complex applications, the two that I use most frequently are outlined below. The first method uses a relatively small list of suggestions that is stored in an array locally. The second is a little more complex - it uses a remote CSV file of suggestions that is accessed through AJAX an PHP.<br />
<br />
I've put together a small demonstration [http://www.partnersinc.biz/surveys//index.php?sid=78611&newtest=Y&lang=en here] and implementation is as follows.<br />
<br />
'''Both methods:'''<br />
*[http://docs.jquery.com/Plugins/Autocomplete Download the plugin]<br />
*Place the files ''jquery.autocomplete.css'' and ''jquery.autocomplete.js'' in your template directory<br />
*Add the following code inside the <head> element of startpage.pstpl<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}jquery.autocomplete.js"></script><br />
<link rel="stylesheet" type="text/css" href="{TEMPLATEURL}jquery.autocomplete.css" /></syntaxhighlight><br />
<br />
'''Method 1 ("States" question in the demo):'''<br />
*Create a text input question<br />
*Add the following script to the source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace the states with your list of suggestions (comma separated)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var q1ID = QQ;<br />
<br />
var states = "Alabama,Alaska,Arizona,Arkansas,California,Colorado,Connecticut,Delaware, District of Columbia,Florida,Georgia,Hawaii,Idaho,Illinois,Indiana,Iowa,Kansas,Kentucky, Louisiana,Maine,Montana,Nebraska,Nevada,New Hampshire,New Jersey,New Mexico,New York, North Carolina,North Dakota,Ohio,Oklahoma,Oregon,Maryland,Massachusetts,Michigan, Minnesota,Mississippi,Missouri,Pennsylvania,Rhode Island,South Carolina,South Dakota, Tennessee,Texas,Utah,Vermont,Virginia,Washington,West Virginia,Wisconsin,Wyoming".split(',');<br />
<br />
$('#question'+q1ID+' input.text').autocomplete(states, {<br />
matchContains: true,<br />
minChars: 0<br />
});<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Method 2 ("Countries" question in the demo):'''<br />
*Place the CSV file of suggestions in your template directory. <br />
*Place a PHP file containing the code below in your template directory<br />
*Replace "countries2.csv" with your CSV filename (you could make this more universal by passing the filename in the URL)<br />
*This file will grab the contents of the CSV and encode them in JSON format that the JavaScript can use<br />
*Place the JavaScript code below in ths source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace "templates/yourTemplate/countries.php" with the path to the PHP file (from LimeSurvey root)<br />
*This script will grab the jsonized data from the PHP file and load it into an array that the plugin can use<br />
<br />
PHP code:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><?php<br />
<br />
$countriesArr = array();<br />
<br />
$file_handle = fopen("countries2.csv", "r");<br />
<br />
while (!feof($file_handle) ) {<br />
$line_of_text = fgetcsv($file_handle);<br />
array_push($countriesArr, $line_of_text[0]);<br />
}<br />
<br />
fclose($file_handle);<br />
<br />
echo json_encode($countriesArr);<br />
<br />
?></syntaxhighlight><br />
<br />
JavaScript code:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var qID = QQ;<br />
var url = "templates/yourTemplate/countries.php";<br />
var countriesArr = new Array();<br />
<br />
$.getJSON(url,function(data){<br />
<br />
$(data).each(function(i, item){<br />
countriesArr.push(item);<br />
});<br />
<br />
$('#question'+qID+' input.text').autocomplete(countriesArr, {<br />
matchContains: true,<br />
minChars: 0<br />
});<br />
});<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
== 1.91 and later versions==<br />
<br />
''Tested with: 1.91+, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
This workaround uses the [http://jqueryui.com/demos/autocomplete/ Autocomplete widget] included with jQuery UI to provide a respondent a list of suggested answers that the they can select from as they type in a text input.<br />
<br />
Although the plugin allows for much more complex applications, the two that I use most frequently are outlined below. The first method uses a relatively small list of suggestions that is stored in an array locally. The second is a little more complex - it uses a remote CSV file of suggestions that is accessed through AJAX an PHP.<br />
<br />
'''Both methods:'''<br />
*Add the following styles to the end of your 'template.css' file<br />
<br />
<syntaxhighlight lang="css" enclose="div">/* Autocomplete styles */<br />
<br />
ul.ui-autocomplete {<br />
width: 250px !important;<br />
padding: 5px 10px;<br />
list-style: none;<br />
}</syntaxhighlight><br />
<br />
'''Method 1 (use local JavaScript array for data):'''<br />
*Create a text input question<br />
*Add the following script to the source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace the states with your list of suggestions (comma separated)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var q1ID = QQ;<br />
<br />
var states = "Alabama,Alaska,Arizona,Arkansas,California,Colorado,Connecticut,Delaware, District of Columbia,Florida,Georgia,Hawaii,Idaho,Illinois,Indiana,Iowa,Kansas,Kentucky, Louisiana,Maine,Montana,Nebraska,Nevada,New Hampshire,New Jersey,New Mexico,New York, North Carolina,North Dakota,Ohio,Oklahoma,Oregon,Maryland,Massachusetts,Michigan, Minnesota,Mississippi,Missouri,Pennsylvania,Rhode Island,South Carolina,South Dakota, Tennessee,Texas,Utah,Vermont,Virginia,Washington,West Virginia,Wisconsin,Wyoming".split(',');<br />
<br />
$('#question'+q1ID+' input.text').autocomplete({<br />
source: states<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Method 2 (use remote CSV file for data):'''<br />
*Place the CSV file of suggestions in your template directory<br />
*Place a PHP file containing the code below in your template directory<br />
*Replace "countries2.csv" with your CSV filename (you could make this more universal by passing the filename in the URL)<br />
*This file will grab the contents of the CSV and encode them in JSON format that the JavaScript can use<br />
*Place the JavaScript code below in ths source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace "templates/yourTemplate/countries.php" with the path to the PHP file (from LimeSurvey root)<br />
*This script will grab the jsonized data from the PHP file and load it into an array that the plugin can use<br />
<br />
PHP code:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><?php<br />
<br />
$countriesArr = array();<br />
<br />
$file_handle = fopen("countries2.csv", "r");<br />
<br />
while (!feof($file_handle) ) {<br />
$line_of_text = fgetcsv($file_handle);<br />
array_push($countriesArr, $line_of_text[0]);<br />
}<br />
<br />
fclose($file_handle);<br />
<br />
echo json_encode($countriesArr);<br />
<br />
?></syntaxhighlight><br />
<br />
JavaScript code:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var qID = QQ;<br />
var url = "templates/yourTemplate/countries.php";<br />
var dataArr = [];<br />
<br />
$.getJSON(url,function(data){<br />
<br />
$.each(data,function(i, item){<br />
dataArr.push(item);<br />
});<br />
<br />
$('#question'+qID+' input.text').autocomplete({<br />
source: dataArr<br />
});<br />
<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
== Use autocomplete to populate several fields==<br />
<br />
''Tested with: 1.91+, IE 7/8/9, Firefox 18''<br />
<br />
This workaround uses the [http://jqueryui.com/demos/autocomplete/ Autocomplete widget] included with jQuery UI and the [https://code.google.com/p/jquery-csv/source/browse/jquery.csv.js?r=f13189b2550a770ccaa777f1d747bc860b943fe7 jquery.csv.js] plugin to provide a respondent with a list of suggested answers as they type in a text input and then to automatically populate other fields depending on the selection.<br />
<br />
For example, if you have 3 questions - "Name", "ID" and "Email" - you can use this workaround to autocomplete the "Name" question and then the "ID" and "Email" questions can be automatically populated with values associated with the selected name.<br />
*Download the [https://code.google.com/p/jquery-csv/source/browse/jquery.csv.js?r=f13189b2550a770ccaa777f1d747bc860b943fe7 jquery.csv.js] plugin and place it in your template folder<br />
*If using LimeSurvey 1.9x, add the following line to your startpage.pstpl BEFORE the tag for template.js, if using 2.x, add it AFTER the {TEMPLATEJS} placeholder<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}jquery.csv.js"></script></syntaxhighlight><br />
*Create your CSV file with 3 columns (name, ID, email) as in this example and place it in your template folder<syntaxhighlight lang="php" enclose="div">Bob, Bob's ID, Bob's email<br />
<br />
Andy, Andy's ID, Andy's email<br />
<br />
Sam, Sam's ID, Sam's email<br />
<br />
Tony, Tony's ID, Tony's email<br />
<br />
Fred, Fred's ID, Fred's email</syntaxhighlight><br />
*Create your 3 questions - "Name", "ID" and "Email". They must be in the same group/page.<br />
*Add the following styles to the end of your 'template.css' file<syntaxhighlight lang="php" enclose="div">/* Autocomplete styles */<br />
<br />
ul.ui-autocomplete {<br />
<br />
width: 250px !important;<br />
<br />
padding: 5px 10px;<br />
<br />
list-style: none;<br />
<br />
}</syntaxhighlight><br />
*Add the following script to the source of one of the questions<br />
*Replace:<br />
**"NN" with the "Name" question ID<br />
**"II" with the "ID" question ID<br />
**"EE" with the "Email" question ID<br />
*Modify the path to your CSV file<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var qNameID = NN;<br />
<br />
var qIDID = II;<br />
<br />
var qEmailID = EE;<br />
<br />
var url = "upload/templates/yourTemplate/yourCsvFile.csv";<br />
<br />
// Create an array to hold the names<br />
var namesArr = new Array();<br />
<br />
// Grab the CSV contents<br />
$.get(url,function(data){<br />
<br />
// Convert CSV contents to an array of arrays<br />
fullArray = $.csv.toArrays(data);<br />
<br />
// Load the names array<br />
$(fullArray).each(function(i, item){<br />
namesArr.push(item[0]);<br />
});<br />
<br />
// Initialise the autocomplete plugin<br />
$('#question'+qNameID+' input.text').autocomplete({<br />
source: namesArr,<br />
// Event fired when a selection is made (ui.item.value refers to the selected item)<br />
select: function(event, ui) {<br />
// Find the "ID" and "Email" values associated with the selected name value and load those questions<br />
$(fullArray).each(function(i, item){<br />
if(item[0] == ui.item.value) {<br />
// The value from column 2 of the CSV<br />
$('#question'+qIDID+' input.text').val(item[1]);<br />
// The value from column 3 of the CSV<br />
$('#question'+qEmailID+' input.text').val(item[2]);<br />
}<br />
});<br />
}<br />
});<br />
});<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Drag and Drop Rankings {{Deprecated|2.0}} =<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }} <br />
<br />
==Drag and Drop Ranking - Version 1.90 to 1.92==<br />
<br />
''Tested with: 1.90+ & 1.91RC4, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }} <br />
<br />
This workaround is a modification of the workaround below and also uses [http://jqueryui.com/demos/sortable/#connect-lists JQuery connected sortables]. Thanks to the author of that workaround.<br />
<br />
[[File:Untitled-12.png]]<br />
<br />
Modifications include:<br />
*Allow for multiple drag-n-drop ranking questions on a page<br />
*Handle minimum and maximum answers settings<br />
*Allow double clicking of items to add or remove them from the ranking list<br />
*Work with the new shipped jQuery UI<br />
<br />
There is a '''[http://www.partnersinc.biz/surveys//index.php?sid=36981&newtest=Y&lang=en demonstrated here]'''.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the large script below in your template.js file.<br />
#Place the small script below in the source a ranking question, (this applies the "dragDropRank" function to the question). Replace "QQ" with the ranking [http://docs.limesurvey.org/SGQA+identifier&structure;=English+Instructions+for+LimeSurvey#General_Description question ID].<br />
**Note: the LimeSurvey translations will be automatically used for the "Choices" and "Rankings" header labels but can be overridden with custom labels - see the example calls below.<br />
#Insert the CSS below at the end of template.css (these styles are for the default template).<br />
<br />
NOTE: I have not tested this workaround with conditions.<br />
<br />
'''Code for template.js:'''<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
function dragDropRank(qID, choiceText, rankText) {<br />
<br />
if(!choiceText) {<br />
choiceText = $('#question'+qID+' td.label label').text();<br />
}<br />
if(!rankText) {<br />
rankText = $('#question'+qID+' td.output tr:first td:eq(1)').text();<br />
}<br />
<br />
//Add a class to the question<br />
$('#question'+qID+'').addClass('dragDropRanking');<br />
<br />
// Hide the original question in LimeSurvey (so that we can replace with drag and drop)<br />
$('#question'+qID+' .rank, #question'+qID+' .questionhelp').hide();<br />
<br />
// Turn off display of question (to override error checking built into LimeSurvey ranking question)<br />
//$('#display'+qID).val('off');<br />
<br />
// Add connected sortables elements to the question<br />
var htmlCode = '<table class="dragDropTable"> \<br />
<tbody> \<br />
<tr> \<br />
<td> \<br />
<span class="dragDropHeader choicesLabel">'+choiceText+'</span><br /> \<br />
<div class="ui-state-highlight dragDropChoices"> \<br />
<ul id="sortable1'+qID+'" class="connectedSortable'+qID+' dragDropChoiceList"> \<br />
<li>Choices</li> \<br />
</ul> \<br />
</div> \<br />
</td> \<br />
<td> \<br />
<span class="dragDropHeader rankingLabel">'+rankText+'</span><br /> \<br />
<div class="ui-state-highlight dragDropRanks"> \<br />
<ol id="sortable2'+qID+'" class="connectedSortable'+qID+' dragDropRankList"> \<br />
<li>Ranks</li> \<br />
</ol> \<br />
</div> \<br />
</td> \<br />
</tr> \<br />
</tbody> \<br />
</table>';<br />
$(htmlCode).insertAfter('#question'+qID+' table.rank');<br />
<br />
// Remove placeholder list items (have to have one item so that LimeSurvey doesn"t remove the <ul>)<br />
$('#sortable1'+qID+' li, #sortable2'+qID+' li').remove();<br />
<br />
// Load any previously-set values<br />
loadDragDropRank(qID);<br />
<br />
// Find the number of LimeSurvey ranking inputs ("Maximum answers")<br />
var maxAnswer = $('#question'+qID+' td.output input.text').length;<br />
<br />
// Set up the connected sortable<br />
$('#sortable1'+qID+', #sortable2'+qID+'').sortable({<br />
connectWith: '.connectedSortable'+qID+'',<br />
placeholder: 'ui-sortable-placeholder',<br />
helper: 'clone',<br />
revert: 50,<br />
receive: function(event, ui) {<br />
if($('#sortable2'+qID+' li').length > maxAnswer) {<br />
alert ('You can only rank a maximum of '+maxAnswer+' choices.');<br />
$(ui.sender).sortable('cancel');<br />
}<br />
},<br />
stop: function(event, ui) {<br />
$('#sortable1'+qID+'').sortable('refresh');<br />
$('#sortable2'+qID+'').sortable('refresh');<br />
updateDragDropRank(qID);<br />
}<br />
}).disableSelection();<br />
<br />
// Get the list of choices from the LimeSurvey question and copy them as items into the sortable choices list<br />
$('#CHOICES_' + qID).children().each(function(index, Element) {<br />
var liCode = '<li class="ui-state-default" id="choice_' + $(this).attr("value") + '">' + this.text + '</li>'<br />
$(liCode).appendTo('#sortable1'+qID+'');<br />
});<br />
<br />
// Allow users to double click to move to selections from list to list<br />
$('#sortable1'+qID+' li').live('dblclick', function() {<br />
if($('#sortable2'+qID+' li').length == maxAnswer) {<br />
alert ('You can only rank a maximum of '+maxAnswer+' choices.');<br />
return false;<br />
}<br />
else {<br />
$(this).appendTo('#sortable2'+qID+'');<br />
$('#sortable1'+qID+'').sortable('refresh');<br />
$('#sortable2'+qID+'').sortable('refresh');<br />
updateDragDropRank(qID);<br />
}<br />
});<br />
$('#sortable2'+qID+' li').live('dblclick', function() {<br />
$(this).appendTo('#sortable1'+qID+'');<br />
$('#sortable2'+qID+'').sortable('refresh');<br />
$('#sortable1'+qID+'').sortable('refresh');<br />
updateDragDropRank(qID);<br />
});<br />
}<br />
<br />
// This function copies the drag and drop sortable data into the LimeSurvey ranking list.<br />
function updateDragDropRank(qID) {<br />
<br />
// Reload the LimeSurvey choices select element<br />
var rankees = [];<br />
$('#sortable2'+qID+' li').each(function(index) {<br />
$(this).attr('value', index+1);<br />
<br />
// Get value of ranked item<br />
var liID = $(this).attr("id");<br />
liIDArray = liID.split('_');<br />
<br />
// Save to an array<br />
rankees[rankees.length] = { "r_name":$(this).text(),"r_value":liIDArray[1] };<br />
});<br />
$('#question'+qID+' input[name<div class="simplebox">="RANK_"]').each(function(index) {<br />
if (rankees.length > index) {<br />
$(this).val(rankees[index].r_name);<br />
$(this).next('input').attr('value', rankees[index].r_value);<br />
} else {<br />
$(this).val('');<br />
$(this).next().val('');<br />
}<br />
});<br />
<br />
// Reload the LimeSurvey choices select element (we need this for "Minimum answers" code)<br />
$('#question'+qID+' td.label select option').remove();<br />
$('#sortable1'+qID+' li').each(function(index) {<br />
var liText = $(this).text();<br />
var liID = $(this).attr('id');<br />
liIDArray = liID.split('_');<br />
var optionCode = '<option value="'+liIDArray[1]+'">'+liText+'</option>';<br />
$(optionCode).appendTo('#question'+qID+' td.label select');<br />
});<br />
<br />
// Hack for IE6<br />
if ($.browser.msie && $.browser.version.substr(0,1)<7) {<br />
$('#question'+qID+' select').show();<br />
$('#question'+qID+' select').hide();<br />
}<br />
}<br />
<br />
// This function is called on page load to see if there are any items already ranked (from a previous visit<br />
// or cached due to a page change. If so, the already-ranked items are loaded into the sortable list<br />
function loadDragDropRank(qID) {<br />
<br />
var rankees = [];<br />
<br />
// Loop through each item in the built-in LimeSurvey ranking list looking for non-empty values<br />
$('#question'+qID+' input[name</div>="RANK_"]').each(function(index) {<br />
<br />
// Check to see if the current item has a value<br />
if ($(this).val()) {<br />
<br />
// Item has a value - save to the array<br />
// Use this element to contain the name and the next for the value (numeric)<br />
rankees[rankees.length] = { "r_name":$(this).val(),"r_value":$(this).next().val() };<br />
}<br />
});<br />
<br />
// Now that we have a list of all the pre-ranked items, populate the sortable list<br />
// Note that the items *won"t* appear in the main list because LimeSurvey has removed them.<br />
$.each(rankees, function(index, value) {<br />
<br />
// Create the items in the sortable<br />
var liCode = '<li class="ui-state-default" id="choice_' + value.r_value + '">' + value.r_name + '</li>';<br />
$(liCode).appendTo('#sortable2'+qID+'');<br />
});<br />
}</syntaxhighlight><br />
<br />
'''Code in the source of the question(s) using the LimeSurvey translations for the "Choices" and "Rankings" element header labels''' (replace "QQ" with the ranking [http://docs.limesurvey.org/SGQA+identifier&structure;=English+Instructions+for+LimeSurvey#General_Description question ID]):<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
dragDropRank(QQ);<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Fix for later versions of 1.91+'''<br />
In my version of LimeSurvey 1.91+, build 11026, this drag-n-drop workaround was not saving the selections properly. I'm not sure if that's because of my template, or other jquery uses, but I fixed it by making the following modifications to the above code placed into template.js.<br />
<br />
If you're having problems (and it's definitely worth testing that the rankings are actually saving into your response table before proceeding with the survey) give this a try.<br />
<br />
In the 'updateDragDropRank(qID)' function, replace the line:<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$('#question'+qID+' input[name<div class="simplebox">="RANK_"]').each(function(index) {<br />
</syntaxhighlight><br />
with:<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$('#question'+qID+' input[name^="RANK_"]').each(function(index) {<br />
</syntaxhighlight><br />
<br />
In the 'loadDragDropRank(qID) function, replace the line:<br />
<syntaxhighlight><script><br />
$('#question'+qID+' input[name</div>="RANK_"]').each(function(index) {<br />
</script></syntaxhighlight><br />
with:<br />
<syntaxhighlight><script><br />
$('#question'+qID+' input[name^="RANK_"]').each(function(index) {<br />
</script></syntaxhighlight><br />
<br />
<br />
'''Code in the source of the question(s) using custom text for the "Choices" and "Rankings" element header labels''' (replace "QQ" with the ranking [http://docs.limesurvey.org/SGQA+identifier&structure;=English+Instructions+for+LimeSurvey#General_Description question ID]):<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
dragDropRank(QQ, 'Custom Choices Label', 'Custom Rankings Label');<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Styles for template.css:'''<br />
<br />
<syntaxhighlight lang="css" enclose="div"><br />
/* Drag-n-drop ranking styles */<br />
.dragDropTable {<br />
border: 0 none;<br />
border-collapse: collapse;<br />
width: 100%;<br />
}<br />
<br />
.dragDropTable td {<br />
vertical-align: top;<br />
width: 50%;<br />
padding-right: 20px;<br />
}<br />
<br />
.dragDropTable .dragDropHeader {<br />
font-weight: bold;<br />
}<br />
<br />
.dragDropTable .dragDropChoices,<br />
.dragDropTable .dragDropRanks {<br />
margin: 5px 0 0 0;<br />
background: transparent none;<br />
border: 0 none;<br />
}<br />
<br />
.dragDropTable .dragDropChoiceList,<br />
.dragDropTable .dragDropRankList {<br />
float: left;<br />
width: 100%;<br />
min-height: 2.4em;<br />
_height: 2.4em; /* IE6 and below hack */<br />
margin: 0;<br />
padding: 0;<br />
list-style-type: none;<br />
background: #FBFBFB none;<br />
border: 1px solid #CCCCCC;<br />
}<br />
<br />
.dragDropTable .dragDropChoiceList li,<br />
.dragDropTable .dragDropRankList li {<br />
margin: 3px;<br />
*margin-left: -13px; /* IE7 and below */<br />
padding: 3px;<br />
min-height: 1.3em;<br />
_height: 1.3em; /* IE6 and below hack */<br />
font-weight: normal;<br />
cursor: move;<br />
display: block; /* Force the li to full width */<br />
}</syntaxhighlight><br />
<br />
==Drag and Drop Ranking using Images - Version 1.90 to 1.92==<br />
<br />
''Tested with: 1.90+ & 1.91RC4, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }}<br />
<br />
This workaround works in conjunction with the above workaround to allow ranking of images.<br />
<br />
[[File:Untitled-11.png]]<br />
<br />
There is a '''[http://www.partnersinc.biz/surveys//index.php?sid=36981&newtest=Y&lang=en demonstrated here]'''.<br />
<br />
Implementation is as follows:<br />
<br />
1) Follow the above workaround to get basic drag-n-drop functionality in your ranking question.<br />
<br />
2) Insert your images in the ranking question text or help section after any text that you wish to have there (we'll move them later with JavaScript).<br />
<br />
3) Give the images '''EXACTLY''' the same IDs as the answer code you would like them to be associated with:[[File:Untitled-8.png]]<br />
<br />
4) Place the first script below in your template.js file.<br />
<br />
5) Place the second script below in the source the ranking question '''AFTER''' the initial call for the dragDropRank function from the workaround above. Replace "QQ" with the ID of the ranking question (this applies the "dragDropRankImages" function to the question).<br />
<br />
6) Insert the CSS below at the end of template.css. Replace "11" with your question ID. These styles are for the default template using 50x50px images (as in the demo) and may need to be modified for other templates or image sizes.<br />
<br />
'''Code for template.js:'''<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
function dragDropRankImages(qID) {<br />
<br />
$('.connectedSortable'+qID+' li').each(function(i) {<br />
<br />
// Remove any text in the sortable choice or rank items<br />
$(this).text('');<br />
<br />
// Move the images into the appropriate sortable list item<br />
var liID = $(this).attr('id');<br />
liIDArray = liID.split('_');<br />
$('#question'+qID+' img#'+liIDArray[1]+'').appendTo(this);<br />
});<br />
}</syntaxhighlight><br />
<br />
'''Code in the source of the question(s):'''<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
dragDropRankImages(QQ);<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Styles for template.css:'''<br />
<br />
<syntaxhighlight lang="css" enclose="div"><br />
<br />
/* Drag-n-drop for ranking images */<br />
#question11 .dragDropTable {<br />
width: auto;<br />
}<br />
<br />
#question11 .dragDropTable .dragDropChoiceList,<br />
#question11 .dragDropTable .dragDropRankList {<br />
min-height: 60px;<br />
_height: 60px; /* IE6 and below hack */<br />
width: auto;<br />
min-width: 60px;<br />
_width: 60px; /* IE6 and below hack */<br />
}<br />
<br />
#question11 .dragDropTable li {<br />
background: 0 none;<br />
border: 0 none;<br />
height: 50px;<br />
width: 50px;<br />
}<br />
<br />
#question11 .dragDropTable li img {<br />
margin: 0;<br />
padding: 0;<br />
border: 0 none;<br />
}</syntaxhighlight><br />
<br />
==Drag and Drop Ranking for iPad - Version 1.91 and newer==<br />
<br />
''Tested with: LimeSurvey 1.91, iPad 2''<br />
<br />
This workaround extends the above workarounds to work with the touch interface on iPads.<br />
<br />
1) Follow the [[Workarounds: Manipulating a survey at runtime using Javascript#Drag and Drop Ranking - Version 1.90 and newer|Drag and Drop Ranking - Version 1.90 and newer]] workaround above to get basic drag-n-drop functionality in your ranking question.<br />
<br />
2) Download the [https://github.com/furf/jquery-ui-touch-punch jQuery.ui.touch-punch.js plugin] and save it in your template directory.<br />
<br />
3) Replace this line in your startpage.pstpl:<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}template.js"></script></syntaxhighlight>With this:<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}jquery.ui.touch-punch.js"></script><br />
<br />
<script type="text/javascript" src="{TEMPLATEURL}template.js"></script></syntaxhighlight><br />
<br />
==Drag and Drop Ranking - Version 1.86==<br />
<br />
Tested with 1.86 on IE 7,8, FireFox 3, Chrome, and Safari 4<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }}<br />
<br />
This workaround uses [http://jqueryui.com/demos/sortable/#connect-lists JQuery connected sortables] to modify a ranking question and allow the survey taker to drag and drop choices instead of clicking. The nice thing is that the choices can be easily re-arranged or removed from the ranking, all by drag and drop.<br />
<br />
I used it for a voting application and some of the element names reflect that use.<br />
<br />
It looks best when some CSS is added to control the appearance of the boxers around each choice.<br />
<br />
[[File:drag-n-drop.png]]<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
// Question ID global variable<br />
var questionID;<br />
<br />
$(document).ready(function() {<br />
<br />
// Grab the question ID[[File:drag-n-drop.png]]<br />
// This is something with a class of "ranking" and an ID that starts with "questionXXXXX". The X's represent the question ID<br />
var entire_questionID = $(".ranking[id<div class="simplebox">='question']").attr('id');<br />
<br />
// Get just the question number (ID)<br />
var patt=/\d+$/;<br />
questionID=patt.exec(entire_questionID);<br />
<br />
// Hide the original quetion in LimeSurvey (so that we can replace with drag and drop)<br />
$(".rank, .questionhelp").hide();<br />
<br />
// Turn off display of question (to override error checking built into LimeSurvey ranking question)<br />
$("#display"+questionID).val("off");<br />
<br />
// Add connected sortables to the question<br />
var html_code = "<table style='border: medium none ; width: 770px; margin-left: auto; \<br />
margin-right: auto;'><tbody><tr><td style='width: 590px; vertical-align: top;'><h3>List of Candidates:</h3> \<br />
<div class='ui-state-highlight' style='margin: 5px; float: left;' id='ballot_list'> \<br />
<ul id='sortable1' class='connectedSortable'><li>Candidates</li></ul></div></td> \<br />
<td style='vertical-align: top;'><h3>Your selections:</h3><div class='ui-state-highlight' \<br />
style='margin: 5px; float: left;' id='voting_selections'><ol id='sortable2' class='connectedSortable'> \<br />
<li>Voting Area</li></ol></div></td></tr></tbody></table>";<br />
$(html_code).appendTo("#question" + questionID);<br />
<br />
// Remove list items (have to have one item so that LimeSurvey doesn't remove the <ul>)<br />
$("#sortable1 li, #sortable2 li").remove();<br />
<br />
// Load any previously-set values<br />
loadRanking();<br />
<br />
// Load jQuery UI<br />
$.getScript("/scripts/jquery/jquery-ui.js", function() {<br />
<br />
// After JQuery UI finishes loading, set up the connected sortable.<br />
$("#sortable1, #sortable2").sortable({<br />
connectWith: '.connectedSortable',<br />
placeholder: 'ui-sortable-placeholder',<br />
stop: function(event, ui) {<br />
$("#sortable1").sortable("refresh");<br />
$("#sortable2").sortable("refresh");<br />
updateRanking();<br />
}<br />
}).disableSelection();<br />
<br />
// Get the list of candidates from the built-in LimeSurvey question and copy them as items in sortable1<br />
$("#CHOICES_" + questionID).children().each(function(index, Element) {<br />
li_tag = "<li class='ui-state-default' id='choice_" + $(this).attr('value') + "'>" + this.text + "</li>"<br />
$(li_tag).appendTo("#sortable1"); } );<br />
<br />
// Make sure the submit button is showing<br />
$(":submit[value|=' Submit']").show();<br />
<br />
// Show a confirmation alert upon submit<br />
$("form").submit(function() {<br />
<br />
// Override the built-in "disable navigation buttons" feature<br />
$('#moveprevbtn, #movenextbtn, #movesubmitbtn').attr('disabled', '');<br />
var validated = confirm("Cast your ballot now?");<br />
if (validated) { return true; } else { return false; }<br />
});<br />
<br />
// Allow users to double click to move to selection list<br />
$("#sortable1 li").assignDblClick();<br />
}); // End of JQuery UI loading<br />
<br />
}); // End of JQuery ready function<br />
<br />
// Define the actions when an item is double clicked<br />
$.fn.assignDblClick = function() {<br />
$(this).dblclick(function(){<br />
$(this).appendTo('#sortable2');<br />
$("#sortable1").sortable("refresh");<br />
$("#sortable2").sortable("refresh");<br />
updateRanking();<br />
});<br />
}<br />
<br />
// This function copies the drag and drop sortable data into the standard LimeSurvey ranking structure.<br />
function updateRanking() {<br />
var rankees = [];<br />
$('#sortable2 li').each(function(index) {<br />
$(this).attr("value", index+1);<br />
<br />
// Get value of person<br />
li_tag = $(this).attr('id');<br />
li_tag_array = li_tag.split("_");<br />
<br />
// Save to an array<br />
rankees[rankees.length] = { 'r_name':$(this).text(),'r_value':li_tag_array[1] };<br />
});<br />
$("input[name</div>='RANK_']").each(function(index) {<br />
if (rankees.length > index) {<br />
$(this).val(rankees[index].r_name);<br />
$(this).next().val(rankees[index].r_value);<br />
} else {<br />
$(this).val("");<br />
$(this).next().val("");<br />
}<br />
});<br />
<br />
// Re-assign double click action to first list items and remove<br />
// double click action from section list items<br />
$('#sortable1 li').unbind('dblclick').assignDblClick();<br />
$('#sortable2 li').unbind('dblclick');<br />
}<br />
<br />
// This function is called on page load to see if there are any items already ranked (from a previous visit<br />
// or cached due to a page change. If so, the already-ranked items are loaded into the sortable list<br />
function loadRanking() {<br />
var rankees = [];<br />
<br />
// Loop through each item in the built-in LimeSurvey ranking list looking for non-empty values<br />
$("input[name<div class="simplebox">='RANK_']").each(function(index) {<br />
<br />
// Check to see if the current item has a value<br />
if ($(this).val()) {<br />
// Item has a value - save to the array<br />
// Use this element to contain the name and the next for the value (numeric)<br />
rankees[rankees.length] = { 'r_name':$(this).val(),'r_value':$(this).next().val() };<br />
}<br />
});<br />
<br />
// Now that we have a list of all the pre-ranked items, populate the sortable list<br />
// Note that the items *won't* appear in the main list because LimeSurvey has removed them.<br />
$.each(rankees, function(index, value) {<br />
// Create the items in the sortable<br />
li_tag = "<li class='ui-state-default' id='choice_" + value.r_value + "'>" + value.r_name + "</li>";<br />
$(li_tag).appendTo("#sortable2");<br />
});<br />
}</syntaxhighlight><br />
<br />
=Create MaxDiff question type=<br />
<br />
See the [[Workarounds: Question design, layout and templating|Question design, layout and templating]] section for a workaround that uses JavaScript to convert an '''''Array (flexible labels) by column''''' question into a [http://en.wikipedia.org/wiki/MaxDiff MaxDiff] question type.<br />
<br />
[[File:max_diff_596x253.gif]]<br />
<br />
=In a checkbox matrix, have the 'none' option in a row disable all other columns in that row=<br />
<br />
''Tested with: LimeSurvey 1.90+''<br />
<br />
The questionId parameter is the base ID of the question matrix (multiflexible).<br />
<br />
numColumns and numRows speak for themselves<br />
<br />
specialColumns is an array of the columns that have the special ability that when one of them<br />
<br />
is checked, none of the others can be checked. E.g., a 'none of these' and/or a 'do now know' option.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
numColumns=13;<br />
<br />
numRows=18;<br />
<br />
questionId='28417X2X24';<br />
<br />
specialColumns=[1,12,13];<br />
<br />
function action(obj){<br />
<br />
locator=obj.id.replace('cbox_'+questionId, '').split('_');<br />
<br />
row=locator[0];<br />
<br />
column=locator[1];<br />
<br />
//alert('Action for row,column='+row+','+column);<br />
<br />
my_id='#cbox_'+questionId+row+'_'+column+''<br />
<br />
if($(my_id).attr('checked') == false) {<br />
<br />
for( var i=1; i<=numColumns; i++ ) {<br />
<br />
if(i==column) continue;<br />
<br />
id='#cbox_'+questionId+row+'_'+i<br />
<br />
$(id).attr('disabled',false);<br />
<br />
}<br />
<br />
} else {<br />
<br />
for( var i=1; i<=numColumns; i++ ) {<br />
<br />
if(i==column) continue;<br />
<br />
id='#cbox_'+questionId+row+'_'+i<br />
<br />
aid='#answer'+questionId+row+'_'+i<br />
<br />
$(aid).val(0);<br />
<br />
$(id).attr('checked',false);<br />
<br />
$(id).attr('disabled',true);<br />
<br />
}<br />
<br />
}<br />
<br />
}<br />
<br />
function customOnLoad(){<br />
<br />
for( var row=1; row<=numRows; row++ ) {<br />
<br />
for( var k=0; k<specialColumns.length; k++ )<br />
<br />
{<br />
<br />
column=specialColumns[k];<br />
<br />
$('#cbox_'+questionId+row+'_'+column).change(function() {<br />
<br />
action(this);<br />
<br />
});<br />
<br />
}<br />
<br />
}<br />
<br />
}<br />
<br />
jQuery(document).ready(<br />
<br />
function(){<br />
<br />
customOnLoad();<br />
<br />
}<br />
<br />
);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Last Option In Array (Numbers) (Checkboxes) Row Excludes All Others=<br />
<br />
''Tested with: 2.05, IE 7-10, Firefox''<br />
<br />
This workaround uses JavaScript/jQuery to make the last option of each Array (Numbers) (Checkboxes) row exclude all other options in the same row.<br />
<br />
The script will uncheck all options in a row if the last option is checked and uncheck the last option in a row if any other options are checked.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the following script in the source of the array question.<br />
<br />
NOTE: Care should be taken when using this script and conditional questions on the same page.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"> <br />
$(document).ready(function() {<br />
// Call the exclude function using question ID<br />
excludeOpt ({QID});<br />
});<br />
<br />
// A function to make the last option in each array row exclusive<br />
function excludeOpt (qID) {<br />
<br />
var thisQuestion = $('#question'+qID)<br />
<br />
// Add some classes to the checkbox cells<br />
$('table.question tbody td', thisQuestion).addClass('normalOpt');<br />
$('table.question tbody tr', thisQuestion).each(function(i) {<br />
$('.normalOpt:last', this).removeClass('normalOpt').addClass('exlusiveOpt')<br />
});<br />
<br />
// A listener on the checkbox cells<br />
$('table.question tbody td', thisQuestion).click(function (event) {<br />
<br />
// Set some vars<br />
var thisRow = $(this).closest('tr');<br />
<br />
// Uncheck the appropriate boxes in a row<br />
if ($(this).hasClass('normalOpt')) {<br />
$('.exlusiveOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
else {<br />
$('.normalOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
});<br />
<br />
// A listener on the checkboxes<br />
$('table.question tbody td input[type=checkbox]', thisQuestion).click(function (event) {<br />
<br />
// Set some vars<br />
var thisRow = $(this).closest('tr');<br />
var thisCell = $(this).closest('td');<br />
<br />
// Uncheck the appropriate boxes in a row<br />
if ($(thisCell).hasClass('normalOpt')) {<br />
$('.exlusiveOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
else {<br />
$('.normalOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
});<br />
} <br />
</script></syntaxhighlight><br />
<br />
=Add Navigation Buttons (Next and Previous) To Top Of Page=<br />
<br />
''Tested with: 1.90+, IE 7/8, Firefox 3.6, Safari 3.2''<br />
<br />
Add the following to the end of template.js. It will insert a new div after the progress bar and then insert clones of the nav buttons in the new div.<br />
<br />
This example is for the default template in 1.90 or 1.91. The placement of the new div may need to be modified for other templates.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$(document).ready(function() {<br />
<br />
// Insert a new div after the progress bar<br />
$('<div id="navigator2" />').insertAfter('#progress-wrapper');<br />
<br />
// Style the new div<br />
$('#navigator2').css({<br />
'text-align':'center'<br />
});<br />
<br />
// Insert clones of the nav buttons in the new div<br />
$('input.submit:eq(0)').clone().appendTo('#navigator2');<br />
$('input.submit:eq(2)').clone().appendTo('#navigator2');<br />
<br />
// Give the new buttons some new IDs<br />
$('#navigator2 input.submit').each(function(i) {<br />
var oldID = $(this).attr('id');<br />
var newID = oldID + '2';<br />
$(this).attr('id', newID)<br />
});<br />
});</syntaxhighlight><br />
<br />
[[File:extra_buttons.png]]<br />
<br />
=How to ''add'' an opt out link to your survey=<br />
<br />
Tested with: 1.91+, Firefox 5.0<br />
<br />
This javascript inserts a link to opt out of the survey above the progress bar.<br />
<br />
[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]]<br />
<br />
Then insert the following code into to the source of a group description or a question. I used the group description.<br />
<br />
<syntaxhighlight lang="php" enclose="div"> <script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Find the survey ID<br />
if($('input#fieldnames').length != 0) {<br />
var fieldNames = $('input#fieldnames').attr('value');<br />
var tmp = fieldNames.split('X');<br />
var sID = tmp[0];<br />
}<br />
<br />
// Insert a new div after the progress bar<br />
$('<div id="optOutLink" />').insertBefore('#progress-wrapper');<br />
<br />
// Style the new div<br />
$('#optOutLink').css({<br />
'text-align':'center'<br />
});<br />
<br />
// Insert opt out url in the new div<br />
$('#optOutLink').html('<p><a href="optout.php?lang=en&sid;='+sID+'&token;={TOKEN}">Click here to opt out of this survey.</a></p><br>');<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Anonymously track respondents answers across multiple surveys=<br />
<br />
''Tested with: 1.91+ and 1.92+''<br />
<br />
This workaround uses JavaScript/jQuery to enable tracking of respondents across multiple surveys ensuring anonymity (it does not use tokens).<br />
<br />
To do this you have to use this question in all the surveys you want to link respondents answers.<br />
<br />
This workaround create an ID by asking some partial personal information (like initials, birth month ...). The ID will be encrypted using a one-way function (in this case SHA-1) and stored in a short text answer.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the following code in the source of a short text question.<br />
#Optional: you can also add other select field to avoid collisions (e.g. for large population sample)<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<p>This answers are used to generate your ID. These information will be encrypted, it will not be possible in any case to identify you neither from your answers nor from your ID.</p><br />
<br />
<table><br />
<br />
<tr><br />
<br />
<td>Initial of your name</td><br />
<br />
<td><br />
<br />
<select id="field1"><br />
<br />
<option value=""></option><br />
<br />
<option value="A">A</option><br />
<br />
<option value="B">B</option><br />
<br />
<option value="C">C</option><br />
<br />
<option value="D">D</option><br />
<br />
<option value="E">E</option><br />
<br />
<option value="F">F</option><br />
<br />
<option value="G">G</option><br />
<br />
<option value="H">H</option><br />
<br />
<option value="I">I</option><br />
<br />
<option value="J">J</option><br />
<br />
<option value="K">K</option><br />
<br />
<option value="L">L</option><br />
<br />
<option value="M">M</option><br />
<br />
<option value="N">N</option><br />
<br />
<option value="O">O</option><br />
<br />
<option value="P">P</option><br />
<br />
<option value="Q">Q</option><br />
<br />
<option value="R">R</option><br />
<br />
<option value="S">S</option><br />
<br />
<option value="T">T</option><br />
<br />
<option value="U">U</option><br />
<br />
<option value="V">V</option><br />
<br />
<option value="W">W</option><br />
<br />
<option value="X">X</option><br />
<br />
<option value="Y">Y</option><br />
<br />
<option value="Z">Z</option><br />
<br />
</select><br />
<br />
</td><br />
<br />
</tr><br />
<br />
<tr><br />
<br />
<td>Your birth month</td><br />
<br />
<td><br />
<br />
<select id="field2"><br />
<br />
<option value=""></option><br />
<br />
<option value="01">January</option><br />
<br />
<option value="02">February</option><br />
<br />
<option value="03">March</option><br />
<br />
<option value="04">April</option><br />
<br />
<option value="05">May</option><br />
<br />
<option value="06">June</option><br />
<br />
<option value="07">July</option><br />
<br />
<option value="08">August</option><br />
<br />
<option value="09">September</option><br />
<br />
<option value="10">October</option><br />
<br />
<option value="11">November</option><br />
<br />
<option value="12">December</option><br />
<br />
</select><br />
<br />
<td><br />
<br />
</tr><br />
<br />
</table><br />
<br />
<script type="text/javascript" src="http://crypto-js.googlecode.com/svn/tags/3.0.2/build/rollups/sha1.js"></script><br />
<br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
$("#answer{SGQ}").attr('readonly', 'readonly');<br />
<br />
//$("#answer{SGQ}").css('display', 'none'); //uncomment this line for not displaying the code<br />
<br />
});<br />
<br />
$('#field1, #field2').bind('change keyup', function() {<br />
<br />
if ($("#field1").val()=='' || $("#field2").val()=='')<br />
<br />
$("#answer{SGQ}").val('');<br />
<br />
else {<br />
<br />
var sha1 = CryptoJS.algo.SHA1.create();<br />
<br />
sha1.update($("#field1").val());<br />
<br />
sha1.update($("#field2").val());<br />
<br />
// sha1.update($("#otherfield").val());<br />
<br />
var hash = sha1.finalize();<br />
<br />
$("#answer{SGQ}").val(hash);<br />
<br />
}<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Check validity of international phone number in subquestion=<br />
<br />
''Tested with: 1.91+, Firefox 8, Chrome 15''<br />
<br />
As of version 1.92, you can use the core Validation querstion option to validate multiple short text and array text questions. Any question that fails that validation check will have its background color changed to red.<br />
<br />
Note, the below workaround will fail in version 1.92 because it contains a regular expression with curly braces. However, as described above, support for this feature is now built-in to version 1.92<br />
<br />
This workaround uses javascript to check the validity of an international phone number in a subquestion of multiple short text.<br />
<br />
Add the following code to the source of your question.<br />
<br />
Replace "QQ" with the question ID and "NN" with the row number that you want to validate.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Call the phone function with the question ID and the row number<br />
<br />
phoneTest(QQ, NN);<br />
<br />
function phoneTest(qID, inputNum) {<br />
<br />
// Interrupt next/submit function<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
// Some vars - modify as required<br />
<br />
var phoneMatch = /^[0-9,+,(), ,]{1,}(,[0-9]+){0,}$/;<br />
<br />
var msg1 = 'Please enter a valid phone number.';<br />
<br />
// Test the input<br />
<br />
var phoneInput = $('#question'+qID+' li:eq('+(inputNum-1)+') input.text').val();<br />
<br />
if(phoneInput != '' && !phoneMatch.test(phoneInput)) {<br />
<br />
alert(msg1);<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'pink' });<br />
<br />
return false;<br />
<br />
}<br />
<br />
else {<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'' });<br />
<br />
return true;<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
The regex is from: [http://www.regexlib.com/REDetails.aspx?regexp_id=1136 regexlib.com blank]<br />
<br />
=Check validity of email address in subquestion=<br />
<br />
'Tested with: 1.91+, Firefox 8, Chrome 15''<br />
<br />
<div class="simplebox">As of version 1.92, you can use the core Validation querstion option to validate multiple short text and array text questions. Any question that fails that validation check will have its background color changed to red.<br />Note, the below workaround will fail in version 1.92 because it contains a regular expression with curly braces. However, as described above, support for this feature is now built-in to version 1.92</div><br />
<br />
This workaround uses javascript to check the validity of an email address in a subquestion of multiple short text.<br />
<br />
Add the following code to the source of your question.<br />
<br />
Replace "QQ" with the question ID and "NN" with the row number that you want to validate.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Call the email function with the question ID and the row number<br />
<br />
emailTest(QQ, NN);<br />
<br />
function emailTest(qID, inputNum) {<br />
<br />
// Interrupt next/submit function<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
// Some vars - modify as required<br />
<br />
var emailMatch = /^[a-zA-Z0-9\_\-]+[a-zA-Z0-9\.\_\-]*@([a-zA-Z0-9\_\-]+\.)+([a-zA-Z]{2,4}|travel|museum)$/;<br />
<br />
var msg1 = 'Please enter a valid email address.';<br />
<br />
// Test the input<br />
<br />
var emailInput = $('#question'+qID+' li:eq('+(inputNum-1)+') input.text').val();<br />
<br />
if(emailInput != '' && !emailMatch.test(emailInput)) {<br />
<br />
alert(msg1);<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'pink' });<br />
<br />
return false;<br />
<br />
}<br />
<br />
else {<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'' });<br />
<br />
return true;<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
The regex is from: [http://www.regexlib.com/REDetails.aspx?regexp_id=1653 regexlib.com blank]<br />
<br />
=Hiding the help-text when it's empty=<br />
<br />
Tested with: 1.91+<br />
<br />
I had made a style in my template putting a border around my help-text. To avoid empty help-text to show up (and have lines instead of just 'nothing' when there was no help text, I used this piece of code in question.pstpl:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
var questionhelp="{QUESTIONHELP}";<br />
<br />
if (questionhelp=="") {<br />
<br />
document.write("");}<br />
<br />
else {<br />
<br />
document.write('<tr><td class="survey-question-help">'+ questionhelp +'</td></tr>');}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
it can probably be optimized but it worked for me<br />
<br />
=Disable or hide selected fields in a matrix question=<br />
<br />
''Tested with: 1.92+, IE 7/8/9, FireFox 12/13''<br />
<br />
TASK<br />
<br />
Hide or disable selected fields in a Matrix, so that users cannot make any input.<br />
<br />
(See example, where users should not make input into red framed fields)<br />
<br />
[[File:snap035.gif]]<br />
<br />
Fig. 1: Prevent users from input into first two fields (as an example)<br />
<br />
SOLUTION<br />
<br />
First find the name of the fields you want to hide / disable. In my case I used Firebug with firefox to figure that out.<br />
<br />
[[File:snap037.gif]]<br />
<br />
Fig. 2: Figure out the name(s) of the field(s)<br />
<br />
Then put the following script-code into the HTML-source code as described above:<br />
<br />
Note: you have to change the code to match the names of your fields!<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('input[name="69965X2X10SQ001_SQ001"]').attr('disabled', 'disabled');<br />
<br />
$('input[name="69965X2X10SQ001_SQ002"]').attr('hidden', 'hidden');<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
[[File:snap039.gif]]<br />
<br />
Fig. 3: Result: first field is diabled ("greyed out"), second one is completely hidden<br />
<br />
I think this way one can apply many other attributes to a field like color etc. But did not try that myself.<br />
<br />
Thanks to roB2009 for the input in the forum!<br />
<br />
=Add prefix or suffix to question type "Array (Texts)"=<br />
<br />
TASK<br />
<br />
Add a prefix or suffix to the text fields in questions of the "Array (Texts)" type.<br />
<br />
[[File:suffix.png]]<br />
<br />
Fig. 1: Suffix<br />
<br />
[[File:prefix.png]]<br />
<br />
Fig. 1: Prefix<br />
<br />
SOLUTION<br />
*Set up your survey to use JavaScript.<br />
*Add the following script to the source of the array. Replace "12345" with the array question ID and modify the suffixes/prefixes as required.<br />
*The function call must consist of a question ID followed by the suffixes for each column. Suffixes/Prefixes must be enclosed in quotes and comma separated.<br />
*In this example question ID 12345 will get an "in &euro;" suffix in the first column and an "in %" in the next 3 columns.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Call the function with the question ID followed by a comma-separated list of suffixes<br />
<br />
addSuffix(12345, 'in &euro;', 'in %', 'in %', 'in %');<br />
<br />
function addSuffix() {<br />
<br />
var qID = $(arguments)[0];<br />
<br />
// Assign some column-specific classes<br />
<br />
$('#question'+qID+' table.question tbody tr').each(function(i){<br />
<br />
$('td', this).each(function(i){<br />
<br />
$(this).addClass('answerCol-'+(i+1)+'');<br />
<br />
});<br />
<br />
});<br />
<br />
// Some styling<br />
<br />
$('#question'+qID+' table.question tbody input[type="text"]').css({<br />
<br />
'width': '50%'<br />
<br />
});<br />
<br />
// Insert the suffixes<br />
<br />
$(arguments).each(function(i, val){<br />
<br />
if(i > 0) {<br />
<br />
$('#question'+qID+' td.answerCol-'+i+' label').append(val);<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
For adding a prefix you need to substitute the following line in the code<br />
<br />
<syntaxhighlight lang="php" enclose="div">$('#question'+qID+' td.answerCol-'+i+' label').append(val);</syntaxhighlight><br />
<br />
with this<br />
<br />
<syntaxhighlight lang="php" enclose="div">$('#question'+qID+' td.answerCol-'+i+' label').prepend(val);</syntaxhighlight><br />
<br />
=Time question (Date question-like)=<br />
<br />
''Tested with: 1.92+''<br />
<br />
This workaround uses JavaScript/jQuery to build a Time question just like to the Date one.<br />
<br />
Implementation is as follows:<br />
#Download the file at [http://trentrichardson.com/examples/timepicker/jquery-ui-timepicker-addon.js trentrichardson.com/examples/timepicker/jquery-ui-timepicker-addon.js] and upload it to your survey.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the following code in the source of a short text question.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script src="/upload/surveys/{SID}/jquery-ui-timepicker-addon.js"></script><br />
<br />
<script><br />
<br />
$(document).ready(function(){<br />
<br />
$('#answer{SGQ}').timepicker({<br />
timeText: 'Time', //here translation<br />
hourText: 'hour', //here translation<br />
minuteText: 'minute', //here translation<br />
closeText: 'Done' //here translation<br />
});<br />
<br />
$('#answer{SGQ}').attr('readonly', 'readonly');<br />
<br />
$( "<style>"<br />
+".ui-widget-header, .ui-datepicker-current { display:none; }"<br />
+".ui-timepicker-div dl dt { height: 25px; margin-bottom: -25px; }"<br />
+".ui-timepicker-div dl dd { margin: 0 10px 10px 65px; }"<br />
+" }"<br />
+"</style>").appendTo( "head" );<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Calculating date difference=<br />
<br />
''Tested with: 1.92+ Build 120909''<br />
<br />
This workaround explains how calculate difference between two dates (in: days, weeks, months and years) and is based on this [http://ditio.net/2010/05/02/javascript-date-difference-calculation/ resource external].<br />
<br />
Requieres 2 groups and 'group by group' or 'question by question' presentation.<br />
<br />
Group 1 (2 date questions)<br />
*1st question - Question code: "DD"<br />
*2nd question - Question code: "D2"<br />
<br />
Group 2<br />
*1 numerical input question.<br />
<br />
This question retrieves the number of days between the 2 dates, and check if D2 is posterior than DD.<br />
<br />
All the requiered code have to be added in the source of this numerical question.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
/*<br />
<br />
Adapted from http://ditio.net/2010/05/02/javascript-date-difference-calculation/<br />
*/<br />
<br />
var DateDiff = {<br />
<br />
inDays: function(d1, d2) {<br />
<br />
var t2 = d2.getTime();<br />
<br />
var t1 = d1.getTime();<br />
<br />
return parseInt[[t2-t1)/(24*3600*1000]];<br />
<br />
},<br />
<br />
inWeeks: function(d1, d2) {<br />
<br />
var t2 = d2.getTime();<br />
<br />
var t1 = d1.getTime();<br />
<br />
return parseInt[[t2-t1)/(24*3600*1000*7]];<br />
<br />
},<br />
<br />
inMonths: function(d1, d2) {<br />
<br />
var d1Y = d1.getFullYear();<br />
<br />
var d2Y = d2.getFullYear();<br />
<br />
var d1M = d1.getMonth();<br />
<br />
var d2M = d2.getMonth();<br />
<br />
return (d2M+12*d2Y)-(d1M+12*d1Y);<br />
<br />
},<br />
<br />
inYears: function(d1, d2) {<br />
<br />
return d2.getFullYear()-d1.getFullYear();<br />
<br />
}<br />
<br />
}<br />
<br />
d1 = new Date({substr(DD,0,4)}, {substr(DD,5,2)}, {substr(DD,8,2)});<br />
<br />
d2 = new Date({substr(D2,0,4)}, {substr(D2,5,2)}, {substr(D2,8,2)});<br />
<br />
// Displays result<br />
<br />
document.write("<br />Number of <b>days</b>: "+DateDiff.inDays(d1, d2));<br />
<br />
document.write("<br />Number of <b>weeks</b>: "+DateDiff.inWeeks(d1, d2));<br />
<br />
document.write("<br />Number of <b>months</b>: "+DateDiff.inMonths(d1, d2));<br />
<br />
document.write("<br />Number of <b>years</b>: "+DateDiff.inYears(d1, d2));<br />
<br />
// filled the numerical input with number of days (or nights)<br />
<br />
var nDays = +DateDiff.inDays(d1, d2);<br />
<br />
jQuery(document).ready(function() {<br />
<br />
$(".numeric:eq(0) input.text").val(nDays);<br />
<br />
$(".numeric:eq(0) input.text").attr('readonly','readonly');<br />
<br />
// check if d2 > d1<br />
<br />
$('#movenextbtn').hide();<br />
<br />
$('#movesubmitbtn').hide();<br />
<br />
if(nDays >= 0){<br />
<br />
// automatic submit (uncomment if needed)<br />
<br />
// document.limesurvey.submit();<br />
<br />
// $('body').hide();<br />
<br />
}<br />
<br />
else alert("Check out date must be posterior than Check in\nPlease return to the previous page and edit your answers");<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=How to set minDate/maxDate based on other Datequestions=<br />
<br />
'' tested with Version 2.00+ Build 130708''<br />
<br />
QQ1 and QQ2 are the question identifiers. QQ2 gets as maxDate today and as minDate the date set in QQ1. The onClose event is needed because on document.ready the value of QQ1 is not yet known, although the value of today is.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function () {<br />
'use strict';<br />
var qID1 = QQ1,<br />
qID2 = QQ2,<br />
q1 = $('#question' + 'QQ1' + ' .popupdate'), <br />
q2 = $('#question' + 'QQ2' + ' .popupdate');<br />
<br />
//if q1 loses focus, its value is taken and used as minDate in q2 <br />
q1.datepicker("option", "onClose", function (datum){<br />
q2.datepicker( "option", "minDate", datum );<br />
});<br />
//q2 gets today as its maxDate<br />
q2.datepicker( 'option', 'maxDate', new Date() );<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
=Remove Question Help if empty=<br />
<br />
''Version 2.00+ Build 130513''<br />
<br />
Change your question.pstpl in your Template Editor so that the line looks like below. I've added the ID tag help_{question_number}.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<tr><td class="survey-question-help" id=help_{QUESTION_NUMBER}>{QUESTIONHELP}</td></tr><br />
</syntaxhighlight><br />
<br />
You can then add the following javascript at the end of question.pstpl. If the contents of the help tag is empty then hide the element.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script><br />
$(document).ready(function(){<br />
if($('#help_{QUESTION_NUMBER}').is(':empty')){<br />
$('#help_{QUESTION_NUMBER}').hide();<br />
}<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
= Implicit Association Test (IAT)=<br />
<br />
''Tested with: 2.0, IE 7-10, Firefox, Chrome, iPad''<br />
<br />
This workaround uses JavaScript to insert an IAT interface into an Array (Texts) question. The workaround prompts respondents to assign words or phrases using the "E" or "I" keys. In mobile devices, "E" and "I" buttons are provided.<br /><br /><br />
<br />
[[File:Iat_1.png]]<br /><br /><br />
<br />
Download a [[Media:Demo_IAT_Concept.zip|working template]] and [[Media:Demo_iat_concept.lss|working survey]].<br />
<br />
Implementation is as follows:<br />
<br />
1) [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
<br />
2) Create your Array (Texts) with sub-questions as follows:<br /><br />
- Y scale - all of your "attribut" words or phrases<br /><br />
- X scale - "Key Pressed" and "Elapsed Time (ms)"<br /><br />
[[File:Iat_2.jpg]]<br />
<br />
3) Insert your association terms and the other text elements for the interface into the Question Help section as depicted below. The text strings must be separated with "double pipes" (||) and you will need to place them in the following order:<br /><br />
- Left association term<br /><br />
- Right association term<br /><br />
- Instructional text<br /><br />
- Finished text<br /><br />
[[File:Iat_3.png]]<br />
<br />
4) Add the following to the end of template.js:<syntaxhighlight lang="javascript" enclose="div"><br />
// A plugin to insert an IAT interface<br />
function implicitAssociation(el, showAnswers) {<br />
<br />
$(el).each(function() {<br />
<br />
var thisQuestion = $(this);<br />
var thisQuestionHelp = $('img[src$="help.gif"]', thisQuestion).parent();<br />
var thisQuestionAnswers = $('table.question', thisQuestion).parent();<br />
var startTime = '';<br />
var endTime = ''; <br />
var agent = navigator.userAgent.toLowerCase();<br />
var mobile = false;<br />
if( /android|webos|iphone|ipad|ipod|blackberry/i.test(navigator.userAgent) ) { // Mobile devices<br />
mobile = true;<br />
}<br />
mobile = true;<br />
<br />
// Some classes<br />
$(thisQuestion).addClass('iatQuestion');<br />
$('.subquestion-list').addClass('unanswered');<br />
<br />
// Hide the question help element<br />
$(thisQuestionHelp).hide();<br />
<br />
// Hide the answers<br />
if(showAnswers != true) {<br />
$('table.question', thisQuestion).hide();<br />
}<br />
<br />
// Insert IAT display<br />
var iatTexts = $(thisQuestionHelp).text().split('||');<br />
var iatDisplayHTML = '<div class="iatWrapper">\<br />
<div class="iatLeftLabel">'+iatTexts[0]+'</div>\<br />
<div class="iatRightLabel">'+iatTexts[1]+'</div>\<br />
<div class="iatWord"></div>\<br />
<div class="iatInstructions">'+iatTexts[2]+'</div>\<br />
</div>\<br />
<div class="iatMobileButtonWrapper">\<br />
<div class="iatButton iatLeftButton">E</div>\<br />
<div class="iatButton iatRightButton">I</div>\<br />
<div style="width:100%; clear:both;"></div>\<br />
</div>';<br />
$(thisQuestionAnswers).prepend(iatDisplayHTML);<br />
<br />
// Show a word<br />
function iatShowWord() {<br />
$('div.iatWord', thisQuestion).text($('.subquestion-list.unanswered:first .answertext', thisQuestion).text());<br />
startTime = new Date();<br />
<br />
$(document).bind('keypress.iatKeypress', function(e) {<br />
if(e.which == 101 || e.which == 105) {<br />
var thisRow = $('.subquestion-list.unanswered:eq(0)', thisQuestion);<br />
$(thisRow).removeClass('unanswered');<br />
endTime = new Date();<br />
$('input[type="text"]:eq(1)', thisRow).val(endTime.valueOf() - startTime.valueOf());<br />
if(e.which == 101) {<br />
$('input[type="text"]:eq(0)', thisRow).val('E');<br />
}<br />
else {<br />
$('input[type="text"]:eq(0)', thisRow).val('I');<br />
}<br />
$(document).unbind('keypress.iatKeypress');<br />
if($('.subquestion-list.unanswered', thisQuestion).length > 0) {<br />
iatShowWord();<br />
}<br />
else {<br />
$('.iatLeftLabel, .iatWord, .iatRightLabel, .iatInstructions', thisQuestion).fadeOut('slow', function() {<br />
$('div.iatWord', thisQuestion).text(iatTexts[3]);<br />
$('.iatWord', thisQuestion).addClass('done').fadeIn('slow');<br />
});<br />
}<br />
}<br />
});<br />
}<br />
function iatShowWordMobile() {<br />
$('div.iatWord', thisQuestion).text($('.subquestion-list.unanswered:first .answertext', thisQuestion).text());<br />
startTime = new Date();<br />
<br />
$('.iatButton', thisQuestion).bind('click.iatButtonClick', function(e) {<br />
var thisRow = $('.subquestion-list.unanswered:eq(0)', thisQuestion);<br />
$(thisRow).removeClass('unanswered');<br />
endTime = new Date();<br />
$('input[type="text"]:eq(1)', thisRow).val(endTime.valueOf() - startTime.valueOf());<br />
$('input[type="text"]:eq(0)', thisRow).val($(this).text());<br />
$('.iatButton', thisQuestion).unbind('click.iatButtonClick');<br />
if($('.subquestion-list.unanswered', thisQuestion).length > 0) {<br />
iatShowWordMobile();<br />
}<br />
else {<br />
$('.iatLeftLabel, .iatWord, .iatRightLabel, .iatInstructions, .iatMobileButtonWrapper', thisQuestion).fadeOut('slow', function() {<br />
$('div.iatWord', thisQuestion).text(iatTexts[3]);<br />
$('.iatWord', thisQuestion).addClass('done').fadeIn('slow');<br />
});<br />
}<br />
});<br />
}<br />
<br />
// Start the IAT display<br />
if(mobile == true) { // Mobile devices<br />
$('.iatMobileButtonWrapper', thisQuestion).show();<br />
$('.iatButton', thisQuestion).bind('click.iatStartMobile', function(e) {<br />
$('.iatButton', thisQuestion).unbind('click.iatStartMobile');<br />
iatShowWordMobile();<br />
});<br />
}<br />
else {<br />
$(document).bind('keypress.iatStart', function(e) { // Non-mobile devices<br />
if(e.which == 101 || e.which == 105) {<br />
$(document).unbind('keypress.iatStart');<br />
iatShowWord();<br />
}<br />
});<br />
}<br />
});<br />
} </syntaxhighlight><br />
<br />
<br />5) Add the following to the end of template.css:<syntaxhighlight lang="css" enclose="div"><br />
/* IAT questions */<br />
<br />
.iatWrapper {<br />
position: relative;<br />
width: 600px;<br />
height: 300px;<br />
color: #FFFFFF;<br />
background-color: #000000;<br />
font-size: 21px;<br />
}<br />
<br />
.iatLeftLabel {<br />
float: left;<br />
padding: 10px;<br />
}<br />
<br />
.iatRightLabel {<br />
float: right;<br />
padding: 10px;<br />
}<br />
<br />
.iatWord {<br />
position: absolute;<br />
width: 100%;<br />
top: 35%;<br />
text-align: center;<br />
font-size: 36px;<br />
color:#0F0;<br />
}<br />
<br />
.iatWord.done {<br />
color:#FFFFFF;<br />
}<br />
<br />
.iatInstructions {<br />
position: absolute;<br />
width: 100%;<br />
bottom: 0px;<br />
padding-bottom: 10px;<br />
text-align: center;<br />
}<br />
<br />
.iatMobileButtonWrapper {<br />
display: none;<br />
position: relative;<br />
width: 600px;<br />
font-size: 36px;<br />
}<br />
<br />
.iatButton {<br />
float: left;<br />
margin: 20px;<br />
width: 100px;<br />
padding: 2px 0 5px 0;<br />
border: 5px solid #999;<br />
-moz-border-radius: 10px;<br />
-webkit-border-radius: 10px;<br />
-khtml-border-radius: 10px;<br />
border-radius: 10px;<br />
text-align: center;<br />
line-height: normal;<br />
cursor: pointer;<br />
}<br />
<br />
.iatLeftButton {<br />
float: left;<br />
}<br />
<br />
.iatRightButton {<br />
float: right;<br />
}</syntaxhighlight><br />
<br />
<br />6) To apply the plugin, add one of the two scripts below to the question source:<br /><br />
- With hidden answer table (for normally activated survey)<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"> <br />
$(document).ready(function() {<br />
// Apply the IAT plugin to this question<br />
implicitAssociation('#question{QID}');<br />
}); <br />
</script></syntaxhighlight><br />
- With visible answer table (for testing purposes)<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"> <br />
$(document).ready(function() {<br />
// Apply the IAT plugin to this question<br />
implicitAssociation('#question{QID}', true);<br />
}); <br />
</script></syntaxhighlight><br />
<br />
<br />
=Make multiple choice easier=<br />
<br />
''Tested with Version 2.00 in Chrome, FF, Safar, IE''<br />
<br />
The problem:<br />
We often have multiple choice question, where the user has to select 4 elements out of 78 possible answers or 3 out of 25 and so on.<br />
If we use pen and paper version for this questions, we noticed that the participants go through the whole list and if an answer doesn't suit on the first sight, they cross it out.<br />
<br />
The solution:<br />
The script gives the participant the possibility to cross out this answers in a digital way. The script adds a small "X" before the checkbox. When it is clicked, the label text of the checkbox turns grey.<br />
(see the attached screenshot for an example)<br />
<br />
Here is the script, just add it to help text<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript"><br />
<br />
/**<br />
* Small script that adds a "X" before a checkbox. <br />
* On click the text color of the label of the checkbox turns grey<br />
* If the user has to choose some answers from many options, he can "delete" answers, that on first sight looks wrong<br />
* Add the script to the question in Limesurvey (for example within the source code of the help text)<br />
*/<br />
<br />
//Define the X (standard is a X in capitals)<br />
var x = "X";<br />
css_class = "x";<br />
<br />
/*<br />
* Define the style of the X<br />
* Of course you can define the style in the stylesheet - if so, the script ignores the following settings<br />
* If there is a style, than set style var to 1<br />
*/<br />
var style = 0;<br />
var size = "12px";<br />
var weight = "bold";<br />
var color = "red";<br />
var cursor = "pointer";<br />
<br />
//element type - standard is a span element<br />
var type = "span";<br />
<br />
//Define the new font color of the checkbox label<br />
label_color = "#bfbfbf";<br />
<br />
<br />
//End of configuration - start of the function<br />
<br />
//Define the element that is added<br />
if(style == 1) {<br />
ele = "<"+type+" class='"+css_class+"'>"+x+"</"+type+">";<br />
}<br />
else {<br />
ele = "<"+type+" class='"+css_class+"' style='font-size:"+size+"; font-weight:"+weight+"; color:"+color+"; cursor:"+cursor+";'>"+x+"</"+type+">";<br />
}<br />
<br />
//Get the standard font-color of the used style<br />
st_color = $("label").css("color");<br />
<br />
//insert the X before the checkboxes<br />
$(document).ready(function() { <br />
$("li").each(function(){<br />
$(this).prepend(ele);<br />
});<br />
});<br />
<br />
//bind an eventhandler on the X (delegate is used, because Limesurvey uses an old jQuery version)<br />
var css_class_c = "."+css_class;<br />
$(document).delegate(css_class_c,"click",function() {<br />
var color_check = $(this).siblings("label").data("color");<br />
if(color_check != "true") {<br />
$(this).siblings("label").css("color",label_color).data("color","true");<br />
$(this).siblings('input').attr('checked', false);<br />
<br />
}<br />
else {<br />
$(this).siblings("label").css("color",st_color).data("color","false");<br />
<br />
}<br />
});<br />
<br />
$(".checkbox").click(function () {<br />
$(this).siblings("label").css("color",st_color).data("color","false");<br />
});<br />
<br />
</script><br />
</syntaxhighlight></div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Workarounds:_Manipulating_a_survey_at_runtime_using_Javascript&diff=59823Workarounds: Manipulating a survey at runtime using Javascript2014-01-16T03:55:18Z<p>Jcleeland: /* Drag and Drop Ranking - Version 1.90 to 1.92 */ - Fix for later versions of 1.91+ where ranked responses were not saved</p>
<hr />
<div><br />
Often you want to manipulate certain elements of a survey at runtime. The only solution without touching the source code is to use JavaScript or jQuery which is shipped with LimeSurvey. Here are some examples to hide and style elements, validate user input or do calculations at runtime.<br />
<br />
Other workarounds can be found at<br />
* [[Workarounds: Survey behaviour]]<br />
* [[Workarounds: Question design, layout and templating]]<br />
<br />
<div class="simplebox"><center><br />'''Please keep in mind that these workarounds are not official LimeSurvey extensions - they are solutions that users have created for themselves.<br /><span style='color:#EE0000,#FFFFFF'>Therefore LimeSurvey can't offer guarantees or support for these solutions.</span><br />If you have questions, please contact the users that, thankfully, shared their solutions with the community.'''<br /><br /></center></div><br />
<br />
<div class="simplebox">Note: Version 1.92 implements many new features that make some existing workarounds obsolete. You can continue to use existing workarounds, but may want to consider switching over to using the new features (since those new features are officially supported, and the workarounds are not). Please review below for details of which are no longer needed.<br /><br /></div><br />
<br />
<div class="simplebox">Also Note: Version 1.92's Expression Manager (EM) may cause some of these work-arounds to fail. Any custom javascript included as a .js file will be fine. However, if you in-line your JavaScript code, you must make sure that you have a space after every opening (left) curly brace, and a space before every closing (right) curly brace. Otherwise, EM will think that the content between the curly braces is something it should parse and understand. I have fixed all of the work-arounds below that can be fixed (many did not follow those rules). However, some will continue to break. If a work-around contains a regular expression which contains curly braces (to indicate a range of repeats of a sub-expression), EM will try to process those curly braces, and thus break your regular expression. Strategies to continue to support that work-around functionality are discussed below.<br /><br /></div><br />
<br />
__TOC__<br />
<br />
=How to ''add'' a javascript workaround solution to this Wiki page?=<br />
<br />
Well, this is pretty easy. Click the edit icon and create your own headline within the javascript section starting with "'''!'''". Then add a short note about the version you have used when creating your workaround, you can copy/paste this code snippet <nowiki>''Tested with: (enter LimeSurvey version and maybe browser)''</nowiki>.<br />
<br />
Finally it's imported to mark all your code with code tags, other wise you might break this page.<br />
*Start tag: '''<nowiki><syntaxhighlight lang="php" enclose="div"></nowiki>'''<br />
*End tag: '''<nowiki></syntaxhighlight></nowiki>'''.<br />
<br />
=How to ''use'' Script (eg. JavaScript etc.) in LimeSurvey?=<br />
<br />
To use JavaScript within LimeSurvey, the XSS filter must be turned off and the code inserted in the source of a question or a group description.<br />
*Go to Global settings --> Security and set "Filter HTML for XSS" to "Off".<br />
* [http://docs.limesurvey.org/tiki-index.php?page=Adding+A+Question Add a new question]<br />
* Edit the question and click the "Source" button in the editor toolbar:<br />
<br />
[[File:editor_1.gif]]<br />
* Enter your script after the question text:<br />
<br />
[[File:editor_2.gif]]<br />
* Save the question<br />
<br />
A simple test to see if JavaScript is enabled is to echo an alert. Use this code:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
alert("Test!");<br />
<br />
</script></syntaxhighlight><br />
<br />
It is a good practice to use the jQuery $(document).ready function to prevent the code from executing until the page is fully loaded:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
alert("Test!");<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
It is also good practice to use jslint.com to get a good layout and design (e.q. no cluttering of name space)<br />
<br />
=Sum up input values using Javascript=<br />
<br />
''Tested with: ''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the sum() function in [[Expression Manager|Expression Manager]]. See this [[Expression Manager HowTos#Calculate assessment values at runtime and store the results in the survey data|HowTo example]].</div><br />
<br />
<div class="simplebox">Starting in Version 1.92, you also do no longer need to use SGQA (e.g. 45251X1X5) identifiers. Instead the code <code>{SGQ}</code> will automatically replaced by the current questions SGQA-codes.</div><br />
<br />
This is from a survey that is a invitation to a longer party, when the user clicks to the next page, the calculated results will be shown.<br />
<br />
If you wonder what the {INSERTANS:1X6X12} stuff is, look at [http://docs.limesurvey.org/tiki-index.php?page=SGQA+Identifier SGQA identifier] and [[Adding a question#Information from previous answers|Using information from previous answers]].<br />
<br />
<syntaxhighlight lang="html4strict" enclose="div"><br />
<br />
<div style="text-align: left">These are your answers:<br /><br />
<br />
<u></u><u></u><u></u><u></u><u>=<br />
<br />
<p><script LANGUAGE="JavaScript"><br />
<br />
partyprice = 3;<br />
<br />
beadclothprice = 3;<br />
<br />
breakfastprice = 7;<br />
<br />
lunchprice = 8;<br />
<br />
dinnerprice = 10;<br />
<br />
foodtotal = 0;<br />
<br />
var isreallytrue = "Yes";<br />
<br />
var noanswer = "No answer";<br />
<br />
document.write( "Can you come? = {INSERTANS:45251X1X1}<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X1}" == isreallytrue )<br />
<br />
{<br />
<br />
if ("{INSERTANS:45251X1X3}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X3}"; }<br />
<br />
partypeople = parseInt(answer);<br />
<br />
partytotal = partyprice * partypeople;<br />
<br />
document.write( "It's {INSERTANS:45251X1X3} persons who will come = " + partytotal + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X4}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X4}";}<br />
<br />
beadcloths = parseInt(answer);<br />
<br />
beadclothtotal = beadclothprice * beadcloths;<br />
<br />
document.write( "You want to borrow {INSERTANS:45251X1X4} beadcloths = " + beadclothtotal + "&euro;<BR>" );<br />
<br />
document.write( "Will you be there thursday? = {INSERTANS:45251X1X5}<BR>" );<br />
<br />
document.write( "On friday you will have these meals: <BR>" );<br />
<br />
if ("{INSERTANS:45251X1X71}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X71}";}<br />
<br />
breakfastfriday = parseInt(answer) * breakfastprice;<br />
<br />
document.write( "'''_ " + answer + " breakfeasts = " + breakfastfriday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X72}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X72}";}<br />
<br />
lunchfriday = parseInt(answer) * lunchprice ;<br />
<br />
document.write( "'''_ " + answer + " lunches = " + lunchfriday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X73}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X73}";}<br />
<br />
dinnerfriday = parseInt(answer)* dinnerprice ;<br />
<br />
document.write( "'''_ " + answer + " dinners = " + dinnerfriday + "&euro;<BR>" );<br />
<br />
foodtotal = breakfastfriday + lunchfriday + dinnerfriday;<br />
<br />
document.write( "Will you be there saturday? = {INSERTANS:45251X1X8}<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X8}" == isreallytrue )<br />
<br />
{<br />
<br />
document.write( "On saturday you will have these meals: <BR>" );<br />
<br />
if ("{INSERTANS:45251X1X91}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X91}"; }<br />
<br />
breakfastsaturday = parseInt(answer) * breakfastprice ;<br />
<br />
document.write("'''_ " + answer + " breakfeasts = " + breakfastsaturday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X92}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X92}"; }<br />
<br />
lunchsaturday = parseInt(answer) * lunchprice ;<br />
<br />
document.write( "'''_ " + answer + " lunches = " + lunchsaturday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X93}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X93}"; }<br />
<br />
dinnersaturday = parseInt(answer) * dinnerprice ;<br />
<br />
document.write( "'''_ " + answer + " dinners = " + dinnersaturday + "&euro;<BR>" );<br />
<br />
foodtotal = foodtotal + breakfastsaturday + lunchsaturday + dinnersaturday;<br />
<br />
}<br />
<br />
document.write( "Will you be there sunday? = {INSERTANS:45251X1X10}<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X10}" == isreallytrue )<br />
<br />
{<br />
<br />
document.write( "On sunday you will have these meals: <br>" );<br />
<br />
if ("{INSERTANS:45251X1X111}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X111}"; }<br />
<br />
breakfastsunday = parseInt(answer) * breakfastprice ;<br />
<br />
document.write( "'''_ " + answer + " breakfeasts = " + breakfastsunday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X112}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X112}"; }<br />
<br />
lunchsunday = parseInt(answer) * lunchprice ;<br />
<br />
document.write( "'''_ " + answer + " lunches = " + lunchsunday + "&euro;<BR>" );<br />
<br />
if ("{INSERTANS:45251X1X113}"== noanswer) { answer = 0; }<br />
<br />
else { answer = "{INSERTANS:45251X1X113}"; }<br />
<br />
dinnersunday = parseInt(answer) * dinnerprice ;<br />
<br />
document.write( "'''_ " + answer + " dinners = " + dinnersunday + "&euro;<p>" );<br />
<br />
foodtotal = foodtotal + breakfastsunday + lunchsunday + dinnersunday;<br />
<br />
}<br />
<br />
total = partytotal + beadclothtotal + foodtotal;<br />
<br />
document.write( "<h3>In total it will cost you " + total + "&euro;</h3><BR><br />
<br />
Put that sum in this bank account 1234 5678 9012" );<br />
<br />
}<br />
<br />
</SCRIPT></p><br />
<br />
</div></syntaxhighlight><br />
<br />
=Multiple Question Validation=<br />
<br />
''Tested with: ''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the min/max/equals_num_value attributes (to validate sums), or the em_validation_q function, which lets you refer to other variables when you validate the current question [[Expression Manager|Expression Manager]]. Such validations also work on the current page, and properly handle array_filter and cascading relevance.</div><br />
<br />
This workaround is in case you need to do some validation involving more than one question, it implies a very little JavaScript programming and the use of SGQA Identifiers; this should work on almost any version of LimeSurvey.<br />
<br />
Is easy to explain with an example, we need to do a survey of the percentage of males and females and we want to be sure that the sum is 100, to do this follow this steps (the necessary data that is not indicated in these instructions are not important i.e. question codes, etc.):<br />
#Create a new survey of type "group by group", set the "Show |<< Prev| button" to yes and note the SID.<br />
#Add a new group called "Group 1" and note the GID.<br />
#Add a new question "Percent of males" of type "numeric", make it mandatory and note the QID (we will refer to this as QID1).<br />
#Add a new question "Percent of females" of type "numeric", make it mandatory and note the QID (we will refer to this as QID2).<br />
#Add a new group called "Group 2"<br />
#Add a new non mandatory question, here is the trick the question text has to be (be sure to replace the SID, GID, QID1 and QID2<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script><br />
<br />
function validation()<br />
<br />
{<br />
<br />
if [[{INSERTANS:SIDXGIDXQID1}+{INSERTANS:SIDXGIDXQID2}) != 100)<br />
<br />
{<br />
<br />
alert("Your responses don't sum 100! Check them");<br />
<br />
document.limesurvey.move.value = 'moveprev';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
else<br />
<br />
{<br />
<br />
document.limesurvey.move.value = 'movelast';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
}<br />
<br />
setTimeout("validation()",250);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
But this will show shortly the question and will jump to the end page, a little weird for the survey taker but works.<br />
<br />
This is a proof of concept, and may have some problems, please if you notice something or improve it send me an e-mail to leochaton-limesurvey at yahoo dot com.<br />
<br />
This will work for 2 questions that you want to be the same. Works well for email and confirm email questions<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
function validation() {<br />
<br />
if ("{INSERTANS:SIDXGIDXQID}" != "{INSERTANS:SIDXGIDXQID}") {<br />
<br />
alert("Your responses don't match Check them"); document.limesurvey.move.value = 'moveprev';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
}<br />
<br />
setTimeout("validation()",250);<br />
<br />
</syntaxhighlight><br />
<br />
=Alternate exit=<br />
<br />
''Tested with: ''<br />
<br />
Using the same idea of the previous post, you can implement an alternate exit of your survey.<br />
<br />
This script should be in the first question to be displayed in a next page after the question that should trigger the alternate exit. In this example the question that trigger the alternate exit is a Yes/No question, if the user chooses no, he is redirected to another page.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
if ("{INSERTANS:SIDXGIDXQID}" == "No")<br />
<br />
{<br />
<br />
window.location="http://www.limesurvey.org";<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Custom onload function=<br />
<br />
''Tested with: 'All browsers', LimeSurvey 1.70 and up<br />
<br />
==General==<br />
<br />
This simple workaround describes how to '''add a custom Javascript code''' that is triggered right after the page is loaded. It may have numerous applications, especially when you deal with a custom JS/HTML code. It may be used to hide form elements (<input> tags), make them read-only, display alert messages, etc.<br />
<br />
To run any Javascript code right after page load use the Query ready() function. It will be executed when the page is being loaded. For example when you add the following code to one of your question definitions...:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
jQuery(document).ready(<br />
<br />
function(){<br />
<br />
alert('onload alert!');<br />
<br />
}<br />
<br />
);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
...it will display a pop-up message immediately after the page has been loaded.<br />
<br />
Some of the applications of this trick I've explored are:<br />
<br />
a) Hiding the form elements by calling in your Custom_On_Load:<br />
<br />
<syntaxhighlight lang="php" enclose="div">document.getElementById("answer73166X16X54").style.display='none';</syntaxhighlight><br />
<br />
Note: As of svn build 9755, you can now dynamically reference the questions input fields by using the {SGQ} keyword. You can rewrite the previous example like this:<br />
<br />
<syntaxhighlight lang="php" enclose="div">document.getElementById("answer{SGQ}").style.display='none';</syntaxhighlight><br />
<br />
this makes it a little easier when exporting surveys, so you don't have to worry about manually entering each questions SurveyGroupQuestion ID.<br />
<br />
b) Making the elements read only:<br />
<br />
<syntaxhighlight lang="php" enclose="div">document.getElementById("answer73166X16X54").readOnly=true;</syntaxhighlight> where the "answer73166X16X54" structure has been described in one of other workarounds above.<br />
<br />
c) For Hiding by a lot of elements by calling in your Customer_On_Load<br />
<br />
jQuery searchs in html document for input-fields with radio type, if his answer text empty then do the display css set to none.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
jQuery(document).ready(<br />
<br />
function() {<br />
<br />
jQuery('input:radio').each(<br />
<br />
function() {<br />
<br />
var s = jQuery(this);<br />
<br />
var c = s.parent().children('.answertext');<br />
<br />
for(var i=0; i < c.length; i++) {<br />
<br />
var a = jQuery(c[i]]);<br />
<br />
if(this.id </u> a.attr('for') && a.text() == '') {<br />
<br />
s.css({ 'display' : 'none' });<br />
<br />
a.css({ 'display' : 'none' });<br />
<br />
break;<br />
<br />
}<br />
<br />
}<br />
<br />
}<br />
<br />
)<br />
<br />
}<br />
<br />
);<br />
<br />
</syntaxhighlight><br />
<br />
==Advanced usage==<br />
<br />
If you want to place global Javascript code using the above jQuery(document).ready function then the best place to do this is the template javascript file template.js. You can edit this file using the template editor. Please be aware that placing it in the template javascript file will make the function available to all surveys using that template. If needed just create a new template copy for your survey.<br />
<br />
Alternatively you can place the jQuery(document).ready function in the group description to make a Javascript function only available to a certain question group.<br />
<br />
==Language-specific Javascript code==<br />
<br />
There is an easy way to find out the current language and execute according Javascript using jQuery: The <html> tag of any survey pages contains an 'lang' attribute which holds the current language code. You can read that language code by using the followin code<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
jQuery(document).ready(<br />
<br />
function(){<br />
<br />
languagecode=$('html').attr('lang');<br />
<br />
alert('This is the current language code: '+languagecode);<br />
<br />
}<br />
<br />
);<br />
<br />
</syntaxhighlight><br />
<br />
For an English survey the above code would show a messagebox with "This is the current language code: en"<br />
<br />
=Custom onload function in multi-language survey=<br />
<br />
''Tested with: 1.85+ (7253), IE 6/7, FireFox 3.0, Safari 3.2,''<br />
<br />
To use custom onload functions, as above, in multi-language surveys you must define the functions in the question source for '''all''' languages.<br />
<br />
While this initially seems to be a bit tedious, it actually can be useful - you can alter your onload functions depending on the language in use. For example, you can dynamically display alerts or element contents in the current language.<br />
<br />
=Skipping the welcome page=<br />
<br />
''Tested with: 1.85 (second code snippet)''<br />
<br />
<div class="simplebox">Note: As of version 1.91, there is a survey option letting you skip the welcome page, so this workaround is not needed.</div><br />
<br />
'''Solution 1:''' Include this Javascript in your welcome template, in the file welcome.pstpl for all welcome page, or in the source of the welcome text for one survey:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
jQuery(document).ready(function($) {<br />
<br />
document.limesurvey.move.value = 'movenext';<br />
<br />
document.limesurvey.submit(); });<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
It will reproduce the onclick event of the submit button and submit the form.<br />
<br />
Drawback of course is that users will see the page flashing up.<br />
<br />
Therefore, you may want to announce "... loading survey ..." as a description of your welcome page (in the admin interface when creating the survey), to pretend loading something big.<br />
<br />
'''Solution 2:'''<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
function custom_on_load(){<br />
<br />
document.limesurvey.move.value = 'movenext';<br />
<br />
document.limesurvey.submit();<br />
<br />
}<br />
<br />
window.setTimeout( 'custom_on_load()',1);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Filter answers of a question with the answer of another=<br />
<br />
===Method 1===<br />
<br />
''Tested with: 1.70 - 1.72''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the the array_filter attribute, or relevance equations in general.</div><br />
<br />
If you want to filter the answer of a question with another answer, you can use this workaround.<br />
<br />
First, use answer code like that: XX for the first question, and XXYYY for the second one.<br />
<br />
Answer of the second question filter if the 2 first letters are the answer of the first question.<br />
<br />
We use 1000X1X1 and 1000X1X2 for the example, question had to be on separate page (question by question for example).The second question had to be a dropdown list (we can do similar workaround, but droplis is the best). You can do this using JQuery. It leaves the answer in the select box, but disables it. You could also replace "disable" with "remove" to get rid of it altogether.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
var previousQuestionAnswer = "{INSERTANS:1000X1X1}";<br />
<br />
var currentQuestionID = "#answer1000X1X1"<br />
<br />
$(document).ready(function() {<br />
<br />
// See if the answer for the previous question matches an answer in the current question<br />
<br />
// (other than 'No Answer')<br />
<br />
// If so, disable it.<br />
<br />
if (previousQuestionAnswer!='No Answer') {<br />
<br />
$(currentQuestionID).children().each(function(index, Element)<br />
<br />
{<br />
<br />
if ($(this).attr('text') == previousQuestionAnswer)<br />
<br />
{ $(this).attr('disabled', true); }<br />
<br />
}<br />
<br />
);}<br />
<br />
}); // End of JQuery ready function<br />
<br />
</syntaxhighlight><br />
<br />
===Method 2===<br />
<br />
''Tested with 1.92 + Firefox 9.0''<br />
<br />
If you have a country, state, and city set of questions (or similar), you could code answer options as:<br />
<br />
'''Q1 Country''' ''Single choice list (ratio, dropdown)''<br />
<br />
X country#<br />
<br />
'''Q2 State''' ''Single choice list (dropdown)''<br />
<br />
XY state#<br />
<br />
'''Q3 City''' ''Single choice list (dropdown)''<br />
<br />
XYZZ city#<br />
<br />
Now you must put the following Javascript code in the source of question 2 (State):<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Get the countryCode (first character of the country)<br />
<br />
var countryCode = '{INSERTANS:1000X1X1}'.substr(0, 1).toUpperCase();<br />
<br />
// Loop through all dropdown options and remove those with codes not starting with the countryCode<br />
<br />
$('select[id<div class="simplebox">="answer"] option').each(function(i){<br />
<br />
if($(this).attr('value') && $(this).attr('value').substr(0, 1).toUpperCase() != countryCode) {<br />
<br />
$(this).remove();<br />
<br />
}<br />
<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
And the following code in the source of question 3 (City):<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Get the stateCode (two first characters of the state)<br />
<br />
var stateCode = '{INSERTANS:1000X1X2}'.substr(0, 2).toUpperCase();<br />
<br />
// Loop through all dropdown options and remove those with codes not starting with the stateCode<br />
<br />
$('select[id</div>="answer"] option').each(function(i){<br />
<br />
if($(this).attr('value') && $(this).attr('value').substr(0, 2).toUpperCase() != stateCode) {<br />
<br />
$(this).remove();<br />
<br />
}<br />
<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
Each question must be in different pages of survey to work, i.e. in a question by question survey, or in diferent groups in a group by group survey.<br />
<br />
Note that if you choose a two characters answer option code in the State question, i.e. a XYY answer option code, you must change the ''substr(0, 2)'' part of code in question 3 to ''substr(0, 3)''.<br />
<br />
=Filter answers of a multiple numeric type question=<br />
<br />
''Tested with: 1.90+''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the the array_filter attribute, or relevance equations in general. In 1.92, array_filter works with all questions that have sub-questions (e.g. also works for multiple numeric and multiple short text).</div><br />
<br />
If you want to filter a question of type "multiple numeric", you have to modify the workaround.<br />
<br />
Note that this workaround assumes that the code for each of the subquestions are a numeric sequence 1,2,3...<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function(){<br />
<br />
// Match elements with labels using htmlFor and a loop<br />
<br />
var labels = document.getElementsByTagName('LABEL');<br />
<br />
for (var i = 0; i < labels.length; i++) {<br />
<br />
if (labels[i].htmlFor != '') {<br />
<br />
var elem = document.getElementById(labels[i].htmlFor);<br />
<br />
if (elem)<br />
<br />
elem.label = labels[i];<br />
<br />
}<br />
<br />
}<br />
<br />
var answerFilter="{INSERTANS:96553X63X759}";<br />
<br />
for (i=0; i<30; i++){<br />
<br />
var iLabel = document.getElementById('answer96553X63X760'+(i+1]].label.innerHTML;<br />
<br />
if (answerFilter.search(iLabel) == -1){<br />
<br />
// Hide element<br />
<br />
$('#question760').find('li').eq(i).hide();<br />
<br />
// Set value of hidden elements to zero<br />
<br />
document.getElementById('answer96553X63X760'+(i+1)).value = 0;<br />
<br />
}<br />
<br />
}<br />
<br />
});</script><br />
<br />
</syntaxhighlight><br />
<br />
=Use an answer to prefill another question (default value)=<br />
<br />
''Tested with: 1.72''<br />
<br />
''And tested with: 1.91+''<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do using the enhanced defaults feature, which lets you pre-fill most question types with default values. In 1.91, you could set defaults for list and multiple choice questions. In 1.92, you can set defaults for any text-entry question too. Moreover, the defaults can be [[Expression Manager|Expression Manager]] compatible equations or tailored text. Finally, with 1.92, defaults are properly managed even when set on the same page.</div><br />
<br />
This workaround gives you the ablility to use an answer to fill the default value for another question. It's explained for free text question type but can be adapted for another question type.<br />
<br />
We use SGQA identifier. For example, we use SGQA 1000X10X20 and 1000X10X21 to prefill 1000X11X30 and 1000X11X31. For the script to work, the question has to be on a different page.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answer1000X11X30').val('{INSERTANS:1000X10X20}');<br />
<br />
$('#answer1000X11X31').val('{INSERTANS:1000X10X21}');<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
If you want use two times the value of an integer input, you can also use this to prefill a question that you hide via CSS.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answer1000X2X2').val(parseInt('{INSERTANS:1000X1X1}')*2);<br />
<br />
$("#question2").hide();<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
Now you can use {INSERTANS:1000X2X2} for giving you twice the value of the user input from question 1.<br />
<br />
=Dynamic Sum=<br />
<br />
<div class="simplebox">As of version 1.92, this is easier to do with [[Expression Manager|Expression Manager]] using the sum() function. Not only will sums be dynamic, but they wille exclude irrelevant values, so you can array_filter a multiple numeric question and get the sum of just the answers that are visible. This [[Expression Manager HowTos#Calculate assessment values at runtime and store the results in the survey data|HowTo example]] demonstrates the dynamic sum feature.</div><br />
<br />
<div class="simplebox">Also note, as of version 1.92, the following workaround will fail, since it includes a a regular expression containing curly braces.</div><br />
<br />
This script is used with a "Multiple Options" type question calculate a total price based on how which checkboxes are selected. The prices are listed as part of the answer. The answers are set up like this: "USB Mouse ($20)". The script uses the number between the "($" and the ")" as the price for that item. You can adapt the script to if you need to change the currency or need to sum something other than money.<br />
<br />
This script works when used in a question-by-question format. It does not work when there are more than one question on a page. I think it can be adapted to work, but I haven't done the coding yet.<br />
<br />
Put the following code into body of your question:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script language=Javascript><br />
<br />
// General definitions<br />
<br />
// Define a regular expression to match the labels containing information about an answer<br />
<br />
// In LimeSurvey, these labels start with "answer..."<br />
<br />
var answerRegex = /^answer/;<br />
<br />
// Find all answer checkboxes in the document and set their<br />
<br />
// onchange events to updatePrice<br />
<br />
function Custom_On_Load()<br />
<br />
{<br />
<br />
// Find all input elements<br />
<br />
var inputList=document.getElementsByTagName("input");<br />
<br />
// Loop through each, looking for checkboxes<br />
<br />
var i;<br />
<br />
for( i=0; i< inputList.length;i++ )<br />
<br />
{<br />
<br />
// If input item does not have an ID, skip<br />
<br />
if (! (inputList[i].id)) { continue; }<br />
<br />
// Skip to next if ID doesn't start with "answer"<br />
<br />
if (!answerRegex.test(inputList[i].id)) { continue; }<br />
<br />
// Skip to next if not a checkbox<br />
<br />
if (inputList[i].type.toUpperCase()!='CHECKBOX') { continue; }<br />
<br />
// This is an answer checkbox!<br />
<br />
// Setup onchange event<br />
<br />
inputList[i].onclick = updatePrice;<br />
<br />
}<br />
<br />
// Load initial sum<br />
<br />
updatePrice();<br />
<br />
}<br />
<br />
function updatePrice()<br />
<br />
{<br />
<br />
var labels=document.getElementsByTagName("LABEL");<br />
<br />
// Define a regular expression to match a price inside parenthesis<br />
<br />
// For example: ($29) or ($29.54).<br />
<br />
// Set up<br />
<br />
priceRegex = /\(\$(\d*\.{0,1}\d+)\)/;<br />
<br />
// Loop through all the labels, looking for labels corresponding to<br />
<br />
// answers that have a price in them.<br />
<br />
var i;<br />
<br />
var total = 0;<br />
<br />
for( i=0; i<labels.length;i++ )<br />
<br />
{<br />
<br />
var myArray; // Define array used for regex matching<br />
<br />
var inputID; // Define field element<br />
<br />
// Get the ID of the field corresponding to the label using the<br />
<br />
// "htmlFor" attribute<br />
<br />
// (FYI, there are some labels that will have to be screened out<br />
<br />
// because they don't correspond to an answer)<br />
<br />
// Does the label start with "answer"?<br />
<br />
// If not: exit.<br />
<br />
if (!answerRegex.test(labels[i].htmlFor)) { continue; }<br />
<br />
// First make sure this element exists<br />
<br />
// If it doesn't, go to the next element<br />
<br />
// If it does, it will be defined in inputID<br />
<br />
if (! (inputID = document.getElementById(labels[i].htmlFor)) ) { continue; }<br />
<br />
// See if the corresponding answer is a checkbox that is checked.<br />
<br />
// If not, go to next label<br />
<br />
if (inputID.type.toUpperCase()!='CHECKBOX') { continue; }<br />
<br />
if (!inputID.checked) { continue; }<br />
<br />
// This is label for an answer.<br />
<br />
// The innerHTML will give us the text of the label<br />
<br />
// The price information will be in the form ($XX.XX)<br />
<br />
// which in contained in the label text.<br />
<br />
// Find a match for a decimal number inside the pattern "($" and ")"<br />
<br />
if [[myArray = priceRegex.exec(labels[i].innerHTML]] != null)<br />
<br />
{<br />
<br />
// Keep a running tally<br />
<br />
total += parseFloat(myArray[1]);<br />
<br />
}<br />
<br />
}<br />
<br />
// Update total price on form<br />
<br />
document.getElementById("totalPrice").value = "$" + formatCurrency(total);<br />
<br />
}<br />
<br />
function formatCurrency(num) {<br />
<br />
num = isNaN(num) || num <u> '' || num </u> null ? 0.00 : num;<br />
<br />
return parseFloat(num).toFixed(2);<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
Put the following code in the help section (or wherever you want the sum to appear):<br />
<br />
<syntaxhighlight lang="php" enclose="div">Total Cost for selected accessories: <input type="readonly" value="" id="totalPrice" /></syntaxhighlight><br />
<br />
=Focus on the first Input field=<br />
<br />
(''Tested with: LimeSurvey 1.80 / IE6/7, Firefox 3, Safari, Opera, chrome'')<br />
<br />
<div class="simplebox">As of version 1.91, there is a built-in JavaScript function called focusFirst() to focus on the first visible element. It uses jQuery, so is more robust than this example.</div><br />
<br />
Again an onload Function is needed for this tasks. I have done it the DOM way with compatibility to IE6/7.<br />
<br />
Put the following code into the startpage.pstpl of your template, right before the </head> closing tag:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
function focusFirst(Event)<br />
<br />
{<br />
<br />
var i=0;<br />
<br />
while(document.forms[0].elements[i].type == "hidden")<br />
<br />
{<br />
<br />
i++;<br />
<br />
}<br />
<br />
document.forms[0].elements[i].focus();<br />
<br />
return;<br />
<br />
}<br />
<br />
if(ie)<br />
<br />
{ window.attachEvent("onload", focusFirst); }<br />
<br />
else<br />
<br />
{ document.addEventListener("load", focusFirst, true); }<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
'''Note:''' I am using this with version 1.80. As changes happened to the templates in the last release, you might need to add the following before the code, if your template is older than 1.80 stable and does not include this:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
var ie = false;<br />
<br />
</script><br />
<br />
<br />
<br />
</syntaxhighlight><br />
<br />
You will need this for the var ie to be set. Without this var, the function will not work with ie.<br />
<br />
=Answer questions by keypress=<br />
<br />
(''Tested with: IE7, Firefox 3'')<br />
<br />
This workaround allow to answer the question on key 0-9 (0 is for the 10 answer).<br />
<br />
Follow issues are supported at the moment:<br />
*Yes-No Questions<br />
*List Questions (radio)<br />
*other radio questions<br />
<br />
In lists the answer limit is ten.<br />
<br />
You supply the template "endpage" of your template with the following script.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
jQuery(document).ready(function() {<br />
<br />
jQuery(document).bind('keypress', function(e){<br />
<br />
if (48 <= e.which && e.which <= 57) {<br />
<br />
jQuery('input:radio').each(function() {<br />
<br />
var v = jQuery(this).val();<br />
<br />
var c = (e.which <u> 48) ? 10 : e.which - 48;<br />
<br />
if(v </u> 'Y' || v <u> 'N') {<br />
<br />
v = (v </u> 'Y') ? 1 : 2;<br />
<br />
}<br />
<br />
if(v == c) {<br />
<br />
jQuery(this).click();<br />
<br />
jQuery('#limesurvey input:submit').click();<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
})<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Math notation in LimeSurvey=<br />
#download the js file from [http://mathcs.chapman.edu/~jipsen/mathml/asciimathdownload.html AsciiMath script]<br />
#copy it in the /scripts/ folder in your installation<br />
#modify the startpage.psptl of the template you want to use adding the reference to the script (if you use an older version make sure that you copy the template folder first!) for example:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" src="ASCIIMathML.js"><br />
<br />
</syntaxhighlight><br />
<br />
Use the notation where you need it!<br />
<br />
'''Note:''' If you use internet explorer or safari you will need to download the plugin as well, but firefox does the lot for you.<br />
<br />
Finally, if you are confident with the limesurvey structure you could add the editor which support math notation and change the reference to the editor you want to use in the configuration file. here is the [http://www.imathas.com/editordemo/demo.html link for a TinyMCE with math support].<br />
<br />
=Reverse array_filter (for pre-1.90)=<br />
<br />
''Tested with: 1.85+ (7253), IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
<div class="simplebox">Note: Version 1.91 natively supports this functionality via the array_filter_exclude advanced quation option.</div><br />
<br />
This can be used to filter the answers of an array question to be displayed based on the answers of a multi option question that were '''NOT''' selected. A possible application would be to have a multi-option question asking which products were purchased, followed by 2 array questions - one asking to rate the purchased products and another asking why the remaining products were not purchased. Another would be to ask about sessions attended at a conference as in [http://www.limesurvey.org/en/forum/5-can-i-do-this-with-limesurvey/27970-reverse-of-arrayfilter.html this forum thread] and pictured below. There is a live [http://www.partnersinc.biz/surveys//index.php?sid=43358&newtest=Y&lang=en demo here]<br />
<br />
[[File:sessions_645x344.gif]]<br />
<br />
We'll use the above example to explain the process as follows:<br />
#In group 1 - Create a ''SessionsAttended'' multi-options question<br />
#In group 1 - Create a ''SessionsNotAttended'' multi-options question with identical answers as ''SessionsAttended'' and hide it with styles or conditions<br />
#In group 2 - Create a ''RateSessionsAttended'' array question with an [http://docs.limesurvey.org/tiki-index.php?page=Question+attributes&structure;=English+Instructions+for+LimeSurvey#array_filter array_filter] based on ''SessionsAttended''<br />
#In group 2 - Create a ''ReasonNotAttended'' array question with an [http://docs.limesurvey.org/tiki-index.php?page=Question+attributes&structure;=English+Instructions+for+LimeSurvey#array_filter array_filter] based on ''SessionsNotAttended''<br />
#In group 1 - Place JavaScript/jQeury listeners on each of the checkboxes in ''SessionsAttended'' that would toggle the corresponding checkbox in ''SessionsNotAttended'' to the opposite state<br />
<br />
The JavaScript/jQuery code used would be:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
// The toggle function<br />
<br />
function toggle(q1, q2) {<br />
<br />
if ($(q1).attr('checked') == false ) {<br />
<br />
$(q2).attr('checked', true);<br />
<br />
}<br />
<br />
else {<br />
<br />
$(q2).attr('checked', false);<br />
<br />
}<br />
<br />
}<br />
<br />
// Initialize the SessionNotAttended checkboxes to "checked"<br />
<br />
toggle ('#answer11111X22X331', '#answer11111X22X441');<br />
<br />
toggle ('#answer11111X22X332', '#answer11111X22X442');<br />
<br />
toggle ('#answer11111X22X333', '#answer11111X22X443');<br />
<br />
toggle ('#answer11111X22X334', '#answer11111X22X444');<br />
<br />
// The jQuery listeners on the SessionAttended checkboxes<br />
<br />
// that toggle the SessionNotAttended checkboxes<br />
<br />
$('#answer11111X22X331').change(function() {<br />
<br />
toggle ('#answer11111X22X331', '#answer11111X22X441');<br />
<br />
});<br />
<br />
$('#answer11111X22X332').change(function() {<br />
<br />
toggle ('#answer11111X22X332', '#answer11111X22X442');<br />
<br />
});<br />
<br />
$('#answer11111X22X333').change(function() {<br />
<br />
toggle ('#answer11111X22X333', '#answer11111X22X443');<br />
<br />
});<br />
<br />
$('#answer11111X22X334').change(function() {<br />
<br />
toggle ('#answer11111X22X334', '#answer11111X22X444');<br />
<br />
});<br />
<br />
</syntaxhighlight><br />
<br />
Some notes about the code:<br />
*The code is in an onload function defined in the first question of group 1 - see [[Workarounds#Custom_onload_function|here]]<br />
*Both ''SessionsAttended'' and ''SessionsNotAttended'' must be in the same group for the toggling to work<br />
*This case only uses 4 checkboxes but could be expanded as required<br />
*In this case the survey ID is 11111, the group ID is 22, ''SessionsAttended'' ID is 33 and SessionsNotAttended ID is 44 - these would need to be modified for your survey<br />
*The toggle function looks for the state of a checkbox in ''SessionsAttended'' and sets the corresponding checkbox in ''SessionsNotAttended'' to the opposite state<br />
*The "Initialize" section sets the state of ''SessionsNotAttended'' checkboxes whenever we navigate to the group<br />
*The "Listener" section uses jQuery listeners to detect any change in the ''SessionsAttended'' checkboxes and then toggle the corresponding ''SessionsNotAttended'' checkbox<br />
<br />
Some general notes about the questions:<br />
*CSS can be used to hide ''SessionsNotAttended'' (div#question44 { display: none; }) if you don't want to use conditions (because maybe you've got [[Optional settings#Survey Behavior|$deletenonvalues set to 1]])<br />
*''RateSessionsAttended'' and ''ReasonNotAttended'' are another group to avoid things popping in and out of existence as ''SessionsAttended'' is answered<br />
*[[Setting conditions|Conditions]] are used to ensure that ''RateSessionsAttended'' only appears if some sessions are selected and ''ReasonNotAttended'' only appears if no sessions are selected<br />
<br />
=Filter Ranking Question With Multiple-Options (pre 1.92)=<br />
<br />
''Tested with: 1.90, IE 7/8, FireFox 3/4, Safari 5.0, Chrome 10.0''<br />
<br />
<div class="simplebox">As of version 1.92, most of this is easier to do using the the array_filter attribute, or relevance equations in general. They all work on the same page, and fully support cascading relevance.</div><br />
<br />
This workaround applies a filter to a ranking question based on the checked boxes of a previous multiple-options question. There are two methods - one for filter and ranking questions being on the same page and a slightly different one for the filter question being on a page before the ranking question.<br />
<br />
There is a [http://www.partnersinc.biz/surveys//index.php?sid=96314&newtest=Y&lang=en demo of both methods here].<br />
<br />
Implementation is as follows.<br />
<br />
'''FOR BOTH METHODS:'''<br />
*[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
*Place the following script in your template.js file. This function will be accessed by either method.<syntaxhighlight lang="javascript" enclose="div"><br />
// A function to filter choices in a ranking question<br />
function rankFilter(q1ID, q2ID, prevPage) {<br />
<br />
// If filter question is on a previous page, hide Q1 and check all "visible" boxes<br />
if(prevPage == 1) {<br />
$('#question'+q1ID+' li[id<div class="simplebox">="javatbd"]:visible input.checkbox').attr('checked', true);<br />
$('#question'+q1ID+'').hide();<br />
}<br />
<br />
handleChecked(q1ID, q2ID);<br />
$('#question'+q1ID+' input.checkbox').click(function() {<br />
handleChecked(q1ID, q2ID);<br />
});<br />
<br />
function handleChecked(q1ID, q2ID) {<br />
<br />
// Find the survey and group IDs<br />
if($( 'input#fieldnames' ).length != 0) {<br />
var fieldNames = $( 'input#fieldnames' ).attr('value');<br />
var tmp = fieldNames.split('X');<br />
var sID = tmp[0];<br />
var gID = tmp[1];<br />
}<br />
<br />
// Loop through all Q1 options<br />
$('#question'+q1ID+' input.checkbox').each(function(i) {<br />
<br />
// Find the answer code and value<br />
var tmp2 = $(this).attr('id').split('X'+gID+'X'+q1ID+'');<br />
var ansCode = tmp2[1];<br />
var ansTxt = $(this).next('label').text();<br />
<br />
// If option is checked and not in rank choices or output, add it to the rank choices<br />
if($(this).attr('checked') == true<br />
&& $('#question'+q2ID+' select.select option[value="'+ansCode+'"]').length == 0<br />
&& $('#question'+q2ID+' .output input[id</div>="fvalue_"][value="'+ansCode+'"]').length == 0) {<br />
$('<option value="'+ansCode+'">'+ansTxt+'</option>').appendTo('#question'+q2ID+' select.select');<br />
}<br />
<br />
// If option is unchecked...<br />
else if($(this).attr('checked') == false) {<br />
// Remove it from the rank choices<br />
$('#question'+q2ID+' select.select option[value="'+ansCode+'"]').remove();<br />
// Remove it from the rank output and reset hidden values<br />
$('#question'+q2ID+' .output input[id<div class="simplebox">="fvalue_"][value="'+ansCode+'"]').attr('value', '').siblings('input.text').val('').siblings('img').hide();<br />
}<br />
});<br />
<br />
// Clean up empty inputs in the rank output table<br />
$('#question'+q2ID+' .output table tr').each(function(i) {<br />
var nextRow = $(this).next('tr');<br />
if($('input.text', this).val() == '' && $('input.text', nextRow).val() != '') {<br />
$('input.text', this).val($('input.text', nextRow).val());<br />
$('input.text', nextRow).val('');<br />
$('input[id</div>="fvalue_"]', this).attr('value', $('input[id<div class="simplebox">="fvalue_"]', nextRow).attr('value'));<br />
$('input[id</div>="fvalue_"]', nextRow).attr('value', '');<br />
}<br />
});<br />
<br />
// Show the scissors for the last populated rank output row<br />
$('#question'+q2ID+' .output table img[id<div class="simplebox">="cut_"]').hide();<br />
$('#question'+q2ID+' .output table input.text[value!=""]:last').siblings('img[id</div>="cut_"]').show();<br />
<br />
// Hide extra rank output rows<br />
var optNum = $('#question'+q1ID+' input.checkbox:checked').length;<br />
$('#question'+q2ID+' .output table tr').hide();<br />
$('#question'+q2ID+' .output table tr:lt('+(optNum+1)+')').show();<br />
<br />
// Hide and clear the ranking question if there are less than 2 checked options in Q1<br />
if(optNum < 2) {<br />
$('#question'+q2ID+'').hide();<br />
$('#question'+q2ID+' input.text').val('');<br />
$('#question'+q2ID+' input[id<div class="simplebox">="fvalue_"]').attr('value', '');<br />
}<br />
else {<br />
$('#question'+q2ID+'').show();<br />
}<br />
<br />
// A workaround for the built in max-answers function<br />
$('#question'+q2ID+' select.select').attr('disabled', true);<br />
$('#question'+q2ID+' td.output tr:visible').each(function(i) {<br />
if($('input.text', this).val() == '') {<br />
$('#question'+q2ID+' select.select').attr('disabled', false);<br />
}<br />
});<br />
}<br />
<br />
// A listener to work around the built in max-answers function<br />
$('#question'+q2ID+' td.rank').click(function (event) {<br />
$('#question'+q2ID+' select.select').attr('disabled', true);<br />
$('#question'+q2ID+' td.item input.text').each(function(i) {<br />
if ($(this).val() == '') {<br />
$('#question'+q2ID+' select.select').attr('disabled', false);<br />
}<br />
});<br />
});<br />
}</syntaxhighlight><br />
<br />
'''FOR BOTH FILTER AND RANKING QUESTIONS ON SAME PAGE:'''<br />
*Create a multiple options question and a ranking question on the same page (in the same group).<br />
*Both questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Place the following script in the source of one of the questions.<br />
*Replace "MM" with the ID of the multiple options question and "RR" with the ID of the ranking question.<br />
*The function will hide the ranking question unless at least two options are selected in the multiple options question, in which case, it will only show the options selected.<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
rankFilter(MM, RR);<br />
});<br />
</script></syntaxhighlight><br />
<br />
'''FOR FILTER AND RANKING QUESTIONS ON SEPARATE PAGES:'''<br />
*Create a multiple options question on page 1.<br />
*Create a multiple options question and a ranking question on page 2.<br />
*All three questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Set the multiple options on page 2 to be filtered by the multiple options on page 1.<br />
*Place the following script in the source of one of the questions on page 2.<br />
*Replace "MM" with the ID of the multiple options question and "RR" with the ID of the ranking question. Do not modify the "1".<br />
*The function will hide the multiple options question. If at least 2 options were selected in the multiple options on page 1, the corresponding options will be checked in the hidden multiple options question which will then be used to control the display of the ranking question.<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function() {<br />
rankFilter(MM, RR, 1);<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Filter "Array by Column" Question With "Multiple-Options"=<br />
<br />
''Tested with: 1.91, IE 7/8, FireFox 3/4, Safari 5.0, Chrome 10.0''<br />
<br />
This workaround applies a filter to an "Array by Column" question based on the checked boxes of a previous multiple-options question. There are two methods - one for filter and array questions being on the same page and a slightly different one for the filter question being on a page before the array question.<br />
<br />
There is a [http://www.partnersinc.biz/surveys//index.php?sid=74213&newtest=Y&lang=en demo of both methods here].<br />
<br />
Implementation is as follows.<br />
<br />
'''FOR BOTH METHODS:'''<br />
*[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
*Place the following scripts in your template.js file. These functions will be accessed by either method.<syntaxhighlight lang="javascript" enclose="div"><br />
$(document).ready(function() {<br />
<br />
function filterArrByCol(qMultiOpt, qArray, prevPage) {<br />
<br />
// If filter question is on a previous page, hide Q1 and check all "visible" boxes<br />
if(prevPage == 1) {<br />
$('#question'+qMultiOpt+' li[id</div>="javatbd"]:visible input.checkbox').attr('checked', true);<br />
$('#question'+qMultiOpt+'').hide();<br />
}<br />
<br />
// Assign classes to the answer cells<br />
$('#question'+qArray+' table.question tbody td').each(function(i){<br />
var classArr = $(this).attr('class').split('answer_cell_00');<br />
var ansCode = classArr[1];<br />
$(this).addClass('ans-'+ansCode+' filtered');<br />
});<br />
<br />
// Assign classes to the answer label cells<br />
$('#question'+qArray+' table.question tbody tr:eq(0) td').each(function(i){<br />
var classArr2 = $(this).attr('class').split(' ans-');<br />
var ansCode2 = classArr2[1];<br />
$('#question'+qArray+' table.question thead tr:eq(0) th:eq('+i+')').addClass('ans-'+ansCode2+'');<br />
});<br />
<br />
// Fire the filter function on page load<br />
filterArr(qMultiOpt, qArray);<br />
<br />
// Listener on multi-opt checkboxes to fire the filter function<br />
$('#question'+qMultiOpt+' input.checkbox').click(function(){<br />
filterArr(qMultiOpt, qArray);<br />
});<br />
<br />
// On submit, clear all hidden radios of array<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
$('#question'+qArray+' td.filtered:hidden').each(function(i){<br />
$('input.radio', this).attr('checked', false);<br />
});<br />
return true;<br />
});<br />
}<br />
<br />
function filterArr(qMultiOpt, qArray) {<br />
<br />
if($('#question'+qMultiOpt+' input.checkbox:checked').length < 1) {<br />
// Hide the array if no multi-opt options are checked<br />
$('#question'+qArray+'').hide();<br />
}<br />
else {<br />
$('#question'+qArray+'').show();<br />
<br />
// Hide all columns of array<br />
$('#question'+qArray+' table.question tbody td, #question'+qArray+' table.question thead th').hide();<br />
<br />
// Loop through multi-opt checkboxes and, if checked, show corresponding column of array<br />
$('#question'+qMultiOpt+' input.checkbox').each(function(i){<br />
if($(this).attr('checked') == true) {<br />
var classArr3 = $(this).attr('id').split('X'+qMultiOpt);<br />
var ansCode3 = classArr3[1];<br />
$('#question'+qArray+' .ans-'+ansCode3+'').show();<br />
}<br />
});<br />
}<br />
}<br />
});</syntaxhighlight><br />
<br />
'''FOR BOTH FILTER AND ARRAY QUESTIONS ON SAME PAGE:'''<br />
*Create a multiple options question and an array-by-column question on the same page (in the same group).<br />
*Both questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Place the following script in the source of one of the questions.<br />
*Replace "MM" with the ID of the multiple options question and "AA" with the ID of the ranking question.<br />
*The function will hide the array question unless at least one option is selected in the multiple-options question, in which case, it will only show the corresponding array column(s).<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function() {<br />
filterArrByCol(MM, AA);<br />
});<br />
</script></syntaxhighlight><br />
<br />
'''FOR FILTER AND ARRAY QUESTIONS ON SEPARATE PAGES:'''<br />
*Create a multiple options question on page 1.<br />
*Create a multiple options question and an array-by-column question on page 2.<br />
*All three questions '''MUST''' have identical sub-questions and sub-question codes.<br />
*Set the multiple options on page 2 to be filtered by the multiple options on page 1.<br />
*Place the following script in the source of one of the questions on page 2.<br />
*Replace "MM" with the ID of the multiple options question and "AA" with the ID of the array question. Do not modify the "1".<br />
*The function will hide the multiple options question. If options were selected in the multiple options on page 1, the corresponding options will be checked in the hidden multiple options question which will then be used to control the display of the array columns.<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function() {<br />
filterArrByCol(MM, AA, 1);<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Auto-tabbing between text input fields=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
This is a workaround to facilitate auto-tabbing between text input questions in a single group using a [http://plugins.jquery.com/project/autotab jQuery plugin by Mathachew] and the Maximum characters attribute of questions.<br />
<br />
The behaviour will be: When the maximum number of characters has been entered into an input field, the focus (cursor) will be automatically moved to the next input field. When the backspace key is used to remove all characters from a field, the focus will be moved to the previous field. It's very useful in surveys having many text input questions to avoid having to manually tab or click between fields.<br />
<br />
You can view a small demo survey [http://www.partnersinc.biz/surveys//index.php?sid=11327&newtest=Y&lang=en here].<br />
<br />
Implementation is as follows:<br />
#Visit [http://plugins.jquery.com/autotabs http://plugins.jquery.com/autotabs], download the plugin script and save it as ''jquery.autotab-1.1b.js'' in the template folder.<br />
#Link to the script by placing ''<script type="text/javascript" src="{TEMPLATEURL}jquery.autotab-1.1b.js"></script>'' within the ''<head>'' tag of startpage.pstpl.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Create the text based questions that auto-tabbing is to be applied to. (All must be in the same group if you're using group by group presentation)<br />
#Define a Maximum characters attribute for all questions that the autotab is applied to.<br />
{{QS:maximum_chars}} <br />
#In the source of the first question of the group that contains the auto-tabbed questions, add the following code.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answerSSSSSXGGXAA').focus(); //initially focus on the first input<br />
<br />
$('#answerSSSSSXGGXAA').autotab({ target: 'answerSSSSSXGGXBB' });<br />
<br />
$('#answerSSSSSXGGXBB').autotab({ previous: 'answerSSSSSXGGXAA', target: 'answerSSSSSXGGXCC' });<br />
<br />
$('#answerSSSSSXGGXCC').autotab({ previous: 'answerSSSSSXGGXBB', target: 'answerSSSSSXGGXDD' });<br />
<br />
$('#answerSSSSSXGGXDD').autotab({ previous: 'answerSSSSSXGGXCC' });<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
This example has 4 fields to be auto-tabbed between - all instances of the following must be replaced to be compatible with your survey (See image below):<br />
*SSSSS -> Survey ID<br />
*GG -> Group ID<br />
*AA -> First question<br />
*BB -> Second question<br />
*CC -> Third question<br />
*DD -> Last question<br />
<br />
[[File:ids_343x252.gif]]<br />
<br />
The ''target'' parameter defines where the next input is and the ''previous'' parameter defines (you guessed it) the previous input.<br />
<br />
This plugin also has limited capability of formatting the input text - see comments in the plugin script.<br />
<br />
=Custom response listeners=<br />
<br />
''Tested with: 1.85+ (7253), IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
Listeners can be used to perform functions when a change in an input is detected. There are many uses such as the [[Workarounds#Reverse_array_filter|Reverse array_filter]] but a simple one would be to warn a respondent if they enter a value that may be too high.<br />
<br />
We can use the [http://docs.jquery.com/Events/change jQuery change( ) event] to fire a function whenever there is a change to the input. The function will look for an input value higher than 10 and, if found, will warn the respondent.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the script below in the source of one of the questions on the page where:<br />
**11111 is the survey ID<br />
**22 is the group ID<br />
**33 is the question ID<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('#answer11111X22X33').change(function() {<br />
<br />
if ( $('#answer11111X22X33').val() > 10 ) {<br />
alert ("That's an awful lot. Are you sure?");<br />
}<br />
});<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Text input masks=<br />
<br />
''Tested with: 1.90+, IE 7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
There may be instances where you would like to place a mask on a text input - for example only allowing respondents to enter the correct characters for a North American phone number ((###) ###-####) or a Canadian postal code (A1A 1A1) The [http://plugins.jquery.com/project/meioMask jQuery meioMask plugin by fabiomcosta] can be used to do this.<br />
<br />
The plugin has several pre-defined masks and supports custom masks. It also allows for pasting of input, allows default values and can auto-focus the next form element when the current input is completely filled. See [http://www.meiocodigo.com/projects/meiomask/ http://www.meiocodigo.com/projects/meiomask/] for more details on features and options.<br />
<br />
There is a small demo [http://www.partnersinc.biz/surveys//index.php?sid=36146&newtest=Y&lang=en here].<br />
<br />
Implementation for this demo was as follows:<br />
#Visit [http://www.meiocodigo.com/projects/meiomask/ http://www.meiocodigo.com/projects/meiomask/], download the latest plugin script and save it as jquery.meiomask.js in the template folder.<br />
#Link to the script by placing <script type="text/javascript" src="{TEMPLATEURL}jquery.meiomask.js" charset="utf-8"></script> within the <head> tag of startpage.pstpl.<br />
#Turn off $filterxsshtml to allow insertion of JavaScript in the questions. ([http://docs.limesurvey.org/tiki-index.php?page=Optional+settings&structure=English+Instructions+for+LimeSurvey#Filtering_dangerous_HTML_tags_in_survey_objects See documentation here])<br />
#Create the text input questions that the masks are to be applied to<br />
#In the source of the help section of the first question of the group that contains the masked inputs, add the following code. ([http://docs.limesurvey.org/tiki-index.php?page=Workarounds&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._ See How to use script here]) <br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() { <br />
<br />
// Define custom masks<br />
$.mask.masks = $.extend($.mask.masks,{<br />
customMask1:{ mask: 'a9a 9a9' }, // Canadian postal code<br />
// Maximum input of 9,999.99, reverse input, default value of 0.00 <br />
customMask2:{ mask: '99.999,9', type : 'reverse', defaultValue : '000' } <br />
});<br />
<br />
// Set the 'alt' attributes of the inputs<br />
$('#answer111111X22XAA').attr('alt', 'phone-us'); // a pre-defined mask <br />
$('#answer111111X22XBB').attr('alt', 'customMask1'); // a custom mask <br />
$('#answer111111X22XCC').attr('alt', 'customMask2'); // a custom mask <br />
$('#answer111111X22XDD').attr('alt', 'cc'); // a pre-defined mask for credit card<br />
<br />
// Tell the plugin to apply masks to these inputs<br />
$('input:#answer111111X22XAA').setMask();<br />
$('input:#answer111111X22XBB').setMask();<br />
$('input:#answer111111X22XCC').setMask();<br />
$('input:#answer111111X22XDD').setMask(); <br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
<br />
The first section defines two custom masks to be used - one for Canadian postal code with a format of A#A #A# and a second for a maximum amount of 9999.99 with reverse input (useful for cost inputs) and a default value of 0.00.<br />
<br />
The next section sets the "alt" attributes for the text inputs. This will tell meioMask which mask we will be applying to each input. By default meioMask looks at the alt attribute to find which mask to apply however this can be changed using the [http://www.meiocodigo.com/projects/meiomask/#mm_options mask options].<br />
<br />
In the final section we apply the masks to the inputs.<br />
<br />
This example has 4 inputs with masks on them - all instances of the following must be replaced to be compatible with your survey (See image below):<br />
<br />
*11111 -> Survey ID<br />
*22 -> Group ID<br />
*AA -> First question<br />
*BB -> Second question<br />
*CC -> Third question<br />
*DD -> Fourth question<br />
<br />
[[File:Ids 343x252.gif]]<br />
<br />
=Text input masks - second method=<br />
<br />
''Tested with: 1.91RC6+, FireFox 4.0''<br />
<br />
There may be instances where you would like to place a mask on a text input - for example only allowing respondents to enter the correct characters for a North American phone number ((###) ###-####) or a US social security number (###-##-####). The jQuery meioMask plugin by fabiomcosta is no longer supported but an alternative exists. The DigitalBush Masked Input Plugin is updated and simple to implement in LimeSurvey. See [http://digitalbush.com/projects/masked-input-plugin/ http://digitalbush.com/projects/masked-input-plugin/] for more details on features and options.<br />
<br />
Implementation as follows:<br />
<br />
#Visit [http://digitalbush.com/projects/masked-input-plugin/ http://digitalbush.com/projects/masked-input-plugin/], download the latest plugin script and save it as jquery.maskedinput.js in the template folder.<br />
#Link to the script by placing <script type="text/javascript" src="{TEMPLATEURL}jquery.maskedinput.js" charset="utf-8"></script> within the <head> tag of startpage.pstpl.<br />
#Turn off $filterxsshtml to allow insertion of JavaScript in the questions. ([http://docs.limesurvey.org/tiki-index.php?page=Optional+settings&structure=English+Instructions+for+LimeSurvey#Filtering_dangerous_HTML_tags_in_survey_objects See documentation here])<br />
#Create the text input questions that the masks are to be applied to<br />
#In the source of the help section of the first question of the group that contains the masked inputs, add the following code. ([http://docs.limesurvey.org/tiki-index.php?page=Workarounds&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._ See How to use script here]) <br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function($) { <br />
$("#answer55431X1X5").mask("999-99-9999",{ placeholder:"#" });<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
<br />
Replace the "#answer55431X1X5" with your survey ID, group ID, and question ID. You can change the mask format and change or eliminate the placeholder if you wish. If you have multiple questions in the same group, simply copy and paste the line that begins with "$" and change the code to what is needed for your application.<br />
<br />
=Select a random response to a "Multiple options" question for later use=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2, Chrome 2.0''<br />
<br />
This workaround allows you to randomly select one of the checked boxes in a "Multiple options" question and store it's label for later use in the survey. A possible use would be to have a question asking what products were purchased and then randomly selecting one of the products to ask further questions about.<br />
<br />
There is a small demo of the above example [http://www.partnersinc.biz/surveys//index.php?sid=81252&newtest=Y&lang=en here].<br />
<br />
Basically what we've done here is to put listeners on all of the checkboxes. If a change of state is detected in any of them the "randomResponse" function is called which loops through all of the checkboxes and if it finds a checked state, that box's label is added to an array. Then a random item is pulled from the array and used to populate the hidden question. This hidden question can then be drawn upon later in the survey using [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+Question#Information_from_previous_answers INSERTANS] or [http://docs.limesurvey.org/tiki-index.php?page=Setting+conditions&structure=English+Instructions+for+LimeSurvey Conditions].<br />
<br />
Implementation for this demo is as follows:<br />
<br />
#[http://docs.limesurvey.org/tiki-index.php?page=Workarounds%3A+Manipulating+a+survey+at+runtime+using+Javascript&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._in_LimeSurvey_ Set up your survey to use JavaScript].<br />
#Create a "Multiple options" question that we're going to randomly pick a checked box from<br />
#Create a text input question to store the label of the checked box in (we're going to hide this with JavaScript)<br />
#Place the script below in the source of one of the questions on the page. <br />
<br />
The following edits are required to implement this in your survey:<br />
<br />
*EDIT HERE (1) - 11111 -> Survey ID, 22 -> Group ID, 44 -> hidden question ID.<br />
*EDIT HERE (2) - 44 -> hidden question ID.<br />
*EDIT HERE (3) - 11111 -> Survey ID, 22 -> Group ID, 33 -> multiple option question ID, A/B/C/D/E/F -> multiple option answer codes. Also add or remove CBs for more or less checkboxes.<br />
*EDIT HERE (4) - add or remove CBs for more or less checkboxes.<br />
*EDIT HERE (5) - add or remove CBs for more or less checkboxes. <br />
<br />
For more info on these IDs see [http://docs.limesurvey.org/tiki-index.php?page=SGQA+identifier&structure=English+Instructions+for+LimeSurvey SGQA identifier].<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
//// Identify the hidden question input<br />
//// EDIT HERE (1) - replace with your hidden question input ID<br />
var hiddenInput = '#answer11111X22X44';<br />
<br />
//// Make the "hidden" question disappear<br />
//// EDIT HERE (2) - replace with your hidden question ID<br />
$('#question44').hide();<br />
<br />
//// Identify the checkboxes to be randomized<br />
//// EDIT HERE (3) - add or remove as required, <br />
//// replace with your checkbox IDs<br />
var CB1 = '#answer11111X22X33A';<br />
var CB2 = '#answer11111X22X33B';<br />
var CB3 = '#answer11111X22X33C';<br />
var CB4 = '#answer11111X22X33D';<br />
var CB5 = '#answer11111X22X33E';<br />
var CB6 = '#answer11111X22X33F';<br />
<br />
//// Create an array of all checkboxes to be randomized<br />
//// EDIT HERE (4) - add or remove CBs as required<br />
checkBoxes = new Array( CB1, CB2, CB3, CB4, CB5, CB6 );<br />
var checkBoxesLength = checkBoxes.length;<br />
<br />
//// The randomizing function - no editing required<br />
function randomResponse () {<br />
var boxLabels = new Array();<br />
<br />
// loop through all of the checkboxes and if they are checked, <br />
// add their label to the boxLabels array<br />
for( var i=0; i<checkBoxesLength; i++ ) {<br />
if ( $(checkBoxes[i]).attr('checked') == true ) {<br />
var cbid = checkBoxes[i].replace('#','');<br />
boxLabels.push( $( 'label[for=' + cbid + ']' ).html() );<br />
}<br />
}<br />
<br />
// find a random index of the responses array<br />
var randomNum = Math.floor(Math.random() * boxLabels.length); <br />
<br />
// populate the hidden question input with the <br />
// random input value<br />
$(hiddenInput).val( boxLabels[randomNum] ); <br />
}<br />
<br />
//// The listeners that will fire the randomize function if a <br />
//// change occurs in the checkboxes<br />
//// EDIT HERE (5) - add or remove CBs as required<br />
$(CB1).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB2).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB3).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB4).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB5).change(function() {<br />
randomResponse ();<br />
});<br />
$(CB6).change(function() {<br />
randomResponse ();<br />
}); <br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
=Display secondary options in a "Multiple options" question=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows you to display secondary options in a "Multiple options" question if a primary option is checked as in the images below.<br />
<br />
Primary option not selected:<br /><br />
[[File:Secondary_options_1.jpg]]<br />
<br />
<br />
Primary option selected:<br /><br />
[[File:Secondary_options_2.jpg]]<br />
<br />
<br />
There is a small demo of the above example [http://www.partnersinc.biz/surveys//index.php?sid=11491&newtest=Y&lang=en here].<br />
<br />
We've put a listener on the primary answer ("Option 1" in the demo) that shows or hides the secondary answers depending on the state of the primary.<br />
<br />
Implementation for this demo is as follows:<br />
<br />
#[http://docs.limesurvey.org/tiki-index.php?page=Workarounds%3A+Manipulating+a+survey+at+runtime+using+Javascript&structure=English+Instructions+for+LimeSurvey#How_to_use_Script_eg._JavaScript_etc._in_LimeSurvey_ Set up your survey to use JavaScript].<br />
#Create a "Multiple options" question including both the primary and secondary answers (in the order that you would like them displayed if all shown)<br />
#Add the following script to the source of the question.<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
/**** <br />
The following code puts a listener on an answer in a multiple options<br />
question (the primary answer) and if that answer is checked, a secondary <br />
level of answers is displayed.<br />
****/<br />
<br />
// --- 1 --- Indent the secondary answers a bit<br />
$( '#questionQQ li:eq(1)' ).css({ 'margin-left':'2.5em' });<br />
$( '#questionQQ li:eq(2)' ).css({ 'margin-left':'2.5em' });<br />
<br />
// --- 2 --- When the page loads, see if the primary answer is checked and if not, <br />
//hide and un-check all secondary answers<br />
if ($( '#answerSSSSSXGGXQQAA' ).attr('checked') == false ) {<br />
<br />
$( '#questionQQ li:eq(1)' ).hide();<br />
$( '#questionQQ li:eq(2)' ).hide();<br />
<br />
$( '#answerSSSSSXGGXQQBB' ).attr('checked', false);<br />
$( '#answerSSSSSXGGXQQCC' ).attr('checked', false);<br />
}<br />
<br />
// --- 3 --- Now put a listener on the primary answer to show or hide secondary answers <br />
// We need to use .click instead of .change cause IE won't cooperate<br />
$('#answerSSSSSXGGXQQAA').click(function (event) {<br />
<br />
// Have a look at the primary answer and hide/show the secondary answers accordingly<br />
if ($( '#answerSSSSSXGGXQQAA' ).attr('checked') == false ) {<br />
<br />
$( '#questionQQ li:eq(1)' ).hide();<br />
$( '#questionQQ li:eq(2)' ).hide();<br />
<br />
$( '#answerSSSSSXGGXQQBB' ).attr('checked', false);<br />
$( '#answerSSSSSXGGXQQCC' ).attr('checked', false);<br />
}<br />
else {<br />
<br />
$( '#questionQQ li:eq(1)' ).show();<br />
$( '#questionQQ li:eq(2)' ).show();<br />
} <br />
<br />
// The original functions of the click event<br />
cancelBubbleThis(event);<br />
checkconditions(this.value, this.name, this.type);<br />
}<br />
);<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
<br />
The following edits are required to implement this in your survey:<br />
<br />
'''Section 1:'''<br />
*This section indents the secondary answers to give the look of a list in a list when they're shown<br />
*'''QQ''' is your question ID<br />
*'''eq(1)''' and '''eq(2)''' are the index positions of your secondary options. Modify or add as necessary for the number and placement of secondary options in your question. Note that the index starts at 0 so '''eq(1)''' actually affects the second option in the full list and '''eq(2)''' affects the third. <br />
<br />
'''Section 2:'''<br />
*This section checks the state of the primary question when the page is loaded and if necessary hides the secondary questions. We need this in case users navigate away from and then back to the page.<br />
*Modify '''eq(1)''' and '''eq(2)''' as above.<br />
*'''SSSSS''' is your survey ID.<br />
*'''GG''' is your group ID.<br />
*'''QQ''' is your question ID.<br />
*'''AA''' is your primary answer code.<br />
*'''BB''' and '''CC''' are your secondary answer codes (add as necessary). <br />
<br />
'''Section 3:'''<br />
*This is the section that "listens" to the primary answer and reacts accordingly.<br />
*Edit as in section 2.<br />
<br />
For more info on these IDs see SGQA identifier(external link).<br />
<br />
This code could be tidied up and shortened a bit but I left it this way to make it easier to follow.<br />
<br />
=Minimum number of required answers in an array (pre 1.92)=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2,''<br />
<br />
<div class="simplebox">As of version 1.92 all array style questions have the min_answers and max_answers options, so this script is obsolete.</div><br />
<br />
This workaround allows you to specify a '''minimum number''' of answers required in an array question. It is an alternative to the "Mandatory" parameter which specifies that '''all''' answers are required. It could also be easily modified to specify a maximum number of answers.<br />
<br />
We accomplish this by placing an onload function in the source of the array question. This function hides the Next/Submit button and displays a warning element until it detects a minimum number of responses. It then hides the warning and shows the Next/Submit button.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=97166&newtest=Y&lang=en here].<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Set up the template to use custom onload functions. (See the [[Workarounds#Custom onload function|workaround here]])<br />
#In the source of the array question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Modify the ''SETTINGS'' section of the code as required.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
// Wait until the document is fully loaded<br />
$(document).ready(function() {<br />
<br />
/********************** SETTINGS **********************/<br />
// The text to appear in the warning element<br />
var warningText = 'Please answer at least 4 to continue';<br />
// The question ID<br />
var questionId = 137;<br />
// The minimum number of answers required<br />
var minNumber = 4;<br />
/******************************************************/<br />
<br />
// Create the warning element and place it after the submit button<br />
var el = document.createElement('div');<br />
el.setAttribute('id','warning');<br />
document.body.appendChild(el);<br />
$( '#warning' ).css({<br />
'border':'1px solid #333333',<br />
'width':'200px',<br />
'padding':'3px',<br />
'color':'red'<br />
});<br />
$('#warning').html(warningText);<br />
$('input[type="submit"]').after($('#warning'));<br />
<br />
// Detect the initial number of checked answers & display Next/Submit button accordingly<br />
var inputInitCount = 0;<br />
$('#question' + questionId + ' input').each(function(i) {<br />
if ($( this ).attr('checked') == true ) {<br />
inputInitCount++;<br />
}<br />
});<br />
if (inputInitCount > (minNumber - 1)) {<br />
$('input[type="submit"]').show();<br />
$('#warning').hide();<br />
}<br />
else {<br />
$('#warning').show();<br />
$('input[type="submit"]').hide();<br />
}<br />
<br />
// Listener to detect number of checked answers & display Next/Submit button accordingly<br />
$('#question' + questionId + ' input.radio, #question'+questionId+' tbody[id<div class="simplebox">="javatbd"] td').click(function() {<br />
var inputCount = 0;<br />
$('#question' + questionId + ' input.radio').each(function(i) {<br />
if ($( this ).attr('checked') == true ) {<br />
inputCount++;<br />
}<br />
});<br />
if (inputCount > (minNumber - 1)) {<br />
$('input[type="submit"]').show();<br />
$('#warning').hide();<br />
}<br />
else {<br />
$('#warning').show();<br />
$('input[type="submit"]').hide();<br />
}<br />
<br />
// The original functions of the click event<br />
checkconditions(this.value, this.name, this.type);<br />
});<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Minimum elapsed time before moving forward in survey=<br />
<br />
''Tested with: 1.91, IE 7/8, Firefox 7.0, Safari 3.2''<br />
<br />
This workaround interrupts the Next/Submit function and checks the amount of time elapsed since the page loaded. If the time is less than the minimum dictated, the respondent is alerted and not allowed to proceed. It is useful if you want to enforce a minimum amount of time spent viewing a page.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the script below in the source of one of the questions on the page, replacing "TT" with the minimum number of seconds required before advancing is allowed.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
minTime(TT);<br />
<br />
function minTime(minTime) {<br />
<br />
var startTime = new Date();<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
var endTime = new Date();<br />
<br />
if((endTime - startTime)/1000 <= minTime) {<br />
alert ('You must spend at least '+minTime+' seconds on the question.');<br />
return false;<br />
}<br />
else {<br />
return true;<br />
}<br />
});<br />
}<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
=Minimum number of characters in Long free text or Huge free text questions=<br />
<br />
''Tested with: 1.91, IE 7/8, Firefox 7.0, Safari 3.2''<br />
<br />
<div class="simplebox">As of version 1.91, you can use regular expression masks (validation) to specify the minimum number of required characters. However, even if the question is mandatory, it can still be blank.</div><br />
<br />
<div class="simplebox">As of version 1.92, if you make the question mandatory and use a validation mask to specify the minimum number of characters, then the user will be forced to answer the question. Note that unlike 1.91, they can submit their current answers, even if partially invalid (so they are stored in the database), but they will not ber able to proceed to the next page until they have passed all mandatory and validity checks.</div><br />
<br />
This workaround interrupts the Next/Submit function and checks the number of characters entered in a Long free text or Huge free text question. If the number is less than the minimum dictated, the respondent is alerted and not allowed to proceed.<br />
<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
<br />
#Place the script below in the source of one of the questions on the page, replace "QQ" with the question ID and "CC" with the minimum number of characters required before advancing is allowed.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
minChar(QQ, CC);<br />
<br />
function minChar(qID, minChars) {<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
if($('#question'+qID+' textarea').val().replace(/ /g,'').length < minChars) {<br />
<br />
alert ('You must enter at least '+minChars+' characters.');<br />
<br />
return false;<br />
<br />
}<br />
<br />
else {<br />
<br />
return true;<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Variable Length Array (Multi Flexible Text) question=<br />
<br />
''Tested with: 1.90+, IE 6/7/8, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows a respondent to add or remove rows of an Array (Multi Flexible Text) question. It's useful to avoid the page being cluttered with unnecessary array rows.<br />
<br />
A function is placed in the template.js file of your template (use template editor). This function hides all of the array rows except the first and inserts two elements that when clicked show or hide rows accordingly.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=53132&newtest=Y&lang=en here].<br />
<br />
It must be noted that you can not make this question Mandatory as the respondent will have no way to complete hidden fields. If you want the displayed fields to be mandatory you will need to validate them in another function or modify this function to only allow the addition of rows if all fields in the last row are completed and then disable those fields - that, however, is a little over the top for this example.<br />
<br />
Implementation is as follows:<br />
<br />
#Set up your survey to use JavaScript (See instructions [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|here]])<br />
<br />
#Add the following script to your ''template.js'' file.<br />
<br />
#Replace "QQ" in the function call at the end with the question ID.<br />
<br />
#Create one or more Array (Multi Flexible Text) questions<br />
<br />
#If you want to apply it to more arrays on the same page simply add more calls with the appropriate question IDs. (eg. varLengthArray(1); varLengthArray(2);...)<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div">$(document).ready(function() {<br />
<br />
// A function to add or remove rows of an Array (Multi Flexible)(Text) question<br />
function varLengthArray(qID) {<br />
<br />
if ($('#question'+qID+'').length > 0) {<br />
<br />
// The HTML content of the Add/Remove elements - modify as you wish<br />
var addContent = '[+]';<br />
var removeContent = '[-]';<br />
<br />
// Create the Add and Remove elements & insert them<br />
var el1 = document.createElement('div');<br />
el1.setAttribute('id','addButton'+qID);<br />
document.body.appendChild(el1);<br />
var el2 = document.createElement('div');<br />
el2.setAttribute('id','removeButton'+qID);<br />
document.body.appendChild(el2);<br />
<br />
// Move them to after the array<br />
$( 'div#addButton'+qID ).appendTo($( '#question' + qID + ' table.question' ).parent());<br />
$( 'div#removeButton'+qID ).appendTo($( '#question' + qID + ' table.question' ).parent());<br />
<br />
// Insert their HTML<br />
$( 'div#addButton'+qID ).html( addContent );<br />
$( 'div#removeButton'+qID ).html( removeContent );<br />
<br />
// Style the elements - you can modify here if you wish<br />
$( 'div#addButton'+qID ).css({<br />
'margin':'10px 0 0 10px',<br />
'padding':'1px',<br />
'text-align':'center',<br />
'font-weight':'bold',<br />
'width':'auto',<br />
'cursor':'pointer',<br />
'float':'left'<br />
});<br />
<br />
$( 'div#removeButton'+qID ).css({<br />
'margin':'10px 0 0 10px',<br />
'padding':'1px',<br />
'text-align':'center',<br />
'font-weight':'bold',<br />
'width':'auto',<br />
'cursor':'pointer',<br />
'float':'left'<br />
});<br />
<br />
// Initially hide the Remove element<br />
$( 'div#removeButton'+qID ).hide();<br />
<br />
// Call the functions below when clicked<br />
$( 'div#addButton'+qID ).click(function (event) {<br />
addRow(qID);<br />
});<br />
$( 'div#removeButton'+qID ).click(function (event) {<br />
removeRow(qID);<br />
});<br />
<br />
// Function to add a row, also shows the Remove element and hides the<br />
//Add element if all rows are shown<br />
function addRow(qID) {<br />
var arrayRow = '#question' + qID + ' table.question tbody';<br />
var rowCount = $( arrayRow ).size() - 1;<br />
$( arrayRow + '[name="hidden"]:first' ).attr('name', 'visible').show();<br />
$( 'div#removeButton'+qID ).show();<br />
if ( $( arrayRow + ':eq(' + rowCount + ')' ).attr('name') == 'visible' ) {<br />
$( 'div#addButton'+qID ).hide();<br />
}<br />
}<br />
<br />
// Function to remove a row, also clears the contents of the removed row,<br />
// shows the Add element if the last row is hidden and hides the Remove<br />
// element if only the first row is shown<br />
function removeRow(qID) {<br />
var arrayRow = '#question' + qID + ' table.question tbody';<br />
var rowCount = $( arrayRow ).size() - 1;<br />
$( arrayRow + '[name="visible"]:last input[type="text"]' ).val('');<br />
$( arrayRow + '[name="visible"]:last' ).attr('name', 'hidden').hide();<br />
$( 'div#addButton'+qID ).show();<br />
if ( $( arrayRow + ':eq(1)' ).attr('name') == 'hidden' ) {<br />
$( 'div#removeButton'+qID ).hide();<br />
}<br />
}<br />
<br />
// Just some initialization stuff<br />
var arrayRow = '#question' + qID + ' table.question tbody';<br />
var rowCount = '';<br />
<br />
// Initially hide all except first row or any rows with populated inputs<br />
$( arrayRow ).each(function(i) {<br />
if ( i > 0 ) {<br />
// We also need to give the hidden rows a name cause IE doesn't<br />
// recognize jQuery :visible selector consistently<br />
$( this ).attr('name', 'hidden').hide();<br />
<br />
$('input[type=text]', this).each(function(i) {<br />
if ($(this).attr('value') != '') {<br />
$(this).parents('tbody:eq(0)').attr('name', 'visible').show();<br />
$( 'div#removeButton'+qID ).show();<br />
}<br />
});<br />
rowCount = i;<br />
}<br />
});<br />
}<br />
}<br />
<br />
// Call the function with a question ID<br />
varLengthArray(QQ);<br />
<br />
});</syntaxhighlight><br />
<br />
=Expandable Array=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.5, Safari 3.2''<br />
<br />
This workaround allows you to present an array question incrementally. That is to say that initially only the first option (row) in the array is shown. When that option is answered the next is shown and so-on.<br />
<br />
A JavaScript function is placed in the source of the array question. This function hides all of the array rows except the first and then displays them as options are answered.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=94958&newtest=Y&lang=en here].<br />
<br />
The workaround supports following question types:<br />
*Array (flexible labels)<br />
*Array (flexible labels) by column<br />
*Array (Yes/No/Uncertain)<br />
*Array (Increase, Same, Decrease)<br />
*Array (Flexible Labels) dual scale<br />
*Array (10 point choice)<br />
<br />
Implementation is as follows:<br />
#Set up your survey to use JavaScript. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|documentation here]])<br />
#Create one or more Array questions<br />
#In the source of the first array question add the following script.<br />
#Replace "QQ" in the function call at the end of the script with the question ID of the array you would like to manipulate.<br />
#If you want to apply it to more arrays on the same page, simply add more calls with the appropriate question IDs. (eg. expandingArray(1); expandingArray(2);...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
// A function to show subsequent rows of an array as options are checked<br />
function expandingArray(qID) {<br />
<br />
// Build an array of the question rows<br />
var arrayRow = '#question' + qID + ' table.question tbody tr';<br />
<br />
// Initially hide all rows unless an input was previously checked<br />
$( arrayRow ).each(function(i) {<br />
<br />
if ( $( arrayRow + ':eq(' + i + ') input.radio:checked' ).length != 0 ) {<br />
$(this).attr('name', 'clickedRow');<br />
}<br />
else {<br />
$(this).attr('name', 'hidden').hide();<br />
}<br />
});<br />
<br />
// Now show the first hidden row<br />
addRow();<br />
<br />
// Add another row when an option is checked for the first time<br />
$( '#question' + qID + ' td.answer input.radio' ).click(function (event) {<br />
<br />
if ($(this).parents('tr:eq(0)').attr('name') != 'clickedRow') {<br />
addRow();<br />
$(this).parents('tr:eq(0)').attr('name', 'clickedRow');<br />
}<br />
<br />
// The original function of the click event<br />
checkconditions(this.value, this.name, this.type);<br />
});<br />
<br />
// Add another row when an table cell is clicked for the first time<br />
$( '#question' + qID + ' table.question tbody td' ).click(function (event) {<br />
<br />
if ($(this).parents('tr:eq(0)').attr('name') != 'clickedRow') {<br />
addRow();<br />
$(this).parents('tr:eq(0)').attr('name', 'clickedRow');<br />
}<br />
});<br />
<br />
// Function to add a row<br />
function addRow() {<br />
$( arrayRow + '[name="hidden"]:first' ).attr('name', 'visible').show();<br />
}<br />
}<br />
<br />
// Call the function with a question ID<br />
expandingArray(QQ);<br />
<br />
});<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - Multiple Options & List (radio) questions - ENHANCED=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows the answers of Multiple Options & List (radio) questions to be randomized while always keeping as many answers at the end of the list as specified by the var insertitems=n, where n is the number of answers you want left unrandomized. It's useful if you want to randomize, say, the first 4 of your answers but always have the 5th to 7th displayed last as in the image below (assuming you assigned the number 3 to insertitems):<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
Some conditions on the use of this are:<br />
*For Select/radio type questions it will only work if the [[Optional settings#Survey Behavior|$shownoanswer option]] is set to 0 in config.php. ("No answer" is removed from the end of questions)<br />
*You must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more Multiple Options or List (radio) questions with sequential response codes. Set the [[Advanced question settings#random order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Set var insertitems=n (n = the number of items you want un-randomized)<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRand(11111, 22, 1); partRand(11111, 22, 2); ...)<br />
<br />
Onload code:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers except the last one in Multiple options and List/radio questions<br />
<br />
function partRand(sID, gID, qID) {<br />
<br />
//var to define how many lists to be added at the end<br />
<br />
var insertitems=3;<br />
<br />
// Find the number of answers<br />
<br />
var ansCount = ''<br />
<br />
lastitems=new Array();<br />
<br />
var liid=new Array();<br />
<br />
var $ul;<br />
<br />
var j=0;<br />
<br />
$( '#question' + qID + ' td.answer li' ).each(function(i) {<br />
<br />
ansCount = (i + 1);<br />
<br />
});<br />
<br />
$( '#question' + qID + ' td.answer li' ).each(function(i) {<br />
<br />
if(i>ansCount-(insertitems+1)){<br />
<br />
lastitems[j]=$(this).html();<br />
<br />
liid[j]=$(this).attr("id");<br />
<br />
j++;<br />
<br />
$(this).remove();<br />
<br />
}<br />
<br />
});<br />
<br />
$( '#question' + qID + ' td.answer li' ).each(function(i) {<br />
<br />
// get current ul<br />
<br />
$ul = $(this).parent();<br />
<br />
// get array of list items in current ul<br />
<br />
var $liArr = $ul.children('li');<br />
<br />
// sort array of list items in current ul randomly<br />
<br />
$liArr.sort(function(a,b){<br />
<br />
// Get a random number between 0 and 100<br />
<br />
var temp = parseInt( Math.random()*100 );<br />
<br />
// Get 1 or 0, whether temp is odd or even<br />
<br />
var isOddOrEven = temp%2;<br />
<br />
// Get +1 or -1, whether temp greater or smaller than 5<br />
<br />
var isPosOrNeg = temp>5 ? 1 : -1;<br />
<br />
// Return -1, 0, or +1<br />
<br />
return( isOddOrEven*isPosOrNeg );<br />
<br />
})<br />
<br />
// append list items to ul<br />
<br />
.appendTo($ul);<br />
<br />
});<br />
<br />
$.each(lastitems,function(i){<br />
<br />
$( $ul ).append("<li id="+liid[i]+">"+this+"</li>");<br />
<br />
});<br />
<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
<br />
partRand(SSSSS, GG, QQ);<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - Multiple Options & List (radio) questions=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround allows the answers of Multiple Options & List (radio) questions to be randomized while always keeping one answer at the end of the list. It's useful if you want to randomize, say, the first 4 of your answers but always have the fifth displayed last as in the image below:<br />
<br />
[[File:random_336x179gif.gif]]<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=89344&newtest=Y&lang=en here].<br />
<br />
Some conditions on the use of this are:<br />
*For Select/radio type questions it will only work if the [[Optional settings#Survey Behavior|$shownoanswer option]] is set to 0 in config.php. ("No answer" is removed from the end of questions)<br />
*You must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more Multiple Options or List (radio) questions with sequential response codes. Set the [[Advanced question settings#random_order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRand(11111, 22, 1); partRand(11111, 22, 2); ...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers except the last one in Multiple options and List/radio questions<br />
function partRand(sID, gID, qID) {<br />
<br />
// Find the number of answers<br />
var ansCount = ''<br />
$( 'div#question' + qID + ' td.answer li' ).each(function(i) {<br />
ansCount = (i + 1);<br />
});<br />
<br />
// Place the last answer created at the end of the list<br />
$( 'input#answer' + sID + 'X' + gID + 'X' + qID + ansCount + '' ).parent().appendTo($( '#question' + qID + ' td.answer ul' ));<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
partRand(SSSSS, GG, QQ);<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - List (dropdown) questions=<br />
<br />
''Tested with: 1.90+, IE 6/7, FireFox 3.0, Safari 3.2''<br />
<br />
This workaround, similar to the one above, allows the answers of List (dropdown) questions to be randomized while always keeping one answer at the end of the list. It's useful if you want to randomize, say, the first 4 of your answers but always have the fifth displayed last.<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
There is a demo [http://www.partnersinc.biz/surveys//index.php?sid=89344&newtest=Y&lang=en here].<br />
<br />
A condition is that you must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more List (dropdown) questions with sequential response codes. Set the [[Advanced question settings#random order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRandDD(11111, 22, 1); partRandDD(11111, 22, 2); ...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers<br />
//except the last one in List/dropdown questions<br />
function partRandDD(sID, gID, qID) {<br />
<br />
// Find the number of answers<br />
var ansCount = ''<br />
$( 'div#question' + qID + ' select option' ).each(function(i) {<br />
ansCount = i;<br />
});<br />
<br />
// Place the last answer created at the end of the list<br />
$( 'option[value="' + ansCount + '"]' ).appendTo($( 'div#question' + qID + ' select' ));<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
partRandDD(89344, 72, 244);<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Partially Randomized Answers - Multiple numerical input=<br />
<br />
''Tested with: 1.90+, Safari 5.1''<br />
<br />
This workaround, similar to the ones above, allows the answers of Multiple numerical input questions to be randomized while always keeping one answer at the end of the list. It's useful if you want to randomize, say, the first 4 of your answers but always have the fifth displayed last.<br />
<br />
An onload function is placed in the source of a question. After the randomizing has occurred this function moves the answer with the highest answer code to the end of the list.<br />
<br />
A condition is that you must use sequential numbers, starting at 1 as response codes. (See image below)<br />
<br />
[[File:random_700x154.png]]<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions. (See [[Optional settings#Security|documentation here]])<br />
#Create one or more Multiple numerical input question with sequential response codes. Set the [[Advanced question settings#random order|random_order question attribute]] to 1.<br />
#In the source of the first question add the following onload function. (See [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]])<br />
#Replace "SSSSS", "GG", "QQ" in the function call at the end with the survey ID, group ID and question ID respectively.<br />
#If you want to apply it to more questions on the same page simply add more calls with the appropriate IDs. (eg. partRandDD(11111, 22, 1); partRandDD(11111, 22, 2); ...)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Function to allow randomization of all answers except the last one in multiple numeric input questions<br />
function partRand(sID, gID, qID) {<br />
<br />
// Find the number of answers<br />
var ansCount = ''<br />
$( 'div#question' + qID + ' div.answers li' ).each(function(i) {<br />
ansCount = (i - 1);<br />
});<br />
<br />
// Place the last answer created at the end of the list - but before the first helping sum<br />
$( 'li#javatbd' + sID + 'X' + gID + 'X' + qID + ansCount + '' ).insertBefore($( 'div#question' + qID + ' div.answers li.multiplenumerichelp' ).first());<br />
<br />
}<br />
<br />
// Call the function with the SID, GID and QID<br />
partRand(SID, GID, QID);<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
Using this solution for Multiple numerical input questions might be a bit more complicated than for other question types. All answers are organized in an unordered list (<nowiki><ul></nowiki>) structure. However, if advanced question settings like ''Equals sum value'' are used, LimeSurvey adds helping information (e.g. sum of all entries and remainder) to the same unordered list using the class ''multiplenumerichelp'' for these additional list items. The above example assumes that at least one of these list items is present and moves the last answer to the position right above the first helper item. Without such advanced settings, the code will most certainly need adaptation.<br />
<br />
=Making one (or more) rows of an array mandatory=<br />
<br />
''Tested with: 1.90+, IE 6/7, Firefox 3.0, Safari 3.2''<br />
<br />
This workaround allows you to define one or more rows of an array question as mandatory (instead of all of them which the "Mandatory" question setting does). It is [http://www.partnersinc.biz/surveys//index.php?sid=26842&newtest=Y&lang=en demonstrated here].<br />
<br />
A JavaScript function interrupts the submit function and checks if the inputs in the mandatory row(s) are populated. If not, an alert is popped up, the offending inputs are turned pink and the submit is aborted. Otherwise the submit goes ahead.<br />
<br />
Implementation is as follows:<br />
#Turn off ''$filterxsshtml'' to allow insertion of JavaScript in the questions (see [[Optional settings#Security|documentation here]]).<br />
#Create the array question.<br />
#In the source of the array question add the following script (see [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]]).<br />
#Modify the warningText (line10)as required.<br />
#Replace "QQ" (lines 13 and 14) with the question ID and add calls as necessary for more rows - the example code renders rows 1 and 3 mandatory.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function () {<br />
<br />
// Interrupt the submit function<br />
$('form#limesurvey').submit(function () {<br />
<br />
// Override the built-in "disable navigation buttons" feature<br />
$('#moveprevbtn, #movenextbtn, #movesubmitbtn').attr('disabled', '');<br />
<br />
var empty = 0;<br />
var warningText = 'Please complete the highlighted inputs.';<br />
<br />
// Call the mandatory row function with question IDs and row numbers<br />
mandatoryRow(QQ, 1);<br />
mandatoryRow(QQ, 3);<br />
<br />
// A function to render rows of an array mandatory<br />
function mandatoryRow(qID, rowNum) {<br />
<br />
$('div#question' + qID + ' table.question tbody[id</div>="javatbd"]:eq(' + Number(rowNum - 1) + ') input[type="text"]').each(function (i) {<br />
<br />
if ($(this).val() == '') {<br />
$(this).css('background-color', 'pink');<br />
empty = 1;<br />
} <br />
else {<br />
$(this).css('background-color', '#FFFFFF');<br />
}<br />
});<br />
}<br />
<br />
if (empty == 1) {<br />
alert(warningText);<br />
return false;<br />
} <br />
else {<br />
return true;<br />
}<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Randomly displaying one of a few YouTube videos, and recording which was displayed=<br />
<br />
''Tested in 1.85+''<br />
<br />
Jason Cleeland has created and documented a method to randomly display one of a number of youtube videos in a single question, and save which one was displayed.<br />
<br />
http://www.aptigence.com.au/home/archives/23-Random-display-of-videos-in-a-question-2-YouTube.html<br />
<br />
=Randomly displaying one of a few pictures, and recording which was displayed=<br />
<br />
''Tested in 1.91+''<br />
<br />
The following steps allow you to randomly display one of a few pictures and record in the dataset which picture was displayed. We use four pictures in this example, but you can easily adapt these scripts according to your needs.<br />
<br />
1. Create a new sub-directory '''pic''' in your LimeSurvey folder.<br />
<br />
2. Copy four pictures (named ''1.jpg'', ''2.jpg'', ''3.jpg'', and ''4.jpg'') in this pic sub-directory.<br />
<br />
3. Deactivate the ''Filter HTML for XSS'' function in LimeSurvey's ''Global Settings''.<br />
<br />
4. Create a '''Short free text''' question where you want these pictures to be displayed.<br />
<br />
5. Figure out the [[SGQA identifier|SGQA Identifier]] of this question (e.g., 12345X67X89).<br />
<br />
6. Paste the following code as question text after activating the editor's ''Source'' view and replace both SSSSSXGGXQQ strings with your SGQA identifier:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
Please have a look at this picture:<br />
<br />
<br /><br />
<br />
<script><br />
<br />
$(document).ready(<br />
<br />
function(){<br />
<br />
// Find a random number (here between 1 and 4)<br />
<br />
var randNumber = Math.floor(Math.random()*4 + 1);<br />
<br />
// Save the number as answer of this question<br />
<br />
$('input#answerSSSSSXGGXQQ').val(randNumber);<br />
<br />
// Hide this answer field<br />
<br />
document.getElementById("answerSSSSSXGGXQQ").style.display='none';<br />
<br />
// Show the picture<br />
<br />
picString = '<img src="pic/' + String(randNumber) + '.jpg">';<br />
<br />
document.getElementById('pic').innerHTML = picString;<br />
<br />
}<br />
<br />
);</script><br />
<br />
<p><br />
<br />
</p><br />
<br />
<div id="pic"><br />
<br />
</div><br />
<br />
</syntaxhighlight><br />
<br />
If you want to display the number of this picture in a later question, use the following code as question text (don't forget to replace the SSSSSXGGXQQ string acordingly):<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
You saw picture number {INSERTANS:SSSSSXGGXQQ}.<br />
<br />
</syntaxhighlight><br />
<br />
Perhaps you want to display the same picture again in a later question, but a little bit smaller (100px width, 100px height)? Just paste the following code as question text after activating the editor's ''Source'' view, and replace the SSSSSXGGXQQ string acordingly:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
Here you see the picture again: <br><br />
<br />
<script><br />
<br />
$(document).ready(<br />
<br />
function(){<br />
<br />
// Get the picture number from previous question<br />
<br />
var randNumber = "{INSERTANS:SSSSSXGGXQQ}";<br />
<br />
// Show picture<br />
<br />
picString = '<img width="100" height="100" src="pic/' + String(randNumber) + '.jpg">';<br />
<br />
document.getElementById('pic').innerHTML = picString;<br />
<br />
}<br />
<br />
);</script><br />
<br />
<div id="pic"><br />
<br />
</div><br />
<br />
</syntaxhighlight><br />
<br />
=Multiple numerical input with max_num_value defined in token (personalized limit)=<br />
<br />
''Tested in 1.85+''<br />
<br />
<div class="simplebox">As of version 1.92, max_num_value can be an experession, so you can simply enter the {TOKEN} or other variable in that question attribute.</div><br />
<br />
To make personalized survey with multiple numerical input when max_num_value (Maximum sum value) is different for each user and is loaded from the token use following tricks:<br />
*Create 1st group with numerical input field (1000X10X11). "Limit"<br />
*Add java script into this question:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
function Custom_On_Load(){<br />
<br />
document.getElementById('answer1000X10X11').value='{TOKEN:ATTRIBUTE_1}';<br />
<br />
document.getElementById('answer1000X10X11').readOnly=1;<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
where:<br />
<br />
TOKEN:ATTRIBUTE_1 is individual limit defined in token.<br />
<br />
readOnly=1 // user shouldn't change it.<br />
*Create 2nd group with multiple numerical input and add "Max value from SGQA" with 1000X10X11 as argument.<br />
<br />
Note: If you don't want to show first field with numerical input (and show definied limit in different way) you can add 2 lines to above script to hide whole question:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
document.getElementById('question85').style.display='none';<br />
<br />
document.getElementById('display85').value='';<br />
<br />
</syntaxhighlight><br />
<br />
where:<br />
<br />
question85 and display85 are field names.<br />
<br />
Note: It's no possible to create it into one group, because all SGQA references can only refer to data on a previous page because when clicking next the answer is stored at the DB and the SGQA is replaced by querying the database.<br />
<br />
=Default values in array questions=<br />
<br />
''Tested with: 1.87+ (7557), IE 6/7, Firefox 3.5, Safari 3.2''<br />
<br />
<div class="simplebox">As of Version 1.92, many more question types support default values.</div><br />
<br />
This workaround uses JavaScript to allow you to pre-check default answers in all sub-questions of an array type question. You can select a column of the array to be checked as the page loads. The script first checks to see if a sub-question has already been answered and, if not, checks the default answer.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use script]].<br />
#Create the array question.<br />
#In the source of the array question add the following script.<br />
#Replace"QQ" with the question ID and "CC" with the column number to be checked.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// A function to pre-check a column of an array<br />
<br />
function checkedDefault(qID, column) {<br />
<br />
var checkedCol = column - 1;<br />
<br />
$('#question' + qID + ' table.question tbody tr').each(function(i) {<br />
<br />
if ($('input.radio[checked=true]', this).length == 0) {<br />
<br />
$('input.radio:eq(' + checkedCol + ')', this).attr('checked', true);<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
// Call the function with a question ID and column number<br />
<br />
checkedDefault(QQ, CC);<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Record group view time=<br />
<br />
''Tested with: 1.87+ (8518), IE 6/7, Firefox 3.5, Safari 3.2''<br />
<br />
<div class="simplebox">As of version 1.92, group view time is accurately recorded in the timings table if you choose the Record Timings survey option.</div><br />
<br />
This workaround uses JavaScript to populate a hidden question with the total time that a respondent views a group. If used in a group with only one question, it could be used to track the amount of time required to answer the question.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#In the group, create a short-text question. We will hide this later with JavaScript and populate it with the elapsed time.<br />
#Place the following script in the source of the short-text question.<br />
#Replace "QQ" in line 6 with the ID of the short-text question.<br />
<br />
The script populates the hidden question with the elapsed time since the group was opened. If a respondent leaves the group and then returns, the timer continues up from the elapsed time of the last visit.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function(){<br />
<br />
// call the functions with the hidden timer question ID<br />
<br />
runTimer(QQ);<br />
<br />
function runTimer(timeQID) {<br />
<br />
$('#question'+timeQID).hide();<br />
<br />
var initSec = '0';<br />
<br />
// Check for elapsed time from previous visits<br />
<br />
if ($('#question'+timeQID+' input.text').val()) {<br />
<br />
var initTime = $('#question'+timeQID+' input.text').val();<br />
<br />
initTimeArr = initTime.split(':');<br />
<br />
initSec = Number[[initTimeArr[0]*3600]]+Number[[initTimeArr[1]*60]]+Number(initTimeArr[2]);<br />
<br />
}<br />
<br />
// Run the timer update function<br />
<br />
recordTime(initSec, timeQID);<br />
<br />
}<br />
<br />
});<br />
<br />
// Timer update function<br />
<br />
function recordTime(elapsedSec, timeQID){<br />
<br />
elapsedSec++;<br />
<br />
var h = Math.floor(elapsedSec / 3600);<br />
<br />
var m = Math.floor(elapsedSec % 3600 / 60);<br />
<br />
var s = Math.floor(elapsedSec % 3600 % 60);<br />
<br />
var elapsedTime = [[h > 0 ? h + ":" : "00:") + (m > 0 ? (m < 10 ? "0" : "") + m + ":" : "00:") + (s < 10 ? "0" : "") + s);<br />
<br />
$('#question'+timeQID+' input.text').val(elapsedTime);<br />
<br />
// Run the timer update function every second<br />
<br />
setTimeout('recordTime('+elapsedSec+', '+timeQID+')',1000);<br />
<br />
}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Toggle visibility of groups=<br />
<br />
''Tested with: 1.90+, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
This workaround uses JavaScript to toggle the visibility of groups in an "all in one" survey. Initially the groups are hidden and there are links inserted to display the groups. It's useful to avoid the page being cluttered with many groups and lets the respondent focus on one at a time.<br />
<br />
It's [http://www.partnersinc.biz/surveys//index.php?sid=33613&newtest=Y&lang=en demonstrated here].<br />
<br />
Implementation is as follows:<br />
<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Set the survey to run in "all in one" mode.<br />
#Add your groups and questions.<br />
#Place the following script in the source of one of the questions in the first group.<br />
<br />
<br />
The comments in the script are pretty self-explanatory but it does the following:<br />
<br />
#initially hides all of the groups<br />
#inserts a link above each one to toggle its display<br />
#some styles are added to the clickable links but these could be done in template.css instead<br />
#shows any groups that have an unanswered mandatory after a submit attempt<br />
<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function(){<br />
<br />
// Insert show/hide divs before all group wrapper divs<br />
$('<div class="groupToggler"><span></span></div>').insertBefore('div[id^="group-"]');<br />
<br />
// Add some text to the show/hide divs<br />
$('.groupToggler span').each(function(i) {<br />
($( this ).text('Show/Hide Group '+(i+1)+''));<br />
});<br />
<br />
// Add some styles to the show/hide divs<br />
$('.groupToggler').css({<br />
'padding':'5px 0 10px 0',<br />
'text-align':'center'<br />
});<br />
$('.groupToggler span').css({<br />
'text-decoration':'underline', <br />
'cursor':'pointer'<br />
});<br />
<br />
// Add some hover effects to the show/hide divs<br />
$(".groupToggler span").hover(<br />
function () {<br />
$(this).css({<br />
'text-decoration':'none',<br />
'font-weight':'bold'<br />
});<br />
}, <br />
function () {<br />
$(this).css({<br />
'text-decoration':'underline',<br />
'font-weight':'normal'<br />
});<br />
}<br />
);<br />
<br />
// Initially hide all of the groups<br />
// Toggle their visibility when the show/hide is clicked<br />
$('.groupToggler span').click(function() {<br />
$(this).parent().next().toggle();<br />
return false;<br />
}).parent().next().hide();<br />
<br />
// Display any groups that have unanswered mandatories<br />
$('.errormandatory').parents('div[id^="group-"]').show();<br />
<br />
// Some tidying up<br />
$('h1').next().next().hide();<br />
$('.surveywelcome').css({'margin-bottom':'10px'});<br />
$('.surveywelcome').next().hide();<br />
$('.surveywelcome').next().next().hide();<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Use jQuery Autocomplete plugin to suggest answers for text inputs=<br />
<br />
== 1.90 and previous versions==<br />
<br />
''Tested with: 1.90+, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
This workaround uses the [http://docs.jquery.com/Plugins/Autocomplete jQuery Autocomplete] plugin to provide a respondent a list of suggested answers that the they can select from as they type in a text input.<br />
<br />
Although the plugin allows for much more complex applications, the two that I use most frequently are outlined below. The first method uses a relatively small list of suggestions that is stored in an array locally. The second is a little more complex - it uses a remote CSV file of suggestions that is accessed through AJAX an PHP.<br />
<br />
I've put together a small demonstration [http://www.partnersinc.biz/surveys//index.php?sid=78611&newtest=Y&lang=en here] and implementation is as follows.<br />
<br />
'''Both methods:'''<br />
*[http://docs.jquery.com/Plugins/Autocomplete Download the plugin]<br />
*Place the files ''jquery.autocomplete.css'' and ''jquery.autocomplete.js'' in your template directory<br />
*Add the following code inside the <head> element of startpage.pstpl<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}jquery.autocomplete.js"></script><br />
<link rel="stylesheet" type="text/css" href="{TEMPLATEURL}jquery.autocomplete.css" /></syntaxhighlight><br />
<br />
'''Method 1 ("States" question in the demo):'''<br />
*Create a text input question<br />
*Add the following script to the source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace the states with your list of suggestions (comma separated)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var q1ID = QQ;<br />
<br />
var states = "Alabama,Alaska,Arizona,Arkansas,California,Colorado,Connecticut,Delaware, District of Columbia,Florida,Georgia,Hawaii,Idaho,Illinois,Indiana,Iowa,Kansas,Kentucky, Louisiana,Maine,Montana,Nebraska,Nevada,New Hampshire,New Jersey,New Mexico,New York, North Carolina,North Dakota,Ohio,Oklahoma,Oregon,Maryland,Massachusetts,Michigan, Minnesota,Mississippi,Missouri,Pennsylvania,Rhode Island,South Carolina,South Dakota, Tennessee,Texas,Utah,Vermont,Virginia,Washington,West Virginia,Wisconsin,Wyoming".split(',');<br />
<br />
$('#question'+q1ID+' input.text').autocomplete(states, {<br />
matchContains: true,<br />
minChars: 0<br />
});<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Method 2 ("Countries" question in the demo):'''<br />
*Place the CSV file of suggestions in your template directory. <br />
*Place a PHP file containing the code below in your template directory<br />
*Replace "countries2.csv" with your CSV filename (you could make this more universal by passing the filename in the URL)<br />
*This file will grab the contents of the CSV and encode them in JSON format that the JavaScript can use<br />
*Place the JavaScript code below in ths source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace "templates/yourTemplate/countries.php" with the path to the PHP file (from LimeSurvey root)<br />
*This script will grab the jsonized data from the PHP file and load it into an array that the plugin can use<br />
<br />
PHP code:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><?php<br />
<br />
$countriesArr = array();<br />
<br />
$file_handle = fopen("countries2.csv", "r");<br />
<br />
while (!feof($file_handle) ) {<br />
$line_of_text = fgetcsv($file_handle);<br />
array_push($countriesArr, $line_of_text[0]);<br />
}<br />
<br />
fclose($file_handle);<br />
<br />
echo json_encode($countriesArr);<br />
<br />
?></syntaxhighlight><br />
<br />
JavaScript code:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var qID = QQ;<br />
var url = "templates/yourTemplate/countries.php";<br />
var countriesArr = new Array();<br />
<br />
$.getJSON(url,function(data){<br />
<br />
$(data).each(function(i, item){<br />
countriesArr.push(item);<br />
});<br />
<br />
$('#question'+qID+' input.text').autocomplete(countriesArr, {<br />
matchContains: true,<br />
minChars: 0<br />
});<br />
});<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
== 1.91 and later versions==<br />
<br />
''Tested with: 1.91+, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
This workaround uses the [http://jqueryui.com/demos/autocomplete/ Autocomplete widget] included with jQuery UI to provide a respondent a list of suggested answers that the they can select from as they type in a text input.<br />
<br />
Although the plugin allows for much more complex applications, the two that I use most frequently are outlined below. The first method uses a relatively small list of suggestions that is stored in an array locally. The second is a little more complex - it uses a remote CSV file of suggestions that is accessed through AJAX an PHP.<br />
<br />
'''Both methods:'''<br />
*Add the following styles to the end of your 'template.css' file<br />
<br />
<syntaxhighlight lang="css" enclose="div">/* Autocomplete styles */<br />
<br />
ul.ui-autocomplete {<br />
width: 250px !important;<br />
padding: 5px 10px;<br />
list-style: none;<br />
}</syntaxhighlight><br />
<br />
'''Method 1 (use local JavaScript array for data):'''<br />
*Create a text input question<br />
*Add the following script to the source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace the states with your list of suggestions (comma separated)<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var q1ID = QQ;<br />
<br />
var states = "Alabama,Alaska,Arizona,Arkansas,California,Colorado,Connecticut,Delaware, District of Columbia,Florida,Georgia,Hawaii,Idaho,Illinois,Indiana,Iowa,Kansas,Kentucky, Louisiana,Maine,Montana,Nebraska,Nevada,New Hampshire,New Jersey,New Mexico,New York, North Carolina,North Dakota,Ohio,Oklahoma,Oregon,Maryland,Massachusetts,Michigan, Minnesota,Mississippi,Missouri,Pennsylvania,Rhode Island,South Carolina,South Dakota, Tennessee,Texas,Utah,Vermont,Virginia,Washington,West Virginia,Wisconsin,Wyoming".split(',');<br />
<br />
$('#question'+q1ID+' input.text').autocomplete({<br />
source: states<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Method 2 (use remote CSV file for data):'''<br />
*Place the CSV file of suggestions in your template directory<br />
*Place a PHP file containing the code below in your template directory<br />
*Replace "countries2.csv" with your CSV filename (you could make this more universal by passing the filename in the URL)<br />
*This file will grab the contents of the CSV and encode them in JSON format that the JavaScript can use<br />
*Place the JavaScript code below in ths source of the text question<br />
*Replace "QQ" with the ID of the text input question<br />
*Replace "templates/yourTemplate/countries.php" with the path to the PHP file (from LimeSurvey root)<br />
*This script will grab the jsonized data from the PHP file and load it into an array that the plugin can use<br />
<br />
PHP code:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><?php<br />
<br />
$countriesArr = array();<br />
<br />
$file_handle = fopen("countries2.csv", "r");<br />
<br />
while (!feof($file_handle) ) {<br />
$line_of_text = fgetcsv($file_handle);<br />
array_push($countriesArr, $line_of_text[0]);<br />
}<br />
<br />
fclose($file_handle);<br />
<br />
echo json_encode($countriesArr);<br />
<br />
?></syntaxhighlight><br />
<br />
JavaScript code:<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var qID = QQ;<br />
var url = "templates/yourTemplate/countries.php";<br />
var dataArr = [];<br />
<br />
$.getJSON(url,function(data){<br />
<br />
$.each(data,function(i, item){<br />
dataArr.push(item);<br />
});<br />
<br />
$('#question'+qID+' input.text').autocomplete({<br />
source: dataArr<br />
});<br />
<br />
});<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
== Use autocomplete to populate several fields==<br />
<br />
''Tested with: 1.91+, IE 7/8/9, Firefox 18''<br />
<br />
This workaround uses the [http://jqueryui.com/demos/autocomplete/ Autocomplete widget] included with jQuery UI and the [https://code.google.com/p/jquery-csv/source/browse/jquery.csv.js?r=f13189b2550a770ccaa777f1d747bc860b943fe7 jquery.csv.js] plugin to provide a respondent with a list of suggested answers as they type in a text input and then to automatically populate other fields depending on the selection.<br />
<br />
For example, if you have 3 questions - "Name", "ID" and "Email" - you can use this workaround to autocomplete the "Name" question and then the "ID" and "Email" questions can be automatically populated with values associated with the selected name.<br />
*Download the [https://code.google.com/p/jquery-csv/source/browse/jquery.csv.js?r=f13189b2550a770ccaa777f1d747bc860b943fe7 jquery.csv.js] plugin and place it in your template folder<br />
*If using LimeSurvey 1.9x, add the following line to your startpage.pstpl BEFORE the tag for template.js, if using 2.x, add it AFTER the {TEMPLATEJS} placeholder<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}jquery.csv.js"></script></syntaxhighlight><br />
*Create your CSV file with 3 columns (name, ID, email) as in this example and place it in your template folder<syntaxhighlight lang="php" enclose="div">Bob, Bob's ID, Bob's email<br />
<br />
Andy, Andy's ID, Andy's email<br />
<br />
Sam, Sam's ID, Sam's email<br />
<br />
Tony, Tony's ID, Tony's email<br />
<br />
Fred, Fred's ID, Fred's email</syntaxhighlight><br />
*Create your 3 questions - "Name", "ID" and "Email". They must be in the same group/page.<br />
*Add the following styles to the end of your 'template.css' file<syntaxhighlight lang="php" enclose="div">/* Autocomplete styles */<br />
<br />
ul.ui-autocomplete {<br />
<br />
width: 250px !important;<br />
<br />
padding: 5px 10px;<br />
<br />
list-style: none;<br />
<br />
}</syntaxhighlight><br />
*Add the following script to the source of one of the questions<br />
*Replace:<br />
**"NN" with the "Name" question ID<br />
**"II" with the "ID" question ID<br />
**"EE" with the "Email" question ID<br />
*Modify the path to your CSV file<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
var qNameID = NN;<br />
<br />
var qIDID = II;<br />
<br />
var qEmailID = EE;<br />
<br />
var url = "upload/templates/yourTemplate/yourCsvFile.csv";<br />
<br />
// Create an array to hold the names<br />
var namesArr = new Array();<br />
<br />
// Grab the CSV contents<br />
$.get(url,function(data){<br />
<br />
// Convert CSV contents to an array of arrays<br />
fullArray = $.csv.toArrays(data);<br />
<br />
// Load the names array<br />
$(fullArray).each(function(i, item){<br />
namesArr.push(item[0]);<br />
});<br />
<br />
// Initialise the autocomplete plugin<br />
$('#question'+qNameID+' input.text').autocomplete({<br />
source: namesArr,<br />
// Event fired when a selection is made (ui.item.value refers to the selected item)<br />
select: function(event, ui) {<br />
// Find the "ID" and "Email" values associated with the selected name value and load those questions<br />
$(fullArray).each(function(i, item){<br />
if(item[0] == ui.item.value) {<br />
// The value from column 2 of the CSV<br />
$('#question'+qIDID+' input.text').val(item[1]);<br />
// The value from column 3 of the CSV<br />
$('#question'+qEmailID+' input.text').val(item[2]);<br />
}<br />
});<br />
}<br />
});<br />
});<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Drag and Drop Rankings {{Deprecated|2.0}} =<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }} <br />
<br />
==Drag and Drop Ranking - Version 1.90 to 1.92==<br />
<br />
''Tested with: 1.90+ & 1.91RC4, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }} <br />
<br />
This workaround is a modification of the workaround below and also uses [http://jqueryui.com/demos/sortable/#connect-lists JQuery connected sortables]. Thanks to the author of that workaround.<br />
<br />
[[File:Untitled-12.png]]<br />
<br />
Modifications include:<br />
*Allow for multiple drag-n-drop ranking questions on a page<br />
*Handle minimum and maximum answers settings<br />
*Allow double clicking of items to add or remove them from the ranking list<br />
*Work with the new shipped jQuery UI<br />
<br />
There is a '''[http://www.partnersinc.biz/surveys//index.php?sid=36981&newtest=Y&lang=en demonstrated here]'''.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the large script below in your template.js file.<br />
#Place the small script below in the source a ranking question, (this applies the "dragDropRank" function to the question). Replace "QQ" with the ranking [http://docs.limesurvey.org/SGQA+identifier&structure;=English+Instructions+for+LimeSurvey#General_Description question ID].<br />
**Note: the LimeSurvey translations will be automatically used for the "Choices" and "Rankings" header labels but can be overridden with custom labels - see the example calls below.<br />
#Insert the CSS below at the end of template.css (these styles are for the default template).<br />
<br />
NOTE: I have not tested this workaround with conditions.<br />
<br />
'''Code for template.js:'''<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
function dragDropRank(qID, choiceText, rankText) {<br />
<br />
if(!choiceText) {<br />
choiceText = $('#question'+qID+' td.label label').text();<br />
}<br />
if(!rankText) {<br />
rankText = $('#question'+qID+' td.output tr:first td:eq(1)').text();<br />
}<br />
<br />
//Add a class to the question<br />
$('#question'+qID+'').addClass('dragDropRanking');<br />
<br />
// Hide the original question in LimeSurvey (so that we can replace with drag and drop)<br />
$('#question'+qID+' .rank, #question'+qID+' .questionhelp').hide();<br />
<br />
// Turn off display of question (to override error checking built into LimeSurvey ranking question)<br />
//$('#display'+qID).val('off');<br />
<br />
// Add connected sortables elements to the question<br />
var htmlCode = '<table class="dragDropTable"> \<br />
<tbody> \<br />
<tr> \<br />
<td> \<br />
<span class="dragDropHeader choicesLabel">'+choiceText+'</span><br /> \<br />
<div class="ui-state-highlight dragDropChoices"> \<br />
<ul id="sortable1'+qID+'" class="connectedSortable'+qID+' dragDropChoiceList"> \<br />
<li>Choices</li> \<br />
</ul> \<br />
</div> \<br />
</td> \<br />
<td> \<br />
<span class="dragDropHeader rankingLabel">'+rankText+'</span><br /> \<br />
<div class="ui-state-highlight dragDropRanks"> \<br />
<ol id="sortable2'+qID+'" class="connectedSortable'+qID+' dragDropRankList"> \<br />
<li>Ranks</li> \<br />
</ol> \<br />
</div> \<br />
</td> \<br />
</tr> \<br />
</tbody> \<br />
</table>';<br />
$(htmlCode).insertAfter('#question'+qID+' table.rank');<br />
<br />
// Remove placeholder list items (have to have one item so that LimeSurvey doesn"t remove the <ul>)<br />
$('#sortable1'+qID+' li, #sortable2'+qID+' li').remove();<br />
<br />
// Load any previously-set values<br />
loadDragDropRank(qID);<br />
<br />
// Find the number of LimeSurvey ranking inputs ("Maximum answers")<br />
var maxAnswer = $('#question'+qID+' td.output input.text').length;<br />
<br />
// Set up the connected sortable<br />
$('#sortable1'+qID+', #sortable2'+qID+'').sortable({<br />
connectWith: '.connectedSortable'+qID+'',<br />
placeholder: 'ui-sortable-placeholder',<br />
helper: 'clone',<br />
revert: 50,<br />
receive: function(event, ui) {<br />
if($('#sortable2'+qID+' li').length > maxAnswer) {<br />
alert ('You can only rank a maximum of '+maxAnswer+' choices.');<br />
$(ui.sender).sortable('cancel');<br />
}<br />
},<br />
stop: function(event, ui) {<br />
$('#sortable1'+qID+'').sortable('refresh');<br />
$('#sortable2'+qID+'').sortable('refresh');<br />
updateDragDropRank(qID);<br />
}<br />
}).disableSelection();<br />
<br />
// Get the list of choices from the LimeSurvey question and copy them as items into the sortable choices list<br />
$('#CHOICES_' + qID).children().each(function(index, Element) {<br />
var liCode = '<li class="ui-state-default" id="choice_' + $(this).attr("value") + '">' + this.text + '</li>'<br />
$(liCode).appendTo('#sortable1'+qID+'');<br />
});<br />
<br />
// Allow users to double click to move to selections from list to list<br />
$('#sortable1'+qID+' li').live('dblclick', function() {<br />
if($('#sortable2'+qID+' li').length == maxAnswer) {<br />
alert ('You can only rank a maximum of '+maxAnswer+' choices.');<br />
return false;<br />
}<br />
else {<br />
$(this).appendTo('#sortable2'+qID+'');<br />
$('#sortable1'+qID+'').sortable('refresh');<br />
$('#sortable2'+qID+'').sortable('refresh');<br />
updateDragDropRank(qID);<br />
}<br />
});<br />
$('#sortable2'+qID+' li').live('dblclick', function() {<br />
$(this).appendTo('#sortable1'+qID+'');<br />
$('#sortable2'+qID+'').sortable('refresh');<br />
$('#sortable1'+qID+'').sortable('refresh');<br />
updateDragDropRank(qID);<br />
});<br />
}<br />
<br />
// This function copies the drag and drop sortable data into the LimeSurvey ranking list.<br />
function updateDragDropRank(qID) {<br />
<br />
// Reload the LimeSurvey choices select element<br />
var rankees = [];<br />
$('#sortable2'+qID+' li').each(function(index) {<br />
$(this).attr('value', index+1);<br />
<br />
// Get value of ranked item<br />
var liID = $(this).attr("id");<br />
liIDArray = liID.split('_');<br />
<br />
// Save to an array<br />
rankees[rankees.length] = { "r_name":$(this).text(),"r_value":liIDArray[1] };<br />
});<br />
$('#question'+qID+' input[name<div class="simplebox">="RANK_"]').each(function(index) {<br />
if (rankees.length > index) {<br />
$(this).val(rankees[index].r_name);<br />
$(this).next('input').attr('value', rankees[index].r_value);<br />
} else {<br />
$(this).val('');<br />
$(this).next().val('');<br />
}<br />
});<br />
<br />
// Reload the LimeSurvey choices select element (we need this for "Minimum answers" code)<br />
$('#question'+qID+' td.label select option').remove();<br />
$('#sortable1'+qID+' li').each(function(index) {<br />
var liText = $(this).text();<br />
var liID = $(this).attr('id');<br />
liIDArray = liID.split('_');<br />
var optionCode = '<option value="'+liIDArray[1]+'">'+liText+'</option>';<br />
$(optionCode).appendTo('#question'+qID+' td.label select');<br />
});<br />
<br />
// Hack for IE6<br />
if ($.browser.msie && $.browser.version.substr(0,1)<7) {<br />
$('#question'+qID+' select').show();<br />
$('#question'+qID+' select').hide();<br />
}<br />
}<br />
<br />
// This function is called on page load to see if there are any items already ranked (from a previous visit<br />
// or cached due to a page change. If so, the already-ranked items are loaded into the sortable list<br />
function loadDragDropRank(qID) {<br />
<br />
var rankees = [];<br />
<br />
// Loop through each item in the built-in LimeSurvey ranking list looking for non-empty values<br />
$('#question'+qID+' input[name</div>="RANK_"]').each(function(index) {<br />
<br />
// Check to see if the current item has a value<br />
if ($(this).val()) {<br />
<br />
// Item has a value - save to the array<br />
// Use this element to contain the name and the next for the value (numeric)<br />
rankees[rankees.length] = { "r_name":$(this).val(),"r_value":$(this).next().val() };<br />
}<br />
});<br />
<br />
// Now that we have a list of all the pre-ranked items, populate the sortable list<br />
// Note that the items *won"t* appear in the main list because LimeSurvey has removed them.<br />
$.each(rankees, function(index, value) {<br />
<br />
// Create the items in the sortable<br />
var liCode = '<li class="ui-state-default" id="choice_' + value.r_value + '">' + value.r_name + '</li>';<br />
$(liCode).appendTo('#sortable2'+qID+'');<br />
});<br />
}</syntaxhighlight><br />
<br />
'''Code in the source of the question(s) using the LimeSurvey translations for the "Choices" and "Rankings" element header labels''' (replace "QQ" with the ranking [http://docs.limesurvey.org/SGQA+identifier&structure;=English+Instructions+for+LimeSurvey#General_Description question ID]):<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
dragDropRank(QQ);<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Fix for later versions of 1.91+'''<br />
In my version of LimeSurvey 1.91+, build 11026, this drag-n-drop workaround was not saving the selections properly. I'm not sure if that's because of my template, or other jquery uses, but I fixed it by making the following modifications to the above code placed into template.js.<br />
<br />
If you're having problems (and it's definitely worth testing that the rankings are actually saving into your response table before proceeding with the survey) give this a try.<br />
<br />
In the 'updateDragDropRank(qID)' function, replace the line:<br />
<syntaxhighlight><script><br />
$('#question'+qID+' input[name<div class="simplebox">="RANK_"]').each(function(index) {<br />
</script></syntaxhighlight><br />
with:<br />
<syntaxhighlight><script><br />
$('#question'+qID+' input[name^="RANK_"]').each(function(index) {<br />
</script></syntaxhighlight><br />
<br />
In the 'loadDragDropRank(qID) function, replace the line:<br />
<syntaxhighlight><script><br />
$('#question'+qID+' input[name</div>="RANK_"]').each(function(index) {<br />
</script></syntaxhighlight><br />
with:<br />
<syntaxhighlight><script><br />
$('#question'+qID+' input[name^="RANK_"]').each(function(index) {<br />
</script></syntaxhighlight><br />
<br />
<br />
'''Code in the source of the question(s) using custom text for the "Choices" and "Rankings" element header labels''' (replace "QQ" with the ranking [http://docs.limesurvey.org/SGQA+identifier&structure;=English+Instructions+for+LimeSurvey#General_Description question ID]):<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
dragDropRank(QQ, 'Custom Choices Label', 'Custom Rankings Label');<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Styles for template.css:'''<br />
<br />
<syntaxhighlight lang="css" enclose="div"><br />
/* Drag-n-drop ranking styles */<br />
.dragDropTable {<br />
border: 0 none;<br />
border-collapse: collapse;<br />
width: 100%;<br />
}<br />
<br />
.dragDropTable td {<br />
vertical-align: top;<br />
width: 50%;<br />
padding-right: 20px;<br />
}<br />
<br />
.dragDropTable .dragDropHeader {<br />
font-weight: bold;<br />
}<br />
<br />
.dragDropTable .dragDropChoices,<br />
.dragDropTable .dragDropRanks {<br />
margin: 5px 0 0 0;<br />
background: transparent none;<br />
border: 0 none;<br />
}<br />
<br />
.dragDropTable .dragDropChoiceList,<br />
.dragDropTable .dragDropRankList {<br />
float: left;<br />
width: 100%;<br />
min-height: 2.4em;<br />
_height: 2.4em; /* IE6 and below hack */<br />
margin: 0;<br />
padding: 0;<br />
list-style-type: none;<br />
background: #FBFBFB none;<br />
border: 1px solid #CCCCCC;<br />
}<br />
<br />
.dragDropTable .dragDropChoiceList li,<br />
.dragDropTable .dragDropRankList li {<br />
margin: 3px;<br />
*margin-left: -13px; /* IE7 and below */<br />
padding: 3px;<br />
min-height: 1.3em;<br />
_height: 1.3em; /* IE6 and below hack */<br />
font-weight: normal;<br />
cursor: move;<br />
display: block; /* Force the li to full width */<br />
}</syntaxhighlight><br />
<br />
==Drag and Drop Ranking using Images - Version 1.90 to 1.92==<br />
<br />
''Tested with: 1.90+ & 1.91RC4, IE 6/7/8, Firefox 3.6, Safari 3.2''<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }}<br />
<br />
This workaround works in conjunction with the above workaround to allow ranking of images.<br />
<br />
[[File:Untitled-11.png]]<br />
<br />
There is a '''[http://www.partnersinc.biz/surveys//index.php?sid=36981&newtest=Y&lang=en demonstrated here]'''.<br />
<br />
Implementation is as follows:<br />
<br />
1) Follow the above workaround to get basic drag-n-drop functionality in your ranking question.<br />
<br />
2) Insert your images in the ranking question text or help section after any text that you wish to have there (we'll move them later with JavaScript).<br />
<br />
3) Give the images '''EXACTLY''' the same IDs as the answer code you would like them to be associated with:[[File:Untitled-8.png]]<br />
<br />
4) Place the first script below in your template.js file.<br />
<br />
5) Place the second script below in the source the ranking question '''AFTER''' the initial call for the dragDropRank function from the workaround above. Replace "QQ" with the ID of the ranking question (this applies the "dragDropRankImages" function to the question).<br />
<br />
6) Insert the CSS below at the end of template.css. Replace "11" with your question ID. These styles are for the default template using 50x50px images (as in the demo) and may need to be modified for other templates or image sizes.<br />
<br />
'''Code for template.js:'''<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
function dragDropRankImages(qID) {<br />
<br />
$('.connectedSortable'+qID+' li').each(function(i) {<br />
<br />
// Remove any text in the sortable choice or rank items<br />
$(this).text('');<br />
<br />
// Move the images into the appropriate sortable list item<br />
var liID = $(this).attr('id');<br />
liIDArray = liID.split('_');<br />
$('#question'+qID+' img#'+liIDArray[1]+'').appendTo(this);<br />
});<br />
}</syntaxhighlight><br />
<br />
'''Code in the source of the question(s):'''<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
dragDropRankImages(QQ);<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
'''Styles for template.css:'''<br />
<br />
<syntaxhighlight lang="css" enclose="div"><br />
<br />
/* Drag-n-drop for ranking images */<br />
#question11 .dragDropTable {<br />
width: auto;<br />
}<br />
<br />
#question11 .dragDropTable .dragDropChoiceList,<br />
#question11 .dragDropTable .dragDropRankList {<br />
min-height: 60px;<br />
_height: 60px; /* IE6 and below hack */<br />
width: auto;<br />
min-width: 60px;<br />
_width: 60px; /* IE6 and below hack */<br />
}<br />
<br />
#question11 .dragDropTable li {<br />
background: 0 none;<br />
border: 0 none;<br />
height: 50px;<br />
width: 50px;<br />
}<br />
<br />
#question11 .dragDropTable li img {<br />
margin: 0;<br />
padding: 0;<br />
border: 0 none;<br />
}</syntaxhighlight><br />
<br />
==Drag and Drop Ranking for iPad - Version 1.91 and newer==<br />
<br />
''Tested with: LimeSurvey 1.91, iPad 2''<br />
<br />
This workaround extends the above workarounds to work with the touch interface on iPads.<br />
<br />
1) Follow the [[Workarounds: Manipulating a survey at runtime using Javascript#Drag and Drop Ranking - Version 1.90 and newer|Drag and Drop Ranking - Version 1.90 and newer]] workaround above to get basic drag-n-drop functionality in your ranking question.<br />
<br />
2) Download the [https://github.com/furf/jquery-ui-touch-punch jQuery.ui.touch-punch.js plugin] and save it in your template directory.<br />
<br />
3) Replace this line in your startpage.pstpl:<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}template.js"></script></syntaxhighlight>With this:<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" src="{TEMPLATEURL}jquery.ui.touch-punch.js"></script><br />
<br />
<script type="text/javascript" src="{TEMPLATEURL}template.js"></script></syntaxhighlight><br />
<br />
==Drag and Drop Ranking - Version 1.86==<br />
<br />
Tested with 1.86 on IE 7,8, FireFox 3, Chrome, and Safari 4<br />
<br />
{{Hint|Text=In 2.0 and up, this system Ranking question use jqueryui-sortable. This workaround is deprecated. }}<br />
<br />
This workaround uses [http://jqueryui.com/demos/sortable/#connect-lists JQuery connected sortables] to modify a ranking question and allow the survey taker to drag and drop choices instead of clicking. The nice thing is that the choices can be easily re-arranged or removed from the ranking, all by drag and drop.<br />
<br />
I used it for a voting application and some of the element names reflect that use.<br />
<br />
It looks best when some CSS is added to control the appearance of the boxers around each choice.<br />
<br />
[[File:drag-n-drop.png]]<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
// Question ID global variable<br />
var questionID;<br />
<br />
$(document).ready(function() {<br />
<br />
// Grab the question ID[[File:drag-n-drop.png]]<br />
// This is something with a class of "ranking" and an ID that starts with "questionXXXXX". The X's represent the question ID<br />
var entire_questionID = $(".ranking[id<div class="simplebox">='question']").attr('id');<br />
<br />
// Get just the question number (ID)<br />
var patt=/\d+$/;<br />
questionID=patt.exec(entire_questionID);<br />
<br />
// Hide the original quetion in LimeSurvey (so that we can replace with drag and drop)<br />
$(".rank, .questionhelp").hide();<br />
<br />
// Turn off display of question (to override error checking built into LimeSurvey ranking question)<br />
$("#display"+questionID).val("off");<br />
<br />
// Add connected sortables to the question<br />
var html_code = "<table style='border: medium none ; width: 770px; margin-left: auto; \<br />
margin-right: auto;'><tbody><tr><td style='width: 590px; vertical-align: top;'><h3>List of Candidates:</h3> \<br />
<div class='ui-state-highlight' style='margin: 5px; float: left;' id='ballot_list'> \<br />
<ul id='sortable1' class='connectedSortable'><li>Candidates</li></ul></div></td> \<br />
<td style='vertical-align: top;'><h3>Your selections:</h3><div class='ui-state-highlight' \<br />
style='margin: 5px; float: left;' id='voting_selections'><ol id='sortable2' class='connectedSortable'> \<br />
<li>Voting Area</li></ol></div></td></tr></tbody></table>";<br />
$(html_code).appendTo("#question" + questionID);<br />
<br />
// Remove list items (have to have one item so that LimeSurvey doesn't remove the <ul>)<br />
$("#sortable1 li, #sortable2 li").remove();<br />
<br />
// Load any previously-set values<br />
loadRanking();<br />
<br />
// Load jQuery UI<br />
$.getScript("/scripts/jquery/jquery-ui.js", function() {<br />
<br />
// After JQuery UI finishes loading, set up the connected sortable.<br />
$("#sortable1, #sortable2").sortable({<br />
connectWith: '.connectedSortable',<br />
placeholder: 'ui-sortable-placeholder',<br />
stop: function(event, ui) {<br />
$("#sortable1").sortable("refresh");<br />
$("#sortable2").sortable("refresh");<br />
updateRanking();<br />
}<br />
}).disableSelection();<br />
<br />
// Get the list of candidates from the built-in LimeSurvey question and copy them as items in sortable1<br />
$("#CHOICES_" + questionID).children().each(function(index, Element) {<br />
li_tag = "<li class='ui-state-default' id='choice_" + $(this).attr('value') + "'>" + this.text + "</li>"<br />
$(li_tag).appendTo("#sortable1"); } );<br />
<br />
// Make sure the submit button is showing<br />
$(":submit[value|=' Submit']").show();<br />
<br />
// Show a confirmation alert upon submit<br />
$("form").submit(function() {<br />
<br />
// Override the built-in "disable navigation buttons" feature<br />
$('#moveprevbtn, #movenextbtn, #movesubmitbtn').attr('disabled', '');<br />
var validated = confirm("Cast your ballot now?");<br />
if (validated) { return true; } else { return false; }<br />
});<br />
<br />
// Allow users to double click to move to selection list<br />
$("#sortable1 li").assignDblClick();<br />
}); // End of JQuery UI loading<br />
<br />
}); // End of JQuery ready function<br />
<br />
// Define the actions when an item is double clicked<br />
$.fn.assignDblClick = function() {<br />
$(this).dblclick(function(){<br />
$(this).appendTo('#sortable2');<br />
$("#sortable1").sortable("refresh");<br />
$("#sortable2").sortable("refresh");<br />
updateRanking();<br />
});<br />
}<br />
<br />
// This function copies the drag and drop sortable data into the standard LimeSurvey ranking structure.<br />
function updateRanking() {<br />
var rankees = [];<br />
$('#sortable2 li').each(function(index) {<br />
$(this).attr("value", index+1);<br />
<br />
// Get value of person<br />
li_tag = $(this).attr('id');<br />
li_tag_array = li_tag.split("_");<br />
<br />
// Save to an array<br />
rankees[rankees.length] = { 'r_name':$(this).text(),'r_value':li_tag_array[1] };<br />
});<br />
$("input[name</div>='RANK_']").each(function(index) {<br />
if (rankees.length > index) {<br />
$(this).val(rankees[index].r_name);<br />
$(this).next().val(rankees[index].r_value);<br />
} else {<br />
$(this).val("");<br />
$(this).next().val("");<br />
}<br />
});<br />
<br />
// Re-assign double click action to first list items and remove<br />
// double click action from section list items<br />
$('#sortable1 li').unbind('dblclick').assignDblClick();<br />
$('#sortable2 li').unbind('dblclick');<br />
}<br />
<br />
// This function is called on page load to see if there are any items already ranked (from a previous visit<br />
// or cached due to a page change. If so, the already-ranked items are loaded into the sortable list<br />
function loadRanking() {<br />
var rankees = [];<br />
<br />
// Loop through each item in the built-in LimeSurvey ranking list looking for non-empty values<br />
$("input[name<div class="simplebox">='RANK_']").each(function(index) {<br />
<br />
// Check to see if the current item has a value<br />
if ($(this).val()) {<br />
// Item has a value - save to the array<br />
// Use this element to contain the name and the next for the value (numeric)<br />
rankees[rankees.length] = { 'r_name':$(this).val(),'r_value':$(this).next().val() };<br />
}<br />
});<br />
<br />
// Now that we have a list of all the pre-ranked items, populate the sortable list<br />
// Note that the items *won't* appear in the main list because LimeSurvey has removed them.<br />
$.each(rankees, function(index, value) {<br />
// Create the items in the sortable<br />
li_tag = "<li class='ui-state-default' id='choice_" + value.r_value + "'>" + value.r_name + "</li>";<br />
$(li_tag).appendTo("#sortable2");<br />
});<br />
}</syntaxhighlight><br />
<br />
=Create MaxDiff question type=<br />
<br />
See the [[Workarounds: Question design, layout and templating|Question design, layout and templating]] section for a workaround that uses JavaScript to convert an '''''Array (flexible labels) by column''''' question into a [http://en.wikipedia.org/wiki/MaxDiff MaxDiff] question type.<br />
<br />
[[File:max_diff_596x253.gif]]<br />
<br />
=In a checkbox matrix, have the 'none' option in a row disable all other columns in that row=<br />
<br />
''Tested with: LimeSurvey 1.90+''<br />
<br />
The questionId parameter is the base ID of the question matrix (multiflexible).<br />
<br />
numColumns and numRows speak for themselves<br />
<br />
specialColumns is an array of the columns that have the special ability that when one of them<br />
<br />
is checked, none of the others can be checked. E.g., a 'none of these' and/or a 'do now know' option.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script><br />
<br />
numColumns=13;<br />
<br />
numRows=18;<br />
<br />
questionId='28417X2X24';<br />
<br />
specialColumns=[1,12,13];<br />
<br />
function action(obj){<br />
<br />
locator=obj.id.replace('cbox_'+questionId, '').split('_');<br />
<br />
row=locator[0];<br />
<br />
column=locator[1];<br />
<br />
//alert('Action for row,column='+row+','+column);<br />
<br />
my_id='#cbox_'+questionId+row+'_'+column+''<br />
<br />
if($(my_id).attr('checked') == false) {<br />
<br />
for( var i=1; i<=numColumns; i++ ) {<br />
<br />
if(i==column) continue;<br />
<br />
id='#cbox_'+questionId+row+'_'+i<br />
<br />
$(id).attr('disabled',false);<br />
<br />
}<br />
<br />
} else {<br />
<br />
for( var i=1; i<=numColumns; i++ ) {<br />
<br />
if(i==column) continue;<br />
<br />
id='#cbox_'+questionId+row+'_'+i<br />
<br />
aid='#answer'+questionId+row+'_'+i<br />
<br />
$(aid).val(0);<br />
<br />
$(id).attr('checked',false);<br />
<br />
$(id).attr('disabled',true);<br />
<br />
}<br />
<br />
}<br />
<br />
}<br />
<br />
function customOnLoad(){<br />
<br />
for( var row=1; row<=numRows; row++ ) {<br />
<br />
for( var k=0; k<specialColumns.length; k++ )<br />
<br />
{<br />
<br />
column=specialColumns[k];<br />
<br />
$('#cbox_'+questionId+row+'_'+column).change(function() {<br />
<br />
action(this);<br />
<br />
});<br />
<br />
}<br />
<br />
}<br />
<br />
}<br />
<br />
jQuery(document).ready(<br />
<br />
function(){<br />
<br />
customOnLoad();<br />
<br />
}<br />
<br />
);<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Last Option In Array (Numbers) (Checkboxes) Row Excludes All Others=<br />
<br />
''Tested with: 2.05, IE 7-10, Firefox''<br />
<br />
This workaround uses JavaScript/jQuery to make the last option of each Array (Numbers) (Checkboxes) row exclude all other options in the same row.<br />
<br />
The script will uncheck all options in a row if the last option is checked and uncheck the last option in a row if any other options are checked.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the following script in the source of the array question.<br />
<br />
NOTE: Care should be taken when using this script and conditional questions on the same page.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript" charset="utf-8"> <br />
$(document).ready(function() {<br />
// Call the exclude function using question ID<br />
excludeOpt ({QID});<br />
});<br />
<br />
// A function to make the last option in each array row exclusive<br />
function excludeOpt (qID) {<br />
<br />
var thisQuestion = $('#question'+qID)<br />
<br />
// Add some classes to the checkbox cells<br />
$('table.question tbody td', thisQuestion).addClass('normalOpt');<br />
$('table.question tbody tr', thisQuestion).each(function(i) {<br />
$('.normalOpt:last', this).removeClass('normalOpt').addClass('exlusiveOpt')<br />
});<br />
<br />
// A listener on the checkbox cells<br />
$('table.question tbody td', thisQuestion).click(function (event) {<br />
<br />
// Set some vars<br />
var thisRow = $(this).closest('tr');<br />
<br />
// Uncheck the appropriate boxes in a row<br />
if ($(this).hasClass('normalOpt')) {<br />
$('.exlusiveOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
else {<br />
$('.normalOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
});<br />
<br />
// A listener on the checkboxes<br />
$('table.question tbody td input[type=checkbox]', thisQuestion).click(function (event) {<br />
<br />
// Set some vars<br />
var thisRow = $(this).closest('tr');<br />
var thisCell = $(this).closest('td');<br />
<br />
// Uncheck the appropriate boxes in a row<br />
if ($(thisCell).hasClass('normalOpt')) {<br />
$('.exlusiveOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
else {<br />
$('.normalOpt input[type=checkbox]', thisRow).attr('checked', false);<br />
}<br />
});<br />
} <br />
</script></syntaxhighlight><br />
<br />
=Add Navigation Buttons (Next and Previous) To Top Of Page=<br />
<br />
''Tested with: 1.90+, IE 7/8, Firefox 3.6, Safari 3.2''<br />
<br />
Add the following to the end of template.js. It will insert a new div after the progress bar and then insert clones of the nav buttons in the new div.<br />
<br />
This example is for the default template in 1.90 or 1.91. The placement of the new div may need to be modified for other templates.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
$(document).ready(function() {<br />
<br />
// Insert a new div after the progress bar<br />
$('<div id="navigator2" />').insertAfter('#progress-wrapper');<br />
<br />
// Style the new div<br />
$('#navigator2').css({<br />
'text-align':'center'<br />
});<br />
<br />
// Insert clones of the nav buttons in the new div<br />
$('input.submit:eq(0)').clone().appendTo('#navigator2');<br />
$('input.submit:eq(2)').clone().appendTo('#navigator2');<br />
<br />
// Give the new buttons some new IDs<br />
$('#navigator2 input.submit').each(function(i) {<br />
var oldID = $(this).attr('id');<br />
var newID = oldID + '2';<br />
$(this).attr('id', newID)<br />
});<br />
});</syntaxhighlight><br />
<br />
[[File:extra_buttons.png]]<br />
<br />
=How to ''add'' an opt out link to your survey=<br />
<br />
Tested with: 1.91+, Firefox 5.0<br />
<br />
This javascript inserts a link to opt out of the survey above the progress bar.<br />
<br />
[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|How to use script here]]<br />
<br />
Then insert the following code into to the source of a group description or a question. I used the group description.<br />
<br />
<syntaxhighlight lang="php" enclose="div"> <script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Find the survey ID<br />
if($('input#fieldnames').length != 0) {<br />
var fieldNames = $('input#fieldnames').attr('value');<br />
var tmp = fieldNames.split('X');<br />
var sID = tmp[0];<br />
}<br />
<br />
// Insert a new div after the progress bar<br />
$('<div id="optOutLink" />').insertBefore('#progress-wrapper');<br />
<br />
// Style the new div<br />
$('#optOutLink').css({<br />
'text-align':'center'<br />
});<br />
<br />
// Insert opt out url in the new div<br />
$('#optOutLink').html('<p><a href="optout.php?lang=en&sid;='+sID+'&token;={TOKEN}">Click here to opt out of this survey.</a></p><br>');<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Anonymously track respondents answers across multiple surveys=<br />
<br />
''Tested with: 1.91+ and 1.92+''<br />
<br />
This workaround uses JavaScript/jQuery to enable tracking of respondents across multiple surveys ensuring anonymity (it does not use tokens).<br />
<br />
To do this you have to use this question in all the surveys you want to link respondents answers.<br />
<br />
This workaround create an ID by asking some partial personal information (like initials, birth month ...). The ID will be encrypted using a one-way function (in this case SHA-1) and stored in a short text answer.<br />
<br />
Implementation is as follows:<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the following code in the source of a short text question.<br />
#Optional: you can also add other select field to avoid collisions (e.g. for large population sample)<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<p>This answers are used to generate your ID. These information will be encrypted, it will not be possible in any case to identify you neither from your answers nor from your ID.</p><br />
<br />
<table><br />
<br />
<tr><br />
<br />
<td>Initial of your name</td><br />
<br />
<td><br />
<br />
<select id="field1"><br />
<br />
<option value=""></option><br />
<br />
<option value="A">A</option><br />
<br />
<option value="B">B</option><br />
<br />
<option value="C">C</option><br />
<br />
<option value="D">D</option><br />
<br />
<option value="E">E</option><br />
<br />
<option value="F">F</option><br />
<br />
<option value="G">G</option><br />
<br />
<option value="H">H</option><br />
<br />
<option value="I">I</option><br />
<br />
<option value="J">J</option><br />
<br />
<option value="K">K</option><br />
<br />
<option value="L">L</option><br />
<br />
<option value="M">M</option><br />
<br />
<option value="N">N</option><br />
<br />
<option value="O">O</option><br />
<br />
<option value="P">P</option><br />
<br />
<option value="Q">Q</option><br />
<br />
<option value="R">R</option><br />
<br />
<option value="S">S</option><br />
<br />
<option value="T">T</option><br />
<br />
<option value="U">U</option><br />
<br />
<option value="V">V</option><br />
<br />
<option value="W">W</option><br />
<br />
<option value="X">X</option><br />
<br />
<option value="Y">Y</option><br />
<br />
<option value="Z">Z</option><br />
<br />
</select><br />
<br />
</td><br />
<br />
</tr><br />
<br />
<tr><br />
<br />
<td>Your birth month</td><br />
<br />
<td><br />
<br />
<select id="field2"><br />
<br />
<option value=""></option><br />
<br />
<option value="01">January</option><br />
<br />
<option value="02">February</option><br />
<br />
<option value="03">March</option><br />
<br />
<option value="04">April</option><br />
<br />
<option value="05">May</option><br />
<br />
<option value="06">June</option><br />
<br />
<option value="07">July</option><br />
<br />
<option value="08">August</option><br />
<br />
<option value="09">September</option><br />
<br />
<option value="10">October</option><br />
<br />
<option value="11">November</option><br />
<br />
<option value="12">December</option><br />
<br />
</select><br />
<br />
<td><br />
<br />
</tr><br />
<br />
</table><br />
<br />
<script type="text/javascript" src="http://crypto-js.googlecode.com/svn/tags/3.0.2/build/rollups/sha1.js"></script><br />
<br />
<script type="text/javascript"><br />
<br />
$(document).ready(function() {<br />
<br />
$("#answer{SGQ}").attr('readonly', 'readonly');<br />
<br />
//$("#answer{SGQ}").css('display', 'none'); //uncomment this line for not displaying the code<br />
<br />
});<br />
<br />
$('#field1, #field2').bind('change keyup', function() {<br />
<br />
if ($("#field1").val()=='' || $("#field2").val()=='')<br />
<br />
$("#answer{SGQ}").val('');<br />
<br />
else {<br />
<br />
var sha1 = CryptoJS.algo.SHA1.create();<br />
<br />
sha1.update($("#field1").val());<br />
<br />
sha1.update($("#field2").val());<br />
<br />
// sha1.update($("#otherfield").val());<br />
<br />
var hash = sha1.finalize();<br />
<br />
$("#answer{SGQ}").val(hash);<br />
<br />
}<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=Check validity of international phone number in subquestion=<br />
<br />
''Tested with: 1.91+, Firefox 8, Chrome 15''<br />
<br />
As of version 1.92, you can use the core Validation querstion option to validate multiple short text and array text questions. Any question that fails that validation check will have its background color changed to red.<br />
<br />
Note, the below workaround will fail in version 1.92 because it contains a regular expression with curly braces. However, as described above, support for this feature is now built-in to version 1.92<br />
<br />
This workaround uses javascript to check the validity of an international phone number in a subquestion of multiple short text.<br />
<br />
Add the following code to the source of your question.<br />
<br />
Replace "QQ" with the question ID and "NN" with the row number that you want to validate.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Call the phone function with the question ID and the row number<br />
<br />
phoneTest(QQ, NN);<br />
<br />
function phoneTest(qID, inputNum) {<br />
<br />
// Interrupt next/submit function<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
// Some vars - modify as required<br />
<br />
var phoneMatch = /^[0-9,+,(), ,]{1,}(,[0-9]+){0,}$/;<br />
<br />
var msg1 = 'Please enter a valid phone number.';<br />
<br />
// Test the input<br />
<br />
var phoneInput = $('#question'+qID+' li:eq('+(inputNum-1)+') input.text').val();<br />
<br />
if(phoneInput != '' && !phoneMatch.test(phoneInput)) {<br />
<br />
alert(msg1);<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'pink' });<br />
<br />
return false;<br />
<br />
}<br />
<br />
else {<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'' });<br />
<br />
return true;<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
The regex is from: [http://www.regexlib.com/REDetails.aspx?regexp_id=1136 regexlib.com blank]<br />
<br />
=Check validity of email address in subquestion=<br />
<br />
'Tested with: 1.91+, Firefox 8, Chrome 15''<br />
<br />
<div class="simplebox">As of version 1.92, you can use the core Validation querstion option to validate multiple short text and array text questions. Any question that fails that validation check will have its background color changed to red.<br />Note, the below workaround will fail in version 1.92 because it contains a regular expression with curly braces. However, as described above, support for this feature is now built-in to version 1.92</div><br />
<br />
This workaround uses javascript to check the validity of an email address in a subquestion of multiple short text.<br />
<br />
Add the following code to the source of your question.<br />
<br />
Replace "QQ" with the question ID and "NN" with the row number that you want to validate.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Call the email function with the question ID and the row number<br />
<br />
emailTest(QQ, NN);<br />
<br />
function emailTest(qID, inputNum) {<br />
<br />
// Interrupt next/submit function<br />
<br />
$('#movenextbtn, #movesubmitbtn').click(function(){<br />
<br />
// Some vars - modify as required<br />
<br />
var emailMatch = /^[a-zA-Z0-9\_\-]+[a-zA-Z0-9\.\_\-]*@([a-zA-Z0-9\_\-]+\.)+([a-zA-Z]{2,4}|travel|museum)$/;<br />
<br />
var msg1 = 'Please enter a valid email address.';<br />
<br />
// Test the input<br />
<br />
var emailInput = $('#question'+qID+' li:eq('+(inputNum-1)+') input.text').val();<br />
<br />
if(emailInput != '' && !emailMatch.test(emailInput)) {<br />
<br />
alert(msg1);<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'pink' });<br />
<br />
return false;<br />
<br />
}<br />
<br />
else {<br />
<br />
$('#question'+qID+' li:eq('+(inputNum-1)+') input.text').css({ 'background':'' });<br />
<br />
return true;<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
The regex is from: [http://www.regexlib.com/REDetails.aspx?regexp_id=1653 regexlib.com blank]<br />
<br />
=Hiding the help-text when it's empty=<br />
<br />
Tested with: 1.91+<br />
<br />
I had made a style in my template putting a border around my help-text. To avoid empty help-text to show up (and have lines instead of just 'nothing' when there was no help text, I used this piece of code in question.pstpl:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
var questionhelp="{QUESTIONHELP}";<br />
<br />
if (questionhelp=="") {<br />
<br />
document.write("");}<br />
<br />
else {<br />
<br />
document.write('<tr><td class="survey-question-help">'+ questionhelp +'</td></tr>');}<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
it can probably be optimized but it worked for me<br />
<br />
=Disable or hide selected fields in a matrix question=<br />
<br />
''Tested with: 1.92+, IE 7/8/9, FireFox 12/13''<br />
<br />
TASK<br />
<br />
Hide or disable selected fields in a Matrix, so that users cannot make any input.<br />
<br />
(See example, where users should not make input into red framed fields)<br />
<br />
[[File:snap035.gif]]<br />
<br />
Fig. 1: Prevent users from input into first two fields (as an example)<br />
<br />
SOLUTION<br />
<br />
First find the name of the fields you want to hide / disable. In my case I used Firebug with firefox to figure that out.<br />
<br />
[[File:snap037.gif]]<br />
<br />
Fig. 2: Figure out the name(s) of the field(s)<br />
<br />
Then put the following script-code into the HTML-source code as described above:<br />
<br />
Note: you have to change the code to match the names of your fields!<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<br />
<script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
$('input[name="69965X2X10SQ001_SQ001"]').attr('disabled', 'disabled');<br />
<br />
$('input[name="69965X2X10SQ001_SQ002"]').attr('hidden', 'hidden');<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
[[File:snap039.gif]]<br />
<br />
Fig. 3: Result: first field is diabled ("greyed out"), second one is completely hidden<br />
<br />
I think this way one can apply many other attributes to a field like color etc. But did not try that myself.<br />
<br />
Thanks to roB2009 for the input in the forum!<br />
<br />
=Add prefix or suffix to question type "Array (Texts)"=<br />
<br />
TASK<br />
<br />
Add a prefix or suffix to the text fields in questions of the "Array (Texts)" type.<br />
<br />
[[File:suffix.png]]<br />
<br />
Fig. 1: Suffix<br />
<br />
[[File:prefix.png]]<br />
<br />
Fig. 1: Prefix<br />
<br />
SOLUTION<br />
*Set up your survey to use JavaScript.<br />
*Add the following script to the source of the array. Replace "12345" with the array question ID and modify the suffixes/prefixes as required.<br />
*The function call must consist of a question ID followed by the suffixes for each column. Suffixes/Prefixes must be enclosed in quotes and comma separated.<br />
*In this example question ID 12345 will get an "in &euro;" suffix in the first column and an "in %" in the next 3 columns.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><script type="text/javascript" charset="utf-8"><br />
<br />
$(document).ready(function() {<br />
<br />
// Call the function with the question ID followed by a comma-separated list of suffixes<br />
<br />
addSuffix(12345, 'in &euro;', 'in %', 'in %', 'in %');<br />
<br />
function addSuffix() {<br />
<br />
var qID = $(arguments)[0];<br />
<br />
// Assign some column-specific classes<br />
<br />
$('#question'+qID+' table.question tbody tr').each(function(i){<br />
<br />
$('td', this).each(function(i){<br />
<br />
$(this).addClass('answerCol-'+(i+1)+'');<br />
<br />
});<br />
<br />
});<br />
<br />
// Some styling<br />
<br />
$('#question'+qID+' table.question tbody input[type="text"]').css({<br />
<br />
'width': '50%'<br />
<br />
});<br />
<br />
// Insert the suffixes<br />
<br />
$(arguments).each(function(i, val){<br />
<br />
if(i > 0) {<br />
<br />
$('#question'+qID+' td.answerCol-'+i+' label').append(val);<br />
<br />
}<br />
<br />
});<br />
<br />
}<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
For adding a prefix you need to substitute the following line in the code<br />
<br />
<syntaxhighlight lang="php" enclose="div">$('#question'+qID+' td.answerCol-'+i+' label').append(val);</syntaxhighlight><br />
<br />
with this<br />
<br />
<syntaxhighlight lang="php" enclose="div">$('#question'+qID+' td.answerCol-'+i+' label').prepend(val);</syntaxhighlight><br />
<br />
=Time question (Date question-like)=<br />
<br />
''Tested with: 1.92+''<br />
<br />
This workaround uses JavaScript/jQuery to build a Time question just like to the Date one.<br />
<br />
Implementation is as follows:<br />
#Download the file at [http://trentrichardson.com/examples/timepicker/jquery-ui-timepicker-addon.js trentrichardson.com/examples/timepicker/jquery-ui-timepicker-addon.js] and upload it to your survey.<br />
#[[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
#Place the following code in the source of a short text question.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script src="/upload/surveys/{SID}/jquery-ui-timepicker-addon.js"></script><br />
<br />
<script><br />
<br />
$(document).ready(function(){<br />
<br />
$('#answer{SGQ}').timepicker({<br />
timeText: 'Time', //here translation<br />
hourText: 'hour', //here translation<br />
minuteText: 'minute', //here translation<br />
closeText: 'Done' //here translation<br />
});<br />
<br />
$('#answer{SGQ}').attr('readonly', 'readonly');<br />
<br />
$( "<style>"<br />
+".ui-widget-header, .ui-datepicker-current { display:none; }"<br />
+".ui-timepicker-div dl dt { height: 25px; margin-bottom: -25px; }"<br />
+".ui-timepicker-div dl dd { margin: 0 10px 10px 65px; }"<br />
+" }"<br />
+"</style>").appendTo( "head" );<br />
<br />
});<br />
<br />
</script></syntaxhighlight><br />
<br />
=Calculating date difference=<br />
<br />
''Tested with: 1.92+ Build 120909''<br />
<br />
This workaround explains how calculate difference between two dates (in: days, weeks, months and years) and is based on this [http://ditio.net/2010/05/02/javascript-date-difference-calculation/ resource external].<br />
<br />
Requieres 2 groups and 'group by group' or 'question by question' presentation.<br />
<br />
Group 1 (2 date questions)<br />
*1st question - Question code: "DD"<br />
*2nd question - Question code: "D2"<br />
<br />
Group 2<br />
*1 numerical input question.<br />
<br />
This question retrieves the number of days between the 2 dates, and check if D2 is posterior than DD.<br />
<br />
All the requiered code have to be added in the source of this numerical question.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<script type="text/javascript"><br />
<br />
/*<br />
<br />
Adapted from http://ditio.net/2010/05/02/javascript-date-difference-calculation/<br />
*/<br />
<br />
var DateDiff = {<br />
<br />
inDays: function(d1, d2) {<br />
<br />
var t2 = d2.getTime();<br />
<br />
var t1 = d1.getTime();<br />
<br />
return parseInt[[t2-t1)/(24*3600*1000]];<br />
<br />
},<br />
<br />
inWeeks: function(d1, d2) {<br />
<br />
var t2 = d2.getTime();<br />
<br />
var t1 = d1.getTime();<br />
<br />
return parseInt[[t2-t1)/(24*3600*1000*7]];<br />
<br />
},<br />
<br />
inMonths: function(d1, d2) {<br />
<br />
var d1Y = d1.getFullYear();<br />
<br />
var d2Y = d2.getFullYear();<br />
<br />
var d1M = d1.getMonth();<br />
<br />
var d2M = d2.getMonth();<br />
<br />
return (d2M+12*d2Y)-(d1M+12*d1Y);<br />
<br />
},<br />
<br />
inYears: function(d1, d2) {<br />
<br />
return d2.getFullYear()-d1.getFullYear();<br />
<br />
}<br />
<br />
}<br />
<br />
d1 = new Date({substr(DD,0,4)}, {substr(DD,5,2)}, {substr(DD,8,2)});<br />
<br />
d2 = new Date({substr(D2,0,4)}, {substr(D2,5,2)}, {substr(D2,8,2)});<br />
<br />
// Displays result<br />
<br />
document.write("<br />Number of <b>days</b>: "+DateDiff.inDays(d1, d2));<br />
<br />
document.write("<br />Number of <b>weeks</b>: "+DateDiff.inWeeks(d1, d2));<br />
<br />
document.write("<br />Number of <b>months</b>: "+DateDiff.inMonths(d1, d2));<br />
<br />
document.write("<br />Number of <b>years</b>: "+DateDiff.inYears(d1, d2));<br />
<br />
// filled the numerical input with number of days (or nights)<br />
<br />
var nDays = +DateDiff.inDays(d1, d2);<br />
<br />
jQuery(document).ready(function() {<br />
<br />
$(".numeric:eq(0) input.text").val(nDays);<br />
<br />
$(".numeric:eq(0) input.text").attr('readonly','readonly');<br />
<br />
// check if d2 > d1<br />
<br />
$('#movenextbtn').hide();<br />
<br />
$('#movesubmitbtn').hide();<br />
<br />
if(nDays >= 0){<br />
<br />
// automatic submit (uncomment if needed)<br />
<br />
// document.limesurvey.submit();<br />
<br />
// $('body').hide();<br />
<br />
}<br />
<br />
else alert("Check out date must be posterior than Check in\nPlease return to the previous page and edit your answers");<br />
<br />
});<br />
<br />
</script><br />
<br />
</syntaxhighlight><br />
<br />
=How to set minDate/maxDate based on other Datequestions=<br />
<br />
'' tested with Version 2.00+ Build 130708''<br />
<br />
QQ1 and QQ2 are the question identifiers. QQ2 gets as maxDate today and as minDate the date set in QQ1. The onClose event is needed because on document.ready the value of QQ1 is not yet known, although the value of today is.<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<script type="text/javascript" charset="utf-8"><br />
$(document).ready(function () {<br />
'use strict';<br />
var qID1 = QQ1,<br />
qID2 = QQ2,<br />
q1 = $('#question' + 'QQ1' + ' .popupdate'), <br />
q2 = $('#question' + 'QQ2' + ' .popupdate');<br />
<br />
//if q1 loses focus, its value is taken and used as minDate in q2 <br />
q1.datepicker("option", "onClose", function (datum){<br />
q2.datepicker( "option", "minDate", datum );<br />
});<br />
//q2 gets today as its maxDate<br />
q2.datepicker( 'option', 'maxDate', new Date() );<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
=Remove Question Help if empty=<br />
<br />
''Version 2.00+ Build 130513''<br />
<br />
Change your question.pstpl in your Template Editor so that the line looks like below. I've added the ID tag help_{question_number}.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<tr><td class="survey-question-help" id=help_{QUESTION_NUMBER}>{QUESTIONHELP}</td></tr><br />
</syntaxhighlight><br />
<br />
You can then add the following javascript at the end of question.pstpl. If the contents of the help tag is empty then hide the element.<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script><br />
$(document).ready(function(){<br />
if($('#help_{QUESTION_NUMBER}').is(':empty')){<br />
$('#help_{QUESTION_NUMBER}').hide();<br />
}<br />
});<br />
</script><br />
</syntaxhighlight><br />
<br />
= Implicit Association Test (IAT)=<br />
<br />
''Tested with: 2.0, IE 7-10, Firefox, Chrome, iPad''<br />
<br />
This workaround uses JavaScript to insert an IAT interface into an Array (Texts) question. The workaround prompts respondents to assign words or phrases using the "E" or "I" keys. In mobile devices, "E" and "I" buttons are provided.<br /><br /><br />
<br />
[[File:Iat_1.png]]<br /><br /><br />
<br />
Download a [[Media:Demo_IAT_Concept.zip|working template]] and [[Media:Demo_iat_concept.lss|working survey]].<br />
<br />
Implementation is as follows:<br />
<br />
1) [[Workarounds: Manipulating a survey at runtime using Javascript#How to use Script (eg. JavaScript etc.) in LimeSurvey?|Set up your survey to use JavaScript]].<br />
<br />
2) Create your Array (Texts) with sub-questions as follows:<br /><br />
- Y scale - all of your "attribut" words or phrases<br /><br />
- X scale - "Key Pressed" and "Elapsed Time (ms)"<br /><br />
[[File:Iat_2.jpg]]<br />
<br />
3) Insert your association terms and the other text elements for the interface into the Question Help section as depicted below. The text strings must be separated with "double pipes" (||) and you will need to place them in the following order:<br /><br />
- Left association term<br /><br />
- Right association term<br /><br />
- Instructional text<br /><br />
- Finished text<br /><br />
[[File:Iat_3.png]]<br />
<br />
4) Add the following to the end of template.js:<syntaxhighlight lang="javascript" enclose="div"><br />
// A plugin to insert an IAT interface<br />
function implicitAssociation(el, showAnswers) {<br />
<br />
$(el).each(function() {<br />
<br />
var thisQuestion = $(this);<br />
var thisQuestionHelp = $('img[src$="help.gif"]', thisQuestion).parent();<br />
var thisQuestionAnswers = $('table.question', thisQuestion).parent();<br />
var startTime = '';<br />
var endTime = ''; <br />
var agent = navigator.userAgent.toLowerCase();<br />
var mobile = false;<br />
if( /android|webos|iphone|ipad|ipod|blackberry/i.test(navigator.userAgent) ) { // Mobile devices<br />
mobile = true;<br />
}<br />
mobile = true;<br />
<br />
// Some classes<br />
$(thisQuestion).addClass('iatQuestion');<br />
$('.subquestion-list').addClass('unanswered');<br />
<br />
// Hide the question help element<br />
$(thisQuestionHelp).hide();<br />
<br />
// Hide the answers<br />
if(showAnswers != true) {<br />
$('table.question', thisQuestion).hide();<br />
}<br />
<br />
// Insert IAT display<br />
var iatTexts = $(thisQuestionHelp).text().split('||');<br />
var iatDisplayHTML = '<div class="iatWrapper">\<br />
<div class="iatLeftLabel">'+iatTexts[0]+'</div>\<br />
<div class="iatRightLabel">'+iatTexts[1]+'</div>\<br />
<div class="iatWord"></div>\<br />
<div class="iatInstructions">'+iatTexts[2]+'</div>\<br />
</div>\<br />
<div class="iatMobileButtonWrapper">\<br />
<div class="iatButton iatLeftButton">E</div>\<br />
<div class="iatButton iatRightButton">I</div>\<br />
<div style="width:100%; clear:both;"></div>\<br />
</div>';<br />
$(thisQuestionAnswers).prepend(iatDisplayHTML);<br />
<br />
// Show a word<br />
function iatShowWord() {<br />
$('div.iatWord', thisQuestion).text($('.subquestion-list.unanswered:first .answertext', thisQuestion).text());<br />
startTime = new Date();<br />
<br />
$(document).bind('keypress.iatKeypress', function(e) {<br />
if(e.which == 101 || e.which == 105) {<br />
var thisRow = $('.subquestion-list.unanswered:eq(0)', thisQuestion);<br />
$(thisRow).removeClass('unanswered');<br />
endTime = new Date();<br />
$('input[type="text"]:eq(1)', thisRow).val(endTime.valueOf() - startTime.valueOf());<br />
if(e.which == 101) {<br />
$('input[type="text"]:eq(0)', thisRow).val('E');<br />
}<br />
else {<br />
$('input[type="text"]:eq(0)', thisRow).val('I');<br />
}<br />
$(document).unbind('keypress.iatKeypress');<br />
if($('.subquestion-list.unanswered', thisQuestion).length > 0) {<br />
iatShowWord();<br />
}<br />
else {<br />
$('.iatLeftLabel, .iatWord, .iatRightLabel, .iatInstructions', thisQuestion).fadeOut('slow', function() {<br />
$('div.iatWord', thisQuestion).text(iatTexts[3]);<br />
$('.iatWord', thisQuestion).addClass('done').fadeIn('slow');<br />
});<br />
}<br />
}<br />
});<br />
}<br />
function iatShowWordMobile() {<br />
$('div.iatWord', thisQuestion).text($('.subquestion-list.unanswered:first .answertext', thisQuestion).text());<br />
startTime = new Date();<br />
<br />
$('.iatButton', thisQuestion).bind('click.iatButtonClick', function(e) {<br />
var thisRow = $('.subquestion-list.unanswered:eq(0)', thisQuestion);<br />
$(thisRow).removeClass('unanswered');<br />
endTime = new Date();<br />
$('input[type="text"]:eq(1)', thisRow).val(endTime.valueOf() - startTime.valueOf());<br />
$('input[type="text"]:eq(0)', thisRow).val($(this).text());<br />
$('.iatButton', thisQuestion).unbind('click.iatButtonClick');<br />
if($('.subquestion-list.unanswered', thisQuestion).length > 0) {<br />
iatShowWordMobile();<br />
}<br />
else {<br />
$('.iatLeftLabel, .iatWord, .iatRightLabel, .iatInstructions, .iatMobileButtonWrapper', thisQuestion).fadeOut('slow', function() {<br />
$('div.iatWord', thisQuestion).text(iatTexts[3]);<br />
$('.iatWord', thisQuestion).addClass('done').fadeIn('slow');<br />
});<br />
}<br />
});<br />
}<br />
<br />
// Start the IAT display<br />
if(mobile == true) { // Mobile devices<br />
$('.iatMobileButtonWrapper', thisQuestion).show();<br />
$('.iatButton', thisQuestion).bind('click.iatStartMobile', function(e) {<br />
$('.iatButton', thisQuestion).unbind('click.iatStartMobile');<br />
iatShowWordMobile();<br />
});<br />
}<br />
else {<br />
$(document).bind('keypress.iatStart', function(e) { // Non-mobile devices<br />
if(e.which == 101 || e.which == 105) {<br />
$(document).unbind('keypress.iatStart');<br />
iatShowWord();<br />
}<br />
});<br />
}<br />
});<br />
} </syntaxhighlight><br />
<br />
<br />5) Add the following to the end of template.css:<syntaxhighlight lang="css" enclose="div"><br />
/* IAT questions */<br />
<br />
.iatWrapper {<br />
position: relative;<br />
width: 600px;<br />
height: 300px;<br />
color: #FFFFFF;<br />
background-color: #000000;<br />
font-size: 21px;<br />
}<br />
<br />
.iatLeftLabel {<br />
float: left;<br />
padding: 10px;<br />
}<br />
<br />
.iatRightLabel {<br />
float: right;<br />
padding: 10px;<br />
}<br />
<br />
.iatWord {<br />
position: absolute;<br />
width: 100%;<br />
top: 35%;<br />
text-align: center;<br />
font-size: 36px;<br />
color:#0F0;<br />
}<br />
<br />
.iatWord.done {<br />
color:#FFFFFF;<br />
}<br />
<br />
.iatInstructions {<br />
position: absolute;<br />
width: 100%;<br />
bottom: 0px;<br />
padding-bottom: 10px;<br />
text-align: center;<br />
}<br />
<br />
.iatMobileButtonWrapper {<br />
display: none;<br />
position: relative;<br />
width: 600px;<br />
font-size: 36px;<br />
}<br />
<br />
.iatButton {<br />
float: left;<br />
margin: 20px;<br />
width: 100px;<br />
padding: 2px 0 5px 0;<br />
border: 5px solid #999;<br />
-moz-border-radius: 10px;<br />
-webkit-border-radius: 10px;<br />
-khtml-border-radius: 10px;<br />
border-radius: 10px;<br />
text-align: center;<br />
line-height: normal;<br />
cursor: pointer;<br />
}<br />
<br />
.iatLeftButton {<br />
float: left;<br />
}<br />
<br />
.iatRightButton {<br />
float: right;<br />
}</syntaxhighlight><br />
<br />
<br />6) To apply the plugin, add one of the two scripts below to the question source:<br /><br />
- With hidden answer table (for normally activated survey)<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"> <br />
$(document).ready(function() {<br />
// Apply the IAT plugin to this question<br />
implicitAssociation('#question{QID}');<br />
}); <br />
</script></syntaxhighlight><br />
- With visible answer table (for testing purposes)<br />
<syntaxhighlight lang="javascript" enclose="div"><script type="text/javascript" charset="utf-8"> <br />
$(document).ready(function() {<br />
// Apply the IAT plugin to this question<br />
implicitAssociation('#question{QID}', true);<br />
}); <br />
</script></syntaxhighlight><br />
<br />
<br />
=Make multiple choice easier=<br />
<br />
''Tested with Version 2.00 in Chrome, FF, Safar, IE''<br />
<br />
The problem:<br />
We often have multiple choice question, where the user has to select 4 elements out of 78 possible answers or 3 out of 25 and so on.<br />
If we use pen and paper version for this questions, we noticed that the participants go through the whole list and if an answer doesn't suit on the first sight, they cross it out.<br />
<br />
The solution:<br />
The script gives the participant the possibility to cross out this answers in a digital way. The script adds a small "X" before the checkbox. When it is clicked, the label text of the checkbox turns grey.<br />
(see the attached screenshot for an example)<br />
<br />
Here is the script, just add it to help text<br />
<br />
<syntaxhighlight lang="javascript" enclose="div"><br />
<script type="text/javascript"><br />
<br />
/**<br />
* Small script that adds a "X" before a checkbox. <br />
* On click the text color of the label of the checkbox turns grey<br />
* If the user has to choose some answers from many options, he can "delete" answers, that on first sight looks wrong<br />
* Add the script to the question in Limesurvey (for example within the source code of the help text)<br />
*/<br />
<br />
//Define the X (standard is a X in capitals)<br />
var x = "X";<br />
css_class = "x";<br />
<br />
/*<br />
* Define the style of the X<br />
* Of course you can define the style in the stylesheet - if so, the script ignores the following settings<br />
* If there is a style, than set style var to 1<br />
*/<br />
var style = 0;<br />
var size = "12px";<br />
var weight = "bold";<br />
var color = "red";<br />
var cursor = "pointer";<br />
<br />
//element type - standard is a span element<br />
var type = "span";<br />
<br />
//Define the new font color of the checkbox label<br />
label_color = "#bfbfbf";<br />
<br />
<br />
//End of configuration - start of the function<br />
<br />
//Define the element that is added<br />
if(style == 1) {<br />
ele = "<"+type+" class='"+css_class+"'>"+x+"</"+type+">";<br />
}<br />
else {<br />
ele = "<"+type+" class='"+css_class+"' style='font-size:"+size+"; font-weight:"+weight+"; color:"+color+"; cursor:"+cursor+";'>"+x+"</"+type+">";<br />
}<br />
<br />
//Get the standard font-color of the used style<br />
st_color = $("label").css("color");<br />
<br />
//insert the X before the checkboxes<br />
$(document).ready(function() { <br />
$("li").each(function(){<br />
$(this).prepend(ele);<br />
});<br />
});<br />
<br />
//bind an eventhandler on the X (delegate is used, because Limesurvey uses an old jQuery version)<br />
var css_class_c = "."+css_class;<br />
$(document).delegate(css_class_c,"click",function() {<br />
var color_check = $(this).siblings("label").data("color");<br />
if(color_check != "true") {<br />
$(this).siblings("label").css("color",label_color).data("color","true");<br />
$(this).siblings('input').attr('checked', false);<br />
<br />
}<br />
else {<br />
$(this).siblings("label").css("color",st_color).data("color","false");<br />
<br />
}<br />
});<br />
<br />
$(".checkbox").click(function () {<br />
$(this).siblings("label").css("color",st_color).data("color","false");<br />
});<br />
<br />
</script><br />
</syntaxhighlight></div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_Documentation_Wiki&diff=17546LimeSurvey Documentation Wiki2013-04-19T06:08:55Z<p>Jcleeland: </p>
<hr />
<div><languages /><br />
<translate><br />
=LimeSurvey manual (1.85 and later)= <!--T:1--><br />
<br />
<!--T:2--><br />
The LimeSurvey manual is available in the following languages (click on your language below to read the manual):<br />
*[[File:gb.png]] '''[[English Instructions for LimeSurvey|English]] - This is the base language!'''<br />
*[[File:cn.png]] [[Chinese (Simplified) Manual|Chinese (Simplified]])<br />
*[[File:cn.png]] [[安装|Chinese (Traditional]])<br />
*[[File:fr.png]] [[Instructions fran&ccedil;aises pour LimeSurvey|French]]<br />
*[[File:de.png]] [[Deutsche Anleitung f&uuml;r LimeSurvey|German]]<br />
*[[File:gr.png]] [[Greek Manual|Greek]]<br />
*[[File:it.png]] [[Documentazione Italiano|Italian]]<br />
*[[File:jp.png]] [[日本語マニュアル|Japanese]]<br />
*[[File:pl.png]] [[Podręcznik obsługi|Polish]]<br />
*[[File:pt.png]] [[Manual de Instru&ccedil;&otilde;es do LimeSurvey|Portuguese]]<br />
*[[File:es.png]] [[Manual de Instrucciones en Espa&ntilde;ol|Spanish]]<br />
<br />
<!--T:3--><br />
Please note that not all translations are complete/up-to-date. Â English is the base language (likely most complete and up-to-date). We always need help to translate pages from English to one of the other languages. If you would like to help, [[Creating, editing and translating LimeSurvey Wiki pages|start here]].<br />
<br />
=LimeSurvey development= <!--T:4--><br />
*[[Development overview]] - General pages about LimeSurvey development<br />
*[[LimeSurvey 1.x development documentation]]<br />
*[[LimeSurvey 2.x development documentation]]<br />
<br />
=Translating LimeSurvey= <!--T:5--><br />
<br />
<!--T:6--><br />
If you want to '''add new translations''' or '''correct a translation''' please follow these instructions:<br />
*[[Translating LimeSurvey|How to translate LimeSurvey 1.x/2.x]]<br />
<br />
=Google Summer of Code / Code-In participation= <!--T:7--><br />
*[[Project Ideas for GSoC 2013]]<br />
*[[LimeSurvey Google Code-in 2012]]<br />
*[[LimeSurvey Google Code-in 2011]]<br />
*[[LimeSurvey GSoC 2011]]/[[GSoC getting started]]<br />
*[[LimeSurvey GSoC 2010]]<br />
*[[LimeSurvey GSoC 2009]]<br />
<br />
<!--T:8--><br />
Temporary: [[LimeSurvey Documentation|Shadow, Structured copy]] of this top level page<br />
</translate></div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_Documentation_Wiki&diff=17544LimeSurvey Documentation Wiki2013-04-19T06:07:53Z<p>Jcleeland: </p>
<hr />
<div><languages /><br />
<translate><br />
=LimeSurvey manual (1.85 and later)= <!--T:1--><br />
<br />
<!--T:2--><br />
The LimeSurvey manual is available in the following languages (click on your language below to read the manual):<br />
*[[File:gb.png]] '''[[English Instructions for LimeSurvey|English]] - This is the base language!'''<br />
*[[File:cn.png]] [[Chinese (Simplified) Manual|Chinese (Simplified]])<br />
*[[File:cn.png]] [[安装|Chinese (Traditional]])<br />
*[[File:fr.png]] [[Instructions fran&ccedil;aises pour LimeSurvey|French]]<br />
*[[File:de.png]] [[Deutsche Anleitung f&uuml;r LimeSurvey|German]]<br />
*[[File:gr.png]] [[Greek Manual|Greek]]<br />
*[[File:it.png]] [[Documentazione Italiano|Italian]]<br />
*[[File:jp.png]] [[日本語マニュアル|Japanese]]<br />
*[[File:pl.png]] [[Podręcznik obsługi|Polish]]<br />
*[[File:pt.png]] [[Manual de Instru&ccedil;&otilde;es do LimeSurvey|Portuguese]]<br />
*[[File:es.png]] [[Manual de Instrucciones en Espa&ntilde;ol|Spanish]]<br />
<br />
<!--T:3--><br />
Please note that not all translations are complete/up-to-date. Â English is the base language (likely most complete and up-to-date). We always need help to translate pages from English to one of the other languages. If you would like to help, [[Creating, editing and translating LimeSurvey Wiki pages|start here]].<br />
<br />
=LimeSurvey development= <!--T:4--><br />
*[[Development overview]] - General pages about LimeSurvey development<br />
*[[LimeSurvey 1.x development documentation]]<br />
*[[LimeSurvey 2.x development documentation]]<br />
<br />
=Translating LimeSurvey= <!--T:5--><br />
<br />
<!--T:6--><br />
If you want to '''add new translations''' or '''correct a translation''' please follow these instructions:<br />
*[[Translating LimeSurvey|How to translate LimeSurvey 1.x/2.x]]<br />
<br />
=Google Summer of Code / Code-In participation= <!--T:7--><br />
*[[LimeSurvey GSoC Ideas Page]]<br />
*[[LimeSurvey Google Code-in 2012]]<br />
*[[LimeSurvey Google Code-in 2011]]<br />
*[[LimeSurvey GSoC 2011]]/[[GSoC getting started]]<br />
*[[LimeSurvey GSoC 2010]]<br />
*[[LimeSurvey GSoC 2009]]<br />
<br />
<!--T:8--><br />
Temporary: [[LimeSurvey Documentation|Shadow, Structured copy]] of this top level page<br />
</translate></div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Translating_LimeSurvey&diff=3452Translating LimeSurvey2012-09-13T11:21:44Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Translating LimeSurvey=<br />
<br />
Wouldn't it be great to have LimeSurvey completely translated to your mother-language? The LimeSurvey team is always on the look-out for new translations and for people who help to update the existing ones. Please read these instructions and don't hesitate to send email to translations@limesurvey.org if you are in doubt or have any other questions.<br />
<br />
~tc~<br />
<br />
(alias(LimeSurvey 1.x Translating LimeSurvey))<br />
<br />
~/tc~<br />
<br />
=How to translate - Step-by-Step instructions=<br />
<br />
==Updating an existing translation==<br />
#Create a free user account on [http://www.limesurvey.org].<br />
#Note: If you already have an account please log in once at [http://www.limesurvey.org] first!<br />
#Go to [http://translate.limesurvey.org], login there with the same user name and password.<br />
#Pick the LimeSurvey version you want to translate for and start translating. After your translation was approved it will automatically be released in the weekly stable release and your username will be credited in the change log.<br />
#If you are interested  to become a prime translator for your language with the ability to approve newly translated string please contact us at translations@limesurvey.org . Such a position requires a maximum of about an hour of work per week - important to us is that you are reliable doing this.<br />
<br />
==Customize an existing translation==<br />
<br />
Sometimes you want to modify an existing translation so it accommodates your particular survey situation better. In that case do the following:<br />
#Go to http://translate.limesurvey.org (external link), pick the LimeSurvey version you want to translate for and the particular language you want to modify.<br />
#On the bottom of the translation page you will find an option to export all strings as .po file. Do that and save it as *.po file to your local harddisk.<br />
#Download and install [http://www.poedit.net/download.php poEDIT]<br />
#Start poEdit end edit the downloaded *.po file - modify the particular translations.<br />
#Save. When you save the .po file then automatically a .mo file is created too. That is the one LimeSurvey will read from.<br />
#Place the particular .mo file in the right language folder in /locale by replacing the existing one - for example for French this would be /locale/fr/LC_MESSAGES/fr.po<br />
#Done.<br />
<br />
<div class="simplebox"> Note: If you are using LimeService they will be happy to place the file for you. Just create a support ticket.</div><br />
<br />
==Creating a new translation==<br />
#First of all get access to the development version of LimeSurvey. You can find detailed instructions how to get your hands on it on this page: [[Accessing the source code]]<br />
#Download and install [http://www.poedit.net/download.php poEDIT]<br />
#Now you have to find out the language-code for your language - you can search for your language-code in the [http://people.w3.org/rishida/utils/subtags/ IANA Language Subtag Registry].<br />
#Go to the /locale directory and create a directory named after your language code.<br />
#Inside that directory create a directory named LC_MESSAGES.<br />
#Now create a language file with poEdit. Save the (yet) empty file to that dir (in the /locale/your_language_code/LC_MESSAGES/ folder). The file has to be be named according to your language-code. (look into the other directory for examples)<br />
#In poEdit do the following:<br />
##Open menu ''Catalog/Settings'', enter the ''Paths''-Tab<br />
##Delete the existing path and add a new one pointing to the downloaded LimeSurvey sources<br />
##Click on the ''Keywords'' tab, click on new item<br />
##Add the keywords: 'gT', 'eT', 'neT:1,2', and 'ngT:1,2' (without quotes).<br />
##On the project info tab you will find "Plural Forms" at the bottom. Just copy & paste the following into this field: 'nplurals=2; plural=n != 1;' (without quotes, again)<br />
##Press 'OK' to close the settings.<br />
##Open the menu entry ''Catalog/Update from Sources''<br />
##If you did everything right it should now find all untranslated strings and add it to the .po file<br />
#Translate everything you need to translate. The yellowish marked items are 'unclear' translations and you should check/correct these first. Remember that is better to have no translation than a wrong one!<br />
#To make LimeSurvey know about your language you must add it to the file classes/core/surveytranslator.php. Open that file with a text editor and add your language in the same way the other languages in that file are defined.<br />
#Save. Send the new .po-File and the updated surveytranslator.php file to translations@limesurvey.org . If you want your name to be linked from/shown on the team-page please write so in the e-mail!</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Statistics&diff=3264Statistics2012-03-28T06:26:47Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
<br/>The statistics feature is available from the menu of the browse screen, which - of course - is only available once a survey has been activated.<br />
<br />
This is a short [http://www.screencast.com/users/healthinformatics/folders/Jing/media/0a3c9a66-fb41-4a84-b7dc-c8af363c391f video tutorial], showing how to get to the statistics screen.<br />
<br />
=What is the statistics feature?=<br />
<br />
Let's say you've got a survey running, or it is finished and you want to start analyzing the results. LimeSurvey can dump all the results into an Excel spreadsheet (or CSV file, or Microsoft Word file). You can do whatever takes your fancy with the data then. Alternatively you can use the statistics feature to have a look at your data and start getting some useful information from it.<br />
<br />
The statistics feature allows you to 'filter' your data and retrieve numbers and summaries of different fields from it. The statistics script doesn't attempt to do highly complex filtering - but you'd be surprised at the sort of information that can be easily obtained.<br />
<br />
=Viewing Results and Field Summaries=<br />
<br />
When you click the "Get statistics" button you will be presented with a list of all available questions. For each question there is a checkbox that can be selected in order to show a summary of this table, and an icon that when clicked (or if the mouse hovers over it) will give you the full text of the question. To view the results for a question or questions, check the checkbox(es) at the top of the question(s) and then click "View stats". Alternatively to view the results for all available questions, check the "View summary of all available fields" box at the very top and then click "View stats".<br />
<br />
You will then be given a "Results" table which will indicate the number of cases and a "Field Summary" table for each question selected which will summarize all possible answers in the question(s), their totals and their percentage.<br />
<br />
=Filtering data=<br />
<br />
Data can be filtered in several ways:<br />
#By survey completion - use the dropdown at the top to select Completed, Incomplete or All records. For a discussion on incomplete responses see [[Browsing survey results]].<br />
#By ID - use the inputs to filter by ID number<br />
#By response - click on one or more responses in the list under each question to filter the data by those responses (use CTRL/click to select multiple responses in the same question). Note that if you choose to view summary of all available fields (checkbox at top) you will need to select your response filters before checking that box.<br />
#By text - You can search the responses to a free text question type (and similar types) by entering a text. If you want to search for a partial string you can use the percentage sign (%) as wildcard. Example: If you look for 'Tom%' it will find entries with 'Tomb' and 'Tommy', etc.<br />
<br />
Selecting "View stats" will then give you the "Results" table, indicating the number of responses matching your criteria, and a "Field Summary" table for each question selected which will summarize all possible answers in the question(s), their totals and their percentage. It is important to note that these results are a subset of your total responses. So, for example, if your criteria display 146 records out of a total 180, the summary will show the breakdown of just those 146 records for that table.<br />
<br />
The images below indicate that I have elected to view the stats for "Employment status" of '''''completed records/female/age 18-25'''''. This gives me the results for 6 out of 14 records.<br />
<br />
[[File:stats_1_823x525.gif]]<br />
<br />
[[File:stats_2_823x504.gif]]<br />
<br />
Things to be cautious of<br />
*If you set criteria on the same question that you ask for a summary, then that question will only present answers matching your criteria. So it is good practice not to set any criteria on the same question you are getting a summary of.<br />
*To select multiple entries for a question hold down the CTRL button when clicking. To 'unselect' the last criteria (if you want to clear all criteria from a question) click on the last highlighted answer with the CTRL button.<br />
<br />
=Browsing / Exporting filtered results=<br />
<br />
If you want to export the responses that match your criteria, click on the "export" button at the bottom of the 'Results' table. This will bring up the usual export screen, however when you export the results you will only receive the responses that match your criteria. Similarly, click on browse to view the matching responses in the browse screen.<br />
<br />
=Graphs=<br />
<br />
For charting the library pChart is used which is completely included and usually doesn't have to be configured.<br />
<br />
However for some languages (like Chinese) the usual font used (Vera) does not cover the needed character set. In that case you can use the setting $chartfontfile to set a new TTF font file in config.php (Check out config-defaults.php for the right setting). For Chinese (Simplified and Traditional) we recommend to use the FireFlySung font which can be downloaded from [http://cle.linux.org.tw/fonts/FireFly/].<br />
<br />
After the graphs have been generated you can export these graphs easily. Use a right-mouse-click over the image and choose "Save image as" and save the graph as a .png-file to your chosen location. Normally all results are displayed as pie charts - only for question type "Multiple Options" bar graphs are used.<br />
<br />
<center>[[File:statistics_pie_chart.png]]</center><br />
<br />
<center>[[File:statistics_bar_chart.png]]</center><br />
<br />
="incomplete responses", "no answers" and not "completed/not displayed" counts=<br />
<br />
"'''incomplete responses'''" counts: when the participant wasn't able to go till the end of the survey and thus haven't clicked the "Submit" button.<br />
<br />
Technically speaking, this is when there is no SubmitDate in the response table for this entry.<br />
<br />
A question with "'''no answer'''" counts: when the question was displayed, but the participant hasn't given an answer.<br />
<br />
Technically speaking, this is when the question is not mandatory, was displayed, received no answer and the user clicked Next or Submit: the consequence is that the database field for this answer is set to "" (empty string). This "no answer" status cannot be really computed for Date or pure Numerical questions where the database field cannot record a string.<br />
<br />
A question with "'''not completed/not displayed'''" counts: when the page containing the question was not displayed. This can be because of conditions, or just because the participant left the survey before this page was displayed (or just while this page is displayed, but without clicking the Next button).<br />
<br />
Technically speaking, the database field for this question is filled with a NULL value.<br />
<br />
=Public Statistics=<br />
<br />
LimeSurvey includes functionality to display simple statistics to your participants after they have completed filling out an online survey.<br />
<br />
There are two steps involved in activating and displaying statistics to your participants. Firstly you must enable public statistics for your survey (by default this is turned off). This setting is in your main survey toolbar, General Settings &ndash; in the Presentation and Navigation Tab. Look for the setting &ldquo;Public Statistics&rdquo;. There is also a setting here called &ldquo;Show graphs in public statistics&rdquo; which &ndash; if turned on &ndash; will show graphs as well as the counts (by default only numerical statistics are displayed).<br />
<br />
Once you&rsquo;ve set your survey to display statistics, you need to indicate question-by-question which statistics are displayed to your participants. By default, no questions are selected for display.<br />
<br />
You choose which questions will be shown in the public statistics page by editing each question. In the Advanced Settings for each question is an option &ldquo;Show in public statistics&rdquo;. Once you set this advanced setting to &ldquo;Yes&rdquo; the question will be included on the public statistics page.<br />
<br />
[http://docs.limesurvey.org/Advanced+question+settings&structure;=English+Instructions+for+LimeSurvey&no;_bl=y#public_statistics * Additional question attribute "public_statistics"]<br />
<br />
'''What participants see'''<br />
<br />
Once you&rsquo;ve enabled public statistics, and selected some questions to display, an additional option will be visible to participants when they&rsquo;ve completed filling out your survey. In addition to the usual thank you, there will be a link to &ldquo;View the statistics for this survey&rdquo;<br />
<br />
If your participants click on this link they will be able to see a page detailing the responses to the questions you&rsquo;ve selected, and a graph (if you chose to display graphs too).<br />
<br />
'''Changing the look of the public statistics page'''<br />
<br />
The public statistics page has a template of it&rsquo;s own that can be edited in the limesurvey template editor.</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Project_Ideas_for_GSoC_2012&diff=2514Project Ideas for GSoC 20122012-03-04T22:51:54Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Welcome=<br />
<br />
Welcome Google Summer of Code Student aspirants (:razz:)<br />
<br />
This page lists project ideas developed by the LimeSurvey Community. These tend to be areas that will get the most support as projects since they have been developed by people who know the project and what it needs the most. '''However''', if you have your own idea for a project discuss your awesome idea with us in our [http://www.limesurvey.org/en/forum forums], [https://lists.sourceforge.net/lists/listinfo/limesurvey-developers mailing list] or at [http://www.limesurvey.org/en/support/live-chat #limesurvey on irc.freenode.net]. Then submit your proposal. Good Luck (:biggrin:)<br />
<br />
----<br />
<br />
=Project ideas=<br />
<br />
----<br />
<br />
==Refactor all question types to a modular OOP format==<br />
<br />
If you look at the LimeSurvey source code (yii branch) you will notice that the code for the question types is strewn across the application.<br />
<br />
The goal of this task is to rewrite all question types to be objects, primarily inherited from one or more base question objects. A question type should have methods for display (several types of display like front ent/printable survey), response saving, configuration, statistics, etc.<br />
<br />
'''Skills'''<br />
*Extensive knowledge of PHP & Yii framework<br />
*Very good kownledge of LimeSurvey inner workings<br />
*Very good OOP knowledge<br />
<br />
'''Difficulty'''<br />
*Hard<br />
<br />
'''Probable Mentors'''<br />
<br />
Carsten Schmitz (c_schmitz)<br />
<br />
----<br />
<br />
==Implement a fully featured XMP-RPC API + API tests + unit test==<br />
<br />
LimeSurvey urgently needs an API so all administration functions (and later even survey-taking functions) can be accessed without using the GUI. In addition you will be implementing an according unit test framework and implement unit & API tests across the whole application so we can make sure at any point in the development process that the application is functioning as it should.<br />
<br />
'''Skills'''<br />
*Good PHP, SQL, Yii knowledge<br />
*Good knowledge of the LimeSurvey administration and code<br />
<br />
'''Difficulty'''<br />
*Hard<br />
<br />
'''Probable Mentors'''<br />
<br />
c_schmitz<br />
<br />
----<br />
<br />
==User Interface Improvements and Backend Tidy Ups==<br />
<br />
Help improve LimeSurvey's usability and flexibility through a range of small tasks such as:<br />
* develop improved 'bulk' question handling UI<br />
* Tidy up input values on public surveys by moving required values from html inputs to javascript variables<br />
<br />
The idea is to provide ways of updating and modifying multiple questions, or multiple groups in one go. Often in a survey a user will need to make parallel changes to 5 or 6 questions all at once across a range of different groups. Being able to select various elements of questions, and then select a range of questions to edit would dramatically improve LimeSurvey's usability from the administrators perspective.<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, Yii, Authentication protocols (openID, CAS, LDAP-bind, ...)<br />
<br />
'''Difficulty'''<br />
<br />
Medium<br />
<br />
'''Probable Mentors'''<br />
<br />
Jason Cleeland (jcleeland)<br />
<br />
----<br />
<br />
==Implement a plugin framework for authentication/languages/ import/export modules==<br />
<br />
The idea is to design and implement a modular "framework" for LimeSurvey as well as convert the existing funcitonaly to according modules. The framework will define the API each plugin type must (or may) implement and propose basic methods that can be used by plugins (for instance how to store the plugins parameters in DB, etc.).<br />
<br />
The plugin framework should be in parts similar to the framework used by Joomla (XML description files in the plugin packages)<br />
<br />
Example description for authentication moduls:<br />
<br />
Currently authentication is only used for the survey-administration GUI and not the participants interface (tokens are used for this). With the new authentication framework it should be possible to define several authentication backends for frontend (survey participation) and backend (administration)<br />
<br />
A generic authentication framework must define the following services:<br />
* User authentication: this interface must return the identity of the authenticated user if authentication is successful.<br />
** Authentication may not always be based on a simple user/password form, so the proposed framework must be generic enough to enable authentication based on other schemes (using any numbers or interaction-pages between the server and the end-user or any other contextual parameter such as Referrer, session variable...<br />
* User provisioning:<br />
** when activated on the survey administration interface, an authentication module might be able to create a newly authenticated user into the LimeSurvey internal DB (which is required for setting the user rights on the platform). The newly created user can be assigned a default profile or a per-user profile (queried from an external database).<br />
** when activated on the participants interface, the authentication module will provision the token table of the corresponding survey // alternatively the general-purpose cross-survey participants-database as described in the above GSoC idea.<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, Yii<br />
<br />
'''Difficulty'''<br />
<br />
Hard<br />
<br />
'''Probable Mentors'''<br />
<br />
c_schmitz<br />
<br />
'''Want to know more'''<br />
<br />
Please read the [http://docs.limesurvey.org/tiki-index.php?page=GSOC+2010++Authentication+framework#FAQ FAQ about this project]<br />
<br />
----<br />
<br />
==Custom Report Generation==<br />
<br />
The task is to make a module which will generate custom reports. Module should be able to do these things(at least) :-<br />
*Creating various types of reports i.e. using tables, pie charts, graphs and bar-charts to name few.<br />
*The resulting charts and other illustrations should be easy to read and understand, and should include the ability to export into standard office suites.<br />
*Reports can be general or survey specific.<br />
**General in the sense that it should show basic findings of a general survey graphically like number of users completing the survey, average time taken to complete the survey, average number of correct responses etc.<br />
**Survey specific results should also be addressed properly e.g. how many users choose first option as there answer of a particular question, how many users didn't answer a specific question etc.<br />
<br />
'''Skills'''<br />
<br />
OOP experience in PHP and experience with a PHP framework like CakePHP or CodeIgniter, jQuery. Strong mathematical background will help!<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
'''Probable mentors'''<br />
<br />
Carsten Schmitz (c_schmitz)<br />
<br />
Jason Cleeland (jcleeland)<br />
<br />
Diogo Gon&ccedil;alves (dionet)<br />
<br />
----<br />
<br />
==Adding new questions/subquestions and groups dynamically==<br />
<br />
Currently in LimeSurvey once a survey is activate we can not<br />
*Add or delete groups<br />
*Add or delete questions<br />
*Add or delete subquestions or change their codes<br />
<br />
The idea is to cover these shortcomings. And in addition, all those participants who have already taken that survey must also be notified about the changes. You should also work out in detail what happens to existing results when a survey is changed that way.<br />
<br />
'''Skills'''<br />
<br />
Experience with the PHP framework Yii and knowledge of inner working of LimeSurvey is must!<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
'''Probable mentors'''<br />
<br />
Jason Cleeland (jcleeland)<br />
<br />
Diogo Gon&ccedil;alves (dionet)<br />
<br />
----<br />
<br />
==Enhance Expression Manager==<br />
<br />
Starting with LimeSurvey 1.92, all of the front-end (survey-taking) processing is now managed using Expression Manager (EM). Â EM implements a safe subset of PHP syntax so that authors can write complex equations. Â It is integrated into LimeSuvey to control navigation (branching via relevance), validation, and tailoring/piping of content. Â Although it is quite powerful, users are already asking for enhancements.<br />
#Add a GUI for Expression Manager<br />
**Background: Â LimeSurvey has a nice GUI for building conditions, but it does not support complex equations such as those available within EM. Â EM does have robust syntax highlighting after an equation is saved, which makes it easy to fix any syntax errors. Â Hoever, users would like a GUI to ease authoring of equations.<br />
**Strategy - use CodeMirror - see [http://bugs.limesurvey.org/view.php?id=5279 here]<br />
***Create CodeMirror syntax file to do appropriate syntax highlighting (use C as base language), ensuring that CodeMirror knows the set of valid operators<br />
***Use CodeMirror API to let it know the names of registered function and variable names<br />
***Utilize auto-complete, ideally letting users see and choose among the availalbe function  syntaxes (e.g. when a function can take several paameters).<br />
***Auto-completion of variable names should show the question and question type to make it easier for users to pick the correct variable.<br />
#Support sub-question-level Relevance<br />
**Background: Â EM already supports user-entered relevance equations at the group and question levels. Â It also generates sub-question-level relevance for features like array_filter. Â Users would like to be able ot add additional relevance criteria at the sub-question level.<br />
**Strategy:<br />
***Add a relevance column to the display of sub-questions, and ensure entered relevance is saved the to database (the data model is already OK)<br />
***Refactor createFieldMap() (or its successor) to read sub-question-level relevance into the run-time data structures so that passed to EM<br />
***Enhance EM's sub-question-level data structures to hold sub-question-level releavance<br />
***Update EM's _ValidateQuestion() and JavaScript generation functions to AND any manually-entered sub-question-level relevance equations with that auto-generated for array_filter and array_filter_exclude<br />
***Update ShowSurveyLogicFile() to show sub-question-level relevance equations ***Rigorously unit and regresssion test these changes.<br />
#Add Sub-question-level Validation<br />
**Background: Â The question-level validation supports regular-expression-based validation of each sub-question. Â Users would like to have sub-question-level validation to implement things like a question for collecting user contact information, where there are different validation criteria for address parts (e.g. city, state, postal code) and phone numbers.<br />
**Strategy: Â Similar to sub-question-level relevance<br />
***Add data entry fields for regular expression validation at the sub-question level, and ensure saved to database (which already has a preg field at the sub-question level)<br />
***Ensure EM gets access to the new preg values (via upgrade to createFieldMap)<br />
***Upgrade EM _ValidateQuesation() and function for generation of validation equations to include these new critiera. Â EM already supports validation at the sub-question level (and changes the CSS style to show fields that fail this validation)<br />
***Upgrade ShowSurveyLogicFile() to show sub-question-level validation rules<br />
***Rigorously unit and regresssion test these changes.<br />
#Add Sub-question-level mandatory criteria<br />
**Background: Â Many users have asked, via the forums, for ways to make parts of a multi-part questions mandatory, but make other parts optional. Â LimeSurvey already provides many options, such as minimum and maxium numbers of answers; but users have asked for more fine-grained control, and currently can only achieve that via custom JavaScript.<br />
**Strategy: Â Similar to sub-question-level relevance<br />
***Add checkbox to indicate mandatory status at the sub-question level<br />
#Add native support for input-masks at the question and sub-question level<br />
**Background: Â One of the commonly used work-arounds deals with input masks, such as the jQuery meimomask plugin.<br />
**Strategy:<br />
***Add mask attribute at question and sub-question level<br />
***Have EM generate needed JavaScript code to create and manage those masks<br />
#Add EM reporting functions (tables)<br />
**Background: There is commonly request for enhancemnt of the print answers table at the end of the survey. Â Some users want to generate custom reports mid-survey.<br />
**Strategy:<br />
***Implement showAllResponsesExcept(attributeList,attributeTitleList,questionList) function. Â questionList = list of question identifiers; attributeList = pipe-delimited list of attributes (like question#, title, text, type - so you can decide what to show); attributeTitleList = pipe-delimited list of table headers, so can internationalize the report.<br />
***Implement showTheseResponses(attributeList,attributeTitleList,questionList) function. questionList = list of question identifiers; attributeList = pipe-delimited list of attributes (like question#, title, text, type - so you can decide what to show); attributeTitleList = pipe-delimited list of table headers, so can internationalize the report.<br />
#Add better EM support for operations on array type questions<br />
**Background: Â Many of the EM validation rules are effectively statements like count the number of empty sub-questions, or sum the values of the sub-questions. Â EM generates these functions itself, so there is no burden on the user, even if there ar dozens of sub-quetions. Â However, manual editing of these questions is cumbersom. Users could benefit from special variables to access all of the elements of a question so that they could write functions like (sum(this) == 10)) and have it be expanded to (sum(q1_1, q1_2, ..., q1_N) == 10). Â Note, there is already a "this" variable, but it does not apply to sub-questions.<br />
**Strategy:<br />
***Extend EM so that "this" variable gets expanded into a comma separate list of sub-question references if there are sub-questions. Â Have this expansion carry the suffix, so this.valueNAOK would become q_1.valueNAOK, q_2.valueNAOK, ..., q_N.valueNAOK.<br />
***This macro expansion should occur in group.php (e.g. in the process of generating JavaScript), rather than having this variable be resolved at run-time within JavaScript.<br />
***Provide similar array-expansion macros for all variables (not just "this") - such as qcode_vars.*. Â This would also functions like sum(qcode_vars.NAOK), count(qcode_vars.NAOK), implode(' ', qcode_vars.valueNAOK)<br />
***For questions with comments, create macros like qcode_vars_nc and qcode_vars_oc for no-comments and  only-comments<br />
***For arrays that might need row or  column-level processing, create aliases  like qcode_rowname_vars and qcode_colname_vars so can expand each.  This would let us replace the current system for generating row and column sums with equations like sum(qcode_rowname_vars.NAOK) and be sure that the sums will honor array_filter and array_filter_exclude.<br />
#Add EM functions to validate data entry against value sets managed by Enterprise Vocabulary Systems<br />
**Background: Â Healthcare and biological sciences increasing use large controlled vocabularies, terminologies, or ontologies. Â Data entry systems for such domains require validation against those vocabularies. Â Large open-source projects, like [https://cabig.nci.nih.gov/community/tools/LexEVS_Server LexEVS] and [http://apelon.com/Products/DTS/tabid/97/Default.aspx Apelon DTS] provide open APIs to access that content. Â Such tools let one validate diagnostic codes, and even do incremental search into those vocabularies as one types. Â The main open projects are standardizing on the [http://hssp.wikispaces.com/cts2 CTS-2] (Clinical Terminology Services-2) specification.<br />
**Strategy:<br />
***Create EM-compatible PHP and JavaScript functions to access CTS-2 compliant EVS systems<br />
***Should include question and sub-question-level validation rules to validate the final entry. Â Currently, thre are em_validation_q and em_validation_sq advanced quation attributes for validating questions and sub-questions based upon calls to external functions. Â It may be desirable to support custom sub-question-level validation to validate each sub-question against different value sets. Â If so, can follow the model of adding sub-question-level validation and relevance. Â Alternatively, may be desirable to add sub-question-level advanced question options (if LimeSurvey community feels that there may be enough such extensions that such customization should be stored in a general attribute table rather than making the questions table wider).<br />
***Should also include ability to do incremetal searches into the value sets<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, PHP Debugging (e.g. xdebug), Yii, LimeSurvey's Expression Manager and code-base in general<br />
<br />
'''Difficulty'''<br />
<br />
Medium to Hard<br />
<br />
'''Probable Mentors'''<br />
<br />
Thomas White (TMSWhite)<br />
<br />
----<br />
<br />
==Optimize LimeSurvey for Long Surveys (and better performance and maintenance in general)==<br />
<br />
Although LimeSurvey is excellent for short and mid-length surveys, it is not optimized for surveys with hundreds or thousands of questions - such as those used by epidemiologists or in clinical trials. Â This project would tackle each of those main limitations. Â Those sub-tasks, and the development strategy include:<br />
#Support for more than 1000 database columns<br />
**Background: LS creates a horizontal table for survey data collection, and such tables often are limited to at most 1000 columns<br />
**Strategies:<br />
***Remove unneeded columns from horizontal table (e.g. type 'X')<br />
***Conditionally remove unneeded equation columns (e.g. let users specify a prefix for variable names that should not be stored)<br />
***Add option for Entity Attribute Value data model for data collection (which can support unlimited number of columns. Â See details [http://bugs.limesurvey.org/view.php?id=5289 here].<br />
#Memory and Code Optimization<br />
**Background: LS loads the survey definition data model into several different data structures, such that it uses at least twice as much storage as it really needs. Â Expression Manager now holds all of the instrument definition data, so the other data stores are no longer needed.<br />
**Strategy<br />
***Remove need for buildsurveysession() - gap analysis to add in any missing content to EM<br />
***Remove need for createFieldMap() - similar gap analysis<br />
***Normalize EM data structures to avoid internal duplication (and refactor code to use normalized structures) (and document new data structures so that future developers know which to use, and how to use them)<br />
****gInfo - renaming of groupSeqInfo, plus add missing group-level attributes (relevance, description)<br />
****qInfo - renaming of questionSeq2relevance, plus add any missing attributes from $fieldarray; remove aid, sqid; move grelevance to gInfo<br />
****aInfo - for storing answer arrays?<br />
****sqInfo - renaming of q2subqInfo, indexed on sgqa(?); remove content gleaned from gInfo and qInfo<br />
****gStatus - renaming of indexGseq - make hold only dynamic values; so move gtext and gname to gInfo; also remove gRelInfo, keeping any unique variables it contains<br />
****qStatus - renaming of indexQseq - make hold only dynamic values; so move qtext, qhelp, gtext, gname to qInfo<br />
****sqStatus - renaming of subQrelInfo - make hold only dynamic values<br />
****groupRelevanceInfo - consolidate into indexGseq?<br />
****knownVars - instead of copying content, use reference to gInfo and qInfo (e.g. remove question, relevance, grelevance, qcode, ansList, ansArray, onlynum).<br />
****varNameAttr - remove; generate on the fly from gInfo, qInfo, and knownVars<br />
****alias2varName - remove; generate on the fly from knownVars<br />
***Refactor EM so that stores normalized copies of secondary language text<br />
***Optionally load only current group for each page transition rather than holding entire survey definition in memory<br />
***Refactor EM for consistent variable naming<br />
****e.g. questionId => qid; groupNum => gid; groupSeq => gseq; questionSeq => qseq<br />
#Run-Time Performance Optimization<br />
**Background: Â qanda.php loads the content to create the questions and answers. Â It used to do this by separate database queries per question.<br />
**Strategy<br />
***Refactor qanda.php to remove queries (like for "other", or sub-question text) - have it get that information from EM<br />
***Refactor LS so that language switching does not require a re-load of the core logic, but just the new language content  (and that it gets this from EM)<br />
***Refactor replacements.php and EM<br />
****Should only need to call replacements.php once per page, so set those valeus as locally static in EM per page.<br />
****Refactor group.php to pass {QUESTION_*} via replacements array, rather than as globals passed to templatereplace<br />
#Design-Time Performance Optimization<br />
**Background: Â LS used to only load the information from the data model that was needed for the given question or group. Â EM had to load the entire data model to properly syntax highlight everything. Â This can lead to some performance degradation in very long surveys<br />
**Strategy:<br />
***Add methods to EM to just load changes to model as questions or groups are added, removed, or updated<br />
***Pass those updates into EM internals so that syntax highlighting continues to be correct<br />
***Ensure that admin pages only call the subset of EM functions needed to do accurate syntax highlighting.<br />
#Optimizations for Rapid Development<br />
**Background: Â LS has a nice GUI for editing single questions at a time. Â However, it is not optimized to make changes to multiple questions at a time. Â Some competitor systems let authors design surveys using an Excel template (e.g. so that they can do bulk find and replace, or easily copy similar portions or answer lists). Â Short of a full-blown AJAX-enabled admin system, this has the highest throughput potential<br />
**Strategy:<br />
***Create an Excel data model that would work for importing surveys<br />
***Create import and validation routines from that model<br />
***A similar model, which could be extended for LS, is noted [http://bugs.limesurvey.org/view.php?id=5105 here].<br />
#Performance Validation<br />
**Load test surveys of varying lenghts<br />
**Identify performance and memory bottlenecks<br />
**Idenfity minimum memory requirements for certain survey lengths and concurrent user volumes<br />
**Propose strategy to overcome those performance issues<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, PHP Debugging (e.g. xdebug), Yii, LimeSurvey's Expression Manager and code-base in general, Load testing tool (e.g. webload), PHP Profiler<br />
<br />
'''Difficulty'''<br />
<br />
Medium to Hard<br />
<br />
'''Probable Mentors'''<br />
<br />
Thomas White (TMSWhite)<br />
<br />
----<br />
<br />
==Idea template==<br />
<br />
Describe the idea here in general terms<br />
<br />
'''Skills'''<br />
<br />
Explain what sort of coding skills would be needed for a student to implement this project<br />
<br />
'''Difficulty'''<br />
<br />
Explain the level of difficulty involved<br />
<br />
'''Probable Mentors'''<br />
<br />
Put your name (and tag) here if you are willing to mentor a student for this idea<br />
<br />
----<br />
<br />
=More information=<br />
<br />
==Getting started==<br />
<br />
[[GSoC getting started|Check out our 'Get started' page]] for setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
==Frequently Asked Questions==<br />
<br />
Check out [[GSoC FAQ|our GSoC FAQ page.]]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Project_Ideas_for_GSoC_2012&diff=2531Project Ideas for GSoC 20122012-02-21T21:55:22Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Welcome=<br />
<br />
Welcome Google Summer of Code Student aspirants (:razz:)<br />
<br />
This page lists project ideas developed by the LimeSurvey Community. These tend to be areas that will get the most support as projects since they have been developed by people who know the project and what it needs the most. '''However''', if you have your own idea for a project discuss your awesome idea with us in our [http://www.limesurvey.org/en/forum forums], [https://lists.sourceforge.net/lists/listinfo/limesurvey-developers mailing list] or at [http://www.limesurvey.org/en/support/live-chat #limesurvey on irc.freenode.net]. Then submit your proposal. Good Luck (:biggrin:)<br />
<br />
----<br />
<br />
=Project ideas=<br />
<br />
----<br />
<br />
==Refactor all question types to a modular OOP format==<br />
<br />
----<br />
<br />
==Implement a fully featured XMP-RPC API complete with unit test==<br />
<br />
----<br />
<br />
==Add a unit testing framework and write tests==<br />
<br />
----<br />
<br />
==Integrate the DBSE into Yii==<br />
<br />
----<br />
<br />
==Develop Improved 'bulk' Question Handling UI (and other UI enhancements)==<br />
<br />
The idea is to provide ways of updating and modifying multiple questions, or multiple groups in one go. Often in a survey a user will need to make parallel changes to 5 or 6 questions all at once across a range of different groups. Being able to select various elements of questions, and then select a range of questions to edit would dramatically improve LimeSurvey's usability from the administrators perspective.<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, Yii, Authentication protocols (openID, CAS, LDAP-bind, ...)<br />
<br />
'''Difficulty'''<br />
<br />
Medium<br />
<br />
'''Probable Mentors'''<br />
<br />
Jason Cleeland (jcleeland)<br />
<br />
----<br />
<br />
==Implement a modular authentication framework==<br />
<br />
The idea is to design and implement a modular authentication "framework" for LimeSurvey as well as some authentication modules. The Authentication framework will define the API each authentication plugin must (or may) implement and propose basic methods that can be used by plugins (for instance how to store the plugins parameters in DB, how to display a form using the survey template). A plugin will be responsible to implement, for each particular authentication backend, specific methods (some mandatory, some optional) such as: user authentication, user provisioning, user rights, ...<br />
<br />
Currently authentication is only used for the survey-administration GUI and not the participants interface (tokens are used for this). With the new authentication framework it will be possible to define several authentication backends and use some of them for participants-authentication.<br />
<br />
The generic authentication framework must define the following services:<br />
* User authentication: this interface must return the identity of the authenticated user if authentication is successful.<br />
** Authentication may not always be based on a simple user/password form, so the proposed framework must be generic enough to enable authentication based on other schemes (using any numbers or interaction-pages between the server and the end-user or any other contextual parameter such as Referrer, session variable...<br />
* User provisioning:<br />
** when activated on the survey administration interface, an authentication module might be able to create a newly authenticated user into the LimeSurvey internal DB (which is required for setting the user rights on the platform). The newly created user can be assigned a default profile or a per-user profile (queried from an external database).<br />
** when activated on the participants interface, the authentication module will provision the token table of the corresponding survey // alternatively the general-purpose cross-survey participants-database as described in the above GSoC idea.<br />
<br />
The already existing authentication schemes will be ported to the new framework (internal-DB and Web server authentication delegation) and at least a new one will be implemented (openID, CAS, Shibboleth).<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, CodeIgniter, Authentication protocols (openID, CAS, LDAP-bind, ...)<br />
<br />
'''Difficulty'''<br />
<br />
Medium<br />
<br />
'''Probable Mentors'''<br />
<br />
Unknown<br />
<br />
'''Want to know more'''<br />
<br />
Please read the [http://docs.limesurvey.org/tiki-index.php?page=GSOC+2010++Authentication+framework#FAQ FAQ about this project]<br />
<br />
----<br />
<br />
==Custom Report Generation==<br />
<br />
The task is to make a module which will generate custom reports. Module should be able to do these things(at least) :-<br />
*Creating various types of reports i.e. using tables, pie charts, graphs and bar-charts to name few.<br />
*The resulting charts and other illustrations should be easy to read and understand, and should include the ability to export into standard office suites.<br />
*Reports can be general or survey specific.<br />
**General in the sense that it should show basic findings of a general survey graphically like number of users completing the survey, average time taken to complete the survey, average number of correct responses etc.<br />
**Survey specific results should also be addressed properly e.g. how many users choose first option as there answer of a particular question, how many users didn't answer a specific question etc.<br />
<br />
'''Skills'''<br />
<br />
OOP experience in PHP and experience with a PHP framework like CakePHP or CodeIgniter, jQuery. Strong mathematical background will help!<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
'''Probable mentors'''<br />
<br />
Carsten Schmitz (c_schmitz)<br />
<br />
Jason Cleeland (jcleeland)<br />
<br />
----<br />
<br />
==Adding new questions/subquestions and groups dynamically==<br />
<br />
Currently in LimeSurvey once a survey is activate we can not<br />
*Add or delete groups<br />
*Add or delete questions<br />
*Add or delete subquestions or change their codes<br />
<br />
The idea is to cover these shortcomings. And in addition, all those participants who have already taken that survey must also be notified about the changes.<br />
<br />
'''Skills'''<br />
<br />
Experience with a PHP framework like CakePHP or CodeIgniter and knowledge of inner working of LimeSurvey is must!<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
'''Probable mentors'''<br />
<br />
Carsten Schmitz (c_schmitz)<br />
<br />
Jason Cleeland (jcleeland)<br />
<br />
----<br />
<br />
==Enhance Expression Manager==<br />
<br />
Starting with LimeSurvey 1.92, all of the front-end (survey-taking) processing is now managed using Expression Manager (EM). Â EM implements a safe subset of PHP syntax so that authors can write complex equations. Â It is integrated into LimeSuvey to control navigation (branching via relevance), validation, and tailoring/piping of content. Â Although it is quite powerful, users are already asking for enhancements.<br />
#Add a GUI for Expression Manager<br />
**Background: Â LimeSurvey has a nice GUI for building conditions, but it does not support complex equations such as those available within EM. Â EM does have robust syntax highlighting after an equation is saved, which makes it easy to fix any syntax errors. Â Hoever, users would like a GUI to ease authoring of equations.<br />
**Strategy - use CodeMirror - see [http://bugs.limesurvey.org/view.php?id=5279 here]<br />
***Create CodeMirror syntax file to do appropriate syntax highlighting (use C as base language), ensuring that CodeMirror knows the set of valid operators<br />
***Use CodeMirror API to let it know the names of registered function and variable names<br />
***Utilize auto-complete, ideally letting users see and choose among the availalbe function  syntaxes (e.g. when a function can take several paameters).<br />
***Auto-completion of variable names should show the question and question type to make it easier for users to pick the correct variable.<br />
#Support sub-question-level Relevance<br />
**Background: Â EM already supports user-entered relevance equations at the group and question levels. Â It also generates sub-question-level relevance for features like array_filter. Â Users would like to be able ot add additional relevance criteria at the sub-question level.<br />
**Strategy:<br />
***Add a relevance column to the display of sub-questions, and ensure entered relevance is saved the to database (the data model is already OK)<br />
***Refactor createFieldMap() (or its successor) to read sub-question-level relevance into the run-time data structures so that passed to EM<br />
***Enhance EM's sub-question-level data structures to hold sub-question-level releavance<br />
***Update EM's _ValidateQuestion() and JavaScript generation functions to AND any manually-entered sub-question-level relevance equations with that auto-generated for array_filter and array_filter_exclude<br />
***Update ShowSurveyLogicFile() to show sub-question-level relevance equations ***Rigorously unit and regresssion test these changes.<br />
#Add Sub-question-level Validation<br />
**Background: Â The question-level validation supports regular-expression-based validation of each sub-question. Â Users would like to have sub-question-level validation to implement things like a question for collecting user contact information, where there are different validation criteria for address parts (e.g. city, state, postal code) and phone numbers.<br />
**Strategy: Â Similar to sub-question-level relevance<br />
***Add data entry fields for regular expression validation at the sub-question level, and ensure saved to database (which already has a preg field at the sub-question level)<br />
***Ensure EM gets access to the new preg values (via upgrade to createFieldMap)<br />
***Upgrade EM _ValidateQuesation() and function for generation of validation equations to include these new critiera. Â EM already supports validation at the sub-question level (and changes the CSS style to show fields that fail this validation)<br />
***Upgrade ShowSurveyLogicFile() to show sub-question-level validation rules<br />
***Rigorously unit and regresssion test these changes.<br />
#Add Sub-question-level mandatory criteria<br />
**Background: Â Many users have asked, via the forums, for ways to make parts of a multi-part questions mandatory, but make other parts optional. Â LimeSurvey already provides many options, such as minimum and maxium numbers of answers; but users have asked for more fine-grained control, and currently can only achieve that via custom JavaScript.<br />
**Strategy: Â Similar to sub-question-level relevance<br />
***Add checkbox to indicate mandatory status at the sub-question level<br />
#Add native support for input-masks at the question and sub-question level<br />
**Background: Â One of the commonly used work-arounds deals with input masks, such as the jQuery meimomask plugin.<br />
**Strategy:<br />
***Add mask attribute at question and sub-question level<br />
***Have EM generate needed JavaScript code to create and manage those masks<br />
#Add EM reporting functions (tables)<br />
**Background: There is commonly request for enhancemnt of the print answers table at the end of the survey. Â Some users want to generate custom reports mid-survey.<br />
**Strategy:<br />
***Implement showAllResponsesExcept(attributeList,attributeTitleList,questionList) function. Â questionList = list of question identifiers; attributeList = pipe-delimited list of attributes (like question#, title, text, type - so you can decide what to show); attributeTitleList = pipe-delimited list of table headers, so can internationalize the report.<br />
***Implement showTheseResponses(attributeList,attributeTitleList,questionList) function. questionList = list of question identifiers; attributeList = pipe-delimited list of attributes (like question#, title, text, type - so you can decide what to show); attributeTitleList = pipe-delimited list of table headers, so can internationalize the report.<br />
#Add better EM support for operations on array type questions<br />
**Background: Â Many of the EM validation rules are effectively statements like count the number of empty sub-questions, or sum the values of the sub-questions. Â EM generates these functions itself, so there is no burden on the user, even if there ar dozens of sub-quetions. Â However, manual editing of these questions is cumbersom. Users could benefit from special variables to access all of the elements of a question so that they could write functions like (sum(this) == 10)) and have it be expanded to (sum(q1_1, q1_2, ..., q1_N) == 10). Â Note, there is already a "this" variable, but it does not apply to sub-questions.<br />
**Strategy:<br />
***Extend EM so that "this" variable gets expanded into a comma separate list of sub-question references if there are sub-questions. Â Have this expansion carry the suffix, so this.valueNAOK would become q_1.valueNAOK, q_2.valueNAOK, ..., q_N.valueNAOK.<br />
***This macro expansion should occur in group.php (e.g. in the process of generating JavaScript), rather than having this variable be resolved at run-time within JavaScript.<br />
***Provide similar array-expansion macros for all variables (not just "this") - such as qcode_vars.*. Â This would also functions like sum(qcode_vars.NAOK), count(qcode_vars.NAOK), implode(' ', qcode_vars.valueNAOK)<br />
***For questions with comments, create macros like qcode_vars_nc and qcode_vars_oc for no-comments and  only-comments<br />
***For arrays that might need row or  column-level processing, create aliases  like qcode_rowname_vars and qcode_colname_vars so can expand each.  This would let us replace the current system for generating row and column sums with equations like sum(qcode_rowname_vars.NAOK) and be sure that the sums will honor array_filter and array_filter_exclude.<br />
#Add EM functions to validate data entry against value sets managed by Enterprise Vocabulary Systems<br />
**Background: Â Healthcare and biological sciences increasing use large controlled vocabularies, terminologies, or ontologies. Â Data entry systems for such domains require validation against those vocabularies. Â Large open-source projects, like [https://cabig.nci.nih.gov/community/tools/LexEVS_Server LexEVS] and [http://apelon.com/Products/DTS/tabid/97/Default.aspx Apelon DTS] provide open APIs to access that content. Â Such tools let one validate diagnostic codes, and even do incremental search into those vocabularies as one types. Â The main open projects are standardizing on the [http://hssp.wikispaces.com/cts2 CTS-2] (Clinical Terminology Services-2) specification.<br />
**Strategy:<br />
***Create EM-compatible PHP and JavaScript functions to access CTS-2 compliant EVS systems<br />
***Should include question and sub-question-level validation rules to validate the final entry. Â Currently, thre are em_validation_q and em_validation_sq advanced quation attributes for validating questions and sub-questions based upon calls to external functions. Â It may be desirable to support custom sub-question-level validation to validate each sub-question against different value sets. Â If so, can follow the model of adding sub-question-level validation and relevance. Â Alternatively, may be desirable to add sub-question-level advanced question options (if LimeSurvey community feels that there may be enough such extensions that such customization should be stored in a general attribute table rather than making the questions table wider).<br />
***Should also include ability to do incremetal searches into the value sets<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, PHP Debugging (e.g. xdebug), Yii, LimeSurvey's Expression Manager and code-base in general<br />
<br />
'''Difficulty'''<br />
<br />
Medium to Hard<br />
<br />
'''Probable Mentors'''<br />
<br />
Thomas White (TMSWhite)<br />
<br />
----<br />
<br />
==Optimize LimeSurvey for Long Surveys (and better performance in general)==<br />
<br />
Although LimeSurvey is excellent for short and mid-length surveys, it is not optimized for surveys with hundreds or thousands of questions - such as those used by epidemiologists or in clinical trials. Â This project would tackle each of those main limitations. Â Those sub-tasks, and the development strategy include:<br />
#Support for more than 1000 database columns<br />
**Background: LS creates a horizontal table for survey data collection, and such tables often are limited to at most 1000 columns<br />
**Strategies:<br />
***Remove unneeded columns from horizontal table (e.g. type 'X')<br />
***Conditionally remove unneeded equation columns (e.g. let users specify a prefix for variable names that should not be stored)<br />
***Add option for Entity Attribute Value data model for data collection (which can support unlimited number of columns. Â See details [http://bugs.limesurvey.org/view.php?id=5289 here].<br />
#Memory Optimization<br />
**Background: LS loads the survey definition data model into several different data structures, such that it uses about 2 to 10 times as much storage as it really needs. Â Expression Manager now holds all of the instrument definition data, so the other data stores are no longer needed.<br />
**Strategy<br />
***Remove need for buildsurveysession() - gap analysis to add in any missing content to EM<br />
***Remove need for createFieldMap() - similar gap analysis<br />
***Normalize EM data structures to avoid internal duplication (there are about 4 structures that hold over-lapping code)<br />
***Refactor EM so that stores normalized copies of secondary language text<br />
#Run-Time Performance Optimization<br />
**Background: Â qanda.php loads the content to create the questions and answers. Â It used to do this by separate database queries per question.<br />
**Strategy<br />
***Refactor qanda.php to remove queries (like for "other", or sub-question text) - have it get that information from EM<br />
***Refactor LS so that language switching does not require a re-load of the core logic, but just the new language content  (and that it gets this from EM)<br />
#Design-Time Performance Optimization<br />
**Background: Â LS used to only load the information from the data model that was needed for the given question or group. Â EM had to load the entire data model to properly syntax highlight everything. Â This can lead to some performance degradation in very long surveys<br />
**Strategy:<br />
***Add methods to EM to just load changes to model as questions or groups are added, removed, or updated<br />
***Pass those updates into EM internals so that syntax highlighting continues to be correct<br />
***Ensure that admin pages only call the subset of EM functions needed to do accurate syntax highlighting.<br />
#Optimizations for Rapid Development<br />
**Background: Â LS has a nice GUI for editing single questions at a time. Â However, it is not optimized to make changes to multiple questions at a time. Â Some competitor systems let authors design surveys using an Excel template (e.g. so that they can do bulk find and replace, or easily copy similar portions or answer lists). Â Short of a full-blown AJAX-enabled admin system, this has the highest throughput potential<br />
**Strategy:<br />
***Create an Excel data model that would work for importing surveys<br />
***Create import and validation routines from that model<br />
***A similar model, which could be extended for LS, is noted [http://bugs.limesurvey.org/view.php?id=5105 here].<br />
#Performance Validation<br />
**Load test surveys of varying lenghts<br />
**Identify performance and memory bottlenecks<br />
**Idenfity minimum memory requirements for certain survey lengths and concurrent user volumes<br />
**Propose strategy to overcome those performance issues<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, PHP Debugging (e.g. xdebug), Yii, LimeSurvey's Expression Manager and code-base in general, Load testing tool (e.g. webload), PHP Profiler<br />
<br />
'''Difficulty'''<br />
<br />
Medium to Hard<br />
<br />
'''Probable Mentors'''<br />
<br />
Thomas White (TMSWhite)<br />
<br />
----<br />
<br />
==Idea template==<br />
<br />
Describe the idea here in general terms<br />
<br />
'''Skills'''<br />
<br />
Explain what sort of coding skills would be needed for a student to implement this project<br />
<br />
'''Difficulty'''<br />
<br />
Explain the level of difficulty involved<br />
<br />
'''Probable Mentors'''<br />
<br />
Put your name (and tag) here if you are willing to mentor a student for this idea<br />
<br />
----<br />
<br />
=More information=<br />
<br />
==Getting started==<br />
<br />
[[GSoC getting started|Check out our 'Get started' page]] for setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
==Frequently Asked Questions==<br />
<br />
Check out [[GSoC FAQ|our GSoC FAQ page.]]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Coding_guidelines&diff=3136Coding guidelines2012-01-24T01:21:20Z<p>Jcleeland: </p>
<hr />
<div><br />
Contents:__TOC__<br />
<br />
=Naming convention=<br />
*Use the Hungarian Rule for variables:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
[t]NameOfVariable<br />
<br />
 | <strike>-</strike><strike>+</strike>----<br />
<br />
 |     +--> Descriptive name<br />
<br />
 +--> Datatype stored (for example start with "a" if it is an array)<br />
<br />
</syntaxhighlight><br />
<br />
Examples:<br />
<br />
aQuestionAttributes: Array to store the questions attributes, Mixed values<br />
<br />
dSurveyEnds: Date when the survey ends<br />
<br />
sContditionsOutput: String used to create the JS for conditions<br />
*In case a function is declared '''do not''' use the Hungarian rule for the function name, instead use "Lower CamelCase":<br />
<br />
function questionsRetrieve( $iQID, $iSurvey)<br />
*What about files? Unless Yii requires it in some way always name your files in lowercase - this prevents problems on systems using case-aware filesystems<br />
<br />
=Documentation=<br />
<br />
Please refer to this introduction: [[How to document your source code]].<br />
<br />
=Structures=<br />
*Indent using spaces instead of TAB, or be gentle to announce how many spaces are your TABs long. There is wide ranging debate about tabs vs. spaces, many people prefer using tabs, others prefer spaces, others are happy with a mix of tabs and spaces. Because LimeSurvey is developed collaboratively, we ask that you leave your preference and follow this standard.<br />
*The opening curly brace must be below the structure opening:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
if (condition)<br />
<br />
{<br />
<br />
  ...<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
*Using one line for a simple condition is very "fashionable", a taste of "hacker", but it is not clear at all:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
 WRONG: if (condition) {do true} else {do false}<br />
<br />
 WRONG: if (condition) {do true}<br />
<br />
    else {do false}<br />
<br />
 RIGHT: if (condition)<br />
<br />
    {<br />
<br />
      do true<br />
<br />
    } else<br />
<br />
    {<br />
<br />
      do false<br />
<br />
    }<br />
<br />
 RIGHT: swith $sSelector<br />
<br />
    {<br />
<br />
       case X:<br />
<br />
          ...<br />
<br />
          break;<br />
<br />
       case Y:<br />
<br />
          ...<br />
<br />
       default:<br />
<br />
    }<br />
<br />
</syntaxhighlight><br />
<br />
NOTE: It&acute;s true that sometimes the "WRONG" way can be useful, but if it makes the straight reading difficult, please use the "RIGHT" way instead. Be gentle with your fellow developers.<br />
*SQL sentences must respect the same rule:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
 $sSQL = "SELECT field1, field2, field3 "<br />
<br />
    ."WHERE condition "<br />
<br />
    ."AND condition "<br />
<br />
    ."OR condition "<br />
<br />
    ."ORDER BY field1, field2";<br />
<br />
</syntaxhighlight><br />
*The same for HTML in views tags:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<table><br />
<br />
<tr><br />
<br />
 <td colspan='2'<br />
<br />
   height='4'><br />
<br />
 <strong><br />
<br />
  Some Text<br />
<br />
 </strong><br />
<br />
 </td><br />
<br />
</tr><br />
<br />
</table><br />
<br />
</syntaxhighlight><br />
<br />
=HTML=<br />
*As you will notice, a very customized HTML element can take a lot of lines (very expensive if you paid each one (:wink:) ) to avoid that, use 'CSS classes'. In general, use classes to aesthetic related stuff: color, borders, backgrounds, font faces, sizes, etc.<br />
*Respect W3C standards, and try to use the HTML understandable for all browsers. If one of them has a special feature, think if this feature is so special to break down the HTML in other browsers.<br />
*Do not use PHP short tags <? ?>. Always use full PHP tags <?php ?><br />
*Any rules of the mentioned before: about CSS, well closed HTML tags and JS respect XHTML standards. Give it a try!.<br />
<br />
=Localization=<br />
<br />
Currently we are using the gT(),eT(),ngT() and neT() functions of the limesurvey_lang object for translations.<br />
<br />
Since LimeSurvey is available in 60 languages it is very important that your original English string (which will be picked up automatically for translation by our translators) is done right from the start. Imagine if we have to correct only one string at a later time - then 60 strings become invalid across the project and need to be re-translated by the poor translator souls.<br />
* gT() is the original translation function. It will return a translated version of the string in the currently selected language. ie: echo ''$clang->gT("Hello");''<br />
* ngT() returns multiple translations of a sentence or phrase for which alternate plural forms may apply. ie: ''echo sprintf($clang->ngT('Please select at least %s answer','Please select at least %s answers',iMinimumAnswers),$iMinimumAnswers)'';<br />
* eT() echos the translation directly. (ie: instead of ''echo $clang->gT("Hello");'' you can use ''$clang->eT("Hello");''<br />
* neT() echos the multiple translations of the sentence or phrase for which alternate plural forms may apply directly.<br />
<br />
Please follow these important rules:<br />
*'''Do not embed margin spaces''' in your translation. Instead use proper CSS formatting<br />
<br />
<span style='color:#F00'>Wrong</span>: $clang->eT('Visible? ');<br />
<br />
<span style='color:#060'>Right</span>: $clang->eT('Visible?');<br />
*'''Do not capitalize words''' except where grammatically correct (like at the beginning of a sentence or for a brand name). LimeSurvey is not a newspaper.<br />
<br />
<span style='color:#F00'>Wrong</span>: $clang->eT('Create A New Label Set');<br />
<br />
<span style='color:#060'>Right</span>: $clang->eT('Create a new label set');<br />
<br />
<span style='color:#F00'>Wrong</span>: $clang->eT('Google Maps API Key');<br />
<br />
<span style='color:#060'>Right</span>: $clang->eT('Google Maps API key');<br />
*'''Do not concatenate''' several translations to form a sentence or concatenate to an additional information (like a number or string). Instead use the sprint() or sprintf() function with placeholders.<br />
<br />
<span style='color:#F00'>Wrong</span>: echo $clang->gT('The sum must not be bigger than').$iMaxSum;<br />
<br />
<span style='color:#060'>Right</span>: echo sprintf($clang->gT('The sum must not be bigger than %s'),$iMaxSum);<br />
<br />
This comes from the problem that in other languages the setting of a sentence can be much different and the information $iMaxSum from the example above might be needed in the middle of the sentence.<br />
<br />
<span style='color:#F00'>Wrong</span>: echo $clang->gT('The user').$sUsername.$clang->gT('was deleted.');<br />
<br />
<span style='color:#060'>Right</span>: echo sprintf($clang->gT('The user %s was deleted.'),$sUsername);<br />
*'''Use the n*T functions where applicable'''. These functions show a different translation depending the number of items. Currently LimeSurvey only supports the numbers/situations 1 and >1.<br />
<br />
+Example:<br />
<br />
<span style='color:#F00'>Wrong</span>: echo sprintf($clang->gT('Please select at least %s answer(s).'),$iMinimumAnswers);<br />
<br />
<span style='color:#060'>Right</span>: echo sprintf($clang->ngT('Please select at least %s answer','Please select at least %s answers',iMinimumAnswers),$iMinimumAnswers);<br />
<br />
=Miscellaneous=<br />
*Do not use "global" to access to a declared variable in another process. Pass variables or arrays by reference, use the session or the configuration object.<br />
*If using an auxiliary variable makes clear the code or process, just do it. If you are coding a very complex expression, calling to functions with parameters that are other functions:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
WRONG:<br />
<br />
iAResult= fa(fb(p1,p2),fc(fd(p3),p4),p5)<br />
<br />
It will be more readable:<br />
<br />
iAuxB = fb(p1,p2)<br />
<br />
iAuxD = fd(p3)<br />
<br />
iAuxC = fc(iAuxD,p4)<br />
<br />
iAResult = fa(iAuxB, iAuxC, p5)<br />
<br />
</syntaxhighlight><br />
<br />
Anyway, if you are in doubt about someone missing the point or you are afraid that your expression is obscure, take the chance of writing it in a more simple way, even if that involves the use of one or more auxiliary variables.<br />
*Be efficient and save resources (memory and runtime). Things might work for a small survey but also try out your new feature with a survey that has 400 question, 5 languages and 20,000 responses (Yes, there are surveys like this out there).<br />
*There is always a way to write a line avoiding to reach the 80th column. Think of the people who have a 14" CRT (:wink:)<br />
*Keep a fluid dialog with the others coders, they have their own thoughts about what you are doing.<br />
*Ask if you are in doubt.<br />
<br />
=IMPORTANT=<br />
<br />
'''This is a free development, everything you do can be useful for others. If the feature is very personal there is a way to turn it into a universal solution. This is the challenge!'''<br />
<br />
<div class="simplebox">"The difficulty within a solution is to solve it in a simple way"<br />
<br />
(Lance Burton, magician)</div></div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Coding_guidelines&diff=3138Coding guidelines2012-01-21T03:16:33Z<p>Jcleeland: </p>
<hr />
<div><br />
Contents:__TOC__<br />
<br />
=Naming convention=<br />
*Use the Hungarian Rule for variables:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
[t]NameOfVariable<br />
<br />
 | <strike>-</strike><strike>+</strike>----<br />
<br />
 |     +--> Descriptive name<br />
<br />
 +--> Datatype stored (for example start with "a" if it is an array)<br />
<br />
</syntaxhighlight><br />
<br />
Examples:<br />
<br />
aQuestionAttributes: Array to store the questions attributes, Mixed values<br />
<br />
dSurveyEnds: Date when the survey ends<br />
<br />
sContditionsOutput: String used to create the JS for conditions<br />
*In case a function is declared '''do not''' use the Hungarian rule for the function name, only for the variables:<br />
<br />
function questionsRetrieve( $iQID, $iSurvey)<br />
*What about files? Unless Yii requires it in some way always name your files in lowercase - this prevents problems on systems using case-aware filesystems<br />
<br />
=Documentation=<br />
<br />
Please refer to this introduction: [[How to document your source code]].<br />
<br />
=Structures=<br />
*Indent using spaces instead of TAB, or be gentle to announce how many spaces are your TABs long. There is wide ranging debate about tabs vs. spaces, many people prefer using tabs, others prefer spaces, others are happy with a mix of tabs and spaces. Because LimeSurvey is developed collaboratively, we ask that you leave your preference and follow this standard.<br />
*The opening curly brace must be below the structure opening:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
if (condition)<br />
<br />
{<br />
<br />
  ...<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
*Using one line for a simple condition is very "fashionable", a taste of "hacker", but it is not clear at all:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
 WRONG: if (condition) {do true} else {do false}<br />
<br />
 WRONG: if (condition) {do true}<br />
<br />
    else {do false}<br />
<br />
 RIGHT: if (condition)<br />
<br />
    {<br />
<br />
      do true<br />
<br />
    } else<br />
<br />
    {<br />
<br />
      do false<br />
<br />
    }<br />
<br />
 RIGHT: swith $sSelector<br />
<br />
    {<br />
<br />
       case X:<br />
<br />
          ...<br />
<br />
          break;<br />
<br />
       case Y:<br />
<br />
          ...<br />
<br />
       default:<br />
<br />
    }<br />
<br />
</syntaxhighlight><br />
<br />
NOTE: It&acute;s true that sometimes the "WRONG" way can be useful, but if it makes the straight reading difficult, please use the "RIGHT" way instead. Be gentle with your fellow developers.<br />
*SQL sentences must respect the same rule:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
 $sSQL = "SELECT field1, field2, field3 "<br />
<br />
    ."WHERE condition "<br />
<br />
    ."AND condition "<br />
<br />
    ."OR condition "<br />
<br />
    ."ORDER BY field1, field2";<br />
<br />
</syntaxhighlight><br />
*The same for HTML in views tags:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<table><br />
<br />
<tr><br />
<br />
 <td colspan='2'<br />
<br />
   height='4'><br />
<br />
 <strong><br />
<br />
  Some Text<br />
<br />
 </strong><br />
<br />
 </td><br />
<br />
</tr><br />
<br />
</table><br />
<br />
</syntaxhighlight><br />
<br />
=HTML=<br />
*As you will notice, a very customized HTML element can take a lot of lines (very expensive if you paid each one (:wink:) ) to avoid that, use 'CSS classes'. In general, use classes to aesthetic related stuff: color, borders, backgrounds, font faces, sizes, etc.<br />
*Respect W3C standards, and try to use the HTML understandable for all browsers. If one of them has a special feature, think if this feature is so special to break down the HTML in other browsers.<br />
*Do not use PHP short tags <? ?>. Always use full PHP tags <?php ?><br />
*Any rules of the mentioned before: about CSS, well closed HTML tags and JS respect XHTML standards. Give it a try!.<br />
<br />
=Localization=<br />
<br />
Currently we are using the gT(),eT(),ngT() and neT() functions of the limesurvey_lang object for translations.<br />
<br />
LimeSurvey is available in 60 languages so it is most important that your original English string (which will be picked up automatically for translation by our translators) is done right from the start. Imagine if we have to correct only one string at a later time - then 60 strings become invalid across the project and need to be re-translated by the poor translator souls.<br />
<br />
Please follow these important rules:<br />
*'''Do not embed margin spaces''' in your translation. Instead use proper CSS formatting<br />
<br />
<span style='color:#F00'>Wrong</span>: $clang->eT('Visible? ');<br />
<br />
<span style='color:#060'>Right</span>: $clang->eT('Visible?');<br />
*'''Do not capitalize words''' except where grammatically correct (like at the beginning of a sentence or for a brand name). LimeSurvey is not a newspaper.<br />
<br />
<span style='color:#F00'>Wrong</span>: $clang->eT('Create A New Label Set');<br />
<br />
<span style='color:#060'>Right</span>: $clang->eT('Create a new label set');<br />
<br />
<span style='color:#F00'>Wrong</span>: $clang->eT('Google Maps API Key');<br />
<br />
<span style='color:#060'>Right</span>: $clang->eT('Google Maps API key');<br />
*'''Do not concatenate''' several translations to form a sentence or concatenate to an additional information (like a number or string). Instead use the sprint() or sprintf() function with placeholders.<br />
<br />
<span style='color:#F00'>Wrong</span>: echo $clang->gT('The sum must not be bigger than').$iMaxSum;<br />
<br />
<span style='color:#060'>Right</span>: echo sprintf($clang->gT('The sum must not be bigger than %s'),$iMaxSum);<br />
<br />
This comes from the problem that in other languages the setting of a sentence can be much different and the information $iMaxSum from the example above might be needed in the middle of the sentence.<br />
<br />
<span style='color:#F00'>Wrong</span>: echo $clang->gT('The user').$sUsername.$clang->gT('was deleted.');<br />
<br />
<span style='color:#060'>Right</span>: echo sprintf($clang->gT('The user %s was deleted.'),$sUsername);<br />
*'''Use the n*T functions where applicable'''. These functions show a different translation depending the number of items. Currently LimeSurvey only supports the numbers/situations 1 and >1.<br />
<br />
+Example:<br />
<br />
<span style='color:#F00'>Wrong</span>: echo sprintf($clang->gT('Please select at least %s answer(s).'),$iMinimumAnswers);<br />
<br />
<span style='color:#060'>Right</span>: echo sprintf($clang->ngT('Please select at least %s answer','Please select at least %s answers',iMinimumAnswers),$iMinimumAnswers);<br />
<br />
=Miscellaneous=<br />
*Do not use "global" to access to a declared variable in another process. Pass variables or arrays by reference, use the session or the configuration object.<br />
*If using an auxiliary variable makes clear the code or process, just do it. If you are coding a very complex expression, calling to functions with parameters that are other functions:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
WRONG:<br />
<br />
iAResult= fa(fb(p1,p2),fc(fd(p3),p4),p5)<br />
<br />
It will be more readable:<br />
<br />
iAuxB = fb(p1,p2)<br />
<br />
iAuxD = fd(p3)<br />
<br />
iAuxC = fc(iAuxD,p4)<br />
<br />
iAResult = fa(iAuxB, iAuxC, p5)<br />
<br />
</syntaxhighlight><br />
<br />
Anyway, if you are in doubt about someone missing the point or you are afraid that your expression is obscure, take the chance of writing it in a more simple way, even if that involves the use of one or more auxiliary variables.<br />
*Be efficient and save resources (memory and runtime). Things might work for a small survey but also try out your new feature with a survey that has 400 question, 5 languages and 20,000 responses (Yes, there are surveys like this out there).<br />
*There is always a way to write a line avoiding to reach the 80th column. Think of the people who have a 14" CRT (:wink:)<br />
*Keep a fluid dialog with the others coders, they have their own thoughts about what you are doing.<br />
*Ask if you are in doubt.<br />
<br />
=IMPORTANT=<br />
<br />
'''This is a free development, everything you do can be useful for others. If the feature is very personal there is a way to turn it into a universal solution. This is the challenge!'''<br />
<br />
<div class="simplebox">"The difficulty within a solution is to solve it in a simple way"<br />
<br />
(Lance Burton, magician)</div></div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Using_regular_expressions&diff=3681Using regular expressions2011-10-14T01:17:15Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
(Perl) Regular Expressions must start and finish with a forward slash ("/"). You can find a good library of regular expressions at http://www.regxlib.net/. These patterns will almost all work if surrounded with the forward slash.<br />
<br />
To test your regex you can [http://www.regxlib.net/RETester.aspx use this regex tester].<br />
<br />
''Please add successfully tested regular expressions!''<br />
<br />
Examples (note that these are all one line):<br />
<br />
=SPECIAL NOTE: Regular Expressions in Conditions=<br />
<br />
Note that when using regular expressions in the condition editor, do NOT include the beginning and ending slash.<br />
<br />
=Email Validation:=<br />
<br />
<nowiki>/(\w[-._\w]*\w@\w[-._\w]*\w\.\w{2,3})/</nowiki><br />
<br />
The above regex will not validate email adresses with "+" - which is valid, and e.g. promoted by gmail. The below regex is slightly modified and allows "+":<br />
<br />
<nowiki>/^(\w[-._+\w]*\w@\w[-._\w]*\w\.\w{2,3})$/</nowiki><br />
<br />
It is still far from perfect - but I think its better then the original (also because start-of-string and end-of-string anchors are added). Mind. This will allow e.g. abc+++defg@somemail.office.com. Ideally the regex should be modified to only allow one "+" charachter.<br />
<br />
=Postcodes:=<br />
<br />
==Australian Postcodes:==<br />
<br />
<nowiki>/^[0-9]{4}/</nowiki><br />
<br />
==Canadian Postcodes:==<br />
<br />
<nowiki>/^[a-zA-Z]\d{1}[a-zA-Z](\-| |)\d{1}[a-zA-Z]\d{1}$/</nowiki><br />
<br />
==US Postal Codes:==<br />
<br />
<nowiki>/^[0-9]{5}([- /]?[0-9]{4})?$/</nowiki><br />
<br />
=Phone Numbers=<br />
<br />
==US Phone Number:==<br />
<br />
<nowiki>/^(?:\([2-9]\d{2}\)\ ?|[2-9]\d{2}(?:\-?|\ ?))[2-9]\d{2}[- ]?\d{4}$/</nowiki><br />
<br />
or<br />
<br />
<nowiki>/^[\(\)\.\- ]{0,}[0-9]{3}[\(\)\.\- ]{0,}[0-9]{3}[\(\)\.\- ]{0,}[0-9]{4}[\(\)\.\- ]{0,}$/</nowiki><br />
<br />
This second option will match all phone Canadian and US phone numbers that include non-digit symbols including<br />
<br />
<nowiki> . ( ) - (space)</nowiki><br />
<br />
This will allow you to match phone numbers which resemble below.<br />
*(555)555 5555<br />
*555.555.5555<br />
*555 555 5555<br />
*(555)-555-5555<br />
*555-555-5555<br />
*555555555<br />
<br />
==Australian Phone Number:==<br />
<br />
The following patterns match all various Australian mobile and landline phone numbers including with "+61" country prefix eg:<br />
*(02) 9123 6535<br />
*03 1234-5345<br />
*0412 345 678<br />
*+61 2 3456 789<br />
<br />
But not:<br />
* 234 3450 234<br />
*a234 534 3432<br />
*134567<br />
*123456789013<br />
<br />
Brackets, white space and hypens are ignored.<br />
<br />
<nowiki>NOTE: The 'PRECICE' versions listed here match against the first four or five didgets in a number to ensure that they are valid Australian numbers.<br />
<br />
The 'NOT VERY PRECISE' only match against the first and second didgit so may allow invaid numbers</nowiki><br />
<br />
===All Australian phone numbers (mobile and landline - area code required)===<br />
<br />
<nowiki>VERY PRECISE<br />
<br />
/^\(?(?:\+?61|0)(?:(?:2\)?[ -]?(?:3[ -]?[38]|[46-9][ -]?[0-9]|5[ -]?[0-35-9])|3\)?(?:4[ -]?[0-57-9]|[57-9][ -]?[0-9]|6[ -]?[1-67])|7\)?[ -]?(?:[2-4][ -]?[0-9]|5[ -]?[2-7]|7[ -]?6)|8\)?[ -]?(?:5[ -]?[1-4]|6[ -]?[0-8]|[7-9][ -]?[0-9]))(?:[ -]?[0-9]){6}|4\)?[ -]?(?:(?:[01][ -]?[0-9]|2[ -]?[0-57-9]|3[ -]?[1-9]|4[ -]?[7-9]|5[ -]?[018])[ -]?[0-9]|3[ -]?0[ -]?[0-5])(?:[ -]?[0-9]){5})$/<br />
<br />
NOT VERY PRECISE<br />
<br />
/^(?:\+?61|0)[2-478](?:[ -]?[0-9]){8}$/</nowiki><br />
<br />
===All Australian phone numbers (landlines only - area code required)===<br />
<br />
<nowiki>VERY PRECISE<br />
<br />
/^\(?(?:\+?61|0)(?:2\)?[ -]?(?:3[ -]?[38]|[46-9][ -]?[0-9]|5[ -]?[0-35-9])|3\)?(?:4[ -]?[0-57-9]|[57-9][ -]?[0-9]|6[ -]?[1-67])|7\)?[ -]?(?:[2-4][ -]?[0-9]|5[ -]?[2-7]|7[ -]?6)|8\)?[ -]?(?:5[ -]?[1-4]|6[ -]?[0-8]|[7-9][ -]?[0-9]))(?:[ -]?[0-9]){6}$/<br />
<br />
NOT VERY PRECISE<br />
<br />
/^(?:\+?61|\(?0)[2378]\)?(?:[ -]?[0-9]){8}$/</nowiki><br />
<br />
===New South Wales landline phone numbers (area code optional)===<br />
<br />
<nowiki>VERY PRECISE<br />
<br />
/^(?:\(?(?:\+?61|0)2\)?[ -]?)?(?:3[ -]?[38]|[46-9][ -]?[0-9]|5[ -]?[0-35-9])(?:[ -]?[0-9]){6}$/<br />
<br />
NOT VERY PRECISE<br />
<br />
/^(?:\(?(?:\+?61|0)2\)?(?:[ -]?[0-9]){7}[0-9]$/</nowiki><br />
<br />
===Victorian and Tasmanian landline phone numbers (area code optional)===<br />
<br />
<nowiki>VERY PRECISE<br />
<br />
/^(?:\(?(?:\+?61|0)3\)?[ -]?)?(?:4[ -]?[0-57-9]|[57-9][ -]?[0-9]|6[ -]?[1-67])(?:[ -]?[0-9]){6}$/<br />
<br />
NOT VERY PRECISE<br />
<br />
/^(?:\(?(?:\+?61|0)3\)?(?:[ -]?[0-9]){7}[0-9]$/</nowiki><br />
<br />
===Queensland landline phone numbers (area code optional)===<br />
<br />
<nowiki>VERY PRECISE<br />
<br />
/^(?:\(?(?:\+?61|0)7\)?[ -]?)?(?:[2-4][ -]?[0-9]|5[ -]?[2-7]|7[ -]?6)(?:[ -]?[0-9]){6}$/<br />
<br />
NOT VERY PRECISE<br />
<br />
/^(?:\(?(?:\+?61|0)7\)?(?:[ -]?[0-9]){7}[0-9]$/</nowiki><br />
<br />
===South Australia, Northern Territory, Western Australia landline phone numbers (area code optional)===<br />
<br />
<nowiki>VERY PRECISE<br />
<br />
/^(?:\(?(?:\+?61|0)8\)?[ -]?)?(?:5[1-4]|6[0-8]|[7-9][0-9])$/<br />
<br />
NOT VERY PRECISE<br />
<br />
/^(?:\(?(?:\+?61|0)8\)?(?:[ -]?[0-9]){7}[0-9]$/</nowiki><br />
<br />
===Australian Mobile phone numbers only===<br />
<br />
<nowiki>VERY PRECISE<br />
<br />
/^(?:\+?61|0)4 ?(?:(?:[01] ?[0-9]|2 ?[0-57-9]|3 ?[1-9]|4 ?[7-9]|5 ?[018]) ?[0-9]|3 ?0 ?[0-5])(?: ?[0-9]){5}$/<br />
<br />
NOT VERY PRECISE<br />
<br />
/^(?:\(?(?:\+?61|0)4\)?(?:[ -]?[0-9]){7}[0-9]$/</nowiki><br />
<br />
=German marks (with optional plus or minus)=<br />
<br />
<nowiki>/^[1-6]{1}[\+|\-]?$/</nowiki><br />
<br />
=Age Validation=<br />
<br />
===Example: Age 20-99===<br />
<br />
<nowiki>/([2-9][0-9])/</nowiki><br />
<br />
===Example: Age 18-35===<br />
<br />
<nowiki>/(1[8-9]|2[0-9]|3[0-5])/</nowiki><br />
<br />
===Example: Age 19-65===<br />
<br />
<nowiki><div class="simplebox">(1[8-9]|[2-5][0-9]|6[0-5])$</nowiki><br />
<br />
=Number validation=<br />
<br />
==Numbers from 1 to 99999==<br />
<br />
<nowiki>/^([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|[1-9][0-9][0-9][0-9][0-9])$/</nowiki> <nowiki>/^[1-9][0-9]{0,4}$/ does the same as above but should run a little faster</nowiki><br />
<br />
==Numbers from 1 to 999, 1.000 to 999.999 to 999.999.999==<br />
<br />
<nowiki>/^[1-9][0-9]{0,2}(?:\.[0-9]{3}){0,2}$/<br />
<br />
accepts numbers from 1 to 999, 1.000 to 999.999 to 999.999.999 but<br />
<br />
rejects numbers like 999.1.1 , 94.22.22, 999.1.22, 999.11.1, 999.1.333</nowiki><br />
<br />
==Number validation with optionnal decimal (for price)==<br />
<br />
<nowiki>/^([1][0-9][0-9]|[1-9][0-9]|[0-9])[[\.)[0-9][0-9])?$/ accepts numbers from 0 to 199, with 2 decimal optionnal</nowiki> <nowiki>/^[1-9][0-9]{0,2}(?:,?[0-9]{3}){0,3}\.[0-9]{2}$/<br />
<br />
forces two decimal points<br />
<br />
accepts numbers from 1.00 to 999,999,999.00 with an optional comma delimiting thousands/millions<br />
<br />
including all of the following: 1.00, 1,000.00 , 12,345.67 , 12345,02 , 123,456,468.00 , 1234566.00 , 123456789.00<br />
<br />
but not 1,23.00 , 12,3.4 or 1234,43.04</nowiki> <nowiki>/^[1-9][0-9]{0,2}(?:,?[0-9]{3}){0,3}(?:\.[0-9]{2})?$/ same as above but the two decimal points are optional</nowiki><br />
<br />
==Month (1-12)==<br />
<br />
If you want to ask for the month a person was born you can validate the input as follows:<br />
<br />
<nowiki>/^[0]*[1-9]$|^[0]*1[0-2]$/</nowiki><br />
<br />
=Minimum width (set to 3 in this example)=<br />
<br />
<nowiki>/^.{3,}$/</nowiki><br />
<br />
=Currency=<br />
<br />
==US currency (dollar sign and cents optional)==<br />
<br />
<nowiki>/^\$?\d+(\.(\d{2}]]?$/</nowiki><br />
<br />
==Swiss price==<br />
<br />
A number with two decimal numbers after the decimal point of which the last one is either a 5 or a 0:<br />
<br />
<nowiki>/^(\d+)(\.\d(05)?)?$/</nowiki><br />
<br />
=Validate score=<br />
<br />
==1-10==<br />
<br />
<nowiki>/^[1-9]{1}$|^10$/</nowiki><br />
<br />
==1-100==<br />
<br />
<nowiki>/^[1-9]?[0-9]{1}$|^100$/</nowiki><br />
<br />
=Text validation=<br />
<br />
currently multiple short text doesn't support minimum or maximum answers. One way around this is to use a long free text type question with a regular expression.<br />
<br />
The following test for at least one word per line for at least 3 lines and no more than 10 lines. <nowiki>/(?:[</div>,.;:?!& \n\r]+(?: [<div class="simplebox">,.;:?!& \n\r]+)*)(?:[,.;:?!& \n\r]?(?:\n|\r|\n\r|\r\n)(?:[</div>,.;:?!& \n\r]+(?: [<div class="simplebox">,.;:?!& \n\r]+)*)){2,10}/is</nowiki>If you wanted, say five words per line you could change the first and last star/asterisk to {4,} e.g. <nowiki>/(?:[</div>,.;:?!& \n\r]+(?: [<div class="simplebox">,.;:?!& \n\r]+){4,})(?:[,.;:?!& \n\r]?(?:\n|\r|\n\r|\r\n)(?:[</div>,.;:?!& \n\r]+(?: [<div class="simplebox">,.;:?!& \n\r]+){4,})){2,10}/is</nowiki>If you wanted one or more words per line on between 1 and 5 lines, you can change the content of the last curley braces to {0,4} (note you use 0 because you're already matching the first line. <nowiki>/(?:[</div>,.;:?!& \n\r]+(?: [<div class="simplebox">,.;:?!& \n\r]+)*)(?:[,.;:?!& \n\r]?(?:\n|\r|\n\r|\r\n)(?:[</div>,.;:?!& \n\r]+(?: [<div class="simplebox">,.;:?!& \n\r]+)*)){0,4}/is</nowiki><br />
<br />
==Word count==<br />
<br />
<nowiki>The following restricts the number of words allowed to a minimum of 1 and a maximum of 200<br />
<br />
/^[-\w]+(?:\W+[-\w]+){0,199}\W*$/</nowiki><br />
<br />
<nowiki>To increase the minimum change the zero part of {0,199}<br />
<br />
To increase or decrease the maximum change the "199" part of {0,199}</nowiki><br />
<br />
=Time validation=<br />
<br />
There are a number of ways of writing time formats. Some of the possible options are 12 hour or 24 hour, with seconds or without. Currently  (2009/04/06) LimeSurvey (v1.80plus) doesn't have a Time queston type so instead you can use "short free text" with one of the nine validation regular expressions below:<br />
<br />
<nowiki>The following three validation strings test for 24 hour time (in order of appearences) without seconds, with optional seconds lastly with seconds required.<br />
<br />
/^(?:[01][0-9]|2[0-3]):[0-5][0-9]$/<br />
<br />
/^(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9])?$/<br />
<br />
/^(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$/~/pp<span style="color:pp~The following three match 12 hour time, as above with seconds, optional seconds and with seconds required<br />
<br />
/^(?">00:[0-5][0-9] (?:am|AM)|(?:0[1-9]|1[01]):[0-5][0-9] (?:[ap]m|[AP]M)|12:[0-5][0-9] (?:pm|PM))$/<br />
<br />
/^(?:00:[0-5][0-9](?::[0-5][0-9])? (?:am|AM)|(?:0[1-9]|1[01]):[0-5][0-9](?::[0-5][0-9])? (?:[ap]m|[AP]M)|12:[0-5][0-9](?::[0-5][0-9])? (?:pm|PM))$/<br />
<br />
/^(?:00:[0-5][0-9]:[0-5][0-9] (?:am|AM)|(?:0[1-9]|1[01]):[0-5][0-9]:[0-5][0-9] (?:[ap]m|[AP]M)|12:[0-5][0-9]:[0-5][0-9] (?:pm|PM))$/~/pp</span>pp~The following three match either 12 or 24 hour time as above with seconds, optional seconds and with seconds required<br />
<br />
/^(?:(?:00:[0-5][0-9] (?:am|AM)|(?:0[1-9]|1[01]):[0-5][0-9] (?:[ap]m|[AP]M)|12:[0-5][0-9] (?:pm|PM))|(?:[01][0-9]|2[0-3]):[0-5][0-9])$/<br />
<br />
/^(?:(?:00:[0-5][0-9](?<center>[0-5][0-9])? (?:am|AM)|(?:0[1-9]|1[01]):[0-5][0-9](?</center>[0-5][0-9])? (?:[ap]m|[AP]M)|12:[0-5][0-9](?<center>[0-5][0-9])? (?:pm|PM))|(?:[01][0-9]|2[0-3]):[0-5][0-9](?</center>[0-5][0-9])?)$/<br />
<br />
/^(?:(?:00:[0-5][0-9]:[0-5][0-9] (?:am|AM)|(?:0[1-9]|1[01]):[0-5][0-9]:[0-5][0-9] (?:[ap]m|[AP]M)|12:[0-5][0-9]:[0-5][0-9] (?:pm|PM))|(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9])$/</nowiki><br />
<br />
=US States=<br />
<br />
To validate for one state use the following (example is Texas):<br />
*TX uppercase only = <nowiki>/^(TX)$/</nowiki><br />
*tx lowercase only = <nowiki>/^(tx)$/</nowiki><br />
*TX upper or lowercase = <nowiki>/^([T|t][X|x])$/</nowiki></div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Project_ideas_for_GSOC_2011&diff=2487Project ideas for GSOC 20112011-03-30T23:59:01Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Welcome=<br />
<br />
Welcome Google Summer of Code Student aspirants (:razz:)<br />
<br />
This page lists project ideas developed by the LimeSurvey Community. These tend to be areas that will get the most support as projects since they have been developed by people who know the project and what it needs the most. '''However''', if you have your own idea for a project discuss your awesome idea with us in our [http://www.limesurvey.org/en/forum forums], [https://lists.sourceforge.net/lists/listinfo/limesurvey-developers mailing list] or at [http://www.limesurvey.org/en/support/live-chat #limesurvey on irc.freenode.net]. Then submit your proposal. Good Luck (:biggrin:)<br />
<br />
----<br />
<br />
=Project ideas=<br />
<br />
==Central participants database (User panel)==<br />
<br />
Develop a central 'participants' database for LimeSurvey that can be used as a central registry of participants between surveys. The database should allow<br />
* adding/removing of users along with flexible data to store related information for users<br />
* simple copying of user-information to individual survey token tables<br />
* ability to link user entries with survey responses if the linked survey was not unanimous (UUIDs?)<br />
* ability for survey participants to register in the panel<br />
* ability to update the flexible user data from collected results<br />
* a 'do not email' blacklist to allow people to automatically unsubscribe<br />
* data ownership features for multi-user systems - allow different LimeSurvey users to 'own' different participants<br />
<br />
'''Skills'''<br />
<br />
Database and PHP coding, CodeIgniter<br />
<br />
'''Difficulty'''<br />
<br />
Moderate to high - the coding would be relatively simple, but will entail complex database relationships<br />
<br />
'''Probable mentors'''<br />
<br />
Jason Cleeland<br />
<br />
----<br />
<br />
==Port the LimeSurvey front-end to CodeIgniter==<br />
<br />
LimeSurvey is still written using old procedural code. We want to take the next step into the future and use a MVC-framework name CodeIgniter and port the whole application to this new framework. However proting the whole application is too much for one students. That is why we will split the task into smaller ones. This particular task deals with porting the front-end of LimeSurvey to CodeIgniter - this means all the parts that can be seen by the average survey participant:<br />
*Survey taking<br />
*Public statistics<br />
*Central landing page<br />
<br />
During the rewrite you will be prompted also to encapsulate certain functions to objects where easily doable and it makes sense - we do not want you to rewrite everything. Since you are only working on a certain part of LimeSurvey and other students will port the back-end (=administration) of LimeSurvey you will be required to coordinate your coding with the other students.<br />
<br />
'''Skills'''<br />
<br />
OOP experience in PHP and experience with a PHP framework like CakePHP or CodeIgniter are definately a must. You should get busy with LimeSurvey as early as possible. Students can raise their chance to get accepted by showing off according knowledge about LimeSurvey inner workings.<br />
<br />
'''Difficulty'''<br />
<br />
If you fulfill the requirements above the difficulty in this task is to gradually modernize an application with a modern coding approach while resisting the natural urge to rewrite everything at once. Our mantra to modernizing the application is that the framework is just laying the new fundaments while the fance walls can be built later. So we lay the fundament first and make it stable, then we build new walls (See also [[LimeSurvey roadmap|the LimeSurvey roadmap]] )<br />
<br />
'''Probable mentors'''<br />
<br />
Carsten Schmitz (c_schmitz)<br />
<br />
Thibault le Meur (tlemeur)<br />
<br />
----<br />
<br />
==Port the LimeSurvey back-end (administration) to CodeIgniter==<br />
<br />
LimeSurvey is still written using old procedural code. We want to take the next step into the future and use a MVC-framework name CodeIgniter and port the whole application to this new framework. However porting the whole application is too much for one student. That is why we will split the task into smaller ones. This particular task deals with porting the backend of LimeSurvey to CodeIgniter - this means all the parts that can be seen by an administration user.<br />
<br />
During the rewrite you will be prompted also to encapsulate certain functions to objects where easily doable and it makes sense - we do not want you to rewrite everything. Since you are only working on a certain part of LimeSurvey and another student will port the front-end (=administration) of LimeSurvey you will be required to coordinate your coding with the other student.<br />
<br />
'''Skills'''<br />
<br />
OOP experience in PHP and experience with a PHP framework like CakePHP or CodeIgniter are definately a must. You should get busy with LimeSurvey as early as possible. Students can raise their chance to get accepted by showing off according knowledge about LimeSurvey inner workings.<br />
<br />
'''Difficulty'''<br />
<br />
If you are a very good PHP coder (and fit the demanded skills above) then the main difficulty in this task is the sheer size of it. The administration consists of a great number of different screens and functions which need to be ported. If you don't manage to port all of it then at least the unported parts still have to be working - still best would be if you manage to do the whole administration.<br />
<br />
Also the difficulty in this task is to gradually modernize an application with a modern coding approach while resisting the natural urge to rewrite everything at once. Our mantra to modernizing the application is that the framework is just laying the new foundation while the fancy walls can be built later. So we lay the foundation first and make it stable (your task in the administration), then we build new walls (See also [[LimeSurvey roadmap|the LimeSurvey roadmap]] )<br />
<br />
'''Probable mentors'''<br />
<br />
Carsten Schmitz (c_schmitz)<br />
<br />
Thibault le Meur (tlemeur)<br />
<br />
----<br />
<br />
==Implement a modular authentication framework==<br />
<br />
The idea is to design and implement a modular authentication "framework" for LimeSurvey as well as some authentication modules. The Authentication framework will define the API each authentication plugin must (or may) implement and propose basic methods that can be used by plugins (for instance how to store the plugins parameters in DB, how to display a form using the survey template). A plugin will be responsible to implement, for each particular authentication backend, specific methods (some mandatory, some optionnal) such as: user authentication, user provisionning, user rights, ...<br />
<br />
Currently authentication is only used for the survey-administration GUI and not the participants interface (tokens are used for this). With the new authentication framework it will be possible to define several authentication backends and use some of them for participants-authentication.<br />
<br />
The generic authentication framework must define the following services:<br />
* User authentication: this interface must return the identity of the authenticated user if authentication is successful.<br />
** Authentication may not always be based on a simple user/password form, so the proposed framework must be generic enough to enable authentication based on other schemes (using any numbers or interaction-pages between the server and the end-user or any other contextual parameter such as Referrer, session variable...<br />
* User provisionning:<br />
** when activated on the survey administration interface, an authentication module might be able to create a newly authenticated user into the LimeSurvey internal DB (which is required for setting the user rights on the platform). The newly created user can be assigned a default profile or a per-user profile (queried from an external database).<br />
** when activated on the participants interface, the authentication module will provision the token table of the correspoding survey // alternatively the general-purpose cross-survey participants-database as described in the above GSoC idea.<br />
<br />
The already existing authentication schemes will be ported to the new framework (internal-DB and Web server authentication delegation) and at least a new one will be implemented (openID, CAS, Shibboleth).<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, CodeIgniter, Authentication protocols (openID, CAS, LDAP-bind, ...)<br />
<br />
'''Difficulty'''<br />
<br />
Medium<br />
<br />
'''Probable Mentors'''<br />
<br />
lemeur (Thibault Le Meur)<br />
<br />
'''Want to know more'''<br />
<br />
Please read the [http://docs.limesurvey.org/tiki-index.php?page=GSOC+2010++Authentication+framework#FAQ FAQ about this project]<br />
<br />
----<br />
<br />
== Rewrite and extend the conditions in LimeSurvey==<br />
<br />
[[File:addNewCondition1.png]]<br />
<br />
Rewrite the conditions engine that will let survey administrators design, store and evaluate conditions. Conditions must be implemented in such a way that they can be used in several features such as question branching (survey logic), assessments, quotas, ...<br />
<br />
This projects will at least end up with:<br />
* A working GUI to design complex conditions:<br />
** several atomic conditions can be combined by AND or OR logical operators and will support for grouping conditions with parentheses<br />
** an atomic condition representation can be<br />
<br />
<syntaxhighlight lang="php" enclose="div"><left operand> <operator> <right operand></syntaxhighlight><br />
** an atomic condition editor will implement<br />
*** several operators (equality, inequality, string-comparisons, numerical-comparisons, regexp),...<br />
*** meta operators surch as 'Not displayed'<br />
** left and right operands can be answers from previous questions, or a static values. It should be extensible so that we are able in the future to use more complex operand such as the result of a specific function (for instance the sum of some previous integer questions)<br />
* A working DB storage backend using a string in [http://en.wikipedia.org/wiki/Reverse_Polish_Notation RPN] (Reverse Polish Notation) to describe each condition<br />
* The evaluation of conditions for the question branching feature.<br />
<br />
'''Skills'''<br />
<br />
PHP, CodeIgniter, JQuery and User Interface Design Skills<br />
<br />
'''Difficulty'''<br />
<br />
High<br />
<br />
'''Probable Mentors'''<br />
<br />
Thibault Le Meur (lemeur)<br />
<br />
Carsten Schmitz<br />
<br />
'''Want to know more'''<br />
<br />
Discussion about the [http://docs.limesurvey.org/tiki-index.php?page=GSOC+2010+Condition+engine LS2 conditions engine] is an interresting start. Note however that the task will be easier this year because of the existing conditions engine and the stable database layout of LS1.<br />
<br />
----<br />
<br />
==Custom Report Generation==<br />
<br />
The task is to make a module which will generate custom reports. Module should be able to do these things(at least) :-<br />
*Creating various types of reports i.e. using tables, pie charts, graphs and bar-charts to name few.<br />
*The resulting charts and other illustrations should be easy to read and understand, and should include the ability to export into standard office suites.<br />
*Reports can be general or survey specific.<br />
**General in the sense that it should show basic findings of a general survey graphically like number of users completing the survey, average time taken to complete the survey, average number of correct responses etc.<br />
**Survey specific results should also be addressed properly e.g. how many users choose first option as there answer of a particular question, how many users didn't answer a specific question etc.<br />
<br />
'''Skills'''<br />
<br />
OOP experience in PHP and experience with a PHP framework like CakePHP or CodeIgniter, jQuery. Strong mathematical background will help!<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
'''Probable mentors'''<br />
<br />
Carsten Schmitz (c_schmitz)<br />
<br />
----<br />
<br />
==Adding new questions/subquestions and groups dynamically==<br />
<br />
Currently in LimeSurvey once a survey is activate we can not<br />
*Add or delete groups<br />
*Add or delete questions<br />
*Add or delete subquestions or change their codes<br />
<br />
The idea is to cover these shortcomings. And in addition, all those participants who have already taken that survey must also be notified about the changes.<br />
<br />
'''Skills'''<br />
<br />
Experience with a PHP framework like CakePHP or CodeIgniter and knowledge of inner working of LimeSurvey is must!<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
'''Probable mentors'''<br />
<br />
Carsten Schmitz (c_schmitz)<br />
<br />
----<br />
<br />
==Extend the use of assessments==<br />
<br />
[http://docs.limesurvey.org/Assessments&structure;=English+Instructions+for+LimeSurvey Assessments] are used a lot at Limesurvey but currently this feature only covers very basic needs. Users have asked for some additional assessment features, unfortunately most of them can't be implemented until we start saving assessment results at the database instead of calculating assessment scores at runtime.<br />
<br />
So the first step is to extend the database layout of Limesurvey and add a new table for storing assessment results. Once this is done advanced features can be implemented such as:<br />
* Export assessment results when exporting survey data<br />
* Include assessment results at confirmation emails<br />
* Extend statistics to include information about assessment results such as max score, min score, mean score, standard deviation, ...<br />
* Connect [http://docs.limesurvey.org/Quotas&structure;=English+Instructions+for+LimeSurvey quotas] and assessments so that assessment results can be used to screen users at the beginning of a survey.<br />
* Enable assessment scores at [http://docs.limesurvey.org/Setting+conditions&structure;=English+Instructions+for+LimeSurvey conditions] so that a condition like "''Show question X if <assessment_score1> > 10''"<br />
<br />
'''Skills'''<br />
<br />
PHP, MySQL, CodeIgniter, JQuery and some basic User Interface Design Skills<br />
<br />
'''Difficulty'''<br />
<br />
Medium<br />
<br />
'''Probable Mentors'''<br />
<br />
Carsten Schmitz (c_schmitz)<br />
<br />
----<br />
<br />
=='''NEW''' Rebuild the database frontend using CodeIgniter==<br />
<br />
During last years GSoC, a database frontend was developed using CakePHP. Limesurvey has since decided to switch to the CodeIgniter framework. As such, last years work needs to be ported to CodeIgniter.<br />
<br />
All documentation from last year is available at [[Database Storage Engine Project|here]] aswell as the source of the developed CakePHP modules which can be found [https://limesurvey.svn.sourceforge.net/svnroot/limesurvey/source/limesurvey20/limesurvey-dev/app/plugins/ here] - the plugins market with dbse.<br />
<br />
The final project has to comply with the API developed last year, changes have to be discussed.<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, Object oriented programming & design patterns, CodeIgniter, CakePHP<br />
<br />
'''Difficulty'''<br />
<br />
Medium, Main challenges will be database abstraction and automatic generation of sql code out of survey structures.<br />
<br />
'''Probable Mentors'''<br />
<br />
Maarten Tielemans (ttielu)<br />
<br />
Pieter-Jan Speelmans (MrP001)<br />
<br />
----<br />
<br />
==Idea template==<br />
<br />
Describe the idea here in general terms<br />
<br />
'''Skills'''<br />
<br />
Explain what sort of coding skills would be needed for a student to implement this project<br />
<br />
'''Difficulty'''<br />
<br />
Explain the level of difficulty involved<br />
<br />
'''Probable Mentors'''<br />
<br />
Put your name (and tag) here if you are willing to mentor a student for this idea<br />
<br />
----<br />
<br />
=More information=<br />
<br />
==Getting started==<br />
<br />
[[GSoC getting started|Check out our 'Get started' page]] for setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
==Frequently Asked Questions==<br />
<br />
Check out [[GSoC FAQ|our GSoC FAQ page.]]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_roadmap&diff=2097LimeSurvey roadmap2011-02-09T10:06:54Z<p>Jcleeland: </p>
<hr />
<div><br />
Contents:__TOC__<br />
<br />
=Background=<br />
<br />
Two years ago the development of completely new version of LimeSurvey, namely LimeSurvey 2 (short:LS2) was started. LS2 was developed in chunks during the last two years but until this day it remains far behind the current version of LimeSurvey 1.x. This has several reasons:<br />
*CakePHP as PHP framework proved not dynamic enough. While CakePHP can be made to do all the things we required of it, the effort involved in achieving these things was far greater than we had expected or desired. This became more obvious as work progressed and things became more complicated to code and install. Optimisations also take a lot of effort. In general CakePHP was way slower than the current LimeSurvey 1.<br />
*Except for specific, one-off directed efforts like Google Summer of Code the development stalled because we had no persistent LS2 contributors in the team<br />
*The current LS1 development team is all focused on LimeSurvey 1 which is used by several thousand users and so the feedback of the community and any support is focused on LimeSurvey 1. CakePHP has a steep learning curve and currently none of the existing LS1 developers is able to put their mind to it. There is little likelihood that this will change in the future.<br />
*Even if we put lots of development resources into LS2 right now it would still take another year until at least basic functionality in all common areas will be achieved - and even that will only represent a small fraction of the current LS1 feature set.<br />
<br />
=What now?=<br />
<br />
Considering the history of development activity for LimeSurvey 2 and the underlying problems of its development, the development team has decided that the future of LimeSurvey will take a new turn. This new way will circumvent most of the problems above by taking a slow and evolving approach. The following basic steps will be taken:<br />
*Instead of trying to rewrite such a huge application from scratch we will slowly rewrite LimeSurvey 1. That way we will still have full community and developers support - LimeSurvey 1 will keep evolving and even during the rewrite phase we will be able to have new releases<br />
*Instead of CakePHP we will use the CodeIgniter PHP framwork. CodeIgniter has been proved to be very stable, fast, flexible, actively developed and in many things it is very close to existing libraries already used in LimeSurvey 1 (like AdoDB). That minimizes the learning curve for existing LS1 developers and we can still run the old and new architecture side by side in the same application.<br />
*Concepts that have been elaborated for LS2 aren't automatically obsolete - on the contrary they can be implemented while LimeSurvey is evolving.<br />
*Last but not least: Baby steps - we will get to our goals eventually but if we go slow we won't stumble.<br />
<br />
This new develpment approach will allow us to reach our goal of a modular application which separates content from logic accoroding to MVC standards.<br />
<br />
=Timeline=<br />
<br />
We are currently working out a detailed timeline. Please bear with us - however the first step is pretty clear:<br />
*Summer 2011: Google Summer of Code students will be working on rewriting big parts of the LimeSurvey 1 code to CodeIgniter, starting with the front-end (survey taking) and parts of the administration. Detailed steps can be found in the worked out GSOC tasks, once these are prepared.</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_roadmap&diff=2098LimeSurvey roadmap2011-02-09T10:02:40Z<p>Jcleeland: </p>
<hr />
<div><br />
Contents:__TOC__<br />
<br />
=Background=<br />
<br />
Two years ago the development of completely new version of LimeSurvey, namely LimeSurvey 2 (short:LS2) was started. LS2 was developed in chunks during the last two years but until this day it remains far behind the current version of LimeSurvey 1.x. This has several reasons:<br />
*CakePHP as PHP framework proved to be not dynamic enough. While CakePHP can made to do all the things we required of it, the effort involved in achieving these things was far greater than we had expected or desired. This became more obvious as work progressed and things became more complicated to code and install. Optimisations also take a lot of effort. In general CakePHP was way slower than the current LimeSurvey 1.<br />
*Except for specific, one-off directed efforts like Google Summer of Code the development stalled because we had no persistent LS2 contributors in the team<br />
*The current LS1 development team is all focused on LimeSurvey 1 which is used by several thousand users and so the feedback of the community and any support is focused on LimeSurvey 1. CakePHP has a steep learning curve and currently none of the existing LS1 developers is able to put their mind to it. There is little likelihood that this will change in the future.<br />
*Even if we put lots of development resources into LS2 right now it would still take another year until at least basic functionality in all common areas will be achieved - and even that will only represent a small fraction of the current LS1 feature set.<br />
<br />
=What now?=<br />
<br />
Considered the type of past development activities on LimeSurvey 2 and the underlying problems with the non-existent development resources it was agreed in the development team that the future of LimeSurvey will take a new turn. This new way will circumvent most of the problems above by taking a slow and evolving approach. The following basic steps will be taken:<br />
*Instead of trying to rewrite such a huge application from scratch we will slowly rewrite LimeSurvey 1. That way we will still have full community and developers support - LimeSurvey 1 will keep evolving and even during the rewrite phase we will be able to have new releases<br />
*Instead of CakePHP we will use the CodeIgniter PHP framwork. CodeIgniter has been proved to be very stable, fast, flexible, actively developed and in many things it is very close to existing libraries already used in LimeSurvey 1 (like AdoDB). That minimizes the learning curve for existing LS1 developers and we can still run the old and new architecture side by side in the same application.<br />
*Concepts that have been elaborated for LS2 aren't automatically obsolete - on the contrary they can be implemented while LimeSurvey is evolving.<br />
*Last but not least: Baby steps - we will get to our goals eventually but if we go slow we won't stumble.<br />
<br />
This new develpment approach will allow us to reach our goal of a modular application which separates content from logic accoroding to MVC standards.<br />
<br />
=Timeline=<br />
<br />
We are currently working out a detailed timeline. Please bear with us - however the first step is pretty clear:<br />
*Summer 2011: Google Summer of Code students will be working on rewriting big parts of the LimeSurvey 1 code to CodeIgniter, starting with the front-end (survey taking) and parts of the administration. Detailed steps can be found in the worked out GSOC tasks, once these are prepared.</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_GSoC_2010&diff=2000LimeSurvey GSoC 20102010-05-21T10:44:58Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code 2010=<br />
<br />
The LimeSurvey project has been accepted for the Google Summer of Code 2010!<br />
<br />
=Our Projects for 2010=<br />
* [http://docs.limesurvey.org/tiki-index.php?page=Database+Storage+Engine+Project LimeSurvey 2 Database Storage Engine]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=File+Upload+Question+Type LimeSurvey 1 File Upload Question Type]<br />
<br />
=General Information=<br />
<br />
Google has been continuously supporting Open Source Projects and students coming together since 2005 through its ''Google Summer of Code Programs''. GSoC 2010 has been announced and is On!<br />
<br />
LimeSurvey was accepted as a mentoring organisation for the first time in 2009, and is hopeful and excited about he opportunity to participate again in 2010. We plan to give students an excellent environment and platform to '''learn''' and most importantly to have '''fun''' (:lol:)!<br />
<br />
The LimeSurvey community, at the same time, will benefit by students' participation and fresh eyes and ideas.<br />
<br />
Find out more about our program in 2010 at [http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2010&structure;=LimeSurvey+Development LimeSurvey GSoC 2010]<br />
<br />
==Google Summer of Code Program Information==<br />
<br />
Google Summer of Code is a great program both for Open Source organizations like LimeSurvey as well as students because it gives a platform where several tasks on Open Source Projects are done by students and students in return get a stipend from Google.<br />
<br />
There's a lot more information available in Google's Summer of Code [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs FAQ] and [http://code.google.com/p/google-summer-of-code/ Knowledge Base]. You can also join #gsoc on irc.freenode.net to get feedback or ask questions about Google Summer of Code in real time.<br />
<br />
The timelineline can be found [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs#timeline here].<br />
<br />
==LimeSurvey Specific Information==<br />
<br />
Welcome to the LimeSurvey Community (:biggrin:). LimeSurvey is an open source survey engine that allows people to create and deploy surveys (from marketing to academic to engineering applications). LimeSurvey is written in PHP and used by many high profile organizations including [https://wiki.ubuntu.com/ServerTeam '''Ubuntu Server Team'''], [http://foundation.gnome.org/ '''GNOME Foundation'''] and [http://www.vorarlberg.at/ '''Office of the Austrian Vorarlberg State Government''']<br />
<br />
LimeSurvey is loved and used by many universities, students, medical institutes, non-profit organizations, marketing companies and more around the world. In the 2004 '''U.S. presidential election''', the [http://www.verifiedvoting.org/article.php?id=5207 '''Verified Voting Foundation'''] used PHPSurveyor (as LimeSurvey was then known) to gather data about voting irregularities. Sourceforge provides LimeSurvey as a free application for open source projects. LimeSurvey keeps turning up in new places.<br />
<br />
It's loved because it is free, flexible and constantly improving. It's constantly improving because it has a dedicated and committed team of developers who love the challenge and satisfaction of using and building such a tool.<br />
<br />
LimeSurvey is widely used. It has been directly downloaded from Sourceforge over '''130,000 times''' in the last 12 months alone, and is also distributed as a package in the '''Ubuntu Linux Distribution''', and included as a pre-installed application in many standard Web Hosting packages (such as '''Fantastico''').<br />
<br />
LimeSurvey is recognized as a leader in its field. On November 29, 2007 LimeSurvey won the '''1st prize award''' at the [http://www.trophees-du-libre.org/index.php?lang=en '''Les Troph&eacute;es du Libre'''] contest in the category Corporate Management. In 2008 LimeSurvey was nominated in the category Best Project for the Enterprise in the SourceForge.net '''Community Choice Awards 2008'''. LimeSurvey was successful in being selected as a mentoring organization for the Google Summer of Code in 2009.<br />
<br />
LimeSurvey is the biggest, most active and most exciting open source on-line survey project, and we're building on our success by creating a whole new version of the tool.<br />
<br />
LimeSurvey Version 2 is a whole new - built from the ground-up - version that will revolutionize on-line survey design and use.<br />
<br />
More importantly, it's a perfect opportunity for a GSoC student like yourself to get involved early in a project that has a strong history and an even stronger future. Our community is welcoming and fun. One of our students from 2009 has now become the project lead for LimeSurvey 2. It's a classic case of the student becoming a master!<br />
<br />
==GSoC Student Aspirants==<br />
<br />
Please visit our [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and see if any idea interests you. If you have an idea of your own, then develop it. If any idea excites you, and you want to implement that feature during the summer of 2010, see how you can [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started get started] on it. Come and join us on the IRC channel on freenode (#limesurvey) and talk about what you want to do.<br />
<br />
==LimeSurvey Mentors==<br />
<br />
The following mentors are willing to Mentor students during Google Summer of Code 2010 program.<br />
<br />
Others who are willing to mentor can write their name and details below along with the Idea they are willing to mentor. '''Potential Mentors, please do not forget to put your ideas on the [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and contact [mailto:jason@cleeland.org| program administrator]'''<br />
<br />
{|<br />
|<center>'''Mentor Name'''</center>||<center>'''Nick'''</center>||<center>'''Idea'''</center><br />
|-<br />
|<center>Jason Cleeland</center>||<center>jasebo</center>||<center>Database Storage Engine</center><br />
|-<br />
|<center>Carsten Schmitz</center>||<center>c_schmitz</center>||<center>File upload question type in LimeSurvey 1</center><br />
|-<br />
|<center>Marcel Minke</center> <center>[http://docs.limesurvey.org/tiki-index.php?page=UserPage Mazi||Mazi]</center>||<center>Template editor?</center><br />
|-<br />
|<center>Mac Duy Hai</center>||<center>[[UserPage macduy||macduy]]</center>||<center>Database Storage Engine, Mini-projects</center><br />
|-<br />
|<center>Thibault Le Meur</center>||<center>lemeur</center>||<center>Condition Engine</center><br />
|-<br />
|<br />
|}<br />
<br />
==More Information==<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Student Applications===<br />
* [GSoC_Student_Application_Template|GSoC Student Application Template]<br />
* Advice and General Information:<br />
<br />
- [http://geekfeminism.org/2010/03/25/showing-your-awesomeness-for-google-summer-of-code/ Showing Your Awesomeness for GSoC]<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_GSoC_2010&diff=2001LimeSurvey GSoC 20102010-05-21T10:43:50Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code 2010=<br />
<br />
The LimeSurvey project has been accepted for the Google Summer of Code 2010!<br />
<br />
=Our Projects for 2010=<br />
* [http://docs.limesurvey.org/tiki-index.php?page=Database+Storage+Engine+Project LimeSurvey 2 Database Storage Engine]<br />
* LimeSurvey 1 File Upload Question Type<br />
<br />
=General Information=<br />
<br />
Google has been continuously supporting Open Source Projects and students coming together since 2005 through its ''Google Summer of Code Programs''. GSoC 2010 has been announced and is On!<br />
<br />
LimeSurvey was accepted as a mentoring organisation for the first time in 2009, and is hopeful and excited about he opportunity to participate again in 2010. We plan to give students an excellent environment and platform to '''learn''' and most importantly to have '''fun''' (:lol:)!<br />
<br />
The LimeSurvey community, at the same time, will benefit by students' participation and fresh eyes and ideas.<br />
<br />
Find out more about our program in 2010 at [http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2010&structure;=LimeSurvey+Development LimeSurvey GSoC 2010]<br />
<br />
==Google Summer of Code Program Information==<br />
<br />
Google Summer of Code is a great program both for Open Source organizations like LimeSurvey as well as students because it gives a platform where several tasks on Open Source Projects are done by students and students in return get a stipend from Google.<br />
<br />
There's a lot more information available in Google's Summer of Code [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs FAQ] and [http://code.google.com/p/google-summer-of-code/ Knowledge Base]. You can also join #gsoc on irc.freenode.net to get feedback or ask questions about Google Summer of Code in real time.<br />
<br />
The timelineline can be found [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs#timeline here].<br />
<br />
==LimeSurvey Specific Information==<br />
<br />
Welcome to the LimeSurvey Community (:biggrin:). LimeSurvey is an open source survey engine that allows people to create and deploy surveys (from marketing to academic to engineering applications). LimeSurvey is written in PHP and used by many high profile organizations including [https://wiki.ubuntu.com/ServerTeam '''Ubuntu Server Team'''], [http://foundation.gnome.org/ '''GNOME Foundation'''] and [http://www.vorarlberg.at/ '''Office of the Austrian Vorarlberg State Government''']<br />
<br />
LimeSurvey is loved and used by many universities, students, medical institutes, non-profit organizations, marketing companies and more around the world. In the 2004 '''U.S. presidential election''', the [http://www.verifiedvoting.org/article.php?id=5207 '''Verified Voting Foundation'''] used PHPSurveyor (as LimeSurvey was then known) to gather data about voting irregularities. Sourceforge provides LimeSurvey as a free application for open source projects. LimeSurvey keeps turning up in new places.<br />
<br />
It's loved because it is free, flexible and constantly improving. It's constantly improving because it has a dedicated and committed team of developers who love the challenge and satisfaction of using and building such a tool.<br />
<br />
LimeSurvey is widely used. It has been directly downloaded from Sourceforge over '''130,000 times''' in the last 12 months alone, and is also distributed as a package in the '''Ubuntu Linux Distribution''', and included as a pre-installed application in many standard Web Hosting packages (such as '''Fantastico''').<br />
<br />
LimeSurvey is recognized as a leader in its field. On November 29, 2007 LimeSurvey won the '''1st prize award''' at the [http://www.trophees-du-libre.org/index.php?lang=en '''Les Troph&eacute;es du Libre'''] contest in the category Corporate Management. In 2008 LimeSurvey was nominated in the category Best Project for the Enterprise in the SourceForge.net '''Community Choice Awards 2008'''. LimeSurvey was successful in being selected as a mentoring organization for the Google Summer of Code in 2009.<br />
<br />
LimeSurvey is the biggest, most active and most exciting open source on-line survey project, and we're building on our success by creating a whole new version of the tool.<br />
<br />
LimeSurvey Version 2 is a whole new - built from the ground-up - version that will revolutionize on-line survey design and use.<br />
<br />
More importantly, it's a perfect opportunity for a GSoC student like yourself to get involved early in a project that has a strong history and an even stronger future. Our community is welcoming and fun. One of our students from 2009 has now become the project lead for LimeSurvey 2. It's a classic case of the student becoming a master!<br />
<br />
==GSoC Student Aspirants==<br />
<br />
Please visit our [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and see if any idea interests you. If you have an idea of your own, then develop it. If any idea excites you, and you want to implement that feature during the summer of 2010, see how you can [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started get started] on it. Come and join us on the IRC channel on freenode (#limesurvey) and talk about what you want to do.<br />
<br />
==LimeSurvey Mentors==<br />
<br />
The following mentors are willing to Mentor students during Google Summer of Code 2010 program.<br />
<br />
Others who are willing to mentor can write their name and details below along with the Idea they are willing to mentor. '''Potential Mentors, please do not forget to put your ideas on the [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and contact [mailto:jason@cleeland.org| program administrator]'''<br />
<br />
{|<br />
|<center>'''Mentor Name'''</center>||<center>'''Nick'''</center>||<center>'''Idea'''</center><br />
|-<br />
|<center>Jason Cleeland</center>||<center>jasebo</center>||<center>Database Storage Engine</center><br />
|-<br />
|<center>Carsten Schmitz</center>||<center>c_schmitz</center>||<center>File upload question type in LimeSurvey 1</center><br />
|-<br />
|<center>Marcel Minke</center> <center>[http://docs.limesurvey.org/tiki-index.php?page=UserPage Mazi||Mazi]</center>||<center>Template editor?</center><br />
|-<br />
|<center>Mac Duy Hai</center>||<center>[[UserPage macduy||macduy]]</center>||<center>Database Storage Engine, Mini-projects</center><br />
|-<br />
|<center>Thibault Le Meur</center>||<center>lemeur</center>||<center>Condition Engine</center><br />
|-<br />
|<br />
|}<br />
<br />
==More Information==<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Student Applications===<br />
* [GSoC_Student_Application_Template|GSoC Student Application Template]<br />
* Advice and General Information:<br />
<br />
- [http://geekfeminism.org/2010/03/25/showing-your-awesomeness-for-google-summer-of-code/ Showing Your Awesomeness for GSoC]<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_GSoC_2010&diff=2002LimeSurvey GSoC 20102010-05-21T10:42:47Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code 2010=<br />
<br />
The LimeSurvey project has been accepted for the Google Summer of Code 2010!<br />
<br />
=Our Projects for 2010=<br />
* LimeSurvey 2 Database Storage Engine<br />
* LimeSurvey 1 File Upload Question Type<br />
<br />
=General Information=<br />
<br />
Google has been continuously supporting Open Source Projects and students coming together since 2005 through its ''Google Summer of Code Programs''. GSoC 2010 has been announced and is On!<br />
<br />
LimeSurvey was accepted as a mentoring organisation for the first time in 2009, and is hopeful and excited about he opportunity to participate again in 2010. We plan to give students an excellent environment and platform to '''learn''' and most importantly to have '''fun''' (:lol:)!<br />
<br />
The LimeSurvey community, at the same time, will benefit by students' participation and fresh eyes and ideas.<br />
<br />
Find out more about our program in 2010 at [http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2010&structure;=LimeSurvey+Development LimeSurvey GSoC 2010]<br />
<br />
==Google Summer of Code Program Information==<br />
<br />
Google Summer of Code is a great program both for Open Source organizations like LimeSurvey as well as students because it gives a platform where several tasks on Open Source Projects are done by students and students in return get a stipend from Google.<br />
<br />
There's a lot more information available in Google's Summer of Code [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs FAQ] and [http://code.google.com/p/google-summer-of-code/ Knowledge Base]. You can also join #gsoc on irc.freenode.net to get feedback or ask questions about Google Summer of Code in real time.<br />
<br />
The timelineline can be found [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs#timeline here].<br />
<br />
==LimeSurvey Specific Information==<br />
<br />
Welcome to the LimeSurvey Community (:biggrin:). LimeSurvey is an open source survey engine that allows people to create and deploy surveys (from marketing to academic to engineering applications). LimeSurvey is written in PHP and used by many high profile organizations including [https://wiki.ubuntu.com/ServerTeam '''Ubuntu Server Team'''], [http://foundation.gnome.org/ '''GNOME Foundation'''] and [http://www.vorarlberg.at/ '''Office of the Austrian Vorarlberg State Government''']<br />
<br />
LimeSurvey is loved and used by many universities, students, medical institutes, non-profit organizations, marketing companies and more around the world. In the 2004 '''U.S. presidential election''', the [http://www.verifiedvoting.org/article.php?id=5207 '''Verified Voting Foundation'''] used PHPSurveyor (as LimeSurvey was then known) to gather data about voting irregularities. Sourceforge provides LimeSurvey as a free application for open source projects. LimeSurvey keeps turning up in new places.<br />
<br />
It's loved because it is free, flexible and constantly improving. It's constantly improving because it has a dedicated and committed team of developers who love the challenge and satisfaction of using and building such a tool.<br />
<br />
LimeSurvey is widely used. It has been directly downloaded from Sourceforge over '''130,000 times''' in the last 12 months alone, and is also distributed as a package in the '''Ubuntu Linux Distribution''', and included as a pre-installed application in many standard Web Hosting packages (such as '''Fantastico''').<br />
<br />
LimeSurvey is recognized as a leader in its field. On November 29, 2007 LimeSurvey won the '''1st prize award''' at the [http://www.trophees-du-libre.org/index.php?lang=en '''Les Troph&eacute;es du Libre'''] contest in the category Corporate Management. In 2008 LimeSurvey was nominated in the category Best Project for the Enterprise in the SourceForge.net '''Community Choice Awards 2008'''. LimeSurvey was successful in being selected as a mentoring organization for the Google Summer of Code in 2009.<br />
<br />
LimeSurvey is the biggest, most active and most exciting open source on-line survey project, and we're building on our success by creating a whole new version of the tool.<br />
<br />
LimeSurvey Version 2 is a whole new - built from the ground-up - version that will revolutionize on-line survey design and use.<br />
<br />
More importantly, it's a perfect opportunity for a GSoC student like yourself to get involved early in a project that has a strong history and an even stronger future. Our community is welcoming and fun. One of our students from 2009 has now become the project lead for LimeSurvey 2. It's a classic case of the student becoming a master!<br />
<br />
==GSoC Student Aspirants==<br />
<br />
Please visit our [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and see if any idea interests you. If you have an idea of your own, then develop it. If any idea excites you, and you want to implement that feature during the summer of 2010, see how you can [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started get started] on it. Come and join us on the IRC channel on freenode (#limesurvey) and talk about what you want to do.<br />
<br />
==LimeSurvey Mentors==<br />
<br />
The following mentors are willing to Mentor students during Google Summer of Code 2010 program.<br />
<br />
Others who are willing to mentor can write their name and details below along with the Idea they are willing to mentor. '''Potential Mentors, please do not forget to put your ideas on the [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and contact [mailto:jason@cleeland.org| program administrator]'''<br />
<br />
{|<br />
|<center>'''Mentor Name'''</center>||<center>'''Nick'''</center>||<center>'''Idea'''</center><br />
|-<br />
|<center>Jason Cleeland</center>||<center>jasebo</center>||<center>Database Storage Engine</center><br />
|-<br />
|<center>Carsten Schmitz</center>||<center>c_schmitz</center>||<center>File upload question type in LimeSurvey 1</center><br />
|-<br />
|<center>Marcel Minke</center> <center>[http://docs.limesurvey.org/tiki-index.php?page=UserPage Mazi||Mazi]</center>||<center>Template editor?</center><br />
|-<br />
|<center>Mac Duy Hai</center>||<center>[[UserPage macduy||macduy]]</center>||<center>Database Storage Engine, Mini-projects</center><br />
|-<br />
|<center>Thibault Le Meur</center>||<center>lemeur</center>||<center>Condition Engine</center><br />
|-<br />
|<br />
|}<br />
<br />
==More Information==<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Student Applications===<br />
* [GSoC_Student_Application_Template|GSoC Student Application Template]<br />
* Advice and General Information:<br />
<br />
- [http://geekfeminism.org/2010/03/25/showing-your-awesomeness-for-google-summer-of-code/ Showing Your Awesomeness for GSoC]<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_GSoC_2010&diff=2003LimeSurvey GSoC 20102010-03-27T00:08:23Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code 2010=<br />
<br />
The LimeSurvey project has been accepted for the Google Summer of Code 2010!<br />
<br />
=General Information=<br />
<br />
Google has been continuously supporting Open Source Projects and students coming together since 2005 through its ''Google Summer of Code Programs''. GSoC 2010 has been announced and is On!<br />
<br />
LimeSurvey was accepted as a mentoring organisation for the first time in 2009, and is hopeful and excited about he opportunity to participate again in 2010. We plan to give students an excellent environment and platform to '''learn''' and most importantly to have '''fun''' (:lol:)!<br />
<br />
The LimeSurvey community, at the same time, will benefit by students' participation and fresh eyes and ideas.<br />
<br />
Find out more about our program in 2010 at [http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2010&structure;=LimeSurvey+Development LimeSurvey GSoC 2010]<br />
<br />
==Google Summer of Code Program Information==<br />
<br />
Google Summer of Code is a great program both for Open Source organizations like LimeSurvey as well as students because it gives a platform where several tasks on Open Source Projects are done by students and students in return get a stipend from Google.<br />
<br />
There's a lot more information available in Google's Summer of Code [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs FAQ] and [http://code.google.com/p/google-summer-of-code/ Knowledge Base]. You can also join #gsoc on irc.freenode.net to get feedback or ask questions about Google Summer of Code in real time.<br />
<br />
The timelineline can be found [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs#timeline here].<br />
<br />
==LimeSurvey Specific Information==<br />
<br />
Welcome to the LimeSurvey Community (:biggrin:). LimeSurvey is an open source survey engine that allows people to create and deploy surveys (from marketing to academic to engineering applications). LimeSurvey is written in PHP and used by many high profile organizations including [https://wiki.ubuntu.com/ServerTeam '''Ubuntu Server Team'''], [http://foundation.gnome.org/ '''GNOME Foundation'''] and [http://www.vorarlberg.at/ '''Office of the Austrian Vorarlberg State Government''']<br />
<br />
LimeSurvey is loved and used by many universities, students, medical institutes, non-profit organizations, marketing companies and more around the world. In the 2004 '''U.S. presidential election''', the [http://www.verifiedvoting.org/article.php?id=5207 '''Verified Voting Foundation'''] used PHPSurveyor (as LimeSurvey was then known) to gather data about voting irregularities. Sourceforge provides LimeSurvey as a free application for open source projects. LimeSurvey keeps turning up in new places.<br />
<br />
It's loved because it is free, flexible and constantly improving. It's constantly improving because it has a dedicated and committed team of developers who love the challenge and satisfaction of using and building such a tool.<br />
<br />
LimeSurvey is widely used. It has been directly downloaded from Sourceforge over '''130,000 times''' in the last 12 months alone, and is also distributed as a package in the '''Ubuntu Linux Distribution''', and included as a pre-installed application in many standard Web Hosting packages (such as '''Fantastico''').<br />
<br />
LimeSurvey is recognized as a leader in its field. On November 29, 2007 LimeSurvey won the '''1st prize award''' at the [http://www.trophees-du-libre.org/index.php?lang=en '''Les Troph&eacute;es du Libre'''] contest in the category Corporate Management. In 2008 LimeSurvey was nominated in the category Best Project for the Enterprise in the SourceForge.net '''Community Choice Awards 2008'''. LimeSurvey was successful in being selected as a mentoring organization for the Google Summer of Code in 2009.<br />
<br />
LimeSurvey is the biggest, most active and most exciting open source on-line survey project, and we're building on our success by creating a whole new version of the tool.<br />
<br />
LimeSurvey Version 2 is a whole new - built from the ground-up - version that will revolutionize on-line survey design and use.<br />
<br />
More importantly, it's a perfect opportunity for a GSoC student like yourself to get involved early in a project that has a strong history and an even stronger future. Our community is welcoming and fun. One of our students from 2009 has now become the project lead for LimeSurvey 2. It's a classic case of the student becoming a master!<br />
<br />
==GSoC Student Aspirants==<br />
<br />
Please visit our [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and see if any idea interests you. If you have an idea of your own, then develop it. If any idea excites you, and you want to implement that feature during the summer of 2010, see how you can [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started get started] on it. Come and join us on the IRC channel on freenode (#limesurvey) and talk about what you want to do.<br />
<br />
==LimeSurvey Mentors==<br />
<br />
The following mentors are willing to Mentor students during Google Summer of Code 2010 program.<br />
<br />
Others who are willing to mentor can write their name and details below along with the Idea they are willing to mentor. '''Potential Mentors, please do not forget to put your ideas on the [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and contact [mailto:jason@cleeland.org| program administrator]'''<br />
<br />
{|<br />
|<center>'''Mentor Name'''</center>||<center>'''Nick'''</center>||<center>'''Idea'''</center><br />
|-<br />
|<center>Jason Cleeland</center>||<center>jasebo</center>||<center>Database Storage Engine</center><br />
|-<br />
|<center>Carsten Schmitz</center>||<center>c_schmitz</center>||<center>File upload question type in LimeSurvey 1</center><br />
|-<br />
|<center>Marcel Minke</center> <center>[http://docs.limesurvey.org/tiki-index.php?page=UserPage Mazi||Mazi]</center>||<center>Template editor?</center><br />
|-<br />
|<center>Mac Duy Hai</center>||<center>[[UserPage macduy||macduy]]</center>||<center>Database Storage Engine, Mini-projects</center><br />
|-<br />
|<center>Thibault Le Meur</center>||<center>lemeur</center>||<center>Condition Engine</center><br />
|-<br />
|<br />
|}<br />
<br />
==More Information==<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Student Applications===<br />
* [GSoC_Student_Application_Template|GSoC Student Application Template]<br />
* Advice and General Information:<br />
<br />
- [http://geekfeminism.org/2010/03/25/showing-your-awesomeness-for-google-summer-of-code/ Showing Your Awesomeness for GSoC]<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=GSoC_Student_Application_Template&diff=1439GSoC Student Application Template2010-03-26T04:54:16Z<p>Jcleeland: </p>
<hr />
<div><br />
'''When you make your student application for LimeSurvey on the Google Website you will be asked to provide the following information.'''<br />
<br />
We have reprinted it here so you can start organising yourself early - but you do not submit the application to us, it is submitted to google.<br />
<br />
Note that we will be thrilled if you can provide additional information about your project (ie: screenshots, designs etc.) on a seperate webpage (of your own, we won't host it for you).<br />
<br />
Be as detailed as you possibly can with your "project proposal".<br />
<br />
==Template==<br />
<br />
'''1: Please complete the following information:'''<br />
<br />
(if you can't answer any, enter 'none')<br />
<br />
Your Name:<br />
<br />
Your Email:<br />
<br />
Your IRC Nick:<br />
<br />
Your IM and user id (): ie: Skype, jasebo (Skype is preferred)<br />
<br />
Your location and timezone: Â Â ie: Melbourne Australia, GMT+10<br />
<br />
Your school/educational institution and course: Â Â ie: Monash University, Computer Science<br />
<br />
'''2: Please outline your project proposal with as much detail as possible'''<br />
<br />
- We expect this to be lengthy and descriptive. Short summaries will not be sufficient for us to select your project.<br />
<br />
'''3: How will LimeSurvey benefit from your proposal?'''<br />
<br />
'''4: Please list specific milestones and deliverables for your proposal:'''<br />
<br />
- Milestones and deliverables are points or stages during the project that can be used to check that appropriate progress is being made. A milestone may be a point where certain functionality is available. Milestones or deliverables have to be measurable and explicit, so there has to be something you can show to indicate that a milestone or deliverable has been attained.<br />
<br />
- There must be mid-term milestones and milestones for the end of the project<br />
<br />
- If your proposal is successful, we will pursue milestones and deliverables in greater with you, but we need an indication initially of what milestones you believe can be reached.<br />
<br />
'''5: What Open Source Development Experience do you have?'''<br />
<br />
Please let us know of any experience you have with Open Source projects, whether that is with large coding projects, small projects, bug reports or tiny bug fixes.<br />
<br />
'''6: What other coding, work or related experience do you have?'''<br />
<br />
Let us know of any other experience or skills you have that are related to our project, your proposal and your capacity to achieve the goals you've set out.<br />
<br />
'''7: Academic Experience:'''<br />
<br />
Please detail what you are studying at your higher education institution that is relevant to our project and your proposal. Let us know you're going with it.<br />
<br />
'''8: Why have you chosen LimeSurvey?'''<br />
<br />
Let us know why you chose to apply for GSoC with LimeSurvey.</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=GSoC_Student_Application_Template&diff=1440GSoC Student Application Template2010-03-26T01:03:50Z<p>Jcleeland: </p>
<hr />
<div><br />
'''When you make your student application for LimeSurvey on the Google Website you will be asked to provide the following information.'''<br />
<br />
We have reprinted it here so you can start organising yourself early - but you do not submit the application to us, it is submitted to google.<br />
<br />
Note that we will be thrilled if you can provide additional information about your project (ie: screenshots, designs etc.) on a seperate webpage.<br />
<br />
Be as detailed as you possibly can with your "project proposal".<br />
<br />
'''1: Please complete the following information:'''<br />
<br />
(if you can't answer any, enter 'none')<br />
<br />
Your Name:<br />
<br />
Your Email:<br />
<br />
Your IRC Nick:<br />
<br />
Your IM and user id (): ie: Skype, jasebo (Skype is preferred)<br />
<br />
Your location and timezone: Â Â ie: Melbourne Australia, GMT+10<br />
<br />
Your school/educational institution and course: Â Â ie: Monash University, Computer Science<br />
<br />
'''2: Please outline your project proposal with as much detail as possible'''<br />
<br />
- We expect this to be lengthy and descriptive. Short summaries will not be sufficient for us to select your project.<br />
<br />
'''3: How will LimeSurvey benefit from your proposal?'''<br />
<br />
'''4: Please list specific milestones and deliverables for your proposal:'''<br />
<br />
- Milestones and deliverables are points or stages during the project that can be used to check that appropriate progress is being made. A milestone may be a point where certain functionality is available. Milestones or deliverables have to be measurable and explicit, so there has to be something you can show to indicate that a milestone or deliverable has been attained.<br />
<br />
- There must be mid-term milestones and milestones for the end of the project<br />
<br />
- If your proposal is successful, we will pursue milestones and deliverables in greater with you, but we need an indication initially of what milestones you believe can be reached.<br />
<br />
'''5: What Open Source Development Experience do you have?'''<br />
<br />
Please let us know of any experience you have with Open Source projects, whether that is with large coding projects, small projects, bug reports or tiny bug fixes.<br />
<br />
'''6: What other coding, work or related experience do you have?'''<br />
<br />
Let us know of any other experience or skills you have that are related to our project, your proposal and your capacity to achieve the goals you've set out.<br />
<br />
'''7: Academic Experience:'''<br />
<br />
Please detail what you are studying at your higher education institution that is relevant to our project and your proposal. Let us know you're going with it.<br />
<br />
'''8: Why have you chosen LimeSurvey?'''<br />
<br />
Let us know why you chose to apply for GSoC with LimeSurvey.</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=GSoC_Student_Application_Template&diff=1441GSoC Student Application Template2010-03-26T01:00:57Z<p>Jcleeland: </p>
<hr />
<div><br />
'''When you make your student application for LimeSurvey on the Google Website you will be asked to provide the following information.'''<br />
<br />
We have reprinted it here so you can start organising yourself early - but you do not submit the application to us, it is submitted to google.<br />
<br />
Note that we will be thrilled if you can provide additional information about your project (ie: screenshots, designs etc. on a seperate webpage).<br />
<br />
Be as detailed as you possibly can with your "project proposal".<br />
<br />
'''1: Please complete the following information:'''<br />
<br />
(if you can't answer any, enter 'none')<br />
<br />
Your Name:<br />
<br />
Your Email:<br />
<br />
Your IRC Nick:<br />
<br />
Your IM and user id (): ie: Skype, jasebo (Skype is preferred)<br />
<br />
Your location and timezone: Â Â ie: Melbourne Australia, GMT+10<br />
<br />
Your school/educational institution and course: Â Â ie: Monash University, Computer Science<br />
<br />
'''2: Please outline your project proposal with as much detail as possible'''<br />
<br />
- We expect this to be lengthy and descriptive. Short summaries will not be sufficient for us to select your project.<br />
<br />
'''3: How will LimeSurvey benefit from your proposal?'''<br />
<br />
'''4: Please list specific milestones and deliverables for your proposal:'''<br />
<br />
- Milestones and deliverables are points or stages during the project that can be used to check that appropriate progress is being made. A milestone may be a point where certain functionality is available. Milestones or deliverables have to be measurable and explicit, so there has to be something you can show to indicate that a milestone or deliverable has been attained.<br />
<br />
- There must be mid-term milestones and milestones for the end of the project<br />
<br />
- If your proposal is successful, we will pursue milestones and deliverables in greater with you, but we need an indication initially of what milestones you believe can be reached.<br />
<br />
'''5: What Open Source Development Experience do you have?'''<br />
<br />
Please let us know of any experience you have with Open Source projects, whether that is with large coding projects, small projects, bug reports or tiny bug fixes.<br />
<br />
'''6: What other coding, work or related experience do you have?'''<br />
<br />
Let us know of any other experience or skills you have that are related to our project, your proposal and your capacity to achieve the goals you've set out.<br />
<br />
'''7: Academic Experience:'''<br />
<br />
Please detail what you are studying at your higher education institution that is relevant to our project and your proposal. Let us know you're going with it.<br />
<br />
'''8: Why have you chosen LimeSurvey?'''<br />
<br />
Let us know why you chose to apply for GSoC with LimeSurvey.</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=GSoC_Student_Application_Template&diff=1442GSoC Student Application Template2010-03-26T00:57:30Z<p>Jcleeland: </p>
<hr />
<div><br />
'''1: Please complete the following information:'''<br />
<br />
(if you can't answer any, enter 'none')<br />
<br />
Your Name:<br />
<br />
Your Email:<br />
<br />
Your IRC Nick:<br />
<br />
Your IM and user id (): ie: Skype, jasebo (Skype is preferred)<br />
<br />
Your location and timezone: Â Â ie: Melbourne Australia, GMT+10<br />
<br />
Your school/educational institution and course: Â Â ie: Monash University, Computer Science<br />
<br />
'''2: Please outline your project proposal with as much detail as possible'''<br />
<br />
- We expect this to be lengthy and descriptive. Short summaries will not be sufficient for us to select your project.<br />
<br />
'''3: How will LimeSurvey benefit from your proposal?'''<br />
<br />
'''4: Please list specific milestones and deliverables for your proposal:'''<br />
<br />
- Milestones and deliverables are points or stages during the project that can be used to check that appropriate progress is being made. A milestone may be a point where certain functionality is available. Milestones or deliverables have to be measurable and explicit, so there has to be something you can show to indicate that a milestone or deliverable has been attained.<br />
<br />
- There must be mid-term milestones and milestones for the end of the project<br />
<br />
- If your proposal is successful, we will pursue milestones and deliverables in greater with you, but we need an indication initially of what milestones you believe can be reached.<br />
<br />
'''5: What Open Source Development Experience do you have?'''<br />
<br />
Please let us know of any experience you have with Open Source projects, whether that is with large coding projects, small projects, bug reports or tiny bug fixes.<br />
<br />
'''6: What other coding, work or related experience do you have?'''<br />
<br />
Let us know of any other experience or skills you have that are related to our project, your proposal and your capacity to achieve the goals you've set out.<br />
<br />
'''7: Academic Experience:'''<br />
<br />
Please detail what you are studying at your higher education institution that is relevant to our project and your proposal. Let us know you're going with it.<br />
<br />
'''8: Why have you chosen LimeSurvey?'''<br />
<br />
Let us know why you chose to apply for GSoC with LimeSurvey.</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_GSoC_2010&diff=2004LimeSurvey GSoC 20102010-03-26T00:54:50Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code 2010=<br />
<br />
The LimeSurvey project has been accepted for the Google Summer of Code 2010!<br />
<br />
=General Information=<br />
<br />
Google has been continuously supporting Open Source Projects and students coming together since 2005 through its ''Google Summer of Code Programs''. GSoC 2010 has been announced and is On!<br />
<br />
LimeSurvey was accepted as a mentoring organisation for the first time in 2009, and is hopeful and excited about he opportunity to participate again in 2010. We plan to give students an excellent environment and platform to '''learn''' and most importantly to have '''fun''' (:lol:)!<br />
<br />
The LimeSurvey community, at the same time, will benefit by students' participation and fresh eyes and ideas.<br />
<br />
Find out more about our program in 2010 at [http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2010&structure;=LimeSurvey+Development LimeSurvey GSoC 2010]<br />
<br />
==Google Summer of Code Program Information==<br />
<br />
Google Summer of Code is a great program both for Open Source organizations like LimeSurvey as well as students because it gives a platform where several tasks on Open Source Projects are done by students and students in return get a stipend from Google.<br />
<br />
There's a lot more information available in Google's Summer of Code [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs FAQ] and [http://code.google.com/p/google-summer-of-code/ Knowledge Base]. You can also join #gsoc on irc.freenode.net to get feedback or ask questions about Google Summer of Code in real time.<br />
<br />
The timelineline can be found [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs#timeline here].<br />
<br />
==LimeSurvey Specific Information==<br />
<br />
Welcome to the LimeSurvey Community (:biggrin:). LimeSurvey is an open source survey engine that allows people to create and deploy surveys (from marketing to academic to engineering applications). LimeSurvey is written in PHP and used by many high profile organizations including [https://wiki.ubuntu.com/ServerTeam '''Ubuntu Server Team'''], [http://foundation.gnome.org/ '''GNOME Foundation'''] and [http://www.vorarlberg.at/ '''Office of the Austrian Vorarlberg State Government''']<br />
<br />
LimeSurvey is loved and used by many universities, students, medical institutes, non-profit organizations, marketing companies and more around the world. In the 2004 '''U.S. presidential election''', the [http://www.verifiedvoting.org/article.php?id=5207 '''Verified Voting Foundation'''] used PHPSurveyor (as LimeSurvey was then known) to gather data about voting irregularities. Sourceforge provides LimeSurvey as a free application for open source projects. LimeSurvey keeps turning up in new places.<br />
<br />
It's loved because it is free, flexible and constantly improving. It's constantly improving because it has a dedicated and committed team of developers who love the challenge and satisfaction of using and building such a tool.<br />
<br />
LimeSurvey is widely used. It has been directly downloaded from Sourceforge over '''130,000 times''' in the last 12 months alone, and is also distributed as a package in the '''Ubuntu Linux Distribution''', and included as a pre-installed application in many standard Web Hosting packages (such as '''Fantastico''').<br />
<br />
LimeSurvey is recognized as a leader in its field. On November 29, 2007 LimeSurvey won the '''1st prize award''' at the [http://www.trophees-du-libre.org/index.php?lang=en '''Les Troph&eacute;es du Libre'''] contest in the category Corporate Management. In 2008 LimeSurvey was nominated in the category Best Project for the Enterprise in the SourceForge.net '''Community Choice Awards 2008'''. LimeSurvey was successful in being selected as a mentoring organization for the Google Summer of Code in 2009.<br />
<br />
LimeSurvey is the biggest, most active and most exciting open source on-line survey project, and we're building on our success by creating a whole new version of the tool.<br />
<br />
LimeSurvey Version 2 is a whole new - built from the ground-up - version that will revolutionize on-line survey design and use.<br />
<br />
More importantly, it's a perfect opportunity for a GSoC student like yourself to get involved early in a project that has a strong history and an even stronger future. Our community is welcoming and fun. One of our students from 2009 has now become the project lead for LimeSurvey 2. It's a classic case of the student becoming a master!<br />
<br />
==GSoC Student Aspirants==<br />
<br />
Please visit our [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and see if any idea interests you. If you have an idea of your own, then develop it. If any idea excites you, and you want to implement that feature during the summer of 2010, see how you can [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started get started] on it. Come and join us on the IRC channel on freenode (#limesurvey) and talk about what you want to do.<br />
<br />
==LimeSurvey Mentors==<br />
<br />
The following mentors are willing to Mentor students during Google Summer of Code 2010 program.<br />
<br />
Others who are willing to mentor can write their name and details below along with the Idea they are willing to mentor. '''Potential Mentors, please do not forget to put your ideas on the [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and contact [mailto:jason@cleeland.org| program administrator]'''<br />
<br />
{|<br />
|<center>'''Mentor Name'''</center>||<center>'''Nick'''</center>||<center>'''Idea'''</center><br />
|-<br />
|<center>Jason Cleeland</center>||<center>jasebo</center>||<center>Database Storage Engine</center><br />
|-<br />
|<center>Carsten Schmitz</center>||<center>c_schmitz</center>||<center>File upload question type in LimeSurvey 1</center><br />
|-<br />
|<center>Marcel Minke</center> <center>[http://docs.limesurvey.org/tiki-index.php?page=UserPage Mazi||Mazi]</center>||<center>Template editor?</center><br />
|-<br />
|<center>Mac Duy Hai</center>||<center>[[UserPage macduy||macduy]]</center>||<center>Database Storage Engine, Mini-projects</center><br />
|-<br />
|<center>Thibault Le Meur</center>||<center>lemeur</center>||<center>Condition Engine</center><br />
|-<br />
|<br />
|}<br />
<br />
==More Information==<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]<br />
<br />
===Student Application Template===<br />
* [GSoC_Student_Application_Template|GSoC Student Application Template]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Project_ideas_for_GSOC_2010&diff=2480Project ideas for GSOC 20102010-03-20T15:15:58Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Welcome=<br />
<br />
Welcome Google Summer of Code Student aspirants (:razz:)!! Please check if you are an [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs#student_eligibility eligible candidate] for the GSoC program.<br />
<br />
This page lists project ideas developed by the LimeSurvey Community. These tend to be areas that will get the most support as projects since they have been developed by people who know the project and what it needs the most. '''However''', if you have your own idea for a project discuss your awesome idea with us in our [http://www.limesurvey.org/component/option,com_fireboard/Itemid,105/func,view/catid,11/id,24710/lang,en/ forums], [https://lists.sourceforge.net/lists/listinfo/limesurvey-developers mailing list] or at #limesurvey on irc.freenode.net. Then submit '''your''' proposal. Good Luck (:biggrin:)<br />
<br />
=Project ideas=<br />
<br />
==Example Format...==<br />
<br />
Describe the idea here in general terms<br />
<br />
'''Skills'''<br />
<br />
Explain what sort of coding skills would be needed for a student to implement this project<br />
<br />
'''Difficulty'''<br />
<br />
Explain the level of difficulty involved<br />
<br />
'''Probable Mentors'''<br />
<br />
Put your name (and tag) here if you are willing to mentor a student for this idea<br />
<br />
==LimeSurvey 1: File Upload question type==<br />
<br />
The idea is to have a question type in LimeSurvey1 where survey participants can upload one (or more) files. Often in surveys the participant is asked to create some content (pictures, movies, documents, etc.)  to upload as an answer to a question. The following goals are  primary in this task:<br />
*Easy handling for the participant (uploading one or more files should be a piece of cake - also removing files if accidentally the wrong file was uploaded)<br />
*Extensive configuration options for the question type like<br />
**How many files are required, minimum and maxim number of files,<br />
**maximum/minimum upload size,<br />
**Allowed file types<br />
*Safe!! storage in the file system, checks for file contents<br />
*Implementation in statistics / data entry / printable survey / response browsing / response editing & RemoteControl<br />
*Administrator can download one or more files (zip-packaging files for download) from one response and across responses<br />
*Provide possible hooks for third party processing tools<br />
<br />
'''Skills'''<br />
<br />
PHP, jQuery, AJAX - existing knowledge on the general idea and related security would be of big advantage<br />
<br />
'''Difficulty'''<br />
<br />
Medium<br />
<br />
'''Probable Mentors'''<br />
<br />
c_schmitz (Carsten Schmitz)<br />
<br />
==LimeSurvey 1: Authentication framework==<br />
<br />
The idea is to design and implement a generic authentication framework for LimeSurvey 1 as well as some authentication modules. The Authentication framework will make it possible to implement any kind of authentication backend apart from the already existing internal-DB and Web server delegation schemes. Currently authentication is only used for the survey-administration GUI and not the participants interface (tokens are used for this). With the new authentication framework it will be possible to define several authentication backends and use some of them for participants-authentication.<br />
<br />
The generic authentication framework must define the following services:<br />
* User authentication: this interface must return the identity of the authenticated user if authentication is successful.<br />
** Authentication may not always be based on a simple user/password form, so the proposed framework must be generic enough to enable authentication based on other schemes (using any numbers or GET/POST parameters or any other contextual parameter such as Referrer, session variable...<br />
* User provisionning:<br />
** when activated on the survey administration interface, an authentication module might be able to create a newly authenticated user into the LimeSurvey internal DB (which is required for setting the user rights on the platform). The newly created user can be assigned a default profile or a per-user profile (queried from an external database).<br />
** when activated on the participants interface, the authentication module will provision the token table of the correspoding survey (only if the token for this user has not been already added).<br />
<br />
The already existing authentication schemes will be ported to the new framework (internal-DB and Web server authentication delegation) and at least a new one will be implemented (openID, CAS, Shibboleth).<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, Authentication protocols (openID, CAS, LDAP-bind, ...)<br />
<br />
'''Difficulty'''<br />
<br />
Medium<br />
<br />
'''Probable Mentors'''<br />
<br />
lemeur (Thibault Le Meur)<br />
<br />
==LimeSurvey 2: Db Storage Engine==<br />
<br />
Develop an extensible plugin survey storage engine for LimeSurvey 2.<br />
<br />
<u>Description</u><br />
<br />
Other than survey design, everything that happens in LimeSurvey centres around the ability to save responses to questions to a database, and retrieve the responses again when required. Historically these functions have been incorporated within the various functions of LimeSurvey and this has locked LimeSurvey to a single methodology for data storage and retrieval and made future modifications and improvements difficult if not possible.<br />
<br />
For this project we are looking for students to write a 'middleware' that exposes abstract high-level functions to LimeSurvey 2 (e.g.: storing these answers related to this question, running statistical analysis etc.) but is built in top of Cake's 'low-level' operations (such as find, save etc). The aim is to abstract away from a specific DB implementation and provide an intuitive and rich API for LS2.<br />
<br />
<u>Rationale</u><br />
<br />
Because the interface with the data storage system is so critical to practically every other function in LimeSurvey we want to develop a stand-alone module that is transportable and extensible for the future. And by keeping the logic of data and survey storage separate from the rest of LimeSurvey&rsquo;s functions we will the ease with which LimeSurvey can be developed in the long term.<br />
<br />
<u>Implementation</u><br />
<br />
This is such an important project that we would consider multiple students undertaking the task. In conjunction with a strong understanding of data structures, php coding and api principles the students would also have to display a capacity to work in a team and with the broader community.<br />
<br />
The implementation would focus on becoming a plugin/addon module under CakePHP which uses the default CakePHP database systems to the absolute minimum. In a well implemented version of this proposal only simple SQL inserts, queries and updates would be required. All other logic would be managed by the engine.<br />
<br />
<u>Requirements & Considerations</u><br />
<br />
The DB Engine must be able to do the following<br />
* ease development of additional '''question types, which will be developed as plugins'''<br />
* '''efficient data retrieval''', especially summaries (e.g. display 100 last responses)<br />
* support '''generic''' data storage and retrieval - aside surveys, imagine running online admission tests, polls, sign-up forms, volunteer campaign etc. etc.<br />
* easily support conditions, looped question, or generally, '''non-linear data'''. Think of a survey that asks how many children you have and then asks information about each of them.<br />
* support questions that have multiple '''answers and multiple types of answers'''. Think of a question asking "What is your favourite ice cream?", offering 3 fixed options and last one allowing user to enter a custom answer.<br />
* support survey resuming (where applicable)<br />
<br />
<u>Field Naming and Database Extensibility Methodologies</u><br />
<br />
An ongoing debate in the LimeSurvey community has been the method in which the database stores survey results. In LimeSurvey 1 a flat database schema was used whereby once the survey designer had finished setting up the survey a database table was created with a field for every individual question/answer combination. The advantages of this database schema were speed of retrieval for reporting and exporting and searching. The disadvantages were that the survey system had to &lsquo;freeze&rsquo; the structure in place once the table was created (therefore the activate/de-activate rules in LimeSurvey 1). The single table method doesn&rsquo;t allow easy storage of metadata for individual question/answer combinations (such as timestamps). Nor does it lend itself to surveys with enormous quantities of question/answer combinations &ndash; sometimes running up against database limitations regarding the number of fields per table.<br />
<br />
An alternative is a &lsquo;normalised&rsquo; database topology where a single table is created to store all survey responses &ndash; one database row per question/answer combination. A related table would store metadata that is directly related to the survey sitting/session rather than the answer (e.g.: username, ip address, geographical location, user demographic). The advantage to this methodology is the increased flexibility (extensible) which would allow modification of surveys at any stage even after data has been collected (see requirements). The disadvantages are that searching and compilation of data is complicated and resource intensive.<br />
<br />
In a perfect world LimeSurvey would allow users to choose either methodology &ndash; either at an installation level or even on a per-survey level.<br />
<br />
Having a database storage engine effectively acting as an API would allow this functionality to be built, but the choice of database topology would be invisible to the related LimeSurvey functions that require data.<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, Database Schema Design, Sound knowledge of Algorithms and Data Structures<br />
<br />
'''Difficulty'''<br />
<br />
High<br />
<br />
'''Probable Mentors'''<br />
<br />
jasebo (Jason Cleeland)<br />
<br />
macduy (Mac Duy Hai)<br />
<br />
==LimeSurvey 2: Template Editor==<br />
<br />
Limesurvey 2 needs a nice and powerful template editor so everyone can create a template which matches their requirements.<br />
<br />
'''Skills'''<br />
<br />
One needs to know about the details of the [http://dwoo.org/ dwoo template engine] which is used at LS2. There is some cakePHP coding needed to create an interface and write changes to the template files as well as some HTML/CSS to create a nice interface.<br />
<br />
'''Difficulty'''<br />
<br />
You don't have to create difficult algorithms for this task. It's useful if you have worked with templates for another web-application or take a detailled look at [http://docs.limesurvey.org/tiki-index.php?page=Themes%3A+Templates+and+Styles&structure;=English+Instructions+for+LimeSurvey how templates work in Limesurvey]. Some design/usability background would be nice but is not a must.<br />
<br />
'''Probable Mentors'''<br />
<br />
Mazi<br />
<br />
==LimeSurvey 2: Mini-projects==<br />
<br />
Mini-projects is a collection of small-to-medium sized projects, which you mix-and-match according to your tastes. Heck, you can even roll your own idea and once reviewed and approved, you can code away. Some recommended/important mini-projects and their brief descriptions:<br />
*'''Smarter installer:''' LS2.0 comes with its own installer, though it may not be the friendliest to use. Your task is to make it juicier to use:<br />
** Resume installation - if the user aborts the installation mid-way, make it easy for him to resume it<br />
** Better error handling - meaningful error reports, suggestions how to fix them: e.g. "Database does not exist" is better than "Database error"<br />
** Customization - invite the user to customize his installation of LimeSurvey - from security settings such as salt, to interface such as the header title.<br />
*'''User management:''' When the number of users grow, it becomes increasingly harder to manage them. Implement functionality and provide interface for features that would make this task easier. Inspire yourself by the big players, such as the infamous you-know-which-one social website.<br />
**'''Groups within groups:''' LS2 users can belong to a group, but groups cannot belong to other groups.<br />
**'''Contact lists:''' There is already something called AssignmentGroups. Study this concept carefully and generalize to a Contact List<br />
**'''GUI:''' Design a GUI which allows you easily manage users, groups and contact lists.<br />
**'''Searching:''' Provide an efficient but simple-to-use search interface and functionality<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, JavaScript & jQuery<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
'''Probable Mentors'''<br />
<br />
Mac Duy Hai (macduy)<br />
<br />
==LimeSurvey 2: Template/Theme Editor==<br />
<br />
The idea is to develop a theme / template framework similar to one in jquery [http://jqueryui.com/themeroller/ | Jquery Theme Roller] and thus making the UI design of the surveys easier.The current template editor is based on dwoo template engine which actually loads the files exposing the css etc for us to edit, which of course require some skill set to proceed. Using this template editor we can make everything UI based and thus requiring no developer skills to edit the templates.<br />
<br />
The overview of the modules can be seen here:<br />
<br />
[[File:theme_roller.png]]<br />
<br />
It&rsquo;ll be implemented using Jquery to use the more advanced UI experiences.(:biggrin:)<br />
<br />
The following mock-up will give us a better view:<br />
<br />
Moderate[[File:theme_editor_small.png]]<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, CSS, AJAX, JavaScript & jQuery.<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
==LimeSurvey 2: Lime Survey Social - Facebook Application==<br />
<br />
The idea aims at developing a Facebook app which gives a social touch to LS 2.0. The application will be integrated in several Facebook integration points like News Feed, Applications boxes, Wall etc so that the user participation will be more. Adding a social touch can drive us more user participation and increase the popularity. The ability to control the Facebook app can be provided in the LS2.0 Admin Dashboard and also in the FB user application window with varied options.<br />
<br />
The facebook has the following modules (we can add more. This is primary draft.)<br />
*All Survey related core features. (Create, Edit, Delete, Administer etc)<br />
*Gain reward points.<br />
*Use reward points to create more surveys.<br />
*Spread the surveys ...... and more<br />
<br />
The idea can be extended to other social networks<br />
<br />
[[File:fb_overview.png]]<br />
<br />
The mock-ups :<br />
<br />
[[File:facebook app.png]]<br />
<br />
[[File:canvas.png]]<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, Facebook API.<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
==LimeSurvey 2: Integration of Poll Questions==<br />
<br />
Polls are one of the most popular and quick response getting tools once can use. Implementing polls in LS 2.0 will be an added advantage. Since every one of us know what polls are about, this idea focuses on the implementation part.<br />
<br />
The idea is to integrate the ability to create a POLL Module in Admin dashboard, where he can administer (Create | Edit | Delete | View Responses etc) the Polls.We can even get feedback &ldquo;about the survey&rdquo; at the end on how the user feels by creating a custom poll (we can even redirect the user to this poll).<br />
*Chat Bots and Polls: An another idea is to create chat bots so that whenever we create a poll, all the friends (who added the bot) of that bot will be pinged by the question followed by options. Getting an answer is very easy (Bot friends just need to type a single letter stating the answer) and its a push model which ensures the delivery to everyone (even offline).We can even extend this to deliver certain type of surveys question by question through the bot.<br />
<br />
A simple mock-up for this:<br />
<br />
[[File:chat.png]]<br />
*Alternate Solution: An alternate solution provided by Mazi is clubbing this idea with the Facebook app idea. Instead of porting parts of the admin backend to facebook or other social networks we'll have options in Admin panel to "publish as: common survey |mobile device survey | facebook poll | homepage poll | Â ... etc " Everything will be put together at the usualm admin backend but you can choose which way(s) you want publish your survey.<br />
<br />
We can further extend this idea by giving additional options to publish as widgets for websites and blogs etc.<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, XMPP Protocol (Knowledge of developing bots), Knowledge of Polls.<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
==LimeSurvey 2: Survey Community Project==<br />
<br />
Build a system for LS2 that connects to a central repository of survey resources, such as demographic questions, answer styles and templates. Integrating with a login system, allow LimeSurvey users to easily publish their work to a community resource or use other published works from the same location.<br />
<br />
For many finding already written question texts, or standardised demographic questions would really simplify their use of a survey tool. LimeSurvey could leverage on the community spirit of an open source product and encourage users to share their own work. By integrating a "Publish to the LimeSurvey Library" button in the administration system with questions, or templates, or anything else that can be shared, LimeSurvey could develop a library of tools that simplifies Survey Creation even further.<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, Web and User Interface Design Skills<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
'''Probable Mentors'''<br />
<br />
Jason Cleeland (jasebo)<br />
<br />
==LimeSurvey 2: Condition Engine==<br />
<br />
[[File:addNewCondition1.png]]<br />
<br />
Build a system for LS2 that will let survey administrators design, store and evaluate conditions. Conditions can be used in several features such as question branching (survey logic), assessments, quotas, ...<br />
<br />
This projects will at least end up with:<br />
* A working GUI to design complex conditions:<br />
** several atomic conditions can be combined by AND or OR logical operators and will support for grouping conditions with parentheses<br />
** an atomic condition representation can be<br />
<br />
<syntaxhighlight lang="php" enclose="div"><left operand> <operator> <right operand></syntaxhighlight><br />
** an atomic condition editor will implement<br />
*** several operators (equality, inequality, string-comparisons, numerical-comparisons, regexp),...<br />
*** meta operators surch as 'Not displayed'<br />
** left and right operands can be answers from previous questions, or a static values. It should be extensible so that we are able in the future to use more complex operand such as the result of a specific function (for instance the sum of some previous integer questions)<br />
* A working DB storage backend using a string in [http://en.wikipedia.org/wiki/Reverse_Polish_Notation RPN] (Reverse Polish Notation) to describe each condition<br />
* A first version of the evaluation of conditions for the question branching feature. This part will require interaction with other parts of the projects (Survey Engine, and DB engine).<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, JQuery and User Interface Design Skills<br />
<br />
'''Difficulty'''<br />
<br />
High<br />
<br />
'''Probable Mentors'''<br />
<br />
Thibault Le Meur (lemeur)<br />
<br />
=We want your ideas!=<br />
<br />
What floats your boat? Do you have another idea that gets you excited? Discuss your ideas in our [http://www.limesurvey.org/component/option,com_fireboard/Itemid,105/func,view/catid,11/id,24710/lang,en/ forums], [https://lists.sourceforge.net/lists/listinfo/limesurvey-developers mailing lists] or at #limesurvey on irc.freenode.net.<br />
<br />
=More Information=<br />
<br />
==LimeSurvey Google's Summer of Code 2010==<br />
*[http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2010 Limesurvey GSoC 2010]<br />
<br />
An introduction to LimeSurvey and our application for this years Google Summer of Code<br />
<br />
==Getting Started==<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started How to get started with LimeSurvey's GSoC]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
==Frequently Asked Questions==<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google's Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Project_ideas_for_GSOC_2010&diff=2481Project ideas for GSOC 20102010-03-20T15:04:35Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Welcome=<br />
<br />
Welcome Google Summer of Code Student aspirants (:razz:)!! Please check if you are an [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs#student_eligibility eligible candidate] for the GSoC program.<br />
<br />
This page lists project ideas developed by the LimeSurvey Community. These tend to be areas that will get the most support as projects since they have been developed by people who know the project and what it needs the most. '''However''', if you have your own idea for a project discuss your awesome idea with us in our [http://www.limesurvey.org/component/option,com_fireboard/Itemid,105/func,view/catid,11/id,24710/lang,en/ forums], [https://lists.sourceforge.net/lists/listinfo/limesurvey-developers mailing list] or at #limesurvey on irc.freenode.net. Then submit '''your''' proposal. Good Luck (:biggrin:)<br />
<br />
=Project ideas=<br />
<br />
==Example Format...==<br />
<br />
Describe the idea here in general terms<br />
<br />
'''Skills'''<br />
<br />
Explain what sort of coding skills would be needed for a student to implement this project<br />
<br />
'''Difficulty'''<br />
<br />
Explain the level of difficulty involved<br />
<br />
'''Probable Mentors'''<br />
<br />
Put your name (and tag) here if you are willing to mentor a student for this idea<br />
<br />
==LimeSurvey 1: File Upload question type==<br />
<br />
The idea is to have a question type in LimeSurvey1 where survey participants can upload one (or more) files. Often in surveys the participant is asked to create some content (pictures, movies, documents, etc.)  to upload as an answer to a question. The following goals are  primary in this task:<br />
*Easy handling for the participant (uploading one or more files should be a piece of cake - also removing files if accidentally the wrong file was uploaded)<br />
*Extensive configuration options for the question type like<br />
**How many files are required, minimum and maxim number of files,<br />
**maximum/minimum upload size,<br />
**Allowed file types<br />
*Safe!! storage in the file system, checks for file contents<br />
*Implementation in statistics / data entry / printable survey / response browsing / response editing & RemoteControl<br />
*Administrator can download one or more files (zip-packaging files for download) from one response and across responses<br />
*Provide possible hooks for third party processing tools<br />
<br />
'''Skills'''<br />
<br />
PHP, jQuery, AJAX - existing knowledge on the general idea and related security would be of big advantage<br />
<br />
'''Difficulty'''<br />
<br />
Medium<br />
<br />
'''Probable Mentors'''<br />
<br />
c_schmitz (Carsten Schmitz)<br />
<br />
==LimeSurvey 1: Authentication framework==<br />
<br />
The idea is to design and implement a generic authentication framework for LimeSurvey 1 as well as some authentication modules. The Authentication framework will make it possible to implement any kind of authentication backend apart from the already existing internal-DB and Web server delegation schemes. Currently authentication is only used for the survey-administration GUI and not the participants interface (tokens are used for this). With the new authentication framework it will be possible to define several authentication backends and use some of them for participants-authentication.<br />
<br />
The generic authentication framework must define the following services:<br />
* User authentication: this interface must return the identity of the authenticated user if authentication is successful.<br />
** Authentication may not always be based on a simple user/password form, so the proposed framework must be generic enough to enable authentication based on other schemes (using any numbers or GET/POST parameters or any other contextual parameter such as Referrer, session variable...<br />
* User provisionning:<br />
** when activated on the survey administration interface, an authentication module might be able to create a newly authenticated user into the LimeSurvey internal DB (which is required for setting the user rights on the platform). The newly created user can be assigned a default profile or a per-user profile (queried from an external database).<br />
** when activated on the participants interface, the authentication module will provision the token table of the correspoding survey (only if the token for this user has not been already added).<br />
<br />
The already existing authentication schemes will be ported to the new framework (internal-DB and Web server authentication delegation) and at least a new one will be implemented (openID, CAS, Shibboleth).<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, Authentication protocols (openID, CAS, LDAP-bind, ...)<br />
<br />
'''Difficulty'''<br />
<br />
Medium<br />
<br />
'''Probable Mentors'''<br />
<br />
lemeur (Thibault Le Meur)<br />
<br />
==LimeSurvey 2: Db Storage Engine==<br />
<br />
Develop an extensible plugin survey storage engine for LimeSurvey 2.<br />
<br />
<u>Description</u><br />
<br />
Other than survey design, everything that happens in LimeSurvey centres around the ability to save responses to questions to a database, and retrieve the responses again when required. Historically these functions have been incorporated within the various functions of LimeSurvey and this has locked LimeSurvey to a single methodology for data storage and retrieval and made future modifications and improvements difficult if not possible.<br />
<br />
For this project we are looking for students to write a 'middleware' that exposes abstract high-level functions to LimeSurvey 2 (e.g.: storing these answers related to this question, running statistical analysis etc.) but is built in top of Cake's 'low-level' operations (such as find, save etc). The aim is to abstract away from a specific DB implementation and provide an intuitive and rich API for LS2.<br />
<br />
<u>Rationale</u><br />
<br />
Because the interface with the data storage system is so critical to practically every other function in LimeSurvey we want to develop a stand-alone module that is transportable and extensible for the future. And by keeping the logic of data and survey storage separate from the rest of LimeSurvey&rsquo;s functions we will the ease with which LimeSurvey can be developed in the long term.<br />
<br />
<u>Implementation</u><br />
<br />
This is such an important project that we would consider multiple students undertaking the task. In conjunction with a strong understanding of data structures, php coding and api principles the students would also have to display a capacity to work in a team and with the broader community.<br />
<br />
The implementation would focus on becoming a plugin/addon module under CakePHP which uses the default CakePHP database systems to the absolute minimum. In a well implemented version of this proposal only simple SQL inserts, queries and updates would be required. All other logic would be managed by the engine.<br />
<br />
<u>Requirements & Considerations</u><br />
<br />
The DB Engine must be able to do the following<br />
* ease development of additional '''question types, which will be developed as plugins'''<br />
* '''efficient data retrieval''', especially summaries (e.g. display 100 last responses)<br />
* support '''generic''' data storage and retrieval - aside surveys, imagine running online admission tests, polls, sign-up forms, volunteer campaign etc. etc.<br />
* easily support conditions, looped question, or generally, '''non-linear data'''. Think of a survey that asks how many children you have and then asks information about each of them.<br />
* support questions that have multiple '''answers and multiple types of answers'''. Think of a question asking "What is your favourite ice cream?", offering 3 fixed options and last one allowing user to enter a custom answer.<br />
* support survey resuming (where applicable)<br />
<br />
<u>Field Naming and Database Extensibility Methodologies</u><br />
<br />
An ongoing debate in the LimeSurvey community has been the method in which the database stores survey results. In LimeSurvey 1 a flat database schema was used whereby once the survey designer had finished setting up the survey a database table was created with a field for every individual question/answer combination. The advantages of this database schema were speed of retrieval for reporting and exporting and searching. The disadvantages were that the survey system had to &lsquo;freeze&rsquo; the structure in place once the table was created (therefore the activate/de-activate rules in LimeSurvey 1). The single table method doesn&rsquo;t allow easy storage of metadata for individual question/answer combinations (such as timestamps). Nor does it lend itself to surveys with enormous quantities of question/answer combinations &ndash; sometimes running up against database limitations regarding the number of fields per table.<br />
<br />
An alternative is a &lsquo;normalised&rsquo; database topology where a single table is created to store all survey responses &ndash; one database row per question/answer combination. A related table would store metadata that is directly related to the survey sitting/session rather than the answer (e.g.: username, ip address, geographical location, user demographic). The advantage to this methodology is the increased flexibility (extensible) which would allow modification of surveys at any stage even after data has been collected (see requirements). The disadvantages are that searching and compilation of data is complicated and resource intensive.<br />
<br />
In a perfect world LimeSurvey would allow users to choose either methodology &ndash; either at an installation level or even on a per-survey level.<br />
<br />
Having a database storage engine effectively acting as an API would allow this functionality to be built, but the choice of database topology would be invisible to the related LimeSurvey functions that require data.<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, Database Schema Design, Sound knowledge of Algorithms and Data Structures<br />
<br />
'''Difficulty'''<br />
<br />
High<br />
<br />
'''Probable Mentors'''<br />
<br />
jasebo (Jason Cleeland)<br />
<br />
macduy (Mac Duy Hai)<br />
<br />
==LimeSurvey 2: Template Editor==<br />
<br />
Limesurvey 2 needs a nice and powerful template editor so everyone can create a template which matches their requirements.<br />
<br />
'''Skills'''<br />
<br />
One needs to know about the details of the [http://dwoo.org/ dwoo template engine] which is used at LS2. There is some cakePHP coding needed to create an interface and write changes to the template files as well as some HTML/CSS to create a nice interface.<br />
<br />
'''Difficulty'''<br />
<br />
You don't have to create difficult algorithms for this task. It's useful if you have worked with templates for another web-application or take a detailled look at [http://docs.limesurvey.org/tiki-index.php?page=Themes%3A+Templates+and+Styles&structure;=English+Instructions+for+LimeSurvey how templates work in Limesurvey]. Some design/usability background would be nice but is not a must.<br />
<br />
'''Probable Mentors'''<br />
<br />
Mazi<br />
<br />
==LimeSurvey 2: Mini-projects==<br />
<br />
Mini-projects is a collection of small-to-medium sized projects, which you mix-and-match according to your tastes. Heck, you can even roll your own idea and once reviewed and approved, you can code away. Some recommended/important mini-projects and their brief descriptions:<br />
*'''Smarter installer:''' LS2.0 comes with its own installer, though it may not be the friendliest to use. Your task is to make it juicier to use:<br />
** Resume installation - if the user aborts the installation mid-way, make it easy for him to resume it<br />
** Better error handling - meaningful error reports, suggestions how to fix them: e.g. "Database does not exist" is better than "Database error"<br />
** Customization - invite the user to customize his installation of LimeSurvey - from security settings such as salt, to interface such as the header title.<br />
*'''User management:''' When the number of users grow, it becomes increasingly harder to manage them. Implement functionality and provide interface for features that would make this task easier. Inspire yourself by the big players, such as the infamous you-know-which-one social website.<br />
**'''Groups within groups:''' LS2 users can belong to a group, but groups cannot belong to other groups.<br />
**'''Contact lists:''' There is already something called AssignmentGroups. Study this concept carefully and generalize to a Contact List<br />
**'''GUI:''' Design a GUI which allows you easily manage users, groups and contact lists.<br />
**'''Searching:''' Provide an efficient but simple-to-use search interface and functionality<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, JavaScript & jQuery<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
'''Probable Mentors'''<br />
<br />
Mac Duy Hai (macduy)<br />
<br />
==LimeSurvey 2: Template/Theme Editor==<br />
<br />
The idea is to develop a theme / template framework similar to one in jquery [http://jqueryui.com/themeroller/ | Jquery Theme Roller] and thus making the UI design of the surveys easier.The current template editor is based on dwoo template engine which actually loads the files exposing the css etc for us to edit, which of course require some skill set to proceed. Using this template editor we can make everything UI based and thus requiring no developer skills to edit the templates.<br />
<br />
The overview of the modules can be seen here:<br />
<br />
[[File:theme_roller.png]]<br />
<br />
It&rsquo;ll be implemented using Jquery to use the more advanced UI experiences.(:biggrin:)<br />
<br />
The following mock-up will give us a better view:<br />
<br />
Moderate[[File:theme_editor_small.png]]<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, CSS, AJAX, JavaScript & jQuery.<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
==LimeSurvey 2: Lime Survey Social - Facebook Application==<br />
<br />
The idea aims at developing a Facebook app which gives a social touch to LS 2.0. The application will be integrated in several Facebook integration points like News Feed, Applications boxes, Wall etc so that the user participation will be more. Adding a social touch can drive us more user participation and increase the popularity. The ability to control the Facebook app can be provided in the LS2.0 Admin Dashboard and also in the FB user application window with varied options.<br />
<br />
The facebook has the following modules (we can add more. This is primary draft.)<br />
*All Survey related core features. (Create, Edit, Delete, Administer etc)<br />
*Gain reward points.<br />
*Use reward points to create more surveys.<br />
*Spread the surveys ...... and more<br />
<br />
The idea can be extended to other social networks<br />
<br />
[[File:fb_overview.png]]<br />
<br />
The mock-ups :<br />
<br />
[[File:facebook app.png]]<br />
<br />
[[File:canvas.png]]<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, Facebook API.<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
==LimeSurvey 2: Integration of Poll Questions==<br />
<br />
Polls are one of the most popular and quick response getting tools once can use. Implementing polls in LS 2.0 will be an added advantage. Since every one of us know what polls are about, this idea focuses on the implementation part.<br />
<br />
The idea is to integrate the ability to create a POLL Module in Admin dashboard, where he can administer (Create | Edit | Delete | View Responses etc) the Polls.We can even get feedback &ldquo;about the survey&rdquo; at the end on how the user feels by creating a custom poll (we can even redirect the user to this poll).<br />
*Chat Bots and Polls: An another idea is to create chat bots so that whenever we create a poll, all the friends (who added the bot) of that bot will be pinged by the question followed by options. Getting an answer is very easy (Bot friends just need to type a single letter stating the answer) and its a push model which ensures the delivery to everyone (even offline).We can even extend this to deliver certain type of surveys question by question through the bot.<br />
<br />
A simple mock-up for this:<br />
<br />
[[File:chat.png]]<br />
*Alternate Solution: An alternate solution provided by Mazi is clubbing this idea with the Facebook app idea. Instead of porting parts of the admin backend to facebook or other social networks we'll have options in Admin panel to "publish as: common survey |mobile device survey | facebook poll | homepage poll | Â ... etc " Everything will be put together at the usualm admin backend but you can choose which way(s) you want publish your survey.<br />
<br />
We can further extend this idea by giving additional options to publish as widgets for websites and blogs etc.<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, XMPP Protocol (Knowledge of developing bots), Knowledge of Polls.<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
==LimeSurvey 2: Survey Community Project==<br />
<br />
Build a system for LS2 that connects to a central repository of survey resources, such as demographic questions, answer styles and templates. Integrating with a login system, allow LimeSurvey users to easily publish their work to a community resource or use other published works from the same location.<br />
<br />
For many finding already written question texts, or standardised demographic questions would really simplify their use of a survey tool. LimeSurvey could leverage on the community spirit of an open source product and encourage users to share their own work. By integrating a "Publish to the LimeSurvey Library" button in the administration system with questions, or templates, or anything else that can be shared, LimeSurvey could develop a library of tools that simplifies Survey Creation even further.<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, Web and User Interface Design Skills<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
'''Probable Mentors'''<br />
<br />
Jason Cleeland (jasebo)<br />
<br />
==LimeSurvey 2: Condition Engine==<br />
<br />
[[File:addNewCondition1.png]]<br />
<br />
Build a system for LS2 that will let survey administrators design, store and evaluate conditions. Conditions can be used in several features such as question branching (survey logic), assessments, quotas, ...<br />
<br />
This projects will at least end up with:<br />
* A working GUI to design complex conditions:<br />
** several atomic conditions can be combined by AND or OR logical operators and will support for grouping conditions with parentheses<br />
** an atomic condition representation can be<br />
<br />
<syntaxhighlight lang="php" enclose="div"><left operand> <operator> <right operand></syntaxhighlight><br />
** an atomic condition editor will implement<br />
*** several operators (equality, inequality, string-comparisons, numerical-comparisons, regexp),...<br />
*** meta operators surch as 'Not displayed'<br />
** left and right operands can be answers from previous questions, or a static values. It should be extensible so that we are able in the future to use more complex operand such as the result of a specific function (for instance the sum of some previous integer questions)<br />
* A working DB storage backend using a string in [http://en.wikipedia.org/wiki/Reverse_Polish_Notation RPN] (Reverse Polish Notation) to describe each condition<br />
* A first version of the evaluation of conditions for the question branching feature. This part will require interaction with other parts of the projects (Survey Engine, and DB engine).<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, JQuery and User Interface Design Skills<br />
<br />
'''Difficulty'''<br />
<br />
High<br />
<br />
'''Probable Mentors'''<br />
<br />
Thibault Le Meur (lemeur)<br />
<br />
=We want your ideas!=<br />
<br />
What floats your boat? Do you have another idea that gets you excited? Discuss your ideas in our [http://www.limesurvey.org/component/option,com_fireboard/Itemid,105/func,view/catid,11/id,24710/lang,en/ forums], [https://lists.sourceforge.net/lists/listinfo/limesurvey-developers mailing lists] or at #limesurvey on irc.freenode.net.<br />
<br />
=More Information=<br />
<br />
==LimeSurvey Google's Summer of Code 2010==<br />
*[http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2010 Limesurvey GSoC 2010]<br />
<br />
An introduction to LimeSurvey and our application for this years Google Summer of Code<br />
<br />
==Getting Started==<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started How to get started with LimeSurvey's GSoC 2009]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
==Frequently Asked Questions==<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google's Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=RemoteControl&diff=2923RemoteControl2010-03-20T03:54:00Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Introduction=<br />
<br />
LimeSurvey RemoteControl is a PHP:SOAP based Web service application.<br />
<br />
The LSRC makes it possible for developers to control specific functionality of Limesurvey from any other Application, without beeing restricted to PHP as a Programming language.<br />
<br />
You can start a predefined survey (change titles and things), add predefined groups or questions to this coresurvey. Activate the survey, restrict it to start and endtime, make it closed, add Participant data or just tokens when you need them (your customer just bought a book and now you want to invite him to a closed survey automatically), return the unused tokens to the main application, delete a survey, get a fieldmap for a survey, invite or remind the participants of your survey, etc...<br />
<br />
Be aware that this piece of code was originally written to bind LimeSurvey to a University management software in order to evaluate lectures. So there could be comments in the code or documentation, which have to do with my Company's Software or which are just a little bit confusing when you have nothing to do with University's or the German language.<br />
<br />
Post any comments, wishes or bugs to the [http://bugs.limesurvey.org bugtracker].<br />
<br />
==Files included in LSRC==<br />
* lsrc.config.php (configuration variables)<br />
* lsrc.server.php (the logical SOAP:Server brain. Programm logic is mainly in here )<br />
* lsrc.helper.php (class LsrcHelper, this Class does the work. Mainly copied and customized from Limesurvey files. Especially for import tasks)<br />
* lsrc_orig.wsdl (wsdl definition for SOAP messages. From this file the lsrc.wsdl is generated with correct paths)<br />
* lsrc.testclient.php (to test the environment and functionality of the webservice on the fly)<br />
<br />
== Directory included==<br />
* \surveys (for the core survey .csv's.) Used by sCreateSurvey.<br />
* \groups (for exported group .csv's . Used by sImportGroup. There should be always an empty group for importing, so you can add questions to a new group)<br />
* \questions (for exported questions .csv's. sImportFreetext and sImportMatrix depend on "Freitext.csv" and "Matrix5.csv" which should be exported questions(Freetext and Array 5 point Matrix).<br />
<br />
== Requirements==<br />
* PHP >= 5.2.1 with PHP:SOAP Extension enabled<br />
* libXML installed<br />
* MySQL, PostgreSQL or (not recommended) MSSQL<br />
* (optional) OpenSSL<br />
* (optional) a Certificate for better Security<br />
<br />
=Installation=<br />
<br />
== How to install LSRC==<br />
<br />
If you are using version 1.80 or higher, you do not need to install LSRC, it is included in the package and will be ready to set up - you will not need to install it.<br />
<br />
'''NOTE:''' It is included in Limesurvey since 1.80RC2, before 1.80RC4 it was called "japh" or "japhService"<br />
* create a Dir "remotecontrol" in your LimeSurvey admin dir.<br />
* copy the included files to the new directory.<br />
<br />
== How to configure LSRC==<br />
<br />
In a default LimeSurvey installation LSRC is disabled. In order to use LSRC you must first enable the service, and then adjust the settings to suit your needs.<br />
* To '''enable the LSRC in LimeSurveys config.php''' or in lsrc.config.php<br />
** set the variable '''$enableLsrc = true''';<br />
* In the '''lsrc.config.php''' file, you can '''set all needed Variables''' for the LSRC in Section Variables.<br />
** set the Error Handling. While configuring and testing it is very good to get all errors. If you are using lsrc in Production, you should comment error_reporting, so that it sticks to the servers defaults.<br />
** $lsrcDebug, if set to true, the lsrc writes it's own log. This log is particularly helpful when implementing new features. If some functions of LSRC don't work look for where it stops functioning in this log. Once you have finished setting up or developing new features you should turn the log off by setting this value to false.<br />
** $lsrcDebugLog, The name of the file where the log should be written.<br />
** ini_set("log_errors", "1"), Apaches log file (error.log) will get filed with php-errors. Very useful for debugging. Comment this line out (put two forward slashes at the beginning of the line "//") once you have finished setting up and have put your LSRC service into production.<br />
** ini_set("soap.wsdl_cache_enabled", "0"), while testing, caching is not useful. If in productive Mode, turn this on or just comment the line to stick to server defaults.<br />
** (optional) set $lsrcOverSSL to true, if you want SOAP to exchange the messages over SSL resp. https. '''Note:'''Turning this on simply changes the internal addressing to either "https:" or "http:" in order to work over a SSL connection, nothing more.<br />
** set the directories, where the .csv files to import can be found. You will have to export some survey, you want to import and activate with LSRC, first.<br />
** (optional) change $sLsrcSeparator = "your separator"; in lsrc.config.php if you wish to separate tokens for the sInsertToken function with any other separator than default, which is a comma.<br />
** (optional) change $sDatasetSeperator= "your separator"; in lsrc.config.php if you wish to separate Datasets for the sInsertParticipants function with any other separator than default, which are two colons.<br />
** (optional) change $sDatafieldSeperator= "your separator"; in lsrc.config.php if you wish to separate Datafields for the sInsertParticipants function with any other separator than default, which is a semicolon.<br />
* the script needs rights to write files to the folder "admin/remotecontrol/" Â (lsrc.log, if logging is used and lsrc.wsdl). if(you cannot or don't want to set the directory rights to 777){create those two files(lsrc.log and lsrc.wsdl)in the lsrc dir with the permission to write them(777))<br />
* If you want to save Survey, group or question csv's directly from Limesurvey into the lsrc Folders, you need to set them to 777, too. (Option can be enabled by adding $export4lsrc = true; to Limesurveys config.php)<br />
* You may have to generate a wsdl file if you need a static one. Run lsrc.server.php?wsdl and the script will make a lsrc.wsdl with the correct server url included in the lsrc directory.<br />
* If auto wsdl generation do not work properly (maybe virtual hosts make Problems, please report back, if so or not so, can't test at the moment) You have to set the url of the lsrc.server.php script in the last block of the wsdl<br />
<br />
==How to enable OpenSSL / https Support==<br />
* LSRC supports SSL over http resp. https.<br />
* Your Webserver needs to support and enable OpenSSL (See your Webserver Manual)<br />
* '''ATTENTION:''' Just set the Variable $lsrcOverSSL = true; in lsrc.config.php. After that, initialize your client like shown below, a wsdl file with correct URL will be generated automaticly for you:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
new SoapClient('https://localhost/limesurvey/admin/lsrc.server.php?wsdl',<br />
<br />
         array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
</syntaxhighlight><br />
* 'ONLY FOLLOW THIS STEPS IF WSDL GENERATION DOES NOT WORK FOR YOU' <br>There are two locations in the code, where you force the webservice to use https<br />
<br />
<nowiki>:</nowiki> 1. On the client side, when you call the SOAP-Server over wsdl. For 'https' do it like that:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
new SoapClient('https://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl', array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
</syntaxhighlight><br />
<br />
<nowiki>:</nowiki> for 'http' like that:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
new SoapClient('http://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl', array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
</syntaxhighlight><br />
<br />
<nowiki>:</nowiki> Note that the client will only get the wsdl-definition over https, to get the SOAP Messages over https, set the uri in the wsdl file, like below...<br />
<br />
<nowiki>:</nowiki> 2. Here is the most important Step to SSL. At the End of the lsrc.wsdl file, last block, same procedure:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
  <port name='LsrcPort' binding='tns:LsrcBinding'><br />
<br />
   <soap:address location='https://localhost/limesurvey/admin/remotecontrol/lsrc.server.php' /><br />
<br />
  </port><br />
<br />
</syntaxhighlight><br />
<br />
<nowiki>:</nowiki> or for normal http mode:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
  <port name='LsrcPort' binding='tns:LsrcBinding'><br />
<br />
   <soap:address location='http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php' /><br />
<br />
  </port><br />
<br />
</syntaxhighlight><br />
<br />
That's it! all request, response and fault messages will be transported over https...<br />
<br />
=How to use LSRC=<br />
<br />
==use the client==<br />
<br />
'''NOTE on PHP 5.3:''' setting the path2wsdl to http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl worked with all prior 5.3 version of PHP. With PHP 5.3 the client will not recognize the wsdl lsrc.server.php?wsdl gives back. You have to call lsrc.server.php?wsdl once to generate the lsrc.wsdl file and then point your client to http://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl instead.<br />
<br />
There is a PHPclient (from version 1.86) in the remotecontrol folder. You can use this ClientClass to control Limesurvey from within your PHP Applications with ease.<br />
<br />
Take a look at lsrc.testclient-new.php to get an impression of how it can be implemented.<br />
<br />
Basically you just have to include the class, prepare the Client and start the function calls.<br />
<br />
Example:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<?php<br />
<br />
/**<br />
* include the client class<br />
*/<br />
<br />
include_once("lsrc.client.php");<br />
<br />
/**<br />
* initiate the testclient object<br />
*/<br />
<br />
$testclient = new lsrcClient();<br />
<br />
/**<br />
* prepare the lsrcClient class (initiate the soapClient, set sid if needed)<br />
*/<br />
<br />
$testclient->prepare(333);<br />
<br />
/**<br />
* set user and password (only needed, when not set in the client class directly)<br />
*/<br />
<br />
$testclient->user = 'admin';<br />
<br />
$testclient->pass = 'password';<br />
<br />
/**<br />
* set the path2wsdl (only needed, when not set in the client class directly)<br />
*/<br />
<br />
$testclient->path2wsdl = 'http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl';<br />
<br />
/**<br />
* call the function to create a survey<br />
*/<br />
<br />
$sReturn = $testclient->createSurvey("surveyName" ,<br />
<br />
                  "surveyDescription",<br />
<br />
                  "welcomeText",<br />
<br />
                  "endText",<br />
<br />
                  "surveyAdmins@email.adress",<br />
<br />
                  "Survey Adminsname",<br />
<br />
                  "http://an.end.url",<br />
<br />
                  "Description of End Url",<br />
<br />
                  "template138");<br />
<br />
echo $sReturn;<br />
<br />
</syntaxhighlight><br />
<br />
This Skript initiates the client. The parameter at prepare, sets the surveyId. In this case it means we are going to create the survey with the Id 333. If you do not give an id, the survey will get a random id.<br />
<br />
Next we set the user and password to use. You do not have to do this, as long as the inital values of the client are correct. But you may have to, if you build your app in a way, that different users use the client to create Surveys or edit them.<br />
<br />
In the end, the survey is created with the createSurvey Method and the return is echoed.<br />
<br />
==using the functions==<br />
<br />
You will need a SOAP- or at least RPC-Client to communicate with the LSRC Webservice. How to create such a Client depends on the programming language you use.<br />
<br />
The LSRC itself is written in PHP5 using the PHP:SOAP extension with SOAP 1.1.<br />
<br />
In PHP you would initiate the Client-object and call a function from the Webservice with code like e.g.:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
$wsdl="http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl";<br />
<br />
$client = new SoapClient($wsdl, array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
try<br />
<br />
{<br />
<br />
  $sReturn = $client->sInsertToken($user, $pass, $iVid, $sToken);<br />
<br />
}<br />
<br />
catch (SoapFault $fault)<br />
<br />
{<br />
<br />
  $sOutput .= " <br/><br/>SOAP Error: ".$fault->faultcode." : ".$fault->faultstring;<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
The LSRC offers some functions:<br />
<br />
(<span style='color:#FF0000'>m</span>) means: Mandatory Parameter<br />
<br />
==sCreateSurvey==<br />
<br />
<span style='color:#FF0000'>Parameters changed after 1.81+! (sVend added)</span><br />
* String sCreateSurvey($sUser, $sPass, $iVid, $sVtit , $sVbes, $sVwel, $sVend, $sMail, $sName, $sUrl, $sUbes, $sVtyp )<br />
** '''Purpose''': Creates a new survey. It imports an exported survey from any LS v1.xx. and changes some fields (in the current Version it changes SurveyTitle, Â SurveyDescription and SurveyWelcomeText, adminemail, adminname, url and url_description to the string which was given by the client.)<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int $iVid, SurveyID desired ID for the Survey, make sure it doesn't already exist in LimeSurvey<br />
*** (<span style='color:#FF0000'>m</span>) string $sVtit, SurveyTitle, should be the (Nr +)Name of the Event to be evaluated<br />
*** (<span style='color:#FF0000'>m</span>) string $sVbes, Survey Description, This should be String put together with veransttyp + doztitle + dozname<br />
*** string $sVwel, Survey Welcometext, A text shown before the survey starts. If not given it says: "Herzlich Willkommen zur Evaluation von "$sVtit"<br />
*** string $sVend, Survey Endtext, Text shown at the endpage.<br />
*** string $sMail, Admin Email, Email Adress of the responsible person for this survey<br />
*** string $sName, Name of the responsible person for this survey<br />
*** string $sUrl, Url of the Link, shown on the last page of survey.<br />
*** string $sUbes, Description String of the URL above. ( <a href='$sUrl'>$sUbes</a> )<br />
*** string $sVtyp, The type of Event that should be evaluated. Use in combination with sAvailableModules with $mode='core' to get all available "types"<br />
** '''Returns''':<br />
*** if everything went fine, it returns the SurveyID from the created survey<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "SurveyID already exists");<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Server: ", "Import went wrong somehow");<br />
** '''Note''':<br />
*** Goto line 714 in lsrc.helper.php to see what can be done and customized while importing.<br />
*** If you want Limesurvey to give your Survey a random Number if the given ID exist (because you do not need a specific identification for your surveys), just go into the function sCreateSurvey in lsrc.server.php and delete or comment out the if($lsrcHelper->surveyExists($iVid)) clause. In Result, Limesurvey will give your survey a random ID when the given ID exists.<br />
<br />
==sActivateSurvey==<br />
* String '''sActivateSurvey'''(string USER, string PASSWORD, int SurveyID, date start, date end)<br />
** '''Purpose''': Activates an existing survey and set start and enddate optional<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID for the Survey to activate.<br />
*** date start, date for the Survey to start. 2008-10-22 means it starts exactly at 2008-10-22 00:00:00 Servertime<br />
*** date end, date for the Survey to end. 2008-10-22 means it ends exactly at 2008-10-22 23:59:59 Servertime. Nobody can access nor complete the Survey only a second later.<br />
** '''Returns''':<br />
*** if everything went fine, it returns the SurveyID from the activated survey<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "Survey you want to activate does not exists");<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Server: ", "Activation went wrong somehow");<br />
** '''Note''':<br />
*** You can set startDate and/or endDate after activation if needed. Just run the function again with desired parameters.<br />
<br />
==sImportGroup==<br />
* String '''sImportGroup'''(string USER, string PASSWORD, int SurveyID, String Module, String groupName, String groupDescription)<br />
** '''Purpose''': Imports an exported group file (.csv) to the Survey given by SurveyID<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** (<span style='color:#FF0000'>m</span>) string Module, the filename of the Group you want to add to the Survey. Use sAvailableModules to get the available groups.<br />
*** string groupName, the Title the Group gets. If not set, it will use the title given in the .csv.<br />
*** string groupDescription, Description of the group. If not set, it will use the description given in the .csv.<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "Import OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to change Surveys from other people");<br />
*** Â throw new SoapFault("Server: ", "Survey Module $sMod does not exist");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported groups as .csv which lay under \groups or any other dir given in lsrc.config.php<br />
*** <strike>It imports only the files beginning with "mod_" ending with ".csv"</strike><br />
*** The Param Module must only contain the "name of the Module": Only the String before ".csv"<br />
*** The baselanguage of the group to import, have to match the baselanguage of the coresurvey.<br />
<br />
==sImportQuestion==<br />
* String '''sImportQuestion'''(string USER, string PASSWORD, int SurveyID, String Module, String mandatory)<br />
** '''Purpose''': Imports an exported question file (.csv) to the last group of the Survey given by SurveyID. This is meant for predefined questions stored in the /question directory<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** (<span style='color:#FF0000'>m</span>) String Module, the name of the csv file you want to add to the Survey, without extension(.csv).<br />
*** String mandatory, default='N' set to 'Y' if you want that question mandatory<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to change Surveys from other people");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported questions as .csv which lay under \questions or any dir given in lsrc.config.php<br />
*** The baselanguage of the question to import, have to match the baselanguage of the core survey.<br />
<br />
==sImportFreetext==<br />
* String '''sImportFreetext'''(string USER, string PASSWORD, int SurveyID, String questionTitle, String questionText, String questionhelp, String module='freitext', string mandatory)<br />
** '''Purpose''': Imports an exported question file (.csv) to the last Group of the survey given by SurveyID and changes the Title, question and helptext. This is meant for importing empty question.csv's (Text Questions)<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** String questionTitle, Name or Categorie of the Question<br />
*** String questionText, The Question itself<br />
*** String questionhelp, A little Help text for better understanding of the Question<br />
*** String module, the name of the Module you want to add to the Survey. It should be "Freitext" by default.<br />
*** String mandatory, make the question mandatory by giving 'Y' as this param.<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to change Surveys from other people");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported questions as .csv which lay under \questions or any dir given in lsrc.config.php<br />
*** It is meant for importing one shortext, Longtext or Hugetext Question and changing the Question and Helptext.<br />
*** The baselanguage of the question to import, have to match the baselanguage of the core survey.<br />
*** Be sure to have at least one proper .csv (Freitext.csv) in the proper directory (questions), to use this function.<br />
*** Use sAvailableModules with mode='que' to get all question .csv's available.<br />
<br />
==sImportMatrix==<br />
* String '''sImportMatrix'''(string USER, string PASSWORD, int SurveyID, String Module, String questionText, String questionhelp, String questionItems)<br />
** '''Purpose''': Imports an exported question file (Matrix5.csv) to the Survey given by SurveyID and changes the question, helptext and gives Items to the 5 Scale Matrix. This is meant for importing one 5 Scale Matrix Question.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** string Module, the name of the Module you want to add to the Survey. It should be "Matrix" by default.<br />
*** String questionText, the question or text to the Matrix<br />
*** String questionhelp, the help text<br />
*** String questionItems, the Items that should be rated, separated by commas<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported groups as .csv which lay under docs\demosurveys\studiply_mod<br />
*** It is meant for importing a group with only one 5 Scale Matrix Question and changing the Question and Helptext and add Items.<br />
*** Be sure to use an user with the surveys baselanguage as default, because this language is used to fill the language fields for answers and questions while importing.<br />
<br />
==sAvailableModules==<br />
* String '''sAvailableModules'''(string USER, string PASSWORD, string mode)<br />
** '''Purpose''': Returning all the csv Names of the csv's in the Directorys configured in lsrc.config.php<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** String mode, (optional) "mod" for the available groups, "core" for the coreSurveys, "que" for addable questions. Default, when not given is "mod".<br />
** '''Returns''':<br />
*** if everything went fine, it returns a String with all surveys, groups or questions (depends on mode) in the Dir given in lsrc.config.php, separated by comma.<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
** '''Note''':<br />
<br />
==sSendEmail==<br />
* String sSendEmail($sUser, $sPass, $surveyID, $type, $maxLsrcEmails='', $subject='', $emailText='')<br />
** '''Purpose''': sends Emails to Participants of a particular survey<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int surveyID, Id of the survey from which participants will be mailed<br />
*** (<span style='color:#FF0000'>m</span>) string type, the kind of email you like to send (invite, remind or custom)<br />
*** int $maxLsrcEmails, if you want to override $maxemails setting in config.php for sending mails with lsrc: here you go.<br />
*** string subject, only needed if type==custom, the subject for the mail to be send.<br />
*** string emailText, only needed if type==custom, the text for the mail to be send.<br />
** '''Returns''':<br />
*** "X Mails send" or "No Mails to send" in custom mode.<br />
*** "X Mails send. X Mails left to send" or "No Mails to send" in invite mode.<br />
*** "X Reminders send. X Reminders left to send" or "No Reminders to send" in remind mode.<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Type: ", "Wrong send Type given. Possible types are: custom, invite or remind");<br />
** '''Note''':<br />
*** invite: When $maxemails is set the function sends only $maxemails in one go. If you call it again, it will go on to send the invitations, until everyone is invited.<br />
*** remind: When $maxemails is set, it will only send $maxemails in one go. It checks if reminders have been send to other participants and if there are participants who received less reminders than others, the script will first send reminders to those who have not been reminded so often, until the remindercount is equal.<br />
*** custom: $maxemails have no effect in custom mode. I have no solution for counting those who have been mailed before.<br />
<br />
==sInsertToken==<br />
* String '''sInsertToken'''(string USER, string PASSWORD, int SurveyID, string Token)<br />
** '''Purpose''': Creates and populates a table {dbprefix}token_{SurveyID} and thus "closes" the survey. It is possible to add tokens to the existing table.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, ID of the survey to close with a token table<br />
*** string Token, a string with comma separated tokens. There is a possibility to set any other separator in config.php. Max. tested length of a string was 500,000 tokens, that makes a String of 5,500,000 Chars, Â this is just the limit of the apache webserver on my notebook (CoreDuo 1,6MHz, 1GB Ram) with default Resource Limits (60,60,16). I recommend to send max. 100,000 tokens over the webservice. Repeat for more tokens.<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** if everything went ok, it returns the String: "[X] Token given, [X] Token inserted"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Server: ", "Token could not be inserted");<br />
** '''Note''':<br />
*** Make sure on the client side that no token appears twice in the table. There is no check on this and won't be in the future. What happens if there are two same tokens? 2 participants will get the same token, one will fill out the form for both, and the other will get a message: "your token have already participated"<br />
*** If there is no token table, it will create one and add the tokens.<br />
*** If the Tokentable already exists, it just adds the given tokens to the existing table.<br />
<br />
==sInsertParticipants==<br />
* String '''sInsertParticipants'''(string USER, string PASSWORD, int SurveyID, string ParticipantData)<br />
** '''Purpose''': Creates and populates a table {dbprefix}token_{SurveyID} and thus "closes" the survey. You can deliver some data to the token table. If you do not support a token, or an empty String as token, a unique token will be generated for the participant.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, ID of the survey to close with a token table<br />
*** string ParticipantData, The Data have to be in the right Syntax, it's like this:<br />
<br />
<pre><br />
<br />
FIRSTNAME;LASTNAME;EMAIL;ATTRIB1;ATTRIB2;TOKEN::FIRSTNAME;LASTNAME;EMAIL;ATTRIB1;ATTRIB2;TOKEN<br />
<br />
</pre><br />
<br />
'''NOTE: The Data Syntax change with 1.86'''. in order to take language, validfrom, validuntil and a variable count of attributes.<br />
<br />
With 1.86 and later versions, it will have to be like this:<br />
<br />
<pre><br />
<br />
FIRSTNAME;LASTNAME;EMAIL;LANGUAGE;TOKEN;VALIDFROM;VALIDUNTIL;attribute1,attribute2,attribute3::FIRSTNAME ... etc.<br />
<br />
</pre><br />
<br />
note that the 8th field is the attributes field. There is no 9th field. You can seperate many attributes with a colon (,). The lsrc will create the needed fields in the db if they are not present. All Fields after LANGUAGE are optional and do not have to be send.<br />
<br />
seperate the Datasets with double colons (::) and the fields with semicolon (;). The '''attrib1, attrib2 and token fields are optional''', you can just leave them out if not used. Note that the attrib field will get empty and not NULL, by now there where no complications, inform us, if you see some difficulties in not setting them NULL. Max. successfully tested length of a string was 3,000,000 Chars, this is just the limit of the apache webserver on my notebook (CoreDuo 1,6MHz, 1GB Ram) with default Resource Limits (60,60,16). I recommend to send max. 10,000 Datasets over the webservice at once(~1,000,000 chars). Repeat for more Datasets.<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** if everything went ok, it returns the String: "[X] Datasets given, [X] rows inserted. ";<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Server: ", "No SurveyId given");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
** '''Note''':<br />
*** default tokenlength is 5 chars, if you want to change the length, goto lsrc.server.php, line 441<br />
*** If the token table does not exists, it will be created, and if it does, the data will be added.<br />
<br />
==sTokenReturn==<br />
* string return '''sTokenReturn'''(string USER, string PASSWORD, int SurveyID)<br />
** '''Purpose''': Gives back all Tokens, which did not complete the Survey, in a String seperated by commas.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the ID for the Survey from which you want get the unused tokens<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** Returns a String, a string of all unused tokens seperated by comma.<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Server: ", "No SurveyId given");<br />
*** Â throw new SoapFault("Database: ", "Token table for this Survey does not exists");<br />
*** Â throw new SoapFault("Database: ", "No unused Tokens found");<br />
<br />
==sGetFieldmap==<br />
* string return '''sGetFieldmap'''(string USER, string PASSWORD, int SurveyID)<br />
** '''Purpose''': Gives back the fieldmap for the survey<br />
<br />
for example:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
"fieldname","type","sid","gid","qid","aid","title","question","group_name","lid","lid1"<br />
<br />
"111X779X39801","F","111","779","3980","1","1","How do you feel?","Paticipant feelings","",""<br />
<br />
"111X779X39802","M","111","779","3980","2","1a","Why do you feel like this?","Paticipant feelings","",""<br />
<br />
[...]<br />
<br />
</syntaxhighlight><br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the ID for the Survey from which you want to get the Fieldmap.<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** Returns a String, a string of the fieldmap, seperated by comma and blanks<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to get fieldmaps from other peoples Surveys");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Server: ", "No SurveyId given");<br />
<br />
==fSendStatistic==<br />
<br />
<span style='color:#FF0000'>''(since 1.86)''</span><br />
* '''fSendStatistic'''(string USER, string PASSWORD, int SurveyID, string Email, string doctype, string graph)<br />
** '''Purpose''': sends an Statistic File as Attachment<br />
** '''Parameters'''<br />
*** user: Limesurvey user<br />
*** password: Limesurvey Password<br />
*** surveyId: ID of the survey from which statistics should be generated<br />
*** email: the adress to which the statistic file is send<br />
*** doctype: pdf, xls or html. With pdf or xls, the recipient gets an attached file with a short notice. With html, he gets an html e-mail without attachments<br />
*** graph: turn graph generation on or off. Works only with pdf generation. Use '1' as a string if you want to enable it<br />
** '''returns'''<br />
*** string: 'XLS send'<br />
*** string: 'PDF send'<br />
*** string: 'HTML send'<br />
** '''possible Faults'''<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to send statistics from other peoples Surveys");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Mail System", "Mail could not be send! Check your E-Mail Settings.");<br />
<br />
=Testing=<br />
<br />
For testing purposes, we made a testclient in php. Therefore you need a webserver to run it. If you test on one machine you need nothing to do, you can go to http://localhost/limesurvey/admin/lsrc/lsrc.testclient.php in your browser to test the webservices functionality.<br />
<br />
Of Course this is very boring, because the apache talks with himself (and thats not the matter of a webservice).<br />
<br />
The Testclient have two purposes:<br />
<br />
1. It checks the Server(the one the testclient is running on!) for the PHP:SOAP Extension and installed libXML version and gives feedback if the enviroment does support SOAP via PHP:SOAP. This is very useful to check your Server and your Client towards PHP:SOAP compatibility. In addition to this, it will check if the wsdl file you want to connect to exists, it does not validate the wsdl file.<br />
<br />
2. You can test the functions of the webservice.<br />
<br />
If you test the webservice in realistic enviroment (two machines) you have to customize three things<br />
* the lsrc.testclient.php needs to be on the machine where the webservice is NOT running, but it needs a webserver... download xampp from apachefriends if you dont have one <strike>(caution for Linux Users: you have to compile PHP5 with SOAP and enable the extension, futhermore you have to install libXML2. Last thing can by done very easy via Synaptics or apt-get)</strike> xampp for Linux works well with SOAP and libXML from version 1.7.<br />
* this Line:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
$limeUrl='https://localhost/limesource/limesurvey';<br />
<br />
</syntaxhighlight><br />
<br />
At the beginning of lsrc.testclient.php needs to fit the target Limesurvey Installation Dir. localhost for servername is always wrong in this testcase, 127.0.0.1, too.<br />
<br />
'''NOTES''':<br />
* The Testclient is configured to use "admin" "password" as authentication. If you want to test with another user or password you have to set this vars in lsrc.testclient.php ( lines 40 and 41)<br />
* If you just get a blank page on the testclient, make sure the path to the wsdl is correct, and the var $enableLsrc is set to true in config.php or lsrc.config.php<br />
<br />
=Notes=<br />
* Security is enhanced: no action without permission (as good as Limesurveys Security itself --> very good)<br />
* No headers or "Quick and Dirtys" anymore, no Scripts, just functions and a class.<br />
* All configuration Variables are stored in lsrc.config.php by now<br />
* There is a debug functionality, showing where the script runs through the code in an own log file. Use Apaches error.log in addition to find errors if you got any.<br />
* LSRC is part of LimeSurvey, therefore it stands under GNU/GPL License v2 or later.<br />
* SOAP Services and therefore LSRC only support UTF-8 charsets.<br />
* LSRC works with AdoDB (MySql,Postgresql, MSSQL) .<br />
* LSRC is tested, but under steady development, use on your own risk, test the functions before using them productively!<br />
<br />
=Changes=<br />
<br />
1.86<br />
* new function fSendStatistics: to send statistics as attachment to an e-mail-address<br />
* Datasyntax for sInsertParticipants changed in order to take validfrom, validuntil, language and a variable Set of attributes.<br />
<br />
1.85<br />
* Several improvements to stability.<br />
<br />
1.82<br />
* Added sVend Parameter to sCreateSurvey, to set the endtext<br />
* sInsertParticipants takes a token in the dataset, however, if non is supported, it will be generated.<br />
* a new variable $enableLsrc is introduced to enable the Lsrc only when it is used.<br />
* a serious exploit has been fixed.<br />
<br />
1.81<br />
* Added sGetFieldmap function.<br />
* The template.csv's changed.<br />
* exported csv's prior 1.81 will not import over lsrc anymore. Import them via Browser and export them back to lsrc.<br />
<br />
1.80 => 1.81<br />
* Changed sImportGroup: imports '''all''' groups under $modDir, adds them to the survey. Not only the ones with mod_ as prefix. In addition, you can give Name and Description of the Group.<br />
* New sImportQuestion: imports questions in $queDir and adds them to the last group<br />
* New sImportFreetext: imports a Freetext question and changes the title and question to the Strings given. Previously, this function was called sImportQuestion.<br />
* Changed sAvailableModules: type can be core, mod or que. "que" is new and gives back the names of all the questions available.<br />
* New sSendEmail: send invitations, reminders and custom mails to participants of a survey over Limesurvey.<br />
<br />
=ToDo / ToCome=<br />
* <strike>sInsertParticipants should take a lang attribute for each participant</strike><br />
<br />
please add your feature requests to the [http://bugs.limesurvey.org bugtracker] if it is not listed here...<br />
<br />
=Known Bugs (and workarounds)=<br />
* With PHP 5.3.0, the testclient have problems to read the generated wsdl from lsrc.server.php?wsdl. You have to generate it an use the static file to test it.<br />
* Surveys get not imported in 1.85, due to a bug. The bug is fixed and will be released with the next release. Talk to rakete if you need it earlier...<br />
* exported csv's prior 1.81 will not import over lsrc anymore. Import them via Browser and export them back to lsrc to get them work again. (attributes moved from survey to survey_languagesettings)<br />
* sInsertPaticipants and sInsertToken function: You should note, that in case of an Seperator at the beginning or the end of the Datastring, the return Message will recognize one more given Dataset or Token as inserted into the db...<br />
* There is a bug with Webservices in general: Sometimes (~ 1 of 10.000 Cases) you will get an error message like "function 'anyFunction' does not exist on the server" or similar, altough everything is fine. Just wait a few Moments, clear you cache, phone your mom (she will be happy to hear from you ;)) and try again.<br />
* Webservice will not work if the "install" dir is not renamed or deleted in limesurvey and $debug is not set to 2 -> "looks like we got no xml document" without errorlogs<br />
<br />
please add your bug report to the [http://bugs.limesurvey.org bugtracker] if you found an Issue that is not listed here.<br />
<br />
=Security=<br />
<br />
There have been a security hole in the versions prior 1.82 (1.80RC2 to 1.81+). This leak could be used to compromise your webspace if it is weakly configured.<br />
<br />
To minimise the risk of a security leak endanger your system, we disabled the lsrc by default with version 1.82 and you have to enable it explicity in your config.php.<br />
<br />
Some things you can do to improve your security when using the lsrc:<br />
* instead of setting the remotecontrol folder to 777, just create an empty file lsrc.wsdl with the rights 777<br />
* disable the lsrc.log in lsrc.config.php<br />
* Do not set the survey, groups, questions folders to 777 for saving lsrc templates directly within Limesurvey, instead, save the .csv on your local PC and upload them via ftp to the folders.<br />
* delete lsrc.testclient.php, when in productive use. Lsrc.testclient.php could be used from unauthorized people to perform portscanning on other machines. The attacked webserver would be seeing your webserver as attacker, altough you did not perform any attack by yourself. This is not so serious, as this bahaviour of the testclient is not much valuable for any serious hacker.</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=RemoteControl&diff=2924RemoteControl2010-03-20T03:48:49Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Introduction=<br />
<br />
LimeSurvey RemoteControl is a PHP:SOAP based Web service application.<br />
<br />
The LSRC makes it possible for developers to control specific functionality of Limesurvey from any other Application, without beeing restricted to PHP as a Programming language.<br />
<br />
You can start a predefined survey (change titles and things), add predefined groups or questions to this coresurvey. Activate the survey, restrict it to start and endtime, make it closed, add Participant data or just tokens when you need them (your customer just bought a book and now you want to invite him to a closed survey automatically), return the unused tokens to the main application, delete a survey, get a fieldmap for a survey, invite or remind the participants of your survey, etc...<br />
<br />
Be aware that this piece of code was originally written to bind LimeSurvey to a University management software in order to evaluate lectures. So there could be comments in the code or documentation, which have to do with my Company's Software or which are just a little bit confusing when you have nothing to do with University's or the German language.<br />
<br />
Post any comments, wishes or bugs to the [http://bugs.limesurvey.org bugtracker].<br />
<br />
==Files included in LSRC==<br />
* lsrc.config.php (configuration variables)<br />
* lsrc.server.php (the logical SOAP:Server brain. Programm logic is mainly in here )<br />
* lsrc.helper.php (class LsrcHelper, this Class does the work. Mainly copied and customized from Limesurvey files. Especially for import tasks)<br />
* lsrc_orig.wsdl (wsdl definition for SOAP messages. From this file the lsrc.wsdl is generated with correct paths)<br />
* lsrc.testclient.php (to test the environment and functionality of the webservice on the fly)<br />
<br />
== Directory included==<br />
* \surveys (for the core survey .csv's.) Used by sCreateSurvey.<br />
* \groups (for exported group .csv's . Used by sImportGroup. There should be always an empty group for importing, so you can add questions to a new group)<br />
* \questions (for exported questions .csv's. sImportFreetext and sImportMatrix depend on "Freitext.csv" and "Matrix5.csv" which should be exported questions(Freetext and Array 5 point Matrix).<br />
<br />
== Requirements==<br />
* PHP >= 5.2.1 with PHP:SOAP Extension enabled<br />
* libXML installed<br />
* MySQL, PostgreSQL or (not recommended) MSSQL<br />
* (optional) OpenSSL<br />
* (optional) a Certificate for better Security<br />
<br />
=Installation=<br />
<br />
== How to install LSRC==<br />
<br />
If you are using version 1.80 or higher, you do not need to install LSRC, it is included in the package and will be ready to set up - you will not need to install it.<br />
<br />
'''NOTE:''' It is included in Limesurvey since 1.80RC2, before 1.80RC4 it was called "japh" or "japhService"<br />
* create a Dir "remotecontrol" in your LimeSurvey admin dir.<br />
* copy the included files to the new directory.<br />
<br />
== How to configure LSRC==<br />
<br />
In a default LimeSurvey installation LSRC is disabled. In order to use LSRC you must first enable the service, and then adjust the settings to suit your needs.<br />
* To '''enable the LSRC in LimeSurveys config.php''' or in lsrc.config.php<br />
** set the variable '''$enableLsrc = true''';<br />
* In the '''lsrc.config.php''' file, you can '''set all needed Variables''' for the LSRC in Section Variables.<br />
** set the Error Handling. While configuring and testing it is very good to get all errors. If you are using lsrc in Production, you should comment error_reporting, so that it sticks to the servers defaults.<br />
** $lsrcDebug, if set to true, the lsrc writes an own log. This log is helpful when implementing new features, if some function does not work, look where it hangs in this log. Should be set to false if in productive Use.<br />
** $lsrcDebugLog, File where the log should be written to.<br />
** ini_set("log_errors", "1"), Apaches log file (error.log) will get filed with php-errors. Very useful for debugging. Comment if in productive Mode.<br />
** ini_set("soap.wsdl_cache_enabled", "0"), while testing, caching is not useful. If in productive Mode, turn this on or just comment the line to stick to server defaults.<br />
** (optional) set $lsrcOverSSL to true, if you want SOAP to exchange the messages over SSL resp. https. It does not more or less than generating the target address in the wsdl with http: or https:.<br />
** set the dirs, where the .csv files to import can be found. You will have to export some survey, you want to import and activate with LSRC, first.<br />
** (optional) change $sLsrcSeparator = "your separator"; in lsrc.config.php if you wish to separate tokens for the sInsertToken function with any other separator than default, which is a comma.<br />
** (optional) change $sDatasetSeperator= "your separator"; in lsrc.config.php if you wish to separate Datasets for the sInsertParticipants function with any other separator than default, which are two colons.<br />
** (optional) change $sDatafieldSeperator= "your separator"; in lsrc.config.php if you wish to separate Datafields for the sInsertParticipants function with any other separator than default, which is a semicolon.<br />
* the script needs rights to write files to the folder "admin/remotecontrol/" Â (lsrc.log, if logging is used and lsrc.wsdl). if(you cannot or don't want to set the directory rights to 777){create those two files(lsrc.log and lsrc.wsdl)in the lsrc dir with the permission to write them(777))<br />
* If you want to save Survey, group or question csv's directly from Limesurvey into the lsrc Folders, you need to set them to 777, too. (Option can be enabled by adding $export4lsrc = true; to Limesurveys config.php)<br />
* You may have to generate a wsdl file if you need a static one. Run lsrc.server.php?wsdl and the script will make a lsrc.wsdl with the correct server url included in the lsrc directory.<br />
* If auto wsdl generation do not work properly (maybe virtual hosts make Problems, please report back, if so or not so, can't test at the moment) You have to set the url of the lsrc.server.php script in the last block of the wsdl<br />
<br />
==How to enable OpenSSL / https Support==<br />
* LSRC supports SSL over http resp. https.<br />
* Your Webserver needs to support and enable OpenSSL (See your Webserver Manual)<br />
* '''ATTENTION:''' Just set the Variable $lsrcOverSSL = true; in lsrc.config.php. After that, initialize your client like shown below, a wsdl file with correct URL will be generated automaticly for you:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
new SoapClient('https://localhost/limesurvey/admin/lsrc.server.php?wsdl',<br />
<br />
         array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
</syntaxhighlight><br />
* 'ONLY FOLLOW THIS STEPS IF WSDL GENERATION DOES NOT WORK FOR YOU' <br>There are two locations in the code, where you force the webservice to use https<br />
<br />
<nowiki>:</nowiki> 1. On the client side, when you call the SOAP-Server over wsdl. For 'https' do it like that:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
new SoapClient('https://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl', array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
</syntaxhighlight><br />
<br />
<nowiki>:</nowiki> for 'http' like that:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
new SoapClient('http://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl', array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
</syntaxhighlight><br />
<br />
<nowiki>:</nowiki> Note that the client will only get the wsdl-definition over https, to get the SOAP Messages over https, set the uri in the wsdl file, like below...<br />
<br />
<nowiki>:</nowiki> 2. Here is the most important Step to SSL. At the End of the lsrc.wsdl file, last block, same procedure:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
  <port name='LsrcPort' binding='tns:LsrcBinding'><br />
<br />
   <soap:address location='https://localhost/limesurvey/admin/remotecontrol/lsrc.server.php' /><br />
<br />
  </port><br />
<br />
</syntaxhighlight><br />
<br />
<nowiki>:</nowiki> or for normal http mode:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
  <port name='LsrcPort' binding='tns:LsrcBinding'><br />
<br />
   <soap:address location='http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php' /><br />
<br />
  </port><br />
<br />
</syntaxhighlight><br />
<br />
That's it! all request, response and fault messages will be transported over https...<br />
<br />
=How to use LSRC=<br />
<br />
==use the client==<br />
<br />
'''NOTE on PHP 5.3:''' setting the path2wsdl to http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl worked with all prior 5.3 version of PHP. With PHP 5.3 the client will not recognize the wsdl lsrc.server.php?wsdl gives back. You have to call lsrc.server.php?wsdl once to generate the lsrc.wsdl file and then point your client to http://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl instead.<br />
<br />
There is a PHPclient (from version 1.86) in the remotecontrol folder. You can use this ClientClass to control Limesurvey from within your PHP Applications with ease.<br />
<br />
Take a look at lsrc.testclient-new.php to get an impression of how it can be implemented.<br />
<br />
Basically you just have to include the class, prepare the Client and start the function calls.<br />
<br />
Example:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<?php<br />
<br />
/**<br />
* include the client class<br />
*/<br />
<br />
include_once("lsrc.client.php");<br />
<br />
/**<br />
* initiate the testclient object<br />
*/<br />
<br />
$testclient = new lsrcClient();<br />
<br />
/**<br />
* prepare the lsrcClient class (initiate the soapClient, set sid if needed)<br />
*/<br />
<br />
$testclient->prepare(333);<br />
<br />
/**<br />
* set user and password (only needed, when not set in the client class directly)<br />
*/<br />
<br />
$testclient->user = 'admin';<br />
<br />
$testclient->pass = 'password';<br />
<br />
/**<br />
* set the path2wsdl (only needed, when not set in the client class directly)<br />
*/<br />
<br />
$testclient->path2wsdl = 'http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl';<br />
<br />
/**<br />
* call the function to create a survey<br />
*/<br />
<br />
$sReturn = $testclient->createSurvey("surveyName" ,<br />
<br />
                  "surveyDescription",<br />
<br />
                  "welcomeText",<br />
<br />
                  "endText",<br />
<br />
                  "surveyAdmins@email.adress",<br />
<br />
                  "Survey Adminsname",<br />
<br />
                  "http://an.end.url",<br />
<br />
                  "Description of End Url",<br />
<br />
                  "template138");<br />
<br />
echo $sReturn;<br />
<br />
</syntaxhighlight><br />
<br />
This Skript initiates the client. The parameter at prepare, sets the surveyId. In this case it means we are going to create the survey with the Id 333. If you do not give an id, the survey will get a random id.<br />
<br />
Next we set the user and password to use. You do not have to do this, as long as the inital values of the client are correct. But you may have to, if you build your app in a way, that different users use the client to create Surveys or edit them.<br />
<br />
In the end, the survey is created with the createSurvey Method and the return is echoed.<br />
<br />
==using the functions==<br />
<br />
You will need a SOAP- or at least RPC-Client to communicate with the LSRC Webservice. How to create such a Client depends on the programming language you use.<br />
<br />
The LSRC itself is written in PHP5 using the PHP:SOAP extension with SOAP 1.1.<br />
<br />
In PHP you would initiate the Client-object and call a function from the Webservice with code like e.g.:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
$wsdl="http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl";<br />
<br />
$client = new SoapClient($wsdl, array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
try<br />
<br />
{<br />
<br />
  $sReturn = $client->sInsertToken($user, $pass, $iVid, $sToken);<br />
<br />
}<br />
<br />
catch (SoapFault $fault)<br />
<br />
{<br />
<br />
  $sOutput .= " <br/><br/>SOAP Error: ".$fault->faultcode." : ".$fault->faultstring;<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
The LSRC offers some functions:<br />
<br />
(<span style='color:#FF0000'>m</span>) means: Mandatory Parameter<br />
<br />
==sCreateSurvey==<br />
<br />
<span style='color:#FF0000'>Parameters changed after 1.81+! (sVend added)</span><br />
* String sCreateSurvey($sUser, $sPass, $iVid, $sVtit , $sVbes, $sVwel, $sVend, $sMail, $sName, $sUrl, $sUbes, $sVtyp )<br />
** '''Purpose''': Creates a new survey. It imports an exported survey from any LS v1.xx. and changes some fields (in the current Version it changes SurveyTitle, Â SurveyDescription and SurveyWelcomeText, adminemail, adminname, url and url_description to the string which was given by the client.)<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int $iVid, SurveyID desired ID for the Survey, make sure it doesn't already exist in LimeSurvey<br />
*** (<span style='color:#FF0000'>m</span>) string $sVtit, SurveyTitle, should be the (Nr +)Name of the Event to be evaluated<br />
*** (<span style='color:#FF0000'>m</span>) string $sVbes, Survey Description, This should be String put together with veransttyp + doztitle + dozname<br />
*** string $sVwel, Survey Welcometext, A text shown before the survey starts. If not given it says: "Herzlich Willkommen zur Evaluation von "$sVtit"<br />
*** string $sVend, Survey Endtext, Text shown at the endpage.<br />
*** string $sMail, Admin Email, Email Adress of the responsible person for this survey<br />
*** string $sName, Name of the responsible person for this survey<br />
*** string $sUrl, Url of the Link, shown on the last page of survey.<br />
*** string $sUbes, Description String of the URL above. ( <a href='$sUrl'>$sUbes</a> )<br />
*** string $sVtyp, The type of Event that should be evaluated. Use in combination with sAvailableModules with $mode='core' to get all available "types"<br />
** '''Returns''':<br />
*** if everything went fine, it returns the SurveyID from the created survey<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "SurveyID already exists");<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Server: ", "Import went wrong somehow");<br />
** '''Note''':<br />
*** Goto line 714 in lsrc.helper.php to see what can be done and customized while importing.<br />
*** If you want Limesurvey to give your Survey a random Number if the given ID exist (because you do not need a specific identification for your surveys), just go into the function sCreateSurvey in lsrc.server.php and delete or comment out the if($lsrcHelper->surveyExists($iVid)) clause. In Result, Limesurvey will give your survey a random ID when the given ID exists.<br />
<br />
==sActivateSurvey==<br />
* String '''sActivateSurvey'''(string USER, string PASSWORD, int SurveyID, date start, date end)<br />
** '''Purpose''': Activates an existing survey and set start and enddate optional<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID for the Survey to activate.<br />
*** date start, date for the Survey to start. 2008-10-22 means it starts exactly at 2008-10-22 00:00:00 Servertime<br />
*** date end, date for the Survey to end. 2008-10-22 means it ends exactly at 2008-10-22 23:59:59 Servertime. Nobody can access nor complete the Survey only a second later.<br />
** '''Returns''':<br />
*** if everything went fine, it returns the SurveyID from the activated survey<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "Survey you want to activate does not exists");<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Server: ", "Activation went wrong somehow");<br />
** '''Note''':<br />
*** You can set startDate and/or endDate after activation if needed. Just run the function again with desired parameters.<br />
<br />
==sImportGroup==<br />
* String '''sImportGroup'''(string USER, string PASSWORD, int SurveyID, String Module, String groupName, String groupDescription)<br />
** '''Purpose''': Imports an exported group file (.csv) to the Survey given by SurveyID<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** (<span style='color:#FF0000'>m</span>) string Module, the filename of the Group you want to add to the Survey. Use sAvailableModules to get the available groups.<br />
*** string groupName, the Title the Group gets. If not set, it will use the title given in the .csv.<br />
*** string groupDescription, Description of the group. If not set, it will use the description given in the .csv.<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "Import OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to change Surveys from other people");<br />
*** Â throw new SoapFault("Server: ", "Survey Module $sMod does not exist");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported groups as .csv which lay under \groups or any other dir given in lsrc.config.php<br />
*** <strike>It imports only the files beginning with "mod_" ending with ".csv"</strike><br />
*** The Param Module must only contain the "name of the Module": Only the String before ".csv"<br />
*** The baselanguage of the group to import, have to match the baselanguage of the coresurvey.<br />
<br />
==sImportQuestion==<br />
* String '''sImportQuestion'''(string USER, string PASSWORD, int SurveyID, String Module, String mandatory)<br />
** '''Purpose''': Imports an exported question file (.csv) to the last group of the Survey given by SurveyID. This is meant for predefined questions stored in the /question directory<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** (<span style='color:#FF0000'>m</span>) String Module, the name of the csv file you want to add to the Survey, without extension(.csv).<br />
*** String mandatory, default='N' set to 'Y' if you want that question mandatory<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to change Surveys from other people");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported questions as .csv which lay under \questions or any dir given in lsrc.config.php<br />
*** The baselanguage of the question to import, have to match the baselanguage of the core survey.<br />
<br />
==sImportFreetext==<br />
* String '''sImportFreetext'''(string USER, string PASSWORD, int SurveyID, String questionTitle, String questionText, String questionhelp, String module='freitext', string mandatory)<br />
** '''Purpose''': Imports an exported question file (.csv) to the last Group of the survey given by SurveyID and changes the Title, question and helptext. This is meant for importing empty question.csv's (Text Questions)<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** String questionTitle, Name or Categorie of the Question<br />
*** String questionText, The Question itself<br />
*** String questionhelp, A little Help text for better understanding of the Question<br />
*** String module, the name of the Module you want to add to the Survey. It should be "Freitext" by default.<br />
*** String mandatory, make the question mandatory by giving 'Y' as this param.<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to change Surveys from other people");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported questions as .csv which lay under \questions or any dir given in lsrc.config.php<br />
*** It is meant for importing one shortext, Longtext or Hugetext Question and changing the Question and Helptext.<br />
*** The baselanguage of the question to import, have to match the baselanguage of the core survey.<br />
*** Be sure to have at least one proper .csv (Freitext.csv) in the proper directory (questions), to use this function.<br />
*** Use sAvailableModules with mode='que' to get all question .csv's available.<br />
<br />
==sImportMatrix==<br />
* String '''sImportMatrix'''(string USER, string PASSWORD, int SurveyID, String Module, String questionText, String questionhelp, String questionItems)<br />
** '''Purpose''': Imports an exported question file (Matrix5.csv) to the Survey given by SurveyID and changes the question, helptext and gives Items to the 5 Scale Matrix. This is meant for importing one 5 Scale Matrix Question.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** string Module, the name of the Module you want to add to the Survey. It should be "Matrix" by default.<br />
*** String questionText, the question or text to the Matrix<br />
*** String questionhelp, the help text<br />
*** String questionItems, the Items that should be rated, separated by commas<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported groups as .csv which lay under docs\demosurveys\studiply_mod<br />
*** It is meant for importing a group with only one 5 Scale Matrix Question and changing the Question and Helptext and add Items.<br />
*** Be sure to use an user with the surveys baselanguage as default, because this language is used to fill the language fields for answers and questions while importing.<br />
<br />
==sAvailableModules==<br />
* String '''sAvailableModules'''(string USER, string PASSWORD, string mode)<br />
** '''Purpose''': Returning all the csv Names of the csv's in the Directorys configured in lsrc.config.php<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** String mode, (optional) "mod" for the available groups, "core" for the coreSurveys, "que" for addable questions. Default, when not given is "mod".<br />
** '''Returns''':<br />
*** if everything went fine, it returns a String with all surveys, groups or questions (depends on mode) in the Dir given in lsrc.config.php, separated by comma.<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
** '''Note''':<br />
<br />
==sSendEmail==<br />
* String sSendEmail($sUser, $sPass, $surveyID, $type, $maxLsrcEmails='', $subject='', $emailText='')<br />
** '''Purpose''': sends Emails to Participants of a particular survey<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int surveyID, Id of the survey from which participants will be mailed<br />
*** (<span style='color:#FF0000'>m</span>) string type, the kind of email you like to send (invite, remind or custom)<br />
*** int $maxLsrcEmails, if you want to override $maxemails setting in config.php for sending mails with lsrc: here you go.<br />
*** string subject, only needed if type==custom, the subject for the mail to be send.<br />
*** string emailText, only needed if type==custom, the text for the mail to be send.<br />
** '''Returns''':<br />
*** "X Mails send" or "No Mails to send" in custom mode.<br />
*** "X Mails send. X Mails left to send" or "No Mails to send" in invite mode.<br />
*** "X Reminders send. X Reminders left to send" or "No Reminders to send" in remind mode.<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Type: ", "Wrong send Type given. Possible types are: custom, invite or remind");<br />
** '''Note''':<br />
*** invite: When $maxemails is set the function sends only $maxemails in one go. If you call it again, it will go on to send the invitations, until everyone is invited.<br />
*** remind: When $maxemails is set, it will only send $maxemails in one go. It checks if reminders have been send to other participants and if there are participants who received less reminders than others, the script will first send reminders to those who have not been reminded so often, until the remindercount is equal.<br />
*** custom: $maxemails have no effect in custom mode. I have no solution for counting those who have been mailed before.<br />
<br />
==sInsertToken==<br />
* String '''sInsertToken'''(string USER, string PASSWORD, int SurveyID, string Token)<br />
** '''Purpose''': Creates and populates a table {dbprefix}token_{SurveyID} and thus "closes" the survey. It is possible to add tokens to the existing table.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, ID of the survey to close with a token table<br />
*** string Token, a string with comma separated tokens. There is a possibility to set any other separator in config.php. Max. tested length of a string was 500,000 tokens, that makes a String of 5,500,000 Chars, Â this is just the limit of the apache webserver on my notebook (CoreDuo 1,6MHz, 1GB Ram) with default Resource Limits (60,60,16). I recommend to send max. 100,000 tokens over the webservice. Repeat for more tokens.<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** if everything went ok, it returns the String: "[X] Token given, [X] Token inserted"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Server: ", "Token could not be inserted");<br />
** '''Note''':<br />
*** Make sure on the client side that no token appears twice in the table. There is no check on this and won't be in the future. What happens if there are two same tokens? 2 participants will get the same token, one will fill out the form for both, and the other will get a message: "your token have already participated"<br />
*** If there is no token table, it will create one and add the tokens.<br />
*** If the Tokentable already exists, it just adds the given tokens to the existing table.<br />
<br />
==sInsertParticipants==<br />
* String '''sInsertParticipants'''(string USER, string PASSWORD, int SurveyID, string ParticipantData)<br />
** '''Purpose''': Creates and populates a table {dbprefix}token_{SurveyID} and thus "closes" the survey. You can deliver some data to the token table. If you do not support a token, or an empty String as token, a unique token will be generated for the participant.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, ID of the survey to close with a token table<br />
*** string ParticipantData, The Data have to be in the right Syntax, it's like this:<br />
<br />
<pre><br />
<br />
FIRSTNAME;LASTNAME;EMAIL;ATTRIB1;ATTRIB2;TOKEN::FIRSTNAME;LASTNAME;EMAIL;ATTRIB1;ATTRIB2;TOKEN<br />
<br />
</pre><br />
<br />
'''NOTE: The Data Syntax change with 1.86'''. in order to take language, validfrom, validuntil and a variable count of attributes.<br />
<br />
With 1.86 and later versions, it will have to be like this:<br />
<br />
<pre><br />
<br />
FIRSTNAME;LASTNAME;EMAIL;LANGUAGE;TOKEN;VALIDFROM;VALIDUNTIL;attribute1,attribute2,attribute3::FIRSTNAME ... etc.<br />
<br />
</pre><br />
<br />
note that the 8th field is the attributes field. There is no 9th field. You can seperate many attributes with a colon (,). The lsrc will create the needed fields in the db if they are not present. All Fields after LANGUAGE are optional and do not have to be send.<br />
<br />
seperate the Datasets with double colons (::) and the fields with semicolon (;). The '''attrib1, attrib2 and token fields are optional''', you can just leave them out if not used. Note that the attrib field will get empty and not NULL, by now there where no complications, inform us, if you see some difficulties in not setting them NULL. Max. successfully tested length of a string was 3,000,000 Chars, this is just the limit of the apache webserver on my notebook (CoreDuo 1,6MHz, 1GB Ram) with default Resource Limits (60,60,16). I recommend to send max. 10,000 Datasets over the webservice at once(~1,000,000 chars). Repeat for more Datasets.<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** if everything went ok, it returns the String: "[X] Datasets given, [X] rows inserted. ";<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Server: ", "No SurveyId given");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
** '''Note''':<br />
*** default tokenlength is 5 chars, if you want to change the length, goto lsrc.server.php, line 441<br />
*** If the token table does not exists, it will be created, and if it does, the data will be added.<br />
<br />
==sTokenReturn==<br />
* string return '''sTokenReturn'''(string USER, string PASSWORD, int SurveyID)<br />
** '''Purpose''': Gives back all Tokens, which did not complete the Survey, in a String seperated by commas.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the ID for the Survey from which you want get the unused tokens<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** Returns a String, a string of all unused tokens seperated by comma.<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Server: ", "No SurveyId given");<br />
*** Â throw new SoapFault("Database: ", "Token table for this Survey does not exists");<br />
*** Â throw new SoapFault("Database: ", "No unused Tokens found");<br />
<br />
==sGetFieldmap==<br />
* string return '''sGetFieldmap'''(string USER, string PASSWORD, int SurveyID)<br />
** '''Purpose''': Gives back the fieldmap for the survey<br />
<br />
for example:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
"fieldname","type","sid","gid","qid","aid","title","question","group_name","lid","lid1"<br />
<br />
"111X779X39801","F","111","779","3980","1","1","How do you feel?","Paticipant feelings","",""<br />
<br />
"111X779X39802","M","111","779","3980","2","1a","Why do you feel like this?","Paticipant feelings","",""<br />
<br />
[...]<br />
<br />
</syntaxhighlight><br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the ID for the Survey from which you want to get the Fieldmap.<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** Returns a String, a string of the fieldmap, seperated by comma and blanks<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to get fieldmaps from other peoples Surveys");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Server: ", "No SurveyId given");<br />
<br />
==fSendStatistic==<br />
<br />
<span style='color:#FF0000'>''(since 1.86)''</span><br />
* '''fSendStatistic'''(string USER, string PASSWORD, int SurveyID, string Email, string doctype, string graph)<br />
** '''Purpose''': sends an Statistic File as Attachment<br />
** '''Parameters'''<br />
*** user: Limesurvey user<br />
*** password: Limesurvey Password<br />
*** surveyId: ID of the survey from which statistics should be generated<br />
*** email: the adress to which the statistic file is send<br />
*** doctype: pdf, xls or html. With pdf or xls, the recipient gets an attached file with a short notice. With html, he gets an html e-mail without attachments<br />
*** graph: turn graph generation on or off. Works only with pdf generation. Use '1' as a string if you want to enable it<br />
** '''returns'''<br />
*** string: 'XLS send'<br />
*** string: 'PDF send'<br />
*** string: 'HTML send'<br />
** '''possible Faults'''<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to send statistics from other peoples Surveys");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Mail System", "Mail could not be send! Check your E-Mail Settings.");<br />
<br />
=Testing=<br />
<br />
For testing purposes, we made a testclient in php. Therefore you need a webserver to run it. If you test on one machine you need nothing to do, you can go to http://localhost/limesurvey/admin/lsrc/lsrc.testclient.php in your browser to test the webservices functionality.<br />
<br />
Of Course this is very boring, because the apache talks with himself (and thats not the matter of a webservice).<br />
<br />
The Testclient have two purposes:<br />
<br />
1. It checks the Server(the one the testclient is running on!) for the PHP:SOAP Extension and installed libXML version and gives feedback if the enviroment does support SOAP via PHP:SOAP. This is very useful to check your Server and your Client towards PHP:SOAP compatibility. In addition to this, it will check if the wsdl file you want to connect to exists, it does not validate the wsdl file.<br />
<br />
2. You can test the functions of the webservice.<br />
<br />
If you test the webservice in realistic enviroment (two machines) you have to customize three things<br />
* the lsrc.testclient.php needs to be on the machine where the webservice is NOT running, but it needs a webserver... download xampp from apachefriends if you dont have one <strike>(caution for Linux Users: you have to compile PHP5 with SOAP and enable the extension, futhermore you have to install libXML2. Last thing can by done very easy via Synaptics or apt-get)</strike> xampp for Linux works well with SOAP and libXML from version 1.7.<br />
* this Line:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
$limeUrl='https://localhost/limesource/limesurvey';<br />
<br />
</syntaxhighlight><br />
<br />
At the beginning of lsrc.testclient.php needs to fit the target Limesurvey Installation Dir. localhost for servername is always wrong in this testcase, 127.0.0.1, too.<br />
<br />
'''NOTES''':<br />
* The Testclient is configured to use "admin" "password" as authentication. If you want to test with another user or password you have to set this vars in lsrc.testclient.php ( lines 40 and 41)<br />
* If you just get a blank page on the testclient, make sure the path to the wsdl is correct, and the var $enableLsrc is set to true in config.php or lsrc.config.php<br />
<br />
=Notes=<br />
* Security is enhanced: no action without permission (as good as Limesurveys Security itself --> very good)<br />
* No headers or "Quick and Dirtys" anymore, no Scripts, just functions and a class.<br />
* All configuration Variables are stored in lsrc.config.php by now<br />
* There is a debug functionality, showing where the script runs through the code in an own log file. Use Apaches error.log in addition to find errors if you got any.<br />
* LSRC is part of LimeSurvey, therefore it stands under GNU/GPL License v2 or later.<br />
* SOAP Services and therefore LSRC only support UTF-8 charsets.<br />
* LSRC works with AdoDB (MySql,Postgresql, MSSQL) .<br />
* LSRC is tested, but under steady development, use on your own risk, test the functions before using them productively!<br />
<br />
=Changes=<br />
<br />
1.86<br />
* new function fSendStatistics: to send statistics as attachment to an e-mail-address<br />
* Datasyntax for sInsertParticipants changed in order to take validfrom, validuntil, language and a variable Set of attributes.<br />
<br />
1.85<br />
* Several improvements to stability.<br />
<br />
1.82<br />
* Added sVend Parameter to sCreateSurvey, to set the endtext<br />
* sInsertParticipants takes a token in the dataset, however, if non is supported, it will be generated.<br />
* a new variable $enableLsrc is introduced to enable the Lsrc only when it is used.<br />
* a serious exploit has been fixed.<br />
<br />
1.81<br />
* Added sGetFieldmap function.<br />
* The template.csv's changed.<br />
* exported csv's prior 1.81 will not import over lsrc anymore. Import them via Browser and export them back to lsrc.<br />
<br />
1.80 => 1.81<br />
* Changed sImportGroup: imports '''all''' groups under $modDir, adds them to the survey. Not only the ones with mod_ as prefix. In addition, you can give Name and Description of the Group.<br />
* New sImportQuestion: imports questions in $queDir and adds them to the last group<br />
* New sImportFreetext: imports a Freetext question and changes the title and question to the Strings given. Previously, this function was called sImportQuestion.<br />
* Changed sAvailableModules: type can be core, mod or que. "que" is new and gives back the names of all the questions available.<br />
* New sSendEmail: send invitations, reminders and custom mails to participants of a survey over Limesurvey.<br />
<br />
=ToDo / ToCome=<br />
* <strike>sInsertParticipants should take a lang attribute for each participant</strike><br />
<br />
please add your feature requests to the [http://bugs.limesurvey.org bugtracker] if it is not listed here...<br />
<br />
=Known Bugs (and workarounds)=<br />
* With PHP 5.3.0, the testclient have problems to read the generated wsdl from lsrc.server.php?wsdl. You have to generate it an use the static file to test it.<br />
* Surveys get not imported in 1.85, due to a bug. The bug is fixed and will be released with the next release. Talk to rakete if you need it earlier...<br />
* exported csv's prior 1.81 will not import over lsrc anymore. Import them via Browser and export them back to lsrc to get them work again. (attributes moved from survey to survey_languagesettings)<br />
* sInsertPaticipants and sInsertToken function: You should note, that in case of an Seperator at the beginning or the end of the Datastring, the return Message will recognize one more given Dataset or Token as inserted into the db...<br />
* There is a bug with Webservices in general: Sometimes (~ 1 of 10.000 Cases) you will get an error message like "function 'anyFunction' does not exist on the server" or similar, altough everything is fine. Just wait a few Moments, clear you cache, phone your mom (she will be happy to hear from you ;)) and try again.<br />
* Webservice will not work if the "install" dir is not renamed or deleted in limesurvey and $debug is not set to 2 -> "looks like we got no xml document" without errorlogs<br />
<br />
please add your bug report to the [http://bugs.limesurvey.org bugtracker] if you found an Issue that is not listed here.<br />
<br />
=Security=<br />
<br />
There have been a security hole in the versions prior 1.82 (1.80RC2 to 1.81+). This leak could be used to compromise your webspace if it is weakly configured.<br />
<br />
To minimise the risk of a security leak endanger your system, we disabled the lsrc by default with version 1.82 and you have to enable it explicity in your config.php.<br />
<br />
Some things you can do to improve your security when using the lsrc:<br />
* instead of setting the remotecontrol folder to 777, just create an empty file lsrc.wsdl with the rights 777<br />
* disable the lsrc.log in lsrc.config.php<br />
* Do not set the survey, groups, questions folders to 777 for saving lsrc templates directly within Limesurvey, instead, save the .csv on your local PC and upload them via ftp to the folders.<br />
* delete lsrc.testclient.php, when in productive use. Lsrc.testclient.php could be used from unauthorized people to perform portscanning on other machines. The attacked webserver would be seeing your webserver as attacker, altough you did not perform any attack by yourself. This is not so serious, as this bahaviour of the testclient is not much valuable for any serious hacker.</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=RemoteControl&diff=2925RemoteControl2010-03-20T03:45:35Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Introduction=<br />
<br />
LimeSurvey RemoteControl is a PHP:SOAP based Web service application.<br />
<br />
The LSRC makes it possible for developers to control specific functionality of Limesurvey from any other Application, without beeing restricted to PHP as a Programming language.<br />
<br />
You can start a predefined survey (change titles and things), add predefined groups or questions to this coresurvey. Activate the survey, restrict it to start and endtime, make it closed, add Participant data or just tokens when you need them (your customer just bought a book and now you want to invite him to a closed survey automatically), return the unused tokens to the main application, delete a survey, get a fieldmap for a survey, invite or remind the participants of your survey, etc...<br />
<br />
Be aware that this piece of code was originally written to bind LimeSurvey to a University management software in order to evaluate lectures. So there could be comments in the code or documentation, which have to do with my Company's Software or which are just a little bit confusing when you have nothing to do with University's or the German language.<br />
<br />
Post any comments, wishes or bugs to the [http://bugs.limesurvey.org bugtracker].<br />
<br />
==Files included in LSRC==<br />
* lsrc.config.php (configuration variables)<br />
* lsrc.server.php (the logical SOAP:Server brain. Programm logic is mainly in here )<br />
* lsrc.helper.php (class LsrcHelper, this Class does the work. Mainly copied and customized from Limesurvey files. Especially for import tasks)<br />
* lsrc_orig.wsdl (wsdl definition for SOAP messages. From this file the lsrc.wsdl is generated with correct paths)<br />
* lsrc.testclient.php (to test the environment and functionality of the webservice on the fly)<br />
<br />
== Directory included==<br />
* \surveys (for the core survey .csv's.) Used by sCreateSurvey.<br />
* \groups (for exported group .csv's . Used by sImportGroup. There should be always an empty group for importing, so you can add questions to a new group)<br />
* \questions (for exported questions .csv's. sImportFreetext and sImportMatrix depend on "Freitext.csv" and "Matrix5.csv" which should be exported questions(Freetext and Array 5 point Matrix).<br />
<br />
== Requirements==<br />
* PHP >= 5.2.1 with PHP:SOAP Extension enabled<br />
* libXML installed<br />
* MySQL, PostgreSQL or (not recommended) MSSQL<br />
* (optional) OpenSSL<br />
* (optional) a Certificate for better Security<br />
<br />
=Installation=<br />
<br />
== How to install LSRC==<br />
<br />
If you are using version 1.80 or higher, you do not need to install LSRC, it is included in the package and will be ready to set up - you will not need to install it.<br />
<br />
'''NOTE:''' It is included in Limesurvey since 1.80RC2, before 1.80RC4 it was called "japh" or "japhService"<br />
* create a Dir "remotecontrol" in your LimeSurvey admin dir.<br />
* copy the included files to the new directory.<br />
<br />
== How to configure LSRC==<br />
* first of all you have to '''enable the LSRC in LimeSurveys config.php''' or in lsrc.config.php<br />
** set the variable '''$enableLsrc = true''';<br />
* In the '''lsrc.config.php''' file, you can '''set all needed Variables''' for the LSRC in Section Variables.<br />
** set the Error Handling. While configuring and testing it is very good to get all errors. If you are using lsrc in Production, you should comment error_reporting, so that it sticks to the servers defaults.<br />
** $lsrcDebug, if set to true, the lsrc writes an own log. This log is helpful when implementing new features, if some function does not work, look where it hangs in this log. Should be set to false if in productive Use.<br />
** $lsrcDebugLog, File where the log should be written to.<br />
** ini_set("log_errors", "1"), Apaches log file (error.log) will get filed with php-errors. Very useful for debugging. Comment if in productive Mode.<br />
** ini_set("soap.wsdl_cache_enabled", "0"), while testing, caching is not useful. If in productive Mode, turn this on or just comment the line to stick to server defaults.<br />
** (optional) set $lsrcOverSSL to true, if you want SOAP to exchange the messages over SSL resp. https. It does not more or less than generating the target address in the wsdl with http: or https:.<br />
** set the dirs, where the .csv files to import can be found. You will have to export some survey, you want to import and activate with LSRC, first.<br />
** (optional) change $sLsrcSeparator = "your separator"; in lsrc.config.php if you wish to separate tokens for the sInsertToken function with any other separator than default, which is a comma.<br />
** (optional) change $sDatasetSeperator= "your separator"; in lsrc.config.php if you wish to separate Datasets for the sInsertParticipants function with any other separator than default, which are two colons.<br />
** (optional) change $sDatafieldSeperator= "your separator"; in lsrc.config.php if you wish to separate Datafields for the sInsertParticipants function with any other separator than default, which is a semicolon.<br />
* the script needs rights to write files to the folder "admin/remotecontrol/" Â (lsrc.log, if logging is used and lsrc.wsdl). if(you cannot or don't want to set the directory rights to 777){create those two files(lsrc.log and lsrc.wsdl)in the lsrc dir with the permission to write them(777))<br />
* If you want to save Survey, group or question csv's directly from Limesurvey into the lsrc Folders, you need to set them to 777, too. (Option can be enabled by adding $export4lsrc = true; to Limesurveys config.php)<br />
* You may have to generate a wsdl file if you need a static one. Run lsrc.server.php?wsdl and the script will make a lsrc.wsdl with the correct server url included in the lsrc directory.<br />
* If auto wsdl generation do not work properly (maybe virtual hosts make Problems, please report back, if so or not so, can't test at the moment) You have to set the url of the lsrc.server.php script in the last block of the wsdl<br />
<br />
==How to enable OpenSSL / https Support==<br />
* LSRC supports SSL over http resp. https.<br />
* Your Webserver needs to support and enable OpenSSL (See your Webserver Manual)<br />
* '''ATTENTION:''' Just set the Variable $lsrcOverSSL = true; in lsrc.config.php. After that, initialize your client like shown below, a wsdl file with correct URL will be generated automaticly for you:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
new SoapClient('https://localhost/limesurvey/admin/lsrc.server.php?wsdl',<br />
<br />
         array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
</syntaxhighlight><br />
* 'ONLY FOLLOW THIS STEPS IF WSDL GENERATION DOES NOT WORK FOR YOU' <br>There are two locations in the code, where you force the webservice to use https<br />
<br />
<nowiki>:</nowiki> 1. On the client side, when you call the SOAP-Server over wsdl. For 'https' do it like that:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
new SoapClient('https://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl', array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
</syntaxhighlight><br />
<br />
<nowiki>:</nowiki> for 'http' like that:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
new SoapClient('http://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl', array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
</syntaxhighlight><br />
<br />
<nowiki>:</nowiki> Note that the client will only get the wsdl-definition over https, to get the SOAP Messages over https, set the uri in the wsdl file, like below...<br />
<br />
<nowiki>:</nowiki> 2. Here is the most important Step to SSL. At the End of the lsrc.wsdl file, last block, same procedure:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
  <port name='LsrcPort' binding='tns:LsrcBinding'><br />
<br />
   <soap:address location='https://localhost/limesurvey/admin/remotecontrol/lsrc.server.php' /><br />
<br />
  </port><br />
<br />
</syntaxhighlight><br />
<br />
<nowiki>:</nowiki> or for normal http mode:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
  <port name='LsrcPort' binding='tns:LsrcBinding'><br />
<br />
   <soap:address location='http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php' /><br />
<br />
  </port><br />
<br />
</syntaxhighlight><br />
<br />
That's it! all request, response and fault messages will be transported over https...<br />
<br />
=How to use LSRC=<br />
<br />
==use the client==<br />
<br />
'''NOTE on PHP 5.3:''' setting the path2wsdl to http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl worked with all prior 5.3 version of PHP. With PHP 5.3 the client will not recognize the wsdl lsrc.server.php?wsdl gives back. You have to call lsrc.server.php?wsdl once to generate the lsrc.wsdl file and then point your client to http://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl instead.<br />
<br />
There is a PHPclient (from version 1.86) in the remotecontrol folder. You can use this ClientClass to control Limesurvey from within your PHP Applications with ease.<br />
<br />
Take a look at lsrc.testclient-new.php to get an impression of how it can be implemented.<br />
<br />
Basically you just have to include the class, prepare the Client and start the function calls.<br />
<br />
Example:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<?php<br />
<br />
/**<br />
* include the client class<br />
*/<br />
<br />
include_once("lsrc.client.php");<br />
<br />
/**<br />
* initiate the testclient object<br />
*/<br />
<br />
$testclient = new lsrcClient();<br />
<br />
/**<br />
* prepare the lsrcClient class (initiate the soapClient, set sid if needed)<br />
*/<br />
<br />
$testclient->prepare(333);<br />
<br />
/**<br />
* set user and password (only needed, when not set in the client class directly)<br />
*/<br />
<br />
$testclient->user = 'admin';<br />
<br />
$testclient->pass = 'password';<br />
<br />
/**<br />
* set the path2wsdl (only needed, when not set in the client class directly)<br />
*/<br />
<br />
$testclient->path2wsdl = 'http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl';<br />
<br />
/**<br />
* call the function to create a survey<br />
*/<br />
<br />
$sReturn = $testclient->createSurvey("surveyName" ,<br />
<br />
                  "surveyDescription",<br />
<br />
                  "welcomeText",<br />
<br />
                  "endText",<br />
<br />
                  "surveyAdmins@email.adress",<br />
<br />
                  "Survey Adminsname",<br />
<br />
                  "http://an.end.url",<br />
<br />
                  "Description of End Url",<br />
<br />
                  "template138");<br />
<br />
echo $sReturn;<br />
<br />
</syntaxhighlight><br />
<br />
This Skript initiates the client. The parameter at prepare, sets the surveyId. In this case it means we are going to create the survey with the Id 333. If you do not give an id, the survey will get a random id.<br />
<br />
Next we set the user and password to use. You do not have to do this, as long as the inital values of the client are correct. But you may have to, if you build your app in a way, that different users use the client to create Surveys or edit them.<br />
<br />
In the end, the survey is created with the createSurvey Method and the return is echoed.<br />
<br />
==using the functions==<br />
<br />
You will need a SOAP- or at least RPC-Client to communicate with the LSRC Webservice. How to create such a Client depends on the programming language you use.<br />
<br />
The LSRC itself is written in PHP5 using the PHP:SOAP extension with SOAP 1.1.<br />
<br />
In PHP you would initiate the Client-object and call a function from the Webservice with code like e.g.:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
$wsdl="http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl";<br />
<br />
$client = new SoapClient($wsdl, array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
try<br />
<br />
{<br />
<br />
  $sReturn = $client->sInsertToken($user, $pass, $iVid, $sToken);<br />
<br />
}<br />
<br />
catch (SoapFault $fault)<br />
<br />
{<br />
<br />
  $sOutput .= " <br/><br/>SOAP Error: ".$fault->faultcode." : ".$fault->faultstring;<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
The LSRC offers some functions:<br />
<br />
(<span style='color:#FF0000'>m</span>) means: Mandatory Parameter<br />
<br />
==sCreateSurvey==<br />
<br />
<span style='color:#FF0000'>Parameters changed after 1.81+! (sVend added)</span><br />
* String sCreateSurvey($sUser, $sPass, $iVid, $sVtit , $sVbes, $sVwel, $sVend, $sMail, $sName, $sUrl, $sUbes, $sVtyp )<br />
** '''Purpose''': Creates a new survey. It imports an exported survey from any LS v1.xx. and changes some fields (in the current Version it changes SurveyTitle, Â SurveyDescription and SurveyWelcomeText, adminemail, adminname, url and url_description to the string which was given by the client.)<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int $iVid, SurveyID desired ID for the Survey, make sure it doesn't already exist in LimeSurvey<br />
*** (<span style='color:#FF0000'>m</span>) string $sVtit, SurveyTitle, should be the (Nr +)Name of the Event to be evaluated<br />
*** (<span style='color:#FF0000'>m</span>) string $sVbes, Survey Description, This should be String put together with veransttyp + doztitle + dozname<br />
*** string $sVwel, Survey Welcometext, A text shown before the survey starts. If not given it says: "Herzlich Willkommen zur Evaluation von "$sVtit"<br />
*** string $sVend, Survey Endtext, Text shown at the endpage.<br />
*** string $sMail, Admin Email, Email Adress of the responsible person for this survey<br />
*** string $sName, Name of the responsible person for this survey<br />
*** string $sUrl, Url of the Link, shown on the last page of survey.<br />
*** string $sUbes, Description String of the URL above. ( <a href='$sUrl'>$sUbes</a> )<br />
*** string $sVtyp, The type of Event that should be evaluated. Use in combination with sAvailableModules with $mode='core' to get all available "types"<br />
** '''Returns''':<br />
*** if everything went fine, it returns the SurveyID from the created survey<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "SurveyID already exists");<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Server: ", "Import went wrong somehow");<br />
** '''Note''':<br />
*** Goto line 714 in lsrc.helper.php to see what can be done and customized while importing.<br />
*** If you want Limesurvey to give your Survey a random Number if the given ID exist (because you do not need a specific identification for your surveys), just go into the function sCreateSurvey in lsrc.server.php and delete or comment out the if($lsrcHelper->surveyExists($iVid)) clause. In Result, Limesurvey will give your survey a random ID when the given ID exists.<br />
<br />
==sActivateSurvey==<br />
* String '''sActivateSurvey'''(string USER, string PASSWORD, int SurveyID, date start, date end)<br />
** '''Purpose''': Activates an existing survey and set start and enddate optional<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID for the Survey to activate.<br />
*** date start, date for the Survey to start. 2008-10-22 means it starts exactly at 2008-10-22 00:00:00 Servertime<br />
*** date end, date for the Survey to end. 2008-10-22 means it ends exactly at 2008-10-22 23:59:59 Servertime. Nobody can access nor complete the Survey only a second later.<br />
** '''Returns''':<br />
*** if everything went fine, it returns the SurveyID from the activated survey<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "Survey you want to activate does not exists");<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Server: ", "Activation went wrong somehow");<br />
** '''Note''':<br />
*** You can set startDate and/or endDate after activation if needed. Just run the function again with desired parameters.<br />
<br />
==sImportGroup==<br />
* String '''sImportGroup'''(string USER, string PASSWORD, int SurveyID, String Module, String groupName, String groupDescription)<br />
** '''Purpose''': Imports an exported group file (.csv) to the Survey given by SurveyID<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** (<span style='color:#FF0000'>m</span>) string Module, the filename of the Group you want to add to the Survey. Use sAvailableModules to get the available groups.<br />
*** string groupName, the Title the Group gets. If not set, it will use the title given in the .csv.<br />
*** string groupDescription, Description of the group. If not set, it will use the description given in the .csv.<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "Import OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to change Surveys from other people");<br />
*** Â throw new SoapFault("Server: ", "Survey Module $sMod does not exist");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported groups as .csv which lay under \groups or any other dir given in lsrc.config.php<br />
*** <strike>It imports only the files beginning with "mod_" ending with ".csv"</strike><br />
*** The Param Module must only contain the "name of the Module": Only the String before ".csv"<br />
*** The baselanguage of the group to import, have to match the baselanguage of the coresurvey.<br />
<br />
==sImportQuestion==<br />
* String '''sImportQuestion'''(string USER, string PASSWORD, int SurveyID, String Module, String mandatory)<br />
** '''Purpose''': Imports an exported question file (.csv) to the last group of the Survey given by SurveyID. This is meant for predefined questions stored in the /question directory<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** (<span style='color:#FF0000'>m</span>) String Module, the name of the csv file you want to add to the Survey, without extension(.csv).<br />
*** String mandatory, default='N' set to 'Y' if you want that question mandatory<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to change Surveys from other people");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported questions as .csv which lay under \questions or any dir given in lsrc.config.php<br />
*** The baselanguage of the question to import, have to match the baselanguage of the core survey.<br />
<br />
==sImportFreetext==<br />
* String '''sImportFreetext'''(string USER, string PASSWORD, int SurveyID, String questionTitle, String questionText, String questionhelp, String module='freitext', string mandatory)<br />
** '''Purpose''': Imports an exported question file (.csv) to the last Group of the survey given by SurveyID and changes the Title, question and helptext. This is meant for importing empty question.csv's (Text Questions)<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** String questionTitle, Name or Categorie of the Question<br />
*** String questionText, The Question itself<br />
*** String questionhelp, A little Help text for better understanding of the Question<br />
*** String module, the name of the Module you want to add to the Survey. It should be "Freitext" by default.<br />
*** String mandatory, make the question mandatory by giving 'Y' as this param.<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to change Surveys from other people");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported questions as .csv which lay under \questions or any dir given in lsrc.config.php<br />
*** It is meant for importing one shortext, Longtext or Hugetext Question and changing the Question and Helptext.<br />
*** The baselanguage of the question to import, have to match the baselanguage of the core survey.<br />
*** Be sure to have at least one proper .csv (Freitext.csv) in the proper directory (questions), to use this function.<br />
*** Use sAvailableModules with mode='que' to get all question .csv's available.<br />
<br />
==sImportMatrix==<br />
* String '''sImportMatrix'''(string USER, string PASSWORD, int SurveyID, String Module, String questionText, String questionhelp, String questionItems)<br />
** '''Purpose''': Imports an exported question file (Matrix5.csv) to the Survey given by SurveyID and changes the question, helptext and gives Items to the 5 Scale Matrix. This is meant for importing one 5 Scale Matrix Question.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** string Module, the name of the Module you want to add to the Survey. It should be "Matrix" by default.<br />
*** String questionText, the question or text to the Matrix<br />
*** String questionhelp, the help text<br />
*** String questionItems, the Items that should be rated, separated by commas<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported groups as .csv which lay under docs\demosurveys\studiply_mod<br />
*** It is meant for importing a group with only one 5 Scale Matrix Question and changing the Question and Helptext and add Items.<br />
*** Be sure to use an user with the surveys baselanguage as default, because this language is used to fill the language fields for answers and questions while importing.<br />
<br />
==sAvailableModules==<br />
* String '''sAvailableModules'''(string USER, string PASSWORD, string mode)<br />
** '''Purpose''': Returning all the csv Names of the csv's in the Directorys configured in lsrc.config.php<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** String mode, (optional) "mod" for the available groups, "core" for the coreSurveys, "que" for addable questions. Default, when not given is "mod".<br />
** '''Returns''':<br />
*** if everything went fine, it returns a String with all surveys, groups or questions (depends on mode) in the Dir given in lsrc.config.php, separated by comma.<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
** '''Note''':<br />
<br />
==sSendEmail==<br />
* String sSendEmail($sUser, $sPass, $surveyID, $type, $maxLsrcEmails='', $subject='', $emailText='')<br />
** '''Purpose''': sends Emails to Participants of a particular survey<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int surveyID, Id of the survey from which participants will be mailed<br />
*** (<span style='color:#FF0000'>m</span>) string type, the kind of email you like to send (invite, remind or custom)<br />
*** int $maxLsrcEmails, if you want to override $maxemails setting in config.php for sending mails with lsrc: here you go.<br />
*** string subject, only needed if type==custom, the subject for the mail to be send.<br />
*** string emailText, only needed if type==custom, the text for the mail to be send.<br />
** '''Returns''':<br />
*** "X Mails send" or "No Mails to send" in custom mode.<br />
*** "X Mails send. X Mails left to send" or "No Mails to send" in invite mode.<br />
*** "X Reminders send. X Reminders left to send" or "No Reminders to send" in remind mode.<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Type: ", "Wrong send Type given. Possible types are: custom, invite or remind");<br />
** '''Note''':<br />
*** invite: When $maxemails is set the function sends only $maxemails in one go. If you call it again, it will go on to send the invitations, until everyone is invited.<br />
*** remind: When $maxemails is set, it will only send $maxemails in one go. It checks if reminders have been send to other participants and if there are participants who received less reminders than others, the script will first send reminders to those who have not been reminded so often, until the remindercount is equal.<br />
*** custom: $maxemails have no effect in custom mode. I have no solution for counting those who have been mailed before.<br />
<br />
==sInsertToken==<br />
* String '''sInsertToken'''(string USER, string PASSWORD, int SurveyID, string Token)<br />
** '''Purpose''': Creates and populates a table {dbprefix}token_{SurveyID} and thus "closes" the survey. It is possible to add tokens to the existing table.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, ID of the survey to close with a token table<br />
*** string Token, a string with comma separated tokens. There is a possibility to set any other separator in config.php. Max. tested length of a string was 500,000 tokens, that makes a String of 5,500,000 Chars, Â this is just the limit of the apache webserver on my notebook (CoreDuo 1,6MHz, 1GB Ram) with default Resource Limits (60,60,16). I recommend to send max. 100,000 tokens over the webservice. Repeat for more tokens.<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** if everything went ok, it returns the String: "[X] Token given, [X] Token inserted"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Server: ", "Token could not be inserted");<br />
** '''Note''':<br />
*** Make sure on the client side that no token appears twice in the table. There is no check on this and won't be in the future. What happens if there are two same tokens? 2 participants will get the same token, one will fill out the form for both, and the other will get a message: "your token have already participated"<br />
*** If there is no token table, it will create one and add the tokens.<br />
*** If the Tokentable already exists, it just adds the given tokens to the existing table.<br />
<br />
==sInsertParticipants==<br />
* String '''sInsertParticipants'''(string USER, string PASSWORD, int SurveyID, string ParticipantData)<br />
** '''Purpose''': Creates and populates a table {dbprefix}token_{SurveyID} and thus "closes" the survey. You can deliver some data to the token table. If you do not support a token, or an empty String as token, a unique token will be generated for the participant.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, ID of the survey to close with a token table<br />
*** string ParticipantData, The Data have to be in the right Syntax, it's like this:<br />
<br />
<pre><br />
<br />
FIRSTNAME;LASTNAME;EMAIL;ATTRIB1;ATTRIB2;TOKEN::FIRSTNAME;LASTNAME;EMAIL;ATTRIB1;ATTRIB2;TOKEN<br />
<br />
</pre><br />
<br />
'''NOTE: The Data Syntax change with 1.86'''. in order to take language, validfrom, validuntil and a variable count of attributes.<br />
<br />
With 1.86 and later versions, it will have to be like this:<br />
<br />
<pre><br />
<br />
FIRSTNAME;LASTNAME;EMAIL;LANGUAGE;TOKEN;VALIDFROM;VALIDUNTIL;attribute1,attribute2,attribute3::FIRSTNAME ... etc.<br />
<br />
</pre><br />
<br />
note that the 8th field is the attributes field. There is no 9th field. You can seperate many attributes with a colon (,). The lsrc will create the needed fields in the db if they are not present. All Fields after LANGUAGE are optional and do not have to be send.<br />
<br />
seperate the Datasets with double colons (::) and the fields with semicolon (;). The '''attrib1, attrib2 and token fields are optional''', you can just leave them out if not used. Note that the attrib field will get empty and not NULL, by now there where no complications, inform us, if you see some difficulties in not setting them NULL. Max. successfully tested length of a string was 3,000,000 Chars, this is just the limit of the apache webserver on my notebook (CoreDuo 1,6MHz, 1GB Ram) with default Resource Limits (60,60,16). I recommend to send max. 10,000 Datasets over the webservice at once(~1,000,000 chars). Repeat for more Datasets.<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** if everything went ok, it returns the String: "[X] Datasets given, [X] rows inserted. ";<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Server: ", "No SurveyId given");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
** '''Note''':<br />
*** default tokenlength is 5 chars, if you want to change the length, goto lsrc.server.php, line 441<br />
*** If the token table does not exists, it will be created, and if it does, the data will be added.<br />
<br />
==sTokenReturn==<br />
* string return '''sTokenReturn'''(string USER, string PASSWORD, int SurveyID)<br />
** '''Purpose''': Gives back all Tokens, which did not complete the Survey, in a String seperated by commas.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the ID for the Survey from which you want get the unused tokens<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** Returns a String, a string of all unused tokens seperated by comma.<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Server: ", "No SurveyId given");<br />
*** Â throw new SoapFault("Database: ", "Token table for this Survey does not exists");<br />
*** Â throw new SoapFault("Database: ", "No unused Tokens found");<br />
<br />
==sGetFieldmap==<br />
* string return '''sGetFieldmap'''(string USER, string PASSWORD, int SurveyID)<br />
** '''Purpose''': Gives back the fieldmap for the survey<br />
<br />
for example:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
"fieldname","type","sid","gid","qid","aid","title","question","group_name","lid","lid1"<br />
<br />
"111X779X39801","F","111","779","3980","1","1","How do you feel?","Paticipant feelings","",""<br />
<br />
"111X779X39802","M","111","779","3980","2","1a","Why do you feel like this?","Paticipant feelings","",""<br />
<br />
[...]<br />
<br />
</syntaxhighlight><br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the ID for the Survey from which you want to get the Fieldmap.<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** Returns a String, a string of the fieldmap, seperated by comma and blanks<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to get fieldmaps from other peoples Surveys");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Server: ", "No SurveyId given");<br />
<br />
==fSendStatistic==<br />
<br />
<span style='color:#FF0000'>''(since 1.86)''</span><br />
* '''fSendStatistic'''(string USER, string PASSWORD, int SurveyID, string Email, string doctype, string graph)<br />
** '''Purpose''': sends an Statistic File as Attachment<br />
** '''Parameters'''<br />
*** user: Limesurvey user<br />
*** password: Limesurvey Password<br />
*** surveyId: ID of the survey from which statistics should be generated<br />
*** email: the adress to which the statistic file is send<br />
*** doctype: pdf, xls or html. With pdf or xls, the recipient gets an attached file with a short notice. With html, he gets an html e-mail without attachments<br />
*** graph: turn graph generation on or off. Works only with pdf generation. Use '1' as a string if you want to enable it<br />
** '''returns'''<br />
*** string: 'XLS send'<br />
*** string: 'PDF send'<br />
*** string: 'HTML send'<br />
** '''possible Faults'''<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to send statistics from other peoples Surveys");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Mail System", "Mail could not be send! Check your E-Mail Settings.");<br />
<br />
=Testing=<br />
<br />
For testing purposes, we made a testclient in php. Therefore you need a webserver to run it. If you test on one machine you need nothing to do, you can go to http://localhost/limesurvey/admin/lsrc/lsrc.testclient.php in your browser to test the webservices functionality.<br />
<br />
Of Course this is very boring, because the apache talks with himself (and thats not the matter of a webservice).<br />
<br />
The Testclient have two purposes:<br />
<br />
1. It checks the Server(the one the testclient is running on!) for the PHP:SOAP Extension and installed libXML version and gives feedback if the enviroment does support SOAP via PHP:SOAP. This is very useful to check your Server and your Client towards PHP:SOAP compatibility. In addition to this, it will check if the wsdl file you want to connect to exists, it does not validate the wsdl file.<br />
<br />
2. You can test the functions of the webservice.<br />
<br />
If you test the webservice in realistic enviroment (two machines) you have to customize three things<br />
* the lsrc.testclient.php needs to be on the machine where the webservice is NOT running, but it needs a webserver... download xampp from apachefriends if you dont have one <strike>(caution for Linux Users: you have to compile PHP5 with SOAP and enable the extension, futhermore you have to install libXML2. Last thing can by done very easy via Synaptics or apt-get)</strike> xampp for Linux works well with SOAP and libXML from version 1.7.<br />
* this Line:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
$limeUrl='https://localhost/limesource/limesurvey';<br />
<br />
</syntaxhighlight><br />
<br />
At the beginning of lsrc.testclient.php needs to fit the target Limesurvey Installation Dir. localhost for servername is always wrong in this testcase, 127.0.0.1, too.<br />
<br />
'''NOTES''':<br />
* The Testclient is configured to use "admin" "password" as authentication. If you want to test with another user or password you have to set this vars in lsrc.testclient.php ( lines 40 and 41)<br />
* If you just get a blank page on the testclient, make sure the path to the wsdl is correct, and the var $enableLsrc is set to true in config.php or lsrc.config.php<br />
<br />
=Notes=<br />
* Security is enhanced: no action without permission (as good as Limesurveys Security itself --> very good)<br />
* No headers or "Quick and Dirtys" anymore, no Scripts, just functions and a class.<br />
* All configuration Variables are stored in lsrc.config.php by now<br />
* There is a debug functionality, showing where the script runs through the code in an own log file. Use Apaches error.log in addition to find errors if you got any.<br />
* LSRC is part of LimeSurvey, therefore it stands under GNU/GPL License v2 or later.<br />
* SOAP Services and therefore LSRC only support UTF-8 charsets.<br />
* LSRC works with AdoDB (MySql,Postgresql, MSSQL) .<br />
* LSRC is tested, but under steady development, use on your own risk, test the functions before using them productively!<br />
<br />
=Changes=<br />
<br />
1.86<br />
* new function fSendStatistics: to send statistics as attachment to an e-mail-address<br />
* Datasyntax for sInsertParticipants changed in order to take validfrom, validuntil, language and a variable Set of attributes.<br />
<br />
1.85<br />
* Several improvements to stability.<br />
<br />
1.82<br />
* Added sVend Parameter to sCreateSurvey, to set the endtext<br />
* sInsertParticipants takes a token in the dataset, however, if non is supported, it will be generated.<br />
* a new variable $enableLsrc is introduced to enable the Lsrc only when it is used.<br />
* a serious exploit has been fixed.<br />
<br />
1.81<br />
* Added sGetFieldmap function.<br />
* The template.csv's changed.<br />
* exported csv's prior 1.81 will not import over lsrc anymore. Import them via Browser and export them back to lsrc.<br />
<br />
1.80 => 1.81<br />
* Changed sImportGroup: imports '''all''' groups under $modDir, adds them to the survey. Not only the ones with mod_ as prefix. In addition, you can give Name and Description of the Group.<br />
* New sImportQuestion: imports questions in $queDir and adds them to the last group<br />
* New sImportFreetext: imports a Freetext question and changes the title and question to the Strings given. Previously, this function was called sImportQuestion.<br />
* Changed sAvailableModules: type can be core, mod or que. "que" is new and gives back the names of all the questions available.<br />
* New sSendEmail: send invitations, reminders and custom mails to participants of a survey over Limesurvey.<br />
<br />
=ToDo / ToCome=<br />
* <strike>sInsertParticipants should take a lang attribute for each participant</strike><br />
<br />
please add your feature requests to the [http://bugs.limesurvey.org bugtracker] if it is not listed here...<br />
<br />
=Known Bugs (and workarounds)=<br />
* With PHP 5.3.0, the testclient have problems to read the generated wsdl from lsrc.server.php?wsdl. You have to generate it an use the static file to test it.<br />
* Surveys get not imported in 1.85, due to a bug. The bug is fixed and will be released with the next release. Talk to rakete if you need it earlier...<br />
* exported csv's prior 1.81 will not import over lsrc anymore. Import them via Browser and export them back to lsrc to get them work again. (attributes moved from survey to survey_languagesettings)<br />
* sInsertPaticipants and sInsertToken function: You should note, that in case of an Seperator at the beginning or the end of the Datastring, the return Message will recognize one more given Dataset or Token as inserted into the db...<br />
* There is a bug with Webservices in general: Sometimes (~ 1 of 10.000 Cases) you will get an error message like "function 'anyFunction' does not exist on the server" or similar, altough everything is fine. Just wait a few Moments, clear you cache, phone your mom (she will be happy to hear from you ;)) and try again.<br />
* Webservice will not work if the "install" dir is not renamed or deleted in limesurvey and $debug is not set to 2 -> "looks like we got no xml document" without errorlogs<br />
<br />
please add your bug report to the [http://bugs.limesurvey.org bugtracker] if you found an Issue that is not listed here.<br />
<br />
=Security=<br />
<br />
There have been a security hole in the versions prior 1.82 (1.80RC2 to 1.81+). This leak could be used to compromise your webspace if it is weakly configured.<br />
<br />
To minimise the risk of a security leak endanger your system, we disabled the lsrc by default with version 1.82 and you have to enable it explicity in your config.php.<br />
<br />
Some things you can do to improve your security when using the lsrc:<br />
* instead of setting the remotecontrol folder to 777, just create an empty file lsrc.wsdl with the rights 777<br />
* disable the lsrc.log in lsrc.config.php<br />
* Do not set the survey, groups, questions folders to 777 for saving lsrc templates directly within Limesurvey, instead, save the .csv on your local PC and upload them via ftp to the folders.<br />
* delete lsrc.testclient.php, when in productive use. Lsrc.testclient.php could be used from unauthorized people to perform portscanning on other machines. The attacked webserver would be seeing your webserver as attacker, altough you did not perform any attack by yourself. This is not so serious, as this bahaviour of the testclient is not much valuable for any serious hacker.</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=RemoteControl&diff=2926RemoteControl2010-03-20T03:44:55Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Introduction=<br />
<br />
LimeSurvey RemoteControl is a PHP:SOAP based Web service application.<br />
<br />
The LSRC makes it possible for developers to control specific functionality of Limesurvey from any other Application, without beeing restricted to PHP as a Programming language.<br />
<br />
You can start a predefined survey (change titles and things), add predefined groups or questions to this coresurvey. Activate the survey, restrict it to start and endtime, make it closed, add Participant data or just tokens when you need them (your customer just bought a book and now you want to invite him to a closed survey automatically), return the unused tokens to the main application, delete a survey, get a fieldmap for a survey, invite or remind the participants of your survey, etc...<br />
<br />
Be aware that this piece of code was originally written to bind LimeSurvey to a University management software in order to evaluate lectures. So there could be comments in the code or documentation, which have to do with my Company's Software or which are just a little bit confusing when you have nothing to do with University's or the German language.<br />
<br />
Post any comments, wishes or bugs to the [http://bugs.limesurvey.org bugtracker].<br />
<br />
==Files included in LSRC==<br />
* lsrc.config.php (configuration variables)<br />
* lsrc.server.php (the logical SOAP:Server brain. Programm logic is mainly in here )<br />
* lsrc.helper.php (class LsrcHelper, this Class does the work. Mainly copied and customized from Limesurvey files. Especially for import tasks)<br />
* lsrc_orig.wsdl (wsdl definition for SOAP messages. From this file the lsrc.wsdl is generated with correct paths)<br />
* lsrc.testclient.php (to test the environment and functionality of the webservice on the fly)<br />
<br />
== Directory included==<br />
* \surveys (for the core survey .csv's.) Used by sCreateSurvey.<br />
* \groups (for exported group .csv's . Used by sImportGroup. There should be always an empty group for importing, so you can add questions to a new group)<br />
* \questions (for exported questions .csv's. sImportFreetext and sImportMatrix depend on "Freitext.csv" and "Matrix5.csv" which should be exported questions(Freetext and Array 5 point Matrix).<br />
<br />
== Requirements==<br />
* PHP >= 5.2.1 with PHP:SOAP Extension enabled<br />
* libXML installed<br />
* MySQL, PostgreSQL or (not recommended) MSSQL<br />
* (optional) OpenSSL<br />
* (optional) a Certificate for better Security<br />
<br />
=Installation=<br />
<br />
== How to install LSRC==<br />
<br />
If you are using version 1.80 or higher, you do not need to install LSRC, it is included in the package.<br />
<br />
'''NOTE:''' It is included in Limesurvey since 1.80RC2, before 1.80RC4 it was called "japh" or "japhService"<br />
* create a Dir "remotecontrol" in your LimeSurvey admin dir.<br />
* copy the included files to the new directory.<br />
<br />
== How to configure LSRC==<br />
* first of all you have to '''enable the LSRC in LimeSurveys config.php''' or in lsrc.config.php<br />
** set the variable '''$enableLsrc = true''';<br />
* In the '''lsrc.config.php''' file, you can '''set all needed Variables''' for the LSRC in Section Variables.<br />
** set the Error Handling. While configuring and testing it is very good to get all errors. If you are using lsrc in Production, you should comment error_reporting, so that it sticks to the servers defaults.<br />
** $lsrcDebug, if set to true, the lsrc writes an own log. This log is helpful when implementing new features, if some function does not work, look where it hangs in this log. Should be set to false if in productive Use.<br />
** $lsrcDebugLog, File where the log should be written to.<br />
** ini_set("log_errors", "1"), Apaches log file (error.log) will get filed with php-errors. Very useful for debugging. Comment if in productive Mode.<br />
** ini_set("soap.wsdl_cache_enabled", "0"), while testing, caching is not useful. If in productive Mode, turn this on or just comment the line to stick to server defaults.<br />
** (optional) set $lsrcOverSSL to true, if you want SOAP to exchange the messages over SSL resp. https. It does not more or less than generating the target address in the wsdl with http: or https:.<br />
** set the dirs, where the .csv files to import can be found. You will have to export some survey, you want to import and activate with LSRC, first.<br />
** (optional) change $sLsrcSeparator = "your separator"; in lsrc.config.php if you wish to separate tokens for the sInsertToken function with any other separator than default, which is a comma.<br />
** (optional) change $sDatasetSeperator= "your separator"; in lsrc.config.php if you wish to separate Datasets for the sInsertParticipants function with any other separator than default, which are two colons.<br />
** (optional) change $sDatafieldSeperator= "your separator"; in lsrc.config.php if you wish to separate Datafields for the sInsertParticipants function with any other separator than default, which is a semicolon.<br />
* the script needs rights to write files to the folder "admin/remotecontrol/" Â (lsrc.log, if logging is used and lsrc.wsdl). if(you cannot or don't want to set the directory rights to 777){create those two files(lsrc.log and lsrc.wsdl)in the lsrc dir with the permission to write them(777))<br />
* If you want to save Survey, group or question csv's directly from Limesurvey into the lsrc Folders, you need to set them to 777, too. (Option can be enabled by adding $export4lsrc = true; to Limesurveys config.php)<br />
* You may have to generate a wsdl file if you need a static one. Run lsrc.server.php?wsdl and the script will make a lsrc.wsdl with the correct server url included in the lsrc directory.<br />
* If auto wsdl generation do not work properly (maybe virtual hosts make Problems, please report back, if so or not so, can't test at the moment) You have to set the url of the lsrc.server.php script in the last block of the wsdl<br />
<br />
==How to enable OpenSSL / https Support==<br />
* LSRC supports SSL over http resp. https.<br />
* Your Webserver needs to support and enable OpenSSL (See your Webserver Manual)<br />
* '''ATTENTION:''' Just set the Variable $lsrcOverSSL = true; in lsrc.config.php. After that, initialize your client like shown below, a wsdl file with correct URL will be generated automaticly for you:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
new SoapClient('https://localhost/limesurvey/admin/lsrc.server.php?wsdl',<br />
<br />
         array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
</syntaxhighlight><br />
* 'ONLY FOLLOW THIS STEPS IF WSDL GENERATION DOES NOT WORK FOR YOU' <br>There are two locations in the code, where you force the webservice to use https<br />
<br />
<nowiki>:</nowiki> 1. On the client side, when you call the SOAP-Server over wsdl. For 'https' do it like that:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
new SoapClient('https://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl', array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
</syntaxhighlight><br />
<br />
<nowiki>:</nowiki> for 'http' like that:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
new SoapClient('http://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl', array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
</syntaxhighlight><br />
<br />
<nowiki>:</nowiki> Note that the client will only get the wsdl-definition over https, to get the SOAP Messages over https, set the uri in the wsdl file, like below...<br />
<br />
<nowiki>:</nowiki> 2. Here is the most important Step to SSL. At the End of the lsrc.wsdl file, last block, same procedure:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
  <port name='LsrcPort' binding='tns:LsrcBinding'><br />
<br />
   <soap:address location='https://localhost/limesurvey/admin/remotecontrol/lsrc.server.php' /><br />
<br />
  </port><br />
<br />
</syntaxhighlight><br />
<br />
<nowiki>:</nowiki> or for normal http mode:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
  <port name='LsrcPort' binding='tns:LsrcBinding'><br />
<br />
   <soap:address location='http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php' /><br />
<br />
  </port><br />
<br />
</syntaxhighlight><br />
<br />
That's it! all request, response and fault messages will be transported over https...<br />
<br />
=How to use LSRC=<br />
<br />
==use the client==<br />
<br />
'''NOTE on PHP 5.3:''' setting the path2wsdl to http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl worked with all prior 5.3 version of PHP. With PHP 5.3 the client will not recognize the wsdl lsrc.server.php?wsdl gives back. You have to call lsrc.server.php?wsdl once to generate the lsrc.wsdl file and then point your client to http://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl instead.<br />
<br />
There is a PHPclient (from version 1.86) in the remotecontrol folder. You can use this ClientClass to control Limesurvey from within your PHP Applications with ease.<br />
<br />
Take a look at lsrc.testclient-new.php to get an impression of how it can be implemented.<br />
<br />
Basically you just have to include the class, prepare the Client and start the function calls.<br />
<br />
Example:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
<?php<br />
<br />
/**<br />
* include the client class<br />
*/<br />
<br />
include_once("lsrc.client.php");<br />
<br />
/**<br />
* initiate the testclient object<br />
*/<br />
<br />
$testclient = new lsrcClient();<br />
<br />
/**<br />
* prepare the lsrcClient class (initiate the soapClient, set sid if needed)<br />
*/<br />
<br />
$testclient->prepare(333);<br />
<br />
/**<br />
* set user and password (only needed, when not set in the client class directly)<br />
*/<br />
<br />
$testclient->user = 'admin';<br />
<br />
$testclient->pass = 'password';<br />
<br />
/**<br />
* set the path2wsdl (only needed, when not set in the client class directly)<br />
*/<br />
<br />
$testclient->path2wsdl = 'http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl';<br />
<br />
/**<br />
* call the function to create a survey<br />
*/<br />
<br />
$sReturn = $testclient->createSurvey("surveyName" ,<br />
<br />
                  "surveyDescription",<br />
<br />
                  "welcomeText",<br />
<br />
                  "endText",<br />
<br />
                  "surveyAdmins@email.adress",<br />
<br />
                  "Survey Adminsname",<br />
<br />
                  "http://an.end.url",<br />
<br />
                  "Description of End Url",<br />
<br />
                  "template138");<br />
<br />
echo $sReturn;<br />
<br />
</syntaxhighlight><br />
<br />
This Skript initiates the client. The parameter at prepare, sets the surveyId. In this case it means we are going to create the survey with the Id 333. If you do not give an id, the survey will get a random id.<br />
<br />
Next we set the user and password to use. You do not have to do this, as long as the inital values of the client are correct. But you may have to, if you build your app in a way, that different users use the client to create Surveys or edit them.<br />
<br />
In the end, the survey is created with the createSurvey Method and the return is echoed.<br />
<br />
==using the functions==<br />
<br />
You will need a SOAP- or at least RPC-Client to communicate with the LSRC Webservice. How to create such a Client depends on the programming language you use.<br />
<br />
The LSRC itself is written in PHP5 using the PHP:SOAP extension with SOAP 1.1.<br />
<br />
In PHP you would initiate the Client-object and call a function from the Webservice with code like e.g.:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
$wsdl="http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl";<br />
<br />
$client = new SoapClient($wsdl, array('soap_version' => SOAP_1_1,<br />
<br />
         'trace' => 1));<br />
<br />
try<br />
<br />
{<br />
<br />
  $sReturn = $client->sInsertToken($user, $pass, $iVid, $sToken);<br />
<br />
}<br />
<br />
catch (SoapFault $fault)<br />
<br />
{<br />
<br />
  $sOutput .= " <br/><br/>SOAP Error: ".$fault->faultcode." : ".$fault->faultstring;<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
The LSRC offers some functions:<br />
<br />
(<span style='color:#FF0000'>m</span>) means: Mandatory Parameter<br />
<br />
==sCreateSurvey==<br />
<br />
<span style='color:#FF0000'>Parameters changed after 1.81+! (sVend added)</span><br />
* String sCreateSurvey($sUser, $sPass, $iVid, $sVtit , $sVbes, $sVwel, $sVend, $sMail, $sName, $sUrl, $sUbes, $sVtyp )<br />
** '''Purpose''': Creates a new survey. It imports an exported survey from any LS v1.xx. and changes some fields (in the current Version it changes SurveyTitle, Â SurveyDescription and SurveyWelcomeText, adminemail, adminname, url and url_description to the string which was given by the client.)<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int $iVid, SurveyID desired ID for the Survey, make sure it doesn't already exist in LimeSurvey<br />
*** (<span style='color:#FF0000'>m</span>) string $sVtit, SurveyTitle, should be the (Nr +)Name of the Event to be evaluated<br />
*** (<span style='color:#FF0000'>m</span>) string $sVbes, Survey Description, This should be String put together with veransttyp + doztitle + dozname<br />
*** string $sVwel, Survey Welcometext, A text shown before the survey starts. If not given it says: "Herzlich Willkommen zur Evaluation von "$sVtit"<br />
*** string $sVend, Survey Endtext, Text shown at the endpage.<br />
*** string $sMail, Admin Email, Email Adress of the responsible person for this survey<br />
*** string $sName, Name of the responsible person for this survey<br />
*** string $sUrl, Url of the Link, shown on the last page of survey.<br />
*** string $sUbes, Description String of the URL above. ( <a href='$sUrl'>$sUbes</a> )<br />
*** string $sVtyp, The type of Event that should be evaluated. Use in combination with sAvailableModules with $mode='core' to get all available "types"<br />
** '''Returns''':<br />
*** if everything went fine, it returns the SurveyID from the created survey<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "SurveyID already exists");<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Server: ", "Import went wrong somehow");<br />
** '''Note''':<br />
*** Goto line 714 in lsrc.helper.php to see what can be done and customized while importing.<br />
*** If you want Limesurvey to give your Survey a random Number if the given ID exist (because you do not need a specific identification for your surveys), just go into the function sCreateSurvey in lsrc.server.php and delete or comment out the if($lsrcHelper->surveyExists($iVid)) clause. In Result, Limesurvey will give your survey a random ID when the given ID exists.<br />
<br />
==sActivateSurvey==<br />
* String '''sActivateSurvey'''(string USER, string PASSWORD, int SurveyID, date start, date end)<br />
** '''Purpose''': Activates an existing survey and set start and enddate optional<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID for the Survey to activate.<br />
*** date start, date for the Survey to start. 2008-10-22 means it starts exactly at 2008-10-22 00:00:00 Servertime<br />
*** date end, date for the Survey to end. 2008-10-22 means it ends exactly at 2008-10-22 23:59:59 Servertime. Nobody can access nor complete the Survey only a second later.<br />
** '''Returns''':<br />
*** if everything went fine, it returns the SurveyID from the activated survey<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "Survey you want to activate does not exists");<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Server: ", "Activation went wrong somehow");<br />
** '''Note''':<br />
*** You can set startDate and/or endDate after activation if needed. Just run the function again with desired parameters.<br />
<br />
==sImportGroup==<br />
* String '''sImportGroup'''(string USER, string PASSWORD, int SurveyID, String Module, String groupName, String groupDescription)<br />
** '''Purpose''': Imports an exported group file (.csv) to the Survey given by SurveyID<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** (<span style='color:#FF0000'>m</span>) string Module, the filename of the Group you want to add to the Survey. Use sAvailableModules to get the available groups.<br />
*** string groupName, the Title the Group gets. If not set, it will use the title given in the .csv.<br />
*** string groupDescription, Description of the group. If not set, it will use the description given in the .csv.<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "Import OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to change Surveys from other people");<br />
*** Â throw new SoapFault("Server: ", "Survey Module $sMod does not exist");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported groups as .csv which lay under \groups or any other dir given in lsrc.config.php<br />
*** <strike>It imports only the files beginning with "mod_" ending with ".csv"</strike><br />
*** The Param Module must only contain the "name of the Module": Only the String before ".csv"<br />
*** The baselanguage of the group to import, have to match the baselanguage of the coresurvey.<br />
<br />
==sImportQuestion==<br />
* String '''sImportQuestion'''(string USER, string PASSWORD, int SurveyID, String Module, String mandatory)<br />
** '''Purpose''': Imports an exported question file (.csv) to the last group of the Survey given by SurveyID. This is meant for predefined questions stored in the /question directory<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** (<span style='color:#FF0000'>m</span>) String Module, the name of the csv file you want to add to the Survey, without extension(.csv).<br />
*** String mandatory, default='N' set to 'Y' if you want that question mandatory<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to change Surveys from other people");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported questions as .csv which lay under \questions or any dir given in lsrc.config.php<br />
*** The baselanguage of the question to import, have to match the baselanguage of the core survey.<br />
<br />
==sImportFreetext==<br />
* String '''sImportFreetext'''(string USER, string PASSWORD, int SurveyID, String questionTitle, String questionText, String questionhelp, String module='freitext', string mandatory)<br />
** '''Purpose''': Imports an exported question file (.csv) to the last Group of the survey given by SurveyID and changes the Title, question and helptext. This is meant for importing empty question.csv's (Text Questions)<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** String questionTitle, Name or Categorie of the Question<br />
*** String questionText, The Question itself<br />
*** String questionhelp, A little Help text for better understanding of the Question<br />
*** String module, the name of the Module you want to add to the Survey. It should be "Freitext" by default.<br />
*** String mandatory, make the question mandatory by giving 'Y' as this param.<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to change Surveys from other people");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported questions as .csv which lay under \questions or any dir given in lsrc.config.php<br />
*** It is meant for importing one shortext, Longtext or Hugetext Question and changing the Question and Helptext.<br />
*** The baselanguage of the question to import, have to match the baselanguage of the core survey.<br />
*** Be sure to have at least one proper .csv (Freitext.csv) in the proper directory (questions), to use this function.<br />
*** Use sAvailableModules with mode='que' to get all question .csv's available.<br />
<br />
==sImportMatrix==<br />
* String '''sImportMatrix'''(string USER, string PASSWORD, int SurveyID, String Module, String questionText, String questionhelp, String questionItems)<br />
** '''Purpose''': Imports an exported question file (Matrix5.csv) to the Survey given by SurveyID and changes the question, helptext and gives Items to the 5 Scale Matrix. This is meant for importing one 5 Scale Matrix Question.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the SurveyID<br />
*** string Module, the name of the Module you want to add to the Survey. It should be "Matrix" by default.<br />
*** String questionText, the question or text to the Matrix<br />
*** String questionhelp, the help text<br />
*** String questionItems, the Items that should be rated, separated by commas<br />
** '''Returns''':<br />
*** if everything went fine, it returns the String "OK"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Server: ", "Group does not support Surveys Baselanguage ($langcode)");<br />
** '''Note''':<br />
*** It imports only exported groups as .csv which lay under docs\demosurveys\studiply_mod<br />
*** It is meant for importing a group with only one 5 Scale Matrix Question and changing the Question and Helptext and add Items.<br />
*** Be sure to use an user with the surveys baselanguage as default, because this language is used to fill the language fields for answers and questions while importing.<br />
<br />
==sAvailableModules==<br />
* String '''sAvailableModules'''(string USER, string PASSWORD, string mode)<br />
** '''Purpose''': Returning all the csv Names of the csv's in the Directorys configured in lsrc.config.php<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** String mode, (optional) "mod" for the available groups, "core" for the coreSurveys, "que" for addable questions. Default, when not given is "mod".<br />
** '''Returns''':<br />
*** if everything went fine, it returns a String with all surveys, groups or questions (depends on mode) in the Dir given in lsrc.config.php, separated by comma.<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
** '''Note''':<br />
<br />
==sSendEmail==<br />
* String sSendEmail($sUser, $sPass, $surveyID, $type, $maxLsrcEmails='', $subject='', $emailText='')<br />
** '''Purpose''': sends Emails to Participants of a particular survey<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Useraccount with appropriate rights<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
*** (<span style='color:#FF0000'>m</span>) int surveyID, Id of the survey from which participants will be mailed<br />
*** (<span style='color:#FF0000'>m</span>) string type, the kind of email you like to send (invite, remind or custom)<br />
*** int $maxLsrcEmails, if you want to override $maxemails setting in config.php for sending mails with lsrc: here you go.<br />
*** string subject, only needed if type==custom, the subject for the mail to be send.<br />
*** string emailText, only needed if type==custom, the text for the mail to be send.<br />
** '''Returns''':<br />
*** "X Mails send" or "No Mails to send" in custom mode.<br />
*** "X Mails send. X Mails left to send" or "No Mails to send" in invite mode.<br />
*** "X Reminders send. X Reminders left to send" or "No Reminders to send" in remind mode.<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Type: ", "Wrong send Type given. Possible types are: custom, invite or remind");<br />
** '''Note''':<br />
*** invite: When $maxemails is set the function sends only $maxemails in one go. If you call it again, it will go on to send the invitations, until everyone is invited.<br />
*** remind: When $maxemails is set, it will only send $maxemails in one go. It checks if reminders have been send to other participants and if there are participants who received less reminders than others, the script will first send reminders to those who have not been reminded so often, until the remindercount is equal.<br />
*** custom: $maxemails have no effect in custom mode. I have no solution for counting those who have been mailed before.<br />
<br />
==sInsertToken==<br />
* String '''sInsertToken'''(string USER, string PASSWORD, int SurveyID, string Token)<br />
** '''Purpose''': Creates and populates a table {dbprefix}token_{SurveyID} and thus "closes" the survey. It is possible to add tokens to the existing table.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, ID of the survey to close with a token table<br />
*** string Token, a string with comma separated tokens. There is a possibility to set any other separator in config.php. Max. tested length of a string was 500,000 tokens, that makes a String of 5,500,000 Chars, Â this is just the limit of the apache webserver on my notebook (CoreDuo 1,6MHz, 1GB Ram) with default Resource Limits (60,60,16). I recommend to send max. 100,000 tokens over the webservice. Repeat for more tokens.<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** if everything went ok, it returns the String: "[X] Token given, [X] Token inserted"<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Server: ", "Token could not be inserted");<br />
** '''Note''':<br />
*** Make sure on the client side that no token appears twice in the table. There is no check on this and won't be in the future. What happens if there are two same tokens? 2 participants will get the same token, one will fill out the form for both, and the other will get a message: "your token have already participated"<br />
*** If there is no token table, it will create one and add the tokens.<br />
*** If the Tokentable already exists, it just adds the given tokens to the existing table.<br />
<br />
==sInsertParticipants==<br />
* String '''sInsertParticipants'''(string USER, string PASSWORD, int SurveyID, string ParticipantData)<br />
** '''Purpose''': Creates and populates a table {dbprefix}token_{SurveyID} and thus "closes" the survey. You can deliver some data to the token table. If you do not support a token, or an empty String as token, a unique token will be generated for the participant.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, ID of the survey to close with a token table<br />
*** string ParticipantData, The Data have to be in the right Syntax, it's like this:<br />
<br />
<pre><br />
<br />
FIRSTNAME;LASTNAME;EMAIL;ATTRIB1;ATTRIB2;TOKEN::FIRSTNAME;LASTNAME;EMAIL;ATTRIB1;ATTRIB2;TOKEN<br />
<br />
</pre><br />
<br />
'''NOTE: The Data Syntax change with 1.86'''. in order to take language, validfrom, validuntil and a variable count of attributes.<br />
<br />
With 1.86 and later versions, it will have to be like this:<br />
<br />
<pre><br />
<br />
FIRSTNAME;LASTNAME;EMAIL;LANGUAGE;TOKEN;VALIDFROM;VALIDUNTIL;attribute1,attribute2,attribute3::FIRSTNAME ... etc.<br />
<br />
</pre><br />
<br />
note that the 8th field is the attributes field. There is no 9th field. You can seperate many attributes with a colon (,). The lsrc will create the needed fields in the db if they are not present. All Fields after LANGUAGE are optional and do not have to be send.<br />
<br />
seperate the Datasets with double colons (::) and the fields with semicolon (;). The '''attrib1, attrib2 and token fields are optional''', you can just leave them out if not used. Note that the attrib field will get empty and not NULL, by now there where no complications, inform us, if you see some difficulties in not setting them NULL. Max. successfully tested length of a string was 3,000,000 Chars, this is just the limit of the apache webserver on my notebook (CoreDuo 1,6MHz, 1GB Ram) with default Resource Limits (60,60,16). I recommend to send max. 10,000 Datasets over the webservice at once(~1,000,000 chars). Repeat for more Datasets.<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** if everything went ok, it returns the String: "[X] Datasets given, [X] rows inserted. ";<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Server: ", "No SurveyId given");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
** '''Note''':<br />
*** default tokenlength is 5 chars, if you want to change the length, goto lsrc.server.php, line 441<br />
*** If the token table does not exists, it will be created, and if it does, the data will be added.<br />
<br />
==sTokenReturn==<br />
* string return '''sTokenReturn'''(string USER, string PASSWORD, int SurveyID)<br />
** '''Purpose''': Gives back all Tokens, which did not complete the Survey, in a String seperated by commas.<br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the ID for the Survey from which you want get the unused tokens<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** Returns a String, a string of all unused tokens seperated by comma.<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Server: ", "No SurveyId given");<br />
*** Â throw new SoapFault("Database: ", "Token table for this Survey does not exists");<br />
*** Â throw new SoapFault("Database: ", "No unused Tokens found");<br />
<br />
==sGetFieldmap==<br />
* string return '''sGetFieldmap'''(string USER, string PASSWORD, int SurveyID)<br />
** '''Purpose''': Gives back the fieldmap for the survey<br />
<br />
for example:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
"fieldname","type","sid","gid","qid","aid","title","question","group_name","lid","lid1"<br />
<br />
"111X779X39801","F","111","779","3980","1","1","How do you feel?","Paticipant feelings","",""<br />
<br />
"111X779X39802","M","111","779","3980","2","1a","Why do you feel like this?","Paticipant feelings","",""<br />
<br />
[...]<br />
<br />
</syntaxhighlight><br />
** '''Parameters''':<br />
*** (<span style='color:#FF0000'>m</span>) int SurveyID, the ID for the Survey from which you want to get the Fieldmap.<br />
*** (<span style='color:#FF0000'>m</span>) string USER, this have to be an existing Admin-, Superadmin- or Useraccount with the rights to create and activate Surveys<br />
*** (<span style='color:#FF0000'>m</span>) string PASSWORD, this has to match the password for the account.<br />
** '''Returns''':<br />
*** Returns a String, a string of the fieldmap, seperated by comma and blanks<br />
** '''Possible Faults''':<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to get fieldmaps from other peoples Surveys");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Server: ", "No SurveyId given");<br />
<br />
==fSendStatistic==<br />
<br />
<span style='color:#FF0000'>''(since 1.86)''</span><br />
* '''fSendStatistic'''(string USER, string PASSWORD, int SurveyID, string Email, string doctype, string graph)<br />
** '''Purpose''': sends an Statistic File as Attachment<br />
** '''Parameters'''<br />
*** user: Limesurvey user<br />
*** password: Limesurvey Password<br />
*** surveyId: ID of the survey from which statistics should be generated<br />
*** email: the adress to which the statistic file is send<br />
*** doctype: pdf, xls or html. With pdf or xls, the recipient gets an attached file with a short notice. With html, he gets an html e-mail without attachments<br />
*** graph: turn graph generation on or off. Works only with pdf generation. Use '1' as a string if you want to enable it<br />
** '''returns'''<br />
*** string: 'XLS send'<br />
*** string: 'PDF send'<br />
*** string: 'HTML send'<br />
** '''possible Faults'''<br />
*** Â throw new SoapFault("Server: ", "Mandatory Parameters missing");<br />
*** Â throw new SoapFault("Authentication: ", "User or password wrong");<br />
*** Â throw new SoapFault("Authentication: ", "You have no right to send statistics from other peoples Surveys");<br />
*** Â throw new SoapFault("Database: ", "Survey does not exists");<br />
*** Â throw new SoapFault("Mail System", "Mail could not be send! Check your E-Mail Settings.");<br />
<br />
=Testing=<br />
<br />
For testing purposes, we made a testclient in php. Therefore you need a webserver to run it. If you test on one machine you need nothing to do, you can go to http://localhost/limesurvey/admin/lsrc/lsrc.testclient.php in your browser to test the webservices functionality.<br />
<br />
Of Course this is very boring, because the apache talks with himself (and thats not the matter of a webservice).<br />
<br />
The Testclient have two purposes:<br />
<br />
1. It checks the Server(the one the testclient is running on!) for the PHP:SOAP Extension and installed libXML version and gives feedback if the enviroment does support SOAP via PHP:SOAP. This is very useful to check your Server and your Client towards PHP:SOAP compatibility. In addition to this, it will check if the wsdl file you want to connect to exists, it does not validate the wsdl file.<br />
<br />
2. You can test the functions of the webservice.<br />
<br />
If you test the webservice in realistic enviroment (two machines) you have to customize three things<br />
* the lsrc.testclient.php needs to be on the machine where the webservice is NOT running, but it needs a webserver... download xampp from apachefriends if you dont have one <strike>(caution for Linux Users: you have to compile PHP5 with SOAP and enable the extension, futhermore you have to install libXML2. Last thing can by done very easy via Synaptics or apt-get)</strike> xampp for Linux works well with SOAP and libXML from version 1.7.<br />
* this Line:<br />
<br />
<syntaxhighlight lang="php" enclose="div"><br />
<br />
$limeUrl='https://localhost/limesource/limesurvey';<br />
<br />
</syntaxhighlight><br />
<br />
At the beginning of lsrc.testclient.php needs to fit the target Limesurvey Installation Dir. localhost for servername is always wrong in this testcase, 127.0.0.1, too.<br />
<br />
'''NOTES''':<br />
* The Testclient is configured to use "admin" "password" as authentication. If you want to test with another user or password you have to set this vars in lsrc.testclient.php ( lines 40 and 41)<br />
* If you just get a blank page on the testclient, make sure the path to the wsdl is correct, and the var $enableLsrc is set to true in config.php or lsrc.config.php<br />
<br />
=Notes=<br />
* Security is enhanced: no action without permission (as good as Limesurveys Security itself --> very good)<br />
* No headers or "Quick and Dirtys" anymore, no Scripts, just functions and a class.<br />
* All configuration Variables are stored in lsrc.config.php by now<br />
* There is a debug functionality, showing where the script runs through the code in an own log file. Use Apaches error.log in addition to find errors if you got any.<br />
* LSRC is part of LimeSurvey, therefore it stands under GNU/GPL License v2 or later.<br />
* SOAP Services and therefore LSRC only support UTF-8 charsets.<br />
* LSRC works with AdoDB (MySql,Postgresql, MSSQL) .<br />
* LSRC is tested, but under steady development, use on your own risk, test the functions before using them productively!<br />
<br />
=Changes=<br />
<br />
1.86<br />
* new function fSendStatistics: to send statistics as attachment to an e-mail-address<br />
* Datasyntax for sInsertParticipants changed in order to take validfrom, validuntil, language and a variable Set of attributes.<br />
<br />
1.85<br />
* Several improvements to stability.<br />
<br />
1.82<br />
* Added sVend Parameter to sCreateSurvey, to set the endtext<br />
* sInsertParticipants takes a token in the dataset, however, if non is supported, it will be generated.<br />
* a new variable $enableLsrc is introduced to enable the Lsrc only when it is used.<br />
* a serious exploit has been fixed.<br />
<br />
1.81<br />
* Added sGetFieldmap function.<br />
* The template.csv's changed.<br />
* exported csv's prior 1.81 will not import over lsrc anymore. Import them via Browser and export them back to lsrc.<br />
<br />
1.80 => 1.81<br />
* Changed sImportGroup: imports '''all''' groups under $modDir, adds them to the survey. Not only the ones with mod_ as prefix. In addition, you can give Name and Description of the Group.<br />
* New sImportQuestion: imports questions in $queDir and adds them to the last group<br />
* New sImportFreetext: imports a Freetext question and changes the title and question to the Strings given. Previously, this function was called sImportQuestion.<br />
* Changed sAvailableModules: type can be core, mod or que. "que" is new and gives back the names of all the questions available.<br />
* New sSendEmail: send invitations, reminders and custom mails to participants of a survey over Limesurvey.<br />
<br />
=ToDo / ToCome=<br />
* <strike>sInsertParticipants should take a lang attribute for each participant</strike><br />
<br />
please add your feature requests to the [http://bugs.limesurvey.org bugtracker] if it is not listed here...<br />
<br />
=Known Bugs (and workarounds)=<br />
* With PHP 5.3.0, the testclient have problems to read the generated wsdl from lsrc.server.php?wsdl. You have to generate it an use the static file to test it.<br />
* Surveys get not imported in 1.85, due to a bug. The bug is fixed and will be released with the next release. Talk to rakete if you need it earlier...<br />
* exported csv's prior 1.81 will not import over lsrc anymore. Import them via Browser and export them back to lsrc to get them work again. (attributes moved from survey to survey_languagesettings)<br />
* sInsertPaticipants and sInsertToken function: You should note, that in case of an Seperator at the beginning or the end of the Datastring, the return Message will recognize one more given Dataset or Token as inserted into the db...<br />
* There is a bug with Webservices in general: Sometimes (~ 1 of 10.000 Cases) you will get an error message like "function 'anyFunction' does not exist on the server" or similar, altough everything is fine. Just wait a few Moments, clear you cache, phone your mom (she will be happy to hear from you ;)) and try again.<br />
* Webservice will not work if the "install" dir is not renamed or deleted in limesurvey and $debug is not set to 2 -> "looks like we got no xml document" without errorlogs<br />
<br />
please add your bug report to the [http://bugs.limesurvey.org bugtracker] if you found an Issue that is not listed here.<br />
<br />
=Security=<br />
<br />
There have been a security hole in the versions prior 1.82 (1.80RC2 to 1.81+). This leak could be used to compromise your webspace if it is weakly configured.<br />
<br />
To minimise the risk of a security leak endanger your system, we disabled the lsrc by default with version 1.82 and you have to enable it explicity in your config.php.<br />
<br />
Some things you can do to improve your security when using the lsrc:<br />
* instead of setting the remotecontrol folder to 777, just create an empty file lsrc.wsdl with the rights 777<br />
* disable the lsrc.log in lsrc.config.php<br />
* Do not set the survey, groups, questions folders to 777 for saving lsrc templates directly within Limesurvey, instead, save the .csv on your local PC and upload them via ftp to the folders.<br />
* delete lsrc.testclient.php, when in productive use. Lsrc.testclient.php could be used from unauthorized people to perform portscanning on other machines. The attacked webserver would be seeing your webserver as attacker, altough you did not perform any attack by yourself. This is not so serious, as this bahaviour of the testclient is not much valuable for any serious hacker.</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Project_ideas_for_GSOC_2010&diff=2482Project ideas for GSOC 20102010-03-19T10:49:21Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Welcome=<br />
<br />
Welcome Google Summer of Code Student aspirants (:razz:)!! Please check if you are an [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs#student_eligibility eligible candidate] for the GSoC program.<br />
<br />
This page lists project ideas developed by the LimeSurvey Community. These tend to be areas that will get the most support as projects since they have been developed by people who know the project and what it needs the most. '''However''', if you have your own idea for a project discuss your awesome idea with us in our [http://www.limesurvey.org/component/option,com_fireboard/Itemid,105/func,view/catid,11/id,24710/lang,en/ forums], [https://lists.sourceforge.net/lists/listinfo/limesurvey-developers mailing list] or at #limesurvey on irc.freenode.net. Then submit '''your''' proposal. Good Luck (:biggrin:)<br />
<br />
=Project ideas=<br />
<br />
==Example Format...==<br />
<br />
Describe the idea here in general terms<br />
<br />
'''Skills'''<br />
<br />
Explain what sort of coding skills would be needed for a student to implement this project<br />
<br />
'''Difficulty'''<br />
<br />
Explain the level of difficulty involved<br />
<br />
'''Probable Mentors'''<br />
<br />
Put your name (and tag) here if you are willing to mentor a student for this idea<br />
<br />
==LimeSurvey 1: File Upload question type==<br />
<br />
The idea is to have a question type in LimeSurvey1 where survey participants can upload one (or more) files. Often in surveys the participant is asked to create some content (pictures, movies, documents, etc.)  to upload as an answer to a question. The following goals are  primary in this task:<br />
*Easy handling for the participant (uploading one or more files should be a piece of cake - also removing files if accidentally the wrong file was uploaded)<br />
*Extensive configuration options for the question type like<br />
**How many files are required, minimum and maxim number of files,<br />
**maximum/minimum upload size,<br />
**Allowed file types<br />
*Safe!! storage in the file system, checks for file contents<br />
*Implementation in statistics / data entry / printable survey / response browsing / response editing & RemoteControl<br />
*Administrator can download one or more files (zip-packaging files for download) from one response and across responses<br />
*Provide possible hooks for third party processing tools<br />
<br />
'''Skills'''<br />
<br />
PHP, jQuery, AJAX - existing knowledge on the general idea and related security would be of big advantage<br />
<br />
'''Difficulty'''<br />
<br />
Medium<br />
<br />
'''Probable Mentors'''<br />
<br />
c_schmitz (Carsten Schmitz)<br />
<br />
==LimeSurvey 1: Authentication framework==<br />
<br />
The idea is to design and implement a generic authentication framework for LimeSurvey 1 as well as some authentication modules. The Authentication framework will make it possible to implement any kind of authentication backend apart from the already existing internal-DB and Web server delegation schemes. Currently authentication is only used for the survey-administration GUI and not the participants interface (tokens are used for this). With the new authentication framework it will be possible to define several authentication backends and use some of them for participants-authentication.<br />
<br />
The generic authentication framework must define the following services:<br />
* User authentication: this interface must return the identity of the authenticated user if authentication is successful.<br />
** Authentication may not always be based on a simple user/password form, so the proposed framework must be generic enough to enable authentication based on other schemes (using any numbers or GET/POST parameters or any other contextual parameter such as Referrer, session variable...<br />
* User provisionning:<br />
** when activated on the survey administration interface, an authentication module might be able to create a newly authenticated user into the LimeSurvey internal DB (which is required for setting the user rights on the platform). The newly created user can be assigned a default profile or a per-user profile (queried from an external database).<br />
** when activated on the participants interface, the authentication module will provision the token table of the correspoding survey (only if the token for this user has not been already added).<br />
<br />
The already existing authentication schemes will be ported to the new framework (internal-DB and Web server authentication delegation) and at least a new one will be implemented (openID, CAS, Shibboleth).<br />
<br />
'''Skills'''<br />
<br />
PHP, SQL, Authentication protocols (openID, CAS, LDAP-bind, ...)<br />
<br />
'''Difficulty'''<br />
<br />
Medium<br />
<br />
'''Probable Mentors'''<br />
<br />
lemeur (Thibault Le Meur)<br />
<br />
==LimeSurvey 2: Db Storage Engine==<br />
<br />
Develop an extensible plugin survey storage engine for LimeSurvey 2.<br />
<br />
<u>Description</u><br />
<br />
Other than survey design, everything that happens in LimeSurvey centres around the ability to save responses to questions to a database, and retrieve the responses again when required. Historically these functions have been incorporated within the various functions of LimeSurvey and this has locked LimeSurvey to a single methodology for data storage and retrieval and made future modifications and improvements difficult if not possible.<br />
<br />
For this project we are looking for students to write a 'middleware' that exposes abstract high-level functions to LimeSurvey 2 (e.g.: storing these answers related to this question, running statistical analysis etc.) but is built in top of Cake's 'low-level' operations (such as find, save etc). The aim is to abstract away from a specific DB implementation and provide an intuitive and rich API for LS2.<br />
<br />
<u>Rationale</u><br />
<br />
Because the interface with the data storage system is so critical to practically every other function in LimeSurvey we want to develop a stand-alone module that is transportable and extensible for the future. And by keeping the logic of data and survey storage separate from the rest of LimeSurvey&rsquo;s functions we will the ease with which LimeSurvey can be developed in the long term.<br />
<br />
<u>Implementation</u><br />
<br />
This is such an important project that we would consider multiple students undertaking the task. In conjunction with a strong understanding of data structures, php coding and api principles the students would also have to display a capacity to work in a team and with the broader community.<br />
<br />
The implementation would focus on becoming a plugin/addon module under CakePHP which uses the default CakePHP database systems to the absolute minimum. In a well implemented version of this proposal only simple SQL inserts, queries and updates would be required. All other logic would be managed by the engine.<br />
<br />
<u>Requirements & Considerations</u><br />
<br />
The DB Engine must be able to do the following<br />
* ease development of additional '''question types, which will be developed as plugins'''<br />
* '''efficient data retrieval''', especially summaries (e.g. display 100 last responses)<br />
* support '''generic''' data storage and retrieval - aside surveys, imagine running online admission tests, polls, sign-up forms, volunteer campaign etc. etc.<br />
* easily support conditions, looped question, or generally, '''non-linear data'''. Think of a survey that asks how many children you have and then asks information about each of them.<br />
* support questions that have multiple '''answers and multiple types of answers'''. Think of a question asking "What is your favourite ice cream?", offering 3 fixed options and last one allowing user to enter a custom answer.<br />
* support survey resuming (where applicable)<br />
<br />
<u>Field Naming and Database Extensibility Methodologies</u><br />
<br />
An ongoing debate in the LimeSurvey community has been the method in which the database stores survey results. In LimeSurvey 1 a flat database schema was used whereby once the survey designer had finished setting up the survey a database table was created with a field for every individual question/answer combination. The advantages of this database schema were speed of retrieval for reporting and exporting and searching. The disadvantages were that the survey system had to &lsquo;freeze&rsquo; the structure in place once the table was created (therefore the activate/de-activate rules in LimeSurvey 1). The single table method doesn&rsquo;t allow easy storage of metadata for individual question/answer combinations (such as timestamps). Nor does it lend itself to surveys with enormous quantities of question/answer combinations &ndash; sometimes running up against database limitations regarding the number of fields per table.<br />
<br />
An alternative is a &lsquo;normalised&rsquo; database topology where a single table is created to store all survey responses &ndash; one database row per question/answer combination. A related table would store metadata that is directly related to the survey sitting/session rather than the answer (e.g.: username, ip address, geographical location, user demographic). The advantage to this methodology is the increased flexibility (extensible) which would allow modification of surveys at any stage even after data has been collected (see requirements). The disadvantages are that searching and compilation of data is complicated and resource intensive.<br />
<br />
In a perfect world LimeSurvey would allow users to choose either methodology &ndash; either at an installation level or even on a per-survey level.<br />
<br />
Having a database storage engine effectively acting as an API would allow this functionality to be built, but the choice of database topology would be invisible to the related LimeSurvey functions that require data.<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, Database Schema Design, Sound knowledge of Algorithms and Data Structures<br />
<br />
'''Difficulty'''<br />
<br />
High<br />
<br />
'''Probable Mentors'''<br />
<br />
jasebo (Jason Cleeland)<br />
<br />
macduy (Mac Duy Hai)<br />
<br />
==LimeSurvey 2: Template Editor==<br />
<br />
Limesurvey 2 needs a nice and powerful template editor so everyone can create a template which matches their requirements.<br />
<br />
'''Skills'''<br />
<br />
One needs to know about the details of the [http://dwoo.org/ dwoo template engine] which is used at LS2. There is some cakePHP coding needed to create an interface and write changes to the template files as well as some HTML/CSS to create a nice interface.<br />
<br />
'''Difficulty'''<br />
<br />
You don't have to create difficult algorithms for this task. It's useful if you have worked with templates for another web-application or take a detailled look at [http://docs.limesurvey.org/tiki-index.php?page=Themes%3A+Templates+and+Styles&structure;=English+Instructions+for+LimeSurvey how templates work in Limesurvey]. Some design/usability background would be nice but is not a must.<br />
<br />
'''Probable Mentors'''<br />
<br />
Mazi<br />
<br />
==LimeSurvey 2: Mini-projects==<br />
<br />
Mini-projects is a collection of small-to-medium sized projects, which you mix-and-match according to your tastes. Heck, you can even roll your own idea and once reviewed and approved, you can code away. Some recommended/important mini-projects and their brief descriptions:<br />
*'''Smarter installer:''' LS2.0 comes with its own installer, though it may not be the friendliest to use. Your task is to make it juicier to use:<br />
** Resume installation - if the user aborts the installation mid-way, make it easy for him to resume it<br />
** Better error handling - meaningful error reports, suggestions how to fix them: e.g. "Database does not exist" is better than "Database error"<br />
** Customization - invite the user to customize his installation of LimeSurvey - from security settings such as salt, to interface such as the header title.<br />
*'''User management:''' When the number of users grow, it becomes increasingly harder to manage them. Implement functionality and provide interface for features that would make this task easier. Inspire yourself by the big players, such as the infamous you-know-which-one social website.<br />
**'''Groups within groups:''' LS2 users can belong to a group, but groups cannot belong to other groups.<br />
**'''Contact lists:''' There is already something called AssignmentGroups. Study this concept carefully and generalize to a Contact List<br />
**'''GUI:''' Design a GUI which allows you easily manage users, groups and contact lists.<br />
**'''Searching:''' Provide an efficient but simple-to-use search interface and functionality<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, JavaScript & jQuery<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
'''Probable Mentors'''<br />
<br />
Mac Duy Hai (macduy)<br />
<br />
==LimeSurvey 2: Template/Theme Editor==<br />
<br />
The idea is to develop a theme / template framework similar to one in jquery [http://jqueryui.com/themeroller/ | Jquery Theme Roller] and thus making the UI design of the surveys easier.The current template editor is based on dwoo template engine which actually loads the files exposing the css etc for us to edit, which of course require some skill set to proceed. Using this template editor we can make everything UI based and thus requiring no developer skills to edit the templates.<br />
<br />
The overview of the modules can be seen here:<br />
<br />
[[File:theme_roller.png]]<br />
<br />
It&rsquo;ll be implemented using Jquery to use the more advanced UI experiences.(:biggrin:)<br />
<br />
The following mock-up will give us a better view:<br />
<br />
Moderate[[File:theme_editor_small.png]]<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, CSS, AJAX, JavaScript & jQuery.<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
==LimeSurvey 2: Lime Survey Social - Facebook Application==<br />
<br />
The idea aims at developing a Facebook app which gives a social touch to LS 2.0. The application will be integrated in several Facebook integration points like News Feed, Applications boxes, Wall etc so that the user participation will be more. Adding a social touch can drive us more user participation and increase the popularity. The ability to control the Facebook app can be provided in the LS2.0 Admin Dashboard and also in the FB user application window with varied options.<br />
<br />
The facebook has the following modules (we can add more. This is primary draft.)<br />
*All Survey related core features. (Create, Edit, Delete, Administer etc)<br />
*Gain reward points.<br />
*Use reward points to create more surveys.<br />
*Spread the surveys ...... and more<br />
<br />
The idea can be extended to other social networks<br />
<br />
[[File:fb_overview.png]]<br />
<br />
The mock-ups :<br />
<br />
[[File:facebook app.png]]<br />
<br />
[[File:canvas.png]]<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, Facebook API.<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
==LimeSurvey 2: Integration of Poll Questions==<br />
<br />
Polls are one of the most popular and quick response getting tools once can use. Implementing polls in LS 2.0 will be an added advantage. Since every one of us know what polls are about, this idea focuses on the implementation part.<br />
<br />
The idea is to integrate the ability to create a POLL Module in Admin dashboard, where he can administer (Create | Edit | Delete | View Responses etc) the Polls.We can even get feedback &ldquo;about the survey&rdquo; at the end on how the user feels by creating a custom poll (we can even redirect the user to this poll).<br />
*Chat Bots and Polls: An another idea is to create chat bots so that whenever we create a poll, all the friends (who added the bot) of that bot will be pinged by the question followed by options. Getting an answer is very easy (Bot friends just need to type a single letter stating the answer) and its a push model which ensures the delivery to everyone (even offline).We can even extend this to deliver certain type of surveys question by question through the bot.<br />
<br />
A simple mock-up for this:<br />
<br />
[[File:chat.png]]<br />
*Alternate Solution: An alternate solution provided by Mazi is clubbing this idea with the Facebook app idea. Instead of porting parts of the admin backend to facebook or other social networks we'll have options in Admin panel to "publish as: common survey |mobile device survey | facebook poll | homepage poll | Â ... etc " Everything will be put together at the usualm admin backend but you can choose which way(s) you want publish your survey.<br />
<br />
We can further extend this idea by giving additional options to publish as widgets for websites and blogs etc.<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, XMPP Protocol (Knowledge of developing bots), Knowledge of Polls.<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
==LimeSurvey 2: Survey Community Project==<br />
<br />
Build a system for LS2 that connects to a central repository of survey resources, such as demographic questions, answer styles and templates. Integrating with a login system, allow LimeSurvey users to easily publish their work to a community resource or use other published works from the same location.<br />
<br />
For many finding already written question texts, or standardised demographic questions would really simplify their use of a survey tool. LimeSurvey could leverage on the community spirit of an open source product and encourage users to share their own work. By integrating a "Publish to the LimeSurvey Library" button in the administration system with questions, or templates, or anything else that can be shared, LimeSurvey could develop a library of tools that simplifies Survey Creation even further.<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, Web and User Interface Design Skills<br />
<br />
'''Difficulty'''<br />
<br />
Moderate<br />
<br />
'''Probable Mentors'''<br />
<br />
Jason Cleeland (jasebo)<br />
<br />
==LimeSurvey 2: Condition Engine==<br />
<br />
[[File:addNewCondition1.png]]<br />
<br />
Build a system for LS2 that will let survey administrators design, store and evaluate conditions. Conditions can be used in several features such as question branching (survey logic), assessments, quotas, ...<br />
<br />
This projects will at least end up with:<br />
* A working GUI to design complex conditions:<br />
** several atomic conditions can be combined by AND or OR logical operators and will support for grouping conditions with parentheses<br />
** an atomic condition representation can be<br />
<br />
<syntaxhighlight lang="php" enclose="div"><left operand> <operator> <right operand></syntaxhighlight><br />
** an atomic condition editor will implement<br />
*** several operators (equality, inequality, string-comparisons, numerical-comparisons, regexp),...<br />
*** meta operators surch as 'Not displayed'<br />
** left and right operands can be answers from previous questions, or a static values. It should be extensible so that we are able in the future to use more complex operand such as the result of a specific function (for instance the sum of some previous integer questions)<br />
* A working DB storage backend using a string in [http://en.wikipedia.org/wiki/Reverse_Polish_Notation RPN] (Reverse Polish Notation) to describe each condition<br />
* A first version of the evaluation of conditions for the question branching feature. This part will require interaction with other parts of the projects (Survey Engine, and DB engine).<br />
<br />
'''Skills'''<br />
<br />
PHP, CakePHP, JQuery and User Interface Design Skills<br />
<br />
'''Difficulty'''<br />
<br />
High<br />
<br />
'''Probable Mentors'''<br />
<br />
Thibault Le Meur (lemeur)<br />
<br />
=We want your ideas!=<br />
<br />
What floats your boat? Do you have another idea that gets you excited? Discuss your ideas in our [http://www.limesurvey.org/component/option,com_fireboard/Itemid,105/func,view/catid,11/id,24710/lang,en/ forums], [https://lists.sourceforge.net/lists/listinfo/limesurvey-developers mailing lists] or at #limesurvey on irc.freenode.net.<br />
<br />
=More Information=<br />
<br />
==LimeSurvey Google's Summer of Code 2009==<br />
*[http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2009 Limesurvey GSoC 2009]<br />
<br />
An introduction to LimeSurvey and our application for this years Google Summer of Code<br />
<br />
==Getting Started==<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started How to get started with LimeSurvey's GSoC 2009]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
==Frequently Asked Questions==<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google's Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_GSoC_2010&diff=2007LimeSurvey GSoC 20102010-03-16T00:54:56Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code 2010=<br />
<br />
LimeSurvey is applying to be involved in the Google Summer of Code for 2010<br />
<br />
=General Information=<br />
<br />
Google has been continuously supporting Open Source Projects and students coming together since 2005 through its ''Google Summer of Code Programs''. GSoC 2010 has been announced and is On!<br />
<br />
LimeSurvey was accepted as a mentoring organisation for the first time in 2009, and is hopeful and excited about he opportunity to participate again in 2010. We plan to give students an excellent environment and platform to '''learn''' and most importantly to have '''fun''' (:lol:)!<br />
<br />
The LimeSurvey community, at the same time, will benefit by students' participation and fresh eyes and ideas.<br />
<br />
Find out more about our program in 2010 at [http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2010&structure;=LimeSurvey+Development LimeSurvey GSoC 2010]<br />
<br />
==Google Summer of Code Program Information==<br />
<br />
Google Summer of Code is a great program both for Open Source organizations like LimeSurvey as well as students because it gives a platform where several tasks on Open Source Projects are done by students and students in return get a stipend from Google.<br />
<br />
There's a lot more information available in Google's Summer of Code [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs FAQ] and [http://code.google.com/p/google-summer-of-code/ Knowledge Base]. You can also join #gsoc on irc.freenode.net to get feedback or ask questions about Google Summer of Code in real time.<br />
<br />
The timelineline can be found [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs#timeline here].<br />
<br />
==LimeSurvey Specific Information==<br />
<br />
Welcome to the LimeSurvey Community (:biggrin:). LimeSurvey is an open source survey engine that allows people to create and deploy surveys (from marketing to academic to engineering applications). LimeSurvey is written in PHP and used by many high profile organizations including [https://wiki.ubuntu.com/ServerTeam '''Ubuntu Server Team'''], [http://foundation.gnome.org/ '''GNOME Foundation'''] and [http://www.vorarlberg.at/ '''Office of the Austrian Vorarlberg State Government''']<br />
<br />
Limesurvey is loved and used by many Universities, Students, Medical Institutes, non-profit organisations, marketing companies and more around the world. In the 2004 '''U.S. presidential election''', the [http://www.verifiedvoting.org/article.php?id=5207 '''Verified Voting Foundation'''] used PHPSurveyor (as LimeSurvey was then known) to gather data about voting irregularities. Sourceforge provide LimeSurvey as a free application for open source projects. LimeSurvey keeps turning up in new places.<br />
<br />
It's loved because it is free, flexible and constantly improving. It's constantly improving because it has a dedicated and committed team of developers who love the challenge and satisfaction of using and building such a tool.<br />
<br />
LimeSurvey is widely used. It has been directly downloaded from Sourceforge over '''130,000 times''' in the last 12 months alone, and is also distributed as a package in the '''Ubuntu Linux Distribution''', and included as a pre-installed application in many standard Web Hosting packages (such as '''Fantastico''').<br />
<br />
LimeSurvey is recognised as a leader in its field. On November 29, 2007 LimeSurvey won the '''1st prize award''' at the [http://www.trophees-du-libre.org/index.php?lang=en '''Les Troph&eacute;es du Libre'''] contest in the category Corporate Management. In 2008 LimeSurvey was nominated in the category Best Project for the Enterprise in the SourceForge.net '''Community Choice Awards 2008'''. LimeSurvey was succesful in being selected as a mentoring organisation for the Google Summer of Code in 2009.<br />
<br />
LimeSurvey is the biggest, most active and most exciting open source online survey project, and we're building on our success by creating a whole new version of the tool.<br />
<br />
LimeSurvey Version 2 is a whole new - built from the ground-up - version that will revolutionise online survey design and use.<br />
<br />
More importantly, it's a perfect opportunity for a GSoC student like yourself to get involved early in a project that has a strong history and an even stronger future. Our community is welcoming and fun. One of our students from 2009 has now become the project lead for LimeSurvey 2. It's a classic case of the student becoming a master!<br />
<br />
==GSoC Student Aspirants==<br />
<br />
Please visit our [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and see if any idea interests you. If you have an idea of your own, then develop it. If any idea excites you, and you want to implement that feature during the summer of 2010, see how you can [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started get started] on it. Come and join us on the IRC channel on freenode (#limesurvey) and talk about what you want to do.<br />
<br />
==LimeSurvey Mentors==<br />
<br />
The following mentors are willing to Mentor students during Google Summer of Code 2010 program.<br />
<br />
Others who are willing to mentor can write their name and details below along with the Idea they are willing to mentor. '''Potential Mentors, please do not forget to put your ideas on the [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and contact [mailto:jason@cleeland.org| program administrator]'''<br />
<br />
{|<br />
|<center>'''Mentor Name'''</center>||<center>'''Nick'''</center>||<center>'''Idea'''</center><br />
|-<br />
|<center>Jason Cleeland</center>||<center>jasebo</center>||<center>Database Storage Engine</center><br />
|-<br />
|<center>Carsten Schmitz</center>||<center>c_schmitz</center>||<center>File upload question type in LimeSurvey 1</center><br />
|-<br />
|<center>Marcel Minke</center> <center>[http://docs.limesurvey.org/tiki-index.php?page=UserPage Mazi||Mazi]</center>||<center>Template editor?</center><br />
|-<br />
|<center>Mac Duy Hai</center>||<center>[[UserPage macduy||macduy]]</center>||<center>Database Storage Engine, Mini-projects</center><br />
|-<br />
|<center>Thibault Le Meur</center>||<center>lemeur</center>||<center>Condition Engine</center><br />
|-<br />
|<br />
|}<br />
<br />
==More Information==<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_GSoC_2010&diff=2015LimeSurvey GSoC 20102010-02-18T00:19:00Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code 2010=<br />
<br />
LimeSurvey is applying to be involved in the Google Summer of Code for 2010<br />
<br />
=General Information=<br />
<br />
Google has been continuously supporting Open Source Projects and students coming together since 2005 through its ''Google Summer of Code Programs''. GSoC 2010 has been announced and is On!<br />
<br />
LimeSurvey was accepted as a mentoring organisation for the first time in 2009, and is hopeful and excited about he opportunity to participate again in 2010. We plan to give students an excellent environment and platform to '''learn''' and most importantly to have '''fun''' (:lol:)!<br />
<br />
The LimeSurvey community, at the same time, will benefit by students' participation and fresh eyes and ideas.<br />
<br />
Find out more about our program in 2010 at [http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2010&structure;=LimeSurvey+Development LimeSurvey GSoC 2010]<br />
<br />
==Google Summer of Code Program Information==<br />
<br />
Google Summer of Code is a great program both for Open Source organizations like LimeSurvey as well as students because it gives a platform where several tasks on Open Source Projects are done by students and students in return get a stipend from Google.<br />
<br />
There's a lot more information available in Google's Summer of Code [http://code.google.com/opensource/gsoc/2009/faqs.html FAQ] and [http://code.google.com/p/google-summer-of-code/ Knowledge Base]. You can also join #gsoc on irc.freenode.net to get feedback or ask questions about Google Summer of Code in real time.<br />
<br />
==LimeSurvey Specific Information==<br />
<br />
Welcome to the LimeSurvey Community (:biggrin:). LimeSurvey is an open source survey engine that allows people to create and deploy surveys (from marketing to academic to engineering applications). LimeSurvey is written in PHP and used by many high profile organizations including [https://wiki.ubuntu.com/ServerTeam '''Ubuntu Server Team'''], [http://foundation.gnome.org/ '''GNOME Foundation'''] and [http://www.vorarlberg.at/ '''Office of the Austrian Vorarlberg State Government''']<br />
<br />
Limesurvey is loved and used by many Universities, Students, Medical Institutes, non-profit organisations, marketing companies and more around the world. In the 2004 '''U.S. presidential election''', the [http://www.verifiedvoting.org/article.php?id=5207 '''Verified Voting Foundation'''] used PHPSurveyor (as LimeSurvey was then known) to gather data about voting irregularities. Sourceforge provide LimeSurvey as a free application for open source projects. LimeSurvey keeps turning up in new places.<br />
<br />
It's loved because it is free, flexible and constantly improving. It's constantly improving because it has a dedicated and committed team of developers who love the challenge and satisfaction of using and building such a tool.<br />
<br />
LimeSurvey is widely used. It has been directly downloaded from Sourceforge over '''130,000 times''' in the last 12 months alone, and is also distributed as a package in the '''Ubuntu Linux Distribution''', and included as a pre-installed application in many standard Web Hosting packages (such as '''Fantastico''').<br />
<br />
LimeSurvey is recognised as a leader in its field. On November 29, 2007 LimeSurvey won the '''1st prize award''' at the [http://www.trophees-du-libre.org/index.php?lang=en '''Les Troph&eacute;es du Libre'''] contest in the category Corporate Management. In 2008 LimeSurvey was nominated in the category Best Project for the Enterprise in the SourceForge.net '''Community Choice Awards 2008'''. LimeSurvey was succesful in being selected as a mentoring organisation for the Google Summer of Code in 2009.<br />
<br />
LimeSurvey is the biggest, most active and most exciting open source online survey project, and we're building on our success by creating a whole new version of the tool.<br />
<br />
LimeSurvey Version 2 is a whole new - built from the ground-up - version that will revolutionise online survey design and use.<br />
<br />
More importantly, it's a perfect opportunity for a GSoC student like yourself to get involved early in a project that has a strong history and an even stronger future. Our community is welcoming and fun. One of our students from 2009 has now become the project lead for LimeSurvey 2. It's a classic case of the student becoming a master!<br />
<br />
==GSoC Student Aspirants==<br />
<br />
Please visit our [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and see if any idea interests you. If you have an idea of your own, then develop it. If any idea excites you, and you want to implement that feature during the summer of 2009, see how you can [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started get started] on it. Come and join us on the IRC channel on freenode (#limesurvey) and talk about what you want to do.<br />
<br />
==LimeSurvey Mentors==<br />
<br />
The following mentors are willing to Mentor students during Google Summer of Code 2010 program.<br />
<br />
Others who are willing to mentor can write their name and details below along with the Idea they are willing to mentor. '''Potential Mentors, please do not forget to put your ideas on the [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and contact [mailto:jason@cleeland.org| program administrator]'''<br />
<br />
{|<br />
|<center>'''Mentor Name'''</center>||<center>'''Nick'''</center>||<center>'''Idea'''</center><br />
|-<br />
|<center>Jason Cleeland</center>||<center>jasebo</center>||<center>Currently Thinking About It</center><br />
|-<br />
|<center>Carsten Schmitz</center>||<center>c_schmitz</center>||<center>Thinking About New Ideas</center><br />
|}<br />
<br />
==More Information==<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_GSoC_2010&diff=2016LimeSurvey GSoC 20102010-02-18T00:18:37Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code 2010=<br />
<br />
LimeSurvey is applying to be involved in the Google Summer of Code for 2010<br />
<br />
=General Information=<br />
<br />
Google has been continuously supporting Open Source Projects and students coming together since 2005 through its ''Google Summer of Code Programs''. GSoC 2010 has been announced and is On!<br />
<br />
LimeSurvey was accepted as a mentoring organisation for the first time in 2009, and is hopeful and excited about he opportunity to participate again in 2010. We plan to give students an excellent environment and platform to '''learn''' and most importantly to have '''fun''' (:lol:)!<br />
<br />
The LimeSurvey community, at the same time, will benefit by students' participation and fresh eyes and ideas.<br />
<br />
Find out more about our program in 2010 at [http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2010&structure;=LimeSurvey+Development LimeSurvey GSoC 2010]<br />
<br />
==Google Summer of Code Program Information==<br />
<br />
Google Summer of Code is a great program both for Open Source organizations like LimeSurvey as well as students because it gives a platform where several tasks on Open Source Projects are done by students and students in return get a stipend from Google.<br />
<br />
There's a lot more information available in Google's Summer of Code [http://code.google.com/opensource/gsoc/2009/faqs.html FAQ] and [http://code.google.com/p/google-summer-of-code/ Knowledge Base]. You can also join #gsoc on irc.freenode.net to get feedback or ask questions about Google Summer of Code in real time.<br />
<br />
==LimeSurvey Specific Information==<br />
<br />
Welcome to the LimeSurvey Community (:biggrin:). LimeSurvey is an open source survey engine that allows people to create and deploy surveys (from marketing to academic to engineering applications). LimeSurvey is written in PHP and used by many high profile organizations including [https://wiki.ubuntu.com/ServerTeam '''Ubuntu Server Team'''], [http://foundation.gnome.org/ '''GNOME Foundation'''] and [http://www.vorarlberg.at/ '''Office of the Austrian Vorarlberg State Government''']<br />
<br />
Limesurvey is loved and used by many Universities, Students, Medical Institutes, non-profit organisations, marketing companies and more around the world. In the 2004 '''U.S. presidential election''', the [http://www.verifiedvoting.org/article.php?id=5207 '''Verified Voting Foundation'''] used PHPSurveyor (as LimeSurvey was then known) to gather data about voting irregularities. Sourceforge provide LimeSurvey as a free application for open source projects. LimeSurvey keeps turning up in new places.<br />
<br />
It's loved because it is free, flexible and constantly improving. It's constantly improving because it has a dedicated and committed team of developers who love the challenge and satisfaction of using and building such a tool.<br />
<br />
LimeSurvey is widely used. It has been directly downloaded from Sourceforge over '''130,000 times''' in the last 12 months alone, and is also distributed as a package in the '''Ubuntu Linux Distribution''', and included as a pre-installed application in many standard Web Hosting packages (such as '''Fantastico''').<br />
<br />
LimeSurvey is recognised as a leader in its field. On November 29, 2007 LimeSurvey won the '''1st prize award''' at the [http://www.trophees-du-libre.org/index.php?lang=en '''Les Troph&eacute;es du Libre'''] contest in the category Corporate Management. In 2008 LimeSurvey was nominated in the category Best Project for the Enterprise in the SourceForge.net '''Community Choice Awards 2008'''. LimeSurvey was succesful in being selected as a mentoring organisation for the Google Summer of Code in 2009.<br />
<br />
LimeSurvey is the biggest, most active and most exciting open source online survey project, and we're building on our success by creating a whole new version of the tool.<br />
<br />
LimeSurvey Version 2 is a whole new - built from the ground-up - version that will revolutionise online survey design and use.<br />
<br />
More importantly, it's a perfect opportunity for a GSoC student like yourself to get involved early in a project that has a strong history and an even stronger future. Our community is welcoming and fun. One of our students from 2009 has now become the project lead for LimeSurvey 2. It's a classic case of the student becoming a master!<br />
<br />
==GSoC Student Aspirants==<br />
<br />
Please visit our [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and see if any idea interests you. If you have an idea of your own, then develop it. If any idea excites you, and you want to implement that feature during the summer of 2009, see how you can [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started get started] on it. Come and join us on the IRC channel on freenode (#limesurvey) and talk about what you want to do.<br />
<br />
==LimeSurvey Mentors==<br />
<br />
The following mentors are willing to Mentor students during Google Summer of Code 2010 program.<br />
<br />
Others who are willing to mentor can write their name and details below along with the Idea they are willing to mentor. '''Potential Mentors, please do not forget to put your ideas on the [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2009 ideas page] and contact [mailto:jason@cleeland.org| program administrator]'''<br />
<br />
{|<br />
|<center>'''Mentor Name'''</center>||<center>'''Nick'''</center>||<center>'''Idea'''</center><br />
|-<br />
|<center>Jason Cleeland</center>||<center>jasebo</center>||<center>Currently Thinking About It</center><br />
|-<br />
|<center>Carsten Schmitz</center>||<center>c_schmitz</center>||<center>Thinking About New Ideas</center><br />
|}<br />
<br />
==More Information==<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_GSoC_2010&diff=2017LimeSurvey GSoC 20102010-02-17T23:43:54Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code 2010=<br />
<br />
LimeSurvey is applying to be involved in the Google Summer of Code for 2010<br />
<br />
=General Information=<br />
<br />
Google has been continuously supporting Open Source Projects and students coming together since 2005 through its ''Google Summer of Code Programs''. GSoC 2010 has been announced and is On!<br />
<br />
LimeSurvey was accepted as a mentoring organisation for the first time in 2009, and is hopeful and excited about he opportunity to participate again in 2010. We plan to give students an excellent environment and platform to '''learn''' and most importantly to have '''fun''' (:lol:)!<br />
<br />
The LimeSurvey community, at the same time, will benefit by students' participation and fresh eyes and ideas.<br />
<br />
Find out more about our program in 2010 at [http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2010&structure;=LimeSurvey+Development LimeSurvey GSoC 2010]<br />
<br />
==Google Summer of Code Program Information==<br />
<br />
Google Summer of Code is a great program both for Open Source organizations like LimeSurvey as well as students because it gives a platform where several tasks on Open Source Projects are done by students and students in return get a stipend from Google.<br />
<br />
There's a lot more information available in Google's Summer of Code [http://code.google.com/opensource/gsoc/2009/faqs.html FAQ] and [http://code.google.com/p/google-summer-of-code/ Knowledge Base]. You can also join #gsoc on irc.freenode.net to get feedback or ask questions about Google Summer of Code in real time.<br />
<br />
==LimeSurvey Specific Information==<br />
<br />
Welcome to the LimeSurvey Community (:biggrin:). LimeSurvey is an open source survey engine that allows people to create and deploy surveys (from marketing to academic to engineering applications). LimeSurvey is written in PHP and used by many high profile organizations including [https://wiki.ubuntu.com/ServerTeam '''Ubuntu Server Team'''], [http://foundation.gnome.org/ '''GNOME Foundation'''] and [http://www.vorarlberg.at/ '''Office of the Austrian Vorarlberg State Government''']<br />
<br />
Limesurvey is loved and used by many Universities, Students, Medical Institutes, non-profit organisations, marketing companies and more around the world. In the 2004 '''U.S. presidential election''', the [http://www.verifiedvoting.org/article.php?id=5207 '''Verified Voting Foundation'''] used PHPSurveyor (as LimeSurvey was then known) to gather data about voting irregularities. Sourceforge provide LimeSurvey as a free application for open source projects. LimeSurvey keeps turning up in new places.<br />
<br />
It's loved because it is free, flexible and constantly improving. It's constantly improving because it has a dedicated and committed team of developers who love the challenge and satisfaction of using and building such a tool.<br />
<br />
LimeSurvey is widely used. It has been downloaded from Sourceforge over '''100,000 times''' in the last year, and is included as a package in the '''Ubuntu Linux Distribution''', as well as being included as a pre-installed application in many standard Web Hosting packages (such as '''Fantastico''').<br />
<br />
LimeSurvey is recognised as a leader in its field. On November 29, 2007 LimeSurvey won the '''1st prize award''' at the [http://www.trophees-du-libre.org/index.php?lang=en '''Les Troph&eacute;es du Libre'''] contest in the category Corporate Management. In 2008 LimeSurvey was nominated in the category Best Project for the Enterprise in the SourceForge.net '''Community Choice Awards 2008'''.<br />
<br />
LimeSurvey is the biggest, most active and most exciting open source online survey project, and we're building on our success by creating a whole new version of the tool.<br />
<br />
LimeSurvey Version 2 is a whole new - built from the ground-up - version that will revolutionise online survey design and use.<br />
<br />
More importantly, it's a perfect opportunity for a GSoC student like yourself to get involved early in a project that has a strong history and an even stronger future. Our community is welcoming and fun. One of our students from 2009 has now become the project lead for LimeSurvey 2. It's a classic case of the student becoming a master!<br />
<br />
==GSoC Student Aspirants==<br />
<br />
Please visit our [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and see if any idea interests you. If you have an idea of your own, then develop it. If any idea excites you, and you want to implement that feature during the summer of 2009, see how you can [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started get started] on it. Come and join us on the IRC channel on freenode (#limesurvey) and talk about what you want to do.<br />
<br />
==LimeSurvey Mentors==<br />
<br />
The following mentors are willing to Mentor students during Google Summer of Code 2010 program.<br />
<br />
Others who are willing to mentor can write their name and details below along with the Idea they are willing to mentor. '''Potential Mentors, please do not forget to put your ideas on the [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2009 ideas page] and contact [mailto:jason@cleeland.org| program administrator]'''<br />
<br />
{|<br />
|<center>'''Mentor Name'''</center>||<center>'''Nick'''</center>||<center>'''Idea'''</center><br />
|-<br />
|<center>Jason Cleeland</center>||<center>jasebo</center>||<center>Currently Thinking About It</center><br />
|-<br />
|<center>Carsten Schmitz</center>||<center>c_schmitz</center>||<center>Thinking About New Ideas</center><br />
|}<br />
<br />
==More Information==<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_GSoC_2010&diff=2018LimeSurvey GSoC 20102010-02-17T23:43:16Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code 2010=<br />
<br />
LimeSurvey is applying to be involved in the Google Summer of Code for 2010<br />
<br />
=General Information=<br />
<br />
Google has been continuously supporting Open Source Projects and students coming together since 2005 through its ''Google Summer of Code Programs''. GSoC 2010 has been announced and is On!<br />
<br />
LimeSurvey was accepted as a mentoring organisation for the first time in 2009, and is hopeful and excited about he opportunity to participate again in 2010. We plan to give students an excellent environment and platform to '''learn''' and most importantly to have '''fun''' (:lol:)!<br />
<br />
The LimeSurvey community, at the same time, will benefit by students' participation and fresh eyes and ideas.<br />
<br />
Find out more about our program in 2009 at [http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2009&structure;=LimeSurvey+Development LimeSurvey GSoC 2009]<br />
<br />
==Google Summer of Code Program Information==<br />
<br />
Google Summer of Code is a great program both for Open Source organizations like LimeSurvey as well as students because it gives a platform where several tasks on Open Source Projects are done by students and students in return get a stipend from Google.<br />
<br />
There's a lot more information available in Google's Summer of Code [http://code.google.com/opensource/gsoc/2009/faqs.html FAQ] and [http://code.google.com/p/google-summer-of-code/ Knowledge Base]. You can also join #gsoc on irc.freenode.net to get feedback or ask questions about Google Summer of Code in real time.<br />
<br />
==LimeSurvey Specific Information==<br />
<br />
Welcome to the LimeSurvey Community (:biggrin:). LimeSurvey is an open source survey engine that allows people to create and deploy surveys (from marketing to academic to engineering applications). LimeSurvey is written in PHP and used by many high profile organizations including [https://wiki.ubuntu.com/ServerTeam '''Ubuntu Server Team'''], [http://foundation.gnome.org/ '''GNOME Foundation'''] and [http://www.vorarlberg.at/ '''Office of the Austrian Vorarlberg State Government''']<br />
<br />
Limesurvey is loved and used by many Universities, Students, Medical Institutes, non-profit organisations, marketing companies and more around the world. In the 2004 '''U.S. presidential election''', the [http://www.verifiedvoting.org/article.php?id=5207 '''Verified Voting Foundation'''] used PHPSurveyor (as LimeSurvey was then known) to gather data about voting irregularities. Sourceforge provide LimeSurvey as a free application for open source projects. LimeSurvey keeps turning up in new places.<br />
<br />
It's loved because it is free, flexible and constantly improving. It's constantly improving because it has a dedicated and committed team of developers who love the challenge and satisfaction of using and building such a tool.<br />
<br />
LimeSurvey is widely used. It has been downloaded from Sourceforge over '''100,000 times''' in the last year, and is included as a package in the '''Ubuntu Linux Distribution''', as well as being included as a pre-installed application in many standard Web Hosting packages (such as '''Fantastico''').<br />
<br />
LimeSurvey is recognised as a leader in its field. On November 29, 2007 LimeSurvey won the '''1st prize award''' at the [http://www.trophees-du-libre.org/index.php?lang=en '''Les Troph&eacute;es du Libre'''] contest in the category Corporate Management. In 2008 LimeSurvey was nominated in the category Best Project for the Enterprise in the SourceForge.net '''Community Choice Awards 2008'''.<br />
<br />
LimeSurvey is the biggest, most active and most exciting open source online survey project, and we're building on our success by creating a whole new version of the tool.<br />
<br />
LimeSurvey Version 2 is a whole new - built from the ground-up - version that will revolutionise online survey design and use.<br />
<br />
More importantly, it's a perfect opportunity for a GSoC student like yourself to get involved early in a project that has a strong history and an even stronger future. Our community is welcoming and fun. One of our students from 2009 has now become the project lead for LimeSurvey 2. It's a classic case of the student becoming a master!<br />
<br />
==GSoC Student Aspirants==<br />
<br />
Please visit our [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 ideas page] and see if any idea interests you. If you have an idea of your own, then develop it. If any idea excites you, and you want to implement that feature during the summer of 2009, see how you can [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started get started] on it. Come and join us on the IRC channel on freenode (#limesurvey) and talk about what you want to do.<br />
<br />
==LimeSurvey Mentors==<br />
<br />
The following mentors are willing to Mentor students during Google Summer of Code 2010 program.<br />
<br />
Others who are willing to mentor can write their name and details below along with the Idea they are willing to mentor. '''Potential Mentors, please do not forget to put your ideas on the [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2009 ideas page] and contact [mailto:jason@cleeland.org| program administrator]'''<br />
<br />
{|<br />
|<center>'''Mentor Name'''</center>||<center>'''Nick'''</center>||<center>'''Idea'''</center><br />
|-<br />
|<center>Jason Cleeland</center>||<center>jasebo</center>||<center>Currently Thinking About It</center><br />
|-<br />
|<center>Carsten Schmitz</center>||<center>c_schmitz</center>||<center>Thinking About New Ideas</center><br />
|}<br />
<br />
==More Information==<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2010 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_GSoC_2009&diff=1998LimeSurvey GSoC 20092009-10-24T17:04:03Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code 2009=<br />
<br />
This year LimeSurvey is hosting three Google Summer of Code students.<br />
<br />
=='''[[Google Summer of Code 2009 - Wrapup]]'''==<br />
<br />
=='''[[UserPage macduy|Mac Duy Hai]]''' (macduy)- '''[[GSOC09 dashboard project]]'''==<br />
* Mentors: [[UserPage c_schmitz|Carsten Schmitz]] (c_schmitz), [[UserPage cwittenb|Carsten Wittenberg]] (cwittenb)<br />
<br />
'''Title:'''LimeSurvey2 Dashboards for Administrators<br />
<br />
'''Abstract:''' Aim of the project is to create a widget-based customisable dashboard for LimeSurvey2 administrators, allowing them to get an overview of any information inside LimeSurvey2. The widgets, from which the dashboard is constructed from, will be customizable, interactive, reusable and have a consistent design (see mockup: http://www.flickr.com/photos/macduy/3401513176/)<br />
<br />
=='''[[UserPage dqminh|Dao Quang Minh]]''' (dqminh)- '''[[GSOC09 statistics project]]'''==<br />
* Mentors: [[UserPage jcleeland|Jason Cleeland]] (jasebo), [[UserPage Mazi|Marcel Minke]] (Mazi)<br />
<br />
'''Title:''' Survey Statistics Module<br />
<br />
'''Abstract:''' Limesurvey is a tool for data collection and not a tool for data analysis. A general overview is very helpful for users who don't want to use expensive tools for data evaluation.<br />
* Extend the question type plugins so they can deliver methods for computing a result summary<br />
* Create a report generator so users can put together their own reports with their own graphs or let a wizard do it<br />
* Establish filter properties so user can filter results to a certain scope<br />
<br />
=LimeSurvey Summer of Code (Google Summer of Code Associated Projects)=<br />
<br />
The following students are completing their proposals although not formally part of the Google Summer of Code project. In all other respects, they are working to the same guidelines and rules. LimeSurvey welcomes and thanks them.<br />
<br />
=='''[[UserPage honglianglv|Hongliang Lv]]''' (honglianglv) - '''LSOC09[[Web Service Project]]'''==<br />
<br />
'''Title''': Create a web service Interface<br />
<br />
'''Abstract:''' We like to have web service interfaces in LimeSurvey 2. This gets very handy if you want to connect other Programms with LimeSurvey. Especially if they are not written in PHP. If the Interface could support REST messages in addition to SOAP. The interface would be wider accepted by other developers and potential users. And the Results API can be also thought as a web service!<br />
<br />
=General Information=<br />
<br />
Google has been continuously supporting Open Source Projects and students coming together since 2005 through its ''Google Summer of Code Programs''. GSoC 2009 has been announced and is On!<br />
<br />
LimeSurvey is excited about our participation in the program and have been accepted as mentoring organization for the '''Google Summer of Code 2009'''. We'll give students an excellent environment and platform to '''learn''' and most importantly to have '''fun''' (:lol:)!<br />
<br />
The LimeSurvey community, at the same time, will benefit by students' participation and fresh eyes and ideas.<br />
<br />
==Google Summer of Code Program Information==<br />
<br />
[[File:2009socwithlogo.gif]]<br />
<br />
Google Summer of Code is a great program both for Open Source organizations like LimeSurvey as well as students because it gives a platform where several tasks on Open Source Projects are done by students and students in return get paid by Google.<br />
<br />
There's a lot more information available in Google's Summer of Code [http://code.google.com/opensource/gsoc/2009/faqs.html FAQ] and [http://code.google.com/p/google-summer-of-code/ Knowledge Base]. You can also join #gsoc on irc.freenode.net to get feedback or ask questions about Google Summer of Code in real time.<br />
<br />
==LimeSurvey Specific Information==<br />
<br />
Welcome to the LimeSurvey Community (:biggrin:). LimeSurvey is an open source survey engine that allows people to create and deploy surveys (from marketing to academic to engineering applications). LimeSurvey is written in PHP and used by many high profile organizations including [https://wiki.ubuntu.com/ServerTeam '''Ubuntu Server Team'''], [http://foundation.gnome.org/ '''GNOME Foundation'''] and [http://www.vorarlberg.at/ '''Office of the Austrian Vorarlberg State Government''']<br />
<br />
Limesurvey is loved and used by many Universities, Students, Medical Institutes, non-profit organisations, marketing companies and more around the world. In the 2004 '''U.S. presidential election''', the [http://www.verifiedvoting.org/article.php?id=5207 '''Verified Voting Foundation'''] used PHPSurveyor (as LimeSurvey was then known) to gather data about voting irregularities. Sourceforge provide LimeSurvey as a free application for open source projects. LimeSurvey keeps turning up in new places.<br />
<br />
It's loved because it is free, flexible and constantly improving. It's constantly improving because it has a dedicated and committed team of developers who love the challenge and satisfaction of using and building such a tool.<br />
<br />
LimeSurvey is widely used. It has been downloaded from Sourceforge over '''100,000 times''' in the last year, and is included as a package in the '''Ubuntu Linux Distribution''', as well as being included as a pre-installed application in many standard Web Hosting packages (such as '''Fantastico''').<br />
<br />
LimeSurvey is recognised as a leader in its field. On November 29, 2007 LimeSurvey won the '''1st prize award''' at the [http://www.trophees-du-libre.org/index.php?lang=en '''Les Troph&eacute;es du Libre'''] contest in the category Corporate Management. In 2008 LimeSurvey was nominated in the category Best Project for the Enterprise in the SourceForge.net '''Community Choice Awards 2008'''.<br />
<br />
LimeSurvey is the biggest, most active and most exciting open source online survey project, and we're building on our success by creating a whole new version of the tool.<br />
<br />
LimeSurvey Version 2 is a whole new - built from the ground-up - version that will revolutionise online survey design and use.<br />
<br />
More importantly, it's a perfect opportunity for a GSoC Jedi like yourself to get involved early in a project that has a strong history and an even stronger future.<br />
<br />
==GSoC Student Aspirants==<br />
<br />
Please visit our [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2009 ideas page] and see if any idea interests you. If any idea excites you, and you want to implement that feature during the summer of 2009, see how you can [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started get started] on it.<br />
<br />
==LimeSurvey Mentors==<br />
<br />
The following mentors are willing to Mentor students during Google Summer of Code 2009 program.<br />
<br />
Others who are willing to mentor can write their name and details below along with the Idea they are willing to mentor. '''Potential Mentors, please do not forget to put your ideas on the [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2009 ideas page] and contact [mailto:jason@cleeland.org| program administrator]'''<br />
<br />
{|<br />
|<center>'''Mentor Name'''</center>||<center>'''Nick'''</center>||<center>'''Idea'''</center><br />
|-<br />
|<center>Thibault Le Meur</center>||<center>lemeur</center>||<center>Condition Handling, Authorization API</center><br />
|-<br />
|<center>Jason Cleeland</center>||<center>jasebo</center>||<center>Condition Handling, Statistics, Results API, Question Type</center><br />
|-<br />
|<center>Carsten Schmitz</center>||<center>c_schmitz</center>||<center>Statistics, Dashboard, Question type, Multilingual Surveys </center><br />
|-<br />
|<center>Carsten Wittenberg</center>||<center>cwittenb</center>||<center>Interface Design</center><br />
|-<br />
|<center>Marcel Minke</center>||<center>Mazi</center>||<center>LimeSurvey Offline with Google Gears</center><br />
|-<br />
|<center>Josef Prandstetter</center>||<center>ElMatador69</center>||<center>LimeSurvey Offline with Google Gears</center><br />
|-<br />
|<center>Tim Wahrendorff</center>||<center>rakete</center>||<center>Webservice Interface</center><br />
|}<br />
<br />
==More Information==<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2009 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]<br />
<br />
===Death by Survey===<br />
* [Death by Survey]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Google_Summer_of_Code_2009_-_Wrapup&diff=1400Google Summer of Code 2009 - Wrapup2009-09-11T01:57:46Z<p>Jcleeland: </p>
<hr />
<div><br />
'''Google&rsquo;s Summer of Code 2009 at LimeSurvey'''<br />
<br />
LimeSurvey was chosen in 2009 to participate in the Google Summer of Code program. It was our first experience at the program and so we approached it with a huge deal of excitement, trepidation and hopeful anticipation. The timing was particularly good as it allowed us to put some additional impetus into the development of our second generation version of LimeSurvey, which is being built from the ground up and represents a large jump from the initial version.<br />
<br />
We received around 50 applications from students with development proposals for LimeSurvey 2. Ultimately Google offered to fund 3 placements, which we duly filled with our 3 best student applications. While one of our students did not complete the placement, we rate the years involvement in GSoC as an outstanding success and we&rsquo;re very pleased with the outcomes both in terms of code development and the introduction of new developers to the project team.<br />
<br />
Our two successfully completed projects were:<br />
<br />
'''Mac Duy Hai&rsquo;s Dashboard Project'''<br />
<br />
This project aimed to create a widget-based customisable dashboard for LimeSurvey2 administrators, allowing them to get an overview of any information inside LimeSurvey2. The widgets, from which the dashboard is constructed from, would be customizable, interactive, reusable and have a consistent design.<br />
<br />
Here is a screenshot of Hai&rsquo;s finished work<br />
<br />
[[File:macduyhai.png]]<br />
<br />
One of the main criticisms of LimeSurvey version 1 has been the administrative interface. Hai's great work on the administrative dashboard will serve LimeSurvey 2 development well for years to come.<br />
<br />
'''(Daniel) Dao Quanh Minh&rsquo;s Statistics Project'''<br />
<br />
This project aimed to make the statistics module as functional as (or richer in terms of functionalities and usabiltities than) LimeSurvey 1.x. The new statistic module would also support question type developers and enable them to customize what attributes should be used for statistical report.<br />
<br />
Daniel&rsquo;s project ran into some hurdles from the beginning, as Daniel discovered various limitations in the existing question modules. Showing great initiative, he was able to recognise the importance of the question module/structure to the rest of the project and worked on this area for the first term. Daniel was able to bring his project back on track in the second semester, and although the full scope of the original proposal wasn&rsquo;t met, he was able to meet the revised targets with aplomb. Daniel has provided LimeSurvey 2 with the fundamental statistics structure that was originally envisaged and this will be of great advantage to our future development.<br />
<br />
'''Lessons Learned'''<br />
<br />
As a first timer in GSoC, we faced a very steep learning curve this year &ndash; and it&rsquo;s probable that we weren&rsquo;t able to perform as well as possible as a result. There is not a lot in the way of guidelines for new organisations, and so we managed the best we could.<br />
<br />
What worked very well for us was requiring our students to report regularly to our weekly developer meetings. Emails to the developer group were not as frequent as I would have liked, and this is something I will emphasise in future years. The smaller number of the development team who have been actively involved in coding our new version also meant that there probably wasn't as much of a sounding board for the students as they would have liked. This problem will resolve itself over the next year or so as development and developers move into version 2.<br />
<br />
Our students were very active in our IRC channel and our online forums, and I think this really helped them get a good grounding in the wider LimeSurvey community.<br />
<br />
LimeSurvey is hugely grateful to both Google for sponsoring this wonderful event, and to our students.<br />
<br />
Our students have remained active with the project since completion, and Hai is taking an ongoing development role in LimeSurvey 2.</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=LimeSurvey_GSoC_2009&diff=1999LimeSurvey GSoC 20092009-09-08T23:38:48Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code 2009=<br />
<br />
This year LimeSurvey is hosting three Google Summer of Code students.<br />
<br />
=='''[[Google Summer of Code 2009 - Wrapup]]'''==<br />
<br />
=='''[[UserPage macduy|Mac Duy Hai]]''' (macduy)- '''[[GSOC09 dashboard project]]'''==<br />
* Mentors: [[UserPage c_schmitz|Carsten Schmitz]] (c_schmitz), [[UserPage cwittenb|Carsten Wittenberg]] (cwittenb)<br />
<br />
'''Title:'''LimeSurvey2 Dashboards for Administrators<br />
<br />
'''Abstract:''' Aim of the project is to create a widget-based customisable dashboard for LimeSurvey2 administrators, allowing them to get an overview of any information inside LimeSurvey2. The widgets, from which the dashboard is constructed from, will be customizable, interactive, reusable and have a consistent design (see mockup: http://www.flickr.com/photos/macduy/3401513176/)<br />
<br />
=='''[[UserPage dqminh|Dao Quang Minh]]''' (dqminh)- '''[[GSOC09 statistics project]]'''==<br />
* Mentors: [[UserPage jcleeland|Jason Cleeland]] (jasebo), [[UserPage Mazi|Marcel Minke]] (Mazi)<br />
<br />
'''Title:''' Survey Statistics Module<br />
<br />
'''Abstract:''' Limesurvey is a tool for data collection and not a tool for data analysis. A general overview is very helpful for users who don't want to use expensive tools for data evaluation.<br />
* Extend the question type plugins so they can deliver methods for computing a result summary<br />
* Create a report generator so users can put together their own reports with their own graphs or let a wizard do it<br />
* Establish filter properties so user can filter results to a certain scope<br />
<br />
=LimeSurvey Summer of Code (Google Summer of Code Associated Projects)=<br />
<br />
The following students are completing their proposals although not formally part of the Google Summer of Code project. In all other respects, they are working to the same guidelines and rules. LimeSurvey welcomes and thanks them.<br />
<br />
=='''[[UserPage honglianglv|Hongliang Lv]]''' (honglianglv) - '''LSOC09[[Web Service Project]]'''==<br />
<br />
'''Title''': Create a web service Interface<br />
<br />
'''Abstract:''' We like to have web service interfaces in LimeSurvey 2. This gets very handy if you want to connect other Programms with LimeSurvey. Especially if they are not written in PHP. If the Interface could support REST messages in addition to SOAP. The interface would be wider accepted by other developers and potential users. And the Results API can be also thought as a web service!<br />
<br />
=General Information=<br />
<br />
Google has been continuously supporting Open Source Projects and students coming together since 2005 through its ''Google Summer of Code Programs''. GSoC 2009 has been announced and is On!<br />
<br />
LimeSurvey is excited about our participation in the program and have been accepted as mentoring organization for the '''Google Summer of Code 2009'''. We'll give students an excellent environment and platform to '''learn''' and most importantly to have '''fun''' (:lol:)!<br />
<br />
The LimeSurvey community, at the same time, will benefit by students' participation and fresh eyes and ideas.<br />
<br />
==Google Summer of Code Program Information==<br />
<br />
[[File:2009socwithlogo.gif]]<br />
<br />
Google Summer of Code is a great program both for Open Source organizations like LimeSurvey as well as students because it gives a platform where several tasks on Open Source Projects are done by students and students in return get paid by Google.<br />
<br />
There's a lot more information available in Google's Summer of Code [http://code.google.com/opensource/gsoc/2009/faqs.html FAQ] and [http://code.google.com/p/google-summer-of-code/ Knowledge Base]. You can also join #gsoc on irc.freenode.net to get feedback or ask questions about Google Summer of Code in real time.<br />
<br />
==LimeSurvey Specific Information==<br />
<br />
Welcome to the LimeSurvey Community (:biggrin:). LimeSurvey is an open source survey engine that allows people to create and deploy surveys (from marketing to academic to engineering applications). LimeSurvey is written in PHP and used by many high profile organizations including [https://wiki.ubuntu.com/ServerTeam '''Ubuntu Server Team'''], [http://foundation.gnome.org/ '''GNOME Foundation'''] and [http://www.vorarlberg.at/ '''Office of the Austrian Vorarlberg State Government''']<br />
<br />
Limesurvey is loved and used by many Universities, Students, Medical Institutes, non-profit organisations, marketing companies and more around the world. In the 2004 '''U.S. presidential election''', the [http://www.verifiedvoting.org/article.php?id=5207 '''Verified Voting Foundation'''] used PHPSurveyor (as LimeSurvey was then known) to gather data about voting irregularities. Sourceforge provide LimeSurvey as a free application for open source projects. LimeSurvey keeps turning up in new places.<br />
<br />
It's loved because it is free, flexible and constantly improving. It's constantly improving because it has a dedicated and committed team of developers who love the challenge and satisfaction of using and building such a tool.<br />
<br />
LimeSurvey is widely used. It has been downloaded from Sourceforge over '''100,000 times''' in the last year, and is included as a package in the '''Ubuntu Linux Distribution''', as well as being included as a pre-installed application in many standard Web Hosting packages (such as '''Fantastico''').<br />
<br />
LimeSurvey is recognised as a leader in its field. On November 29, 2007 LimeSurvey won the '''1st prize award''' at the [http://www.trophees-du-libre.org/index.php?lang=en '''Les Troph&eacute;es du Libre'''] contest in the category Corporate Management. In 2008 LimeSurvey was nominated in the category Best Project for the Enterprise in the SourceForge.net '''Community Choice Awards 2008'''.<br />
<br />
LimeSurvey is the biggest, most active and most exciting open source online survey project, and we're building on our success by creating a whole new version of the tool.<br />
<br />
LimeSurvey Version 2 is a whole new - built from the ground-up - version that will revolutionise online survey design and use.<br />
<br />
More importantly, it's a perfect opportunity for a GSoC Jedi like yourself to get involved early in a project that has a strong history and an even stronger future.<br />
<br />
==GSoC Student Aspirants==<br />
<br />
Please visit our [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2009 ideas page] and see if any idea interests you. If any idea excites you, and you want to implement that feature during the summer of 2009, see how you can [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started get started] on it.<br />
<br />
==LimeSurvey Mentors==<br />
<br />
The following mentors are willing to Mentor students during Google Summer of Code 2009 program.<br />
<br />
Others who are willing to mentor can write their name and details below along with the Idea they are willing to mentor. '''Potential Mentors, please do not forget to put your ideas on the [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2009 ideas page] and contact [mailto:jason@cleeland.org| program administrator]'''<br />
<br />
{|<br />
|<center>'''Mentor Name'''</center>||<center>'''Nick'''</center>||<center>'''Idea'''</center><br />
|-<br />
|<center>Thibault Le Meur</center>||<center>lemeur</center>||<center>Condition Handling, Authorization API</center><br />
|-<br />
|<center>Jason Cleeland</center>||<center>jasebo</center>||<center>Condition Handling, Statistics, Results API, Question Type</center><br />
|-<br />
|<center>Carsten Schmitz</center>||<center>c_schmitz</center>||<center>Statistics, Dashboard, Question type, Multilingual Surveys </center><br />
|-<br />
|<center>Carsten Wittenberg</center>||<center>cwittenb</center>||<center>Interface Design</center><br />
|-<br />
|<center>Marcel Minke</center>||<center>Mazi</center>||<center>LimeSurvey Offline with Google Gears</center><br />
|-<br />
|<center>Josef Prandstetter</center>||<center>ElMatador69</center>||<center>LimeSurvey Offline with Google Gears</center><br />
|-<br />
|<center>Tim Wahrendorff</center>||<center>rakete</center>||<center>Webservice Interface</center><br />
|}<br />
<br />
==More Information==<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2009 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=GSoC_selection_criteria&diff=1432GSoC selection criteria2009-03-15T00:07:49Z<p>Jcleeland: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Google Summer of Code Selection Criteria for LimeSurvey=<br />
<br />
LimeSurvey will choose applicants that interest us the most, and we will be using the following criteria when coming to a final decision. Given the limited number of places we will have available, it is important to us to choose carefully.<br />
<br />
Please note that the final decision of the LimeSurvey Mentoring Organisation is final and not negotiable; these guidelines are to help you when determining and framing your application.<br />
<br />
==What we are looking for?==<br />
* Functionality<br />
<br />
Our current focus for LimeSurvey 2 is to achieve a basic level of functionality as an online survey tool. Version 1.8 has a large number of features, and LimeSurvey 2 needs to match version 1 in order to be a logical upgrade path for 1.8 users.<br />
<br />
Students who propose ideas that will improve the basic feature set of LimeSurvey 2 will be high on our list of priorities.<br />
* Originality or Clarity<br />
<br />
LimeSurvey 2 needs to be as feature rich as LimeSurvey 1, but it's the beginning of a new phase for LimeSurvey. Original ideas will count during the selection process. Where an idea is not original, clarity will be an equivalent alternative. If an application shows a clear and definitive understanding of its purpose and place within LimeSurvey, we'll be interested.<br />
* Achievability<br />
<br />
We need to be convinced that you're capable of achieving the idea that you propose.<br />
<br />
As part of your application make sure that you think carefully about milestones and deliverables. When we assess your application we'll be looking at these carefully to see if we think they are measurable and achievable. An application with clearly defined milestones that help us understand that path the student intends to take to finish the project will have an advantage over an application with unclear or uncertain milestones.<br />
* Realism<br />
<br />
Coding projects take time, and this is a 2 month window. Your project needs to be something that can be completed in 2 months. If we think your idea is not realistically achievable, we're not likely to take it on.<br />
* Ability<br />
<br />
To feel confident that you can achieve your proposal, we'll need to feel confident in your abilities. Tell us about your experience and/or skills with PHP, CakePHP, javascript and jQuery. Give us some examples of projects you've completed, or participated in before.<br />
* Communication<br />
<br />
We need to feel confident that you'll be a good communicator during the course of your project.<br />
<br />
==What we are not looking for?==<br />
<br />
We're pretty open to ideas, but since LimeSurvey 2 is a complete rebuild of a fully functioning version 1, naturally we're going to be more interested in proposals that build core functionality. If you have a great idea that's a little out of left-wing, feel free to propose it, but it'll probably need to be outstandingly brilliant to push aside core feature proposals.<br />
<br />
What we're not looking for are applications that are short, show little effort, and do not indicate a serious and real desire to contribute to the LimeSurvey Open Source Project.<br />
<br />
==References==<br />
*[http://inkscape.org/wiki/index.php/SOC_Selection_Criteria Selection Criteria]<br />
<br />
==More Information==<br />
<br />
===LimeSurvey Google Summer of Code 2009===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=Limesurvey+GSoC+2009 Limesurvey GSoC 2009]<br />
<br />
An introduction to LimeSurvey and our application for this years Google Summer of Code<br />
<br />
===Project Ideas Page===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2+Project+Ideas+for+GSOC+2009 GSoC Ideas Page]<br />
<br />
The LimeSurvey Community Ideas Page:<br />
<br />
- ideas that the community have come up with and would love to help you create<br />
<br />
===Getting Started===<br />
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started GSoC Getting Started]<br />
<br />
How to Get Started With LimeSurvey:<br />
<br />
- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!<br />
<br />
===Frequently Asked Questions===<br />
* [http://socghop.appspot.com/document/show/program/google/gsoc2009/faqs Google Summer of Code Faqs]<br />
* [http://docs.limesurvey.org/tiki-index.php?page=GSoC_Faqs LimeSurvey's GSoC Faqs]</div>Jcleelandhttps://www.limesurvey.org/manual/index.php?title=Open_Design_Manifesto&diff=2255Open Design Manifesto2008-08-29T03:23:32Z<p>Jcleeland: </p>
<hr />
<div><br />
OPEN DESIGN MANIFESTO FOR LIMESURVEY 2<br />
<br />
1. Concentrate on your special sauce<br />
<br />
95% of a product is non-differentiating. 5% is the special sauce.<br />
<br />
Don&rsquo;t reinvent the 95%. Concentrate on the 5%.<br />
<br />
2. Build community without destroying individualism<br />
<br />
The user&rsquo;s experience and interaction with LimeSurvey 2 is a significant portion of the 5% special sauce. For the core design (the 95% infrastructure), leverage the global creative community for common design elements and solutions. Leverage the millions of eyes in both the customer community and the design team beyond our version 2 product to identify the best solution.<br />
<br />
Global eyes on design.<br />
<br />
The Open Design Rule Set<br />
* Choose a license and distribution model (for LS2: GPL).<br />
* Set your ideas free: publish your designs on SourceForge, LimeSurvey forums, and design.limesurvey.org. Technical implementation is essential.<br />
* Release early and often. The rapid evolution and exchange of ideas is key to solving complex problems.<br />
<br />
Open Design:<br />
* Builds community without destroying individualism<br />
* Negotiates decisions between technical, cultural, and style factors<br />
* Involves everyone as equals: designers, engineers, architects, project managers, customers<br />
* Uses the collective experience to create better goods and services<br />
<br />
This is the survival of the fittest: the best designs win.<br />
<br />
Elegant, beautiful designs grow, evolve and prosper.<br />
<br />
Shit design withers.<br />
<br />
Evolve or perish.<br />
<br />
Open Design Mission<br />
<br />
Our designs (patterns, scripts, graphics, ideas, docs) will be available to any designer, to any engineer, to any world citizen, to use and modify without restriction.<br />
<br />
by Juhan Sonin, juhan@limesurvey.org<br />
<br />
Draft 2, 24.Jun.08</div>Jcleeland