LimeSurvey Manual - User contributions [en]

RemoteControl 2 API

2012-10-31T23:00:33Z

Dionet:

__TOC__

=Introduction=

LimeSurvey RemoteControl 2 is a XML-RPC/JSON-RPC based web service available in LimeSurvey 2.0 or later. The old [RemoteControl] will not be available any longer in version 2.

LSRC2 makes it possible for developers to control specific functionality of Limesurvey from any other application, without being restricted to PHP as a programming language.

The following features are planned:
* start a predefined survey (change titles and things)
* add predefined groups or questions
* activate the survey, restrict it to start and endtime
* make it closed,
* add participant data/tokens when you need them
* return the unused tokens to the main application
* get a fieldmap for a survey,
* invite or remind the participants of your survey

...and much more

==Requirements==
* libXML installed

=Setup=

== How to configure LSRC2==

In a default LimeSurvey installation LSRC2 is disabled. In order to use LSRC2 you must first enable the service, and then adjust the settings to suit your needs. To enable LSRC2 login to the LimeSurvey administration, go to [[Global settings]], choose the tab 'Services' and select one of the two RPC services (XML-RPC or JSON-RPC) service.

== Security==

LSRC2 uses the same security measures as the normal administration login. That means that the permission set of the used username and password is the same as if you would login in the administration with that user/password. Also LSRC2 is protected against brute-force password cracking - like the normal administration login.

=How to use LSRC2=

The basic LSRC2 URL is: http://<your_domain>/<your_limesurvey_dir>/index.php/admin/remotecontrol

