Coding guidelines - Revision history

P teichmann at 10:18, 13 August 2026

2026-08-13T10:18:32Z

← Older revision		Revision as of 12:18, 13 August 2026
Line 328:		Line 328:
	=Accessibility guidelines=		=Accessibility guidelines=
	New code should be checked for accessibility. <br />		New code should be checked for accessibility. <br />
	WCAG 2.2 AA is the standard for new code. <br />		[https://www.w3.org/TR/WCAG22/ WCAG 2.2 AA] is the standard for new code. <br />
	The LimeSurvey team is actively working to bring existing code up to this standard. When writing code, consider:		The LimeSurvey team is actively working to bring existing code up to this standard. When writing code, consider:
	# Can every part of the UI be reached and operated using only a keyboard?		# Can every part of the UI be reached and operated using only a keyboard?

P teichmann: added initial description for accessibility

2026-08-13T10:12:28Z

added initial description for accessibility

← Older revision		Revision as of 12:12, 13 August 2026
Line 325:		Line 325:

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

			=Accessibility guidelines=
			New code should be checked for accessibility. <br />
			WCAG 2.2 AA is the standard for new code. <br />
			The LimeSurvey team is actively working to bring existing code up to this standard. When writing code, consider:
			# Can every part of the UI be reached and operated using only a keyboard?
			# Do all interactive elements have accessible names (via <label>, aria-label, etc.) and do images have meaningful alt text?
			# After an action, does focus move to the right place, and are dynamic changes announced to screen readers (e.g., via live regions)?
			# Are colors and states visually distinct, with sufficient contrast (4.5:1 for text, 3:1 for UI components)?
			# Are touch/click targets at least 24×24px?
			# Is motion/animation respectful of the user's prefers-reduced-motion setting?

			Tools that can be used to check for accessibility in your browser:
			# [https://chromewebstore.google.com/detail/accessibility-insights-fo/pbjjkligggfmakdaogkfomddhfmpjeni accessibility insights] checks the entire page you are looking at for issues
			# [https://chromewebstore.google.com/detail/wcag-contrast-checker/moeekkcjabmojhnfljngmohaaigchpbf?pli=1 wcag contrast checker] checks color contrast for all elements/text
			# [https://chromewebstore.google.com/detail/color-contrast-checker-by/hfcoldjibhgbnlambdiecfneiegagkhi wcag contrast checker (selected)] checks color contrast for manually selected colors and gives suggestions

			<div class='simplebox'> [[File:help.png]] Work for this section is still in progress and more details and examples will follow </div>


	=Checklist for new features=		=Checklist for new features=

Twilllig at 09:36, 6 October 2025

2025-10-06T09:36:32Z

← Older revision		Revision as of 11:36, 6 October 2025
Line 218:		Line 218:

	1. Navigate to the relevant theme folder (e.g. `assets/admin_themes/Sea_Green/` or `assets/survey_themes/fruity_twentythree/`).		1. Navigate to the relevant theme folder (e.g. `assets/admin_themes/Sea_Green/` or `assets/survey_themes/fruity_twentythree/`).
	2. Modify or add SCSS components as needed.		2. Modify or add SCSS components as needed.
	3. Run one of the Gulp build commands above to compile:		3. Run one of the Gulp build commands above to compile:
	* For example:		* For example:
Line 226:		Line 226:
	4. Clear LimeSurvey’s asset cache (from the admin interface or manually) to see your changes live in the UI.		4. Clear LimeSurvey’s asset cache (from the admin interface or manually) to see your changes live in the UI.

			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.

	[[Category:Development guidelines]]		[[Category:Development guidelines]]

Twilllig at 07:45, 29 August 2025

2025-08-29T07:45:13Z

Show changes

C schmitz: Text replacement - " enclose="div"" to ""

2022-02-16T13:06:26Z

Text replacement - " enclose="div"" to ""

← Older revision		Revision as of 15:06, 16 February 2022
Line 51:		Line 51:
	Example:		Example:

	<syntaxhighlight lang="php~~" enclose="div~~"><?php		<syntaxhighlight lang="php"><?php
	$oResult = Yii::app()->db		$oResult = Yii::app()->db
	->createCommand()		->createCommand()
Line 64:		Line 64:
	WRONG:		WRONG:

	<syntaxhighlight lang="php~~" enclose="div~~"><?php		<syntaxhighlight lang="php"><?php
	$oResult = Yii::app()->db		$oResult = Yii::app()->db
	->createCommand()		->createCommand()
Line 75:		Line 75:
	RIGHT:		RIGHT:

	<syntaxhighlight lang="php~~" enclose="div~~"><?php		<syntaxhighlight lang="php"><?php
	$oResult = Yii::app()->db		$oResult = Yii::app()->db
	->createCommand()		->createCommand()
Line 98:		Line 98:
	*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:		*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:

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

	WRONG:		WRONG:

Ollehar: /* Naming convention */

2021-08-03T12:31:06Z

Naming convention

@@ Line 16: / Line 16: @@
 *Keep a fluid dialog with the others coders, they have their own thoughts about what you are doing.
 *Ask if you are in doubt.
 =Documentation=

Ollehar: /* Structures */

2021-08-03T12:27:14Z

Structures

← Older revision		Revision as of 14:27, 3 August 2021
Line 33:		Line 33:

	Please document your source code - see this introduction: [[How to document your source code]].		Please document your source code - see this introduction: [[How to document your source code]].

	~~=Structures=~~
	* Apply [https://www.php-fig.org/psr/psr-2/ PSR-2], or better, [https://www.php-fig.org/psr/psr-12/ PSR-12].
	*Indent using steps of 4 spaces instead of TAB.
	* Feel free to use [https://github.com/squizlabs/PHP_CodeSniffer codesniffer] and/or [https://phpmd.org/ mess detector] to detect syntax violations and simple bugs (like unused or undefined variables).
	*The same for HTML in views tags:
	~~<syntaxhighlight lang="html" enclose="div">~~
	~~<table>~~
	~~<tr>~~
	~~<td colspan='2' height='4'>~~
	~~<strong>~~
	~~Some Text~~
	~~</strong>~~
	~~</td>~~
	~~</tr>~~
	~~</table>~~
	~~</syntaxhighlight>~~

	=HTML=		=HTML=

Ollehar: /* Controller methods */

2021-08-03T12:26:40Z

Controller methods

← Older revision		Revision as of 14:26, 3 August 2021
Line 29:		Line 29:

	The above is an array of User model (including the empty list).		The above is an array of User model (including the empty list).

	~~== Controller methods ==~~

	All public controller methods should be named with verb + object. Example: saveUser; showPermissions; deleteSurvey. When not using Survey_Common_Action, they will be prefixed with "action-", like so: actionSaveUser.

	=Documentation=		=Documentation=

Ollehar: /* Structures */

2021-07-20T15:00:09Z

Structures

← Older revision		Revision as of 17:00, 20 July 2021
Line 42:		Line 42:
	*Indent using steps of 4 spaces instead of TAB.		*Indent using steps of 4 spaces instead of TAB.
	* Feel free to use [https://github.com/squizlabs/PHP_CodeSniffer codesniffer] and/or [https://phpmd.org/ mess detector] to detect syntax violations and simple bugs (like unused or undefined variables).		* Feel free to use [https://github.com/squizlabs/PHP_CodeSniffer codesniffer] and/or [https://phpmd.org/ mess detector] to detect syntax violations and simple bugs (like unused or undefined variables).
	*SQL sentences must respect the same rule:

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

	~~$sSQL = "SELECT field1, field2, field3 "~~
	~~."WHERE condition "~~
	~~."AND condition "~~
	~~."OR condition "~~
	~~."ORDER BY field1, field2";~~
	~~</syntaxhighlight>~~
	*The same for HTML in views tags:		*The same for HTML in views tags:
			<syntaxhighlight lang="html" enclose="div">
	<syntaxhighlight lang="~~php~~" enclose="div">
	<table>		<table>
	<tr>		<tr>
Line 64:		Line 53:
	</tr>		</tr>
	</table>		</table>

	</syntaxhighlight>		</syntaxhighlight>

Ollehar: /* Localization */

2021-07-20T14:01:30Z

Localization

@@ Line 75: / Line 75: @@
 =Localization=
-Currently we are using the gT(),eT(),ngT() and neT() functions of the limesurvey_lang object for translations.
+Moved to https://manual.limesurvey.org/Code_quality_guide#Localization
 =Bug tracker=