Add IDs to Documentation HTML to allow Bookmark linking

Idea created by Matthew Weathers on Sep 15, 2017
    Open for Voting
    Score1
    • Matthew Weathers

    This is a suggestion for the Canvas Doc Team 

     

    I suggest that a unique ID be added in the HTML to each major section in documentation pages. (Maybe every H2 tag?) This will allow the creation HTML Bookmark links as described here: https://www.w3schools.com/html/html_links.asp 

     

    For example, this could allow a link like this: https://community.canvaslms.com/docs/DOC-10209-4152724129#SelectRubricSettings that would link directly to the "Select Rubric Settings" section of that document.

     

    Here are some more details, using that same page as an example:

     

    In https://community.canvaslms.com/docs/DOC-10209-4152724129 

     

    the HTML looks like this:

    ...<h2 class="screensteps-heading step-title" style="margin: 15px 0;">Select Rubric Settings</h2> <div class="image screensteps-image">...

     

    I suggest adding an id, like this:

     

    ...<h2 id="SelectRubricSettings" class="screensteps-heading step-title" style="margin: 15px 0;">Select Rubric Settings</h2> <div class="image screensteps-image">...


    And that would allow for "bookmark linking," which looks like this:

     

    https://community.canvaslms.com/docs/DOC-10209-4152724129#SelectRubricSettings 

     

    I am a Canvas administrator, and I frequently refer users to specific parts of the documentation. Today I sent an email saying: "If you look at https://community.canvaslms.com/docs/DOC-10209-4152724129 about half-way down, there's a section called Select Rubric Settings and the picture there shows..." and it would be nice to instead be able to say something like "see the picture at https://community.canvaslms.com/docs/DOC-10209-4152724129#SelectRubricSettings"

     

    user documentation