Skip to content

Possible Walk through for the editor interface: 2020 Interface

Mike Gifford edited this page Nov 16, 2021 · 3 revisions

Main Menu

This is a draft of the OpenACR editor based on the work of the WCAG-EM Tool

Buttons for

  • New Report
  • Open
    • OpenACR (note older files referred to this as OPAT)
    • To reload a saved file, click the 'Find and select the data file' button and locate the JSON file that you previously saved.
    • Button: Find and select the data file
  • Save
    • Save ACR
    • Use the link below to save the evaluation report information that you have entered in a JSON data file locally on your computer.
    • You can save partially-complete reports (and notes) and work on them later. You can open them from any web browser and you can transfer the data file to another computer.
    • You can Save periodically as you work to avoid losing data if your web browser closes. You can use Windows shortcut keys Ctrl+S or Mac shortcut keys ⌘S to open the Save dialog (or automatically save it in your downloads folder depending on your web browser settings). When you are done entering your evaluation report information, you can download an HTML file of the completed report from the View Report page.
  • Import
    • Import a WCAG EARL report
    • Step 1 - Select import file
    • If you have used another application to generate a WCAG EARL-report that falls into the scope of this evaluation, you may be able to import these and add them to the evaluation audit result. The file itself should be: JSON-LD parseable, consist of objects in EARL format and evaluation tests should be related to WCAG.
  • Key Resources
  • Language
    • English

Tabs

1. Start

ACR Editor

OpenACR Accessibility Conformance Report (ACR) Generator

What this tool does

This tool helps you generate a machine-readable ACR. It does not perform any accessibility checks. It helps you follow the steps to generate a properly structured report from the input that you provide. It is designed for experienced evaluators who know Section 508 and the Web Content Accessibility Guidelines (WCAG) 2.

Note: This tool does not automatically save the information that you enter. To save your data in a file locally on your computer, use Windows shortcut keys Ctrl+S or Mac shortcut keys ⌘S to open the Save dialog. (Or the 'Save' link at the top of the page will open the Save Evaluation Report page and from there the 'Save data file locally to your computer' link will open the Save dialog.)

How this tool works

  • All functionality provided by this tool is now loaded and running locally in your web browser. You don't need an Internet connection beyond this point. When you close your web browser window, any unsaved data is lost.
  • All input that you provide through this tool is recorded as JSON data in the background (in your web browser, not on any server). You can Save periodically as you work to avoid losing data if your web browser closes.
  • You can save partially-complete reports and work on them later. To reload a saved file, use the 'Open' link at the top and find the file that you previously saved.
  • Links that are not part of the navigation or functionality (links to external resources) open in a new web browser windows.

Tips for using this tool

  • You can go back and forth between the steps in any order. None of the fields are required.
  • To get more information about a field, select the Info expand icon next to the field label.
  • You can include in your report WCAG 2 success criteria beyond the conformance target. For example, the website is only required to meet Level AA, yet you want to also include Level AAA success criteria in the report. Any criteria with a result will always be included in the report.

2. Define Scope

Define the Evaluation Scope

Define the overall parameters and scope of the evaluation. Ideally, this is done with the person who commissioned the evaluation (who may or may not be the website owner), to ensure common expectations about the scope of the evaluation.

  • OpenACR Version: [Section 508, WCAG, EU, All]
  • Requirements: [Web 2.0, 2.1, 2.2, Hardware, Software, Documentation]
  • Product/service name:
  • Product Description:
  • Name of Product/Version:
  • Date:
  • Vendor name:
  • Author name (optional):
  • Related OpenACR (optional):
  • Legal disclaimer (optional):
  • Notes:
  • Evaluation Methods Used:

3. Table 1: Success Criteria, Level A, AA & AAA

For each WCAG 2 success criteria, you can enter 'Results for the entire sample' and you can enter results for individual web pages. You can choose to enter either or both. To enter individual results, select the web page(s) under 'Sample to Evaluate' (in the left column); then under the specific success criteria, select 'Show web pages to enter individual results'.

By default we have assumed Section 508 with WCAG 2.0 AA criteria, but this can be adjusted in the requirements on in the previous tab. The results of your selection on the previous page will have altered the options available in the rest of the form. You can view in either the default POUR format favoured by WCAG or by Level A, AA and AAA which is the default with existing VPATs. You will not lose data by switching displays.

You can add notes to each of the Level A, AAA & AAA criteria.

4. Section 508 Refresh

Chapter 3: Functional Performance Criteria (FPC)

Chapter 4: Hardware

Chapter 5: Software

Chapter 6: Support Documentation and Services

5. European Union (EN 301 549)

Coming soon.

6. ACR View

Accessibility Conformance Report View

Below is the evaluation report based on the input that you provided in previous steps. You can go back to previous steps now and change any of this information. You can download the evaluation data so that you can work on it later. (This is the same as the 'Save' functionality.) This report is intended to be downloaded. The Markdown and HTML versions of this report can be generated through the command line tools provided by the OpenACR GitHub project.

Save the evaluation data (YAML)