Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lib/l10n-en_GB.js
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,8 @@ export const messages = {
'No <em>&ldquo;status of this document&rdquo;</em> introduction (eg absent, not using HTTPS, wrong copy).',
'sotd.supersedable.no-sotd-tr':
'No <em>&ldquo;status of this document&rdquo;</em> 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.',
Expand Down
4 changes: 2 additions & 2 deletions lib/rules.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
"name": "5. Document Status Section",
"rules": {
"sotd": true,
"boilerplateTRDoc": "It <span class=\"rfc2119\">must</span> begin with the following boilerplate text: <blockquote class=\"boilerplate\"> <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> </blockquote> <div class=\"source\"> <span style=\"font-style: italic\">Include this source code</span>:<br><code>&lt;p&gt;&lt;em&gt;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 &lt;a href=\"https://www.w3.org/TR/\"&gt;W3C technical reports index&lt;/a&gt; at https://www.w3.org/TR/.&lt;/em&gt;&lt;/p&gt;</code></div>",
"boilerplateTRDoc": "It <span class=\"rfc2119\">must</span> begin with the following boilerplate text: <blockquote class=\"boilerplate\"> <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> </blockquote> <div class=\"source\"> <span style=\"font-style: italic\">Include this source code</span>:<br><code>&lt;p&gt;&lt;em&gt;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 &lt;a href=\"https://www.w3.org/TR/\"&gt;W3C Standards and drafts index&lt;/a&gt; at https://www.w3.org/TR/.&lt;/em&gt;&lt;/p&gt;</code></div>",
"boilerplateSUBM": "It <span class=\"rfc2119\">must</span> include this boilerplate text (with links to the published Submission and Team Comment): <blockquote class=\"boilerplate\"> 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>.</blockquote> <div class=\"source\"> <span style=\"font-style: italic\">Include this source code</span>:<br><code>&lt;p&gt;By publishing this document, W3C acknowledges that the &lt;a href=\"https://www.w3.org/submissions/@@@submissiondoc@@@\"&gt;Submitting Members&lt;/a&gt; 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 &lt;a href=\"https://www.w3.org/policies/process/\"&gt;W3C Process&lt;/a&gt;. A &lt;a href=\"https://www.w3.org/submissions/@@@teamcomment@@@\"&gt;W3C Team Comment&lt;/a&gt; has been published in conjunction with this Member Submission. Publication of acknowledged Member Submissions at the W3C site is one of the benefits of &lt;a href=\"https://www.w3.org/Consortium/Prospectus/Joining\"&gt;W3C Membership&lt;/a&gt;. Please consult the requirements associated with Member Submissions of &lt;a href=\"https://www.w3.org/policies/patent-policy/#sec-submissions\"&gt;section 3.3 of the W3C Patent Policy&lt;/a&gt;. Please consult the complete &lt;a href=\"https://www.w3.org/submissions/\"&gt;list of acknowledged W3C Member Submissions&lt;/a&gt;.&lt;/p&gt;</code></div>",
"customParagraph": true,
"knownDisclosureNumber": true,
Expand Down Expand Up @@ -1516,7 +1516,7 @@
"name": "5. Document Status Section",
"rules": {
"sotd": "There <span class=\"rfc2119\">must</span> be a status section that follows the abstract, labeled with an <code>h2</code> element with content \"Status of This Document\". The Team maintains the status section of a document.",
"boilerplateTRDoc": "It <span class=\"rfc2119\">must</span> begin with the following boilerplate text: <blockquote class=\"boilerplate\"> <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> </blockquote> <div class=\"source\"> <span style=\"font-style: italic\">Include this source code</span>:<br><code>&lt;p&gt;&lt;em&gt;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 &lt;a href=\"https://www.w3.org/TR/\"&gt;W3C technical reports index&lt;/a&gt; at https://www.w3.org/TR/.&lt;/em&gt;&lt;/p&gt;</code></div>",
"boilerplateTRDoc": "It <span class=\"rfc2119\">must</span> begin with the following boilerplate text: <blockquote class=\"boilerplate\"> <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> </blockquote> <div class=\"source\"> <span style=\"font-style: italic\">Include this source code</span>:<br><code>&lt;p&gt;&lt;em&gt;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 &lt;a href=\"https://www.w3.org/TR/\"&gt;W3C Standards and drafts index&lt;/a&gt; at https://www.w3.org/TR/.&lt;/em&gt;&lt;/p&gt;</code></div>",
"datesFormat": "All dates <span class=\"rfc2119\">must</span> have one of the following forms:<ol><li>DD Month YYYY : 09 January 2020</li><li>DD-Month-YYYY : 09-January-2020</li><li>DD Mon YYYY : 09 Jan 2020</li><li>DD-Mon-YYYY : 09-Jan-2020</li></ol>A leading zero in the day is <span class=\"rfc2119\">optional</span>.",
"publish": "It <span class=\"rfc2119\">must</span> include the name of the W3C group that produced the document, the type of document and its track. The name <span class=\"rfc2119\">must</span> be a link to a public page for the group.<blockquote><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 @{param2}.</p> </blockquote><div class=\"source\"> <span style=\"font-style: italic\">Include this source code</span>:<br><code>&lt;p&gt;This document was published by the &lt;a href=\"https://www.w3.org/groups/(wg|ig)/@@/\"&gt;@@@ Working/Interest Group&lt;/a&gt; as a @{param1} using the @{param3}.&lt;/p&gt;</code></div>",
"customParagraph": "It <span class=\"rfc2119\">must</span> include at least one customized paragraph. This section <span class=\"rfc2119\">should</span> include the title page date (i.e., the one next to the maturity level at the top of the document). These paragraphs <span class=\"rfc2119\">should</span> explain the publication context, including rationale and relationships to other work. See <a href=\"https://www.w3.org/2001/06/manual/#Status\">examples and more discussion in the Manual of Style</a>.",
Expand Down
18 changes: 15 additions & 3 deletions lib/rules/sotd/supersedable.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// <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>
// <a href="https://www.w3.org/TR/">W3C Standards and draft index</a> at https://www.w3.org/TR/.</em></p>

import { filter } from '../../util.js';

Expand Down Expand Up @@ -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();
Expand Down
1 change: 1 addition & 0 deletions test/data/TR/TRBase.js
Original file line number Diff line number Diff line change
Expand Up @@ -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': [
{
Expand Down
13 changes: 10 additions & 3 deletions test/doc-views/specBase.js
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ export const data = {
sotd: {
id: 'sotd',
title: 'Status of This Document',
emHTML: '<em>This section describes the status of this document at the time of its publication. A list of current <abbr title="World Wide Web Consortium">W3C</abbr> publications and the latest revision of this technical report can be found in the <a href="https://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> technical reports index</a> at https://www.w3.org/TR/.</em>',
emHTML: '<em>This section describes the status of this document at the time of its publication. A list of current <abbr title="World Wide Web Consortium">W3C</abbr> publications and the latest revision of this technical report can be found in the <a href="https://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> Standards and drafts index</a> at https://www.w3.org/TR/.</em>',

submission: {
show: false,
Expand Down Expand Up @@ -864,14 +864,21 @@ export function buildCommonViewData(base) {
...base,
sotd: {
...base.sotd,
emHTML: '<em>This section not the status of this document at the time of its publication. A list of current <abbr title="World Wide Web Consortium">W3C</abbr> publications and the latest revision of this technical report can be found in the <a href="https://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> technical reports index</a> at https://www.w3.org/TR/.</em>',
emHTML: '<em>This section not the status of this document at the time of its publication. A list of current <abbr title="World Wide Web Consortium">W3C</abbr> publications and the latest revision of this technical report can be found in the <a href="https://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> Standards and drafts index</a> at https://www.w3.org/TR/.</em>',
},
},
noTr: {
...base,
sotd: {
...base.sotd,
emHTML: "<em>This section describes the status of this document at the time of its publication. A list of current <abbr >W3C</abbr> publications and the latest revision of this technical report can be found in the <a ><abbr title='World Wide Web Consortium'>W3C</abbr> technical reports index</a> at https://www.w3.org/TR/.</em>",
emHTML: "<em>This section describes the status of this document at the time of its publication. A list of current <abbr >W3C</abbr> publications and the latest revision of this technical report can be found in the <a ><abbr title='World Wide Web Consortium'>W3C</abbr> Standards and drafts index</a> at https://www.w3.org/TR/.</em>",
},
},
deprecated: {
...base,
sotd: {
...base.sotd,
emHTML: '<em>This section describes the status of this document at the time of its publication. A list of current <abbr >W3C</abbr> publications and the latest revision of this technical report can be found in the <a href="https://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> technical reports index</a> at https://www.w3.org/TR/.</em>',
},
},
},
Expand Down
2 changes: 1 addition & 1 deletion test/docs/2021-cr.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ <h2>Abstract</h2>
<section id="sotd" data-link-for="Performance" class="introductory">
<h2>Status of This Document</h2>

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

<p>
This document was published by the <a href="https://www.w3.org/groups/wg/webperf">Web Performance Working Group</a>
Expand Down
2 changes: 1 addition & 1 deletion test/docs/2021-crd.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h2>Abstract</h2>
<section id="sotd" data-link-for="Performance" class="introductory">
<h2>Status of This Document</h2>

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

<p>This document was published by the <a href="https://www.w3.org/groups/wg/webperf">Web Performance Working Group</a> as a Candidate Recommendation Draft using the <a href='https://www.w3.org/policies/process/20231103/#recs-and-notes'>Recommendation track</a>.</p>

Expand Down
2 changes: 1 addition & 1 deletion test/docs/2021-cry.html
Original file line number Diff line number Diff line change
Expand Up @@ -694,7 +694,7 @@ <h2>Status of This Document</h2>
document at the time of its publication. A list of current <abbr
title="World Wide Web Consortium">W3C</abbr> publications and the latest revision
of this technical report can be found in the
<a href="https://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> technical reports
<a href="https://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> Standards and drafts
index</a> at
https://www.w3.org/TR/.</em></p>

Expand Down
2 changes: 1 addition & 1 deletion test/docs/2021-cryd.html
Original file line number Diff line number Diff line change
Expand Up @@ -696,7 +696,7 @@ <h2>Status of This Document</h2>
document at the time of its publication. A list of current <abbr
title="World Wide Web Consortium">W3C</abbr> publications and the latest revision
of this technical report can be found in the
<a href="https://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> technical reports
<a href="https://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> Standards and drafts
index</a> at
https://www.w3.org/TR/.</em></p>
<p>This document describes counter styles used by various cultures around the world and can be used as a
Expand Down
2 changes: 1 addition & 1 deletion test/docs/2021-disc.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ <h2>Abstract</h2>
<h2>Status of This Document</h2>

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

<p>
Expand Down
2 changes: 1 addition & 1 deletion test/docs/2021-dnote.html
Original file line number Diff line number Diff line change
Expand Up @@ -692,7 +692,7 @@ <h2>Abstract</h2>
<div id="sotd" class="introductory">
<h2>Status of This Document</h2>
<p>
<em>This section describes the status of this document at the time of its publication. A list of current <abbr title="World Wide Web Consortium">W3C</abbr> publications and the latest revision of this technical report can be found in the <a href="https://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> technical reports index</a> at https://www.w3.org/TR/.</em>
<em>This section describes the status of this document at the time of its publication. A list of current <abbr title="World Wide Web Consortium">W3C</abbr> publications and the latest revision of this technical report can be found in the <a href="https://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> Standards and drafts index</a> at https://www.w3.org/TR/.</em>
</p>

<p>
Expand Down
Loading