User Settings

This section is not yet developed. It is included to describe the concept.

User settings describe the user preferences.

User settings should be restricted to the expected values. User setting must conform to the supported values. Authors are expected to test their content against the expected values of each item.

User setting might be encoded in JSON or XML. Example code may be:

"@coga-simplification": [{ "critical": { "settings": [{ "@aria-hidden": "false", "css": "visibility:visible;" }]

Base values for contextual elements

Property supported values / types expected values
@aria-hidden

false/true

false

true

tooltip text (UTF8) between 1 - 25 characters
CSS

string

any CSS style

CSS =

visibility:visible , non visible

position: fixed; relative,

left: 0, (valid is not overlapping)
bottom: 0;

top:0
right: 0;

float: right left
border: 1 -5 px solid ;

width: 20 px - 300px;

Colors: black MidnightBlue , DarkRed with bgcolor: ,Beige, Cornsilk , Linen , white,

or

colors: ,Beige, Cornsilk , Linen , white, WITH bgcolor: black, MidnightBlue , DarkRed

font-size: 12, 14, 18, 22, 24, 26

Line-spacing: 1.5, 2

long desc

text (UTF8)

15 - 800 characters

more URI
shortcut string SHIFT / CTRL / ALT + SHIFT / CTRL / ALT + alpha numeric
Symbol

URI

or sub-container URL, creator license using DC notation

Formats : pg, SVG, JMEG, GIF, bmp

Size:

Sizes tested are: Xpx, Xpx, and Xpx

"Symbol": "https://d30y9cdsu7xlg0.cloudfront.net/pg/32455-200.png"

Or

"Symbol": [{ "URL": "https://d30y9cdsu7xlg0.cloudfront.net/pg/32455-200.png", "creator": { "name": "Christopher Smith", "URL": "https://thenounproject.com/oneafternine/" }, "license": [{ "name": "Creative Commons", "URL": "http://creativecommons.org/licenses/by/3.0/us/" }] }],

image

URI

or sub-container URL, creator license using DC notation

Formats : pg, SVG, JMEG, GIF, bmp

Sizes tested are: Xpx, Xpx, and Xpx

"image": "https://d30y9cdsu7xlg0.cloudfront.net/pg/32455-200.png"

Or

"image": [{ "URL": "https://d30y9cdsu7xlg0.cloudfront.net/pg/32455-200.png", "creator": { "name": "Christopher Smith", "URL": "https://thenounproject.com/oneafternine/" }, "license": [{ "name": "Creative Commons", "URL": "http://creativecommons.org/licenses/by/3.0/us/" }] }]

inherits URI
name text
text text between 1 - 15 characters UTF8

Untitled section

Property Attribute Values Expected Type (Settings) Expected Settings

Example (JSON)

coga-simplification

Critical

High

Med

Low

aria-hidden

@aria-hidden": "false"

@aria-hidden": "true"

"@aria-importance": [{ "critical": { "settings": [{ "@aria-hidden": "false", "CSS": "visibility:visible;" }]

Features

Taken from smart4MD funded by the European commission horizon 2020 projects.

Text and icons

Text can be displayed under icon

Text can be changed. The text is associated with the icon role and is changed consistently for

Contrast and display

Contrast

Medium
Contrast ratio of at least 4.5:1
High: 7:1

Text size

Basic text
Normal
Large.
V large

Normal: 14 pt
Large: 18 pt.
V large:22 pt

Buttons

text only
images only
text and images

(Note that Icons  on buttons with different roles should be settable)

Feedback and orientation

Spoken feedback always/sometimes/off
Text feedback always/sometimes/off

Failure icon

URI

Need to specify expected format/ allowed format / expected sizes

Success Icons

URI

Interaction

Allow scroll

On / off/ URI

URI is a widget that handles scroll

Allow gestures

terms for allowed gestures

Support

Text to speech (with synchronized highlighting)

Automatic
When an icon is pressed
Never

Tooltips

On/off

Help panel

When I click an icon/text
Never
Always open

URI

Chat support?

Always

When I click an icon/text
Never

Text Settings

Avoidnumbers

On /off

Readinglevel

Easiest
Medium
High
Any

Medium (8th grade)
High (12th grade)

Clarity

Normal
Specific

Finding content

Search

Have a search option when ever possible

Site map

Always

Sometimes

when to show link to the site map

Menu bars

Use menu bars with sub menus

Location of navigational elements

should these be handled as contextual elements
Search location top right, top right , bottom left , bottom right
sitemap location top right, top right , bottom left , bottom right
GetHelp location top right, top right , bottom left , bottom right
Next location top right, top right , bottom left , bottom right
Prev location top right, top right , bottom left , bottom right
Critical elements toolbar top right, top right , bottom left , bottom right
Video
show control bar always/sometime
show captions on /off
Show navigation points ( videos) on/off

Video icons with text

Iconsonly/icons with text/text only

Back button

Always show back button
(on off)

do not rely on the tablet default for navigation as some people will not know how to use it

Links

CSS

expected values will be CSS values for :

blue and underline
Hover affect
Always have a link icon next to links
links as a button

Breadcrumbs

Options
-None
-Normal
-With data

With data will have a summary of what was submitted at each step so people can know exactly what they did

Distractions

  • Turn off all non critical features (on off)
  • Turn off messages(on off)
  • Turn off messages accept for specific people

TBD

Conformation

  • Always show a conformation screen before submitting data

TBD

include user settings to match the accessibility terms and address how accessibility features should be handled

Example code may be:

"@accessibilityFeature": [{ "alternativeText": { "settings": [{ "replaceimage": "true", "css": "visibility:visible;" }]

The full accessibility terms are available at: https://www.w3.org/wiki/WebSchemas/Accessibility

Accessibility term example

Property Expected Type Expected Values Description
accessibilityFeature Text
  • alternativeText
  • annotations
  • audioDescription
  • bookmarks
  • braille
  • captions
  • ChemML
  • describedMath
  • displayTransformability
  • highContrastAudio
  • highContrastDisplay
  • index
  • largePrint
  • latex
  • longDescription
  • MathML
  • none
  • printPageNumbers
  • readingOrder
  • rubyAnnotations
  • signLanguage
  • structuralNavigation
  • synchronizedAudioText
  • tableOfContents
  • taggedPDF
  • tactileGraphic
  • tactileObject
  • timingControl
  • transcript
  • ttsMarkup
  • unlocked
Content features of the resource, such as accessible media, supported enhancements for accessibility and alternatives.

See the accessibilityFeature in detail section below for more information.

accessibilityHazard Text
  • flashing
  • noFlashingHazard
  • motionSimulation
  • noMotionSimulationHazard
  • sound
  • noSoundHazard
  • unknown
A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3.

All three of the negative properties should be set if none of the hazards are known to exist. If the content has hazard(s), include positive assertions for the hazards it has and negative assertions for the others.

If the property is not set in the positive or negative or is specifically set to unknown, the state of hazards is not known.

accessibilityAPI Text
  • AndroidAccessibility
  • ARIA
  • ATK
  • AT-SPI
  • BlackberryAccessibility
  • iAccessible2
  • iOSAccessibility
  • JavaAccessibility
  • MacOSXAccessibility
  • MSAA
  • UIAutomation
Indicates that the resource is compatible with the referenced accessibility API.
accessibilityControl Text
  • fullKeyboardControl
  • fullMouseControl
  • fullSwitchControl
  • fullTouchControl
  • fullVideoControl
  • fullVoiceControl
Identifies one or more input methods that allow access to all of the application functionality.