Rule update: "HTML page has a title" #440

annethyme · 2019-03-14T10:27:07Z

"contain" --> "descendant" in Expectation 1.
Editorial cleanup of "Background" links

Closes issue: #316

How to Review And Approve

Go to the “Files changed” tab
Here you will have the option to leave comments on different lines.
Once the review is completed, find the “Review changes” button in the top right, select “Approve” (if you are really confident in the rule) or "Request changes" and click “Submit review”.

"contain" --> "descendant" in Expectation 1. Editorial cleanup of "Background"

kasperisager · 2019-03-18T13:52:57Z

_rules/SC2-4-2-page-has-title.md

@@ -28,13 +28,13 @@ The rule applies to any page where the root element is an `html` element, and wh

 ### Expectation 1

-The page contains at least one `title` element.
+The root element has at least one [descendant](https://www.w3.org/TR/dom41/#concept-tree-descendant) that is an HTML `title` element.


"root" -> https://www.w3.org/TR/dom41/#concept-tree-root

Now linking to definition of "root" in both Applicability and Expectation

audreymaniez

Ok! I just add a suggestion about a technique.

audreymaniez · 2019-03-20T05:31:16Z

_rules/SC2-4-2-page-has-title.md

- [https://www.w3.org/TR/WCAG20-TECHS/H25.html](https://www.w3.org/TR/WCAG20-TECHS/H25.html)
- The WCAG 2.0 Techniques already contain examples and code snippets to illustrate which content passes or fails the test. Whenever possible {{site.title}} refers to those. Another source for test cases is the W3C Before and After Demonstration.
+- [Understanding Success Criterion 2.4.2: Page Titled](https://www.w3.org/WAI/WCAG21/Understanding/page-titled.html)
+- [WCAG 2.1 Technique G88: Providing descriptive titles for Web pages](https://www.w3.org/WAI/WCAG21/Techniques/general/G88)


Is this technique G88 really relate to that rule ? It seems the G88 is for the rule you write in the #380 PR ? I just suggest remove the relation for less confusion on the scope of the rule.

carlosapaduarte · 2019-03-20T10:10:54Z

_rules/SC2-4-2-page-has-title.md


 ### Expectation 2

-The first `title` element contains [non-empty text](#non-empty).
+The first `title` element contains [letters or numbers](#letters-or-numbers).


Just to make sure I understand, this means that the following title would fail, because it only uses punctuation symbols, not letters or numbers?
<title>#$@&%*!</title>
And should it fail?

@carlosapaduarte, yes, with the current definition it would. The old "non-empty" definition was actually also only looking for letters and numbers, it was just much less obvious.

I have struggled with the same question for headings. If I create a page about smileys, I would say that ":-)" and ":'-(" would be fine as headings.

What do you think? Another definition that I have used in some places is "contains text nodes that do not only consist of Unicode separator characters"
So <title>#$@&%*!</title> would be a Passed outcome, but <title> </title>would be Failed.

Do you think that would be more appropriate?

We do also have another rule that checks if the title is descriptive, so I think I am actually leaning towards this approach...

@annethyme, yes I do prefer the "contains text nodes that do not only consist of Unicode separator characters" definition.

I don't think that both the #$@&%*! title and the :-) heading are accessibility violations, so they shouldn't be failed by a rule that checks just a syntactic aspect (in this case, if the page has a title or not).

Change has been made and test cases updated to reflect this.

Substantial changes have been made since approval, so I will dismiss the review.

kasperisager · 2019-03-21T13:37:46Z

_rules/SC2-4-2-page-has-title.md

@@ -22,19 +22,19 @@ authors:

 ### Applicability

-The rule applies to any page where the root element is an `html` element, and which is not embedded in another page.
+The rule applies to any page where the [root](https://www.w3.org/TR/dom41/#concept-tree-root) element is an `html` element, and which is not embedded in another page.


The root of a document will always be the document itself so no valid HTML documents will ever match this applicability. The term we're looking for is "document element": https://www.w3.org/TR/dom/#document-element

carlosapaduarte

Just a couple of typos in addition to what Kasper has raised

carlosapaduarte · 2019-03-21T16:26:24Z

_rules/SC2-4-2-page-has-title.md

@@ -166,11 +174,21 @@ Empty first `title`.
 </html>
 ```

+#### Failed example 5
+
+The `title` only contains a seperator character.


typo: seperator -> separator

Above there is another typo. On passed example 2 "This page give" -> "This page gives"

Should be fixed now.

"[document title](https://www.w3.org/TR/html5/single-page.html#dom-tree-accessors)" --> "first HTML `title` element that is a [descendant](https://www.w3.org/TR/dom41/#concept-tree-descendant) of a [document element](https://www.w3.org/TR/dom/#document-element)"

WilcoFiers

Super editorial, but please consider :)

WilcoFiers · 2019-03-27T20:45:23Z

_rules/SC2-4-2-page-has-title.md


 ### Expectation 2

-The first `title` element contains [non-empty text](#non-empty).
+The first `title` element contains [text nodes](https://www.w3.org/TR/dom/#text) that do not only consist of [Unicode separator characters](https://www.unicode.org/versions/Unicode11.0.0/ch04.pdf#G134153).


Can we simplify this a little by doing:

The first title element contains text that does not only consist of whitespace (specifically, Unicode separator characters).

@WilcoFiers, we don't find your suggestion to be as unambiguous as we would like.

Which part of it? Alternative proposal:

... contains text content that does not only consist of Unicode separator characters (i.e. space, line breaks and other whitespace characters)

Text content is what the HTML 5.2 spec says needs to be used to derive the document title from the title element, so it's the right technical term, and it reads better than "text nodes" IMO.

HTML defines "child text content" as a term (https://www.w3.org/TR/html/infrastructure.html#child-text-content), not "text content". In general, I don't really think it's appropriate to refer do DOM attributes in the manner proposed, e.g. use "text content" to mean node.textContent or "document title" to mean document.title. If referring to DOM attributes or properties, be explicit about it.

Fair point. But then shouldn't this simply be using document.title?

I don't think it should; that's an implementation detail and rules shouldn't dictate the "how" but rather the "what". The "what", in this case, is the concatenation of the data of the text nodes that are children of the <title> element, i.e. the "child text content". The "how" could be document.title.

I don't mean to say to literally access the document.title property. You're right, that's clearly implementation. I mean using "document title", linking to the algorithm for deriving it, the same way we talk about "accessible name" and referencing that algorithm.

That makes perfect sense and for that very same reason I'd also suggest using the term "child text content" similar to how we use the term "accessible name". We could even add "document title" to the glossary and define it as "the child text content of the first <title> element that is a descendant of the document".

Changed to match Kasper's suggestion for a resolution.

WilcoFiers · 2019-04-01T11:28:25Z

_rules/SC2-4-2-page-has-title.md


 ### Expectation 2

-The first `title` element contains [non-empty text](#non-empty).
+The [child text content](https://www.w3.org/TR/html/infrastructure.html#child-text-content) of the first HTML `title` element that is a [descendant](https://www.w3.org/TR/dom41/#concept-tree-descendant) of the [document element](https://www.w3.org/TR/dom/#document-element) does not only consist of [Unicode separator characters](https://www.unicode.org/versions/Unicode11.0.0/ch04.pdf#G134153).


Please use plain language here. We can replace "non-empty" as a definition, but we shouldn't be inlining complex definitions like this. That makes this very difficult to use for less technical people.

See #380 (comment)

Wording changed. Please review again.

_rules/SC2-4-2-page-has-title.md


 ### Expectation 2

-The first `title` element contains [non-empty text](#non-empty).
+The first HTML `title` element that is a [descendant](https://www.w3.org/TR/dom41/#concept-tree-descendant) of the [document element](https://www.w3.org/TR/dom/#document-element) has [children](https://www.w3.org/TR/dom/#concept-tree-child) that are [text nodes](https://www.w3.org/TR/dom/#text) that are not only [whitespace](#whitespace).


* master: Rule update: "HTML page has a title" (#440) Rule update: "aria attribute allowed" and "aria required states and properties" (#436) Changed succescriteria from 4.1.2 to 1.3.1 (#449) Rename SC1-2-Video-description-track.md to SC1-2-video-description-track.md Glossary: add "Accessibility Support" to "Semantic role" term (#442) SC1-1-1-filename-is-valid-accessible-name (#263) Added assumption for SC3-1-2-lang-valid (#413) Update SC4-1-1-unique-id.md fix: update applicability fix: revert definitions fix: update glossary fix: applicability

* develop: (76 commits) Update SC1-1-1-image-has-name.md (#468) chore: update test case names to be hash and not have outcome (#485) chore: update styles chore: fix styling and spacing on various resolutions chore: fix typo in rules chore: update dependencies chore: add unique id to all rules (#478) fix: move footer from nav fix: update cache version fix: bust dependency cache chore: WCAG ACT RULES CG Website Update (#437) chore: update site publish config Replace auto-wcag with act-r in readme Update _config.yml Rule update: "aria-hidden with focusable content" (#439) Rule update: "HTML page has a title" (#440) Rule update: "aria attribute allowed" and "aria required states and properties" (#436) Changed succescriteria from 4.1.2 to 1.3.1 (#449) Rename SC1-2-Video-description-track.md to SC1-2-video-description-track.md Glossary: add "Accessibility Support" to "Semantic role" term (#442) ...

Rule update: "HTML page has a title"

e0dcf6e

"contain" --> "descendant" in Expectation 1. Editorial cleanup of "Background"

annethyme added Rule Update Use this label for an existing rule that is being updated Rule Use this label for a new rule that does not exist already March 31 deadline labels Mar 14, 2019

annethyme self-assigned this Mar 14, 2019

annethyme added this to Needs Review in Rules Progress via automation Mar 14, 2019

annethyme mentioned this pull request Mar 14, 2019

[WIP] Define "contain" and clean up rules "HTML Page has a title" and "aria-hidden with focusable content" #432

Closed

annethyme requested review from kasperisager and DagfinnRomen March 14, 2019 13:46

kasperisager previously requested changes Mar 18, 2019

View reviewed changes

linking to definition of "root"

7bc0188

kasperisager previously approved these changes Mar 18, 2019

View reviewed changes

annethyme requested review from audreymaniez, jeeyyy, carlosapaduarte and ShadowBB March 19, 2019 09:50

audreymaniez previously approved these changes Mar 20, 2019

View reviewed changes

Removed Technique G88 (descriptive titles)

2392288

carlosapaduarte reviewed Mar 20, 2019

View reviewed changes

Non-letter/numbers characters is a Pass

fbe4e5d

annethyme requested a review from kasperisager March 21, 2019 10:10

annethyme requested review from audreymaniez and carlosapaduarte March 21, 2019 10:10

kasperisager previously requested changes Mar 21, 2019

View reviewed changes

carlosapaduarte reviewed Mar 21, 2019

View reviewed changes

[root] element --> [document element] + fix typos

7477ebd

Rules Progress automation moved this from Needs Review to CFC (Reviewer Approved) Mar 25, 2019

kasperisager approved these changes Mar 25, 2019

View reviewed changes

DagfinnRomen approved these changes Mar 25, 2019

View reviewed changes

annethyme added Agenda item Review call 2 weeks Call for review for new rules and big changes and removed Agenda item labels Mar 26, 2019

ShadowBB approved these changes Mar 26, 2019

View reviewed changes

WilcoFiers previously requested changes Mar 27, 2019

View reviewed changes

Rules Progress automation moved this from CFC (Reviewer Approved) to Needs Review Mar 27, 2019

Anne Thyme added 2 commits April 1, 2019 13:10

[text nodes] --> [child text content]

5c97c95

Added link to definition

8942285

Rules Progress automation moved this from Needs Review to CFC (Reviewer Approved) Apr 1, 2019

annethyme requested a review from WilcoFiers April 1, 2019 11:13

Rules Progress automation moved this from CFC (Reviewer Approved) to Needs Review Apr 1, 2019

WilcoFiers previously requested changes Apr 1, 2019

View reviewed changes

Anne Thyme added 3 commits April 4, 2019 14:20

[seperator characters] --> [whitespace]

97f2af5

Update SC2-4-2-page-has-title.md

d3f291c

Update SC2-4-2-page-has-title.md

2f5a9c8

Rules Progress automation moved this from Needs Review to CFC (Reviewer Approved) Apr 4, 2019

annethyme requested a review from WilcoFiers April 4, 2019 12:45

annethyme commented Apr 5, 2019

View reviewed changes

annethyme merged commit 0585a59 into master Apr 10, 2019

Rules Progress automation moved this from CFC (Reviewer Approved) to Done Apr 10, 2019

annethyme moved this from Done to 3 implementations in Rules Progress Jul 18, 2019

jeeyyy deleted the rule-update-SC-2-4-2-page-has-title branch July 25, 2019 10:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rule update: "HTML page has a title" #440

Rule update: "HTML page has a title" #440

annethyme commented Mar 14, 2019

kasperisager Mar 18, 2019

audreymaniez left a comment

audreymaniez Mar 20, 2019

carlosapaduarte Mar 20, 2019

annethyme Mar 20, 2019

carlosapaduarte Mar 20, 2019

annethyme Mar 21, 2019

kasperisager Mar 21, 2019

carlosapaduarte left a comment •

edited

carlosapaduarte Mar 21, 2019

WilcoFiers left a comment

WilcoFiers Mar 27, 2019

annethyme Mar 28, 2019

WilcoFiers Mar 29, 2019

kasperisager Mar 29, 2019

WilcoFiers Mar 29, 2019

kasperisager Mar 29, 2019 •

edited

WilcoFiers Mar 29, 2019

kasperisager Mar 29, 2019

WilcoFiers Apr 1, 2019

kasperisager Apr 3, 2019

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Rule update: "HTML page has a title" #440

Rule update: "HTML page has a title" #440

Conversation

annethyme commented Mar 14, 2019

How to Review And Approve

Choose a reason for hiding this comment

audreymaniez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlosapaduarte left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WilcoFiers left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kasperisager Mar 29, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

carlosapaduarte left a comment •

edited

kasperisager Mar 29, 2019 •

edited