Project ideas for GSoC 2015
From LimeSurvey Manual
Welcome
Project ideas
Update Limesurvey Template Engine to use Twig
Currently Limesurvey uses its own custom coded template engine. Since the framework used for Limesurvey ("Yii") supports the Twig template engine we plan to replace the custom coded template engine with Twig's template engine for better code maintenance and embedding with the Yii framework.
Steps
- Check how the current Limesurvey templates are structured
- Dig into the related code to find out how the underlying Limesurvey template engine works
- Get familiar with the structure of Twig templates
- Test-edit one of the shipped templates and make it twig-compatible
- Embed the Twig template engine into Limesurvey
- Test your test template and the Twig template engine carefully
- Adjust further shipped Limesurvey templates
Skills
You should know how a template engine and framework works. In addition to that HTML and CSS skills are required for adjusting the shipped Limesurvey templates. You should also know about PHP because switching the template engine will require adjustments of the Limesurvey source code as well.
Difficulty
Easy to medium
Mentor(s)
Marcel Minke (Mazi)
When creating a survey at the Limesurvey admin interface the current page structure is: survey list -> survey question groups -> questions (within the current group)
That structure forces users to often navigate using the drop down and back/next buttons when dealing with larger surveys. Having a new menu on the left presenting a structured overview of all question groups with all their questions would help a lot to easily jump from question X to question Y. That new overview should contain icons for:
- Deleting a question/question group
- Directly jumping to the survey question/question group edit mode
- Copying a survey question
- Adding a new question/question group at the appropriate survey section
Steps
- Check how the current Limesurvey survey designer is structured
- Have a look at the different features available on the different levels (survey/question group/question)
- Think which features could additionally be added to the icon list above
- Check the related code for creating a full overview of question groups + questions
- Adjust the admin GUI to embed the additional overview on the left
- Create the code for the new overview and the functions presented by the different icons (most of that code is already there)
- Testing, testing, testing...
Skills
You should be familiar with the "Yii" framework we are using for Limesurvey or at least other PHP frameworks. A good understanding of object-oriented PHP programmierung is required as well. For adjusting the GUI moderate HTML + CSS skills are needed.
Difficulty
Easy
Mentor(s)
Carsten Schmitz
SettingsWidget for core
Use and update (if needed) extension SettingsWidget for core Survey forms.
Some forms to be updated:
- Survey settings
- Personal settings
- Users settings
- Export settings
Skills
PHP, html, js and css
Difficulty
Easy to moderate : some settings can be more diffcult
Link on mantis
Mentor(s)
Expression Manager JavaScript optimization
Actually the Expression Manager in LimeSurvey uses inline JavaScript for relevance, updating classes and updating HTML. In its current state an administrator or extension developer can not use their own functions. The task is to update Expression manager inline JavaScript to use an JavaScript-only event on update expression manager javascript to call an actual function on this events.
The second part of this task is to move inline Javascript to jQuery. In the old current system each input (when taking a survey) uses the onchange/onkeyup function to fire events. The idea is to remove these inline code and use only JavaScript/jQuery general code where possible.
Skills
Some PHP to update Expression Manager class, deep jQuery/JavaScript knowledge. A jQuery plugin might be a great idea.
Difficulty
Moderate
Mantis
Mentor(s)
Revamp database grids in LimeSurvey
We have various data table/lists in LimeSurvey - for example when listing surveys, tokens or responses. With most of these lists we use jqGrid, some don't use any Javascript widget at all.
All instances of data lists in LimeSurvey should be replaced with a proper Javascript grid (which has to be chosen yet) and a related widget in Yii. As smarter as you will choose the data grid and as better the related Yii widget is coded as easier you will be able to replace the existing jqGrid with your better version.
All lists need to be customized in some way - for example with token editing we will need mass editing functions - for example you should be able to set all tokens to be unused, reset invitation/reminder date/time or similar.
Skills
- Good PHP and JavaScript skills
- Experience with jQuery and Bootstrap, AJAX
Difficulty
Medium difficulty - getting accustomed to the Yii 1.1 widget system and replacing the existing jqGrid functionality will be the difficult part.
Mentor(s)
- Carsten Schmitz
- Sam Mousa
Replace current CKEditor usage with TinyMCE
LimeSurvey currently uses extensively CKEditor to let people edit their question texts. However the CKEditor version we are using is outdated and some components are difficult to update due to CKeditor limitations. Also we use a customized CKeditor widget and a file browser widget that needs to be replaced with newer & better version.
We have concluded that TinyMCE will be the best replacement as the codebase is very stable and it offers a plugin interface.
Your task would be to replace CKEditor instances with TinyMCE - also a widget for Yii should be written to ease any future implementation. As mentioned before the functionality of the existing CKEditor extensions need to be ported as TinyMCE plugins.
Skills
- Good PHP and JavaScript skills
- Experience with jQuery and Bootstrap, AJAX
Difficulty
Medium difficulty - getting accustomed to the Yii 1.1 widget system and replacing the existing CKEditor functionality will be the difficult part.
Mentor(s)
- Carsten Schmitz
- Sam Mousa
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
Mentor(s)
Put your name (and tag) here if you are willing to mentor a student for this idea