hidde / fast

Framework for Accessible Technologies reporting tool

[Draft] FAST Reporting Tool prototype

This is prototype of a tool that can be used for horizontal spec review. It is designed to be used in conjunction with Framework for Accessible Specification of Technologies (FAST).

This evaluation tool is designed to help with accessibility related review of W3C specifications. It creates a report (JSON object) that can be presented to support and assess accessibility related work within W3C specification.

This project is an early prototype built on tooling developed originally by Eric Eggert/Hidde De Vries (W3C). It will be abstracted into more general set of tooling for FAST by Joshue O Connor/Michael Cooper (W3C).

Status

This is a working proof of concept version containing three categories from the FAST checklist. They are 'Input', 'Interaction', and 'Semantics'.

Development

This application is built with Svelte. To run it locally, you need to clone it this repository, have Node installed and then run this in the project's directory:

npm install

This may take a while the first time, but it only needs to be done once.

Then, to build the app with Rollup, and serve it on a local dev server, run:

npm run dev

Navigate to localhost:10001. You should see your app running. Edit a component file in src, save it, and reload the page to see your changes.

Building and running in production mode

To create an optimised version of the app:

npm run build

You can run the newly built app with npm run start. This uses sirv, which is included in your package.json's dependencies so that the app will work when you deploy to platforms like Heroku.

Data structure

This project has a JavaScript representation of the DRAFT Fast Checklist.

Currently it is an abstraction from the original ATAG type layout that followed the object format outlined below. For the purposes of abstracting this tool for more general usage we follow the format here where:

You can work in the new_fast.js file. Also each FAST 'princple' has its own JSON file, that were created and then added to the master file (new_fast.js). These are named 'v_2_technology_provides_x' for each group of related checkpoints.

#For the grouping/renaming of sections:

• principle = page for new group of related FAST checkpoints
• guidelines = A new FAST section
• successcriterioa = Individual FAST checkpoints.

The general process is to create instances of any given guideline/successcriteria for each FAST checkpoint.

NOTE: None of this is normative.

This is an example of everything that can exist in this object, formatted as yaml:

principle:
  handle: Short name for FAST 'parent' principle: Vis.1, Input.1
  text: FAST principle such as "If technology allows visual rendering of content" or "If technology provides author control over color" - these determin the relevancy of a FAST "principle"
  num: Unique reference for this item, e.g. Vis.1
  guidelines:
   - id: common sense naming convention used here - though slightly arbitrary for each checkpoint e.g. "content-resized" or "defined-way-for-non-visual-rendering"
     num: Unique reference for this item, e.g. V.1.1, C.1.1. etc
     handle: Short name
     text: Full text for this 'guideline' - "There is a mechanism for users to override colors of text and user interface components" etc.
     successcriteria:
       - id: short-name
         num: Unique reference for this item, e.g. V.1.1
         handle: Short name
         text: Full text for this checkpoint
         level: ignore this
         details:
           - type: note
             handle: Note 1
             text: Full note text
           - type: olist
             items:
               - handle: Ordered Item
                 text: Full text for item
               - handle: Ordered Item 2
                 text: Full text for item 2
           - type: ulist
           
 
              items:
                - handle: Unordered item
                  text: Full text for item
                - handle: Unordered item
                  text: Full text for item 2