Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
title Click here to expand...
  1. What is Link Checker?
    1.1 Link Checker is a utility tool designed to validate and manage web links within educational platforms, focusing on LEARN and CMS courses.

    1.2. The tool performs extensive link validation, checking the validity of internal and external web page links, documents, embedded media, and links within document files (e.g., .pdf, .docx)

    1.3. Users can generate detailed reports with selectable filters, providing insights into the correctness of links, categorizing them as internal or external, and differentiating between pages, URLs, and rules.

  2. Are there any restrictions on the types of links that can be verified? 
    2.1 Yes, Link Checker is specifically designed to verify links within Learn and CMS   courses. It focuses on testing the validity of links within these educational platforms and does not extend its verification capabilities to links outside this scope.  Link Checker provides a flexible approach to link validation, allowing users to customize the verification process based on specific preferences. In this context, the tool is designed to focus exclusively on links within Learn and CMS courses; it does not extend its verification capabilities to include other links outside this scope. This ensures a targeted and efficient validation process, tailored to the educational context.

  3. How do I initiate a search using Link Checker?

    3.1To 1 To begin a search in Link Checker, you can navigate to the designated search interface and input the relevant criteria, such as the course or webpage you want to analyze. Once entered, the tool will execute the search based on the specified parameters. For more specific and detailed usage , here is the guide: https://uwaterloo.atlassian.net/wiki/pages/resumedraft.action?draftId=43774738566&draftShareId=649c4172-671e-4d78-8b54-b70e1fd790de

  1. What LEARN permission are required to run a search on a LEARN Course?

    4.1 The user WatIAM logged into the Link Checker application must have one of the following LEARN roles in the course: ‘Instructor', 'Course Editor', 'TA Level 4', 'Administrator', 'Course Manager', 'Staff / Librarian’

  1. How can I view and manage search results?

4
  1. 5.1 The tool conveniently displays all searches initiated by the current user, providing a comprehensive overview of your search history

4
  1. 5.2 For each search conducted, the system presents general information, offering insights into the parameters and criteria used in the search.

4
  1. 5.

3The
  1. 3 The interface provides practical options for each search, giving you the ability to take specific actions. You can view a detailed report to gain in-depth insights, restart a search to update or refine parameters, or delete a search if it's no longer needed.

4
  1. 5.4 Link Checker offers a valuable export feature, allowing you to extract pages into a CSV file. This export capability is particularly handy when you wish to analyze or share specific search results. You can apply filters, such as selecting pages based on correctness, internal or external links, and export the relevant data in a convenient CSV format.

 Is other functionality possible?


What Links can be verified using Link Checker?

Expand
title Click here to expand...
  1. What Links can be verified using Link Checker?
    1.1 Currently, only Learn and CMS Contensis Links can be verified using Link Checker

  2. What is a Learn link?
    2.1 LEARN, commonly referred to as the Learning Management System (LMS) at many educational institutions, is a platform that hosts online courses and provides tools for instructors and students to engage in digital learning. A LEARN link typically follows a format that includes the base URL of the platform followed by specific parameters indicating the course and content. For example, a LEARN link might look like “https://learn.uwaterloo.ca/d2l/le/content/course-id/Home”. The structure often incorporates information about the course and the specific page or resource within that course

  3. What is a CMS Contensis Link?
    3,.1 CMS Contensis links refer to web links within a Content Management System, a digital platform used to create, manage, and organize digital content. In an educational context, a CMS Contensis link could lead to resources, documents, or multimedia content hosted within the system. The format of a CMS the link varies depending on the specific system in use. For example, a CMS Contensis link might look like: https://contensis.uwaterloo.ca/sites/courses/course-id/course-name/table-of-contents.aspx. The structure typically includes the base URL of the CMS Contensis platform followed by identifiers for the content or page being referenced.

  4. What kinds of Learn Courses can be verified and what role is needed?
    Learn:

    CEL Version: Requires roles such as Instructor, TA4, Administrator or Content Editor within the specific CEL version.

    Term Version: Requires roles such as Instructor, TA4, or Content Editor within the term version.

Viewing Search Results in Link Checker

Expand
title Click here to expand...
  1. What information is displayed for each search result in Link Checker?
    1.1 For each search, the tool provides a detailed overview, presenting general information about the search, including the parameters used, the date and time of the search, and any additional relevant details. This ensures transparency and easy comprehension of your search history.

    1.2 For each search, there are 3 tabs - Pages, URLs, Rules. The Pages shows the total pages with incorrect links. The URLs tab shows total incorrect URLs within the course you are searching for. The Rules tab shows the set of rules that define the types of invalid links. For more information on Rules, you can find info on each type of rule : Rules

  2. How does the detailed overview assist in managing search history?
    2.1 The detailed overview is instrumental in facilitating transparent and efficient search history management. By presenting comprehensive information about each search, users can quickly identify and assess specific parameters, aiding in decision-making regarding actions such as viewing reports, restarting searches, or deleting entries.

  3. Is there a timestamp associated with each search result?
    3.1 Yes, Link Checker includes a timestamp alongside each search result, indicating the date and time when the search was conducted. This timestamp provides a chronological reference, enabling users to track the sequence of their searches over time.

...

Expand
title Click here to expand...
  1. How does Link Checker benefit students?
    1.1 Link Checker serves as a valuable tool for students by ensuring the integrity of web links within educational platforms. Students can expect a seamless learning experience with validated links, preventing potential disruptions and ensuring access to essential course resources.

    1.2 Link Checker enhances the overall learning experience for students by identifying and rectifying broken or invalid links. This proactive approach minimizes potential obstacles, allowing students to focus on accessing course content without disruptions caused by faulty links

  2. Why does the Link Checker say a URL is invalid, but when I click the link, it is working?
    2.1 Reasons for false negative links:

    1. The content of the link has been changed since the search was run

    2. The website of the link was down at the time the search was run

    3. Reasons as described by the error message. See Error Messages Details

    4. Other: Please submit a ticket with the false negative link here https://uwaterloo.atlassian.net/servicedesk/customer/portal/28/group/2774/create/5032 if you believe the Link Checker incorrectly marked a link as invalid for any reason other that the ones above.