Accessibility notes - Revision history

Damyon: Consolidating accessibility documentation

2019-05-24T04:53:37Z

Consolidating accessibility documentation

Tsala: obsolete template

2016-01-20T07:35:40Z

obsolete template

← Older revision		Revision as of 07:35, 20 January 2016
Line 1:		Line 1:
	~~<p class="note">~~		{{obsolete}}
	These notes give an overview of what accessibility work has been done from Moodle 1.6 onwards, what is left to do, and what guidelines, techniques and coding patterns are being used. Initially based on a workshop at [http://moodlemoot.ca Moodlemoot 2007, Canada]		''These notes give an overview of what accessibility work has been done from Moodle 1.6 onwards, what is left to do, and what guidelines, techniques and coding patterns are being used. Initially based on a workshop at [http://moodlemoot.ca Moodlemoot 2007, Canada] Lots for me to add/edit! Comments welcome! [[User:Nick Freear\|Nick Freear]]''
	Lots for me to add/edit! Comments welcome! [[User:Nick Freear\|Nick Freear]]
	~~</p>~~


	== Guidelines ==		== Guidelines ==

Deraadt: /* See also */

2011-06-07T07:04:29Z

Nfreear: /* Moodle 1.6 */, Moodle forum link

2009-10-06T16:40:34Z

Moodle 1.6: , Moodle forum link

← Older revision		Revision as of 16:40, 6 October 2009
Line 108:		Line 108:
	Released: 19th June 2006		Released: 19th June 2006

	Moodle 1.6 is the first release to which the Open University contributed development resources. An accessibility proposal from Open University identified problems and some solutions. Note, due to time constraints we did not evaluate or modify modules, the content of most side blocks and so on - most changes were to core.		Moodle 1.6 is the first release to which the Open University contributed development resources. An [http://moodle.org/mod/forum/discuss.php?d=40484 accessibility proposal from Open University] identified problems and some solutions. Note, due to time constraints we did not evaluate or modify modules, the content of most side blocks and so on - most changes were to core.

	* ALT text: fixed for side-blocks, some themes, and in core.		* ALT text: fixed for side-blocks, some themes, and in core.
Line 118:		Line 118:
	* Calendar style: improved colour contrast in standard theme for calendar/event backgrounds, links, weekend colours.		* Calendar style: improved colour contrast in standard theme for calendar/event backgrounds, links, weekend colours.
	* Weekscss course format: new format plug-in that does ''not'' use layout tables, based on the 'weeks' course format.		* Weekscss course format: new format plug-in that does ''not'' use layout tables, based on the 'weeks' course format.


	=== Moodle 1.5 ===		=== Moodle 1.5 ===

Tsala: catdev template

2009-03-12T12:05:22Z

catdev template

← Older revision		Revision as of 12:05, 12 March 2009
Line 310:		Line 310:


			{{CategoryDeveloper}}
	[[Category:Accessibility]]		[[Category:Accessibility]]

Nfreear: Re-ordered, new summary, etc.

2008-07-14T11:45:29Z

Re-ordered, new summary, etc.

← Older revision		Revision as of 11:45, 14 July 2008
Line 1:		Line 1:
	<p class="note">These ~~are DRAFT~~ notes on what ~~CSS classes, PHP functions and the so on have~~ been ~~added to~~ Moodle 1.6 onwards to ~~aid accessibility. They can be seen as design patterns, techniques~~, guidelines, and ~~perhaps best practice(?)~~		<p class="note">
			These notes give an overview of what accessibility work has been done from Moodle 1.6 onwards, what is left to do, and what guidelines, techniques and coding patterns are being used. Initially based on a workshop at [http://moodlemoot.ca Moodlemoot 2007, Canada]
	~~Based~~ on a workshop at [http://moodlemoot.ca Moodlemoot 2007, Canada]		Lots for me to add/edit! Comments welcome! [[User:Nick Freear\|Nick Freear]]
	Lots for me to add/edit! Comments welcome!
	[[User:Nick Freear\|Nick Freear]] ~~11:38, 28 August 2007 (CDT)~~
	</p>		</p>

Line 38:		Line 36:


	== ~~Fix and test~~ ==		== Roadmap ==
			The issues remaining (todo list), for Moodle 2.0 and beyond.
	~~; Formal user testing :~~ The ~~most valuable and time-consuming.~~
	~~; Informal user feedback : .~~
	~~; Expert evaluation : .~~
	~~; Developer evaluation : .~~

	~~A desirable process:~~
	~~# Test~~
	~~# Identify~~
	~~# Specify/ report~~
	~~# Discuss/ clarify~~
	~~# Implement solution~~
	~~# Re-test~~
	~~# '''Iterate ...'''~~


	~~== Issues~~ remaining ==
	A todo list~~/ roadmap~~, for Moodle 2.0?

	* 'onchange' popup menus: not keyboard accessible.		* 'onchange' popup menus: not keyboard accessible.
Line 85:		Line 66:
	* '''Blacklist''' (tick): fontname, font-size, underline, left align, center align, right align, justify, direction left to right, direction right to left, reduce indent, increase indent, text colour, background colour, horizontal rule, insert table, insert emoticon, (spell check, new window), enlarge editor (new window).		* '''Blacklist''' (tick): fontname, font-size, underline, left align, center align, right align, justify, direction left to right, direction right to left, reduce indent, increase indent, text colour, background colour, horizontal rule, insert table, insert emoticon, (spell check, new window), enlarge editor (new window).

	== ~~Issues fixed~~ ==
	Note, some of the headline items here could be added to the release notes.		== Releases ==
			Accessibility issues fixed by Moodle release, with links to the Moodle bug tracker. Note, some of the headline items here could be added to the release notes.
	See also [[Release Notes]] \| [[Old releases]] \| [[Roadmap]].		See also [[Release Notes]] \| [[Old releases]] \| [[Roadmap]].


	=== Moodle 1.9 ~~Beta 2~~ ===		=== Moodle 1.9 ===
	Released: circa 22 October 2007		Released: Beta 2, circa 22 October 2007

	Meta-bug, MDL-12298 (14 sub-tasks, 7 dependencies).		Meta-bug, MDL-12298 (14 sub-tasks, 7 dependencies).
Line 126:		Line 108:
	Released: 19th June 2006		Released: 19th June 2006

	~~Accessibility~~ proposal from Open University identified problems and some solutions. Note, due to time constraints we did not evaluate or modify modules, the content of most side blocks and so on - most changes were to core.		Moodle 1.6 is the first release to which the Open University contributed development resources. An accessibility proposal from Open University identified problems and some solutions. Note, due to time constraints we did not evaluate or modify modules, the content of most side blocks and so on - most changes were to core.

	* ALT text: fixed for side-blocks, some themes, and in core.		* ALT text: fixed for side-blocks, some themes, and in core.
	* Standard theme & other 14 themes: removed layout table(s), <h1> ~~used~~ to ~~markup~~ headings (some to do).		* Standard theme & other 14 themes: removed layout table(s), added <h1> to mark-up headings (some to do).
	* Breadcrumb trail: marked up as a list, with a heading (hidden by default for visual user), and graphic for breadcrumb separator.		* Breadcrumb trail: marked up as a list, with a heading (hidden by default for visual user), and graphic for breadcrumb separator.
	* Side blocks: heading marked up as <h2>, added 'skip block' links (needs review).		* Side blocks: heading marked up as <h2>, added 'skip block' links (needs review).
	* Side blocks: removed nested layout tables, started using list markup (activity modules, admin, course list, participants, main menu, social activities - list render in print_side_block; online users).		* Side blocks: removed nested layout tables, started using list markup (activity modules, admin, course list, participants, main menu, social activities - list render in print_side_block; online users).
	* Calendar: fixed data table headers, summary, abbreviations, non-visual indication of 'today', next/previous links.		* Calendar: fixed data table headers, summary, abbreviations, non-visual indication of 'today', next/previous links.
	* Calendar style: improved colour contrast in standard theme for event backgrounds, links, weekend colours.		* Calendar style: improved colour contrast in standard theme for calendar/event backgrounds, links, weekend colours.
	* Weekscss course format: new format plug-in that does ''not'' use layout tables, based on the 'weeks' course format.		* Weekscss course format: new format plug-in that does ''not'' use layout tables, based on the 'weeks' course format.

Line 141:		Line 123:
	Released: 5th June 2005		Released: 5th June 2005

	Work done for Moodle 1.5 is unknown.		Work done for Moodle 1.5 is unknown; the Open University was not involved with Moodle at this time.


			== Fix and test ==

			; Formal user testing : The most valuable and time-consuming.
			; Informal user feedback : .
			; Expert evaluation : .
			; Developer evaluation : .

			A desirable process (similar to the ''waterfall'' programming/design process):
			# Test
			# Identify
			# Specify/ report
			# Discuss/ clarify
			# Implement solution
			# Re-test
			# '''Iterate ...'''


Line 174:		Line 172:
	[Too much accessibility]		[Too much accessibility]

	Below are examples of what the JAWS for Windows 7 screen reader verbalises for good and bad markup (HTML).		(Below are examples of what the JAWS for Windows 7 screen reader verbalises for good and bad markup (HTML).)


Line 182:		Line 180:


	== ~~Accessibility design~~ patterns ==		== Design patterns ==
			This section documents some specific, re-usable coding techniques that improve the accessibility of Moodle. They include server-side (PHP) and client side (XHTML, CSS styles) code samples, and links to specific parts of the [[#Guidelines\|Web Content Accessibility Guidelines]].

	[Problem, Context, Principle, Solution, Why, Examples]		[Problem, Context, Principle, Solution, Why, Examples]
Line 257:		Line 256:
	=== Pattern 3: left, right arrows ===		=== Pattern 3: left, right arrows ===

	PHP variables holding 'silent' representations of right and left arrows (example ► <code>&#x25BA;</code>), to avoid misuse of characters including "greater than" >, "right angle quote" ». The variables are initialised by the function weblib.php: check_theme_arrows, unless they have first been defined in the theme config.php.		PHP variables holding 'silent' (that is, not spoken by assistive technologies including screen readers) representations of right and left arrows (example ► <code>&#x25BA;</code>), to avoid misuse of characters including "greater than" >, "right angle quote" ». The variables are initialised by the function weblib.php: check_theme_arrows, unless they have first been defined in the theme config.php.

	* Difficulty: medium. Careful with fonts.<br />		* Difficulty: medium. Careful with fonts.<br />
Line 302:		Line 301:
	* Examples:		* Examples:


			* Also: Weekscss course format, Moodleforms, img-text class .


			== See also ==
			* [[Accessibility]]
			* [[Moodle Accessibility Specification\|Accessibility Specification, Moodle 1.8]]


	* Also: Weekscss course format, Moodleforms, img-text class .

	[[Category:Accessibility]]		[[Category:Accessibility]]

Nfreear: /* Editor */, fix white/black lists.

2007-11-26T14:09:43Z

Editor: , fix white/black lists.

← Older revision		Revision as of 14:09, 26 November 2007
Line 82:		Line 82:
	- TODO: draft status.		- TODO: draft status.

	* '''Whitelist''' (untick): Word format filter (tick), format, bold, italic, strikethrough, subscript, superscript, copy?, cut, paste, Word filter, undo, redo, number list, bullet list, anchor, link, remove link?, image, character ~~palette~~, show HTML, R?, (language not configurable).		* '''Whitelist''' (untick): Word format filter (tick), format, bold, italic, strikethrough, subscript, superscript, copy, cut, paste, Word filter, undo, redo, number list, bullet list, anchor, insert link, remove link, insert image, special character (new window), show HTML, search-replace (new window), (language not configurable), (heading/normal not configurable).
	* '''Blacklist''' (tick): fontname, font-size, underline, left align, center align, right align, justify, ?P, ?P, reduce indent, increase indent, text colour, background colour?, horizontal ~~line~~, table, emoticon, (spell check?), new window.		* '''Blacklist''' (tick): fontname, font-size, underline, left align, center align, right align, justify, direction left to right, direction right to left, reduce indent, increase indent, text colour, background colour, horizontal rule, insert table, insert emoticon, (spell check, new window), enlarge editor (new window).

	== Issues fixed ==		== Issues fixed ==

Nfreear: /* Moodle 1.9 Beta 2 */

2007-11-22T07:42:22Z

Moodle 1.9 Beta 2

← Older revision		Revision as of 07:42, 22 November 2007
Line 91:		Line 91:

	=== Moodle 1.9 Beta 2 ===		=== Moodle 1.9 Beta 2 ===
	Released: circa 22 October 2007		Released: circa 22 October 2007

			Meta-bug, MDL-12298 (14 sub-tasks, 7 dependencies).

	* QuickForm fixes: MDL-8627, MDL-11134.		* QuickForm fixes: MDL-8627, MDL-11134.
	* Skip block/ skip to content bug fixes, and extended to site home page, course index, as well as course pages~~, MDL-7878, MDL-11675, MDL-11695~~.		* Skip block/ skip to content bug fixes, and extended to site home page, course index, as well as course pages (3 bugs).
	* Side block lists, MDL-6548: TODO.		* Side block lists, MDL-6548: TODO.
	* English language help files: completed MDL-9890.		* English language help files: completed MDL-9890.

Nfreear: /* Editor */

2007-11-22T07:36:55Z

Editor

← Older revision		Revision as of 07:36, 22 November 2007
Line 76:		Line 76:
	=== Editor ===		=== Editor ===

	The rich-text/HTML editor used in Moodle is currently based on HTMLArea. There are many accessibility issues, and we hope it will be replaced soon - ~~TinyMCE is a~~ [http://www.standards-schmandards.com/2006/wysiwyg-editor-test ~~strong~~ open-source ~~contender~~], [http://themaninblue.com/experiment/widgEditor WidgEditor] would be a very simple starting point, or there are [http://456bereastreet.com/archive/200612/forget_wysiwyg_editors_use_wysiwym_instead what you see is what you mean] (WYSIWYM) editors. We are concerned with the ease ~~of use~~ of use of the interface, and ~~the~~ accessibility of the content and markup produced - see [[#Guidelines]].		The rich-text/HTML editor used in Moodle is currently based on HTMLArea. There are many accessibility issues, and we hope it will be replaced soon - there are[http://www.standards-schmandards.com/2006/wysiwyg-editor-test good open-source contenders] including TinyMCE, [http://themaninblue.com/experiment/widgEditor WidgEditor] would be a very simple starting point, or there are [http://456bereastreet.com/archive/200612/forget_wysiwyg_editors_use_wysiwym_instead what you see is what you mean] (WYSIWYM) editors. We are concerned with the ease of use of the interface, AND the validity and accessibility of the content and markup produced
			- see [[#Guidelines\|Guidelines]] section.

	In the meantime, the current editor can be configured by system ~~administrators~~ (go to, Site administration - Appearance - HTML editor). Below are lists of the options it would be sensible to enable and disable (starting from the Open University's configuration)		In the meantime, the current editor can be configured by the system administrator (go to, Site administration - Appearance - HTML editor). Below are lists of the options it would be sensible to enable and disable (starting from the Open University's configuration)
	- TODO: ~~edit.~~		- TODO: draft status.

	* '''Whitelist''' (untick): Word format filter (tick), format, bold, italic, strikethrough, subscript, superscript, copy?, cut, paste, Word filter, undo, redo, number list, bullet list, anchor, link, remove link?, image, character palette, show HTML, R?, (lang n/a).
	* '''Blacklist''' (tick): fontname, font-size, underline, left align, center align, right align, justify, ?P, ?P, reduce indent, increase indent, text colour, background colour?, horizontal line, table, emoticon, (spell check), new window.

			* '''Whitelist''' (untick): Word format filter (tick), format, bold, italic, strikethrough, subscript, superscript, copy?, cut, paste, Word filter, undo, redo, number list, bullet list, anchor, link, remove link?, image, character palette, show HTML, R?, (language not configurable).
			* '''Blacklist''' (tick): fontname, font-size, underline, left align, center align, right align, justify, ?P, ?P, reduce indent, increase indent, text colour, background colour?, horizontal line, table, emoticon, (spell check?), new window.

	== Issues fixed ==		== Issues fixed ==

Nfreear: Use new Moodle tracker filter!

2007-11-22T07:25:56Z

Use new Moodle tracker filter!

← Older revision		Revision as of 07:25, 22 November 2007
Line 14:		Line 14:
	* The [http://w3.org/TR/aria-roadmap Accessible Rich Internet Applications] draft standards (ARIA roadmap September 2006) are useful to ensure that scripting and asynchronous events (AJAX) work with assistive technologies. They supplement HTML with additional semantics: role, state and properties.		* The [http://w3.org/TR/aria-roadmap Accessible Rich Internet Applications] draft standards (ARIA roadmap September 2006) are useful to ensure that scripting and asynchronous events (AJAX) work with assistive technologies. They supplement HTML with additional semantics: role, state and properties.
	* Moodle and components like the rich-text editor are subject to other guidelines including the [http://w3.org/TR/ATAG10 Authoring Tool Accessibility Guidelines 1.0], see [http://w3.org/WAI/guid-tech.html this overview].		* Moodle and components like the rich-text editor are subject to other guidelines including the [http://w3.org/TR/ATAG10 Authoring Tool Accessibility Guidelines 1.0], see [http://w3.org/WAI/guid-tech.html this overview].


	=== Web Content Accessibility Guidelines 1.0 ===		=== Web Content Accessibility Guidelines 1.0 ===

	* WCAG 1.0 contains 14 guidelines (see below), sub-divided into 65 checkpoints numbered 1.1 to 14.3.		* WCAG 1.0 contains 14 guidelines (see below), sub-divided into 65 checkpoints numbered 1.1 to 14.3.
	* The checkpoints are organised into 3 priority levels, 1 (A) ''must'', 2 (double-A) ''should'', 3 (triple-A) ''may'' - Moodle should aim for level 2 and some of level 3.		* The checkpoints are organised into 3 priority levels, 1 (A) ''must'', 2 (double-A) ''should'', 3 (triple-A) ''may'' - Moodle should aim for level 2 and some of level 3.


	# Provide equivalent alternatives to auditory and visual content.		# Provide equivalent alternatives to auditory and visual content.
Line 33:		Line 36:
	# Provide clear navigation mechanisms.		# Provide clear navigation mechanisms.
	# Ensure that documents are clear and simple.		# Ensure that documents are clear and simple.


	== Fix and test ==		== Fix and test ==
Line 49:		Line 53:
	# Re-test		# Re-test
	# '''Iterate ...'''		# '''Iterate ...'''


	== Issues remaining ==		== Issues remaining ==
Line 59:		Line 64:
	* Old Forms: use QuickForms OR add label markup - pragmatic approach.		* Old Forms: use QuickForms OR add label markup - pragmatic approach.
	* QuickForm fixes: review, complete.		* QuickForm fixes: review, complete.
	* Course formats: replace layout tables, as per 'weekscss' ~~[http://tracker.moodle.org/browse/~~MDL-9306 ~~MDL-9306]~~.		* Course formats: replace layout tables, as per 'weekscss', MDL-9306.
	* Layout tables: remove remaining.		* Layout tables: remove remaining.
	* Review USER->screenreader flag use.		* Review USER->screenreader flag use.
Line 78:		Line 83:
	* '''Whitelist''' (untick): Word format filter (tick), format, bold, italic, strikethrough, subscript, superscript, copy?, cut, paste, Word filter, undo, redo, number list, bullet list, anchor, link, remove link?, image, character palette, show HTML, R?, (lang n/a).		* '''Whitelist''' (untick): Word format filter (tick), format, bold, italic, strikethrough, subscript, superscript, copy?, cut, paste, Word filter, undo, redo, number list, bullet list, anchor, link, remove link?, image, character palette, show HTML, R?, (lang n/a).
	* '''Blacklist''' (tick): fontname, font-size, underline, left align, center align, right align, justify, ?P, ?P, reduce indent, increase indent, text colour, background colour?, horizontal line, table, emoticon, (spell check), new window.		* '''Blacklist''' (tick): fontname, font-size, underline, left align, center align, right align, justify, ?P, ?P, reduce indent, increase indent, text colour, background colour?, horizontal line, table, emoticon, (spell check), new window.


	== Issues fixed ==		== Issues fixed ==
Line 87:		Line 93:
	Released: circa 22 October 2007		Released: circa 22 October 2007

	* QuickForm fixes: ~~[http://tracker.moodle.org/browse/~~MDL-8627 ~~MDL-8627]~~, MDL-11134.		* QuickForm fixes: MDL-8627, MDL-11134.
	* Skip block/ skip to content bug fixes, and extended to site home page, course index, as well as course pages ~~[http://tracker.moodle.org/browse/MDL-7878~~ MDL-7878], MDL-11675, MDL-11695.		* Skip block/ skip to content bug fixes, and extended to site home page, course index, as well as course pages, MDL-7878, MDL-11675, MDL-11695.
	* Side block lists, MDL-6548: TODO.		* Side block lists, MDL-6548: TODO.
	* English language help files: completed MDL-9890.		* English language help files: completed MDL-9890.
Line 97:		Line 103:

	Following more expert evaluation, the Open University put together a comprehensive [[Moodle Accessibility Specification\|Specification]] listing what needed fixing in parts of core Moodle and modules.		Following more expert evaluation, the Open University put together a comprehensive [[Moodle Accessibility Specification\|Specification]] listing what needed fixing in parts of core Moodle and modules.
	Moodle.com undertook what were judged to be high priority items from this list - see meta-bug ~~[http://tracker.moodle.org/browse/MDL-7396~~ MDL-7396] (45 sub-tasks, 3 dependencies). There was also funding from Italy - see ~~[http://tracker.moodle.org/browse/MDL-7860~~ MDL-7860] (26 sub-tasks). Here is an (incomplete) summary:		Moodle.com undertook what were judged to be high priority items from this list - see meta-bug MDL-7396 (45 sub-tasks, 3 dependencies). There was also funding from Italy - see MDL-7860 (26 sub-tasks). Here is an (incomplete) summary:

	* Forms: QuickForms adopted for many - consistent rendering: labels, fieldset/legend, tableless.		* Forms: QuickForms adopted for many - consistent rendering: labels, fieldset/legend, tableless.
Line 104:		Line 110:
	* Tabs: replaced table with list.		* Tabs: replaced table with list.
	* ...		* ...
	* Side block lists ~~[http://tracker.moodle.org/browse/~~MDL-6548 ~~MDL-6548]~~: blog tags (inline), messages, news items, section links (inline).		* Side block lists, MDL-6548: blog tags (inline), messages, news items, section links (inline).
	* English help files: ~~[http://tracker.moodle.org/browse/MDL-9890~~ MDL-9890], Help should be well-formed...		* English help files: MDL-9890, Help should be well-formed...

	=== Moodle 1.7 ===		=== Moodle 1.7 ===
Line 112:		Line 118:
	* '''Consolidation'''		* '''Consolidation'''
	* Breadcrumb and left/right-arrow icons fixed: replaced with 'silent' Unicode arrow characters.		* Breadcrumb and left/right-arrow icons fixed: replaced with 'silent' Unicode arrow characters.
	* Side block lists, ~~[http://tracker.moodle.org/browse/~~MDL-6548 ~~MDL-6548]~~: admin bookmarks, (mnet hosts), rss client.		* Side block lists, MDL-6548: admin bookmarks, (mnet hosts), rss client.


Line 132:		Line 138:
	=== Moodle 1.5 ===		=== Moodle 1.5 ===
	Released: 5th June 2005		Released: 5th June 2005

			Work done for Moodle 1.5 is unknown.



	== Assistive technology ==		== Assistive technology ==
Line 168:		Line 178:

	JAWS and other screen readers have a ''forms mode'' to allow the user to input text in forms in a Web browser.		JAWS and other screen readers have a ''forms mode'' to allow the user to input text in forms in a Web browser.


	== Accessibility design patterns ==		== Accessibility design patterns ==

← Older revision		Revision as of 07:04, 7 June 2011
Line 308:		Line 308:
	* [[Moodle Accessibility Specification\|Accessibility Specification, Moodle 1.8]]		* [[Moodle Accessibility Specification\|Accessibility Specification, Moodle 1.8]]


	~~{{CategoryDeveloper}}~~
	[[Category:Accessibility]]		[[Category:Accessibility]]