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
Please do not submit any new pull requests against this branch - please look in the list of branches for the most current Working Branch and use that one.
5
5
6
-
This repository is used to develop the success criteria proposal for wcag 2.1, as well as associated understanding documents and techniques.
6
+
This repository is used to develop content for WCAG 2, as well as associated understanding documents and techniques.
7
7
8
8
## File Structure
9
9
10
-
The WCAG 2.1 repository contains source and auxiliary files for WCAG 2.1, Understanding WCAG 2.1, and eventually techniques, along with some content from WCAG 2.0 for context. It also contains auxiliary files that support automated formatting of the document. To facilitate multi-party editing, each success criterion is in a separate file, consisting of a HTML fragment that can be included into the main guidelines. Key files include:
10
+
WCAG 2.0 was maintained in a different file structure than subsequent versions of WCAG. Source files for WCAG 2.0 are in the wcag20 folder and exists primarily for archival purposes. Do not edit content in that folder.
11
11
12
-
* guidelines/index.html - the main guidelines file
13
-
* guidelines/sc/21/*.html - files for each success criterion
14
-
* guidelines/terms/21/*.html - files for each definition
15
-
* understanding/21/*.html - understanding files for each success criterion
12
+
Content for WCAG 2.1 and later is organized accordign to the file structure below. The WCAG repository contains source and auxiliary files for WCAG 2, Understanding WCAG 2, and eventually techniques. It also contains auxiliary files that support automated formatting of the document. To facilitate multi-party editing, each success criterion is in a separate file, consisting of a HTML fragment that can be included into the main guidelines. Key files include:
16
13
17
-
## Review Links
18
-
19
-
Review links have been [put at the top of each issue](https://lists.w3.org/Archives/Public/w3c-wai-gl/2017JanMar/1200.html) tracking the success criterion proposal. The pattern for review links is:
14
+
* guidelines/index.html - the main guidelines file
15
+
* guidelines/sc/<version>/*.html - files for each success criterion
16
+
* guidelines/terms/<version>/*.html - files for each definition
17
+
* understanding/<version>/*.html - understanding files for each success criterion
20
18
21
-
* SC for viewing: https://rawgit.com/w3c/wcag21/{branchname}/guidelines/sc/21/{scfile}.html
22
-
* SC for editing: https://github.com/w3c/wcag21/blob/{branchname{/guidelines/sc/21/{scfile}.html
23
-
* Term for viewing: https://rawgit.com/w3c/wcag21/{branchname}/guidelines/terms/21/{termfile}.html
24
-
* Term for editing: https://github.com/w3c/wcag21/blob/{branchname{/guidelines/terms/21/{termfile}.html
25
-
* SC in context of full guidelines: https://rawgit.com/w3c/wcag21/branchname/guidelines/#{scfile}
19
+
Where <version> is "20", content came from WCAG 2.0. "21" is used for content introduced in WCAG 2.1, "22" for WCAG 2.2, etc.
26
20
27
21
## Editing Draft Success Criteria
28
22
29
23
[Success Criteria Managers](https://www.w3.org/WAI/GL/wiki/SC_Managers_Phase1) will prepare candidate success criteria, ready for inclusion in the guidelines document. To prepare success criteria, follow these steps:
30
24
31
-
<!--1. [Fork this repository](https://help.github.com/articles/fork-a-repo/) or, if you have already forked it, [update your fork](https://help.github.com/articles/syncing-a-fork/). It is important to keep your fork up to date to avoid merge conflicts.-->
32
25
1.[Clone the repository](https://help.github.com/articles/cloning-a-repository/), using the URI https://github.com/w3c/wcag21.git to clone.
33
26
1. Switch to the working branch for the proposal, which is named for the shortname of the draft success criterion and the issue number, concatenated together.
34
27
1. Find the appropriate file for the success criterion in the guidelines/sc/21 folder, named the same as the start of the branch name, and open in an HTML-capable editor. Do the same with any definitions referenced by the success criterion, in the guidelines/terms/21 folder.
@@ -94,13 +87,13 @@ The ```dfn``` element tells the script that this is a term and causes special st
94
87
There is one Understanding file per success criterion, plus an index:
95
88
96
89
* understanding/index.html - index page, need to uncomment or add a reference to individual Understanding pages as they are made available
97
-
* understanding/21/*.html - files for each understanding page, named the same as the success criterion file in the guidelines
90
+
* understanding/<version>/*.html - files for each understanding page, named the same as the success criterion file in the guidelines
98
91
99
92
Files are populated with a template that provides the expected structure. Leave the template structure in place, and add content as appropriate within the sections. Elements with class="instructions" provide guidance about what content to include in that section; you can remove those elements if you want but don't have to. The template for examples proposes either a bullet list or a series of sub-sections, choose one of those approaches and remove the other from the template. The template for techniques includes sub-sections for "situations", remove that wrapper section if not needed.
100
93
101
-
Understanding files are referenced from the relevant Success Criterion on the WCAG 2.1 page; these links are put in by the script.
94
+
Understanding files are referenced from the relevant Success Criterion on the WCAG specification; these links are put in by the script.
102
95
103
-
The formal publication location for Understanding pages is https://www.w3.org/WAI/WCAG21/Understanding/. This content is updated as needed; and may be automated.
96
+
The formal publication location for Understanding pages is currently https://www.w3.org/WAI/WCAG21/Understanding/. This content is updated as needed; and may be automated.
104
97
105
98
## Editing Techniques
106
99
@@ -113,16 +106,11 @@ For example, a technique "Using the alt attribute on the img element to provide
113
106
* Determine a filename for the technique that is likely to be descriptive, unique, and short.
114
107
* Create a working branch named the same as the technique filename.
115
108
* Copy the techniques/technique-template.html file into the appropriate technology folder for the technique, and give it the chosen file name.
109
+
* In the section element with id "meta", indicate to which guideline or success criterion the technique relates, and whether the technique is sufficient, advisory, or a failure for that item. Multiple applicability are allowed.
116
110
* Populate the template with appropriate content, using other techniques as examples for code formatting choices. Keep the existing structural sections from the template in place.
117
111
* When the technique is ready for review, ask the chairs to arrange WG review and merge.
118
-
119
-
### Associate Techniques with Success Criteria
120
-
121
-
PROPOSED: edit the [wcag21.json](wcag21.json) file to add a technique entry into each SC where appropriate. Entries can declare the technique to be sufficient, advisory, or failure on a per SC basis. The (proposed) generator will use this to provide links in the various places needed.
122
-
123
-
ALTERNATE: create a HTML-based data structure, which would be easier to read but harder to edit correctly.
124
-
125
-
ALTERNATE: link to techniques from Understanding as we have done before, but this allows inconsistencies and is harder to extract data from.
112
+
* If you wish to reference the draft technique from an Understanding document, use the technique's rawgit URI.
113
+
* After a technique is approved, the chairs will assign it an ID and update links to it in the Undestanding documents.
0 commit comments