Skip to content

Commit 1ce030a

Browse files
authored
Merge branch 'main' into add-commandfor-attribute-related-mappings
2 parents 45aa088 + 2742529 commit 1ce030a

File tree

12 files changed

+270
-3130
lines changed

12 files changed

+270
-3130
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,3 +217,6 @@ pip-log.txt
217217

218218
#Mr Developer
219219
.mr.developer.cfg
220+
221+
# Local Netlify folder
222+
.netlify

README.md

Lines changed: 47 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,10 @@
1-
# Accessible Rich Internet Applications (WAI-ARIA)
1+
# Accessible Rich Internet Applications (ARIA)
22

3-
This repository maintains specifications and related publications for the Accessible Rich Internet Applications suite of technologies. This is developed by the [ARIA Working Group](http://www.w3.org/WAI/ARIA/). The W3C staff contact is Daniel Montalvo. Please do not provide commit access to this repository without coordination.
4-
5-
## The default branch has been renamed
6-
7-
If you have a local clone, run the following commands to update the name of the default branch.
8-
9-
```
10-
$ git branch -m master main
11-
$ git fetch origin
12-
$ git branch -u origin/main main
13-
```
3+
This repository maintains specifications and related publications for the Accessible Rich Internet Applications suite of technologies. This is developed by the [ARIA Working Group](http://www.w3.org/WAI/about/groups/ariawg). The W3C staff contact is Daniel Montalvo. Please do not provide commit access to this repository without coordination.
144

155
## Specifications in this repository
166

17-
This repository contains the main deliverable of the ARIA Working Group, Accessible Rich Internet Applications (ARIA), and should be used for issues related to the ARIA spec and and issues that involve both the ARIA spec in conjunction with other specifications maintained by the ARIA working group. All other specifications maintained by ARIA can be found in this repository as well, however, we have separate issue tracking repos for these separate specifications.
7+
This repository contains the main deliverable of the ARIA Working Group, Accessible Rich Internet Applications (ARIA), and should be used for issues related to the ARIA spec as well as issues that involve both the ARIA spec in conjunction with other specifications maintained by the ARIA working group. All other specifications maintained by ARIA can be found in this repository as well, however, we have separate issue tracking repos for these separate specifications.
188

199
* Accessible Rich Internet Applications (aria)
2010
* [Spec](./index.html)
@@ -56,8 +46,11 @@ This repository contains the main deliverable of the ARIA Working Group, Accessi
5646
* [Spec](mathml-aam/index.html)
5747
* [Editor's Draft](https://w3c.github.io/mathml-aam/)
5848
* [Issue Repository](https://github.com/w3c/mathml-aam)
49+
* Portable Document Format Accessibility API Mappings (pdf-aam)
50+
* [Editor's Draft](https://w3c.github.io/pdf-aam/)
51+
* [Issue Repository](https://github.com/w3c/pdf-aam)
5952

60-
In addition to these specifications, there are other deliverables of the [ARIA Contribution](https://www.w3.org/WAI/ARIA/contribute) page. Please file issues in the repository specific to the specification or deliverable to which the issue applies.
53+
In addition to these specifications, there are other deliverables as specified in the [ARIA Charter](https://www.w3.org/2025/01/aria-charter.html). Please file issues in the repository specific to the specification or deliverable to which the issue applies.
6154

6255
## Contributing to this Repository
6356

@@ -80,12 +73,13 @@ Working Group participants and members of the public without commit privileges m
8073
* Raise [issues](https://github.com/w3c/aria/issues/).
8174
* Submit [pull requests](https://help.github.com/articles/using-pull-requests/).
8275

83-
Issues can be assigned to people who are members of the [ARIA Contributors](https://github.com/orgs/w3c/teams/aria-contributors) team. Editors can add people to this team.
76+
Issues can be assigned to people who are members of the [ARIA Contributors](https://github.com/orgs/w3c/teams/aria-contributors) team. If you are an ARIA Working Group participant and need access, ask [Daniel Montalvo](mailto:[email protected]).
8477

8578
When preparing GitHub pull requests:
8679

8780
* Provide a complete summary and description for each pull request. The Working Group needs to understand the rationale for proposed changes. This description may need to be very detailed in some cases, or may be quite brief, for example if providing a change to address a spelling issue.
8881
* Following the editorial documentation below will help prepare a pull request that is ready for inclusion with minimal editing.
82+
* Keep it up-to-date with the base branch, for example by selecting "rebase" under the "Update branch options" menu on the GitHub web interface.
8983

9084
When a pull request is accepted by the Working Group, an editor will integrate changes. Pull requests and issues that are accepted by the working group will be merged into the source documents and the commenter will receive a notification from GitHub that the pull request was accepted.
9185

@@ -114,16 +108,19 @@ First, for each document that might be referenced, a set of URLs is provided. Th
114108
```js
115109
// Spec URLs
116110
ariaSpecURLs: {
117-
"FPWD": "http://www.w3.org/TR/wai-aria-1.1/",
111+
"FPWD": "http://www.w3.org/TR/wai-aria-1.3/",
118112
"ED": "http://w3c.github.io/aria/aria/aria.html",
119-
"WD" : "http://www.w3.org/TR/wai-aria-1.1/",
113+
"WD": "http://www.w3.org/TR/wai-aria-1.3/",
114+
"CR": "http://www.w3.org/TR/wai-aria/"
115+
"CRD": "http://www.w3.org/TR/wai-aria/"
116+
"PR": "http://www.w3.org/TR/wai-aria/",
120117
"REC": "http://www.w3.org/TR/wai-aria/"
121118
},
122119
```
123120

124121
Note that even though some of these URIs are redundant, they must all be defined to work in all circumstances. If a document is a First Public Working Draft but the FPWD variant isn't defined, there won't be a match with the `specStatus` and the links won't work.
125122

126-
The following properties for cross references are currently available *(todo: we should add versions for the other docs)*:
123+
The following properties for cross references are currently available:
127124

128125
* `ariaSpecURLs`: for the main ARIA spec
129126
* `coreMappingURLs`: for the Core AAM
@@ -150,22 +147,33 @@ If you want to target the main spec, leave the href blank (but present). If you
150147

151148
The set of class values currently defined are:
152149

153-
* `role-reference`: role definitions
154-
* `state-reference`: state definitions
155-
* `property-reference`: property definitions
156-
* `specref`: other targets in the main ARIA spec
150+
* `role-reference`: ARIA role definitions
151+
* `state-reference`: ARIA state definitions
152+
* `property-reference`: ARIA property definitions
153+
* `specref`: other ARIA references
157154
* `core-mapping`: the Core AAM
158-
* `html-mapping`: the HTML AAM
159155
* `accname`: the AccName AAM
160-
161-
*Todo: we should add versions for the other docs*
156+
* `html-mapping`: the HTML AAM
157+
* `dpub-role-reference`: DPUB-ARIA role definitions
158+
* `dpub-property-reference`: DPUB-ARIA property definitions
159+
* `dpub-state-reference`: DPUB-ARIA state definitions
160+
* `dpub`: other DPUB-ARIA references
161+
* `graphics-role-reference`: Graphics-ARIA role definitions
162+
* `graphics-property-reference`: Graphics-ARIA property definitions
163+
* `graphics-state-reference: Graphics-ARIA state definitions
164+
* `graphics-role-mapping`: Graphics role mapping
165+
* `graphics-property-mapping`: GRAPHICS property mapping
166+
* `graphics-state-mapping`: GRAPHICS staet mapping
167+
* `graphics-mapping`: other GRAPHIC mapping references
168+
* `graphics`: other Graphics-ARIA references
169+
* `practices`: ARIA Practices
162170

163171
#### References to Other W3C Specs
164172

165173
When referencing other W3C specifications such as
166174
href="https://html.spec.whatwg.org/">HTMLa> and
167175
href="https://dom.spec.whatwg.org/">DOMa>, we can take advantage of ReSpec’s
168-
<a href="https://github.com/w3c/respec/wiki/xref">`xref`a> feature to
176+
<a href="https://github.com/speced/respec/wiki/xref">`xref`a> feature to
169177
automatically generate canonical links in context.
170178

171179
In the text below, for example, `xref` will automatically convert “`[^button^]`
@@ -212,24 +220,24 @@ Internationalization Glossary specs](https://respec.org/xref/?term=range). The
212220
the intended spec.
213221

214222
For more information, please refer to [`xref`’s auto-linking external references
215-
guide](https://github.com/w3c/respec/wiki/Auto-linking-external-references).
223+
guide](https://github.com/speced/respec/wiki/Auto-linking-external-references).
216224

217225
### Shared Resources
218226

219-
The ARIA repositories share a common set of resources to reduce redundancy. Shared resources are in the [aria-common](https://github.com/w3c/aria-common/) repository, and copied to a "common" folder in this and other ARIA repositories. *It is important to make edits in the aria-common repository*; making edits in the common folder of another repository will allow the edits to be overridden.
227+
The ARIA repositories share a common set of resources to reduce redundancy. Shared resources are in the [common](./common/) directory, and copied to every child spec at built time.
220228

221229
### Special Structures
222230

223231
Todo: special characteristics table classes etc. used by the script
224232

225233
### Editors' Drafts
226234

227-
Official editors' drafts are published to [https://w3c.github.io/aria/]. This URI is suitable for public references. Documents published to that location are *static* snapshots from the Respec processor. This is to minimize load time for consumers of these drafts. Editors' drafts are automatically updated (if there are no errors) by a [Travis-CI](https://travis-ci.org/) service run when commits are pushed to the master branch.
235+
Official editors' drafts are published to [https://w3c.github.io/<shortName>/], where `shortName` is the value of `respecConfig.shortName` for each of the specs. This URIs are suitable for public references. Documents published to those locations are *static* snapshots from the Respec processor. This is to minimize load time for consumers of these drafts. Editors' drafts are automatically updated (if there are no errors) by GitHub actions run when commits are pushed to the main branch.
228236

229237
### How ARIA Extension Specs are Built
230238

231239
An extension spec is one that defines additional roles, states, and / or properties that augment
232-
the collection defined in the core ARIA specification (aria/aria.html). Extension specs must be
240+
the collection defined in the core ARIA specification (index.html). Extension specs must be
233241
built in conjunction with the W3C ARIA WG if any new roles are to be in the default vocabulary space
234242
(http://www.w3.org/1999/xhtml/vocab).
235243

@@ -242,31 +250,29 @@ are well integrated into the overall ARIA taxonomy.
242250
The ariaChild.js script relies upon an input script (aria/script/roleInfo.js). As of today, that file is not automatically generated.
243251
If you want to ensure the file is up to date, access the core ARIA spec with the special query string "#saveRoles"
244252
from a browser on a client that has write access to the copy of the extension spec you are editing. When the dialog appears, click
245-
the save button and tell your browser to save the roleInfo.js file into the aria/script directory.
246-
247-
The scripts to support extension modules are stored in the aria-common repository. Therefore, updates to roleInfo.js must be saved and committed to that repository, even though they are generated from content in this repository.
253+
the save button and tell your browser to save the roleInfo.js file into the [common/script](./common/script directory.
248254

249255
### Style guidelines
250256

251257
#### Document style
252258

253259
* There should always be introductory content before starting subsections.
254-
* Sequences of steps use ordered lists, the first paragraph of which labels the step and is in a &lt;strong&gt;; subsequent block elements are the content for the step.
255-
* Preformatted examples should "pretty-print" the example to be less than 80 characters wide, and indent the code using 2 space characters per indent step. Wrap within an element tag with an extra indent. Use line break characters, not &lt;br/&gt; elements, for new lines. Add extra line spacing as useful. They use the class "example". Use the Code Sample Expander tool to assist with this.
256-
* Keyboard characters should be in kbd elements.
260+
* Sequences of steps use ordered lists, the first paragraph of which labels the step and is in a `<strong>`; subsequent block elements are the content for the step.
261+
* Preformatted examples should "pretty-print" the example to be less than 80 characters wide, and indent the code using 2 space characters per indent step. Wrap within an element tag with an extra indent. Use line break characters, not `<br/>` elements, for new lines. Add extra line spacing as useful. They use the class "example". Use the Code Sample Expander tool to assist with this.
262+
* Keyboard characters should be in `<kbd>` elements.
257263
* Spell out keys such as "control", "shift", "command", "option", "alt", "insert", "pageup", "enter", etc.
258264
* Use plus as delimiter for keys that are pressed together, e.g., control+v
259265
* Use comma as delimiter for keys that are pressed in sequence, e.g., insert, m
260-
* Language elements should be in code elements.
266+
* Language elements should be in `<code>` elements.
261267
* The first reference in a section to a role or state should be linked to the role or state with the appropriate class. Subsequent references needn't be referenced, but may be in certain circumstances.
262-
* repeated links to aria features should just be in &lt;code&gt;, not in cross-reference links (just link first time)
268+
* Repeated links to aria features should just be in `<code>`, not in cross-reference links (just link first time)
263269
* Headings use title case.
264270
* "step" headings, the bold sentence at the start of a numbered list item in a list of steps, are sentence case and not marked as an actual hx element. They should summarize what the following paragraphs get into.
265-
* Subheadings: only use sub-headers (&lt;h{x+1}&gt; following &lt;hx&gt;) if there are at least two of them. If there isn't more than two sub-sections, it isn't a sub-section and should be integrated into the parent section.
271+
* Subheadings: only use sub-headers (`<h{x+1}> following `<hx>) if there are at least two of them. If there isn't more than two sub-sections, it isn't a sub-section and should be integrated into the parent section.
266272
* Lists: only use lists of two or more items. If it's only one item, it isn't a list and should have a different semantic.
267273
* Terms like "Web" are capitalized when it's "the Web", but not when referring to "web applications". Same for "internet, rich internet applications".
268274
* Synopsize the meaning of abbreviations and glossary terms the first time they are used in a section.
269-
* Acronyms we don't expand (but wrap in &lt;abbr&gt; elements):
275+
* Acronyms we don't expand (but wrap in `<abbr>` elements):
270276
* API
271277
* Acronyms we do expand (don't use the acronym)
272278
* RIA (use rich internet application)
@@ -278,7 +284,7 @@ The scripts to support extension modules are stored in the aria-common repositor
278284

279285
* When referring to an instance of a role, use "element with a role of X", not "X role" or "X element". "X role" refers to role in the taxonomy itself; "X element" is not technically meaningful.
280286
* "Assistive technologies" is plural, not singular.
281-
* Use "WAI-ARIA" instead of "ARIA", to avoid trademark confusion.
287+
* If in doubt as to when to use "ARIA" or "WAI-ARIA", see [use of ARIA as word instead of abbreviation](https://github.com/w3c/aria/discussions/2441)
282288
* Use "text alternative" instead of "text equivalent" or the like, for consistency with WCAG 2.0 usage.
283289
* Reference "DOMClick" instead of "DOMActivate" which is going to be deprecated or made optional.
284290

0 commit comments

Comments
 (0)