Question themes - Revision history

Vharris: /* General Attributes */

2021-07-05T08:18:48Z

General Attributes

← Older revision		Revision as of 10:18, 5 July 2021
Line 199:		Line 199:
	[[File:QuestionThemes8Files.png]]		[[File:QuestionThemes8Files.png]]

	=== General ~~Attributes~~ ===		=== General attributes ===

	General attributes are attributes that are displayed on the right side of the question editor.		General attributes are attributes that are displayed on the right side of the question editor.

Vharris: /* Importing Question Theme */

2021-07-05T08:18:11Z

Importing Question Theme

← Older revision		Revision as of 10:18, 5 July 2021
Line 60:		Line 60:
	If there are errors while loading the [[Question Themes#Uninstall and Available Question Themes\|available question themes]], they will be displayed in this category with an error message.		If there are errors while loading the [[Question Themes#Uninstall and Available Question Themes\|available question themes]], they will be displayed in this category with an error message.

	== Importing ~~Question Theme~~ ==		== Importing question theme ==

	It is possible to import Question Themes using the import button. During the import, the theme will be automatically installed and available for use.		It is possible to import Question Themes using the import button. During the import, the theme will be automatically installed and available for use.

Vharris: /* Broken Question Themes */

2021-07-05T08:17:58Z

Broken Question Themes

← Older revision		Revision as of 10:17, 5 July 2021
Line 56:		Line 56:
	[[File:QuestionThemes5AvailableQuestions.png]]		[[File:QuestionThemes5AvailableQuestions.png]]

	== Broken ~~Question Themes~~ ==		== Broken question themes ==

	If there are errors while loading the [[Question Themes#Uninstall and Available Question Themes\|available question themes]], they will be displayed in this category with an error message.		If there are errors while loading the [[Question Themes#Uninstall and Available Question Themes\|available question themes]], they will be displayed in this category with an error message.

Vharris: /* Uninstall and Available Question Themes */

2021-07-05T08:17:45Z

Uninstall and Available Question Themes

← Older revision		Revision as of 10:17, 5 July 2021
Line 34:		Line 34:
	When the Option "[[Question Themes#Engine\|Show as question type]]" is enabled, all question themes will also be displayed inside the question type selector.		When the Option "[[Question Themes#Engine\|Show as question type]]" is enabled, all question themes will also be displayed inside the question type selector.

	== Uninstall and ~~Available Question Themes~~ ==		== Uninstall and available question themes ==

	All available themes will be displayed in this section.		All available themes will be displayed in this section.

C schmitz at 13:55, 1 June 2021

2021-06-01T13:55:38Z

← Older revision		Revision as of 15:55, 1 June 2021
Line 1:		Line 1:

	= Introduction =		== Introduction ==
	Question themes can be used to customize existing question types and change their visual appearance. Question themes can only be built on core '''Question types'''.		Question themes can be used to customize existing question types and change their visual appearance. Question themes can only be built on core '''Question types'''.

	= Access =		== Access ==

	To access the question themes, go to Configuration > Themes > Question themes.		To access the question themes, go to Configuration > Themes > Question themes.
Line 17:		Line 17:
	[[File:QuestionThemes2Overview.png]]		[[File:QuestionThemes2Overview.png]]

	= Visibility =		== Visibility ==

	Question Themes are by default visible, but can be switched off. Once turned off, '''they will no longer be displayed inside the question type selector'''.		Question Themes are by default visible, but can be switched off. Once turned off, '''they will no longer be displayed inside the question type selector'''.
Line 34:		Line 34:
	When the Option "[[Question Themes#Engine\|Show as question type]]" is enabled, all question themes will also be displayed inside the question type selector.		When the Option "[[Question Themes#Engine\|Show as question type]]" is enabled, all question themes will also be displayed inside the question type selector.

	= Uninstall and Available Question Themes =		== Uninstall and Available Question Themes ==

	All available themes will be displayed in this section.		All available themes will be displayed in this section.
Line 56:		Line 56:
	[[File:QuestionThemes5AvailableQuestions.png]]		[[File:QuestionThemes5AvailableQuestions.png]]

	= Broken Question Themes =		== Broken Question Themes ==

	If there are errors while loading the [[Question Themes#Uninstall and Available Question Themes\|available question themes]], they will be displayed in this category with an error message.		If there are errors while loading the [[Question Themes#Uninstall and Available Question Themes\|available question themes]], they will be displayed in this category with an error message.

	= Importing Question Theme =		== Importing Question Theme ==

	It is possible to import Question Themes using the import button. During the import, the theme will be automatically installed and available for use.		It is possible to import Question Themes using the import button. During the import, the theme will be automatically installed and available for use.
Line 74:		Line 74:
	NAME/survey/questions/answer/QUESTIONTYPENAME/config.xml		NAME/survey/questions/answer/QUESTIONTYPENAME/config.xml

	= List of question types/IDs and default CSS classes =		== List of question types/IDs and default CSS classes ==

	{\|		{\|
Line 136:		Line 136:
	\|}		\|}

	= Configuration =		== Configuration ==

	The configuration of a question theme can be found inside config.xml.		The configuration of a question theme can be found inside config.xml.
Line 142:		Line 142:
	An example can be found in the [https://github.com/LimeSurvey/LimeSurvey/tree/develop/docs/themes docs folder].		An example can be found in the [https://github.com/LimeSurvey/LimeSurvey/tree/develop/docs/themes docs folder].

	== Metadata ==		=== Metadata ===

	The Metadata describes the question theme. These settings will also be saved in the database.		The Metadata describes the question theme. These settings will also be saved in the database.
Line 193:		Line 193:
	\|}		\|}

	== Files ==		=== Files ===

	List of the of files loaded via asset manager.		List of the of files loaded via asset manager.
Line 199:		Line 199:
	[[File:QuestionThemes8Files.png]]		[[File:QuestionThemes8Files.png]]

	== General Attributes ==		=== General Attributes ===

	General attributes are attributes that are displayed on the right side of the question editor.		General attributes are attributes that are displayed on the right side of the question editor.
Line 207:		Line 207:
	[[File:QuestionThemes9GeneralAttributes.png]]		[[File:QuestionThemes9GeneralAttributes.png]]

	== Attributes ==		=== Attributes ===

	Attributes are options you want to give to a Question Theme and can be customized. They are visible at the bottom of the question editor.		Attributes are options you want to give to a Question Theme and can be customized. They are visible at the bottom of the question editor.
Line 239:		Line 239:
	\|}		\|}

	== Engine ==		=== Engine ===

	Configuration for special load options		Configuration for special load options
Line 260:		Line 260:
	\|}		\|}

	= Compatibility =		== Compatibility ==

	== Converting LS3 to LS4 ==		=== Converting LS3 to LS4 ===

	When updating to LS4, the custom Question Themes will be updated to the LS4 standard. If the theme has missing attributes that cannot be automatically inserted, they will not be installed and instead be available for installation. If errors occur, they can be found under [[Question Themes#Broken Question Themes\|the broken question themes table]].		When updating to LS4, the custom Question Themes will be updated to the LS4 standard. If the theme has missing attributes that cannot be automatically inserted, they will not be installed and instead be available for installation. If errors occur, they can be found under [[Question Themes#Broken Question Themes\|the broken question themes table]].
Line 270:		Line 270:
	The question themes created for LS4 are not backwards compatible (cannot be used in LS3!).		The question themes created for LS4 are not backwards compatible (cannot be used in LS3!).

	== LS4 changes ==		=== LS4 changes ===

	The "custom_attributes" tag is no long needed. Attributes will always be defined inside the attributes tag instead. There is no need for different naming since they will be merged together when reading the Question Type.		The "custom_attributes" tag is no long needed. Attributes will always be defined inside the attributes tag instead. There is no need for different naming since they will be merged together when reading the Question Type.

C schmitz: /* Introduction */

2021-06-01T13:48:24Z

Introduction

← Older revision		Revision as of 15:48, 1 June 2021
Line 1:		Line 1:

	= Introduction =		= Introduction =

	~~{{Alert\|Update 25.01.2021: At the moment, the LS3 themes are not automatically converted and imported to LS4. Make sure the themes are compatible with LS4 beforehand.}}~~

	Question themes can be used to customize existing question types and change their visual appearance. Question themes can only be built on core '''Question types'''.		Question themes can be used to customize existing question types and change their visual appearance. Question themes can only be built on core '''Question types'''.

C schmitz: /* Uninstall and Available Question Themes */

2021-06-01T13:47:57Z

Uninstall and Available Question Themes

← Older revision		Revision as of 15:47, 1 June 2021
Line 39:		Line 39:
	= Uninstall and Available Question Themes =		= Uninstall and Available Question Themes =

	All themes ~~that are available for installation~~ will be displayed in this section.		All available themes will be displayed in this section.

	If you want to uninstall a question, you can do so by selecting the ~~Question~~ Theme and choosing "~~uninstall~~" inside the dropdown menu under the table. They will now appear inside the available Question Themes table.		If you want to uninstall a question theme, you can do so by selecting the question Theme and choosing "Uninstall" inside the dropdown menu under the table. They will now appear inside the available Question Themes table.

	If a theme is uninstalled, it will no longer be available ~~anymore~~ inside the question type selector.		If a theme is uninstalled, it will no longer be available inside the question type selector.


	Steps to uninstall a question theme:		Steps to uninstall a question theme:

	1. '''Configuration''' > '''Themes''' > '''Question ~~Themes~~'''		1. '''Configuration''' > '''Themes''' > '''Question themes'''

	2. Tick the box for the question theme that you would like to uninstall.		2. Tick the box for the question theme that you would like to uninstall.

	3. Click on "Selected ~~Themes~~" at the bottom of the page and select "~~uninstall~~" from the dropdown options.		3. Click on "Selected themes" at the bottom of the page and select "Uninstall" from the dropdown options.

	'''{{Note\|~~Used~~ Question ~~Themes~~ cannot be uninstalled ~~while~~ they are still used inside a ~~Survey~~.}}'''		'''{{Note\|Question themes cannot be uninstalled if they are still used inside a aurvey.}}'''

C schmitz: /* Visibility */

2021-06-01T13:46:23Z

Visibility

← Older revision		Revision as of 15:46, 1 June 2021
Line 35:		Line 35:


	When the Option "[[Question Themes#Engine\|~~show~~ as question type]]" is enabled, all question themes will also be displayed inside the question type selector.		When the Option "[[Question Themes#Engine\|Show as question type]]" is enabled, all question themes will also be displayed inside the question type selector.

	= Uninstall and Available Question Themes =		= Uninstall and Available Question Themes =

C schmitz: /* Visibility */

2021-06-01T13:46:00Z

Visibility

← Older revision		Revision as of 15:46, 1 June 2021
Line 35:		Line 35:


	When the Option "[[Question Themes#Engine\|show as question type]]" is enabled, all ~~Question Themes~~ will also be displayed inside the ~~Question Type Selector~~.		When the Option "[[Question Themes#Engine\|show as question type]]" is enabled, all question themes will also be displayed inside the question type selector.


	~~[[File:QuestionThemes4Visibility.png]]~~

	= Uninstall and Available Question Themes =		= Uninstall and Available Question Themes =

C schmitz: /* Access */

2021-06-01T13:45:11Z

Access

← Older revision		Revision as of 15:45, 1 June 2021
Line 8:		Line 8:
	= Access =		= Access =

	To access the ~~Question~~ themes, go to Configuration > Themes > Question themes.		To access the question themes, go to Configuration > Themes > Question themes.

	[[File:QuestionThemes1Overview.png]]		[[File:QuestionThemes1Overview.png]]