Link Path Detection within the HTML Editor in MyLO

Overview

A new configuration has been enabled, which will display a warning to users who are creating or editing HTML content where the URLs to objects (such as, images, PDFs, or documents) within unit content do not reside within current unit offering.

How does the configuration variable work?

Users who edit HTML content may see an orange border surrounding objects with URLs that are not pointed to the current unit offerings Manage Files area. The warning appears as a tooltip when the item is clicked into that states that “This links to a file that exists outside of the current unit which means some users may see a broken link. Insert the content you need using a file in this unit or from your computer.” The item that was detected is surrounded by an orange border to highlight the area of concern on the page.

For example, let’s say you added an image within a quiz question in a unit offering whose unit offering path was ‘/content/UnitB’ but the URL/link path to the image in the quiz question pointed to ‘/content/UnitA/Image.jpg’. This means that the image in the quiz question does not belong to the course offering you are editing the quiz question in, and so the editor displays an orange border around the image and provide the warning tooltip with information.

It is likely that students taking the quiz would be unable to see the image.

Figure: An example of the file path URL detection showing an error.

How to resolve issues the configuration variable detects?

In the example above, the image should be deleted, and re-inserted into the quiz question using a file that exists within the current unit offering. This ensures that the object shown in the quiz question exists within the current unit offering and is visible to users taking the quiz. This also ensures that should you copy the quiz question to anotherunit offering, the image is also copied as expected and it displays as expected.

What is not detected by the configuration variable?

When enabled, this does not detect external URLs that are invalid or not working. This includes external URLs and quicklinks where the link may generate a 404 error.

This, in conjunction with MyLO Mate's Check Links feature should assist teaching staff to ensure that all content is viewable within their unit.