Skip to content

Commit

Permalink
Further expand README docs in light of 2.1 build support
Browse files Browse the repository at this point in the history
  • Loading branch information
kfranqueiro committed Nov 20, 2024
1 parent 1f224cb commit 99b3fef
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
5 changes: 4 additions & 1 deletion 11ty/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,11 @@ Indicates WCAG version being built, in `XY` format (i.e. no `.`).
Influences which pages get included, guideline/SC content,
and a few details within pages (e.g. titles/URLs, "New in ..." content).
Also influences base URLs for links to guidelines, techniques, and understanding pages.
Explicitly setting this causes the build to reference guidelines and acknowledgements
published under `w3.org/TR/WCAG{version}`, rather than using the local checkout
(which is effectively the 2.2 Editors' Draft).

Possible values: `22` **(default)**, `21`
Possible values: `22`, `21`

### `WCAG_MODE`

Expand Down
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,40 @@ obsoleteMessage: |
In cases where entire technologies are obsolete (e.g. Flash and Silverlight), these properties may also be specified at the technique subdirectory level, e.g. via `techniques/flash/flash.11tydata.json`.
Note that this case specifically requires JSON format, as this is consumed by both Eleventy and additional code in the build process used to assemble techniques data.

## Version-specific Documentation

Informative documents are generated from the same source files for both WCAG 2.2 and 2.1,
as most of their content is consistent between them. (The guidelines themselves continue to be
maintained on separate branches e.g. `WCAG-2.1`, for purposes of maintaining separate Editors' Drafts.)

When building informative documents for older versions, the build system prunes success criteria that are
specific to newer versions, and in turn any techniques that are exclusively related to those criteria.

There are a few cases where content may need to cater to a specific version, explained in this section.

### Specifying Precise Version Number within Informative Documents

**Note:** This is _only_ applicable within `techniques` and `understanding` folders (_not_ `guidelines`).

In cases where the precise version number should be displayed within informative documents,
the syntax `{{ versionDecimal }}` can be used.

### "New in {version}" Call-outs

In cases where a document pertaining to multiple versions warrants a specific call-out about an update in
a newer version, `class="wcagXY"` can be applied to an element surrounding the prose in question
(e.g. `class="wcag22"` for WCAG 2.2). This will result in the prose being omitted from earlier versions,
and displayed with the prefix "New in WCAG X.Y: " in applicable versions.

This class can also be applied alongside the `note` class, in which case " (New in WCAG X.Y)" will be
appended to the "Note" title in applicable versions, and the note will be hidden in earlier versions.

### Techniques Change Log

At the time of writing (Nov 2024), the Change Log in the Techniques index is identical between WCAG 2.1 and 2.2.
These have been split out into separate version-specific includes under `_includes/techniques/changelog/*.html`
for future-proofing in support of building multiple versions of informative documents from the same branch.

## Working Examples

Examples in techniques should be brief easy-to-consume code samples of how the technique is used in content. Therefore examples should focus on the specific features the technique describes, and not include related content such as style, script, surrounding web content, etc.
Expand Down

0 comments on commit 99b3fef

Please sign in to comment.