LSRC2 fully complies to the [http://www.xmlrpc.com/ XML-RPC specification] and JSON-RPC specifications. We recommend in general to use JSON-RPC because it is well tested and has a much smaller footprint than XML-RPC.

LSRC2 offers the following functions:

==get_session_key==

Using this function you can create a new XML-RPC session key. This is mandatory for all following LSRC2 function calls.

Parameters: username (string), password (string)

Returns:
*On success: A session key (string)
*On failure: Error Code 1

==release_session_key==

Using this function you can close a previously opened XML-RPC/JSON-RPC session.

Parameters: session key (string)

Returns:
*Always: 'OK' (string)

==get_site_settings==

Function to provide with site settings only to administrators

Parameters:

sSessionKey (string) The session key

sSetttingName (string) - Name of the setting to get

Returns:
*On success: (string) Setting
*On failure: (string) Error message

==add_survey==

RPC Routine to add an empty survey with minimum details

Parameters:

sSessionKey (string) Auth credentials

iSurveyID (int), The wish id of the Survey to add

sSurveyTitle (string), Title of the new Survey

sSurveyLanguage (string), Default language of the Survey

sformat (string), Question appearance format (S|G|A)

Returns:
*On success: (int) $iNewSurveyID
*On failure: (array) Failure status
**Invalid session key
**No permission
**Faulty parameters
**Creation Failed

==delete_survey==

RPC Routine to Delete a survey

Parameters:

sSessionKey (string), Auth credentials

iSurveyID (int), The Survey to delete

Returns:
*On success: Status =>OK (array)
*On failure: (array) Failure status
**Invalid session key
**No permission

==import_survey==

RPC Routine to import a survey from lss,csv,xls or survey zip archive.

Parameters:

sSessionKey (string) Auth credentials

sImportData (string) String containing the BASE 64 encoded data of a lss,csv,xls or survey zip archive

sImportDataType (string), The format of the import file (lss,csv,xls or zip)

sNewSurveyName (string), The optional new name of the survey (base language)

DestSurveyID (int), This is the new ID of the survey - if already used a random one will be taken instead

Returns:
*On success: (int) $iNewSurveyID
*On failure: (array) Failure status
**Invalid session key
**No permission
**Import error

==get_survey_properties==

RPC Routine to get properties of a survey

Parameters:

sSessionKey (string) Auth credentials

iSurveyID (integer) - ID of the survey

aSurveySettings (array), An array with the properties to return

Returns:
*On success: (string) the requested value
*On failure: (array) Failure status
**Invalid survey ID
**Invalid session key
**No permission
**No valid Data

Available properties:

{|
| || || || || ||
|-
| sid|| savetimings|| allowprev|| tokenanswerspersistence|| showgroupinfo|| showwelcome
|-
| owner_id|| template|| printanswers|| assessments|| shownoanswer || showprogress
|-
| admin|| language|| ipaddr|| usecaptcha|| showqnumcode|| allowjumps
|-
| active|| additional_languages || refurl|| usetokens|| bouncetime|| navigationdelay
|-
| expires|| datestamp|| datecreated|| bounce_email|| bounceprocessing|| nokeyboard
|-
| startdate|| usecookie|| publicstatistics|| attributedescriptions|| bounceaccounttype|| alloweditaftercompletion
|-
| adminemail|| allowregister|| publicgraphs|| emailresponseto|| bounceaccounthost|| googleanalyticsstyle
|-
| anonymized|| allowsave|| listpublic|| emailnotificationto|| bounceaccountpass|| googleanalyticsapikey
|-
| faxto|| autonumber_start|| htmlemail|| tokenlength|| bounceaccountencryption||
|-
|format|| autoredirect|| sendconfirmation|| showxquestions|| bounceaccountuser||
|}

==set_survey_properties==

RPC Routine to set properties of a survey

Parameters:

sSessionKey (string) Auth credentials

iSurveyID (integer) - ID of the survey

aSurveySettings (array), An assosiative array with the name-value pair of the properties to set

Returns:
*On success: (array) The result of the change for each property
*On failure: (array) Failure status
**Invalid survey ID
**Invalid session key
**No permission
**No valid Data

Available properties:

Properties available for changing are all those defined in get_survey_properties with the following exceptions

{|
|properties not allowed to be modified|| Properties not allowed to be modified when survey active
|-
|sid||anonymized
|-
|language||datestamp
|-
|additional_languages||savetimings
|-
|active||ipaddr
|-
|||refurl
|-
|
|}

==list_surveys==

RPC Routine to list the ids and info of surveys belonging to a user.

* If user is admin he can get surveys of every user (parameter sUser) or all surveys (sUser=null)

* Else only the syrveys belonging to the user requesting will be shown.

Parameters:

sSessionKey (string) Auth credentials

sUser (string) - The users surveys to list

Returns:
*On success: (array) The result of the change for each property
*On failure: (array) Failure status
**Invalid user
**Invalid session key
**No permission
**No surveys found

==activate_survey==

RPC Routine that launches a newly created survey (sets active -available for users)

Parameters:

sSessionKey (string) Auth credentials

SurveyID (integer) - ID of the survey

Returns
*On success: (array) The result of the activation
*On failure: (array) Failure status
**Invalid Survey ID
**Activation Error
**Invalid session key
**No permission

==export_statistics==

RPC routine to export statistics of a survey to a user.

Parameters:

sSessionKey (string) Auth credentials

SurveyID (integer) - ID of the survey

docType (string) - Type of document to generate

sLanguage (string) Optional language of the survey to use (if not set, default language is selected)

graph (string) - Optional parameter to enable graphs (0|1)

Returns
*On success: (string) Base64 encoded string with the statistics file
*On failure: (array) Failure status
**Invalid Survey ID
**Invalid session key
**No permission

==get_summary==

RPC routine to get survey summary, regarding token usage and survey participation.

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (integer) - ID of the survey

sStatname (string) - The statistic to return

Returns
*On success: (string) Base64 encoded string with the statistics file
*On failure: (array) Failure status
**No available data
**No such property
**Invalid session key
**No permission

Available statistics:

{|
|Survey stats||Token stats
|-
|completed_responses||token_count
|-
|incomplete_responses||token_invalid
|-
|full_responses||tokens_sent
|-
|||token_opted_out
|-
|||token_completed
|-
|
|}

==add_language==

RPC Routine to add a language to an existing survey

Parameters:

session key (string) - The session key

SurveyID (integer) - ID of the survey

aLanguage (string) - The language shortcut for the new language to be added. Note: If the language is already in that survey no error will be thrown.

Return values:
*On success: (array) status=>OK
*On failure: (array) Any other status
**Invalid survey ID
**Invalid language
**Error
**Invalid session key
**No permission

==delete_survey_language==

RPC Routine to delete a language of an existing survey

Parameters:

session key (string) The session key

SurveyID (integer) - ID of the survey

aLanguage (string) - The language shortcut for the language to be removed. Note: If the language is not part of that survey no error will be thrown.

Return values:
*On success: (array) status=>OK
*On failure: (array) Any other status
**Invalid survey ID
**Invalid language
**Cannot remove base language
**Error
**No permission
**Invalid session key

==get_language_properties==

RPC Routine to get survey language properties

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (integer) - ID of the survey

aSurveyLocaleSettings (array) - An array with the properties to return

slang (string) - The language to use

Returns:
*On success: (string) the requested value
*On failure: (array) Failure status
**Invalid survey ID
**Invalid session key
**No permission
**No valid Data

Available parameters:

{|
| || || ||
|-
| surveyls_survey_id || surveyls_url || surveyls_email_register_subj || email_admin_notification_subj
|-
| surveyls_language || surveyls_urldescription || surveyls_email_register || email_admin_notification
|-
| surveyls_title || surveyls_email_invite_subj || surveyls_email_confirm_subj || email_admin_responses_subj
|-
| surveyls_description || surveyls_email_invite || surveyls_email_confirm || email_admin_responses
|-
| surveyls_welcometext || surveyls_email_remind_subj || surveyls_dateformat || surveyls_numberformat
|-
|surveyls_endtext || surveyls_email_remind || surveyls_attributecaptions ||
|}

==set_language_properties==

RPC Routine to set survey language properties

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (integer) - ID of the survey

aSurveyLocaleData (array) - An assosiative array with the key-value pairs of properties to set. Invalid fieldnames or fields that may not be modified are ignored.

sLanguage (string) - The language to use

Returns:
*On success: (string) Result for each parameter set
*On failure: (array) Failure status
**Invalid survey ID
**Invalid language
**Invalid session key
**No permission
**No valid Data

Allowed Parameters:

All those defined in get-language_properties except:
*surveyls_language
*surveyls_survey_id

==add_group==

RPC Routine to add an empty group with minimum details.

* Used as a placeholder for importing questions.

* Returns the groupid of the created group.

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (integer) - ID of the surveythat the group will be added

sGroupTitle (string) - Name of the new group

sGroupDescription (string) - Optional description of the group

Returns:
*On success: (int) The ID of the new group
*On failure: (array) Failure status
**Invalid survey ID
**Error:Survey is active and not editable
**Invalid session key
**No permission
**Creation Failed

==delete_group==

RPC Routine to delete a group of a survey

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (integer) - ID of the survey that the group belongs

sGroupID (int) - Id of the group to delete

Returns:
*On success: (int) The ID of the deleted group
*On failure: (array) Failure status
**Invalid Survey ID
**Invalid Group ID
**Error:Survey is active and not editable
**Invalid session key
**No permission
**Group deletion failed

==import_group==

RPC Routine to import a group - imports lsg,csv

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (integer) - The id of the survey that the group will belong

sImportData (string) - String containing the BASE 64 encoded data of a lsg,csv

sGroupDescription (string) -The format of the importfile in the stream (lsg|csv)

sNewGroupName (string) - Optional new name for the group

sNewGroupDescription (string) - Optional new description for the group

Returns:
*On success: (int) The ID of the new group
*On failure: (array) Failure status
**Invalid survey ID
**Error:Survey is active and not editable
**Invalid extension
**Error: Invalid LimeSurvey group structure XML
**Invalid session key
**No permission
**Import Error

==get_group_properties==

RPC Routine to return properties of a group of a survey

Parameters:

sSessionKey (string) - Auth credentials

iGroupID (integer) - The id of the group to get properties of

aGroupSettings (array) - Array containing the properties to request.

Returns:
*On success: (array) The requested properties
*On failure: (array) Failure status
**Error: Invalid group ID
**No valid Data
**Invalid session key
**No permission

Available properties:

{|
| ||
|-
|gid||description
|-
|sid||language
|-
|group_name||randomization_group
|-
|group_order||grelevance
|-
|
|}

==set_group_properties==

RPC Routine to set properties of a group of a survey

Parameters:

sSessionKey (string) - Auth credentials

iGroupID (integer) - The id of the group to set properties to

aGroupData (array) - Assosiative Array containing key-value pairs of the properties to set.

Returns:
*On success: (array) The result of each set action
*On failure: (array) Failure status
**Error: Invalid group ID
**No valid Data
**Group with dependencies - Order cannot be changed
**Invalid session key
**No permission

Available properties:

{|
| ||
|-
|||description
|-
|||language
|-
|group_name||randomization_group
|-
|group_order||grelevance
|-
|
|}

==list_groups==

RPC Routine to return the ids and info of groups belonging to survey

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (integer) - The id of the survey to get groups of

Returns:
*On success: (array) The list of the groups
*On failure: (array) Failure status
**Invalid Survey ID
**No groups found
**Invalid session key
**No permission

==delete_question==

RPC Routine to delete a question of a survey

Parameters:

sSessionKey (string) Auth credentials

iQuestionID (int) Id of the question to delete

Returns:
*On success: (int)id of the deleted Question
*On failure: (array) Failure status
**Invalid session key
**No permission
** Invalid question ID
**Survey is active and not editable
**Cannot delete Question. Others rely on this question
**Error

==import_question==

RPC Routine to import a question - imports lsq,csv

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (int) - Id of the survey that the new questions belongs

iGroupID (int) - Id of the group that the new questions belongs

sImportData (string) - String containing the BASE 64 encoded data of a lsg,csv

sImportDataType (string) - Format of the input stream (lsq,csv)

sMandatory (string) - Optional Mandatory question option (default to No)

sNewQuestionTitle (string) - Optional new title for the question

sNewqQuestion (string) - An optional new question

sNewQuestionHelp (string) - An optional new question help text

Returns:
*On success: (int) Id of the new Question
*On failure: (array) Failure status
**Invalid session key
**No permission
**Invalid survey ID
**Invalid group ID
**Survey is active and not editable
**Invalid extension
**Invalid LimeSurvey question structure XML

==get_question_properties==

RPC Routine to return properties of a question of a survey

Parameters:

sSessionKey (string) Auth credentials

iQuestionID (int) Id of the question to get properties of

aQuestionSettings (array) The properties to get

sLanguage (string) Optional parameter language for multilingual questions

Returns:
*On success: (array) The requested properties
*On failure: (array) Failure status
**Invalid session key
**No permission
**Invalid questionid
**Invalid language
**No valid Data

Available Properties:

{|
| || || ||
|-
|gid||type||help||language
|-
|parent_qid||title||other||scale_id
|-
|sid||question||mandatory||same_default
|-
|gid||preg||question_order||relevance
|-
|subquestions||attributes||attributes_lang||answeroptions
|-
|
|}

==set_question_properties==

RPC Routine to set question properties

Parameters:

sSessionKey (string) - Auth credentials

iQuestionID (int) - Id of the question to get properties of

aQuestionData (array) - An array with the particular fieldnames as keys and their values to set on that particular question

sLanguage (string) - Optional parameter language for multilingual questions

Returns:
*On success: (array) The resilt of the set of each property
*On failure: (array) Failure status
**Invalid session key
**No permission
**Invalid questionid
**Invalid language
**Questions with dependencies - Order cannot be changed
**No valid Data

Available Properties:

{|
| || ||
|-
|help|| ||
|-
|title||other||scale_id
|-
|question||mandatory||same_default
|-
|preg||question_order||relevance
|-
|
|}

==list_questions==

RPC Routine to return the ids and info of questions of a survey/group.

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (int) - Id of the survey to get questions of

iGroupID (int) - Id of the group to get questions of

sLanguage (string) - Optional parameter language for multilingual questions

Returns:
*On success: (array) The list of the questions
*On failure: (array) Failure status
**Invalid session key
**No permission
**Invalid questionid
**Invalid language
**Invalid survey ID
**Missmatch in surveyid and groupid
**No questions found

==activate_tokens==

Activate tokens

Parameters:

session key (string) The session key

surveyid (string) The survey ID

additional_attributes (array of integers) Any additional attribute fields to create. Just give the attribute IDs

Returns:
*On success: (array) status OK
*On failure: (array) Any other status

==add_participants==

Using this function you can add new entries to your token table. You can also set if for these new entries a token key is automatically create

Parameters:
*session key (string) - The session key
*survey ID (string) - The survey id
*participant data (array) - 2-dimensional array/structure containing your participants data
*createTokenKey (boolean) - Set this to true if you want a token key create automatically for each entry - if your participant data included a [token] field it will be overwritten

Returns:
*On success: participant data (struct) - structure containing your participants data plus the token ID and (if applicable) the new token
*On failure: (array) Failure status
**Invalid session key
**No permission
**Invalid survey ID

==delete_participants==

RPC Routine to delete multiple participants of a Survey

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (int) - Id of the survey to get questions of

aTokenIDs (array) - IId of the tokens/participants to delete

Returns:
*On success: (array) Array of deletion status for each participant
*On failure: (array) Failure status
**Invalid session key
**No permission
**Invalid survey ID
**No token table

==get_participant_properties==

RPC Routine to return settings of a token/participant of a survey

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (int) - Id of the Survey to get token properties

iTokenID (int) - Id of the participant to check

aTokenProperties (array) - The properties to get

Returns:
*On success: (array) Array of requested values
*On failure: (array) Failure status
**Invalid session key
**No permission
**Invalid survey ID
**No token table
**Invalid tokenid
**No valid Data

Available Parameters:

{|
| || ||
|-
|tid|| token|| completed
|-
| participant_id || language|| usesleft
|-
|firstname|| blacklisted|| validfrom
|-
| lastname|| sent|| validuntil
|-
|email|| remindersent|| mpid
|-
|emailstatus|| remindercount||
|}

==set_participant_properties==

RPC Routine to set properties of a survey participant/token

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (int) - Id of the Survey to set token properties

iTokenID (int) - Id of the participant to alter

aTokenData (array) - Key - value pair of the properties to set

Returns:
*On success: (array) Array of results of changing properties
*On failure: (array) Failure status
**Invalid session key
**No permission
**Invalid survey ID
**No token table
**Invalid tokenid
**No valid Data

Available Parameters:

{|
| || ||
|-
||| token|| completed
|-
| participant_id || language|| usesleft
|-
|firstname|| blacklisted|| validfrom
|-
| lastname|| sent|| validuntil
|-
|email|| remindersent|| mpid
|-
|emailstatus|| remindercount||
|}

==list_participants==

RPC Routine to return the ids and info of token/participants of a survey.

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (int) - Id of the survey to list participants

iStart (int) - Start id of the token list

iLimit (int) - Number of participants to return

bUnused (bool) - If you want unused tokensm, set true

Returns:
*On success: (array) Array of Participants info
*On failure: (array) Failure status
**Invalid session key
**No permission
**Invalid survey ID
**No token table
**No Tokens found

==activate_tokens==

RPC routine to to initialise the survey's collection of tokens where new participant tokens may be later added

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (int) - Id of the survey to list participants

aAttributeFields (array) - An array of integer describing any additional attribute fields

Returns:
*On success: (array) Status OK
*On failure: (array) Failure status
**Invalid session key
**No permission
**Invalid survey ID
**Token table could not be created

==invite_participants==

RPC Routine to invite participants in a survey

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (int) - Id of the survey to send invitation to participants

Returns:
*On success: (array) Array of result of each email send action and count of invitations left to send
*On failure: (array) Failure status
**Invalid session key
**No permission
**Invalid survey ID
**No token table
**No candidate tokens

==remind_participants==

RPC Routine to send reminder for participants in a survey

Parameters:

sSessionKey (string) - Auth credentials

iSurveyID (int) - Id of the survey to send invitation to participants

iMinDaysBetween (int) - Optional parameter days from last reminder

iMaxReminders (int) - Optional parameter Maximum reminders count

Returns:
*On success: (array) Array of result of each email send action and count of invitations left to send
*On failure: (array) Failure status
**Invalid session key
**No permission
**Invalid survey ID
**No token table
**No candidate tokens

==add_response==

Using this function you can add new responses to your survey response table.

Parameters:
*sSessionKey (string) - The session key
*iSurveyID (integer) - The survey id
*aResponseData (array) - array/structure containing your response data

Returns:
*On success: response_id (integer) - Returns the id of the inserted survey response
*On failure: (array) with error description

==export_responses==

Export response data to pdf,csv,xls,doc

Parameters:

sSessionKey (string) - Auth credentials

SurveyID (int) - Id of the Survey

DocumentType (string) - pdf,csv,xls,doc

sLanguageCode (string) - The language to be used

CompletionStatus (string) - Optional 'complete','incomplete' or 'all' selection of responses - defaults to complete

HeadingType (string) - 'code','full' or 'abbreviated'. type of question heading. Optional defaults to 'code'

ResponseType (string) - 'short' or 'long' response type.Optional defaults to 'short'

FromResponseID (int) - Optional start number of response

ToResponseID (int) - Optional end number of responses

Return:

On success: Requested file as base 64-encoded string.

On failure: Array with error information

Note: If you have huge response sets try only to request a certain number of records at a time otherwise the server may run out of memory.

=Testing=

To test you will have to activate JSON-RPC in global settings. To run a simple self-test go to

http://path_to_your_limesurvey_installation/index.php/admin/remotecontrol/test . This will import the example survey, do various things with it and delete it afterwards.

The test assumes that you still are using the standard user 'admin' with password 'password'.

The client function for this test can be found in /application/controller/admin/remotecontrol.php and the particular function is called test().

=PHP Example=

To include JSON-RPC in your application, you can write an application based on the tiny jsonRPCClient from [http://jsonrpcphp.org/ | jsonrpcphp.org]

<syntaxhighlight lang="php" enclose="div">

<?php

require_once 'jsonRPCClient.php';

define( 'LS_BASEURL', 'http://localhost/limesurvey/'); // adjust this one to your actual LimeSurvey URL

define( 'LS_USER', 'rpcuser' );

define( 'LS_PASSWORD', 'mypassword' );

// the survey to process

$survey_id=374699;

// instanciate a new client

$myJSONRPCClient = new jsonRPCClient( LS_BASEURL.'/admin/remotecontrol' );

// receive session key

$sessionKey= $myJSONRPCClient->get_session_key( LS_USER, LS_PASSWORD );

// receive all ids and info of groups belonging to a given survey

$groups = $myJSONRPCClient->list_groups( $sessionKey, $survey_id );

print_r($groups, null );

// release the session key

$myJSONRPCClient->release_session_key( $sessionKey );

?>

</syntaxhighlight>

=Changes=

2.0a Only three functions are supported right now: getSessionKey, releaseSessionKey, deleteSurvey

2.0b Added function add_participants

2.0RC5 Added import_survey, activate_survey, activate_tokens

2.0 (build 121030) Added subquestions, attributes, attributes_lang and answeroptions properties for get_question_properties

Project Ideas for GSoC 2012

2012-03-06T21:59:31Z

Dionet:

__TOC__

=Welcome=

Welcome Google Summer of Code Student aspirants (:razz:)

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:)

----

=Project ideas=

----

==Refactor all question types to a modular OOP format==

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.

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.

'''Skills'''
*Extensive knowledge of PHP & Yii framework
*Very good kownledge of LimeSurvey inner workings
*Very good OOP knowledge

'''Difficulty'''
*Hard

'''Probable Mentors'''

Carsten Schmitz (c_schmitz)

----

==Implement a fully featured XMP-RPC API + API tests + unit test==

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.

'''Skills'''
*Good PHP, SQL, Yii knowledge
*Good knowledge of the LimeSurvey administration and code

'''Difficulty'''
*Hard

'''Probable Mentors'''

c_schmitz

----

==User Interface Improvements and Backend Tidy Ups==

Help improve LimeSurvey's usability and flexibility through a range of small tasks such as:
* develop improved 'bulk' question handling UI
* Tidy up input values on public surveys by moving required values from html inputs to javascript variables

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.

'''Skills'''

PHP, SQL, Yii, Authentication protocols (openID, CAS, LDAP-bind, ...)

'''Difficulty'''

Medium

'''Probable Mentors'''

Jason Cleeland (jcleeland)

----

==Implement a plugin framework for authentication/languages/ import/export modules==

The idea is to design and implement a modular "framework" for LimeSurvey as well as convert the existing functionality 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.).

