EditLive! 9 Documentation : accessibilityChecks

This element allows developers to customize the EditLive! Accessibility Checker dialog.

Configuration Element Tree Structure

<editLive>
<accessibilityChecks>

<editLive>
     ...
     <accessibilityChecks ... />
     ...
</editLive>

Optional Attributes

errors

This option specifies whether any errors against the selected Accessibility Guidelines are displayed. Errors depict HTML elements which require a precise change to ensure the content is accessible under the selected guidelines.

This attribute has three possible values:

  • true - The option will first appear checked,
  • false - The option will first appear unchecked, or
  • hidden - The option will not appear at all for users.

Default Value: true

warnings

This option specifies whether any warnings against the selected Accessibility Guidelines are displayed. Warnings related to the entire HTML document itself, where errors focus on a particular HTML element.

This attribute has three possible values:

  • true - The option will first appear checked,
  • false - The option will first appear unchecked, or
  • hidden - The option will not appear at all for users.

Default Value: true

manual checks

This option specifies whether to do display aesthetic based accessibility checks that can't be programmatically detected. As a user, you will need to review your content to ensure these accessibility guidelines are met.

This attribute has three possible values:

  • true - The option will first appear checked,
  • false - The option will first appear unchecked, or
  • hidden - The option will not appear at all for users.

Default Value: false

WCAG2A

This option specifies whether errors, warnings, or manual checks will be displayed based on the W3C (World Wide Web Consortium) Web Content Accessibility Guideline version 2.0. This guideline specifies that a web content developer must specify these checkpoints.

This attribute has three possible values:

  • true - The option will first appear checked,
  • false - The option will first appear unchecked, or
  • hidden - The option will not appear at all for users.

Default Value: true

WCAG2AA

This option specifies whether errors, warnings or manual checks will be displayed based on the W3C (World Wide Web Consortium) Web Content Accessibility Guideline version 2.0. This guideline specifies that a web content developer should specify these checkpoints.

This attribute has three possible values:

  • true - The option will first appear checked,
  • false - The option will first appear unchecked, or
  • hidden - The option will not appear at all for users.

Default Value: true

Section 508

This option specifies whether errors, warnings, or manual checks will be displayed based on the Section 508 guidelines. Section 508 are web content accessibility guidelines specified as part of the US Rehabilitation Act.

This attribute has three possible values:

  • true - The option will first appear checked,
  • false - The option will first appear unchecked, or
  • hidden - The option will not appear at all for users.

Default Value: true

emptyImageAlt

This option specifies whether empty alt attributes on images result in errors, warnings, or are ignored.

This attribute has three possible values:

  • none - Ignore empty alt attributes,
  • warn - Produce a warning in the accessibility checker and inline accessibility, or
  • error - Produce an error in the accessibility checker and inline accessibility.

Default Value: error

tableMappingIssues

For tables containing cells that aren't either headers or data cells mapped to headers, this configuration option allows developers to specify whether the table is flagged as an accessibility error or warning.

  • warn - Produce a warning in the accessibility checker and inline accessibility, or
  • error - Produce an error in the accessibility checker and inline accessibility.

Default Value: error

inlineAccessibility

This configuration option allows you to enable or disable the Accessibility As You Type functionality by default.

This attribute is a boolean and can only be true or false.

Default Value: false

Example

The following example demonstrates how to set the various attributes of the <accessibilityChecks> element.

<editLive>
    ...
    <accessibilityChecks
        errors="true"
        warnings="false"
        manual="hidden"
        WCAG2A="true"
        WCAG2AA="true"
        Section508="hidden" />
    ...
</editLive> 

Remarks

If the configuration file specified for EditLive! does not contain an <accessibilityChecks> element, any changes a user makes to the Accessibility Checker dialog will be saved on that user's machine.

Example

A user checks the Errors, Warnings, and Section 508 checkboxes in the Accessibility Checker dialog. They leave all other checkboxes unchecked. The next time the user displays this dialog, regardless of whether EditLive! is rendered in a completely different webpage, the Errors, Warnings, and Section 508 checkboxes will be checked.