Managing Indices and Coverage Reports

About APG Indices and Coverage Reports

The appendix includes indices that enable readers to find examples that use a specific role, state, or property. The index tables are built by the scripts/reference-tables.js script. The script parses the documentation tables on the example pages to determine which roles, states, and properties are used in each example.

The root directory of the repository includes a directory named coverage that contains coverage reports. These reports list the roles, states, and properties that do not have guidance or examples. And, for those that are covered, it provides an index of the coverage. These reports are generated by running node scripts/coverage-reports.js. The script looks for headings that contain the names of roles, states, and properties.

Manually adding a role or property reference

The following attributes can be placed on headings in the practices document to indicate the presence of guidance for an aria role, property, or state:

• data-aria-roles: Set to a space separated list of role names.
• data-aria-props: Set to a space separated list of property and state names.