The plugin framework should be in parts similar to the framework used by Joomla (XML description files in the plugin packages)

Example description for authentication moduls:

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)

A generic authentication framework must define the following services:
* User authentication: this interface must return the identity of the authenticated user if authentication is successful.
** 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...
* User provisioning:
** 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).
** 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.

'''Skills'''

PHP, SQL, Yii

'''Difficulty'''

Hard

'''Probable Mentors'''

c_schmitz

Diogo Gonçalves (dionet)

'''Want to know more'''

Please read the [http://docs.limesurvey.org/tiki-index.php?page=GSOC+2010++Authentication+framework#FAQ FAQ about this project]

----

==Custom Report Generation==

The task is to make a module which will generate custom reports. Module should be able to do these things(at least) :-
*Creating various types of reports i.e. using tables, pie charts, graphs and bar-charts to name few.
*The resulting charts and other illustrations should be easy to read and understand, and should include the ability to export into standard office suites.
*Reports can be general or survey specific.
**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.
**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.

'''Skills'''

OOP experience in PHP and experience with a PHP framework like CakePHP or CodeIgniter, jQuery. Strong mathematical background will help!

'''Difficulty'''

Moderate

'''Probable mentors'''

Carsten Schmitz (c_schmitz)

Jason Cleeland (jcleeland)

Diogo Gonçalves (dionet)

----

==Adding new questions/subquestions and groups dynamically==

Currently in LimeSurvey once a survey is activate we can not
*Add or delete groups
*Add or delete questions
*Add or delete subquestions or change their codes

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.

'''Skills'''

Experience with the PHP framework Yii and knowledge of inner working of LimeSurvey is must!

'''Difficulty'''

Moderate

'''Probable mentors'''

Jason Cleeland (jcleeland)

Diogo Gonçalves (dionet)

----

==Enhance Expression Manager==

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.
#Add a GUI for Expression Manager
**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.
***Create CodeMirror syntax file to do appropriate syntax highlighting (use C as base language), ensuring that CodeMirror knows the set of valid operators
#Support sub-question-level Relevance
**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.
#Add Sub-question-level Validation
**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.
#Add Sub-question-level mandatory criteria
**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.
#Add native support for input-masks at the question and sub-question level
**Background: One of the commonly used work-arounds deals with input masks, such as the jQuery meimomask plugin.
#Add EM reporting functions (tables)
**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.
#Add better EM support for operations on array type questions
**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.
#Add EM functions to validate data entry against value sets managed by Enterprise Vocabulary Systems
**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.

'''Skills'''

PHP, SQL, PHP Debugging (e.g. xdebug), Yii, LimeSurvey's Expression Manager and code-base in general

'''Difficulty'''

Medium to Hard

'''Probable Mentors'''

Thomas White (TMSWhite)

----

==Optimize LimeSurvey for Long Surveys (and better performance and maintenance in general)==

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:
#Support for more than 1000 database columns
**Background: LS creates a horizontal table for survey data collection, and such tables often are limited to at most 1000 columns
#Memory and Code Optimization
**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.
#Run-Time Performance Optimization
**Background: qanda.php loads the content to create the questions and answers. It used to do this by separate database queries per question.
#Design-Time Performance Optimization
**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
#Optimizations for Rapid Development
**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
#Performance Validation
**Load test surveys of varying lenghts
**Identify performance and memory bottlenecks
**Idenfity minimum memory requirements for certain survey lengths and concurrent user volumes
**Propose strategy to overcome those performance issues

'''Skills'''

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

'''Difficulty'''

Medium to Hard

'''Probable Mentors'''

Thomas White (TMSWhite)

----

==Idea template==

Describe the idea here in general terms

'''Skills'''

Explain what sort of coding skills would be needed for a student to implement this project

'''Difficulty'''

Explain the level of difficulty involved

'''Probable Mentors'''

Put your name (and tag) here if you are willing to mentor a student for this idea

----

=More information=

==Getting started==

[[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!

==Frequently Asked Questions==

Check out [[GSoC FAQ|our GSoC FAQ page.]]

Project Ideas for GSoC 2012

2012-02-23T22:12:34Z

Dionet:

__TOC__

=Welcome=

Welcome Google Summer of Code Student aspirants (:razz:)

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:)

----

=Project ideas=

----

==Refactor all question types to a modular OOP format==

----

==Implement a fully featured XMP-RPC API complete with unit test==

----

==Add a unit testing framework and write tests==

----

==Integrate the DBSE into Yii==

----

==Develop Improved 'bulk' Question Handling UI (and other UI enhancements)==

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.

'''Skills'''

PHP, SQL, Yii, Authentication protocols (openID, CAS, LDAP-bind, ...)

'''Difficulty'''

Medium

'''Probable Mentors'''

Jason Cleeland (jcleeland)

----

==Implement a modular authentication framework==

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, ...

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.

The generic authentication framework must define the following services:
* User authentication: this interface must return the identity of the authenticated user if authentication is successful.
** 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...
* User provisioning:
** 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).
** 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.

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).

'''Skills'''

PHP, SQL, Yii, Authentication protocols (openID, CAS, LDAP-bind, ...)

'''Difficulty'''

Medium

'''Probable Mentors'''

Unknown

'''Want to know more'''

Please read the [http://docs.limesurvey.org/tiki-index.php?page=GSOC+2010++Authentication+framework#FAQ FAQ about this project]

----

==Custom Report Generation==

The task is to make a module which will generate custom reports. Module should be able to do these things(at least) :-
*Creating various types of reports i.e. using tables, pie charts, graphs and bar-charts to name few.
*The resulting charts and other illustrations should be easy to read and understand, and should include the ability to export into standard office suites.
*Reports can be general or survey specific.
**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.
**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.

'''Skills'''

OOP experience in PHP and experience with a PHP framework like CakePHP or CodeIgniter, jQuery. Strong mathematical background will help!

'''Difficulty'''

Moderate

'''Probable mentors'''

Carsten Schmitz (c_schmitz)

Jason Cleeland (jcleeland)

Diogo Gonçalves (dionet)

----

==Adding new questions/subquestions and groups dynamically==

Currently in LimeSurvey once a survey is activate we can not
*Add or delete groups
*Add or delete questions
*Add or delete subquestions or change their codes

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.

'''Skills'''

Experience with a PHP framework like CakePHP or CodeIgniter and knowledge of inner working of LimeSurvey is must!

'''Difficulty'''

Moderate

'''Probable mentors'''

Carsten Schmitz (c_schmitz)

Jason Cleeland (jcleeland)

Diogo Gonçalves (dionet)

----

==Enhance Expression Manager==

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.
#Add a GUI for Expression Manager
**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.
**Strategy - use CodeMirror - see [http://bugs.limesurvey.org/view.php?id=5279 here]
***Create CodeMirror syntax file to do appropriate syntax highlighting (use C as base language), ensuring that CodeMirror knows the set of valid operators
***Use CodeMirror API to let it know the names of registered function and variable names
***Utilize auto-complete, ideally letting users see and choose among the availalbe function syntaxes (e.g. when a function can take several paameters).
***Auto-completion of variable names should show the question and question type to make it easier for users to pick the correct variable.
#Support sub-question-level Relevance
**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.
**Strategy:
***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)
***Refactor createFieldMap() (or its successor) to read sub-question-level relevance into the run-time data structures so that passed to EM
***Enhance EM's sub-question-level data structures to hold sub-question-level releavance
***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
***Update ShowSurveyLogicFile() to show sub-question-level relevance equations ***Rigorously unit and regresssion test these changes.
#Add Sub-question-level Validation
**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.
**Strategy: Similar to sub-question-level relevance
***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)
***Ensure EM gets access to the new preg values (via upgrade to createFieldMap)
***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)
***Upgrade ShowSurveyLogicFile() to show sub-question-level validation rules
***Rigorously unit and regresssion test these changes.
#Add Sub-question-level mandatory criteria
**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.
**Strategy: Similar to sub-question-level relevance
***Add checkbox to indicate mandatory status at the sub-question level
#Add native support for input-masks at the question and sub-question level
**Background: One of the commonly used work-arounds deals with input masks, such as the jQuery meimomask plugin.
**Strategy:
***Add mask attribute at question and sub-question level
***Have EM generate needed JavaScript code to create and manage those masks
#Add EM reporting functions (tables)
**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.
**Strategy:
***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.
***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.
#Add better EM support for operations on array type questions
**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.
**Strategy:
***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.
***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.
***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)
***For questions with comments, create macros like qcode_vars_nc and qcode_vars_oc for no-comments and only-comments
***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.
#Add EM functions to validate data entry against value sets managed by Enterprise Vocabulary Systems
**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.
**Strategy:
***Create EM-compatible PHP and JavaScript functions to access CTS-2 compliant EVS systems
***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).
***Should also include ability to do incremetal searches into the value sets

