Development:XML Administrator Settings - Revision history

Mudrd8mz: Text replacement - "class="nicetable"" to "class="wikitable""

2021-07-14T13:25:52Z

Text replacement - "class="nicetable"" to "class="wikitable""

← Older revision		Revision as of 13:25, 14 July 2021
Line 31:		Line 31:

	==Glossary==		==Glossary==
	{\| class="~~nicetable~~"		{\| class="wikitable"
	!Term		!Term
	!Definition		!Definition

Cwaclawik: /* Use Cases */

2009-05-22T15:27:41Z

Use Cases

@@ Line 92: / Line 92: @@
 *Each setting says which preset affected it.
 *User sees a summary of what settings were affected
 == TODO ==

Cwaclawik at 15:08, 22 May 2009

2009-05-22T15:08:29Z

@@ Line 52: / Line 52: @@
 [[Image:Settingsmockup1.png]]
 All settings are available in the tree, organized in a similar fashion as the admin navbar. Checking a setting includes it in your preset. The checkbox at the bottom allows you to automatically exclude sensitive settings (like passwords). Saving a preset creates the XML file, and adds the file to the list of available presets.
 ===Applying Settings presets===
 [[Image:Settingsmockup2.png]]
 The debug window at the top only appears when presets have been applied. It shows which setting was taken from which preset, as well as any possible errors. Beneath it is a list of available presets (with an option to import from file). There is a checkbox that determines whether to use the default or current value for unspecified settings, but we will probably end up with more user-controlled parameters for importing. You can preview a preset, bringing up the screen below. The "Use Multiple" button is an advanced feature, allowing you to choose multiple presets and sort them by priority. You can also create a new preset from multiple separate presets.
@@ Line 63: / Line 65: @@
 It allows users to collapse and expand the sub categories, view the values that are specified, as well as seeing setting descriptions. I hope to include an editor that looks similar to this, except with the ability to change the specified value (this would edit the XML file, not the site settings).
 == TODO ==
 ===Coding===

Cwaclawik: /* Glossary */

2009-05-22T14:09:07Z

Glossary

← Older revision		Revision as of 14:09, 22 May 2009
Line 41:		Line 41:
	\|A tree containing all Moodle settings in the same organization as the site administration page		\|A tree containing all Moodle settings in the same organization as the site administration page
	\|-		\|-
	\|~~preset~~		\|Preset
	\|An XML file containing either full or partial Moodle settings.		\|An XML file containing either full or partial Moodle settings.
	\|-		\|-
			\|Template
			\|The old name for presets; this may be found in other pages talking about this project.
	\|}		\|}

Cwaclawik: changed template to preset

2009-05-22T14:07:54Z

changed template to preset

