Skip to content

Latest commit

 

History

History
226 lines (178 loc) · 18.4 KB

ACCESSIBILITY.md

File metadata and controls

226 lines (178 loc) · 18.4 KB

Accessibility & Compatibility

iD aims to make mapping as easy possible for as many people as possible. To this end, we recognize that everyone has different backgrounds, abilities, and technologies, and therefore different needs. Developing for the "average user" will inevitably fail to serve some proportion of mappers. Broadly speaking, iD should strive to follow universal design principles.

This is a living document that details the usability of iD across a number of dimensions, with the intent of identifying and addressing problem areas. Since there are always more factors to consider, no part of this document should be considered complete.

Symbols used in this document:

  • ✅ Full support
  • 🟩 Full support assumed, but not sufficiently tested
  • 🟠 Partial support
  • ❌ No appreciable support
  • 🤷 Unknown support, none is assumed

🔗 Browser Compatibility

As a web app, iD's browser support is fundamental. The user experience should be as equivalent as possible across the latest versions of all modern browsers on all major operating systems. When possible, functionality unsupported by older browsers should fallback gracefully without breaking other aspects of the app.

This table covers high-level compatibility, with individual features to be detailed elsewhere in this document.

Icon Browser Notes
chrome logo Chrome
firefox logo Firefox
safari logo Safari
🟩 opera logo Opera
🟩 edge logo Edge
ie logo Internet Explorer IE has been discontinued, but IE 11 is still maintained. iD uses features of modern web standard which are not supported by Internet Explorer.
webkit logo iOS browsers All browsers on iOS (e.g. Safari, Chrome, Firefox, Edge) use the WebKit engine and should thus have equivalent support
🟩 android logo Android browsers Browsers on Android can use their own engines, so support may vary, but there are currently no known issues
🟩 🌐 Others iD should run on any browser implementing modern web standards. Hardware factors such as screen size may affect usability

🕹 Interaction Support

iD has traditionally assumed the mapper will be interacting via a mouse and keyboard, but realistically people want or need to use various other input devices.

iD relies on modern pointer events for some interactions, so some devices may see degraded functionality on older browsers.

Input Devices

This table details iD's support for specific classes of input devices.

"Full support" for a device means that iD reasonably handles its entire range of input on supported platforms. Though the given device is not necessarily expected to perform all of iD's functions.

It's impractical to ensure every single input device works as expected, so the table only reflects the support status to the best of our knowledge.

Icon Input Device Notes Issues
🟩 apple adb mouse Single-button mouse Primary click (e.g. left-click) can be used for all pointer interactions. Long-clicking on map features opens the edit menu
🟩 ibm mouse Multi-button mouse Secondary click (e.g. right-click) can be used on map features to open the edit menu. Middle click, etc., are not needed by iD but are passed through to the browser
🟩 magic mouse Multi-touch mouse 2D scrolling in the map is treated as panning, not zooming
🟠 vertical scroll wheel Vertical scroll wheel Should zoom the map in and out #5550
Horizontal scroll wheel Currently does nothing in the map #7134
🤷 apple mighty mouse Scroll ball Works like combined vertical/horizontal scroll wheels
🟩 🖲 Trackball
🟩 touchpad Trackpad
🟩 macbook trackpad Multi-touch trackpad Pinch-to-zoom and scroll-to-pan are supported in the map
🟩 pointing stick Pointing stick
🟩 ⌨️ Keyboard Any keyboard can be used, but certain functionality may require certain keys
🤷 Touch bar Generic, browser-provided controls should be shown
🟩 Multi-touch screen
🟩 ✍️ Stylus Works like a single touch for tapping, dragging, scrolling, etc.
🤷 🔲 Graphics tablet
🤷 🎮 Gamepad

Input Setups

This table lists iD's usability for different setups. A setup is where a mapper is using only the device(s) given in the row.

A setup with "full support" offers functionality equivalent to that of the highest-functioning setup (generally mouse and keyboard). Certain functions may be accessed differently on different setups, such as opening the edit menu via long-pressing instead of right-clicking.

Icon Input Setup Notes Issues
🖱⌨️ Mouse + keyboard iD's original input paradigm. Any mouse-like device such as a trackpad, trackball, or pointing stick is grouped into "mouse" for this table
🟠 ⌨️ Keyboard only A keyboard can be used to access all of iD's screens and controls, but not for interacting with data in the map #8004
🟠 🖱 Mouse only The primary mouse button (e.g. left click) alone is sufficient. Multiselection and disabling of node-snapping aren't possible. Text input requires something like a virtual keyboard
🟠 🖐 Multi-touch on a touchscreen Moving and rotating selections isn't possible #7599
🟠 ✍️ Stylus on a touchscreen Moving and rotating selections isn't possible, nor is selecting multiple features
🤷 ✍️🔲 Stylus on a graphics tablet
🤷 🎮 Gamepad
🤷 🗣 Voice Tools like Voice Control on macOS and Windows Speech Recognition allow navigating webpages with voice commands to some degree
🤷 🔘 Switch Tools like Switch Control on macOS can theoretically replicate mouse and keyboard interactions in most apps