'''Skills'''

PHP, SQL, PHP Debugging (e.g. xdebug), Yii, LimeSurvey's Expression Manager and code-base in general

'''Difficulty'''

Medium to Hard

'''Probable Mentors'''

Thomas White (TMSWhite)

----

==Optimize LimeSurvey for Long Surveys (and better performance in general)==

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:
#Support for more than 1000 database columns
**Background: LS creates a horizontal table for survey data collection, and such tables often are limited to at most 1000 columns
**Strategies:
***Remove unneeded columns from horizontal table (e.g. type 'X')
***Conditionally remove unneeded equation columns (e.g. let users specify a prefix for variable names that should not be stored)
***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].
#Memory Optimization
**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.
**Strategy
***Remove need for buildsurveysession() - gap analysis to add in any missing content to EM
***Remove need for createFieldMap() - similar gap analysis
***Normalize EM data structures to avoid internal duplication (there are about 4 structures that hold over-lapping code)
***Refactor EM so that stores normalized copies of secondary language text
#Run-Time Performance Optimization
**Background: qanda.php loads the content to create the questions and answers. It used to do this by separate database queries per question.
**Strategy
***Refactor qanda.php to remove queries (like for "other", or sub-question text) - have it get that information from EM
***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)
#Design-Time Performance Optimization
**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
**Strategy:
***Add methods to EM to just load changes to model as questions or groups are added, removed, or updated
***Pass those updates into EM internals so that syntax highlighting continues to be correct
***Ensure that admin pages only call the subset of EM functions needed to do accurate syntax highlighting.
#Optimizations for Rapid Development
**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
**Strategy:
***Create an Excel data model that would work for importing surveys
***Create import and validation routines from that model
***A similar model, which could be extended for LS, is noted [http://bugs.limesurvey.org/view.php?id=5105 here].
#Performance Validation
**Load test surveys of varying lenghts
**Identify performance and memory bottlenecks
**Idenfity minimum memory requirements for certain survey lengths and concurrent user volumes
**Propose strategy to overcome those performance issues

'''Skills'''

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

'''Difficulty'''

Medium to Hard

'''Probable Mentors'''

Thomas White (TMSWhite)

----

==Idea template==

Describe the idea here in general terms

'''Skills'''

Explain what sort of coding skills would be needed for a student to implement this project

'''Difficulty'''

Explain the level of difficulty involved

'''Probable Mentors'''

Put your name (and tag) here if you are willing to mentor a student for this idea

----

=More information=

==Getting started==

[[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!

==Frequently Asked Questions==

Check out [[GSoC FAQ|our GSoC FAQ page.]]

LimeSurvey project ideas for Google Code-in 2011

2011-10-29T23:12:30Z

Dionet:

__TOC__

=Welcome=

Welcome Google Code-in Student aspirants (:razz:)!! Please check if you are an [http://code.google.com/opensource/gci/2010-11/faqs.html eligible candidate] for the GCI program.

This page lists task ideas developed by the LimeSurvey Community. These tend to be areas that will get the most support as tasks since they have been developed by people who know the project and what it needs the most. Good Luck (:biggrin:)

All tasks aim at the development version 2.0a.

=How to claim a task=

All tasks below will be entered in the [http://www.google-melange.com/gci/program/list_tasks/google/gci2011 Google Code-in task tracker] (which is not yet available). You have to be a registered Google Code-In participant to claim a task.

=Task ideas=

==Idea Template==

'''''This is just a template you can use to add your ideas:'''''

===Code/Documentation/Outreach/Quality assurance/Training/Research/User interface: Some descriptive task description===

''Idea posted by: <myname>''

Here comes some text describing the current situation and how Limesurvey will benefit from this task. The description should make clear what this task is about.

Task steps:
*Some steps like...
*Install Limesurvey or use the online system we provide
*Analyse the problem
*Discuss the issue and your proposed solution with your mentor
*Code/document/translate/... and submit your work
*Discuss the work with your mentor
*Check-in your changes into the limesurvey svn trunk/add it to the wiki/...

{|
|Time frame||Skills||Difficulty||Mentor
|-
|X days||some skills the applicants should have|| easy/moderate/difficult||mentorname
|}

==Localization==

===Localization: Translate LimeSurvey to your mother language===

The LimeSurvey software is available in more than 50 languages - not all of them are completely translated. Check if your language is supported at: http://www.limesurvey.org/translationstatus_v2/

Task Steps:
*Check out if your language is already there and if the translation status is below 70% OR if your language does not exist at all.
*Read the documentation on [[how to update a translation or how to create a new one.|Translating LimeSurvey]]
*Translate as crazy - check your translation using a local copy of LimeSurvey.
*Submit your updated/new translation to us.

Updating a translation from <70% to 100%:

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 Days||Translation|| Easy ||c_schmitz
|}

New translation (at least 50%):

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 Days||Translation|| Moderate ||c_schmitz
|}

===Translation: (GERMAN) Translate the english "Expression Manager" docs page to German===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The upcoming Limesurvey 2.0 version will contain a powerful "Expression Manager" which replaces conditions and some other features. The documentation of this new feature is only available in English yet. Your task is to [http://docs.limesurvey.org/Expression+Manager translate the current wiki page] to German.

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/Expression+Manager
*Create a new German translation of this page directly at our wiki and translate the page carefully
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||German and English language|| easy||mot2
|}

===Translation: (GERMAN) Translate the english "Central Participants Database" docs page to German===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The upcoming Limesurvey 2.0 version will have a new feature called "Central Participants Database" (CPDB). The documentation of this new feature is only available in English yet. Your task is to [http://docs.limesurvey.org/Central+participants+database+%28User+panel%29 translate the current wiki page] to German.

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/Central+participants+database+%28User+panel%29
*Create a new German translation of this page directly at our wiki and translate the page carefully
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||German and English language|| easy||mot2
|}

===Translation: (GERMAN) Translate the english "Creating a new survey" docs page to German===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The "Creating a new survey" page is one of the most important pages at our documentation because it lists all available survey settings. Unfortunately the German documentation of this page is really outdated. Your task is to [http://docs.limesurvey.org/tiki-index.php?page=Erstellen+einer+neuen+Umfrage update the German translation of that wiki page] based on the [http://docs.limesurvey.org/Creating+a+new+survey&structure;=English+Instructions+for+LimeSurvey current english wiki page].

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/Creating+a+new+survey&structure;=English+Instructions+for+LimeSurvey
*Check if it's worth keeping parts of the [http://docs.limesurvey.org/tiki-index.php?page=Erstellen+einer+neuen+Umfrage current German version]. If so, update the existing page, if not, clear the page and translate the [http://docs.limesurvey.org/Creating+a+new+survey&structure;=English+Instructions+for+LimeSurvey english base version].
*Create the German translation of this page directly at our wiki.
*Check if your new/updated translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||German and English language|| easy||mot2
|}

===Translation: (GERMAN) Translate the english "Advanced question settings" docs page to German===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The "Advanced qustion attributes" page is one of the most important pages at our documentation because it lists all available question attributes which enhance question functionality. Unfortunately the German documentation of this page is really outdated. Your task is to [http://docs.limesurvey.org/tiki-index.php?page=Frage-Attribute update the German translation of that wiki page] based on the [http://docs.limesurvey.org/tiki-index.php?page=Advanced+question+settings current english wiki page].

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/tiki-index.php?page=Advanced+question+settings
*Check if it's worth keeping parts of the [http://docs.limesurvey.org/tiki-index.php?page=Frage-Attribute current German version]. If so, update the existing page, if not, clear the page and translate the [http://docs.limesurvey.org/tiki-index.php?page=Advanced+question+settings english base version].
*Create the German translation of this page directly at our wiki.
*Check if your new/updated translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||German and English language|| easy||mot2
|}

===Translation: (GERMAN) Translate the english "Tokens" docs page to German===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The "Tokens" page is one of the most important pages at our documentation because feature is used a lot to restrict access to a survey on predefined users. Unfortunately the German documentation of this page is really outdated. Your task is to [http://docs.limesurvey.org/Zugangsschl%C3%BCssel&structure;=Deutsche+Anleitung+f%C3%BCr+LimeSurvey update the German translation of that wiki page] based on the [http://docs.limesurvey.org/Tokens&structure;=English+Instructions+for+LimeSurvey current english wiki page].

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/Tokens&structure;=English+Instructions+for+LimeSurvey
*Check if it's worth keeping parts of the [http://docs.limesurvey.org/Zugangsschl%C3%BCssel&structure;=Deutsche+Anleitung+f%C3%BCr+LimeSurvey current German version]. If so, update the existing page, if not, clear the page and translate the [http://docs.limesurvey.org/Tokens&structure;=English+Instructions+for+LimeSurvey english base version].
*Create the German translation of this page directly at our wiki.
*Check if your new/updated translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||German and English language|| easy||mot2
|}

===Translation: (GERMAN) Translate the english "Installer" docs page to German===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The new installer is one of the most important featres of the new Limesurvey 2.0 version. Once the English instructions page ([http://docs.limesurvey.org/LimeSurvey+project+ideas+for+Google+Code-in+2011#Documentation:_Rewrite_installation_procedure see this idea]) was set up, the German translation of that page has to be created.

Task Steps:
*Have a look at the english installer page once it was set up.
*Create the German translation of this page directly at our wiki.
*Check if your new/updated translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||German and English language|| easy||mot2
|}

<strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike>--

===Translation: (FRENCH) Translate the english "Expression Manager" docs page to French===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The upcoming Limesurvey 2.0 version will contain a powerful "Expression Manager" which replaces conditions and some other features. The documentation of this new feature is only available in English yet. Your task is to [http://docs.limesurvey.org/Expression+Manager translate the current wiki page] to French.

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/Expression+Manager
*Create a new French translation of this page directly at our wiki and translate the page carefully
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||French and English language|| easy||Shnoulle
|}

===Translation: (FRENCH) Translate the english "Central Participants Database" docs page to French===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The upcoming Limesurvey 2.0 version will have a new feature called "Central Participants Database" (CPDB). The documentation of this new feature is only available in English yet. Your task is to [http://docs.limesurvey.org/Central+participants+database+%28User+panel%29 translate the current wiki page] to French.

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/Central+participants+database+%28User+panel%29
*Create a new French translation of this page directly at our wiki and translate the page carefully
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||French and English language|| easy||Shnoulle
|}

===Translation: (FRENCH) Translate the english "Creating a new survey" docs page to French===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The "Creating a new survey" page is one of the most important pages at our documentation because it lists all available survey settings. Unfortunately the French documentation of this page is really outdated. Your task is to [http://docs.limesurvey.org/Cr%C3%A9er+un+nouveau+questionnaire update the French translation of that wiki page] based on the [http://docs.limesurvey.org/Creating+a+new+survey&structure;=English+Instructions+for+LimeSurvey current english wiki page].

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/Creating+a+new+survey&structure;=English+Instructions+for+LimeSurvey
*Check if it's worth keeping parts of the [http://docs.limesurvey.org/Cr%C3%A9er+un+nouveau+questionnaire current French version]. If so, update the existing page, if not, clear the page and translate the [http://docs.limesurvey.org/Creating+a+new+survey&structure;=English+Instructions+for+LimeSurvey english base version].
*Create the French translation of this page directly at our wiki.
*Check if your new/updated translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|1 day||French and English language|| easy||Shnoulle
|}

===Translation: (FRENCH) Translate the english "Advanced question settings" docs page to French===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The "Advanced question attributes" page is one of the most important pages at our documentation because it lists all available question attributes which enhance question functionality. Unfortunately the French documentation of this page is really outdated. Your task is to [http://docs.limesurvey.org/tiki-index.php?page=Attributs+des+questions update the French translation of that wiki page] based on the [http://docs.limesurvey.org/tiki-index.php?page=Advanced+question+settings current english wiki page].

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/tiki-index.php?page=Advanced+question+settings
*Check if it's worth keeping parts of the [http://docs.limesurvey.org/tiki-index.php?page=Attributs+des+questions current French version]. If so, update the existing page, if not, clear the page and translate the [http://docs.limesurvey.org/tiki-index.php?page=Advanced+question+settings english base version].
*Create the French translation of this page directly at our wiki.
*Check if your new/updated translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||French and English language|| easy||Shnoulle
|}

===Translation: (FRENCH) Translate the english "Tokens" docs page to French===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The "Tokens" page is one of the most important pages at our documentation because feature is used a lot to restrict access to a survey on predefined users. Unfortunately the French documentation of this page is really outdated. Your task is to [http://docs.limesurvey.org/Invitations&structure;=Instructions+fran%C3%A7aises+pour+LimeSurvey update the French translation of that wiki page] based on the [http://docs.limesurvey.org/Tokens&structure;=English+Instructions+for+LimeSurvey current english wiki page].

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/Tokens&structure;=English+Instructions+for+LimeSurvey
*Check if it's worth keeping parts of the [http://docs.limesurvey.org/Invitations&structure;=Instructions+fran%C3%A7aises+pour+LimeSurvey current French version]. If so, update the existing page, if not, clear the page and translate the [http://docs.limesurvey.org/Tokens&structure;=English+Instructions+for+LimeSurvey english base version].
*Create the French translation of this page directly at our wiki.
*Check if your new/updated translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||French and English language|| easy||Shnoulle
|}

===Translation: (FRENCH) Translate the english "Installer" docs page to French===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The new installer is one of the most important featres of the new Limesurvey 2.0 version. Once the English instructions page ([http://docs.limesurvey.org/LimeSurvey+project+ideas+for+Google+Code-in+2011#Documentation:_Rewrite_installation_procedure see this idea]) was set up, the French translation of that page has to be created.

Task Steps:
*Have a look at the english installer page once it was set up.
*Create the French translation of this page directly at our wiki.
*Check if your new/updated translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||French and English language|| easy||Shnoulle
|}

<strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike><strike>-</strike>---

===Translation: (SPANISH) Translate the english "Expression Manager" docs page to Spanish===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The upcoming Limesurvey 2.0 version will contain a powerful "Expression Manager" which replaces conditions and some other features. The documentation of this new feature is only available in English yet. Your task is to [http://docs.limesurvey.org/Expression+Manager translate the current wiki page] to Spanish.

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/Expression+Manager
*Create a new Spanish translation of this page directly at our wiki and translate the page carefully
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||Spanish and English language|| easy||holch
|}

===Translation: (SPANISH) Translate the english "Central Participants Database" docs page to Spanish===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The upcoming Limesurvey 2.0 version will have a new feature called "Central Participants Database" (CPDB). The documentation of this new feature is only available in English yet. Your task is to [http://docs.limesurvey.org/Central+participants+database+%28User+panel%29 translate the current wiki page] to Spanish.

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/Central+participants+database+%28User+panel%29
*Create a new Spanish translation of this page directly at our wiki and translate the page carefully
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||Spanish and English language|| easy||holch
|}

===Translation: (SPANISH) Translate the english "Creating a new survey" docs page to Spanish===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The "Creating a new survey" page is one of the most important pages at our documentation because it lists all available survey settings. Unfortunately the Spanish documentation of this page is really outdated. Your task is to [http://docs.limesurvey.org/tiki-index.php?page=Reglas+de+evaluaci%C3%B3n update the Spanish translation of that wiki page] based on the [http://docs.limesurvey.org/Creating+a+new+survey&structure;=English+Instructions+for+LimeSurvey current english wiki page].

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/Creating+a+new+survey&structure;=English+Instructions+for+LimeSurvey
*Check if it's worth keeping parts of the [http://docs.limesurvey.org/tiki-index.php?page=Reglas+de+evaluaci%C3%B3n current Spanish version]. If so, update the existing page, if not, clear the page and translate the [http://docs.limesurvey.org/Creating+a+new+survey&structure;=English+Instructions+for+LimeSurvey english base version].
*Create the Spanish translation of this page directly at our wiki.
*Check if your new/updated translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|1 day||Spanish and English language|| easy||holch
|}

===Translation: (SPANISH) Translate the english "Question types" docs page to Spanish===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The "Question types" page is one of the most important pages at our documentation because it lists all available question types. Unfortunately the Spanish documentation of this page is really outdated. Your task is to [http://docs.limesurvey.org/tiki-index.php?page=Tipos+de+preguntas update the Spanish translation of that wiki page] based on the [http://docs.limesurvey.org/tiki-index.php?page=Question+types&structure;=English+Instructions+for+LimeSurvey current english wiki page].

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/tiki-index.php?page=Question+types&structure;=English+Instructions+for+LimeSurvey
*Check if it's worth keeping parts of the [http://docs.limesurvey.org/tiki-index.php?page=Tipos+de+preguntas current Spanish version]. If so, update the existing page, if not, clear the page and translate the [http://docs.limesurvey.org/tiki-index.php?page=Question+types english base version].
*Create the Spanish translation of this page directly at our wiki.
*Check if your new/updated translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||Spanish and English language|| moderate||holch
|}

===Translation: (SPANISH) Translate the english "Advanced question settings" docs page to Spanish===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The "Advanced question attributes" page is one of the most important pages at our documentation because it lists all available question attributes which enhance question functionality. Unfortunately the Spanish documentation of this page is really outdated. Your task is to [http://docs.limesurvey.org/tiki-index.php?page=Atributos+de+ajuste+de+preguntas update the Spanish translation of that wiki page] based on the [http://docs.limesurvey.org/tiki-index.php?page=Advanced+question+settings current english wiki page].

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/tiki-index.php?page=Advanced+question+settings
*Check if it's worth keeping parts of the [http://docs.limesurvey.org/tiki-index.php?page=Atributos+de+ajuste+de+preguntas current Spanish version]. If so, update the existing page, if not, clear the page and translate the [http://docs.limesurvey.org/tiki-index.php?page=Advanced+question+settings english base version].
*Create the Spanish translation of this page directly at our wiki.
*Check if your new/updated translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||Spanish and English language|| easy||holch
|}

===Translation: (SPANISH) Translate the english "Tokens" docs page to Spanish===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The "Tokens" page is one of the most important pages at our documentation because feature is used a lot to restrict access to a survey on predefined users. Unfortunately the Spanish documentation of this page doesn't exist yet. Your task is to create the Spanish translation of that wiki page based on the [http://docs.limesurvey.org/Tokens&structure;=English+Instructions+for+LimeSurvey current english wiki page].

Task Steps:
*Have a look at the english page at http://docs.limesurvey.org/Tokens&structure;=English+Instructions+for+LimeSurvey
*Translate the page based on the [http://docs.limesurvey.org/Tokens&structure;=English+Instructions+for+LimeSurvey english base version].
*Check if your new translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 days||Spanish and English language|| difficult||holch
|}

===Translation: (SPANISH) Translate the english "Installer" docs page to Spanish===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

The new installer is one of the most important featres of the new Limesurvey 2.0 version. Once the English instructions page ([http://docs.limesurvey.org/LimeSurvey+project+ideas+for+Google+Code-in+2011#Documentation:_Rewrite_installation_procedure see this idea]) was set up, the Spanish translation of that page has to be created.

Task Steps:
*Have a look at the english installer page once it was set up.
*Create the Spanish translation of this page directly at our wiki.
*Check if your new translation contains all information of the english base version.
*Discuss the translation with your mentor

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||French and English language|| moderate||holch
|}

==Code==

===Code: Usability changes for LimeSurvey===

The LimeSurvey user interface (like most interfaces) has its kinks - often it is very easy to enhance the usability by just making small changes to the interface.

Task Steps:
*Install LimeSurvey - create a small survey, play around with the interface.
*Pick a couple things you would like to change to have better usability
*Discuss the found issues with your mentor
*Together we will either pick one of your found issues or the mentor will make an suggestion for another change.
*Code the usability change and create a patch
*Discuss the patch with your mentor and the mentor
*If necessary make re-submit patch with discusse changes

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||PHP, HTML, CSS, maybe SQL|| Moderate||c_schmitz
|}

===Code: Implement "Embedd all text answers" setting at admin statistics===

''Idea posted by: Mazi''

Currently the admin statistics only sum up data. If you want to have a look at text responses in detail, you have to click another button within the summary which opens a new windows.

This is a bad solution if you want to exports results and include the texts because you have to copy them manually. Therefore a new "Embedd all text answers" setting should be introduced so that all text answers will be listed for all corresponding questions. This way this data would also be avialable when exporting the statistics.

Task Steps:
*Install LimeSurvey - create a small survey with text questions and add some dummy data.
*Have a look at the data summary and the available export options.
*Add a "Embedd all text answers" setting.
*Implement the code to embedd that data and create a patch
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the limesurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||PHP, some very basic HTML, SQL|| Moderate||c_schmitz
|}

===Code: Implement Google map at admin statistics===

''Idea posted by: Mazi''

Limesurvey offers a "Map" question type which can be used to let the user mark a certain location. The results are stored as lat./long. coordinates at a simply text question. Currently the admin statistics only show the raw coordinates. To improve this, a Google Map should be included at the admin statistics, showing the users' answers at that overview.

Task Steps:
*Install LimeSurvey - create a small survey with a map question and add some dummy data.
*Have a look at the admin statistics of that question.
*Implement the code to embedd a Map and mark the users' answers in there and create a patch
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the limesurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 days||PHP, some very basic HTML, (knowledge about Google Maps API or: learning by doing)|| Moderate||c_schmitz
|}

===Code: Implement jqgrid at token overview table===

''Idea posted by: Mazi''

The Limesurvey admin backend includes several tabular overviews, e.g. when listing all the existing users at the token overview. Usability will benefit a lot if those overviews would be sortable, searchable and filterable. For this we can use jqgrid.

Task Steps:
*Install LimeSurvey - create a small survey with a token table and add a few dummy people there.
*Have a look at the jqgrid docs at http://www.trirand.com/jqgridwiki/doku.php
*Implement jqgrid for the token overview and create a patch
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the limesurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||Javascript, PHP, HTML, maybe a little CSS|| Difficult ||c_schmitz
|}

===Code: Implement jqgrid at browse response table===

''Idea posted by: Mazi''

The Limesurvey admin backend includes several tabular overviews, e.g. when listing survey results at the browse responses screen. Usability will benefit a lot if this overview would be sortable, searchable and filterable. For this we can use jqgrid.

Task Steps:
*Install LimeSurvey - import a test survey with all question types (we'll hand that to you) and add some test answer data.
*Have a look at the jqgrid docs at http://www.trirand.com/jqgridwiki/doku.php
*Implement jqgrid for the browse response table and create a patch
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the limesurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||Javascript, PHP, HTML, maybe a little CSS|| Moderate||aniessh
|}

===Code: Improve drag and drop functionality at attribute mapping===

''Idea posted by: Aniessh''

Central Participant's Database feature has a special drag and drop functionality for mapping/creating attributes in the token table to the central table and vice versa. The feature is working but needs improvement in the user interface.

Task Steps:
*Install LimeSurvey - create a small survey with a token table and add a few dummy people there.
*Create some attributes at the token level.
*Create some attributes at the Central Participant Database panel.
*Copy the previously added dummy people from token table to the central table.
*You will be presented with a drag and drop screen that will allow you to match the attributes from the central and the token table.
*Suggest how to improve the user interface.
*Improve the user interface and create a patch.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the limesurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 days||Javascript, PHP, HTML, CSS|| Moderate||aniessh
|}

===Code: Add drag and drop feature to ranking question===

''Idea posted by: Mazi''

Limesurvey contains a "ranking" question type (see http://docs.limesurvey.org/Question+type+-+Ranking&structure;=English+Instructions+for+LimeSurvey) which isn't very user friendly when it comes to sorting and it also causes problems when being used by screen readers. Nowadays there are better interfaces for such question types so switching to a drag and drop version is the goal of this coding task.

There is already a [http://docs.limesurvey.org/Workarounds%3A+Manipulating+a+survey+at+runtime+using+Javascript&structure;=English+Instructions+for+LimeSurvey#Drag_and_Drop_Rankings workaround] and a [http://www.partnersinc.biz/surveys//index.php?sid=36981&newtest;=Y&lang;=en demo version] available so what has to be done is porting the code to create a more generic solution and embedding the CSS for the available shipped templates.

Task Steps:
*Install LimeSurvey - create a test survey with ranking question types and different question attributes
*Have a look at the question type within the survey to see what could be improved.
*Check the workaround linked above and the demo survey to see where we would like to go to.
*Implement a generic solution to make the ranking question type a little nicer (no DB changes required).
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the limesurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 days||Javascript, PHP, CSS|| difficult||c_schmitz
|}

===Code: Add option to switch between bar chart and pie chart at statistics===

''Idea posted by: Mazi''

Limesurvey uses bar charts for multiple choice questions and pie charts for single choice questions. Often users want to switch to a different chart type so this fixed assignment of certain types should be replaced by a more dynamic system which allows the user to set chart types himself.

Task Steps:
*Install LimeSurvey - import a test survey with all question types (we can provide one) and add some test data.
*Have a look at the admin statistics and the charts that are created. Check how we could best offer a choice for the user to set chart types.
*Discuss your suggestions with your mentor and together create a concept how to deal with the problem.
*Implement a generic solution.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the limesurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|4 days||PHP, MySQL, a little HTML|| difficult||c_schmitz
|}

===Code: Refactor the CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. The code however is far from ideal. In order to improve code quality, there are plenty of refactorings required like splitting up long methods, extracting view-related and database-related code from controllers, adding new helper functions, ...

Task Steps:
*Download the LimeSurvey CI-branch
*Find a class or method with smelly (bad) code
*Discuss the code smell with the mentor and make a proposal on how to improve the code
*Work out the improvement and create a patch
*Discuss your patch with the mentor
*Check-in your changes into the limesurvey svn trunk

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days (depending on chosen smell)||PHP, CodeIgniter (depending on chosen smell)|| Moderate||mrp001
|}

