Note: You are currently viewing documentation for Moodle 3.11. Up-to-date documentation for the latest stable version of Moodle may be available here: Accessibility Toolkit.

Accessibility Toolkit: Difference between revisions

From MoodleDocs
No edit summary
Line 24: Line 24:
Once a course has been analysed, any ongoing updates or edits or additions within the course will also be analysed automatically, being triggered by Moodle's event observers / callbacks.
Once a course has been analysed, any ongoing updates or edits or additions within the course will also be analysed automatically, being triggered by Moodle's event observers / callbacks.


==Report pages==
==Report pages for the course==
The accessibility toolkit link to its reports is accessed via a course's Actions menu (Boost theme) or via the course administration block (Classic theme). It can also be accessed via the accessibility review block, if this has been added to the course.
The accessibility toolkit link to its reports is accessed via a course's Actions menu (Boost theme) or via the course administration block (Classic theme). It can also be accessed via the accessibility review block, if this has been added to the course.


Line 33: Line 33:
* Content types, showing error counts per type of content
* Content types, showing error counts per type of content
* Summary report, showing a summary of the other reports combined
* Summary report, showing a summary of the other reports combined
[[{{ns:file}}:SummaryReport.png|600px|none|Accessibility summary report]]
==Report pages for the site==
From Site Administration / Plugins tab / Admin Tools / Accessibility / Reports the administrator can access the site reports generated by the Accessibility toolkit.
The accessibility toolkit provides a number of reports, to display the detected accessibility errors:
* Error list with direct links, which makes it really easy to navigate to their location and fix them.
* Activity breakdown, showing pass ratios per activity
* Content types, showing error counts per type of content
* Summary report, showing a summary of the other reports combined
This is a global-site report, provided data is from the whole site, not for each course. If you need more specific information about a course, go to the course Accessibility toolkit.


[[{{ns:file}}:SummaryReport.png|600px|none|Accessibility summary report]]
[[{{ns:file}}:SummaryReport.png|600px|none|Accessibility summary report]]

Revision as of 10:28, 15 May 2021

New feature
in Moodle 3.11!

Accessibility toolkit in Moodle 3.11

About the Accessibility toolkit

The accessibility starter toolkit allows educators and administrators to assess the accessibility of their course content and to identify existing common accessibility issues.

You can also get a graphic display of types of error, and a report with an overview of all errors. In order to use it, first the site administrator has to register into Brickfield and then activate the plugin in the Moodle site

Registration

From the Site administration panel, Moodle admins will find the Accessibility Toolkit under Admin tools in the Plugins section. The accessibility toolkit pages all initially redirect to the registration page, which needs to be submitted with a set of keys, an API key and a secret key, which are generated for you, once you have registered on the Brickfield registration portal.

Accessibility registration page

Admin settings

The accessibility toolkit's main purpose is to process content accessibility analysis, and initially this is set to disabled to allow institutions to enable it when ready. This is done at Site administration / Plugins / Admin tools / Accessibility / Accessibility toolkit settings with the "Enable analysis requests" setting.

      • Needs Image ***

Teacher usage

In your course, add the Accessibility review block and click the "Submit for analysis" button. After some minutes, you’ll see the results of the analysis. Please note that the first time that you run the analysis is not immediate. You can also run the analysis from the Edit cog

It includes the automated analysis of these requested Moodle course against a set of common accessibility rules, checking the content inside all of Moodle’s core activities. The toolkit then generates reports of all detected accessibility errors, which can also be broken down by type of content or type of activity. This provides insights to educators and organisations on the overall accessibility of their courses and the areas that should be improved.

Once a course has been analysed, any ongoing updates or edits or additions within the course will also be analysed automatically, being triggered by Moodle's event observers / callbacks.

Report pages for the course

The accessibility toolkit link to its reports is accessed via a course's Actions menu (Boost theme) or via the course administration block (Classic theme). It can also be accessed via the accessibility review block, if this has been added to the course.

The accessibility toolkit provides a number of reports, to display the detected accessibility errors:

  • Error list with direct links, which makes it really easy to navigate to their location and fix them.
  • Activity breakdown, showing pass ratios per activity
  • Content types, showing error counts per type of content
  • Summary report, showing a summary of the other reports combined
Accessibility summary report

Report pages for the site

From Site Administration / Plugins tab / Admin Tools / Accessibility / Reports the administrator can access the site reports generated by the Accessibility toolkit.

The accessibility toolkit provides a number of reports, to display the detected accessibility errors:

  • Error list with direct links, which makes it really easy to navigate to their location and fix them.
  • Activity breakdown, showing pass ratios per activity
  • Content types, showing error counts per type of content
  • Summary report, showing a summary of the other reports combined

This is a global-site report, provided data is from the whole site, not for each course. If you need more specific information about a course, go to the course Accessibility toolkit.

Accessibility summary report

Course block

The accessibility review block can be added to a course to display useful information to the teacher, including:

  • A summary of the accessibility errors for the course categorized by type.
  • A heatmap which highlights the errors for each course element. You can activate or hide the heatmap by clicking on the eye.
  • A link to the accessibility toolkit which includes different reports and the error list with links to edit the mistakes
  • A link to download the accessibility toolkit summary report in a printable pdf format.

Note: Students cannot see this block as it is only for teachers.

Accessibility heatmap on course main page

Important Links

Registration Portal Brickfield registration portal

Brickfield partnership with Moodle Moodle News story - Brickfield Blog

Blog Post New Accessibility Checker Starter Toolkit in Moodle 3.11

Enterprise version Brickfield Accessibility Toolkit.