Consistent linking 185 #210
Conversation
Add direct link for first reference. Using ARIA 1.1 spec as inspiration
Left off at Test Target definition.
Redundant links for http11 and DOM removed.
|
Updating links to internal term definitions as well as external informative and normative references. Used WAI-ARIA 1.1 as inspiration and guidance. (https://www.w3.org/TR/wai-aria-1.1/)
|
|
This is to meet Issue #185 Consistent Linking of defined terms. Note: also removed italics from terms. And if a term reference is in a list, added a link. |
|
Please review HTML version of the file, https://w3c.github.io/wcag-act/act-format-185-consistent-linking.html |
|
Currently we are being inconsistent in our linking to TRs. Siteimprove propose consistently linking to non-versioned TRs. This would mean that any link to WCAG 2.0 would link to WCAG 2 e.g. https://www.w3.org/TR/WCAG/ |
|
@skotkjerra Thank you. I will work on those changes to point to use non-versioned TRs where possible. Appreciate your feedback. Moe |
|
In section 9.1 Implementation validation, I'd recommend link text should read "test targets" instead of "pointer" |
Link goes to Test Target section but it's link text reads pointers. Changing to test targets.
act-rules-format.bs
Outdated
| @@ -15,21 +15,21 @@ Markup Shorthands: markdown yes | |||
| Introduction {#intro} | |||
| ===================== | |||
|
|
|||
| There are currently many tools available which aid their users in testing web content for conformance to accessibility standards such as the Web Content Accessibility Guidelines (WCAG). As the web develops in both size and complexity, these tools are essential for managing the resources available on the web. | |||
| There are currently many tools available which aid their users in testing web content for conformance to accessibility standards such as the [Web Content Accessibility Guidelines (WCAG) 2.0](https://www.w3.org/TR/WCAG20/) [[WCAG20]]. As the web develops in both size and complexity, these tools are essential for managing the resources available on the web. | |||
There was a problem hiding this comment.
I recommend dropping the version number "2.0", and to use this link to the overview for WCAG instead: https://www.w3.org/WAI/intro/wcag
There was a problem hiding this comment.
Hi Shadi, per Stein Erik's recommendation I used the non-versioned TR link, https://www.w3.org/TR/WCAG/
There was a problem hiding this comment.
As per 5/31 meeting, updating to overview page, https://www.w3.org/WAI/standards-guidelines/wcag/
act-rules-format.bs
Outdated
|
|
||
| Describing how to test certain accessibility requirements will result in accessibility tests that are transparent with test results that are reproducible. The Accessibility Conformance Testing (ACT) Rules Format defines the requirements for these test descriptions, known as Accessibility Conformance Testing Rules (ACT Rules). | ||
|
|
||
|
|
||
| Scope {#scope} | ||
| ============== | ||
|
|
||
| The ACT Rules Format defined in this specification is focused on the description of rules applicable to content created using web technologies, such as HTML, CSS, WAI-ARIA, SVG and more, including digital publishing. The ACT Rules Format, however, is designed to be technology agnostic, meaning that it can conceivably be used to describe test rules for other technologies. | ||
| The ACT Rules Format defined in this specification is focused on the description of rules applicable to content created using web technologies, such as [Hypertext Markup Language](https://www.w3.org/TR/html5/) [[HTML5]], [Cascading Style Sheets](https://www.w3.org/TR/CSS2/) [[CSS21]], [Accessible Rich Internet Applications](https://www.w3.org/TR/wai-aria-1.1/) [[WAI-ARIA-1.1]], [Scaleable Vector Graphics](https://www.w3.org/TR/SVG2/) [[SVG2]] and more, including digital publishing. The ACT Rules Format, however, is designed to be technology agnostic, meaning that it can conceivably be used to describe test rules for other technologies. |
There was a problem hiding this comment.
Please also use this link for WAI-ARIA instead: https://www.w3.org/WAI/intro/aria
There was a problem hiding this comment.
Hi Shadi, per Stein Erik's recommendation I used the non-versioned TR link. https://www.w3.org/TR/wai-aria/
There was a problem hiding this comment.
Per 5/31 meeting setting link to WAI-ARIA overview page.
There was a problem hiding this comment.
act-rules-format.bs
Outdated
|
|
||
| Other accessibility requirements applicable to web technologies can also be testable with ACT Rules. For example, ACT Rules could be developed to test the conformance of web-based user agents to the User Agent Accessibility Guidelines. However, the ACT Rules Format would not necessarily be suitable to describe tests for the conformance of a non-web-based user agent. | ||
| Other accessibility requirements applicable to web technologies can also be testable with ACT Rules. For example, ACT Rules could be developed to test the conformance of web-based user agents to the [User Agent Accessibility Guidelines](https://www.w3.org/TR/UAAG20/) [[UAAG20]]. However, the ACT Rules Format would not necessarily be suitable to describe tests for the conformance of a non-web-based user agent. |
There was a problem hiding this comment.
Also for UAAG: https://www.w3.org/WAI/intro/uaag
There was a problem hiding this comment.
Interesting, I updated to the non-version TR however this goes to UAAG 1.0. Will take your recommendation but inconsistent with the other links which always go to the latest spec.
There was a problem hiding this comment.
Something good to bring up on Thursday's call.
act-rules-format.bs
Outdated
| @@ -64,7 +64,7 @@ An ACT Rule MUST have a description that is in plain language and provides a bri | |||
| Accessibility Requirements {#structure-accessibility-requirements} | |||
| ------------------------------------------------------------------- | |||
|
|
|||
| An ACT Rule MUST identify the accessibility requirements to which the rule maps. For example, WCAG 2.0 Success Criterion 1.1.1. An ACT Rule is a complete or partial test for one or more accessibility requirements. | |||
| An ACT Rule MUST identify the accessibility requirements to which the rule maps. For example, [WCAG 2.0 Success Criterion 1.1.1](https://www.w3.org/TR/2008/REC-WCAG20-20081211/#text-equiv-all) [[WCAG20]]. An ACT Rule is a complete or partial test for one or more accessibility requirements. | |||
There was a problem hiding this comment.
Not certain about this, but would it be better to link to the "How to Meet WCAG 2.0" quick reference guide instead of the static TR doc? https://www.w3.org/WAI/WCAG20/quickref/#text-equiv-all
There was a problem hiding this comment.
Let's raise this for discussion on Thursday's call. Thanks, Moe.
act-rules-format.bs
Outdated
| @@ -74,96 +74,96 @@ The actual definition of specific accessibility requirements is beyond the scope | |||
| Limitations, Assumptions or Exceptions {#structure-limitations-assumptions-exceptions} | |||
| ------------------------------------------------------------------- | |||
|
|
|||
| An ACT Rule MUST list any limitations, assumptions or any exceptions for the test, the test environment, technologies being used or the subject being tested. For example, a rule for Success Criterion 1.4.1: Use of Color has to make an assumption that CSS is used to make a link visually evident - typically by using CSS background, border, color, font, or text-decoration properties. | |||
| An ACT Rule MUST list any limitations, assumptions or any exceptions for the test, the test environment, technologies being used or the subject being tested. For example, a rule for [WCAG 2.0 Success Criterion 1.4.1: Use of Color](https://www.w3.org/TR/2008/REC-WCAG20-20081211/#visual-audio-contrast-without-color) [[WCAG20]] has to make an assumption that CSS is used to make a link visually evident - typically by using CSS background, border, color, font, or text-decoration properties. | |||
There was a problem hiding this comment.
Same question here - QuickRef vs TR?
act-rules-format.bs
Outdated
|
|
||
| <div class=example> | ||
| Output data using EARL and JSON-LD | ||
| Output data using EARL and JSON-LD. (See [Evaluation and Report Language (EARL) 1.0](https://www.w3.org/TR/EARL10-Schema/) [[EARL10-Schema]] and [Java Script Object Notation (JSON)](https://www.json.org).) |
There was a problem hiding this comment.
I suggest using this link to the overview page for EARL: https://www.w3.org/WAI/intro/earl
Removed version specific links to informative and normative references WCAG 2.0, WAI-ARIA 1.1, SVG 2, CSS 2. Replaced with non-version specific links.
Keeping generic TR link, https://www.w3.org/TR/CSS/, but need specific preprocessor tag to add to reference. Using CSS 2.
Reverting to SVG2
Also remove version from HTML and UAAG and ARIA references.
|
@skotkjerra Hi Stein Erik, I have been able to successfully update the TR links to non-versioned links, however, not all specifications have non-versioned biblio reference tags. For example, SVG comes up obsolete and CSS fails. I reverted to using SVG2 and CSS2 for the biblio references. Please advise. Thanks, |
Using UAAG20
Since generic TR link does not go to latest UAAG, using link working group home page instead.
Per Shadi's recommendation going to https://www.w3.org/WAI/intro/earl
Reverting to EARL10-Schema
|
Posted updated ACT Rules Format on gh-pages, https://w3c.github.io/wcag-act/act-format-185-consistent-linking.html Outstanding issues:
|
act-rules-format.bs
Outdated
|
|
||
|
|
||
| Accessibility Support {#acc-support} | ||
| =========================== | ||
|
|
||
| ACT Rules are designed to test accessible uses of a web technology. However, not every part of a web technology is implemented in all assistive technologies a website may need to support. The concept of [accessibility supported](https://www.w3.org/TR/WCAG20/#accessibility-supporteddef) use of a Web technology is defined in [[WCAG20]]. Because of this, ACT Rules are not necessarily applicable in all test scenarios. For instance, a web page that has to work in assistive technologies that have no WAI-ARIA support, wouldn’t be tested with an ACT Rule that relies on WAI-ARIA support, since this could lead to false positive results. |
There was a problem hiding this comment.
This paragraph still contains a reference to WAI-ARIA-1.1; should be WAI-ARIA.
There was a problem hiding this comment.
Good catch. Thanks.
There was a problem hiding this comment.
Waiting for confirmation from group if we should link to TR or overview page.
|
|
||
| Describing how to test certain accessibility requirements will result in accessibility tests that are transparent with test results that are reproducible. The Accessibility Conformance Testing (ACT) Rules Format defines the requirements for these test descriptions, known as Accessibility Conformance Testing Rules (ACT Rules). | ||
|
|
||
|
|
||
| Scope {#scope} | ||
| ============== | ||
|
|
||
| The ACT Rules Format defined in this specification is focused on the description of rules applicable to content created using web technologies, such as HTML, CSS, WAI-ARIA, SVG and more, including digital publishing. The ACT Rules Format, however, is designed to be technology agnostic, meaning that it can conceivably be used to describe test rules for other technologies. |
There was a problem hiding this comment.
The non-versioned SpecRef entry for SVG is simply SVG, which is the current W3C Recommendation.
There was a problem hiding this comment.
Same for CSS2, I don't think these have to link to the versioned spec.
|
It might be more appropriate to link to the CSSOM spec, or the latest CSS snapshot, whenever CSS is mentioned rather than CSS2? |
|
|
||
|
|
||
| Common Aspects {#input-aspects-common} | ||
| -------------------------------------- | ||
|
|
||
| ### HTTP Messages ### {#input-aspects-http} | ||
|
|
||
| The HTTP messages exchanged between a client and a server as part of requesting a web page may be of interest to ACT Rules. For example, analyzing HTTP messages to perform validation of HTTP headers or unparsed HTML and CSS. | ||
| The HTTP messages [[http11]] exchanged between a client and a server as part of requesting a web page may be of interest to ACT Rules. For example, analyzing HTTP messages to perform validation of HTTP headers or unparsed HTML [[HTML]] and CSS [[CSS2]]. |
There was a problem hiding this comment.
Should we refer to HTTP 1.1 or HTTP/2?
There was a problem hiding this comment.
I would suggest we don't put a version in.
There was a problem hiding this comment.
It would be nice not to tie to a particular version. However, then what do we link to for the reference?
Updated WAI links to point to overview pages per ACT TF review during 5/24 & 5/31 meetings
Link to Quickref for SC 1.1.1 and 1.4.3
Updated biblio reference to point to non-versioned WAI-ARIA
Fixed broken link for test subject under Rule Aggregation
|
No description provided.