University of Auckland logo

Stay informed

Receive updates on teaching and learning initiatives and events.

2. Links

Link text is text that links users to a new page or resource (internally or externally). A meaningful name tells people where they are going. Long-linked text that goes across lines does not always open properly and can be confusing. Links should be short and descriptive (written in a way that makes sense out of context and says exactly what the link is about or what the user is meant to do with it).

DO

Write descriptive links

Course schedule

New students

DON’T

Write vague links

Click here

https://www.auckland.ac.nz/en/students/newstudents.html

Fixing issues with UDOIT

Problem 1: Link has nondescript text

Meaning

The link is not appropriately named/doesn’t describe the content it is linked to. Links should clearly describe the content they are linking to e.g. ‘Class Timetable’ rather than ‘timetable.html’ or ‘click here’.

How to fix it

In UDOIT Advantage, click the Review button for more information. Replace the current link text in the text field or click the checkbox to remove the link, then click Save.

descriptive link text in UDOIT

A screenshot of UDOIT asking the user to enter new link text. The link text is currently set to click here, which is not descriptive.

Problem 2: Links should contain text

Meaning

The link is empty; it contains no text, only an image.

How to fix it

In UDOIT Advantage, click the Review button for more information. Add new link text to the UDOIT tool or alt text to links containing only images and click Save. This will provide a description for users of screen readers.

resolve links without text

A screenshot of UDOIT asking the user to enter new link text. The link text field is currently blank.

Problem 3: Adjacent links found

Meaning

The link is not appropriately named/doesn’t describe the content it is linked to. Links should clearly describe the content they are linking to e.g., ‘Class Timetable’ rather than ‘timetable.html’ or ‘click here’.

How to fix it

In UDOIT Advantage, click the Review button for more information. Replace the current link text in the text field or click the checkbox to remove the link, then click Save.

Adjacent links on words

Click on each word and remove the adjacent links.

Then, highlight all the text previously linked and create a single new link.

Highlight and relink

Highlight all the words to be linked and click the link icon in the rich text editor to assign a new link.

Getting it right in Canvas

When creating links, consider where they lead to, and label them accordingly. For example, write “Visit Student Services.” rather than “For Student Services, click here.”

Tips to avoid problems

  • Keep linked phrases short, 3-5 words.
  • Links should describe what they are linking to.
  • Links should be in contrasting colours to be mindful of learners with low vision or colour blindness.
  • Avoid linking headings.
  • Never use a URL for the link text—screen readers will read out the URL verbatim, e.g. www.canvas…

Page added 28/05/2024

Send us your feedback

What do you think about this page? Is there something missing? For enquiries unrelated to this content, please visit the Staff Service Centre

This form is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.