===Code: Make unit tests for the CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. Now we are using the framework, it is possible to write unit tests for the different classes (domain classes, controllers, helpers, libraries, ...) The goal of this task is to write a unit test for an untested class or method.

Task Steps:
*Download the LimeSurvey CI-branch
*Find an untested class which could use some testing
*Discuss the badly tested class/method with the mentor and make a proposal on how to test the code
*Write tests for class/method and create a patch
*Discuss your patch with the mentor
*Check-in your changes into the limesurvey svn trunk.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days (depending on chosen class/method)||PHP, CodeIgniter (depending on chosen class/method)|| Moderate||mrp001
|}

===Code: Re-factoring HTML into views : CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, there are still some controllers which have lots of HTML content in them. This task aim for separating this HTML(wherever possible) from controllers and move it to View files. This task will be on controller by controller basis.

===Code: Re-factoring database calls into models (Browse Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Browse Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Browse Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Check Integrity Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Check Integrity Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Check Integrity Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Conditions Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Conditions Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Conditions Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Database Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Database Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Database Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Data Entry Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Data Entry Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Data Entry Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Email Templates Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Email Templates Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Email Templates Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Export Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Export Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Export Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Labels Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Labels Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Labels Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Printable Survey Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Printable Survey Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Printable Survey Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Question Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Question Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Question Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Question Group Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Question Group Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Question Group Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Quotas Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Quotas Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Quotas Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Saved Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Saved Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Saved Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Statistics Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Statistics Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Statistics Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Survey Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Survey Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Survey Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Survey Permission Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Survey Permission Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Survey Permission Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Templates Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Templates Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Templates Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Tokens Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Tokens Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Tokens Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (Translate Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

Translate Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in Translate Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (User Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

User Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in User Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

===Code: Re-factoring database calls into models (User Groups Controller): CodeIgniter branch===

This year LimeSurvey got ported to the CodeIgniter framework. As CodeIgniter is based on MVC architecture, all database calls should be in served via models and "Active Records" should be used everywhere. This task aim for searching through the

User Groups Controller and moving all database calls to models. (i.e. making new functions in models to serve the purpose and call it in controller instead of using db_execute_assoc()!).

Task Steps:
*Download LimeSurvey's CodeIgniter branch
*Read the Documentation
*Find outdated database calls in User Groups Controller (db_execute_assoc()).
*Identify which calls have equivalent methods in models.
*Port these calls using the existing models.
*Create or extend the models for the remaining calls.
*Port the remaining calls using the new models.
*Discuss the patch with your mentor and ask for feedback.
*Check-in your changes into the LimeSurvey svn trunk.
*Done!

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2-4 days||PHP, CodeIgniter, MySQL|| Moderate||dionet/magiclko
|}

==Documentation==

===Documentation: Rewrite template editor wiki page===

Limesurvey has a template editor which allows users to create and modify templates used when displaying surveys. These templates allow survey administrators to adjust the look and feel of their surveys and brand them as well. Currently the documentation for the template editor is out of date needs to be brought up to date with the latest version of limesurvey. Cropped screenshots should also be inserted to visually reference the documentation and the software.

Task Steps:
*Read the existing outdated documentation.
*Explore limesurvey's template editor and compare it to the existing documentation.
*Design a new structure for the documentation which is easy to follow and well structured.
*Discuss your planned documentation structure with your mentor.
*Rewrite the template editor documentation.
*Insert cropped screenshots where needed.
*Submit your documentation for review by your mentor.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 Days||Wiki editing,LimeSurvey|| Moderate [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]

}

===Documentation: Create a tutorial about how to replace the logo at a shipped template===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

Limesurvey has a template editor which allows users to create and modify templates used when displaying surveys. These templates allow survey administrators to adjust the look and feel of their surveys and brand them as well. Problem is that some HTML and CSS knowledge is needed to fully style a template and this might be a problem to the common user. Usually replacing the logo at one of the shipped templates is all they need so the goal is to write a step by step tutorial with some screen shots about how to replace the logo.

Task Steps:
*Read the existing documentation about templates and create a new entry at the [http://docs.limesurvey.org/The+template+editor&structure;=English+Instructions+for+LimeSurvey#Tips_amp_Tricks Tipps & Tricks sub-section].
*Explore limesurvey's template editor and compare it to the existing documentation.
*Check the template editor at our demo system and note how the logos are embedded at different templates
*Write a step by step tutorial including screen shots on how to replace the images and/or change the logo file name at the templates
*Submit your documentation for review by your mentor.
*Discuss your tutorial with your mentor and if necessary overwork some parts
* Add everything at our wiki.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 Days||Wiki editing, LimeSurvey, HTML|| Easy [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]

}

===Documentation: Rewrite statistics wiki page===

Limesurvey offers public statistics, which are shown to the user at the end of the survey, as well as more detailed statistics at the admin backend. The [http://docs.limesurvey.org/tiki-index.php?page=Statistics&structure;=English+Instructions+for+LimeSurvey current statistics documentation] is outdated and not very well structured. Lots of users don't know that they can filter data and limit statistics to certain questions only.

To make the statistics more clear to the user, the documentation should be updated, extended and better structured. A video showing how to set filters and demonstrating other statistic features should be added, too.

Task Steps:
*Import the sample survey at /docs/demosurveys which contains all question types.
*Enable public statistics for this survey and all questions that are supported by this feature.
*Fill out the survey ~20-30 times (ask your friends for some help) to create some data to be used by the statistics.
*Explore the public and admin backend statistics and write down which features are available.
*Ask your mentor if all features are on your list.
*Think about a new structure for the wiki page
*Document each section and describe each feature in detail. Add some nice screenshots where appropriate.
*Create a short video showing how to set filters and use other important features.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|4 Days||Wiki editing, LimeSurvey, video capture|| Moderate [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]

}

===Documentation: Rewrite installation procedure.===

LimeSurvey 2.0 has a new automatic installer which makes installation process a cake-walk. Hence, installation procedure needs to be updated explaining each and every step of the installation procedure and possible errors/warnings that a user might see during installation of LimeSurvey and there solutions.

Task Steps:
*Checkout LimeSurvey_CI branch.
*Read existing installation procedure.
*Run the automatic installer and play with it.
*Compare the missing things and update the wiki.
*Write down any error/warning you see during installation or while playing around with it.
*Make a troubleshooting section on installation wikipage which should contain possible warnings a user might see and there solution(s).
*Create a short video tutorial on how to install LimeSurvey.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|4 days||Wiki editing, creating screen shots, writing documentation, creating videos|| difficult||magiclko
|}

