Logo for the Pubrules Checker Pubrules 11.1.6 — publication rules

About · Site map · Github · Help

↑ up to documentation

Publication rules for Member Submission (“MEM-SUBM”)

1. Normative Document Representation

  • § At least one normative representation must be available for requests that use the "This Version" URI. More than one normative representation may be delivered in response to such requests. A "This Version" URI must not be used to identify a non-normative representation.
  • § recursive All normative representations must validate as HTML5 with the following limitations:
    • Inline markup for MathML is permitted but should use a (fallback) alternative.
    • If the HTML5 validator issues content warnings, the publication request must include rationale why the warning is not problematic.
  • § Visual styles should not vary significantly among normative alternatives.

2. Document Metadata

  • § recursive Each document must include the following absolute URI to identify a style sheet for this maturity level: https://www.w3.org/StyleSheets/TR/2021/W3C-Member-SUBM

    Include this source code:
    <link rel="stylesheet" type="text/css" href="https://www.w3.org/StyleSheets/TR/2021/W3C-Member-SUBM"/>

  • § recursive Any internal style sheets must be cascaded before this link; i.e., the internal style sheets must not override the W3C tech report styles.
  • § recursive The viewport meta tag is required.

    Include this source code:
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">

  • § recursive The canonical link is required.

    Include this source code:
    <link rel="canonical" href="@@URL@@">

3. Front Matter

  • § The front matter must appear at the beginning of the body of the document, within <div class="head">. There is one exception to that requirement: the hr element after the copyright may appear inside or after the div element. Editors should not include other information in this section.
  • § The document's title must be in the title element and in an h1 element. When calculating text equation, special transformations made to h1 are:
    1. Replace ':<br>' with ': '
    2. Replace '<br>' with ' - '
    3. Extract text from h1, and ignore HTML tags.
  • § Technical report version information, i.e., version and edition numbers.
    1. See the (non-normative) Version Management in W3C Technical Reports for more information.
  • § The document's status and date must be in a <p id="w3c-state"> element as follows (see also date syntax): 
    <p id="w3c-state">W3C Member Submission DD Month YYYY</p>
  • § Document identifier information must be presented in a dl list, where each dt element marks up an identifier role ("This Version", "Latest Version", "History", etc.) and each dd element includes a link whose link text is the identifier. That dl must itself be placed in a details element.

    Include this source code:
    <details open><summary>More details about this document</summary><dl>...</dl></details>

  • § Document identifier information must be present in this order:
    • 'This version' - URI to that version
    • 'Latest version' - URI to the latest version. See also the (non-normative) Version Management in W3C Technical Reports for information about "latest version" URI and version management.
    • 'History' - URI to the history of the specification
    • Editor(s)
    • Feedback - GitHub repository issue links are required in the <dl>after <dt>Feedback:</dt> in the headers (<div class="head">) of the document. Links are expected to be of the form https://github.com/<USER_OR_ORG>/<REPO_NAME>/[issues|labels][/…].)
  • § The syntax of a “This Version” URI must be https://www.w3.org/submissions/YYYY/SUBM-shortname-YYYYMMDD/.
  • § The syntax of a “Latest Version” URI must be https://www.w3.org/submissions/shortname/.
  • § The title page date and the date at the end of the "This Version" URI must match.
  • § The editors'/authors' names must be listed, with attribute data-editor-id="@@". Affiliations and email addresses are optional; email addresses are not recommended. If an editor/author is acknowledged in an earlier version of this document and the individual's affiliation has since changed, list the individual using the notation "<name>, <affiliation> (until DD Month YYYY)". If the list of authors is very long (e.g., the entire Working Group), identify the authors in the acknowledgments section, linked from the head of the document. Distinguish any contributors from authors in the acknowledgments section.
    Note: Editors must be participating in the group producing the document at the time of its publication.
  • § Authors may provide links to alternative (non-normative) representations or packages for the document. For instance:

    <p>This document is also available in these non-normative formats: <a href="SUBM-shortname-20180101.html">single HTML file</a>, <a href="SUBM-shortname-20180101.tgz">gzipped tar file of HTML</a>.</p>

  • § A horizontal rule (hr) must follow the copyright.

5. Document Status Section

  • § 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.
  • § 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>
  • § 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/Consortium/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/Consortium/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>
  • § 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.
  • § It must not indicate the number of known disclosures at the time of publication.
  • § 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.
  • § There should be a table of contents after the status section, labeled with an h2 element with content "Table of Contents".
  • § The table of content must be inside a navigation element (nav).

    Include this source code:
    <nav id="toc"><h2>Table of Contents</h2>

7. Document Body

  • § recursive Every marked-up section and subsection of the document must have a target anchor. A section is identified by a heading element (h1-h6). The anchor may be specified using an id (or name if an a element is used) attribute on any of the following: the heading element itself, the parent div or section element of the heading element (where the heading element is the first child of the div or section), a descendant of the heading element, or an a immediately preceding the heading element.
  • § recursive The document must not have any style sheet errors.
  • § recursive All proposed XML namespaces created by the publication of the document must follow URIs for W3C Namespaces .
  • § The document(s) must conform to the Web Content Accessibility Guidelines 2.1, Level AA. Note: You may wish to consult the customizable quick reference to Web Content Accessibility Guidelines 2.1.
  • § The document must include the script fixup.js.

    Include this source code:
    <script src="//www.w3.org/scripts/TR/2021/fixup.js" type="application/javascript"></script>

8. Compound Documents

  • § If the document is compound (i.e., if it consists of more than one file), all the files must be under a directory /TR/YYYY/SUBM-shortname-YYYYMMDD/. Exceptions are resources under these paths:
    1. https://www.w3.org/StyleSheets/
    2. https://www.w3.org/scripts/
  • § The main page should be called Overview.html.
  • § All other files must be reachable by links from the document.