accessibility-checker-engine
Version:
An automated accessibility checking engine for use by other tools
106 lines (91 loc) • 4.28 kB
HTML
<html lang="en-US">
<head>
<title>page_title_valid - Accessibility Checker Help</title>
<script>
RULE_MESSAGES = {"en-US":{"Pass_0":"Rule Passed","Potential_2":"Verify that using the filename as the page <title> value is descriptive","group":"Page <title> should be a descriptive title, rather than a filename"}};
RULE_ID = "page_title_valid"
</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?
Descriptive titles help users find relevant content.
The `<title>` element labels the page.
It is typically the first part of the page that users see or hear, allowing them to differentiate the page from others.
Browsers put the title in the title bar of the page window where it is quickly accessible,
and automated tools, such as search engines, use the title to index and classify the page.
<!-- This is where the code snippet is injected -->
<div id="locSnippet"></div>
### What to do
* Change the text in the `<title>` element to a meaningful description of the page purpose. A filename is not an appropriate title for a Web page.
* **And**, in a set of pages, give each a unique title
* **And**, list the unique text string first in a concatenated title
For example:
```
<html lang="en">
<head>
<title>Design - IBM Accessibility</title>
</head>
```
</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 2.4.2 Page Titled](https://www.ibm.com/able/requirements/requirements/#2_4_2)
* [Design - Page titles](https://www.ibm.com/able/toolkit/design/content/#page-titles)
* [G88: Descriptive titles](https://www.w3.org/WAI/WCAG22/Techniques/general/G88)
### Who does this affect?
* People using a screen reader, including blind, low vision, and neurodivergent people
* People with low vision using screen magnification
* People with dexterity impairments using voice control
</script></mark-down>
<!-- End side panel -->
</div>
</div>
</div>
</body>
</html>