accessibility-checker-engine
Version:
An automated accessibility checking engine for use by other tools
93 lines (80 loc) • 4.03 kB
HTML
<html lang="en-US">
<head>
<title>heading_markup_misuse - Accessibility Checker Help</title>
<script>
RULE_MESSAGES = {"en-US":{"Pass_0":"Rule Passed","Potential_1":"Verify that the heading element is a genuine heading","group":"Heading elements must not be used for presentation"}};
RULE_ID = "heading_markup_misuse"
</script>
<!--
/******************************************************************************
Copyright:: 2022- IBM, Inc
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*****************************************************************************/
-->
<!-- Title and messages generated at build time -->
<link rel="icon" href="https://ibm.com/able/favicon-32x32.png" type="image/png">
<link rel="icon" href="https://ibm.com/able/favicon.svg" type="image/svg+xml">
<link rel="stylesheet" href="../common/help.css" />
<script type="module">
import "https://1.www.s81c.com/common/carbon/web-components/version/v1.35.0/code-snippet.min.js";
import "https://1.www.s81c.com/common/carbon/web-components/version/v1.35.0/list.min.js";
</script>
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
<script src="../common/help.js"></script>
</head>
<body>
<div class="bx--grid toolHelp">
<div class="bx--row">
<div class="bx--col-sm-4 bx--col-md-8 bx--col-lg-16 toolHead">
<!-- Group message injected here -->
<h3 id="ruleMessage"></h3>
<!-- Severity level injected here -->
<div id="locLevel"></div>
<!-- Rule specific message injected here -->
<p id="groupLabel"></p>
</div>
</div>
<div class="bx--row">
<div class="bx--col-sm-4 bx--col-md-5 bx--col-lg-8 toolMain">
<!-- Start main panel -->
<mark-down><script type="text/plain">
### Why is this important?
Some assistive technologies use the marked-up headings (`<h1>` .. `<h6>`) to create an outline of a page, allowing users to get an overview and jump quickly to any heading.
When HTML heading elements are used for text that is not a heading, this results in an incorrect outline structure, which might disorient users.
<!-- This is where the code snippet is injected -->
<div id="locSnippet"></div>
### What to do
* Verify that this element with long text content is genuinely a heading
* **Or**, if this is not a heading, do not use a heading element (`<h1>` .. `<h6>`)
</script></mark-down>
<!-- End main panel -->
<!-- This is where the rule id is injected -->
<div id="ruleInfo"></div>
</div>
<div class="bx--col-sm-4 bx--col-md-3 bx--col-lg-4 toolSide">
<!-- Start side panel -->
<mark-down><script type="text/plain">
### About this requirement
* [IBM 1.3.1 Info and Relationships](https://www.ibm.com/able/requirements/requirements/#1_3_1)
* [Failure F43: Structural markup that does not represent relationships](https://www.w3.org/WAI/WCAG22/Techniques/failures/F43)
### Who does this affect?
* People using a screen reader, including blind, low vision, and neurodivergent people
* People using text-only, monochrome, or Braille displays
* People using text-based browsers (e.g., Lynx) or audio interfaces
* People with cognitive differences who view interfaces using an adapted layout
</script></mark-down>
<!-- End side panel -->
</div>
</div>
</div>
</body>
</html>