DOCSEARCHbyAlgolia
Submit Docs

W3C Silver Accessibility Guidelines

repository·main·Indexed 42 days ago

https://github.com/w3c/silver

Development repository for the Silver project by the W3C, focusing on the creation of new accessibility guidelines and WCAG 3.0 how-tos. Includes documentation for the Conformance, Flavor, and Plain Language prototypes, as well as guidelines for contributing new prototypes and structuring guideline content.

Tokens
2.1K
Snippets
5
Records
16
Agent score
52%

What's inside Silver

  1. Overview of the Plain Language Prototype

    main
    The Plain Language prototype demonstrates how different 'flavors' of accessibility implementations can be included within Silver. Specifically, it showcases various ways to implement WCAG 2.0 SC 1.1.1 (Non-Visual Text), illustrating that different technologies can satisfy the same success criterion in diverse ways.

  2. Overview of the Flavor Prototype

    main
    The Flavor Prototype is a demonstration of how different 'flavors' (implementation variations) can be included within Silver. It specifically uses WCAG 2.0 SC 1.1.1 (Non-Visual Text) to illustrate how the same Success Criterion can be implemented using different technologies, making the various possibilities clearer to users.

  4. Overview of the Conformance Prototype

    main

    The Conformance Prototype is a structural model designed to help Silver meet the needs of people with disabilities, evolving technology, and regulatory requirements for clear compliance measurement. The prototype is organized into three primary functional areas:

    1. Compliance: Focuses on the regulatory and standard-based aspects of conformance.
    2. Measurement: Focuses on the methodologies and data used to quantify conformance.
    3. Accessibility Supported: Focuses on the specific accessibility features and capabilities supported by a given implementation.

    This prototype is based on Silver research (2017-2018), the Silver Design Sprint (March 2018), and the AccessU Prototyping session (May 2018).

  5. Overview of the Silver project

    main
    Silver is an accessibility guidelines project developed by the Silver Task Force, which is part of the W3C Accessibility Guidelines Working Group and the Silver Community Group. The project focuses on developing new accessibility guidelines.

  6. List of existing Silver prototypes

    main

    The following prototypes are currently being developed as part of the Silver design and structure exploration:

    • ConformancePrototype: Developed by @jspellman. Based on Silver Design Sprint, member input, and AccessU meeting public input. (Status: In Progress)
    • Flavor Prototype: Developed by @mikecrabb. Demonstrates the possibility of different technology flavors for Silver. (Status: In Progress)

    Note: For the most up-to-date list, explore the /prototypes/ folder directly via the GitHub Code tab.

  7. Structure of a How-To directory

    main

    Each how-to is contained within its own sub-directory and consists of a set of standard HTML files that are processed by a generator.

    Standard Files:

    • index.html: The entry point for the how-to.
    • get-started.html: Initial steps for implementing the guideline.
    • plan.html: Planning guidance.
    • design.html: Design-related guidance.
    • develop.html: Development-related guidance.
    • examples.html: Practical examples of the guideline in use.
    • resources.html: Additional resources for the guideline.

  8. Develop the PlainLanguage prototype using Jekyll

    main

    The PlainLanguage prototype is built using Jekyll. To ensure proper development and deployment, follow these rules:

    1. Do not edit files directly in the site folder. Always edit the source files in the main directory and regenerate the site.
    2. Regenerate the site using the command jekyll serve to see changes.
    3. Deployment/Routing: Because Jekyll has difficulty running within subdirectories, links to this prototype should be routed through the site folder (note: the folder is named site instead of the default _site to avoid being hidden by Jekyll during git operations).

    Important Note on Folder Naming: Normally, Jekyll uses a _site folder which is included in .gitignore. To ensure this prototype is visible and committable, the folder has been renamed to site.

    jekyll serve

  9. Create a new WCAG 3.0 How-To

    main

    To create a new how-to, copy the existing template directory and its contents within the how-tos/ directory.

    Naming Convention: Name the new folder using the short name of the guideline, following these rules:

    1. Convert the name to lowercase.
    2. Replace all punctuation and whitespace with hyphens (-).

    Example: "Text Alternatives" becomes text-alternatives.

  10. Develop and build the Flavor Prototype with Jekyll

    main

    This prototype uses Jekyll for development. Follow these rules to avoid common issues with subdirectories and build outputs:

    1. Development Workflow: Never edit files directly inside the site folder. Always edit the source files in the main directory and then regenerate the site using jekyll serve.
    2. Handling the Build Folder: Jekyll typically names the output folder _site, but this can cause routing issues when the prototype is in a subdirectory.
      • Rename the _site folder to site before committing to the repository.
      • Ensure the site folder is not being hidden by Jekyll's default behavior.
    3. Routing: Links to this prototype should be routed through the site folder.
    # To regenerate the site after making changes to source files
jekyll serve

  11. Develop the Plain Language prototype using Jekyll

    main

    This prototype is built using Jekyll. Follow these steps to develop and serve the site correctly:

    1. Avoid editing the site folder directly: Always edit the main source files. To apply changes, regenerate the site using the jekyll serve command.
    2. Handling the output folder: Jekyll typically outputs to a _site folder, which is often ignored by git. To ensure links work correctly in this prototype, the output folder should be routed through the _site folder.
    3. Git configuration: Because Jekyll hides _site folders, rename the _site folder to site before committing your changes to the repository.
    jekyll serve
# After editing source files, rename the output folder for git
mv _site site

  12. How to contribute a new Silver prototype

    main

    To contribute a new prototype to the Silver Community Group repository, follow these structural and workflow requirements:

    1. Research: Before starting, review the Suggestions from the Design Sprint and the Design Sprint Report to align with the intended direction of Silver (the successor to WCAG).
    2. Branching: Create a new branch using the naming convention: prototype-[short-name-of-prototype].
    3. Directory Structure: Place the prototype in its own dedicated folder within the /prototypes/ directory.
    4. Entry Point: The prototype must be accessible via an index.html file located in the prototype's folder.
    5. Documentation: Include a readme.md file within the prototype folder using the provided template to document relevant information.