You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+47-41Lines changed: 47 additions & 41 deletions
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,10 @@
1
-
# Accessible Rich Internet Applications (WAI-ARIA)
1
+
# Accessible Rich Internet Applications (ARIA)
2
2
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.
14
4
15
5
## Specifications in this repository
16
6
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.
18
8
19
9
* Accessible Rich Internet Applications (aria)
20
10
*[Spec](./index.html)
@@ -56,8 +46,11 @@ This repository contains the main deliverable of the ARIA Working Group, Accessi
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.
61
54
62
55
## Contributing to this Repository
63
56
@@ -80,12 +73,13 @@ Working Group participants and members of the public without commit privileges m
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]).
84
77
85
78
When preparing GitHub pull requests:
86
79
87
80
* 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.
88
81
* 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.
89
83
90
84
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.
91
85
@@ -114,16 +108,19 @@ First, for each document that might be referenced, a set of URLs is provided. Th
114
108
```js
115
109
// Spec URLs
116
110
ariaSpecURLs: {
117
-
"FPWD":"http://www.w3.org/TR/wai-aria-1.1/",
111
+
"FPWD":"http://www.w3.org/TR/wai-aria-1.3/",
118
112
"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/",
120
117
"REC":"http://www.w3.org/TR/wai-aria/"
121
118
},
122
119
```
123
120
124
121
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.
125
122
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:
127
124
128
125
*`ariaSpecURLs`: for the main ARIA spec
129
126
*`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
150
147
151
148
The set of class values currently defined are:
152
149
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
157
154
*`core-mapping`: the Core AAM
158
-
*`html-mapping`: the HTML AAM
159
155
*`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
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.
220
228
221
229
### Special Structures
222
230
223
231
Todo: special characteristics table classes etc. used by the script
224
232
225
233
### Editors' Drafts
226
234
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.
228
236
229
237
### How ARIA Extension Specs are Built
230
238
231
239
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
233
241
built in conjunction with the W3C ARIA WG if any new roles are to be in the default vocabulary space
234
242
(http://www.w3.org/1999/xhtml/vocab).
235
243
@@ -242,31 +250,29 @@ are well integrated into the overall ARIA taxonomy.
242
250
The ariaChild.js script relies upon an input script (aria/script/roleInfo.js). As of today, that file is not automatically generated.
243
251
If you want to ensure the file is up to date, access the core ARIA spec with the special query string "#saveRoles"
244
252
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.
248
254
249
255
### Style guidelines
250
256
251
257
#### Document style
252
258
253
259
* 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 <strong>; 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 <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.
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.
257
263
* Spell out keys such as "control", "shift", "command", "option", "alt", "insert", "pageup", "enter", etc.
258
264
* Use plus as delimiter for keys that are pressed together, e.g., control+v
259
265
* 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.
261
267
* 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 <code>, 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)
263
269
* Headings use title case.
264
270
* "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 (<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.
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.
266
272
* 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.
267
273
* Terms like "Web" are capitalized when it's "the Web", but not when referring to "web applications". Same for "internet, rich internet applications".
268
274
* 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 <abbr> elements):
275
+
* Acronyms we don't expand (but wrap in `<abbr>` elements):
270
276
* API
271
277
* Acronyms we do expand (don't use the acronym)
272
278
* RIA (use rich internet application)
@@ -278,7 +284,7 @@ The scripts to support extension modules are stored in the aria-common repositor
278
284
279
285
* 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.
280
286
* "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)
282
288
* Use "text alternative" instead of "text equivalent" or the like, for consistency with WCAG 2.0 usage.
283
289
* Reference "DOMClick" instead of "DOMActivate" which is going to be deprecated or made optional.
0 commit comments