Accessibility Checker

  0 rating
3/22/2013 1:55:43 AM
3/22/2013 1:55:43 AM
Provider: Sitecore

About

The Accessibility Checker Module allows editors to check their content against various accessibility standards including:

    WCAG 1.0 (A-AAA)
    WCAG 2.0 (A-AAA)
    BITV (Germany)
    Section 508 (US)
    Stanca Act (Italy) 

It makes use of the Open Source Accessibility AChecker ​http://atutor.ca/achecker/ you can try the checker online at ​http://achecker.ca/checker/index.php

The Accessibility Checker works in two ways, one as a Field or Item Validator, also as a live preview with errors and warning highlighted. 

show case

Documentation

Documentation
  • Documentation > Getting Started with the Accessibility Checker
    Getting Started with the Accessibility Checker

    Pre Requisites

    The Accessibility Checker Module requires access to a slightly enhanced version of the Open Source AChecker REST API. For improved performance of the accessibility check it is best to have a local install of the AChecker website, for information on how to download AChecker and the required enchantments downloadable files read the Installation notes.


    During testing of this component on your environment you can use one of two test environments of AChecker that I have set up.


    Please note: These These environments are on low performing servers (one is on a small shared hosting plan, the other on an Amazon Micro instance) and have no guarantees of uptime. So are only recommended during setup and testing of the module.


    Installation

    1. Install the Accessibility Checker Module
    2. Configure the Accessibility Checker Validators If you wish to use the two Accessibility Checker validators (Field Validator, and Item Validator), please see the Validators page for information on how to set this up.
    3. Configure the Accessibility Checker Options

      Log in to the Content Editor and under the ‘Review Ribbon’ you should now see the new ‘Accessibility’ icon, using the drop down select configure.

    Achecker button


    4. Set the Accessibility Checker Options

        Before use, you will need to configure the Module, the fields are described below

    AChecker settings


    API URL: This needs to point to the api.php link of your installed AChecker website, for more information on Installing AChecker see the AChecker Installation notes. The downloadable package is configured to use an Amazon EC2 Micro Instance pre-configured with AChecker. You can use this whilst setting up and testing the module, but there are no guarantees of uptime or performance. On the API page there are some other settings you can use for testing if this server is down.


    API Key: The API Key from the AChecker website, see the AChecker Installation notes for details on how to obtain this key from ACheker. Again this has been pre-configured to use the Amazon EC2 Instance, see the API page for other settings you can use.


    Guide Line: Check the required accessibility guidelines you want to validate against. You can select more than one option.


    Ignore Validator Warnings: By checking this option the Sitecore Validators will ignore accessibility warnings, and only report on accessibility errors.


    Show Errors: By enabling this option, all accessibility errors will be displayed in the ‘Validator’ screen, otherwise the validator will just report that errors were found in the content during validation. See the below image to see the difference between the two settings.

    AChecker validationAChecker validation

    200
  • Documentation > How to use
    How to use

    The Accessibility Checker Module works in two ways:

        1. Sitecore Validators
        2. Page Preview, with issues highlighted


    Validators


    Follow the link to see how to configure the Validators in Sitecore, it is recommended that you don’t use interactive validators to run in the interface (such as Quick Action Bar or Validation Bar) as this may effect performance.

    To run the validators, simply click on the ‘Validation’ button in the ‘Review’ tab. Depending on the configuration options enabled, the accessibility validator will check all Rich Text fields for accessibility and also the full page output, which will include output from layouts and renderings.


    Page Preview


    To get a preview of the page, with all accessibility errors (and optionally) warnings highlighted, simply click the ‘Accessibility’ button in the ‘Review’ Ribbon.

    This will open a new Tab in the content editor that will show you a preview of your item (this may take a few seconds to run), with all accessibility errors highlighted with a red-dashed highlighted box around the content causing the error. Any warnings will be highlighted in yellow.


    By clicking on one of the highlighted boxes, any errors or warning will be displayed. Depending on the issue discovered, you will be informed on what the issue is, and also how to fix the problem. By clicking on the ‘more…’ link you will also be show a further description of the error, and also a procedure of how to manually check the issue.


    AChecker demo

    250
  • Documentation > Validators
    Validators

    By default the Package installer will enable full page accessibility checking, if you don’t wish to use this feature, open the Content Editor, and navigate to 


    /sitecore/system/Settings/Validation Rules/Item Rules/Item/ 


    Then simply delete the ‘Full Page Accessibility Check’ item.


    To enable the accessibility validator to check Rich Text fields, navigate to /sitecore/system/Settings/Validation Rules/Field Types/Rich Text/ 

    with the Content Editor.


    Depending on where you want the accessibility validator to run, you will need to add the ‘AccessibilityCheck’ to the selected items, as shown in the screen shot below.


    validation

    300
  • Documentation > AChecker
    AChecker

    AChecker is an open source Web accessibility evaluation tool. It can be used to review the accessibility of Web pages based on a variety international accessibility guidelines. Use the Public ​AChecker to evaluate the accessibility of a Web site you know. For more information on the AChecker tool, go to the AChecker home page ​http://atutor.ca/achecker/


    To get the best performance out of the Accessibility Checker Module, it is best to install the AChecker website n to a local server.


    During testing and installation there are two test servers configured with AChecker running, to get more information and the configuration needed please see the API page.

    AChecker can be downloaded from ​http://atutor.ca/achecker/download.php here The requirements for AChecker are found at ​http://atutor.ca/atutor/docs/requirements.php (Note, AChecker works fine on Windows using IIS).


    Important

    The Accessibility Checker Module, has extended the REST API, that AChecker offers, so you also need to download the enhancements, simply extract the two files (keeping the folder structure) in to the AChecker folder.


    Once AChecker has been installed correctly, you will need to retrieve the Web Service API key. To do this follow the instructions:


        Browse to your newly installed AChcker website.
        Click on the Login Link
        Login with the username and password created during setup
        Click the Profile Link
        Copy the Web Service ID
        Use this to populate your API Key field in the Accessibility Checker Settings.


    validation

    400
  • API

    Pre-Configured AChecker Servers

    I have enabled two instances of AChecker, that can be used whilst testing and installing the Accessibility Checker Module, please note there can be no Guarantee of uptime, or performance from these servers.


    API Details for these instances are as below.


    Server 1

    API URL: http://achecker.azurewebsites.net/api.php

    Api key: 67815422fb641f002e5715b1c597a9420059f377

    Server 2


    API URL: http://checker.asp-dev.com/checker/api.php

    Api key: 0169d208ac103e16eacc76e96f8bf31bfcbb5b99

    500
Back
Release notes
The module was added 07/06-2012
Read more Back
Code examples

Solution screenshots(0)

Upload

Reviews (0)

Sort by: Date Most votes
  • Profile Avatar
    [fullName]

    Level: 0

    x0 x0 x0

    [date]

    [title]

    [text]

    Was this helpful?

    0

Comments (0)

Sort by: Date  Most votes

Leave a Comment

Comment must be field in
Post comment
loader

Write a review

Title can't be empty
Review can't be empty
Post review

Download

Title Description Download Action

Add File