https://www.limesurvey.org/api.php?action=feedcontributions&feedformat=atom&user=P+teichmannLimeSurvey Manual - User contributions [en]2026-08-16T17:33:22ZUser contributionsMediaWiki 1.43.9https://www.limesurvey.org/manual/index.php?title=Coding_guidelines&diff=381800Coding guidelines2026-08-13T10:18:32Z<p>P teichmann: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=General=<br />
<br />
'''This is a free development, everything you do can be useful for others. If the feature is very personal there is a way to turn it into a universal solution. This is the challenge!'''<br />
<br />
<div class="simplebox">"The difficulty within a solution is to solve it in a simple way"<br />
<br />
(Lance Burton, magician)</div><br />
<br />
Some general rules:<br />
*Be efficient and save resources (memory and runtime). Things might work for a small survey but also try out your new feature with a survey that has 400 question, 5 languages and 20,000 responses (Yes, there are surveys like this out there).<br />
*Keep a fluid dialog with the others coders, they have their own thoughts about what you are doing.<br />
*Ask if you are in doubt.<br />
<br />
=Documentation=<br />
<br />
Please document your source code - see this introduction: [[How to document your source code]].<br />
<br />
= Coding Standards and MVC Architecture in LimeSurvey Development =<br />
<br />
LimeSurvey is built on the '''Yii framework''', which provides the foundation for its Model-View-Controller (MVC) structure. Yii has its own conventions and tools that influence how models, views, and controllers are implemented. While some areas of the LimeSurvey codebase predate the adoption of Yii or use older approaches, new development should always align with Yii’s MVC principles and the guidelines described below.<br />
<br />
As you probably know it is an '''open-source survey platform''' with contributions from developers around the world. Like many long-lived open-source projects, its codebase has evolved over time, and you may encounter different approaches to structuring the code. Some older parts of the system may not follow modern best practices or the '''Model-View-Controller (MVC)''' architecture as strictly as newer code.<br />
<br />
While this variety reflects the project’s history, new development should follow the current standards. Staying focused on the recommended guidelines helps keep LimeSurvey maintainable, testable, and easier to extend in the future—without being distracted by legacy approaches.<br />
<br />
== Understanding MVC in LimeSurvey ==<br />
<br />
The '''MVC pattern''' divides an application into three interconnected layers, each with a clear responsibility:<br />
<br />
* '''Models''' – Represent the data and contain business rules related to that data. Models handle database interactions, validations, and data transformations. <br />
* '''Views''' – Manage the presentation layer. They are responsible for displaying information to the user and should not contain business logic. <br />
* '''Controllers''' – Act as intermediaries, handling incoming requests, coordinating with models, and choosing the correct views to render. <br />
<br />
By keeping these responsibilities separate, developers can more easily test, extend, and debug their code.<br />
<br />
== Where Business Logic Belongs ==<br />
<br />
One of the most common pitfalls in MVC development is misplacing business logic. In LimeSurvey development, the recommended approach is:<br />
<br />
* '''Models''': Store business rules and perform operations directly related to the data, such as validations and relationships. <br />
* '''Service Classes''': Handle more complex operations that span across multiple models or involve higher-level application logic. For example see: \LimeSurvey\Models\Services\QuestionAggregateService <br />
<br />
Controllers should remain as thin as possible. Their main role is to receive requests, pass data to the appropriate services or models, and return responses via the correct views.<br />
<br />
== Best Practices for Clean Code ==<br />
<br />
To keep your LimeSurvey contributions maintainable and consistent with the project’s standards, follow these practices:<br />
<br />
* '''Keep controllers lightweight''' – They should primarily manage request/response flow and delegate logic to models or services. <br />
* '''Move complex logic into service classes''' – If a piece of functionality requires multiple steps or involves multiple models, encapsulate it in a dedicated service. <br />
* '''Use models for data operations''' – Models should clearly represent data structures and provide methods for interacting with the database. <br />
* '''Keep views presentation-only''' – Views should focus on displaying data. They should not contain calculations, validations, or business rules. <br />
* '''Apply dependency injection''' – This improves testability and flexibility by avoiding hard-coded dependencies. <br />
<br />
= Twig Templates in LimeSurvey =<br />
<br />
LimeSurvey uses the '''Twig templating engine''' for rendering much of the survey-taking interface. Twig provides a clean separation between logic and presentation, making it easier to customize themes and maintain a consistent look and feel across surveys.<br />
<br />
== What is Twig? ==<br />
<br />
Twig is a fast, secure, and flexible templating language for PHP. It allows developers and theme designers to write templates that are easy to read and extend, without mixing in raw PHP code. <br />
<br />
== Where LimeSurvey Uses Twig ==<br />
<br />
Twig is primarily used in the survey-taking portion of LimeSurvey:<br />
* '''Survey themes''' – Layout, structure, and style of the survey pages <br />
* '''Question rendering''' – How individual questions and groups are displayed <br />
* '''Template overrides''' – Custom themes can override core Twig templates for tailored designs <br />
<br />
== Best Practices for Twig in LimeSurvey ==<br />
<br />
When working with Twig templates in LimeSurvey, follow these guidelines:<br />
* '''Keep logic out of templates''' – Use Twig for presentation only, not business rules <br />
* '''Test in multiple themes''' – Ensure your changes work across different devices and survey layouts <br />
<br />
== Developer Tips ==<br />
<br />
* Default Twig templates for survey-taking are located in the `application/views/survey/` and theme directories. <br />
* Custom survey themes should include a `twig` folder for template overrides. <br />
* Always clear LimeSurvey’s cache after making changes to Twig files to see updates. <br />
* Review the official [https://twig.symfony.com/doc/ Twig documentation] for the full syntax and feature set. <br />
<br />
[[Category:Development guidelines]]<br />
[[Category:Survey themes]]<br />
<br />
= JavaScript Packages in LimeSurvey =<br />
<br />
LimeSurvey includes several JavaScript packages that provide functionality for the administration interface as well as the survey-taking environment. These packages are organized under the `assets/packages/` directory and are built to keep front-end code modular, maintainable, and consistent.<br />
<br />
== Overview ==<br />
<br />
JavaScript in LimeSurvey is mostly organized into '''packages''' that can include:<br />
* JavaScript source files <br />
* Stylesheets (CSS/SCSS) <br />
* Build configuration (Webpack, npm/yarn dependencies) <br />
<br />
When developing new js this package approach should be followed. <br />
This ensures that front-end code can be bundled, minified, and versioned properly, while avoiding duplication and conflicts.<br />
<br />
== Building JavaScript Packages ==<br />
<br />
When a new feature requires JavaScript functionality, it is typically developed inside a dedicated package folder under `assets/packages/`. Each package can define:<br />
* An `src/` directory for source files <br />
* A `dist/` or `build/` output for the compiled files <br />
* Dependencies declared in `package.json` <br />
<br />
The build system (commonly Webpack or a similar bundler) compiles modern JavaScript (ES6+) and frameworks like Vue into browser-ready files. These are then registered in LimeSurvey’s asset manager to be loaded when needed.<br />
<br />
== Example: adminbasics ==<br />
<br />
The package `assets/packages/adminbasics` contains JavaScript and styles used across the LimeSurvey administration interface. <br />
<br />
Typical functionality includes:<br />
* General UI helpers <br />
* Event handlers for common actions in the admin panel <br />
<br />
This package acts as a foundation layer for other admin UI features.<br />
<br />
The dependencies for adminbasics package need to be installed with the command yarn.<br />
<br />
There are the following commands available:<br />
* dev to build a non minified version of the assets with rollup<br />
* prod to build a minified version of the assets with rollup<br />
* build to build a non minified and a minified version of the assets with rollup in one step<br />
* test to run the test cases<br />
<br />
== Example: adminsidepanel (Vue.js) ==<br />
<br />
The package `assets/packages/adminsidepanel` provides the code for the collapsible side panel in the administration interface. Unlike other parts of LimeSurvey, this package is built with the '''Vue.js framework'''. <br />
<br />
Key points:<br />
* The side panel is a '''Vue single-page component''' embedded into the admin UI <br />
* Vue allows the panel to be reactive, updating its content dynamically without reloading the whole page <br />
* The build process compiles `.vue` files and JavaScript modules into a single bundle served by LimeSurvey <br />
<br />
For building this package, you need to have node version 14 installed (not higher!)<br />
The dependencies for adminsidepanel package need to be installed with the command yarn.<br />
<br />
There are the following commands:<br />
* serve to run the component with hot-reloading (all changes are visible without compiling again)<br />
* build to build a non minified and a minified version of the assets in one step<br />
* prod to build a minified version of the assets<br />
* dev to build a minified version of the assets with the development mode<br />
<br />
== Best Practices for Developing New Packages ==<br />
<br />
When adding or updating JavaScript functionality in LimeSurvey:<br />
* Place your code inside a new or existing `assets/packages/` folder <br />
* Keep code modular and organized under `src/` <br />
* Use the build system (npm/yarn + Webpack) to compile assets into distributable bundles <br />
* Avoid inline JavaScript in views whenever possible <br />
* For complex interactive features, consider using modern frameworks like Vue (as with `adminsidepanel`) <br />
<br />
<br />
<br />
[[Category:Development guidelines]]<br />
[[Category:JavaScript]]<br />
<br />
= Bootstrap 5 and Gulp Build System in LimeSurvey Themes =<br />
<br />
LimeSurvey has upgraded to '''Bootstrap 5''' for both its administration and survey themes. This modern framework enhances consistency, responsiveness, and maintainability across the UI.<br />
<br />
To manage and generate theme-specific stylesheets and scripts, LimeSurvey uses a '''Gulp build system''' — defined in a `gulpfile.js` — that handles CSS/JS compilation, theme variations, and RTL support.<br />
<br />
== Gulp Tasks Overview ==<br />
<br />
The `gulpfile.js` orchestrates four main build areas:<br />
<br />
# '''Bootstrap 5 Assets''' – Compiles and minifies Bootstrap 5 JavaScript and SCSS files. Outputs both standard and RTL (Right-to-Left) versions.<br />
'''Commands'''<br />
* `gulp build` – Builds all Bootstrap 5 assets <br />
* `gulp watch` – Watches for changes and rebuilds automatically<br />
<br />
# '''Admin Theme ("Sea Green")''' – Processes SCSS files of the admin theme into CSS.<br />
'''Commands:'''<br />
* `gulp build_theme` – Builds the admin theme <br />
* `gulp watch_theme` – Watches for changes in admin theme files<br />
<br />
# '''Fruity Survey Theme (Legacy)''' – Generates multiple color variations of the original Fruity survey theme.<br />
'''Commands:'''<br />
* `gulp build_survey_theme_fruity` – Builds all Fruity theme variations <br />
* `gulp watch_survey_theme_fruity` – Watches for changes to Fruity theme files<br />
<br />
# '''LS6 Survey Theme ("Fruity TwentyThree")''' – Builds the newer LS6 survey theme (Fruity TwentyThree) along with its variations, including JavaScript processing.<br />
'''Commands:'''<br />
* `gulp build_survey_theme_ls6` – Builds all LS6 theme assets <br />
* `gulp watch_survey_theme_ls6` – Watches for changes to LS6 theme files<br />
<br />
== SCSS File Locations & Component-Based Structure ==<br />
<br />
SCSS files in LimeSurvey are organized to keep styling modular and maintainable.<br />
<br />
* '''Admin Theme – Sea Green''' <br />
Located under: <br />
`assets/admin_themes/Sea_Green/` <br />
This directory contains SCSS source files arranged in components (e.g., `_variables.scss`, `_buttons.scss`, `_layout.scss`) and a main entry point SCSS file that brings them together for compilation.<br />
<br />
* '''Survey Theme – Fruity TwentyThree (LS6)''' <br />
Located under: <br />
`assets/survey_themes/fruity_twentythree/` <br />
SCSS files here are similarly split into component files (e.g., typography, colors, forms), along with CSS or JS files as needed. The main SCSS file imports these components and is picked up by the Gulp task for building.<br />
<br />
This component-based approach allows for easier styling, overrides, and theme variation without duplicating code.<br />
<br />
== Why This Matters ==<br />
<br />
Using Bootstrap 5 along with Gulp-driven build automation ensures:<br />
<br />
* Consistent and responsive design across admin and survey interfaces. <br />
* Streamlined workflows for theme development and maintenance. <br />
* Flexibility to generate color variations and handle RTL languages cleanly. <br />
* Easier updates to design components — change one SCSS component, rebuild, and it's applied globally.<br />
<br />
== How to Contribute or Customize ==<br />
<br />
1. Navigate to the relevant theme folder (e.g. `assets/admin_themes/Sea_Green/` or `assets/survey_themes/fruity_twentythree/`).<br />
2. Modify or add SCSS components as needed. <br />
3. Run one of the Gulp build commands above to compile:<br />
* For example: <br />
```bash<br />
gulp build_survey_theme_ls6<br />
```<br />
4. Clear LimeSurvey’s asset cache (from the admin interface or manually) to see your changes live in the UI.<br />
<br />
Important: when you have to define sizes (fonts, margins, paddings, etc), use the variables we defined in the ...variables.scss (e.g.: assets/admin_themes/Sea_Green/sea_green_variables.scss) file.<br />
<br />
[[Category:Development guidelines]]<br />
[[Category:Themes]]<br />
[[Category:CSS/SCSS]]<br />
<br />
=HTML=<br />
*As you will notice, a very customized HTML element can take a lot of lines (very expensive if you paid each one (:wink:) ) to avoid that, use 'CSS classes'. In general, use classes to aesthetic related stuff: color, borders, backgrounds, font faces, sizes, etc.<br />
*Respect W3C standards, and try to use the HTML understandable for all browsers. If one of them has a special feature, think if this feature is so special to break down the HTML in other browsers.<br />
*Do not use PHP short tags <? ?>. Always use full PHP tags <?php ?>. Excluded from this is the echo shorthand <?=. Which is allowed as per PSR standard.<br />
*Any rules of the mentioned before: about CSS, well closed HTML tags and JS respect XHTML standards. Give it a try!.<br />
<br />
=Localization=<br />
<br />
Moved to https://manual.limesurvey.org/Code_quality_guide#Localization<br />
<br />
=Bug tracker=<br />
#First consider if the reported issue is really a bug. If it is a feature request please move it to the feature tracker.<br />
#If you would like to work on a bug assign it to yourself.<br />
#Try to reproduce the issue.<br />
##If you cannot reproduce ask the user to provide a small example survey to demonstrate the issue. Then set the issue to 'Feedback'. After the user added the necessary information it will automatically be set to 'Assigned' again.<br />
##If the user does not responds for more than a week ask once again for feedback by adding a comment. After a further week without feedback close the issue.<br />
#After you resolved the issue set the status to resolved AND provide the 'Fixed in version' information.<br />
#After you committed a fix and use the proper GIt commit message naming the commit will be automatically assigned to your bug report.<br />
#After a release the release technician will set all issues to 'Closed' that were fixed for this release. That signals to the reporter that a fix is available in the version and it was just released. The release technicial will also add a comment to the close issue: 'Fixed in <Version> <Build number>'<br />
<br />
=Cross-DB compatibility=<br />
<br />
LimeSurvey targets several database types it can run on: MySQL, Postgres and Microsoft SQL Server. This demands certain precautions when coding<br />
<br />
==Parameter binding==<br />
<br />
Yii/PDO supports parameter binding - use it. Don't inject variables directly into the query or into conditions because this might create a security issue.<br />
<br />
Example:<br />
<br />
<syntaxhighlight lang="php"><?php<br />
$oResult = Yii::app()->db<br />
->createCommand()<br />
->select('somefield')<br />
->where("sid = :sid")<br />
->from('{{sometable}}')<br />
->bindParam(":sid", $surveyid, PDO::PARAM_INT);<br />
?></syntaxhighlight><br />
<br />
If you bind the same value several times do NOT use the same parameter name, instead use a different named parameter for each bind:<br />
<br />
WRONG:<br />
<br />
<syntaxhighlight lang="php"><?php<br />
$oResult = Yii::app()->db<br />
->createCommand()<br />
->select('somefield')<br />
->where("sid = :sid and parent_sid= :sid ")<br />
->from('{{sometable}}')<br />
->bindParam(":sid", $surveyid, PDO::PARAM_INT);<br />
?></syntaxhighlight><br />
<br />
RIGHT:<br />
<br />
<syntaxhighlight lang="php"><?php<br />
$oResult = Yii::app()->db<br />
->createCommand()<br />
->select('somefield')<br />
->where("sid = :sid1 and parent_sid= :sid2 ")<br />
->from('{{sometable}}')<br />
->bindParam(":sid1", $surveyid, PDO::PARAM_INT)<br />
->bindParam(":sid2", $surveyid, PDO::PARAM_INT);<br />
?></syntaxhighlight><br />
<br />
<br />
==Quote column name==<br />
<br />
Some column name must be quoted for DB compatibility. You can use [https://www.yiiframework.com/doc/api/1.1/CDbConnection#quoteColumnName-detail App()->db->quoteColumnName].<br />
<br />
Know column needed to be quoted :<br />
<br />
* Column name statring with number( column in survey database)<br />
* Reserved <code>key</code> word column name<br />
<br />
=Code complexity=<br />
*If using an auxiliary variable makes clear the code or process, just do it. If you are coding a very complex expression, calling to functions with parameters that are other functions:<br />
<br />
<syntaxhighlight lang="php"><br />
<br />
WRONG:<br />
<br />
iAResult= fa(fb(p1,p2),fc(fd(p3),p4),p5)<br />
<br />
It will be more readable:<br />
<br />
iAuxB = fb(p1,p2)<br />
iAuxD = fd(p3)<br />
iAuxC = fc(iAuxD,p4)<br />
iAResult = fa(iAuxB, iAuxC, p5)<br />
<br />
</syntaxhighlight><br />
<br />
Anyway, if you are in doubt about someone missing the point or you are afraid that your expression is obscure, take the chance of writing it in a more simple way, even if that involves the use of one or more auxiliary variables.<br />
<br />
=Accessibility guidelines=<br />
New code should be checked for accessibility. <br /><br />
[https://www.w3.org/TR/WCAG22/ WCAG 2.2 AA] is the standard for new code. <br /><br />
The LimeSurvey team is actively working to bring existing code up to this standard. When writing code, consider:<br />
# Can every part of the UI be reached and operated using only a keyboard?<br />
# Do all interactive elements have accessible names (via <label>, aria-label, etc.) and do images have meaningful alt text?<br />
# After an action, does focus move to the right place, and are dynamic changes announced to screen readers (e.g., via live regions)?<br />
# Are colors and states visually distinct, with sufficient contrast (4.5:1 for text, 3:1 for UI components)?<br />
# Are touch/click targets at least 24×24px?<br />
# Is motion/animation respectful of the user's prefers-reduced-motion setting?<br />
<br />
Tools that can be used to check for accessibility in your browser:<br />
# [https://chromewebstore.google.com/detail/accessibility-insights-fo/pbjjkligggfmakdaogkfomddhfmpjeni accessibility insights] checks the entire page you are looking at for issues<br />
# [https://chromewebstore.google.com/detail/wcag-contrast-checker/moeekkcjabmojhnfljngmohaaigchpbf?pli=1 wcag contrast checker] checks color contrast for all elements/text<br />
# [https://chromewebstore.google.com/detail/color-contrast-checker-by/hfcoldjibhgbnlambdiecfneiegagkhi wcag contrast checker (selected)] checks color contrast for manually selected colors and gives suggestions<br />
<br />
<div class='simplebox'> [[File:help.png]] Work for this section is still in progress and more details and examples will follow </div><br />
<br />
<br />
=Checklist for new features=<br />
If you implement a new feature please make sure that you checked the following things before you create a pull request/commit your new feature:<br />
<br />
*'''Localization''': Do all texts (that are usually visible to the user) use the localization/translation system (gT, eT, etc.)?<br />
*'''Permissions''': Does the feature obey the permission system (global permissions, survey permissions)?<br />
*'''Backward-compatibility''': Does the feature still work when updating from any old version? Does it maybe break the update?<br />
*'''Database compatibility''': Does it work on all database types (MySQL, MSSQL, Postgres)?<br />
*'''Scaling''': Does your feature scale? For example; It will work fine with 10 surveys, does it still work performant with 10000?<br />
*'''Performance''': Does your feature use the minimal possible number of SQL queries (see also Scaling). <br />
*'''QA''': Did you test your code for all scenarios? Did you let someone else test or read your code?<br />
*'''Acceptance tests''': Did you write automatic acceptance tests for your specification?<br />
*'''Discussions''': Did you discuss the new feature with the team for feedback?<br />
<br />
Also see [https://manual.limesurvey.org/How_to_contribute_new_features How_to_contribute_new_features].<br />
<br />
[[Category:Development]]</div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Coding_guidelines&diff=381799Coding guidelines2026-08-13T10:12:28Z<p>P teichmann: added initial description for accessibility</p>
<hr />
<div><br />
__TOC__<br />
<br />
=General=<br />
<br />
'''This is a free development, everything you do can be useful for others. If the feature is very personal there is a way to turn it into a universal solution. This is the challenge!'''<br />
<br />
<div class="simplebox">"The difficulty within a solution is to solve it in a simple way"<br />
<br />
(Lance Burton, magician)</div><br />
<br />
Some general rules:<br />
*Be efficient and save resources (memory and runtime). Things might work for a small survey but also try out your new feature with a survey that has 400 question, 5 languages and 20,000 responses (Yes, there are surveys like this out there).<br />
*Keep a fluid dialog with the others coders, they have their own thoughts about what you are doing.<br />
*Ask if you are in doubt.<br />
<br />
=Documentation=<br />
<br />
Please document your source code - see this introduction: [[How to document your source code]].<br />
<br />
= Coding Standards and MVC Architecture in LimeSurvey Development =<br />
<br />
LimeSurvey is built on the '''Yii framework''', which provides the foundation for its Model-View-Controller (MVC) structure. Yii has its own conventions and tools that influence how models, views, and controllers are implemented. While some areas of the LimeSurvey codebase predate the adoption of Yii or use older approaches, new development should always align with Yii’s MVC principles and the guidelines described below.<br />
<br />
As you probably know it is an '''open-source survey platform''' with contributions from developers around the world. Like many long-lived open-source projects, its codebase has evolved over time, and you may encounter different approaches to structuring the code. Some older parts of the system may not follow modern best practices or the '''Model-View-Controller (MVC)''' architecture as strictly as newer code.<br />
<br />
While this variety reflects the project’s history, new development should follow the current standards. Staying focused on the recommended guidelines helps keep LimeSurvey maintainable, testable, and easier to extend in the future—without being distracted by legacy approaches.<br />
<br />
== Understanding MVC in LimeSurvey ==<br />
<br />
The '''MVC pattern''' divides an application into three interconnected layers, each with a clear responsibility:<br />
<br />
* '''Models''' – Represent the data and contain business rules related to that data. Models handle database interactions, validations, and data transformations. <br />
* '''Views''' – Manage the presentation layer. They are responsible for displaying information to the user and should not contain business logic. <br />
* '''Controllers''' – Act as intermediaries, handling incoming requests, coordinating with models, and choosing the correct views to render. <br />
<br />
By keeping these responsibilities separate, developers can more easily test, extend, and debug their code.<br />
<br />
== Where Business Logic Belongs ==<br />
<br />
One of the most common pitfalls in MVC development is misplacing business logic. In LimeSurvey development, the recommended approach is:<br />
<br />
* '''Models''': Store business rules and perform operations directly related to the data, such as validations and relationships. <br />
* '''Service Classes''': Handle more complex operations that span across multiple models or involve higher-level application logic. For example see: \LimeSurvey\Models\Services\QuestionAggregateService <br />
<br />
Controllers should remain as thin as possible. Their main role is to receive requests, pass data to the appropriate services or models, and return responses via the correct views.<br />
<br />
== Best Practices for Clean Code ==<br />
<br />
To keep your LimeSurvey contributions maintainable and consistent with the project’s standards, follow these practices:<br />
<br />
* '''Keep controllers lightweight''' – They should primarily manage request/response flow and delegate logic to models or services. <br />
* '''Move complex logic into service classes''' – If a piece of functionality requires multiple steps or involves multiple models, encapsulate it in a dedicated service. <br />
* '''Use models for data operations''' – Models should clearly represent data structures and provide methods for interacting with the database. <br />
* '''Keep views presentation-only''' – Views should focus on displaying data. They should not contain calculations, validations, or business rules. <br />
* '''Apply dependency injection''' – This improves testability and flexibility by avoiding hard-coded dependencies. <br />
<br />
= Twig Templates in LimeSurvey =<br />
<br />
LimeSurvey uses the '''Twig templating engine''' for rendering much of the survey-taking interface. Twig provides a clean separation between logic and presentation, making it easier to customize themes and maintain a consistent look and feel across surveys.<br />
<br />
== What is Twig? ==<br />
<br />
Twig is a fast, secure, and flexible templating language for PHP. It allows developers and theme designers to write templates that are easy to read and extend, without mixing in raw PHP code. <br />
<br />
== Where LimeSurvey Uses Twig ==<br />
<br />
Twig is primarily used in the survey-taking portion of LimeSurvey:<br />
* '''Survey themes''' – Layout, structure, and style of the survey pages <br />
* '''Question rendering''' – How individual questions and groups are displayed <br />
* '''Template overrides''' – Custom themes can override core Twig templates for tailored designs <br />
<br />
== Best Practices for Twig in LimeSurvey ==<br />
<br />
When working with Twig templates in LimeSurvey, follow these guidelines:<br />
* '''Keep logic out of templates''' – Use Twig for presentation only, not business rules <br />
* '''Test in multiple themes''' – Ensure your changes work across different devices and survey layouts <br />
<br />
== Developer Tips ==<br />
<br />
* Default Twig templates for survey-taking are located in the `application/views/survey/` and theme directories. <br />
* Custom survey themes should include a `twig` folder for template overrides. <br />
* Always clear LimeSurvey’s cache after making changes to Twig files to see updates. <br />
* Review the official [https://twig.symfony.com/doc/ Twig documentation] for the full syntax and feature set. <br />
<br />
[[Category:Development guidelines]]<br />
[[Category:Survey themes]]<br />
<br />
= JavaScript Packages in LimeSurvey =<br />
<br />
LimeSurvey includes several JavaScript packages that provide functionality for the administration interface as well as the survey-taking environment. These packages are organized under the `assets/packages/` directory and are built to keep front-end code modular, maintainable, and consistent.<br />
<br />
== Overview ==<br />
<br />
JavaScript in LimeSurvey is mostly organized into '''packages''' that can include:<br />
* JavaScript source files <br />
* Stylesheets (CSS/SCSS) <br />
* Build configuration (Webpack, npm/yarn dependencies) <br />
<br />
When developing new js this package approach should be followed. <br />
This ensures that front-end code can be bundled, minified, and versioned properly, while avoiding duplication and conflicts.<br />
<br />
== Building JavaScript Packages ==<br />
<br />
When a new feature requires JavaScript functionality, it is typically developed inside a dedicated package folder under `assets/packages/`. Each package can define:<br />
* An `src/` directory for source files <br />
* A `dist/` or `build/` output for the compiled files <br />
* Dependencies declared in `package.json` <br />
<br />
The build system (commonly Webpack or a similar bundler) compiles modern JavaScript (ES6+) and frameworks like Vue into browser-ready files. These are then registered in LimeSurvey’s asset manager to be loaded when needed.<br />
<br />
== Example: adminbasics ==<br />
<br />
The package `assets/packages/adminbasics` contains JavaScript and styles used across the LimeSurvey administration interface. <br />
<br />
Typical functionality includes:<br />
* General UI helpers <br />
* Event handlers for common actions in the admin panel <br />
<br />
This package acts as a foundation layer for other admin UI features.<br />
<br />
The dependencies for adminbasics package need to be installed with the command yarn.<br />
<br />
There are the following commands available:<br />
* dev to build a non minified version of the assets with rollup<br />
* prod to build a minified version of the assets with rollup<br />
* build to build a non minified and a minified version of the assets with rollup in one step<br />
* test to run the test cases<br />
<br />
== Example: adminsidepanel (Vue.js) ==<br />
<br />
The package `assets/packages/adminsidepanel` provides the code for the collapsible side panel in the administration interface. Unlike other parts of LimeSurvey, this package is built with the '''Vue.js framework'''. <br />
<br />
Key points:<br />
* The side panel is a '''Vue single-page component''' embedded into the admin UI <br />
* Vue allows the panel to be reactive, updating its content dynamically without reloading the whole page <br />
* The build process compiles `.vue` files and JavaScript modules into a single bundle served by LimeSurvey <br />
<br />
For building this package, you need to have node version 14 installed (not higher!)<br />
The dependencies for adminsidepanel package need to be installed with the command yarn.<br />
<br />
There are the following commands:<br />
* serve to run the component with hot-reloading (all changes are visible without compiling again)<br />
* build to build a non minified and a minified version of the assets in one step<br />
* prod to build a minified version of the assets<br />
* dev to build a minified version of the assets with the development mode<br />
<br />
== Best Practices for Developing New Packages ==<br />
<br />
When adding or updating JavaScript functionality in LimeSurvey:<br />
* Place your code inside a new or existing `assets/packages/` folder <br />
* Keep code modular and organized under `src/` <br />
* Use the build system (npm/yarn + Webpack) to compile assets into distributable bundles <br />
* Avoid inline JavaScript in views whenever possible <br />
* For complex interactive features, consider using modern frameworks like Vue (as with `adminsidepanel`) <br />
<br />
<br />
<br />
[[Category:Development guidelines]]<br />
[[Category:JavaScript]]<br />
<br />
= Bootstrap 5 and Gulp Build System in LimeSurvey Themes =<br />
<br />
LimeSurvey has upgraded to '''Bootstrap 5''' for both its administration and survey themes. This modern framework enhances consistency, responsiveness, and maintainability across the UI.<br />
<br />
To manage and generate theme-specific stylesheets and scripts, LimeSurvey uses a '''Gulp build system''' — defined in a `gulpfile.js` — that handles CSS/JS compilation, theme variations, and RTL support.<br />
<br />
== Gulp Tasks Overview ==<br />
<br />
The `gulpfile.js` orchestrates four main build areas:<br />
<br />
# '''Bootstrap 5 Assets''' – Compiles and minifies Bootstrap 5 JavaScript and SCSS files. Outputs both standard and RTL (Right-to-Left) versions.<br />
'''Commands'''<br />
* `gulp build` – Builds all Bootstrap 5 assets <br />
* `gulp watch` – Watches for changes and rebuilds automatically<br />
<br />
# '''Admin Theme ("Sea Green")''' – Processes SCSS files of the admin theme into CSS.<br />
'''Commands:'''<br />
* `gulp build_theme` – Builds the admin theme <br />
* `gulp watch_theme` – Watches for changes in admin theme files<br />
<br />
# '''Fruity Survey Theme (Legacy)''' – Generates multiple color variations of the original Fruity survey theme.<br />
'''Commands:'''<br />
* `gulp build_survey_theme_fruity` – Builds all Fruity theme variations <br />
* `gulp watch_survey_theme_fruity` – Watches for changes to Fruity theme files<br />
<br />
# '''LS6 Survey Theme ("Fruity TwentyThree")''' – Builds the newer LS6 survey theme (Fruity TwentyThree) along with its variations, including JavaScript processing.<br />
'''Commands:'''<br />
* `gulp build_survey_theme_ls6` – Builds all LS6 theme assets <br />
* `gulp watch_survey_theme_ls6` – Watches for changes to LS6 theme files<br />
<br />
== SCSS File Locations & Component-Based Structure ==<br />
<br />
SCSS files in LimeSurvey are organized to keep styling modular and maintainable.<br />
<br />
* '''Admin Theme – Sea Green''' <br />
Located under: <br />
`assets/admin_themes/Sea_Green/` <br />
This directory contains SCSS source files arranged in components (e.g., `_variables.scss`, `_buttons.scss`, `_layout.scss`) and a main entry point SCSS file that brings them together for compilation.<br />
<br />
* '''Survey Theme – Fruity TwentyThree (LS6)''' <br />
Located under: <br />
`assets/survey_themes/fruity_twentythree/` <br />
SCSS files here are similarly split into component files (e.g., typography, colors, forms), along with CSS or JS files as needed. The main SCSS file imports these components and is picked up by the Gulp task for building.<br />
<br />
This component-based approach allows for easier styling, overrides, and theme variation without duplicating code.<br />
<br />
== Why This Matters ==<br />
<br />
Using Bootstrap 5 along with Gulp-driven build automation ensures:<br />
<br />
* Consistent and responsive design across admin and survey interfaces. <br />
* Streamlined workflows for theme development and maintenance. <br />
* Flexibility to generate color variations and handle RTL languages cleanly. <br />
* Easier updates to design components — change one SCSS component, rebuild, and it's applied globally.<br />
<br />
== How to Contribute or Customize ==<br />
<br />
1. Navigate to the relevant theme folder (e.g. `assets/admin_themes/Sea_Green/` or `assets/survey_themes/fruity_twentythree/`).<br />
2. Modify or add SCSS components as needed. <br />
3. Run one of the Gulp build commands above to compile:<br />
* For example: <br />
```bash<br />
gulp build_survey_theme_ls6<br />
```<br />
4. Clear LimeSurvey’s asset cache (from the admin interface or manually) to see your changes live in the UI.<br />
<br />
Important: when you have to define sizes (fonts, margins, paddings, etc), use the variables we defined in the ...variables.scss (e.g.: assets/admin_themes/Sea_Green/sea_green_variables.scss) file.<br />
<br />
[[Category:Development guidelines]]<br />
[[Category:Themes]]<br />
[[Category:CSS/SCSS]]<br />
<br />
=HTML=<br />
*As you will notice, a very customized HTML element can take a lot of lines (very expensive if you paid each one (:wink:) ) to avoid that, use 'CSS classes'. In general, use classes to aesthetic related stuff: color, borders, backgrounds, font faces, sizes, etc.<br />
*Respect W3C standards, and try to use the HTML understandable for all browsers. If one of them has a special feature, think if this feature is so special to break down the HTML in other browsers.<br />
*Do not use PHP short tags <? ?>. Always use full PHP tags <?php ?>. Excluded from this is the echo shorthand <?=. Which is allowed as per PSR standard.<br />
*Any rules of the mentioned before: about CSS, well closed HTML tags and JS respect XHTML standards. Give it a try!.<br />
<br />
=Localization=<br />
<br />
Moved to https://manual.limesurvey.org/Code_quality_guide#Localization<br />
<br />
=Bug tracker=<br />
#First consider if the reported issue is really a bug. If it is a feature request please move it to the feature tracker.<br />
#If you would like to work on a bug assign it to yourself.<br />
#Try to reproduce the issue.<br />
##If you cannot reproduce ask the user to provide a small example survey to demonstrate the issue. Then set the issue to 'Feedback'. After the user added the necessary information it will automatically be set to 'Assigned' again.<br />
##If the user does not responds for more than a week ask once again for feedback by adding a comment. After a further week without feedback close the issue.<br />
#After you resolved the issue set the status to resolved AND provide the 'Fixed in version' information.<br />
#After you committed a fix and use the proper GIt commit message naming the commit will be automatically assigned to your bug report.<br />
#After a release the release technician will set all issues to 'Closed' that were fixed for this release. That signals to the reporter that a fix is available in the version and it was just released. The release technicial will also add a comment to the close issue: 'Fixed in <Version> <Build number>'<br />
<br />
=Cross-DB compatibility=<br />
<br />
LimeSurvey targets several database types it can run on: MySQL, Postgres and Microsoft SQL Server. This demands certain precautions when coding<br />
<br />
==Parameter binding==<br />
<br />
Yii/PDO supports parameter binding - use it. Don't inject variables directly into the query or into conditions because this might create a security issue.<br />
<br />
Example:<br />
<br />
<syntaxhighlight lang="php"><?php<br />
$oResult = Yii::app()->db<br />
->createCommand()<br />
->select('somefield')<br />
->where("sid = :sid")<br />
->from('{{sometable}}')<br />
->bindParam(":sid", $surveyid, PDO::PARAM_INT);<br />
?></syntaxhighlight><br />
<br />
If you bind the same value several times do NOT use the same parameter name, instead use a different named parameter for each bind:<br />
<br />
WRONG:<br />
<br />
<syntaxhighlight lang="php"><?php<br />
$oResult = Yii::app()->db<br />
->createCommand()<br />
->select('somefield')<br />
->where("sid = :sid and parent_sid= :sid ")<br />
->from('{{sometable}}')<br />
->bindParam(":sid", $surveyid, PDO::PARAM_INT);<br />
?></syntaxhighlight><br />
<br />
RIGHT:<br />
<br />
<syntaxhighlight lang="php"><?php<br />
$oResult = Yii::app()->db<br />
->createCommand()<br />
->select('somefield')<br />
->where("sid = :sid1 and parent_sid= :sid2 ")<br />
->from('{{sometable}}')<br />
->bindParam(":sid1", $surveyid, PDO::PARAM_INT)<br />
->bindParam(":sid2", $surveyid, PDO::PARAM_INT);<br />
?></syntaxhighlight><br />
<br />
<br />
==Quote column name==<br />
<br />
Some column name must be quoted for DB compatibility. You can use [https://www.yiiframework.com/doc/api/1.1/CDbConnection#quoteColumnName-detail App()->db->quoteColumnName].<br />
<br />
Know column needed to be quoted :<br />
<br />
* Column name statring with number( column in survey database)<br />
* Reserved <code>key</code> word column name<br />
<br />
=Code complexity=<br />
*If using an auxiliary variable makes clear the code or process, just do it. If you are coding a very complex expression, calling to functions with parameters that are other functions:<br />
<br />
<syntaxhighlight lang="php"><br />
<br />
WRONG:<br />
<br />
iAResult= fa(fb(p1,p2),fc(fd(p3),p4),p5)<br />
<br />
It will be more readable:<br />
<br />
iAuxB = fb(p1,p2)<br />
iAuxD = fd(p3)<br />
iAuxC = fc(iAuxD,p4)<br />
iAResult = fa(iAuxB, iAuxC, p5)<br />
<br />
</syntaxhighlight><br />
<br />
Anyway, if you are in doubt about someone missing the point or you are afraid that your expression is obscure, take the chance of writing it in a more simple way, even if that involves the use of one or more auxiliary variables.<br />
<br />
=Accessibility guidelines=<br />
New code should be checked for accessibility. <br /><br />
WCAG 2.2 AA is the standard for new code. <br /><br />
The LimeSurvey team is actively working to bring existing code up to this standard. When writing code, consider:<br />
# Can every part of the UI be reached and operated using only a keyboard?<br />
# Do all interactive elements have accessible names (via <label>, aria-label, etc.) and do images have meaningful alt text?<br />
# After an action, does focus move to the right place, and are dynamic changes announced to screen readers (e.g., via live regions)?<br />
# Are colors and states visually distinct, with sufficient contrast (4.5:1 for text, 3:1 for UI components)?<br />
# Are touch/click targets at least 24×24px?<br />
# Is motion/animation respectful of the user's prefers-reduced-motion setting?<br />
<br />
Tools that can be used to check for accessibility in your browser:<br />
# [https://chromewebstore.google.com/detail/accessibility-insights-fo/pbjjkligggfmakdaogkfomddhfmpjeni accessibility insights] checks the entire page you are looking at for issues<br />
# [https://chromewebstore.google.com/detail/wcag-contrast-checker/moeekkcjabmojhnfljngmohaaigchpbf?pli=1 wcag contrast checker] checks color contrast for all elements/text<br />
# [https://chromewebstore.google.com/detail/color-contrast-checker-by/hfcoldjibhgbnlambdiecfneiegagkhi wcag contrast checker (selected)] checks color contrast for manually selected colors and gives suggestions<br />
<br />
<div class='simplebox'> [[File:help.png]] Work for this section is still in progress and more details and examples will follow </div><br />
<br />
<br />
=Checklist for new features=<br />
If you implement a new feature please make sure that you checked the following things before you create a pull request/commit your new feature:<br />
<br />
*'''Localization''': Do all texts (that are usually visible to the user) use the localization/translation system (gT, eT, etc.)?<br />
*'''Permissions''': Does the feature obey the permission system (global permissions, survey permissions)?<br />
*'''Backward-compatibility''': Does the feature still work when updating from any old version? Does it maybe break the update?<br />
*'''Database compatibility''': Does it work on all database types (MySQL, MSSQL, Postgres)?<br />
*'''Scaling''': Does your feature scale? For example; It will work fine with 10 surveys, does it still work performant with 10000?<br />
*'''Performance''': Does your feature use the minimal possible number of SQL queries (see also Scaling). <br />
*'''QA''': Did you test your code for all scenarios? Did you let someone else test or read your code?<br />
*'''Acceptance tests''': Did you write automatic acceptance tests for your specification?<br />
*'''Discussions''': Did you discuss the new feature with the team for feedback?<br />
<br />
Also see [https://manual.limesurvey.org/How_to_contribute_new_features How_to_contribute_new_features].<br />
<br />
[[Category:Development]]</div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=How_to_contribute_new_features&diff=381349How to contribute new features2026-05-20T12:37:33Z<p>P teichmann: </p>
<hr />
<div><br />
__TOC__<br />
<br />
=Contribution process=<br />
<br />
We are always encouraging users to contribute new features or fix bug they have developed. If you are planning to code a stunning new feature and you want it to be implemented at the core so you are future save when updating later, please proceed as follows:<br />
# Use the [https://github.com/LimeSurvey/LimeSurvey latest Github version] for your development<br />
# Open a new ticket at [http://bugs.limesurvey.org/my_view_page.php our bugtracker] at the good project part:<br />
## Bug report for a bug<br />
## Feature request for a new feature<br />
## Development is more for fix the internal system<br />
# If you already have fix : make a pull request at [https://github.com/LimeSurvey/LimeSurvey/pulls github]. Remember the [[Standard for Git commit messages]]<br />
# Describe your feature as detailed as possible and tell us about the implementation details (what code you want to add, which files you are planning to change, which GUI parts have to be extended, ...)<br />
# We will then assign the ticket to one of our developers and discuss your approach. It's important to tell us about your plans '''before''' you start coding because otherwise you might take the wrong way when implementing new features so we might have to say "Sorry, we can't take that one (because of security problems or what so ever)".<br />
# Once implementation details were discussed just start coding and create a Github pull request afterwards and ask for a developer to review your coding.<br />
# Make sure to write unit or functional tests that tests your new functionality. If you don't know how to set it up, please read this [https://manual.limesurvey.org/Regression_and_unit_tests manual page] or ask in the [https://discord.com/invite/DEjguXn LimeSurvey discord] for help.<br />
# There might be some further discussions about implementation details but once this was solved, your feature will be available in the next new version.<br />
<br />
Please remember that ''new features should as much as possible be in new files''.<br />
<br />
=Internal contribution process=<br />
<br />
(This section is only relevant for employees at LimeSurvey GmbH.)<br />
<br />
As above, but using [https://datasift.github.io/gitflow/IntroducingGitFlow.html gitflow] instead of pull-requests. Especially:<br />
<br />
* New features are always on feature branches<br />
* New features are never merged into develop-minor or develop-major branch before QA<br />
* Bug fixes are in bug branches and should always have a '''pull request''' on GitHub for code review and comments<br />
* Pull requests with a single author are squashed and merged<br />
* Trivial fixes can be applied in the development branch directly (trivial fixes are e.g. one line or changing a localization typo in multiple lines)<br />
<br />
Most importantly, nothing is ever merged into master or develop branches without:<br />
<br />
# QA<br />
# Code review<br />
<br />
=How to create a pull request?=<br />
* First figure out the source branch you need:<br />
** New backward-compatible features: '''develop-minor'''<br />
** New backward-incompatible features: '''develop-major'''<br />
** Bug fixes: '''master''' <br />
<br />
* Branch the source branch for your feature/bug fix to a separate branch (see branch naming below)<br />
* Develop your bug fix/feature on that separate branch.<br />
* Push your branch to the repository (internal developer) or push it to your personal fork (external)<br />
* Visit https://github.com/LimeSurvey/LimeSurvey and navigate to '''Pull requests''' tab.<br />
* Click on the '''Create pull request''' button<br />
* Select the source branch you used,<br />
* For the title of the pull request use the same text as required in our [[Standard for Git commit messages]]. Please also enter a meaningful description of what you fixed.<br />
* Confirm to create the PR and you are done.<br />
<br />
=How to merge a pull request?=<br />
After a PR has been reviewed and tested, it will be merged by the responsible person.<br />
Please note the following rules:<br />
* When merging the PR on GitHub always squash it (there is an option in the merge button dropdown).<br />
[[File:Github_squash_merge.png]]<br />
* Always make sure that the squashed merge has a [[Standard_for_Git_commit_messages|proper commit message]]. <br />
* If you fixed several issues in the same PR, they should all be part of the commit message text.<br />
<br />
=Branch naming=<br />
<br />
All bug branches should be prefixed with <code>bug/12345-short-description</code>, where the number points to relevant Mantis issue on bugs.limesurvey.org.<br />
<br />
All feature branches should be prefixed with <code>feature/12345-short-description</code>, where the number points to relevant Mantis issue on bugs.limesurvey.org.<br />
<br />
[https://gitversion.readthedocs.io/en/latest/git-branching-strategies/gitflow-examples GitFlow examples].<br />
<br />
=Specification=<br />
<br />
All new features should be specified using scenarios or [https://www.mountaingoatsoftware.com/agile/user-stories user-stories].<br />
<br />
=QA=<br />
<br />
New features must be tested by a QA-team or tester before being merged. The tester should not be part of the same sprint team that developed the feature.<br />
<br />
=Documentation=<br />
<br />
Make sure all PHPDoc blocks are correct.<br />
<br />
All relevant manual pages should be updated before merge. Include information about from which version the new feature is available.<br />
<br />
=Acceptance tests=<br />
<br />
Each new feature should have a folder with acceptance test. The folder name should include the ticket number, like<br />
<br />
tests/functional/acceptance/15532-em-warning/<test classes><br />
<br />
The acceptance tests correspond to the user-stories written in the specification and guarantees that the functionality keeps working as intended even after further changes are applied to the code-base.<br />
<br />
TODO: How to organize unit tests for new functionality?<br />
<br />
=Static analysis=<br />
<br />
Run some analysis toosl on your code to make sure you have the correct docblocks, no unused variables, and apply [https://www.php-fig.org/psr/psr-12/ PSR-12].<br />
<br />
Run<br />
<br />
<syntaxhighlight lang="bash"><br />
$ ./composer.phar install<br />
</syntaxhighlight><br />
<br />
This will install all dev tools. Make sure to ''not'' commit any changes to the autoloader. The autoloader should always be commited with the --no-dev switch on.<br />
<br />
==Code sniffer==<br />
<br />
Home page: https://github.com/squizlabs/PHP_CodeSniffer<br />
<br />
PHP code sniffer checks your code for style violations.<br />
<br />
Run it with<br />
<br />
<syntaxhighlight lang="bash"><br />
$ ./third_party/bin/phpcs --standard=psr12 <file to check><br />
</syntaxhighlight><br />
<br />
Example output:<br />
<br />
<syntaxhighlight lang="text"><br />
---------------------------------------------------------------------------------------------------<br />
FOUND 273 ERRORS AND 98 WARNINGS AFFECTING 260 LINES<br />
---------------------------------------------------------------------------------------------------<br />
2 | ERROR | [ ] Missing file doc comment<br />
3 | ERROR | [ ] Missing doc comment for class QuestionEditorController<br />
5 | ERROR | [ ] Missing doc comment for function accessRules()<br />
25 | ERROR | [ ] Missing parameter comment<br />
25 | ERROR | [x] Tag value for @param tag indented incorrectly; expected 2 spaces but found 1<br />
26 | ERROR | [ ] Tag @return cannot be grouped with parameter tags in a doc comment<br />
31 | WARNING | [ ] Line exceeds 85 characters; contains 90 characters<br />
</syntaxhighlight><br />
<br />
Setup in PHPStorm: https://confluence.jetbrains.com/display/PhpStorm/PHP+Code+Sniffer+in+PhpStorm<br />
<br />
==Mess detector==<br />
<br />
Home page: https://phpmd.org/<br />
<br />
Mess detector can detect unused variables, and code complexity.<br />
<br />
Run it with<br />
<br />
<syntaxhighlight lang="bash"><br />
$ ./third_party/bin/phpmd <file to test> text tests/rulesets/phpmd_ruleset.xml <br />
</syntaxhighlight><br />
<br />
Example output:<br />
<br />
<syntaxhighlight lang="bash"><br />
application/controllers/QuestionEditorController.php:240 The method actionSaveQuestionData() has an NPath complexity of 8652. The configured NPath complexity threshold is 200.<br />
application/controllers/QuestionEditorController.php:240 The method actionSaveQuestionData() has 142 lines of code. Current threshold is set to 100. Avoid really long methods.<br />
application/controllers/QuestionEditorController.php:444 Avoid unused parameters such as '$returnArray'.<br />
application/controllers/QuestionEditorController.php:468 Avoid unused parameters such as '$returnArray'.<br />
</syntaxhighlight><br />
<br />
Setup in PHPStorm: https://confluence.jetbrains.com/display/PhpStorm/PHP+Code+Sniffer+in+PhpStorm<br />
<br />
==Psalm==<br />
<br />
Home page: https://psalm.dev/<br />
<br />
Psalm makes sure your docblocks are correct, and that you never access anything that could be null.<br />
<br />
Run it with<br />
<br />
<syntaxhighlight lang="bash"><br />
$ ./third_party/bin/psalm <file to check><br />
</syntaxhighlight><br />
<br />
Example output:<br />
<br />
<syntaxhighlight lang="text"><br />
INFO: MissingReturnType - application/controllers/QuestionEditorController.php:54:21 - Method QuestionEditorController::actionView does not have a return type, expecting void<br />
public function actionView($surveyid, $gid = null, $qid = null, $landOnSideMenuTab = 'structure'){<br />
ERROR: PossiblyNullPropertyFetch - application/controllers/QuestionEditorController.php:58:24 - Cannot get property on possibly null variable $oSurvey of type Survey|null<br />
$gid = $gid ?? $oSurvey->groups[0]->gid;<br />
ERROR: PossiblyNullArrayAccess - application/controllers/QuestionEditorController.php:58:24 - Cannot access array value on possibly null variable $oSurvey->groups of type array<array-key, QuestionGroup>|null<br />
$gid = $gid ?? $oSurvey->groups[0]->gid;<br />
</syntaxhighlight><br />
<br />
==Release process==<br />
<br />
[[File:releaseprocess.png|Release process]]<br />
<br />
The release cycle consists of two phases:<br />
<br />
* Merge window<br />
* Feature freeze<br />
<br />
During the merge window, new features are accepted into the develop branch.<br />
<br />
During the feature freeze, only bug fixes are accepted.<br />
<br />
At the end of the feature freeze, the develop branch is merged into master and a new version is released. After that, a new release schedule is written and announced.<br />
<br />
Also see [[LimeSurvey_roadmap#Current_release_schedule|current release schedule]].<br />
<br />
=Useful links=<br />
* [[Accessing the source code]]<br />
* [[Coding guidelines]]<br />
* [[How to join the LimeSurvey project team]]<br />
* [[LimeSurvey 1.x navigating the source code]]<br />
* [[LimeSurvey 1.8 database layout documentation]] (outdated)</div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Debugging&diff=377442Debugging2024-04-29T09:14:11Z<p>P teichmann: /* Debugging */</p>
<hr />
<div><br />
=Debugging=<br />
<br />
Working with a framework can sometimes be hard to debug. In Yii we have some tools at our disposal to help debug the application. The very first thing to do is modify '''application/config/config.php''' and to set [[Optional_settings#Development_and_debugging|debug = 2]] at the end. Now we get more errors presented and we can use a trace function to see what a variable's content is at any time during program execution.<br />
<br />
If you want to see what queries are sent to the database, you can also enable debugsql by setting it to 1.<br />
<br />
To do a dump of a variable you can use the following syntax:<br />
<br />
<syntaxhighlight lang="php">$variable = $this->someMethod(); // What would this return?<br />
<br />
Yii::trace(CVarDumper:dumpAsString($variable), 'vardump');</syntaxhighlight><br />
<br />
We make use of the <nowiki>Yii<center>trace()</nowiki> method, and pass it the result of the static call to <nowiki>CVarDumper</center>dumpAsString()</nowiki>. What it does is is similar to var_dump but it allows a little more control if you need if. The second parameter 'vardump' makes sure our messages gets logged. All this is a lot of typing and since programmers are lazy, we created a global function to save you some trouble. Instead of the lines above you can also use:<br />
<br />
<syntaxhighlight lang="php">traceVar($variable);</syntaxhighlight><br />
<br />
As a bonus you will also get the file and line that called the traceVar function to assist in debugging.</div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=237416Major version upgrade2023-09-14T08:27:08Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions= <!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade= <!--T:3--><br />
To be on the safe side when performing an upgrade and be able to continue surveys with the least amount of interruption, we recommend first testing all your customized code on the new version of LimeSurvey you want to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes== <!--T:4--><br />
All custom survey themes (this includes extended themes) will be uninstalled and the theme options in the global, group and survey settings will be reset to the new default.<br />
<br />
<!--T:5--><br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it into the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import it into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized survey theme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old survey theme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes== <!--T:6--><br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<!--T:7--><br />
<b>for self-hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, our new admin theme is displayed by default. To update your previously installed admin theme, either:<br />
#* Manually update the code of the admin theme currently marked as incompatible <br />
#* Delete the old admin theme and install the new one you previously updated in your test environment.<br />
<br />
<!--T:8--><br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes== <!--T:9--><br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes. Custom JavaScript inserted into the survey theme or any of the questions in a survey will likely not work anymore as well.<br />
<br />
<!--T:10--><br />
<b>Upgrading your customized question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is a self-created question theme, make the necessary adjustments<br />
# After successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<!--T:11--><br />
<b>Upgrading a theme you do not own:</b><br><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins== <!--T:12--><br />
Custom plugins that do not match the current version will be deactivated during the upgrade process.<br />
<br />
<!--T:13--><br />
<b>for self-hosted application:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application which will preserve settings or uninstall the old version and reinstall the new version, in that case all settings will be reentered.<br />
<br />
<!--T:14--><br />
<b>for Cloud users:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin code or contact the plugin author to update the plugin.<br />
# Installation options:<br />
#* Uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
#* Contact support to make an update to the plugin without loosing configuration data <br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=237415Major version upgrade2023-09-14T08:26:23Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions= <!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade= <!--T:3--><br />
To be on the safe side when performing an upgrade and be able to continue surveys with the least amount of interruption, we recommend first testing all your customized code on the new version of LimeSurvey you want to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes== <!--T:4--><br />
All custom survey themes (this includes extended themes) will be uninstalled and the theme options in the global, group and survey settings will be reset to the new default.<br />
<br />
<!--T:5--><br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it into the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import it into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized survey theme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old survey theme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes== <!--T:6--><br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<!--T:7--><br />
<b>for self-hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, our new admin theme is displayed by default. To update your previously installed admin theme, either:<br />
#* Manually update the code of the admin theme currently marked as incompatible <br />
#* Delete the old admin theme and install the new one you previously updated in your test environment.<br />
<br />
<!--T:8--><br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes== <!--T:9--><br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes. Custom JavaScript inserted will likely not work anymore as well.<br />
<br />
<!--T:10--><br />
<b>Upgrading your customized question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is a self-created question theme, make the necessary adjustments<br />
# After successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<!--T:11--><br />
<b>Upgrading a theme you do not own:</b><br><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins== <!--T:12--><br />
Custom plugins that do not match the current version will be deactivated during the upgrade process.<br />
<br />
<!--T:13--><br />
<b>for self-hosted application:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application which will preserve settings or uninstall the old version and reinstall the new version, in that case all settings will be reentered.<br />
<br />
<!--T:14--><br />
<b>for Cloud users:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin code or contact the plugin author to update the plugin.<br />
# Installation options:<br />
#* Uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
#* Contact support to make an update to the plugin without loosing configuration data <br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210729Major version upgrade2023-08-25T09:26:49Z<p>P teichmann: /* Custom survey themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the theme options in the global, group and survey settings will be reset to the new default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it into the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import it into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, our new admin theme is displayed by default. To update your previously installed admin theme, either:<br />
#* Manually update the code of the admin theme currently marked as incompatible <br />
#* Delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
<b>Upgrading your own question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is your own question theme, make the necessary adjustments<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<b>Upgrading a theme you do not own:</b><br><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version will be deactivated during the upgrade process.<br />
<br />
<b>for self hosted application:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application which will preserve settings or uninstall the old version and reinstall the new version, in that case all settings will be reentered.<br />
<br />
<b>for Cloud users:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin code or contact the plugin author to update the plugin.<br />
# Installation options:<br />
#* Uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
#* Contact support to make an update to the plugin without loosing configuration data <br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210728Major version upgrade2023-08-25T09:23:57Z<p>P teichmann: /* Custom plugins */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the theme options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it into the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import it into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, our new admin theme is displayed by default. To update your previously installed admin theme, either:<br />
#* Manually update the code of the admin theme currently marked as incompatible <br />
#* Delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
<b>Upgrading your own question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is your own question theme, make the necessary adjustments<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<b>Upgrading a theme you do not own:</b><br><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version will be deactivated during the upgrade process.<br />
<br />
<b>for self hosted application:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application which will preserve settings or uninstall the old version and reinstall the new version, in that case all settings will be reentered.<br />
<br />
<b>for Cloud users:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin code or contact the plugin author to update the plugin.<br />
# Installation options:<br />
#* Uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
#* Contact support to make an update to the plugin without loosing configuration data <br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210727Major version upgrade2023-08-25T09:11:36Z<p>P teichmann: /* Custom admin themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the theme options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it into the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import it into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, our new admin theme is displayed by default. To update your previously installed admin theme, either:<br />
#* Manually update the code of the admin theme currently marked as incompatible <br />
#* Delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
<b>Upgrading your own question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is your own question theme, make the necessary adjustments<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<b>Upgrading a theme you do not own:</b><br><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade. It should be checked if they are still working as expected and be updated if possible.<br />
<br />
<b>for self hosted application:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<b>for Cloud users(enterprise and above):</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Contact support to make an update to the plugin without loosing configuration data or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210726Major version upgrade2023-08-25T09:10:05Z<p>P teichmann: /* Custom survey themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the theme options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it into the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import it into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
#* manually update the code of the currently marked as incompatible admin theme <br />
#* delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
<b>Upgrading your own question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is your own question theme, make the necessary adjustments<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<b>Upgrading a theme you do not own:</b><br><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade. It should be checked if they are still working as expected and be updated if possible.<br />
<br />
<b>for self hosted application:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<b>for Cloud users(enterprise and above):</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Contact support to make an update to the plugin without loosing configuration data or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210725Major version upgrade2023-08-25T09:09:39Z<p>P teichmann: /* Custom survey themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the theme options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it into the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
#* manually update the code of the currently marked as incompatible admin theme <br />
#* delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
<b>Upgrading your own question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is your own question theme, make the necessary adjustments<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<b>Upgrading a theme you do not own:</b><br><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade. It should be checked if they are still working as expected and be updated if possible.<br />
<br />
<b>for self hosted application:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<b>for Cloud users(enterprise and above):</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Contact support to make an update to the plugin without loosing configuration data or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210412Major version upgrade2023-08-24T10:08:08Z<p>P teichmann: /* Custom admin themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
#* manually update the code of the currently marked as incompatible admin theme <br />
#* delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
<b>Upgrading your own question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is your own question theme, make the necessary adjustments<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<b>Upgrading a theme you do not own:</b><br><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade. It should be checked if they are still working as expected and be updated if possible.<br />
<br />
<b>for self hosted application:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<b>for Cloud users(enterprise and above):</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Contact support to make an update to the plugin without loosing configuration data or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210411Major version upgrade2023-08-24T09:53:29Z<p>P teichmann: /* Custom plugins */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
<b>Upgrading your own question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is your own question theme, make the necessary adjustments<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<b>Upgrading a theme you do not own:</b><br><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade. It should be checked if they are still working as expected and be updated if possible.<br />
<br />
<b>for self hosted application:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<b>for Cloud users(enterprise and above):</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Contact support to make an update to the plugin without loosing configuration data or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210410Major version upgrade2023-08-24T09:50:17Z<p>P teichmann: /* Custom plugins */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
<b>Upgrading your own question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is your own question theme, make the necessary adjustments<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<b>Upgrading a theme you do not own:</b><br><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade. It should be checked if they are still working as expected and be updated if possible.<br />
<br />
<b>for self hosted application:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<b>for Cloud users(enterprise and above):</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Contact support to make an update to the plugin without loosing configuration data <br><br />
or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210409Major version upgrade2023-08-24T09:42:58Z<p>P teichmann: /* Custom plugins */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
<b>Upgrading your own question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is your own question theme, make the necessary adjustments<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<b>Upgrading a theme you do not own:</b><br><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
<b>self hosted application:</b><br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210408Major version upgrade2023-08-24T09:35:41Z<p>P teichmann: /* Custom question themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
<b>Upgrading your own question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is your own question theme, make the necessary adjustments<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<b>Upgrading a theme you do not own:</b><br><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210407Major version upgrade2023-08-24T09:35:31Z<p>P teichmann: /* Custom question themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
<b>Upgrading your own question theme:</b><br />
# Download the question theme from a website or export the current question theme<br />
# Before uploading, make sure the compatibility of your custom question theme is set correctly https://manual.limesurvey.org/Extension_compatibility#Question_themes<br />
# Try to upload your question theme into the new application.<br />
# If it is your own question theme, make the necessary adjustments<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
<b>Upgrading a theme you do not own:</b><br />
Try to see if an update is available from the website or developer that provided it<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Extension_compatibility&diff=210406Extension compatibility2023-08-24T08:42:31Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Explanation=<!--T:2--><br />
Every Extension has a "compatibility" option set within its config.xml file which determines if the extension is compatible with the current version of LimeSurvey.<br><br />
The version will be compared to LimeSurvey's currently installed version.<br><br />
Extensions currently present in the application are: Survey themes, Admin themes and Plugins.<br />
<br />
==Valid formats==<!--T:3--><br />
6<br><br />
If a value of 6 is set, it will be compatible with all versions between 6 and 7.<br><br />
<br />
6.1<br><br />
6.1.1<br><br />
If a value of 6.1 is set, it will be compatible with all versions between 6.1 and 7.<br><br />
<br />
Example:<br><br />
[[File:Compatibility_config.PNG]]<br />
<br />
=Survey themes=<!--T:4--><br />
To fix an incompatible survey theme, add the "compatibility" option with the correct version number inside the "config.xml" file for this theme.<br />
<br />
This can be done in 2 ways:<br><br />
#Export the survey theme and access the config.xml file.<br />
#If you have access to the server, the config.xml is located inside "upload/themes/survey/YOURTHEMENAME" of the applications root directory.<br />
Carefully examine in a dummy survey which changes you need to make before using your custom survey theme in a live environment.<br />
<br />
=Admin themes=<!--T:5--><br />
{{Alert|text=Before updating the compatibility version number of your config.xml file, please be aware that enabling an incompatible admin theme can break the admin interface of the application.<br><br />
If this happens to you, make sure to manually set the theme inside the database table "settings_global" to the default theme "Sea_Green". You can always check in the "application/config/config-defaults.php" file what name should be used in the database $config['admintheme'] = 'Sea_Green';.<br>}}<br />
To enable an admin theme again, add the "compatibility" option with the correct version number inside the "config.xml" file for this theme.<br />
<br />
=Question themes=<!--T:6--><br />
To make them compatible with a new version of LimeSurvey the compatibility tag in config.xml has to be updated, located in "NAME/survey/questions/answer/QUESTIONTYPENAME/config.xml" within the structure of the quesiton theme.<br />
<br />
=Plugins=<!--T:7--><br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Extension_compatibility&diff=210405Extension compatibility2023-08-24T08:41:44Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Explanation=<!--T:2--><br />
Every Extension has a "compatibility" option set within its config.xml file which determines if the extension is compatible with the current version of LimeSurvey.<br><br />
The version will be compared to LimeSurvey's currently installed version.<br><br />
Extensions currently present in the application are: Survey themes, Admin themes and Plugins.<br />
<br />
==Valid formats==<!--T:3--><br />
6<br><br />
If a value of 6 is set, it will be compatible with all versions between 6 and 7.<br><br />
<br />
6.1<br><br />
6.1.1<br><br />
If a value of 6.1 is set, it will be compatible with all versions between 6.1 and 7.<br><br />
<br />
Example:<br><br />
[[File:Compatibility_config.PNG]]<br />
<br />
=Survey themes=<!--T:4--><br />
To fix an incompatible survey theme, add the "compatibility" option with the correct version number inside the "config.xml" file for this theme.<br />
<br />
This can be done in 2 ways:<br><br />
#Export the survey theme and access the config.xml file.<br />
#If you have access to the server, the config.xml is located inside "upload/themes/survey/YOURTHEMENAME" of the applications root directory.<br />
Carefully examine in a dummy survey which changes you need to make before using your custom survey theme in a live environment.<br />
<br />
=Admin themes=<!--T:5--><br />
{{Alert|text=Before updating the compatibility version number of your config.xml file, please be aware that enabling an incompatible admin theme can break the admin interface of the application.<br><br />
If this happens to you, make sure to manually set the theme inside the database table "settings_global" to the default theme "Sea_Green". You can always check in the "application/config/config-defaults.php" file what name should be used in the database $config['admintheme'] = 'Sea_Green';.<br>}}<br />
To enable an admin theme again, add the "compatibility" option with the correct version number inside the "config.xml" file for this theme.<br />
<br />
=Question themes=<!--T:6--><br />
To make them compatible with a new version of LimeSurvey the compatibility tag in config.xml has to be updated, located in "NAME/survey/questions/answer/QUESTIONTYPENAME/config.xml" of the custom question directory.<br />
<br />
=Plugins=<!--T:7--><br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Extension_compatibility&diff=210404Extension compatibility2023-08-24T08:34:28Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Explanation=<!--T:2--><br />
Every Extension has a "compatibility" option set within its config.xml file which determines if the extension is compatible with the current version of LimeSurvey.<br><br />
The version will be compared to LimeSurvey's currently installed version.<br><br />
Extensions currently present in the application are: Survey themes, Admin themes and Plugins.<br />
<br />
==Valid formats==<!--T:3--><br />
6<br><br />
If a value of 6 is set, it will be compatible with all versions between 6 and 7.<br><br />
<br />
6.1<br><br />
6.1.1<br><br />
If a value of 6.1 is set, it will be compatible with all versions between 6.1 and 7.<br><br />
<br />
Example:<br><br />
[[File:Compatibility_config.PNG]]<br />
<br />
=Survey themes=<!--T:4--><br />
To fix an incompatible survey theme, add the "compatibility" option with the correct version number inside the "config.xml" file for this theme.<br />
<br />
This can be done in 2 ways:<br><br />
#Export the survey theme and access the config.xml file.<br />
#If you have access to the server, the config.xml is located inside "upload/themes/survey/YOURTHEMENAME" of the applications root directory.<br />
Carefully examine in a dummy survey which changes you need to make before using your custom survey theme in a live environment.<br />
<br />
=Admin themes=<!--T:5--><br />
{{Alert|text=Before updating the compatibility version number of your config.xml file, please be aware that enabling an incompatible admin theme can break the admin interface of the application.<br><br />
If this happens to you, make sure to manually set the theme inside the database table "settings_global" to the default theme "Sea_Green". You can always check in the "application/config/config-defaults.php" file what name should be used in the database $config['admintheme'] = 'Sea_Green';.<br>}}<br />
To enable an admin theme again, add the "compatibility" option with the correct version number inside the "config.xml" file for this theme.<br />
<br />
=Question themes=<!--T:6--><br />
<b>for self hosted application:</b><br><br />
The question themes can be found in the "upload/themes/question" directory of the root application.<br><br />
To make them compatible with a new version of LimeSurvey the compatibility tag in config.xml has to be updated, located in "NAME/survey/questions/answer/QUESTIONTYPENAME/config.xml" of the custom question directory.<br />
<br />
=Plugins=<!--T:7--><br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Extension_compatibility&diff=210403Extension compatibility2023-08-24T08:31:31Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Explanation=<!--T:2--><br />
Every Extension has a "compatibility" option set within its config.xml file which determines if the extension is compatible with the current version of LimeSurvey.<br><br />
The version will be compared to LimeSurvey's currently installed version.<br><br />
Extensions currently present in the application are: Survey themes, Admin themes and Plugins.<br />
<br />
==Valid formats==<!--T:3--><br />
6<br><br />
If a value of 6 is set, it will be compatible with all versions between 6 and 7.<br><br />
<br />
6.1<br><br />
6.1.1<br><br />
If a value of 6.1 is set, it will be compatible with all versions between 6.1 and 7.<br><br />
<br />
Example:<br><br />
[[File:Compatibility_config.PNG]]<br />
<br />
=Survey themes=<!--T:4--><br />
To fix an incompatible survey theme, add the "compatibility" option with the correct version number inside the "config.xml" file for this theme.<br />
<br />
This can be done in 2 ways:<br><br />
#Export the survey theme and access the config.xml file.<br />
#If you have access to the server, the config.xml is located inside "upload/themes/survey/YOURTHEMENAME" of the applications root directory.<br />
Carefully examine in a dummy survey which changes you need to make before using your custom survey theme in a live environment.<br />
<br />
=Admin themes=<!--T:5--><br />
{{Alert|text=Before updating the compatibility version number of your config.xml file, please be aware that enabling an incompatible admin theme can break the admin interface of the application.<br><br />
If this happens to you, make sure to manually set the theme inside the database table "settings_global" to the default theme "Sea_Green". You can always check in the "application/config/config-defaults.php" file what name should be used in the database $config['admintheme'] = 'Sea_Green';.<br>}}<br />
To enable an admin theme again, add the "compatibility" option with the correct version number inside the "config.xml" file for this theme.<br />
<br />
=Question themes=<!--T:6--><br />
for self hosted application:<br />
The question themes can be found in the "upload/themes/question" directory of the root application.<br><br />
To make them compatible with a new version of LimeSurvey the compatibility tag in config.xml has to be updated, located in "NAME/survey/questions/answer/QUESTIONTYPENAME/config.xml" of the custom question directory.<br />
<br />
=Plugins=<!--T:7--><br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210402Major version upgrade2023-08-24T08:25:41Z<p>P teichmann: /* Custom question themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
Upgrade strategy:<br />
# Before uploading make sure the compatibility is set correctly<br />
# try to upload your question theme into the new application.<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210401Major version upgrade2023-08-24T07:54:20Z<p>P teichmann: /* Custom question themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
More information about question themes can be found here https://manual.limesurvey.org/Question_themes<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application.<br />
# If the import failed, make sure the compatibility is set correctly<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210400Major version upgrade2023-08-24T07:46:12Z<p>P teichmann: /* LimeSurvey 6 */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing "sea_green" theme which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210399Major version upgrade2023-08-24T07:46:00Z<p>P teichmann: /* LimeSurvey 6 */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey themes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. Admin themes will be reset to the already existing sea_green which has been updated as well.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210398Major version upgrade2023-08-23T15:58:47Z<p>P teichmann: /* Custom survey themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
<b>Upgrade Strategy:</b><br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210397Major version upgrade2023-08-23T15:58:13Z<p>P teichmann: /* Custom admin themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before copying the admin theme to the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210396Major version upgrade2023-08-23T15:36:56Z<p>P teichmann: /* Custom admin themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210395Major version upgrade2023-08-23T15:36:46Z<p>P teichmann: /* Custom admin themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
<b>for self hosted application:</b><br />
# Before it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
<b>for Cloud users:</b><br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210394Major version upgrade2023-08-23T15:35:56Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
for self hosted application:<br />
# Before it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Admin_themes''<br />
# Copy the existing admin theme from the old application to the new application ''https://manual.limesurvey.org/Custom_Admin_Themes''<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
for Cloud users:<br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210393Major version upgrade2023-08-23T15:31:29Z<p>P teichmann: /* Custom admin themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
for self hosted application:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Before<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, by default our new admin theme is now displayed. To update your previously installed admin theme, either:<br />
## manually update the code of the currently marked as incompatible admin theme <br />
## delete the old admin theme and install the new one you previously updated in your test environment<br />
<br />
for Cloud users:<br />
Please contact our support.<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210392Major version upgrade2023-08-23T15:23:39Z<p>P teichmann: /* Custom admin themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check the code you customized for the admin theme and update it in accordance with the new version of the application you want to use.<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210391Major version upgrade2023-08-23T15:17:30Z<p>P teichmann: /* Custom survey themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Before importing it in the new application, make sure the compatibility tag is set correctly: ''https://manual.limesurvey.org/Extension_compatibility#Survey_themes''<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use.<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210390Major version upgrade2023-08-23T15:12:45Z<p>P teichmann: /* Upgrade Strategy: */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210389Major version upgrade2023-08-23T15:12:09Z<p>P teichmann: /* Custom survey themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
===Upgrade Strategy:===<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210388Major version upgrade2023-08-23T15:11:02Z<p>P teichmann: /* Custom survey themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application to the new version, the current survey themes will be uninstalled and marked as incompatible. <br />
# Now you can delete the old surveytheme and import the new survey theme which you updated. Please ensure you have a backup of the deleted theme.<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210387Major version upgrade2023-08-23T15:01:30Z<p>P teichmann: /* Custom survey themes */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check the code you customized for the survey theme and update it in accordance with the new version of the application you want to use<br />
# Export your updated customized surveytheme from the new application<br />
# After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210386Major version upgrade2023-08-23T14:39:28Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check what changes are required<br />
# Implement your changes<br />
# Export your customized surveytheme from the new application<br />
# After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210385Major version upgrade2023-08-23T14:39:16Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
To be on save side when performing an upgrade and be able to continue surveys with the least amount of interruption we reccommend first testing all your customized code on the new version of LimeSurvey oyu wnat to upgrade to.<br><br />
This will require you to create a new application to test on, you can either create one through our cloud hosting:<<br><br />
''https://www.limesurvey.org/'' <br><br />
or host one up by yourself:<br><br />
''https://manual.limesurvey.org/Installation_-_LimeSurvey_CE'' <br><br />
<br />
<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check what changes are required<br />
# Implement your changes<br />
# Export your customized surveytheme from the new application<br />
# After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210384Major version upgrade2023-08-23T13:46:09Z<p>P teichmann: /* LimeSurvey 6 */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
It is required to create a new application with the version you want to upgrade to.<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check what changes are required<br />
# Implement your changes<br />
# Export your customized surveytheme from the new application<br />
# After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210383Major version upgrade2023-08-23T13:46:01Z<p>P teichmann: /* LimeSurvey 6 */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
# We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. <br><br />
After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
It is required to create a new application with the version you want to upgrade to.<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check what changes are required<br />
# Implement your changes<br />
# Export your customized surveytheme from the new application<br />
# After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210382Major version upgrade2023-08-23T13:45:38Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
# We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
It is required to create a new application with the version you want to upgrade to.<br />
<br />
==Custom survey themes==<br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check what changes are required<br />
# Implement your changes<br />
# Export your customized surveytheme from the new application<br />
# After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210381Major version upgrade2023-08-23T13:41:50Z<p>P teichmann: /* =LimeSurvey 6 */</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6==<br />
# We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes.<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
We first recommend creating a new application with version 6 installed.<br />
<br />
==Custom survey themes==<!--T:4--><br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check what changes are required<br />
# Implement your changes<br />
# Export your customized surveytheme from the new application<br />
# After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<!--T:5--><br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<!--T:6--><br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<!--T:7--><br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210380Major version upgrade2023-08-23T13:41:39Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Notes for specific LimeSurvey versions=<!--T:2--><br />
==LimeSurvey 6=<br />
# We updated LimeSurvey with a new design, which also includes an upgrade to the Bootstrap version being used for the admin- and surveytheme from Bootstrap 3 to 5. After this upgrade, all custom survey and adminthemes will be uninstalled and reset to use our new default theme "Fruity TwentyThree", this also affects extended themes. <br />
<br />
<br />
=How to prepare for a major version upgrade=<!--T:3--><br />
We first recommend creating a new application with version 6 installed.<br />
<br />
==Custom survey themes==<!--T:4--><br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check what changes are required<br />
# Implement your changes<br />
# Export your customized surveytheme from the new application<br />
# After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<!--T:5--><br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<!--T:6--><br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<!--T:7--><br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210379Major version upgrade2023-08-23T13:33:46Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=How to prepare for a major version upgrade=<!--T:2--><br />
We first recommend creating a new application with version 6 installed.<br />
<br />
==Custom survey themes==<!--T:3--><br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check what changes are required<br />
# Implement your changes<br />
# Export your customized surveytheme from the new application<br />
# After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<!--T:4--><br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<!--T:5--><br />
Custom question themes that do not match the current version cannot be installed, but will still be active after the upgrade.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected.<br />
<br />
==Custom plugins==<!--T:6--><br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210378Major version upgrade2023-08-23T13:31:02Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=How to prepare for a major version upgrade=<!--T:2--><br />
We first recommend creating a new application with version 6 installed.<br />
<br />
==Custom survey themes==<!--T:3--><br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check what changes are required<br />
# Implement your changes<br />
# Export your customized surveytheme from the new application<br />
# After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<!--T:4--><br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<!--T:5--><br />
Custom question themes will still be active, but will need to be checked for compatibility in your new version.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected. <br />
<br />
==Custom plugins==<!--T:6--><br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210377Major version upgrade2023-08-23T13:30:33Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=How to prepare for a major version upgrade=<!--T:2--><br />
We first recommend creating a new application with version 6 installed.<br />
<br />
==Custom survey themes==<!--T:3--><br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check what changes are required<br />
# Implement your changes<br />
# Export your customized surveytheme from the new application<br />
# After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<!--T:4--><br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<!--T:5--><br />
Custom question themes will still be active, but will need to be checked for compatibility in your new version.<br />
<br />
Upgrade strategy:<br />
# try to upload your question theme into the new application<br />
# make required changes, so it will be compatible with the new version<br />
# after successfully uploading, please check if the question theme is displayed and working as expected. <br />
<br />
==Custom plugins==<!--T:6-><br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210376Major version upgrade2023-08-23T08:09:37Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=How to prepare for a major version upgrade=<!--T:2--><br />
We first recommend creating a new application with version 6 installed.<br />
<br />
==Custom survey themes==<!--T:3--><br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
# Export the survey theme from the old application<br />
# Import into the new application<br />
# Check what changes are required<br />
# Implement your changes<br />
# Export your customized surveytheme from the new application<br />
# After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<!--T:4--><br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
# Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
# Check what changes are required<br />
# Implement your changes<br />
# After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<!--T:5--><br />
Custom question themes will still be active but will need to be checked for compatibility in your new version.<br />
<br />
==Custom plugins==<!--T:6-><br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
# Check if the plugin can be installed on the new version.<br />
# Update the plugin or contact the plugin author to update the plugin.<br />
# Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Major_version_upgrade&diff=210191Major version upgrade2023-08-22T15:34:58Z<p>P teichmann: Created page with "<languages /> <translate> <!--T:1--> __TOC__ =How to prepare for a major version upgrade=<!--T:2--> We first recommend creating a new application with version 6 installed...."</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=How to prepare for a major version upgrade=<!--T:2--><br />
We first recommend creating a new application with version 6 installed.<br />
<br />
==Custom survey themes==<!--T:3--><br />
All custom survey themes (this includes extended themes) will be uninstalled and the options configured will be reset to the default.<br />
<br />
Upgrade Strategy:<br />
1. Export the survey theme from the old application<br />
2. Import into the new application<br />
3. Check what changes are required<br />
4. Implement your changes<br />
5. Export your customized surveytheme from the new application<br />
6. After upgrading your old application, import the new survey theme, and you are done!<br />
<br />
==Custom admin themes==<!--T:4--><br />
All custom admin themes will be uninstalled and the new default will be used.<br />
<br />
Upgrade strategy:<br />
1. Copy the existing admin theme from the old application to the new application [insert link to admin theme documentation]<br />
2. Check what changes are required<br />
3. Implement your changes<br />
4. After upgrading your old application, copy the new admin theme into the upgraded application, and you are done!<br />
<br />
==Custom question themes==<!--T:5--><br />
Custom question themes will still be active but will need to be checked for compatibility in your new version.<br />
<br />
==Custom plugins==<!--T:6-><br />
Custom plugins that do not match the current version cannot be activated or installed, but will still be active after the upgrade.<br />
<br />
Upgrade Strategy:<br />
1. Check if the plugin can be installed on the new version.<br />
2. Update the plugin or contact the plugin author to update the plugin.<br />
3. Manually override the plugin with new files in your application or uninstall the old version and reinstall the new version (all settings will be lost and have to be reapplied)<br />
<br />
<br />
</translate></div>P teichmannhttps://www.limesurvey.org/manual/index.php?title=Extension_compatibility&diff=176634Extension compatibility2023-07-05T15:03:17Z<p>P teichmann: </p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
__TOC__<br />
<br />
=Explanation=<!--T:2--><br />
Every Extension has a "compatibility" option set within its config.xml file which determines if the extension is compatible with the current version of LimeSurvey.<br><br />
The version will be compared to LimeSurvey's currently installed version.<br><br />
Extensions currently present in the application are: Survey themes, Admin themes and Plugins.<br />
<br />
==Valid formats==<!--T:3--><br />
6<br><br />
If a value of 6 is set, it will be compatible with all versions between 6 and 7.<br><br />
<br />
6.1<br><br />
6.1.1<br><br />
If a value of 6.1 is set, it will be compatible with all versions between 6.1 and 7.<br><br />
<br />
Example:<br><br />
[[File:Compatibility_config.PNG]]<br />
<br />
=Survey themes=<!--T:4--><br />
To fix an incompatible survey theme, add the "compatibility" option with the correct version number inside the "config.xml" file for this theme.<br />
<br />
This can be done in 2 ways:<br><br />
#Export the survey theme and access the config.xml file.<br />
#If you have access to the server, the config.xml is located inside "upload/themes/survey/YOURTHEMENAME" of the applications root directory.<br />
Carefully examine in a dummy survey which changes you need to make before using your custom survey theme in a live environment.<br />
<br />
=Admin themes=<!--T:5--><br />
{{Alert|text=Before updating the compatibility version number of your config.xml file, please be aware that enabling an incompatible admin theme can break the admin interface of the application.<br><br />
If this happens to you, make sure to manually set the theme inside the database table "settings_global" to the default theme "Sea_Green". You can always check in the "application/config/config-defaults.php" file what name should be used in the database $config['admintheme'] = 'Sea_Green';.<br>}}<br />
To enable an admin theme again, add the "compatibility" option with the correct version number inside the "config.xml" file for this theme.<br />
<br />
=Plugins=<!--T:6--><br />
<br />
</translate></div>P teichmann