📟 System Compatibility

iD is largely platform-independent, meaning it should work on any system that runs a modern web browser. However, certain hardware and software components can affect iD's usability and functionality.

Display Support

Display Notes Issues
No display Non-graphical devices and "headless" use cases aren't supported. See also the vision accessibility section
🟠 Small display iD is not optimized for smartphone-sized screens or smaller, but some editing is usually possible
Large display The map expands to fill the entire browser window
🟠 Low pixel density display Some icons are not legible on low-res displays
High pixel density display iD's vector graphics scale well to high-resolution screens (e.g. Retina)
Multiple displays iD responds accordingly when its browser window is moved between different types of external screens

Network Support

Connection Notes Issues
No connection iD isn't built for offline use out-of-the-box
🟠 Slow connection iD downloads a lot of data all throughout use, so slow connections can significantly slow down mapping #7788
Intermittent connection Downloaded data can be edited during temporary connection losses. A banner message is displayed. Reconnection is attempted automatically and a "Retry" button is also provided
🟠 Mobile phone connection A fast, reliable phone network can be used for mapping. However, iD downloads data indiscriminately and can thus gobble up limited data plans #7788
🤷 Tor connection

📖 Language Support

English is the language of tags and relation roles in the OpenStreetMap database. It's also the source language of iD's interface, meaning English is the only language guaranteed to have 100% coverage. Despite this privileged position, English proficiency should not be a barrier to mapping.

Most of iD's interface can be translated to essentially any written language via the Transifex platform. Some languages have region-specific variants, such as Brazilian Portuguese (pt_BR). Translators are typically volunteers. See the translation guide for more info.

Multilingual Feature Notes Issues
Browser language preference iD tries to use the language set in the browser
Base language fallback E.g. if pt_BR is incomplete, pt should be tried before en #7996
Custom fallback languages If the preferred language is incomplete, user-specified ones should be tried before en (e.g. kkru) #7996
lang HTML attributes Helps with text-to-speech, text formatting, and auto-transliteration, particularly when iD mixes strings from different languages #7998
Locale URL parameters locale and rtl can be used to manually set iD's locale preferences. See the API
Language selection in UI The mapper should be able to view and change iD's language in the interface at any time. Useful for public computers with fixed browser languages #3120
🟩 Right-to-left layouts The dir HTML attribute is properly set for languages like Hebrew and Arabic
Language-specific plurals English has two plural forms, but some languages need more to be grammatically correct #597, #7991
Localized number formats Most in-text numbers are localized, including numeric fields #8769, #7993
🟠 Label icons Icons should accompany text labels to illustrate the meaning of untranslated terms

Translatability

This table details which interface elements can adapt to the mapper's language preferences. This doesn't account for whether they've actually been translated to one or more languages.

Interface Element Notes Issues
Labels and descriptions
Help docs and walkthrough
Letter hotkeys E.g. S for Straighten makes sense in English, but not every language
Preset names and search terms
🟠 Fields Combo fields may show raw tag values. The Wikipedia field lists Wiki names in their native languages #2708
Tags OpenStreetMap tags are English-only as a limitation of the database
Relation member roles OpenStreetMap roles are also limited to English
🟠 Imagery metadata #7724
🟠 Locator overlay This layer shows feature labels in their local languages #7737
OSM community index
iD validation issues
KeepRight issues
Osmose issues Translated strings are provided by Osmose itself, not iD

Language Coverage

The completion percentages for iD translations constantly change, and so are not listed here. Visit the Transifex project page to see the latest numbers. Typically a few languages (German, Spanish, Japanese…) are kept close to 100% coverage, while most languages have less than 50% coverage.


👁 Vision Accessibility

Vision-Access Feature Notes Issues
🤷 Screen reader support
🟠 Browser zoom Scrolling-to-pan the map may react oddly on some browsers
🟠 Text-only browser zoom Interface elements scale to compensate larger text sizes. Map labels don't scale #7965
Browser zoom keyboard shortcuts The Cmd+ and Cmd shortcuts used by major browsers are supported #7976
🟠 Don't rely on color alone Some classes of map data are indistinguishable except for their colors
🤷 High-contrast text colors
Dark mode Many people find light-on-dark UIs easier to read under certain conditions #8214
Audio feedback This would need to be easy to disable or even disabled by default #5821

👂 Hearing Accessibility

iD itself currently has no audio, so hearing difficulties alone are not expected to impact usability.