Skip to content
This repository has been archived by the owner on Jun 7, 2024. It is now read-only.

Commit

Permalink
fix(w3c/headers-spec): wrapped header in <details> (speced#3793)
Browse files Browse the repository at this point in the history
  • Loading branch information
@marcoscaceres
marcoscaceres authored Sep 29, 2021
1 parent c4d0885 commit ba47f7f
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 84 deletions.
171 changes: 87 additions & 84 deletions src/w3c/templates/headers.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,90 +156,93 @@ export default (conf, options) => {
${conf.logos.map(showLogo)} ${document.querySelector("h1#title")}
${getSpecSubTitleElem(conf)}
<h2>${renderSpecTitle(conf)}</h2>
<dl>
${conf.isTagFinding || !conf.isNoTrack
? html`
<dt>${l10n.this_version}</dt>
<dd>
<a class="u-url" href="${conf.thisVersion}"
>${conf.thisVersion}</a
>
</dd>
<dt>${l10n.latest_published_version}</dt>
<dd>
${conf.latestVersion
? html`<a href="${conf.latestVersion}"
>${conf.latestVersion}</a
>`
: "none"}
</dd>
`
: ""}
${conf.edDraftURI
? html`
<dt>${l10n.latest_editors_draft}</dt>
<dd><a href="${conf.edDraftURI}">${conf.edDraftURI}</a></dd>
`
: ""}
${conf.testSuiteURI
? html`
<dt>${l10n.test_suite}</dt>
<dd><a href="${conf.testSuiteURI}">${conf.testSuiteURI}</a></dd>
`
: ""}
${conf.implementationReportURI
? html`
<dt>${l10n.implementation_report}</dt>
<dd>
<a href="${conf.implementationReportURI}"
>${conf.implementationReportURI}</a
>
</dd>
`
: ""}
${conf.isED && conf.prevED
? html`
<dt>${l10n.prev_editor_draft}</dt>
<dd><a href="${conf.prevED}">${conf.prevED}</a></dd>
`
: ""}
${conf.showPreviousVersion
? html`
<dt>${l10n.prev_version}</dt>
<dd><a href="${conf.prevVersion}">${conf.prevVersion}</a></dd>
`
: ""}
${!conf.prevRecURI
? ""
: conf.isRec
? html`
<dt>${l10n.prev_recommendation}</dt>
<dd><a href="${conf.prevRecURI}">${conf.prevRecURI}</a></dd>
`
: html`
<dt>${l10n.latest_recommendation}</dt>
<dd><a href="${conf.prevRecURI}">${conf.prevRecURI}</a></dd>
`}
<dt>${conf.multipleEditors ? l10n.editors : l10n.editor}</dt>
${showPeople(conf, "editors")}
${Array.isArray(conf.formerEditors) && conf.formerEditors.length > 0
? html`
<dt>
${conf.multipleFormerEditors
? l10n.former_editors
: l10n.former_editor}
</dt>
${showPeople(conf, "formerEditors")}
`
: ""}
${conf.authors
? html`
<dt>${conf.multipleAuthors ? l10n.authors : l10n.author}</dt>
${showPeople(conf, "authors")}
`
: ""}
${conf.otherLinks ? conf.otherLinks.map(showLink) : ""}
</dl>
<details open="">
<summary>${l10n.more_details_about_this_doc}</summary>
<dl>
${conf.isTagFinding || !conf.isNoTrack
? html`
<dt>${l10n.this_version}</dt>
<dd>
<a class="u-url" href="${conf.thisVersion}"
>${conf.thisVersion}</a
>
</dd>
<dt>${l10n.latest_published_version}</dt>
<dd>
${conf.latestVersion
? html`<a href="${conf.latestVersion}"
>${conf.latestVersion}</a
>`
: "none"}
</dd>
`
: ""}
${conf.edDraftURI
? html`
<dt>${l10n.latest_editors_draft}</dt>
<dd><a href="${conf.edDraftURI}">${conf.edDraftURI}</a></dd>
`
: ""}
${conf.testSuiteURI
? html`
<dt>${l10n.test_suite}</dt>
<dd><a href="${conf.testSuiteURI}">${conf.testSuiteURI}</a></dd>
`
: ""}
${conf.implementationReportURI
? html`
<dt>${l10n.implementation_report}</dt>
<dd>
<a href="${conf.implementationReportURI}"
>${conf.implementationReportURI}</a
>
</dd>
`
: ""}
${conf.isED && conf.prevED
? html`
<dt>${l10n.prev_editor_draft}</dt>
<dd><a href="${conf.prevED}">${conf.prevED}</a></dd>
`
: ""}
${conf.showPreviousVersion
? html`
<dt>${l10n.prev_version}</dt>
<dd><a href="${conf.prevVersion}">${conf.prevVersion}</a></dd>
`
: ""}
${!conf.prevRecURI
? ""
: conf.isRec
? html`
<dt>${l10n.prev_recommendation}</dt>
<dd><a href="${conf.prevRecURI}">${conf.prevRecURI}</a></dd>
`
: html`
<dt>${l10n.latest_recommendation}</dt>
<dd><a href="${conf.prevRecURI}">${conf.prevRecURI}</a></dd>
`}
<dt>${conf.multipleEditors ? l10n.editors : l10n.editor}</dt>
${showPeople(conf, "editors")}
${Array.isArray(conf.formerEditors) && conf.formerEditors.length > 0
? html`
<dt>
${conf.multipleFormerEditors
? l10n.former_editors
: l10n.former_editor}
</dt>
${showPeople(conf, "formerEditors")}
`
: ""}
${conf.authors
? html`
<dt>${conf.multipleAuthors ? l10n.authors : l10n.author}</dt>
${showPeople(conf, "authors")}
`
: ""}
${conf.otherLinks ? conf.otherLinks.map(showLink) : ""}
</dl>
</details>
${conf.errata
? html`<p>
Please check the
Expand Down
13 changes: 13 additions & 0 deletions tests/spec/w3c/headers-spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,19 @@ describe("W3C — Headers", () => {
collapsedTextContent(child).includes(string)
);
}

it("has a details and summary", async () => {
const opts = makeStandardOps({ specStatus: "FPWD" });
const doc = await makeRSDoc(opts);
const details = doc.querySelector(".head details");
const summary = doc.querySelector(".head summary");
const dl = doc.querySelector(".head details > dl");
expect(details).toBeTruthy();
expect(details.open).toBe(true);
expect(summary).toBeTruthy();
expect(dl).toBeTruthy();
});

it("links to the 'kinds of documents' only for W3C documents", async () => {
const statuses = ["FPWD", "LCWD", "WD", "CR", "CRD", "PR", "REC", "NOTE"];
for (const specStatus of statuses) {
Expand Down

0 comments on commit ba47f7f

Please sign in to comment.