← Older revision		Revision as of 14:07, 22 May 2009
Line 4:		Line 4:

	== Motivation ==		== Motivation ==
	I want to create a new administrative interface for importing and exporting site-wide configuration (tracker issue MDL-18548). At the basic level, it would allow administrators to save their site settings in an XML file, as well as import other saved configurations. Administrators will be able to select a subset of all settings to create a ~~template~~. They can then apply ~~templates~~ to their site settings, either individually or with specified priorities. Moodle will then adjust change setting to the value in the highest-priority ~~template~~, and then use either the current or default settings for whatever remains.		I want to create a new administrative interface for importing and exporting site-wide configuration (tracker issue MDL-18548). At the basic level, it would allow administrators to save their site settings in an XML file, as well as import other saved configurations. Administrators will be able to select a subset of all settings to create a preset. They can then apply presets to their site settings, either individually or with specified priorities. Moodle will then adjust change setting to the value in the highest-priority preset, and then use either the current or default settings for whatever remains.

	== Other Discussion==		== Other Discussion==
	*[https://docs.moodle.org/en/Talk:Projects_for_new_developers#~~XML_templates_for_admin_settings~~ Projects for new developers: XML ~~templates~~ for admin settings]		*[https://docs.moodle.org/en/Talk:Projects_for_new_developers#XML_presets_for_admin_settings Projects for new developers: XML presets for admin settings]
	*[http://moodle.org/mod/forum/discuss.php?d=118494#p528195 Forum discussion]		*[http://moodle.org/mod/forum/discuss.php?d=118494#p528195 Forum discussion]
	*Tracker Issue MDL-18548		*Tracker Issue MDL-18548
Line 18:		Line 18:
	This is a current list of features that have been suggested/requested. This is not the finalized list and will need a community review:		This is a current list of features that have been suggested/requested. This is not the finalized list and will need a community review:
	*Selection of settings to export (grouped in a tree format as displayed in the administrator panel)		*Selection of settings to export (grouped in a tree format as displayed in the administrator panel)
	*Naming and saving of XML files as special "~~templates~~" to be applied to a new install of Moodle for specific situations.		*Naming and saving of XML files as special "presets" to be applied to a new install of Moodle for specific situations.
	*An interface listing the ~~templates~~ (XML exported files with the "~~template~~" attribute set)		*An interface listing the presets (XML exported files with the "preset" attribute set)
	*A way to record the registered ~~templates~~ (beyond detecting the filesystem)		*A way to record the registered presets (beyond detecting the filesystem)
	*A view of the settings available for restore in a given XML file		*A view of the settings available for restore in a given XML file
	*Partial export/import		*Partial export/import
Line 26:		Line 26:
	*Logging the settings (to allow rollbacks)		*Logging the settings (to allow rollbacks)
	*Comments for settings changes		*Comments for settings changes
	*The ability to "switch" a ~~template~~ on/off. While on, it overrides the original settings without replacing them. When off, the original settings are restored		*The ability to "switch" a preset on/off. While on, it overrides the original settings without replacing them. When off, the original settings are restored
	*In addition to the previous point: ability to switch several ~~templates~~ on/off, and to organise them by priority. If a setting is defined in two ~~templates~~, the one in the ~~template~~ with the highest priority overrides the other one.		*In addition to the previous point: ability to switch several presets on/off, and to organise them by priority. If a setting is defined in two presets, the one in the preset with the highest priority overrides the other one.
	*Progressive disclosure (making sure that only those who want to mess with the ~~templates~~ will find them, and that they will not be changed accidentally) [http://www.useit.com/alertbox/progressive-disclosure.html]		*Progressive disclosure (making sure that only those who want to mess with the presets will find them, and that they will not be changed accidentally) [http://www.useit.com/alertbox/progressive-disclosure.html]

	==Glossary==		==Glossary==
Line 36:		Line 36:
	\|-		\|-
	\|Preview		\|Preview
	\|The ability to see the contents of a ~~template~~ before applying it (either all the settings, or the settings that will be changed)		\|The ability to see the contents of a preset before applying it (either all the settings, or the settings that will be changed)
	\|-		\|-
	\|Settings tree		\|Settings tree
	\|A tree containing all Moodle settings in the same organization as the site administration page		\|A tree containing all Moodle settings in the same organization as the site administration page
	\|-		\|-
	\|~~Template~~		\|preset
	\|An XML file containing either full or partial Moodle settings.		\|An XML file containing either full or partial Moodle settings.
	\|-		\|-
Line 47:		Line 47:

	== UI Mockups ==		== UI Mockups ==
	===Settings ~~Template~~ Creation===		===Settings preset Creation===

	[[Image:Settingsmockup1.png]]		[[Image:Settingsmockup1.png]]
	All settings are available in the tree, organized in a similar fashion as the admin navbar. Checking a setting includes it in your ~~template~~. The checkbox at the bottom allows you to automatically exclude sensitive settings (like passwords). Saving a ~~template~~ creates the XML file, and adds the file to the list of available ~~templates~~.		All settings are available in the tree, organized in a similar fashion as the admin navbar. Checking a setting includes it in your preset. The checkbox at the bottom allows you to automatically exclude sensitive settings (like passwords). Saving a preset creates the XML file, and adds the file to the list of available presets.

	===Applying Settings ~~Templates~~===		===Applying Settings presets===
	[[Image:Settingsmockup2.png]]		[[Image:Settingsmockup2.png]]
	The debug window at the top only appears when ~~templates~~ have been applied. It shows which setting was taken from which ~~template~~, as well as any possible errors. Beneath it is a list of available ~~templates~~ (with an option to import from file). There is a checkbox that determines whether to use the default or current value for unspecified settings, but we will probably end up with more user-controlled parameters for importing. You can preview a ~~template~~, bringing up the screen below. The "Use Multiple" button is an advanced feature, allowing you to choose multiple ~~templates~~ and sort them by priority. You can also create a new ~~template~~ from multiple separate ~~templates~~.		The debug window at the top only appears when presets have been applied. It shows which setting was taken from which preset, as well as any possible errors. Beneath it is a list of available presets (with an option to import from file). There is a checkbox that determines whether to use the default or current value for unspecified settings, but we will probably end up with more user-controlled parameters for importing. You can preview a preset, bringing up the screen below. The "Use Multiple" button is an advanced feature, allowing you to choose multiple presets and sort them by priority. You can also create a new preset from multiple separate presets.

	===Settings ~~Template~~ Preview===		===Settings preset Preview===
	[[Image:Settingsmockup3.png]]		[[Image:Settingsmockup3.png]]

Line 75:		Line 75:
	*Import partial configuration		*Import partial configuration
	*Settings preview		*Settings preview
	*Import multiple ~~templates~~		*Import multiple presets
	*XML/~~template~~ editor		*XML/preset editor

Rcollman: Intro, no longer need _TOC_

2009-05-20T11:55:03Z

Intro, no longer need _TOC_

← Older revision		Revision as of 11:55, 20 May 2009
Line 1:		Line 1:
	{{GSOC 09}}		{{GSOC 09}}
	~~__TOC__~~		This project will create a administrative interface for importing and exporting site-wide configurations. These settings can be applied either individually or with specified priorities.


	== Motivation ==		== Motivation ==

Rcollman: add template

2009-05-20T11:42:37Z

add template

← Older revision		Revision as of 11:42, 20 May 2009
Line 1:		Line 1:
			{{GSOC 09}}
	__TOC__		__TOC__

Cwaclawik: /* Needs Assesment */

2009-05-15T11:54:50Z

Needs Assesment

← Older revision		Revision as of 11:54, 15 May 2009
Line 13:		Line 13:
	*[https://docs.moodle.org/en/Development:Admin_settings How Admin settings work]		*[https://docs.moodle.org/en/Development:Admin_settings How Admin settings work]

	==~~Needs Assesment~~==		==User Requested Features==
	This is a current list of features that have been suggested/requested. This is not the finalized list and will need a community review:		This is a current list of features that have been suggested/requested. This is not the finalized list and will need a community review:
	*Selection of settings to export (grouped in a tree format as displayed in the administrator panel)		*Selection of settings to export (grouped in a tree format as displayed in the administrator panel)

Cwaclawik at 17:41, 12 May 2009

2009-05-12T17:41:56Z

← Older revision		Revision as of 17:41, 12 May 2009
Line 9:		Line 9:
	*Tracker Issue MDL-18548		*Tracker Issue MDL-18548
	*[http://moodlegsoc2009.blogspot.com/ Project Blog]		*[http://moodlegsoc2009.blogspot.com/ Project Blog]

			== Related Documentation ==
			*[https://docs.moodle.org/en/Development:Admin_settings How Admin settings work]

	==Needs Assesment==		==Needs Assesment==

Cwaclawik at 03:49, 12 May 2009

2009-05-12T03:49:18Z

← Older revision		Revision as of 03:49, 12 May 2009
Line 8:		Line 8:
	*[http://moodle.org/mod/forum/discuss.php?d=118494#p528195 Forum discussion]		*[http://moodle.org/mod/forum/discuss.php?d=118494#p528195 Forum discussion]
	*Tracker Issue MDL-18548		*Tracker Issue MDL-18548
			*[http://moodlegsoc2009.blogspot.com/ Project Blog]

	==Needs Assesment==		==Needs Assesment==