https://github.com/xi/a11y-outline

web extension to navigate document outlines easily
https://github.com/xi/a11y-outline

a11y outline webextension

Last synced: 20 days ago
JSON representation

web extension to navigate document outlines easily

• Host: GitHub
• URL: https://github.com/xi/a11y-outline
• Owner: xi
• License: bsd-3-clause
• Created: 2017-04-23T11:54:29.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-06-24T06:44:40.000Z (6 months ago)
• Last Synced: 2024-07-31T18:24:18.286Z (5 months ago)
• Topics: a11y, outline, webextension
• Language: JavaScript
• Homepage: https://addons.mozilla.org/firefox/addon/a11y-outline/
• Size: 150 KB
• Stars: 36
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
a11y-outline - web extension to navigate page outlines easily

Many screen readers like JAWS or NVDA have shortcuts to bring up a list of

landmarks, headings or links. This browser extension provides the same

functionality without requiring a screen reader. It therefore implements

[Success Criterion 1.9.1 of

UAAG20](https://www.w3.org/TR/UAAG20/#gl-alternative-views).

This is mainly useful for two audiences:

-	Sighted web developers who want to get a feeling for how blind users might

	experience their content.

-	Sighted users who like this kind of navigation.

# Installation

## Firefox

See 

## Chrome

-	Download the [latest release](https://github.com/xi/a11y-outline/releases)

	and unpack.

-	In chrome, navigate to `chrome://extensions/`.

-	Make sure that "Developer mode" is checked.

-	Use "Load unpacked extension…"

-	You may need to add the keyboard shortcut manually (at the bottom of the

	extensions page).

## Bookmarklet

A bookmarklet is available on .

## Building manually

Running `make` should be sufficient.

# Usage

Pressing `Ctrl+Shift+7` brings up a dialog. You can use the up/down arrow keys

to select a list. With the tab key you can switch to the actual list and

navigate it with arrow keys.`

Optionally you can create shortcuts for some additional commands in your

browser settings.

# Note on HTML5 outline algorithm

This extension *does not* implement the [HTML5 outline

algorithm](https://www.w3.org/TR/html53/sections.html#creating-an-outline), as

that is also not available in common screen readers and works very differently

from the WAI-ARIA based outlines used here.