Name: aria-common
Owner: World Wide Web Consortium
Description: Shared files for the ARIA repositories
Created: 2016-10-21 21:05:26.0
Updated: 2018-01-09 02:30:49.0
Pushed: 2018-01-09 22:06:06.0
Homepage: null
Size: 377
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This is the repository for aria-common. It contains files shared by several other ARIA repositories, and copied into those repositories. Note content must be updated in this repository; changes made in copies would be overwritten next time content from this repository is synced.
Resources in the common files:
The specifications share a common set of term definitions, located in common/terms.html. Add and update terms there, keeping in mind your edits will affect all specifications. To use the terms, at the place you want the terms to be included, provide the following line:
data-include="../common/terms.html" data-oninclude="restrictReferences"></div>
This includes the terms file and filters it to only output ones that are referenced in that particular specification.
The Respec processor loads a bibliography called Specref. This resource automatically includes most publications that have been published to the W3C Technical Reports page. While it is possible to request additions to this via pull requests, in practice to use references that are not in that database, it is easier to use a localBiblio. This allows the Respec configuration to load additional bibliographic entries, structured in the same way as in Specref.
Many of the supplementary bibliographic entries needed for the ARIA publications are common to several specifications. Therefore the bibliographic entries are all stored in common/biblio.js. This is loaded with the other scripts at the top of the file with the following line:
ipt src="../common/biblio.js" class="remove"></script>
In the respecConfig, instead of providing the set of bibliographic entries directly, simply reference the object created by that script:
lBiblio: biblio,
The common directory also contains shared images, CSS, and scripts. Some of the scripts extend the Respec formatting processor, and others are meant to be used with the final output version. When a resource is, or is likely to be, shared, put it in the common directory. Resources specific to a particular specification, including overriding CSS, can be placed in the directory for that specification. Use the same sub-directory structure of img, css, and script to help keep files organized.