From 6912029891d5d55046f2bd21c60c033dbf6a0f0f Mon Sep 17 00:00:00 2001 From: Denis Ah-Kang Date: Tue, 18 Mar 2025 17:14:14 +0400 Subject: [PATCH] update SOTD intro wording --- lib/l10n-en_GB.js | 2 ++ lib/rules.json | 4 ++-- lib/rules/sotd/supersedable.js | 18 +++++++++++++++--- test/data/TR/TRBase.js | 1 + test/doc-views/specBase.js | 13 ++++++++++--- test/docs/2021-cr.html | 2 +- test/docs/2021-crd.html | 2 +- test/docs/2021-cry.html | 2 +- test/docs/2021-cryd.html | 2 +- test/docs/2021-disc.html | 2 +- test/docs/2021-dnote.html | 2 +- test/docs/2021-dry.html | 2 +- test/docs/2021-fpwd.html | 2 +- test/docs/2021-note.html | 2 +- test/docs/2021-pr.html | 2 +- test/docs/2021-rec.html | 2 +- test/docs/2021-ry.html | 2 +- test/docs/2021-stmt.html | 2 +- test/docs/2021-wd-shortname-change.html | 2 +- test/docs/2021-wd.html | 2 +- 20 files changed, 45 insertions(+), 23 deletions(-) diff --git a/lib/l10n-en_GB.js b/lib/l10n-en_GB.js index a641284ff..1b48a6087 100644 --- a/lib/l10n-en_GB.js +++ b/lib/l10n-en_GB.js @@ -163,6 +163,8 @@ export const messages = { 'No “status of this document” introduction (eg absent, not using HTTPS, wrong copy).', 'sotd.supersedable.no-sotd-tr': 'No “status of this document” introduction link to TR (or perhaps not using HTTPS).', + 'sotd.supersedable.deprecated': + 'The introduction to the status of this document uses the deprecated term "W3C technical reports index".', // sotd/deployment 'sotd.deployment.not-found': 'Cannot find the paragraph regarding deployment in the Status of This Document.', diff --git a/lib/rules.json b/lib/rules.json index b64491e8e..b8cc86965 100644 --- a/lib/rules.json +++ b/lib/rules.json @@ -55,7 +55,7 @@ "name": "5. Document Status Section", "rules": { "sotd": true, - "boilerplateTRDoc": "It must begin with the following boilerplate text:

This section describes the status of this document at the time of its publication. A list of current W3C publications can be found in the W3C technical reports index at https://www.w3.org/TR/.

Include this source code:
<p><em>This section describes the status of this document at the time of its publication. A list of current W3C publications can be found in the <a href=\"https://www.w3.org/TR/\">W3C technical reports index</a> at https://www.w3.org/TR/.</em></p>
", + "boilerplateTRDoc": "It must begin with the following boilerplate text:

This section describes the status of this document at the time of its publication. A list of current W3C publications can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

Include this source code:
<p><em>This section describes the status of this document at the time of its publication. A list of current W3C publications can be found in the <a href=\"https://www.w3.org/TR/\">W3C Standards and drafts index</a> at https://www.w3.org/TR/.</em></p>
", "boilerplateSUBM": "It must include this boilerplate text (with links to the published Submission and Team Comment):
By publishing this document, W3C acknowledges that the Submitting Members have made a formal Submission request to W3C for discussion. Publication of this document by W3C indicates no endorsement of its content by W3C, nor that W3C has, is, or will be allocating any resources to the issues addressed by it. This document is not the product of a chartered W3C group, but is published as potential input to the W3C Process. A W3C Team Comment has been published in conjunction with this Member Submission. Publication of acknowledged Member Submissions at the W3C site is one of the benefits of W3C Membership. Please consult the requirements associated with Member Submissions of section 3.3 of the W3C Patent Policy. Please consult the complete list of acknowledged W3C Member Submissions.
Include this source code:
<p>By publishing this document, W3C acknowledges that the <a href=\"https://www.w3.org/submissions/@@@submissiondoc@@@\">Submitting Members</a> have made a formal Submission request to W3C for discussion. Publication of this document by W3C indicates no endorsement of its content by W3C, nor that W3C has, is, or will be allocating any resources to the issues addressed by it. This document is not the product of a chartered W3C group, but is published as potential input to the <a href=\"https://www.w3.org/policies/process/\">W3C Process</a>. A <a href=\"https://www.w3.org/submissions/@@@teamcomment@@@\">W3C Team Comment</a> has been published in conjunction with this Member Submission. Publication of acknowledged Member Submissions at the W3C site is one of the benefits of <a href=\"https://www.w3.org/Consortium/Prospectus/Joining\">W3C Membership</a>. Please consult the requirements associated with Member Submissions of <a href=\"https://www.w3.org/policies/patent-policy/#sec-submissions\">section 3.3 of the W3C Patent Policy</a>. Please consult the complete <a href=\"https://www.w3.org/submissions/\">list of acknowledged W3C Member Submissions</a>.</p>
", "customParagraph": true, "knownDisclosureNumber": true, @@ -1516,7 +1516,7 @@ "name": "5. Document Status Section", "rules": { "sotd": "There must be a status section that follows the abstract, labeled with an h2 element with content \"Status of This Document\". The Team maintains the status section of a document.", - "boilerplateTRDoc": "It must begin with the following boilerplate text:

This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.

Include this source code:
<p><em>This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the <a href=\"https://www.w3.org/TR/\">W3C technical reports index</a> at https://www.w3.org/TR/.</em></p>
", + "boilerplateTRDoc": "It must begin with the following boilerplate text:

This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

Include this source code:
<p><em>This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the <a href=\"https://www.w3.org/TR/\">W3C Standards and drafts index</a> at https://www.w3.org/TR/.</em></p>
", "datesFormat": "All dates must have one of the following forms:
  1. DD Month YYYY : 09 January 2020
  2. DD-Month-YYYY : 09-January-2020
  3. DD Mon YYYY : 09 Jan 2020
  4. DD-Mon-YYYY : 09-Jan-2020
A leading zero in the day is optional.", "publish": "It must include the name of the W3C group that produced the document, the type of document and its track. The name must be a link to a public page for the group.

This document was published by the @@@ Working/Interest Group as a @{param1} using the @{param2}.

Include this source code:
<p>This document was published by the <a href=\"https://www.w3.org/groups/(wg|ig)/@@/\">@@@ Working/Interest Group</a> as a @{param1} using the @{param3}.</p>
", "customParagraph": "It must include at least one customized paragraph. This section should include the title page date (i.e., the one next to the maturity level at the top of the document). These paragraphs should explain the publication context, including rationale and relationships to other work. See examples and more discussion in the Manual of Style.", diff --git a/lib/rules/sotd/supersedable.js b/lib/rules/sotd/supersedable.js index 2912d0bdc..50e67172e 100644 --- a/lib/rules/sotd/supersedable.js +++ b/lib/rules/sotd/supersedable.js @@ -3,7 +3,7 @@ //

This section describes the status of this document at the time of its publication. // A list of current W3C publications and the // latest revision of this technical report can be found in the -// W3C technical reports index at https://www.w3.org/TR/.

+// W3C Standards and draft index at https://www.w3.org/TR/.

import { filter } from '../../util.js'; @@ -38,10 +38,22 @@ export function check(sr, done) { sr.config.status === 'SUBM' ? '' : 'and the latest revision of this technical report ' - }can be found in the W3C technical reports index at https://www.w3.org/TR/.`; + }can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.`; + + const deprecatedWanted = wanted.replace( + 'W3C Standards and drafts index', + 'W3C technical reports index' + ); + + if (txt !== wanted) { + if (txt === deprecatedWanted) { + sr.warning(self, 'deprecated'); + } else { + sr.error(self, 'no-sotd-intro'); + } + } const a = em && em.querySelectorAll("a[href='https://www.w3.org/TR/']"); - if (txt !== wanted) sr.error(self, 'no-sotd-intro'); if (!a || !a.length) sr.error(self, 'no-sotd-tr'); } done(); diff --git a/test/data/TR/TRBase.js b/test/data/TR/TRBase.js index e7f0a53eb..543d12365 100644 --- a/test/data/TR/TRBase.js +++ b/test/data/TR/TRBase.js @@ -58,6 +58,7 @@ export const rules = { supersedable: [ { data: 'noIntro', errors: ['sotd.supersedable.no-sotd-intro'] }, { data: 'noTr', errors: ['sotd.supersedable.no-sotd-tr'] }, + { data: 'deprecated', warnings: ['sotd.supersedable.deprecated'] }, ], 'process-document': [ { diff --git a/test/doc-views/specBase.js b/test/doc-views/specBase.js index b701dcab2..891700664 100644 --- a/test/doc-views/specBase.js +++ b/test/doc-views/specBase.js @@ -117,7 +117,7 @@ export const data = { sotd: { id: 'sotd', title: 'Status of This Document', - emHTML: 'This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.', + emHTML: 'This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.', submission: { show: false, @@ -864,14 +864,21 @@ export function buildCommonViewData(base) { ...base, sotd: { ...base.sotd, - emHTML: 'This section not the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.', + emHTML: 'This section not the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.', }, }, noTr: { ...base, sotd: { ...base.sotd, - emHTML: "This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.", + emHTML: "This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.", + }, + }, + deprecated: { + ...base, + sotd: { + ...base.sotd, + emHTML: 'This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.', }, }, }, diff --git a/test/docs/2021-cr.html b/test/docs/2021-cr.html index 156b1d746..e76661c8f 100644 --- a/test/docs/2021-cr.html +++ b/test/docs/2021-cr.html @@ -79,7 +79,7 @@

Abstract

Status of This Document

-

This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.

+

This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

This document was published by the Web Performance Working Group diff --git a/test/docs/2021-crd.html b/test/docs/2021-crd.html index 04ecab6fe..bccbbba3b 100644 --- a/test/docs/2021-crd.html +++ b/test/docs/2021-crd.html @@ -100,7 +100,7 @@

Abstract

Status of This Document

-

This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.

+

This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

This document was published by the Web Performance Working Group as a Candidate Recommendation Draft using the Recommendation track.

diff --git a/test/docs/2021-cry.html b/test/docs/2021-cry.html index b3c89ac0f..f9259ab8f 100644 --- a/test/docs/2021-cry.html +++ b/test/docs/2021-cry.html @@ -694,7 +694,7 @@

Status of This Document

document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the - W3C technical reports + W3C Standards and drafts index at https://www.w3.org/TR/.

diff --git a/test/docs/2021-cryd.html b/test/docs/2021-cryd.html index 0f225d28c..722fce72a 100644 --- a/test/docs/2021-cryd.html +++ b/test/docs/2021-cryd.html @@ -696,7 +696,7 @@

Status of This Document

document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the - W3C technical reports + W3C Standards and drafts index at https://www.w3.org/TR/.

This document describes counter styles used by various cultures around the world and can be used as a diff --git a/test/docs/2021-disc.html b/test/docs/2021-disc.html index 1725a0d20..f98eb36f2 100644 --- a/test/docs/2021-disc.html +++ b/test/docs/2021-disc.html @@ -93,7 +93,7 @@

Abstract

Status of This Document

- This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/. + This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

diff --git a/test/docs/2021-dnote.html b/test/docs/2021-dnote.html index 28ace956f..8c8550e7a 100644 --- a/test/docs/2021-dnote.html +++ b/test/docs/2021-dnote.html @@ -692,7 +692,7 @@

Abstract

Status of This Document

- This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/. + This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

diff --git a/test/docs/2021-dry.html b/test/docs/2021-dry.html index 196b90cc2..c7888f932 100644 --- a/test/docs/2021-dry.html +++ b/test/docs/2021-dry.html @@ -694,7 +694,7 @@

Abstract

Status of This Document

- This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/. + This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

This document describes counter styles used by various cultures around the world and can be used as a reference for those wishing to define user-defined counter styles for CSS. The content of this document was originally part of the CSS Lists and Counters specification, but is now published as a standalone document by the W3C Internationalization Working Group. It is expected that the document will be updated from time to time to include new information. diff --git a/test/docs/2021-fpwd.html b/test/docs/2021-fpwd.html index f41c6b987..33faa3d90 100644 --- a/test/docs/2021-fpwd.html +++ b/test/docs/2021-fpwd.html @@ -95,7 +95,7 @@

Abstract

Status of This Document

- This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.

+ This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

This document was published by the Web Performance Working Group as a First Public Working Draft using the Recommendation track. diff --git a/test/docs/2021-note.html b/test/docs/2021-note.html index 1c032cbfd..c934b22ff 100644 --- a/test/docs/2021-note.html +++ b/test/docs/2021-note.html @@ -694,7 +694,7 @@

Abstract

Status of This Document

- This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/. + This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

diff --git a/test/docs/2021-pr.html b/test/docs/2021-pr.html index aa949c3ea..cc2a77232 100644 --- a/test/docs/2021-pr.html +++ b/test/docs/2021-pr.html @@ -88,7 +88,7 @@

Abstract

Status of This Document

- This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/. + This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

diff --git a/test/docs/2021-rec.html b/test/docs/2021-rec.html index 16e63f1e3..2928cd907 100644 --- a/test/docs/2021-rec.html +++ b/test/docs/2021-rec.html @@ -112,7 +112,7 @@

Abstract

Status of This Document

-

This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.

+

This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

This document was published by the CSS Working Group as a Recommendation using the Recommendation track.

diff --git a/test/docs/2021-ry.html b/test/docs/2021-ry.html index 56df2295a..41541a883 100644 --- a/test/docs/2021-ry.html +++ b/test/docs/2021-ry.html @@ -692,7 +692,7 @@

Abstract

Status of This Document

- This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/. + This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

diff --git a/test/docs/2021-stmt.html b/test/docs/2021-stmt.html index fd8c84002..4e6e8ed4f 100644 --- a/test/docs/2021-stmt.html +++ b/test/docs/2021-stmt.html @@ -694,7 +694,7 @@

Abstract

Status of This Document

- This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/. + This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.

This document describes counter styles used by various cultures around the world and can be used as a reference for those wishing to define user-defined counter styles for CSS. The content of this document was originally part of the CSS Lists and Counters specification, but is now published as a standalone document by the W3C Internationalization Working Group. It is expected that the document will be updated from time to time to include new information. diff --git a/test/docs/2021-wd-shortname-change.html b/test/docs/2021-wd-shortname-change.html index bc60ae003..167fd575b 100644 --- a/test/docs/2021-wd-shortname-change.html +++ b/test/docs/2021-wd-shortname-change.html @@ -99,7 +99,7 @@

Status of This Document

This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at + title="World Wide Web Consortium">W3C Standards and drafts index at https://www.w3.org/TR/.

diff --git a/test/docs/2021-wd.html b/test/docs/2021-wd.html index 7999d6547..9a34bd8cd 100644 --- a/test/docs/2021-wd.html +++ b/test/docs/2021-wd.html @@ -95,7 +95,7 @@

Abstract

Status of This Document

- This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/. + This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C Standards and drafts index at https://www.w3.org/TR/.