Uploaded image for project: 'Sakai'
  1. Sakai
  2. SAK-43026

Heading structure not following best practices

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Awaiting Information
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Portal
    • Labels:
    • Test Plan:
      Hide

      Manual code inspect

      Run a screen reader, refresh the page, navigate by headings only. Can also look at code or use a headings checker (Firefox web developer extension has a good one).

      Show
      Manual code inspect Run a screen reader, refresh the page, navigate by headings only. Can also look at code or use a headings checker (Firefox web developer extension has a good one).

      Description

      Possible Solution:

      Follow logical hierarchy with only 1 H1

       ** 

      URL of issue:

      https://qa.longsight.com/portal/site/~student01/tool/49268c7e-45e3-484c-babd-f89c57feafdc/messages?0#tocontent

       

      Comment from ISU:

      Heading structure on any given page should only contain one H1 (first heading of page - main idea of page/site)
      Other headings should follow in logical hierarchy, not skipping levels. This is also true of hidden headings.
      H1
      H2
      H3
      H3
      H2
      H3
      for example

      Globally at least three H1s exist on every page typically used to denote the Sites List, Tools List, and the Content Area. As mentioned above best practice suggests that each page should have only one H1 to cover the main idea or content of the page. The Sites list and the tools list are separate navigation areas and used as such.
      According to WEBAIM there is an "Exception for fixed page sections
      In fixed sections of the page, for example in sidebars, the heading ranks should not change depending on the ranks in the content area. In those cases, consistency across pages is more important." So because the multiple H1s are consistant across Sakai's naviagtion sections, we could choose to leave those as is. This being said, in the content areas, we should improve, add, or maintain the proper nested heading structure to assist in search and navigation of page content. Maintaining a consistant experience is important across the Sakai Platform.

        Gliffy Diagrams

          Zeplin

            Attachments

              Activity

                People

                Assignee:
                Unassigned Unassigned
                Reporter:
                kedwar1 Kendra Edwards
                Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                  Dates

                  Created:
                  Updated:

                    Git Integration