==Outreach & Marketing==

===Outreach: Blog about LimeSurvey===

Write an independant article about LimeSurvey on your blog. Explain what are advantages, what are disadavantages of the software - show how to create a first survey and also write about problems are on the way getting there. Motivate people to participate to help use make LimeSurvey better. The article should be in-depth and correct. It should help other to get hooked up without false promises.

Task Steps:
*Use LimeSurvey to setup your own survey (you can use our demo version for that)
*Blog about your experience after discussing your article with us.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 Days|| Writing skills || Easy ||c_schmitz
|}

===Marketing: Create an article on how to use LimeSurvey and OrangeHRM to conduct an employee engagement survey===

OrangeHRM is a powerful and fully featured Human Resource Management Tool. Help empower open source by showing how two separate open source products can be used together to bring added value to their users.

The article should include:
#An introduction.
#Setting up an employee engagement survey with LimeSurvey.
#Patching OrangeHRM (CustomExport.php and CustomizableCSVExport.php models) to allow the work_email field to be exported.
#Creating a custom export in OrangeHRM with the fields: firstName, lastName, workEmail.
#Using the OrangeHRM custom export to get a CSV list for LimeSurvey tokens import.
#Importing the tokens into the employee engagement survey.
#Sending out invitations and reminders.
#Viewing statistics and exporting results.
#Provide links to patched OrangeHRM files and example survey.
#Article conclusion.

