Custom keys documented
Supplemental requirement
Custom keyboard commands are documented. That documentation is actively available from any page/view to which it applies.
Tests
This section is non-normative.
Procedure
For each custom keyboard command that works on a page/view:
- Check that documentation of the keyboard commands exists.
- Check that the documentation is available from the page/view.
Expected results
- #1 and #2 are true.
ACT Rules
This section is non-normative.
This is an Atomic rule to test Custom Keys Documented.
This rule checks that custom keyboard commands are documented and that documentation is programmatically and visually available from any page/view to which they apply.
- Applicability
- This rule applies to any page/view in which an author has provided a custom keyboard command.
- Expectation
- The custom keyboard command is documented, and programmatically and visually available from any page/view to which it applies.
Examples:
- Passed example 1
- A search input can be focused using a custom keyboard command of / (forward slash). This custom keyboard command is documented as programmatically related description text for the input.
- Passing example 1
- Passed example 2
- A search input can be focused using a custom keyboard command of / (forward slash). This custom keyboard command is documented on a linked “Help” page.
- Passing example 2
- Passed example 3
- A search input can be focused using a custom keyboard command of / (forward slash). This custom keyboard command is documented in a “Help” dialog on the same page.
- Passing example 3
- Failed example 1
- A search input can be focused using a custom keyboard command of / (forward slash). This custom keyboard command is not documented.
- Failing example 1
- Failed example 2
- A search input can be focused using a custom keyboard command of / (forward slash). This custom keyboard command is visually documented but not programmatically determinable.
- Failing example 2
- Failed example 3
- A search input can be focused using a custom keyboard command of s. This custom keyboard command is not documented. As a red herring, a custom keyboard command of / (forward slash) is documented, but does nothing.
- Failing example 3
- Inapplicable example 1
- A button reveals a tooltip of “Press Space to activate” on focus and hover. The documentation is not necessary since it is describing a standard platform keyboard command.
- Inapplicable example 1
Tests
This content needs to be written.
Key Terms
- actively available
available for the user to perceive and use
- conformance scope
A set of Views and/or Pages selected to be part of a conformance claim. Where a View or Page is part of a Process, all the Views or Pages in the process must be included.
How a person or organization selects the set is not defined in WCAG3. There maybe informative guidance on selecting a suitable set in future (similar to WCAG-EM), but regional laws or regulations may provide a methodology.
- content
information, sensory experience and interactions conveyed
person or persons responsible for the content presented, including word choice, formatting, images, video, audio, and other elements
- custom keyboard command
a keyboard command provided by a content author that is not a standard platform keyboard command
- page
non-embedded resource obtained from a single URI using HTTP plus any other resources that are used in the rendering or intended to be rendered together
Where a URI is available and represents a unique set of content, that would be the preferred conformance unit.
- platform
software, or collection of layers of software, that lies below the subject software and provides services to the subject software and that allows the subject software to be isolated from the hardware, drivers, and other software below
Platform software both makes it easier for subject software to run on different hardware, and provides the subject software with many services (e.g. functions, utilities, libraries) that make the subject software easier to write, keep updated, and work more uniformly with other subject software.
A particular software component might play the role of a platform in some situations and a client in others. For example a browser is a platform for the content of the page but it also relies on the operating system below it.
The platform is the context in which the conformance scope exists.
- process
series of views or pages associated with user actions, where actions required to complete an activity are performed, often in a certain order, regardless of the technologies used or whether it spans different sites or domains
- standard platform keyboard commands
keyboard commands that are the same across most or all platforms and are relied upon by users who need to navigate by keyboard alone
A sufficient listing of common keyboard navigation techniques for use by authors can be found in Standard Keyboard Navigation & Operation Keys and Techniques.
- view
content that is actively available in a viewport including that which can be scrolled or panned to, and any additional content that is included by expansion while leaving the rest of the content in the viewport actively available
A modal dialog box would constitute a new view because the other content in the viewport is no longer actively available.
- viewport
object in which the platform presents content
The author has no control of the viewport and almost always has no idea what is presented in a viewport (e.g. what is on screen) because it is provided by the platform. On browsers the hardware platform is isolated from the content.
Content can be presented through one or more viewports. Viewports include windows, frames, loudspeakers, and virtual magnifying glasses. A viewport may contain another viewport. For example, nested frames. Interface components created by the user agent such as prompts, menus, and alerts are not viewports.