Introduction

This Brickfield Accessibility Checker for TinyMCE checks your content for accessibility problems while you write it in the Moodle text editor.

  • It lists what it finds.
  • It explains why each issue matters.
  • It fixes most issues for you.

The checker works anywhere you use the text editor in Moodle, for example in a course summary, a page, a label, an assignment description or a forum post.

Before You Start

The checker is available to teachers and other staff. If you cannot see its button in the editor, ask your Moodle site administrator whether the checker is turned on for your role, and whether it has been enabled.

The checker only reads the content in the editor. It changes nothing until you choose AND save a fix, and you can undo every fix.

Remember, in order to update your content:

  1. Open the checker.
  2. Engage with the fix solutions.
  3. Then save as you would with any other edit changes.

Open the Checker

You can open the checker in either of these ways:
  • Select the Brickfield Accessibility Checker button on the editor toolbar.
  • Open the Tools menu in the editor and choose Brickfield Accessibility Checker.
The Tiny editor modal opened with the top toolbar, and the checker button highlighted. Further editor content is showing below the toolbar also.
If the editor is narrow, the toolbar may not have room for every button. Select the button with three dots at the end of the toolbar to show the rest, or use the Tools menu.
The Tiny editor modal opened with the top toolbar Tools option selected, showing the Tools dropdown with Brickfield Accessibility Checker highlighted. Further editor content is showing below the toolbar also.

Read the Results

The checker opens a panel beside your content. At the top, the panel shows how many issues it found and how many of them it can fix.

Below that, the issues are grouped by type. Each group has:

  • a description of the issue
  • a help button that explains why the issue matters
  • an entry for each place the issue occurs, with a short extract of your content
  • View and Fix buttons for each entry
The checker panel beside a Moodle page, listing issues grouped by type, each with View and Fix buttons.

If the checker finds nothing, the panel says: Congratulations! No accessibility issues were found.

The checker panel showing that no accessibility issues were found.

Find an Issue in Your Content

Select View next to an issue. The editor scrolls to that part of your content and highlights it.
An image in the editor highlighted after View was selected for it in the checker panel.

Get Help With an Issue

Select the help button (a question mark) next to an issue type. A short explanation opens, saying what the issue is and why it matters. To close it, press Escape or select the help button again.

Fix Issues

Select Fix next to an issue. Depending on the issue, the checker does one of these things:
  • It fixes the issue straight away.
  • It asks you for something it cannot work out itself, such as a description of an image.
  • It asks you to confirm before it restructures your content.
  • It tells you what needs changing, in the case of issues only you can fix.
When a fix is applied, the Fix button changes to a short message saying what was done, and the issue is marked with a tick. If the same issue occurs more than once and its fix needs no input from you, the group also has a Fix all button. It fixes every occurrence at once.

Undo a Fix

Every fix goes into the editor’s undo history. To reverse the last fix, press Ctrl+Z (Cmd+Z on a Mac), or select Undo on the editor toolbar. After you undo a fix, run the checks again so that the panel matches your content.

Check Again After Changes

The list of issues does not update by itself. After you change your content, select the Re-check content button (a circular arrow) at the top of the panel to run the checks again.

Download the Results

Select Download CSV at the bottom of the panel to save the issues as a comma-separated values (CSV) file. It opens in a spreadsheet program such as Excel.

The file has one row for each issue, with these columns:

  • Check ID
  • Element Type
  • Issue Description
  • Element Text
  • HTML Snippet
  • Location
The downloaded checker results open in a spreadsheet, with one row for each issue. It shows the check ID, the HTML element type, the Issue description, the element text, and so on.

Close the Checker

To close the panel, select the close button (a cross) at the top of the panel, or select the checker button on the toolbar again. You can also press Escape while you are working in the panel.

Save Your Work

Fixes change the content in the editor, not the saved page. Save the page or form as usual when you have finished, or your changes are lost.