Task Steps:
*Install OrangeHRM.
*Create the employee engagement survey.
*Discuss the employee engagement metrics measured with your mentor.
*Modify OrangeHRM custom export and generate patches (mentor can provide changes).
*Test the OrangeHRM custom export and LimeSurvey tokens import.
*Write the article.
*Submit the article to your mentor for review.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|4 Days||Survey Creation, Technical Writing, Source Code Patching|| Moderate||Machaven
|}

===Marketing: Create an article on how to use LimeSurvey and OrangeHRM to conduct an employee satisfaction survey===

OrangeHRM is a powerful and fully featured Human Resource Management Tool. Help empower open source by showing how two separate open source products can be used together to bring added value to their users.

The article should include:
#An Introduction.
#Setting up an employee satisfaction survey with LimeSurvey.
#Patching OrangeHRM (CustomExport.php and CustomizableCSVExport.php models) to allow the work_email field to be exported.
#Creating a custom export in OrangeHRM with the fields: firstName, lastName, workEmail.
#Using the OrangeHRM custom export to get a CSV list for LimeSurvey tokens import.
#Importing the tokens into the employee satisfaction survey.
#Sending out invitations and reminders.
#Viewing statistics and exporting results.
#Provide links to patched OrangeHRM files and example survey.
#Article conclusion.

Task Steps:
*Install OrangeHRM.
*Create the employee satisfaction survey.
*iscuss the employee satisfaction metrics measured with your mentor.
*Modify OrangeHRM custom export and generate patches (mentor can provide changes).
*Test the OrangeHRM custom export and LimeSurvey tokens import.
*Write the article.
*Submit the article to your mentor for review.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|4 Days||Survey Creation, Technical Writing, Source Code Patching|| Moderate||Machaven
|}

===Marketing: Create an article on how to use LimeSurvey to create and distribute a customer satisfaction survey===

Show current and potential LimeSurvey users how they can use LimeSurvey to do customer satisfaction surveys.

The article should include:
#An Introduction.
#Setting up an customer satisfaction survey with LimeSurvey.
#Importing the tokens into the customer satisfaction survey.
#Sending out invitations and reminders.
#Viewing statistics and exporting results.
#Provide a link to the example customer satisfaction survey.
#Article conclusion.

Task Steps:
*Create the customer satisfaction survey and test it.
*Discuss the customer satisfaction metrics measured with your mentor.
*Write the article.
*Submit the article to your mentor for review.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|4 Days||Survey Creation, Technical Writing, Source Code Patching|| Moderate||Machaven
|}

==Quality Assurance==

===Quality Assurance: Analyse user feedback and port suggestions to our idea tracker===

From time to time Limesurvey [http://survey.limesurvey.org/ conducts user feedback surveys] to find out how our users use the software and which features they are missing. We received quite a lot feedback during the last months and a lot of valuable information can be found at the textual feedback. It's a mixture of praise, suggestions for new features and other useful comments. This needs to be summed up. Also useful suggestions for new features should be ported to [http://ideas.limesurvey.org/ our idea tracker] so we have this on our list for future development.

Task Steps:
*We will give you access to our survey system so you can export the survey data into MS Word, Excel or what else you like.
*Go through all the textual user feedback and create a list of common complaints, suggested features and the like.
*Once you are done, order the lists by frequency and present it to your mentor.
*Your mentor will go through your list and mark those ideas worth porting to the idea tracker.
*Add ideas to the idea tracker

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 Days||Data analysis, Report Writing, Using idea tracker|| Moderate [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]

}

===Quality Assurance: Find and report 3 bugs or GUI design issues at the new Central Participant Database feature of the upcoming Limesurvey 2.0alpha version (1/2)===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

During this years Google Summer of Code a cool new feature called "Central Participant Database" was coded. It will be available at the upcoming Limesurvey 2.0 alpha release. Though this feature was carefully tested there might still be some bugs in there and we want you to have a detailed look at this feature to check if you can find any weird behavior, misleading user interface or bugs.

Task Steps:
*Have a look at our [http://www.limesurvey.org/en/component/content/article/1-general-news/226-new-qcentral-participants-databaseq-feature-is-ready-for-testing testing instructions] and the [http://docs.limesurvey.org/Central+participants+database+%28User+panel%29 CPDB documentation].
*Test this feature by checking each single function and note any weird behavior, error messages or anything else you think is worth being improved.
*Your mentor will go through your list and will discuss the details with you.
*Add all issues to the bugtracker.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 Days||Using bugtracker, Limesurvey|| Easy ||Aniessh
|}

===Quality Assurance: Find and report 3 bugs at the new Expression Manager feature of the upcoming Limesurvey 2.0alpha version (1/2)===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

At the upcoming Limesurvey 2.0 alpha release conditions will be replaced by a powerful Expression Manager (EM). This feature is capable to evaluate all kinds of expressions and it will be used for other feature besides conditions as well.

Since this is a new feature with a very complex logic we have to test it carefully. Therefore it's your task to create tests and see if everything works as expected.

Task Steps:
*Have a look at our [http://www.limesurvey.org/en/component/content/article/1-general-news/226-new-qcentral-participants-databaseq-feature-is-ready-for-testing testing system details] and the [http://docs.limesurvey.org/Expression+Manager EM documentation].
*Test this feature by checking each single function and note any weird behavior, error messages or anything else you think is worth being improved.
*Your mentor will go through your list and will discuss the details with you.
*Add all issues to the bugtracker.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 Days||Using bugtracker, Limesurvey|| Moderate||TMS White
|}

===Quality Assurance: Find and report 3 bugs at the overworked Admin Backend of the upcoming Limesurvey 2.0alpha version (1/2)===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

During this years Google Summer of Code we ported the whole Limesurvey code to an MVC framework called codeigniter. This implied a whole bunch of code changes and re-design. Though this feature was carefully tested, there might still be some bugs in there and we want you to have a detailed look at this feature to check if you can find any weird behavior, misleading user interface or bugs.

Task Steps:
*Have a look at the Limesurvey admin feature. Play around with the available features and check if all works as described at the manual. If not, note all details about the problem.
*Find out which new features were added at Limesurvey 2.0 and check the according sections at the admin panel carefully. Note any weird behavior.
*Your mentor will go through your list and will discuss the details with you.
*Add all issues to the bugtracker.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 Days||Limesurvey, Using bugracker|| Moderate||dionet
|}

===Quality Assurance: Find and report 3 bugs at the overworked Survey Engine of the upcoming Limesurvey 2.0alpha version (1/2)===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

During this years Google Summer of Code we ported the whole Limesurvey code to an MVC framework called codeigniter. This implied a whole bunch of code changes and re-design. Though this feature was carefully tested there might still be some bugs in there and we want you to have a detailed look at this feature to check if you can find any weird behavior, misleading user interface or bugs.

Task Steps:
*Import a test survey with all question types and most of the additional question attributes (we can provide some test surevys).
*Check if data for each question type is stored correctly, if conditions work as expected and all other available features listed at our documentation.
*Note any weird behavior, error messages and the like.
*Your mentor will go through your list and will discuss the details with you.
*Add all issues to the bugtracker.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 Days||Limesurvey, Using bugracker|| Moderate||dionet
|}

===Quality Assurance: Find and report 3 bugs or GUI design issues at the new Central Participant Database feature of the upcoming Limesurvey 2.0alpha version (2/2)===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

During this years Google Summer of Code a cool new feature called "Central Participant Database" was coded. It will be available at the upcoming Limesurvey 2.0 alpha release. Though this feature was carefully tested there might still be some bugs in there and we want you to have a detailed look at this feature to check if you can find any weird behavior, misleading user interface or bugs.

Task Steps:
*Have a look at our [http://www.limesurvey.org/en/component/content/article/1-general-news/226-new-qcentral-participants-databaseq-feature-is-ready-for-testing testing instructions] and the [http://docs.limesurvey.org/Central+participants+database+%28User+panel%29 CPDB documentation].
*Test this feature by checking each single function and note any weird behavior, error messages or anything else you think is worth being improved.
*Your mentor will go through your list and will discuss the details with you.
*Add all issues to the bugtracker.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 Days||Using bugtracker, Limesurvey|| Easy ||Aniessh
|}

===Quality Assurance: Find and report 3 bugs at the new Expression Manager feature of the upcoming Limesurvey 2.0alpha version (2/2)===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

At the upcoming Limesurvey 2.0 alpha release conditions will be replaced by a powerful Expression Manager (EM). This feature is capable to evaluate all kinds of expressions and it will be used for other feature besides conditions as well.

Since this is a new feature with a very complex logic we have to test it carefully. Therefore it's your task to create tests and see if everything works as expected.

Task Steps:
*Have a look at our [http://www.limesurvey.org/en/component/content/article/1-general-news/226-new-qcentral-participants-databaseq-feature-is-ready-for-testing testing system details] and the [http://docs.limesurvey.org/Expression+Manager EM documentation].
*Test this feature by checking each single function and note any weird behavior, error messages or anything else you think is worth being improved.
*Your mentor will go through your list and will discuss the details with you.
*Add all issues to the bugtracker.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 Days||Using bugtracker, Limesurvey|| Moderate||TMS White
|}

===Quality Assurance: Find and report 3 bugs at the overworked Admin Backend of the upcoming Limesurvey 2.0alpha version (2/2)===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

During this years Google Summer of Code we ported the whole Limesurvey code to an MVC framework called codeigniter. This implied a whole bunch of code changes and re-design. Though this feature was carefully tested, there might still be some bugs in there and we want you to have a detailed look at this feature to check if you can find any weird behavior, misleading user interface or bugs.

Task Steps:
*Have a look at the Limesurvey admin feature. Play around with the available features and check if all works as described at the manual. If not, note all details about the problem.
*Find out which new features were added at Limesurvey 2.0 and check the according sections at the admin panel carefully. Note any weird behavior.
*Your mentor will go through your list and will discuss the details with you.
*Add all issues to the bugtracker.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|2 Days||Limesurvey, Using bugracker|| Moderate||magiclko
|}

