Brickfield Education Labs

Table of Contents

Introduction

The Fix link text wizard provides you with “link text” errors for the course, or courses and suggests alternatives, based on the retrieved title of the URL to help fix them quickly, but this can also be customised.

 

Links should be descriptive of the content they’re linking to, such as “Project Jude guidelines” rather than “guidelines.html” or “Click here”.

 

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

Impact of bad link text

If a link is not descriptive enough, users of screenreaders cannot determine the destination’s content and importance, in advance of actually visiting it and spending that time loading and then evaluating the new content. Even sighted users are slowed by poor link text, needing to stop and read surrounding text again to determine the link destination.

Editor's Note

The link text changes need a degree of teacher oversight / engagement. However, we do automated retrieval of the website’s own title, and provide it as a suggested text in the “Suggested updated link text” input field. Hence the teacher needs to review and edit each link’s “Suggested updated link text” input field, as plain text, which will then be used to update the link text in its content location.

Where to find the Fix link text wizard

The Fix link text wizard can be accessed via:

  • From Site administration: Site administration > Brickfield Enable > Accessibility management > Go to wizards > Fix > Link text
  • From a course: Course actions menu > More > Brickfield Accessibility+ Toolkit > Fix > Link text
  • From the course block: Accessibility+ Review block > View Accessibility+ Report (Chart icon) > Fix > Link text.
  • From the Check list report: The “Fix” link that’s available for the “Link text should be descriptive and provide context about its destination” check.

How to use the Fix link text wizard

The Fix link text wizard displays a page which includes a table where each row is one of the links found that has unsuitable link text.

 

The Fix link text wizard provides the ability to:

  • Submit link text updates for links in bulk.
  • Make an exception by hiding an individual error.
The fix link text wizard displaying the page heading, number of reviewed courses, help docs button, number of errors, and the link text errors table. The link 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.
    • Link text
  • Existing link text.
    • Existing link URL.
    • Suggested updated link text.
  • Hide – The checkbox to hide the error when submitted.

Submit updates for bulk fixing

When updates to the link 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 link text wizard.
  2. Write the new link text into the Suggested updated link text box.
    1. Remember to spell check your link text otherwise the screen reader will mispronounce it.
  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 wizards.
  • ‘accessibilityplustool/fixlinktext:view’ capability – To view this Fix link text wizard, users must have this and one of the capabilities mentioned above.

 

For more information, go to: Capabilities.