search

ntno / mkdocs-terminal

monospace theme for MkDocs
https://ntno.github.io/mkdocs-terminal/
MIT License
119 stars 5 forks source link

review site accessibility #80

Closed ntno closed 1 year ago

ntno commented 1 year ago
ntno commented 1 year ago

lengthy alternate text

https://webaim.org/standards/wcag/checklist#sc1.1.1

Why It Matters

Alternative text should be succinct, yet descriptive of the content and function of an image. Lengthy alternative text (more than around 100 characters) often indicates that extraneous content or content that is not available to sighted users is being presented.

What To Do

Ensure the alternative text is succinct, yet descriptive. Ensure that no content is being presented in alternative text that is not available to sighted users viewing the image. When possible, either shorten the alternative text or provide the text alternative via another method (e.g., in text near the image, through a separate description page, etc.).

The Algorithm... in English

The image's alt attribute value is more than 100 characters. Note that the 100 character limit is a rough and somewhat arbitrary length. For images that present complex content or lengthy text, alternative text longer than 100 characters may be appropriate.

ntno commented 1 year ago

Language missing or invalid

What It Means

The language of the document is not identified or a lang attribute value is invalid.

Why It Matters

Identifying the language of the page or page elements allows screen readers to read the content in the appropriate language. It also facilitates automatic translation of content.

What To Do

Identify the document language using the attribute with a valid value (e.g., ). Ensure that all lang attribute values are valid. The Algorithm... in English The attribute is missing or is empty, or a lang attribute value is not a valid language identifier.

Standards and Guidelines

3.1.1 Language of Page (Level A)

ntno commented 1 year ago

Unlabeled form control with title

What It Means

A form control does not have a label, but has a title.

Why It Matters

The title attribute value for unlabeled form controls will be presented to screen reader users. However, a properly associated text label provides better usability and accessibility and should be used unless the purpose of the form control is intuitive without the label.

What To Do

If a visible text label is available for the form control, associate the text label to the form control using the label element. This provides additional functionality for end users because if the label is clicked it will set focus to the form control. If the form control is intuitive without a

The Algorithm... in English

An<input> (except types of image, submit, reset, button, or hidden), <textarea>, or <select> element has a non-empty title attribute value and is missing a label or valid aria-labelledby reference.

Standards and Guidelines

ntno commented 1 year ago

Skipped heading level

What It Means

A heading level is skipped.

Why It Matters

Headings provide document structure and facilitate keyboard navigation by users of assistive technology. These users may be confused or experience difficulty navigating when heading levels are skipped.

What To Do

Restructure the document headings to ensure that heading levels are not skipped.

The Algorithm... in English

A heading level is skipped (e.g., an <h1>is followed by an <h3>, with no intermediate <h2>). Note that an <h1> is not required to be the first heading within the document.

Standards and Guidelines

1.3.1 Info and Relationships (Level A) 2.4.1 Bypass Blocks (Level A) 2.4.6 Headings and Labels (Level AA)

ntno commented 1 year ago

see also - https://www.w3.org/WAI/ARIA/apg/example-index/dialog-modal/dialog