Brickfield Education Labs

Table of Contents

Introduction

The Fix image alt text wizard provides you with “image alt text” errors for the course, or courses and allows you to submit a suitable image (alt) description for each image to help fix them quickly.

 

Image Alt Text is the non-visual text alternative for an image so it can be perceived and understood by those who cannot see it or understand it. Provide a brief description of the meaning and context of an image. It should be concise, relevant, meaningful, and no longer than required.

 

N.B.: In the top right of the Fix image alt text wizard is a “Help docs” button that will bring your directly to this documentation page.

Impact of having no or bad Alt Text

If an image alt is not descriptive enough, such as using the image file name, users of screen readers or users with images blocked cannot determine the image’s content and importance.

Editor's Note

The image alt changes need a degree of user oversight / engagement, hence they need to be manually typed into each image’s “Update to” input field, as plain text, which will then be used to update the image’s alt text in its content location. There is also a help popup, with guidance on how to write good image alt descriptions, located below the text input area.

Where to find the Fix image alt text wizard

The Fix image alt text wizard can be accessed via:

  • From Site administration: Site administration > Brickfield Enable > Accessibility management > Go to wizards > Fix > Image alt
  • From a course: Course actions menu > More > Brickfield Accessibility+ Toolkit > Fix > Image alt
  • From the course block: Accessibility+ Review block > View Accessibility+ Report (Chart icon) > Fix > Image alt
  • From the Check list report: The “Fix” link that’s available for the following checks:
    • “Image alt (alternative) text should not be the image filename”
    • “Image alt (alternative) text should not be more than the maximum recommended (125) characters”.

How to use the Fix image alt text wizard

The Fix image alt text wizard displays a page which includes a table where each row is one of the images found that has unsuitable or no Alt Text.

 

The Fix image alt text wizard provides the ability to:

  • Submit alt text updates for images in bulk.
  • Make an exception by hiding an individual error.
The fix image alt text wizard displaying the page heading, number of reviewed courses, help docs button, number of errors, and the image alt text errors table. The image alt text errors table has 4 columns: details, existing, update to, and hide.

The heading area of the wizard will show how many errors are found, and whether the errors listed are for one course or many courses.

  • If the results are for one course, the course name is displayed.
  • If the results are for more than one course, the number of courses is displayed.

 

The table displays a row for each error that contains four parts:

  • Details
    • Course Name.
    • Course Section.
    • Activity name.
    • The link to Edit the content.
  • Existing context
    • Existing content.
    • The button to view the error in its full context.
  • Image description (alt text)
    • Existing alt text.
    • The Update to box to add new Alt Text.
    • The checkbox to mark the image as decorative.
  • Hide – The checkbox to hide the error when submitted.

Submit updates for bulk fixing

When updates to the Alt Text for errors are submitted for bulk fixing, it will only process the errors on the current page. All fixed errors are temporarily logged and can be reverted if needed in the Bulk fix log. 

 

To submit updates to the errors for bulk fixing:

  1. Ensure you are viewing the Fix image alt text wizard.
  2. Write the new Alt Text into the Update To box.
    1. If you need guidance on composing the alt text check the help icons
    2. Remember to spell check your Alt text otherwise the screen reader will mispronounce it.
    3. Do not add alt text if the image is decorative only, tick the “mark this image as decorative” checkbox instead.
  3. If you want to hide this error, select the “Hide” checkbox.
  4. Select the “Submit Bulk fixing” button to submit all the updates at once.

 

All hidden errors are located in the Hidden errors page.

Capability requirements

Access to the Brickfield Accessibility+ Toolkit is controlled by capabilities and users must have the correct capabilities in the correct context.

  • ‘tool/bfplus:viewsystemtools’ capability – To view site level reports and wizards.
  • ‘tool/bfplus:viewcoursetools’ capability – To view individual course reports and wizard.
  • ‘accessibilityplustool/fiximgalt:view’ capability – To view this Fix image alt text wizard, users must have this and one of the capabilities mentioned above.

 

For more information, go to: Capabilities.