Form: Difference between revisions
m (New page: Moodle User Interface Guidelines > '''Form''' {{Work in progress|forumurl=http://moodle.org/mod/forum/discuss.php?d=126884|info=<br /><br...) |
(This page will not be migrated to new devdocs) |
||
(7 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
{{Template:WillNotMigrate}} | |||
[[ Moodle User Interface Guidelines|Moodle User Interface Guidelines]] > '''Form''' | [[ Moodle User Interface Guidelines|Moodle User Interface Guidelines]] > '''Form''' | ||
{{Work in progress|forumurl=http://moodle.org/mod/forum/discuss.php?d=126884|info=<br /><br />'''This is a guideline template for a [[Moodle_User_Interface_Guidelines|Moodle Interface Guideline]]. Comments: [http://moodle.org/mod/forum/discuss.php?d=126884 developer forum thread] | {{Work in progress|forumurl=http://moodle.org/mod/forum/discuss.php?d=126884|info=<br /><br />'''Status: INCOMPLETE'''<br />This is a guideline template for a [[Moodle_User_Interface_Guidelines|Moodle Interface Guideline]]. Comments: [http://moodle.org/mod/forum/discuss.php?d=126884 developer forum thread]}} | ||
== Problem == | |||
You want to allow users to enter information into the application. | |||
== Forces: factors that affect selection == | |||
* There may not be much space. Forms elements are typically verbose and forms require at least a submit button. | |||
== Solution == | |||
Moodle uses progressive disclosure to hide form items that are suspected to be needed a minority of users. | |||
On simple forms, (less than one page / four elements or less) autofocus the first field of the form on body onload | |||
* IF none of the fields have any changed content in them (i.e. if the user is not returning to the page from browser history, see: [http://tracker.moodle.org/browse/MDL-825 MDL-825]) | |||
Date selection: use javascript selector (how about time?) | |||
* Show the more important settings at the top | |||
* Each entry should have a label, and if necessary, a help file | |||
* If there are more than 10 options, split them into required and optional/extra/advanced parameters | |||
== Common mistakes == | |||
Autofocusing a field by default is an accessibility issue, see MDL-20410 | |||
== Examples and implementation == | |||
=== Site configuration forms === | |||
=== Module configuration forms ("Update this Forum")=== | |||
== Related guidelines == | |||
* [[Radio button|Radio button]] | |||
* [[Checkbox|Checkbox]] | |||
* [[Dropdown Lists|Dropdown lists]] (incomplete) | |||
== Related issues in the tracker == | |||
* TODO: Configuration defaults http://moodle.org/mod/forum/discuss.php?d=124533 | |||
* TODO: Inconsistency with buttons in each module configuration: save and return to course / save and display / cancel. Are there really use cases to support having this choice each time? | |||
== Further information / Sources == | |||
* http://moodle.org/mod/forum/discuss.php?d=122545#p554845 | |||
[[Category:Moodle User Interface Guidelines]] |
Latest revision as of 14:26, 27 May 2022
Warning: This page is no longer in use. The information contained on the page should NOT be seen as relevant or reliable. |
Moodle User Interface Guidelines > Form
Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.
Status: INCOMPLETE
This is a guideline template for a Moodle Interface Guideline. Comments: developer forum thread
Problem
You want to allow users to enter information into the application.
Forces: factors that affect selection
- There may not be much space. Forms elements are typically verbose and forms require at least a submit button.
Solution
Moodle uses progressive disclosure to hide form items that are suspected to be needed a minority of users.
On simple forms, (less than one page / four elements or less) autofocus the first field of the form on body onload
- IF none of the fields have any changed content in them (i.e. if the user is not returning to the page from browser history, see: [https://tracker.moodle.org/browse/MDL-825 MDL-825])
Date selection: use javascript selector (how about time?)
- Show the more important settings at the top
- Each entry should have a label, and if necessary, a help file
- If there are more than 10 options, split them into required and optional/extra/advanced parameters
Common mistakes
Autofocusing a field by default is an accessibility issue, see MDL-20410
Examples and implementation
Site configuration forms
Module configuration forms ("Update this Forum")
Related guidelines
- Radio button
- Checkbox
- Dropdown lists (incomplete)
Related issues in the tracker
- TODO: Configuration defaults http://moodle.org/mod/forum/discuss.php?d=124533
- TODO: Inconsistency with buttons in each module configuration: save and return to course / save and display / cancel. Are there really use cases to support having this choice each time?