===Quality Assurance: Find and report 3 bugs at the overworked Survey Engine of the upcoming Limesurvey 2.0alpha version (2/2)===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

During this years Google Summer of Code we ported the whole Limesurvey code to an MVC framework called codeigniter. This implied a whole bunch of code changes and re-design. Though this feature was carefully tested there might still be some bugs in there and we want you to have a detailed look at this feature to check if you can find any weird behavior, misleading user interface or bugs.

Task Steps:
*Import a test survey with all question types and most of the additional question attributes (we can provide some test surevys).
*Check if data for each question type is stored correctly, if conditions work as expected and all other available features listed at our documentation.
*Note any weird behavior, error messages and the like.
*Your mentor will go through your list and will discuss the details with you.
*Add all issues to the bugtracker.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 Days||Limesurvey, Using bugracker|| Moderate||magiclko
|}

==Training==

===Training: Create a video tutorial for creating a custom survey template===

Limesurvey has a template editor which allows users to create and modify templates used when displaying surveys. These templates allow survey administrators to adjust the look and feel of their surveys and brand them as well. Create a video tutorial showing users how to create a copy of the default template and modify it.

The Video should include:
#An overview of the template editor and a description of what each area of the template editor is used for.
#An explanation of the different screens.
#Inserting a company logo in to the template.
#Basic adjustments in the css to modify the appearance of questions.
#Customizing the survey description page.
#Customizing the end page.

It will be best to record each video section separately and then join the video at the end. Your will need to create a script for your video which includes all the steps you will be showing in your video and the dialog associated with each step.

Task Steps:
*Create a script with dialog to explain what will be done in the video from start to end.
*Submit your video script to your mentor for review.
*Record/Produce each section for your video tutorial.
*Submit each video to your mentor for review.
*Merge your video sections into an xvid avi with mp3 audio.
*Submit your video to your mentor.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|4 Days||Screen Recording, Video and Sound Editing|| Moderate||Machaven
|}

===Training: Create a video tutorial for creating a new survey from scratch===

There are several videos around explaining how to create a survey with LimeSurvey. Unfortunately most of the are pretty outdated and old. We would like to have a kick-all video tutorial explaining how to create a survey that immediately will hook up people.

The Video should include:
#Creation of a survey, with an easy explanation of the concept behind it (Survey->Question groups->Questions)
#Creating the survey, explaining the most important settings
#Creating question groups and questions plus answers
#Showing off a number of question types
#Showing off how a simple condition is created.
#Activating the survey

It will be best to record each video section separately and then join the video at the end. Your will need to create a script for your video which includes all the steps you will be showing in your video and the dialog associated with each step.

Task Steps:
*Create a script with dialog to explain what will be done in the video from start to end.
*Submit your video script to your mentor for review.
*Record/Produce each section for your video tutorial.
*Submit each video to your mentor for review.
*Merge your video sections into an xvid avi with mp3 audio.
*Submit your video to your mentor.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|4 Days||Screen Recording, Video and Sound Editing|| Moderate||Machaven
|}

===Training: Create demo surveys for the most important features===

Limesurvey offers a wide range of features. Some of them are a little complex to set up in a survey. To help new users getting familiar with these feature, we intend to create several sample surveys which users can easily download from our manual and import for testing.

Each survey should contain 8-10 questions, depending on the feature that is demonstrated.

List of sample surveys:
#Use of [http://docs.limesurvey.org/tiki-index.php?page=Question+attributes#Array_Filter_and_Array_Filter_Exclusion array filter and array exclusive option]
#How to set different types of [http://docs.limesurvey.org/tiki-index.php?page=Setting+conditions&structure;=English+Instructions+for+LimeSurvey conditions]
#Create a quiz using [http://docs.limesurvey.org/tiki-index.php?page=Assessments&structure;=English+Instructions+for+LimeSurvey assessments ]and [http://docs.limesurvey.org/tiki-index.php?page=SGQA+identifier&structure;=English+Instructions+for+LimeSurvey SGQA identifier] to show the users answers at the end of the survey.
#Screen users by making use of [http://docs.limesurvey.org/tiki-index.php?page=Quotas&structure;=English+Instructions+for+LimeSurvey quotas]
#Demonstrate the use of ~10 different [http://docs.limesurvey.org/tiki-index.php?page=Question+attributes&structure;=English+Instructions+for+LimeSurvey question attributes].

Task Steps:
*Get familiar with Limesurvey by using our [http://docs.limesurvey.org/tiki-index.php?page=Question+attributes&structure;=English+Instructions+for+LimeSurvey demo ]or installing Limesurvey yourself.
*Read the documentation linked above.
*Create a first survey and ask your mentor for feedback.
*Create the rest of the surveys.
*Create a topic in our forum and ask for some user feedback.
*Add feedback where useful.
*Merge all surveys in a big demo survey using group/question import/export while keeping the smaller survey versions.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|4 Days||Creating surveys using Limesurvey, communicate with coomunity|| easy [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]

}

===Training: Create a "How to design a ''good'' survey" tutorial===

''Idea posted by: [http://docs.limesurvey.org/tiki-index.php?page=UserPage+Mazi Mazi]''

Our manual describes all available features in detail but we don't have instructions on how to create a good survey yet, e.g. users might have huge matrix question which are all mandatory at their survey, that's a no go. Your task is to find out about some basics of survey design by asking google and asking our experienced users at the forum and then collect that data and structure it so we can have a list of issues one should take care of when designing a survey.

Task Steps:
*Create a new forum topic explaining your task and asking for user feedback. Ask your mentor to also link this post at www.limesurvey.org and to twitter about it.
*Ask Google about the important issues when creating an online survey
*Sum up all information and create a structured document which deals with different parts to take care of.
*Discuss the work with your mentor
*Port all the details to a new wiki page
*Add the wiki page at a new tipps & tricks section of our wiki

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 days||Using search engines, writing documentation|| easy||holch
|}

==Research==

===Research: Usability testing===

Usability testing and user input is a great source of ideas for improving your application. The goal of this assignment is to identify usability problems in LimeSurvey and discussing possible solutions for them.

The general steps for this assignment would be:
#Work with LimeSurvey like a regular user would
##Set up a new survey
##Answer the survey at least once
##Make changes to the survey
##Use and export the results
##… (be creative!)
#Identify usability problems in LimeSurvey
##What was good/lacking in LimeSurvey?
##What was easy/hard to do?
#Discuss possible solutions to these usability problems with your mentor
#Write a social media post (blog, facebook, twitter) about your work at LimeSurvey, discuss the problems you have found and the ideas your propose to solve them.
##Tell others about what you have done during this assignment and how awesome LimeSurvey and their dev team is.

For this assignment it is possible to make use of LimeService . LimeService provides free LimeSurvey installs for small users and requires no installation (even though installation could be a usability test in itself! How easy is it to install LimeSurvey). We advice to google for common usability problems before starting this assignment as a source of inspiration.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 Days||None, skills in web development are a plus|| Easy||ttielu
|}

===Research: Use Google Analytics to create a report about the common Limesurvey user===

''Idea posted by: Mazi''

Limesurvey uses Google Analytics to gather some basic background information about our users like where they come from, which browser they are using, which pages are visited most and the like. Because Google Analyitcs offers a lot of information we need a summary of the most important details. That's where you can give a helping hand.

Task Steps:
*We will grant you access to our Google Analytics account so you can play around with the data a little
*Have a look at the available information and create a list of available data. Mark which data you consider important.
*Discuss the list and your proposed priorities with your mentor
*After we have agreed on the information the final report should include, gather the required information and create a report containing a 1 page summary plus 3-4 pages of additional information and charts.
*Discuss the work with your mentor
*Create a news article for the www.limesurvey.org website summing up your findings.

{|
|Time frame||Skills||Difficulty||Mentor
|-
|4 days||writing reports (MS WOrd/Excel)|| moderate||Mazi
|}

==User interface==

===User interface: Icon creation===

As easy as it is sounds icon creation is a demanding task. Icons have to fit to the existing theme and their meaning must be untuitive without being hard on the eye. We want you to create three icons for for LimeSurvey that represent the following entities:
*Survey
*Question group
*Question

The icons must fit to the existing theme and shoudl be create using Inkscape as SVG file.
#Have a look at our existing icons in the LimeSurvey interface
#Have a look at our existing icons in SVG format in our Subversion repository at https://limesurvey.svn.sourceforge.net/svnroot/limesurvey/source/original art
#Create a couple drafts with a tool of your choice
#Discuss the drafts with your mentor
#Create the final icons

{|
|Time frame||Skills||Difficulty||Mentor
|-
|3 Days||Design, Inkscape|| Easy||c_schmitz
|}

===User interface: Workflow improvements===

''Idea added by: Mazi''

There are some sections at the Limesurvey admin backend at which workflow improvements can be added. Often a summary page is shown even if you just made a minor change. Instead we should speed up the workflow and show just a pop-up, just to name a few issues.

This is a list of issues I (Mazi) noticed. We can later splitt this up into some small and easy tasks:
*Problem: When adding new answer options and clicking into the answer text field, you have to manually delete the "Some example subquestion" text. For following answer options the text is deleted automatically when clicking into the input field.
*Solution: Add some Javascript to automatically delete the text once a user clicks into the input field.
*Problem: When switching to the token admin screen you don't see a list of available tokens. You have to click on the "Display Tokens" icon first.
*Solution: List all tokens below the "Token Summary" and above the "Token database options".
*Problem: After having added a token entry you only see a short "New token was added" message with options to display tokens or add another token.
*Solution: It would be better to show the confirmation as a pop-up, like it is done after having added answer options or having changed global settings, and directly move on to the "add token entry" page because usually users want to add several token entries one by one.
*Alternative solution: When adding a token have two radio options above the save button: a) add another token after save (should be default) OR b) display tokens after save.
*Problem: When creating a new survey there are options to import or copy a survey. BUT there is a "save" button after the "import/copy survey" button as well. This is irritating because users might click the save button instead and then an error message will show up because no survey title etc. was entered at the previous tabs
*Solution: Hide "save" button at import and copy tab.

'''''TO BE CONTINUED'''''
*Problem: ...
*Solution: ...

Steps:
#Check the described issues using the online system we provide
#Search for the according code piece
#Overwork the code to improve the workflow
#Create a patch file and send it to your mentor for review.
#Once the mentor accepts your patch he will add it to the current development branch

{|
|Time frame||Skills||Difficulty||Mentor
|-
|X Days||PHP, maybe a little HTML and Javascript|| Easy||c_schmitz
|}

=We want your ideas!=

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.

==Getting Started==
*[http://docs.limesurvey.org/tiki-index.php?page=GSoC_Getting_Started How to get started with LimeSurvey]

How to Get Started With LimeSurvey:

- setting up the development environment, coding standards, and all the other important stuff that you need to know before the real fun begins!