Publication Policies

Resources

Tools

Also On This Page →

then view result requirements and sample

Document status and these characteristics:

Working Group Patent Policy:

Relation to previous Recommendations of same major revision:

Three Services: Pubrules, Checker, Sample

This resource provides three services:

  1. Pubrules filter, which shows only the relevant requirements for publication of a W3C Technical Report, Submission, or Incubator Report.
  2. Checker, available in two flavors:
    • Use auto mode to determine values from the document and then run the checker (then switching to manual mode for adjustments).
    • Use manual mode to exercise control over the type of tests run and their display.
  3. A sample of what the front of the document should look like given the chosen characteristics

Publication requirements and checker test results are shown below. The requirements and template are not shown in "Checker (Auto)" mode until you have run the checker.

A companion document includes a glossary, roles, and history of this document. A comparison of requirements across all document types is available.

For information about process requirements (how to request a transition, how to request publication, etc.), see How to Organize a Recommendation Track Transition . If you would like to discuss technical report production informally among your peers and get the latest tips and techniques, try the spec-prod mailing list (archive). Document Contacts should consult the W3C Manual of Style for guidance on additional publication topics and conventions.

Document Requirements

The Document Contact MUST verify that the requirements in this section (listed in "document order") have been satisfied before requesting publication. How to Organize a Recommendation Track Transition explains the remainder of the publication process.

See the sample below that has been generated by the parameters you have chosen in the form at the top of this document, summarized here:

1. Normative Document Representation

  1. normativeVersionTest 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.
  2. valideHTMLTest recursive All normative representations MUST validate as one of the following: HTML 4.x, or some version of XHTML or XHTML+RDFa that is a W3C Recommendation. HTML5 is also permitted with the following limitations:
    • Inline markup for SVG 1.1 or MathML 2.0 is permitted but only with a (fallback) alternative.
    • If the HTML5 validator issues content warnings, the publication request must include rationale why the warning is not problematic.
    Note: Please consider how your content will render in browsers that do not support HTML5.
  3. Visual styles SHOULD NOT vary significantly among normative alternatives.

Note: Serving two representations at the "this version" URI is an assertion by W3C that the documents are equivalent for the purposes of conveying the requirements of the document. In practice, the Comm Team will not read each alternative to verify that this is the case. If the Communications Team learns of substantive discrepancies between normative alternatives, the W3C Head of Communications may request that the author no longer serve the alternative as normative.

2. Document Metadata

  1. goodStylesheetTest recursive Each document MUST include the following absolute URI to identify a style sheet for this maturity level: http://www.w3.org/StyleSheets/TR/W3C-WD

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

  2. lastStylesheetTest 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.

See also Style Guidelines for Group-Internal Drafts.

3. Front Matter

  1. divClassHeadTest 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.

Logos

  1. logoTest The document MUST include a link to the W3C logo identified below. The URI used to identify the logo MUST be absolute.
    Include this source code:
    <a href="http://www.w3.org/"><img height="48" width="72" alt="W3C" src="http://www.w3.org/Icons/w3c_home"/></a>

Title, Date, Maturity Level

  1. titleTest The document's title MUST be in the title element and in an h1 element.
  2. Technical report version information, i.e., version and edition numbers.
    1. See the (non-normative) Version Management in W3C Technical Reports for more information
  3. dateTitleH2Test The document's status and date MUST be in an h2 element as follows (see also date syntax):
    <h2>W3C Working Draft 14 August 2014</h2>

Document Identifiers

  1. docIDFormat Document identifier information MUST be presented in a dl list, where each dt element marks up an identifier role ("This Version", "Latest Version", "Previous Version", etc.) and each dd element includes a link whose link text is the identifier.
  2. docIDOrder Document identifier information MUST be present in this order:
  3. docIDThisVersion The syntax of a "This Version" URI MUST be <http://www.w3.org/TR/2014/WD-shortname-2014MMDD/>.
  4. docIDLatestVersion The syntax of a "Latest Version" URI MUST be <http://www.w3.org/TR/shortname/>.
  5. docIDDate The title page date and the date at the end of the "This Version" URI MUST match.

Editor/Author Information

  1. editorSectionTest The editors'/authors' names MUST be listed. 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.

Links to non-normative document representations

  1. 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="WD-shortname-20020101.html">single HTML file</a>, <a href="WD-shortname-20020101.tgz">gzipped tar file of HTML</a>.</p>

Copyright Information

  1. hrAfterCopyrightTest A horizontal rule (hr) MUST follow the copyright.

4. Document Abstract

  1. abstractTest There MUST be an abstract, labeled with an h2 element with content "Abstract" that follows the hr element.

5. Document Status Section

  1. sotdTest 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.
  2. boilerplateTRDocTest It MUST begin with the following boilerplate text:

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

    Include this source code:
    <p><em>This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a> at http://www.w3.org/TR/.</em></p>
  3. datesFormatTest All dates MUST have the form DD Month YYYY. A leading zero in the day is OPTIONAL.
  4. WGLinkTest It MUST include the name of the W3C group that produced the document. The name MUST be a link to a public page for the group.
  5. mailingListNameTest It MUST include the name of a mailing list for comments that has a public archive.
  6. mailingListLinkTest It MUST include a link to the public archive of that mailing list.
  7. customParagraphTest 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.
  8. changesListTest It SHOULD include a link to changes since the previous draft (e.g., a list of changes or a diff document or both; see the online HTML diff tool).
  9. stabilityTest It MUST set expectations about the (in)stability of the document. The RECOMMENDED text is:

    Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

    Include this source code:
    <p>Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.</p>
  10. patPolReqTest It MUST include this text related to patent policy requirements (with suitable links inserted; see guidelines for linking to disclosure pages):

    This document was produced by a group operating under the 5 February 2004 W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

    Include this source code:
    <p> This document was produced by a group operating under the <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February 2004 W3C Patent Policy</a>. W3C maintains a <a rel="disclosure" href="@@URI to IPP status or other page@@">public list of any patent disclosures</a> made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential Claim(s)</a> must disclose the information in accordance with <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section 6 of the W3C Patent Policy</a>. </p>

    Note: Contact the Communications Team for suitable adaptations in the case where a document has been published jointly by more than one group. In the adaptation, be sure that the text for informative-only specs or specs not going to Rec is the same as the standard text.

  11. knownDisclosureNumberTest It MUST NOT indicate the number of known disclosures at the time of publication.

6. Table of Contents

  1. tocTest There SHOULD be a table of contents after the status section, labeled with an h2 element with content "Table of Contents".

7. Document Body

  1. headingWithoutIDTest 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.
  2. brokenLinkTest The document MUST NOT have any broken internal links or broken links to other resources at w3.org. The document SHOULD NOT have any other broken links.
  3. cssValideTest recursive The document MUST NOT have any style sheet errors.
  4. namespacesTest recursive All proposed XML namespaces created by the publication of the document MUST follow URIs for W3C Namespaces .
  5. wcagTest The document(s) MUST conform to the Web Content Accessibility Guidelines 2.0, Level AA. Note: You may wish to consult the customizable quick reference to Web Content Accessibility Guidelines 2.0.

8. Compound Documents

  1. compoundFilesLocationTest If the document is compound (i.e., if it consists of more than one file), all the files MUST be under a directory /TR/2014/WD-shortname-2014MMDD/
  2. compoundOverviewTestThe main page SHOULD be called Overview.html.
  3. compoundTestAll other files MUST be reachable by links from the document.

Sample: Your Document Head Should Look Like This

Given the parameters you have chosen, the head of your document should resemble the instance shown below. Note however that you will still need to provide a custom paragraph in the status section, and you may also have to adjust some of the recommended language according to your publication context. The sample shown does not illustrate all of the requirements of pubrules: it does not illustrate every possible publication context or requirements beyond those of the document head and status section.

The following appear in the head element but are not shown here:

W3C

SampleML 1.0

W3C Working Draft DD Month 2014

This version:
http://www.w3.org/TR/2014/WD-sampleml1-2014MMDD/
Latest version:
http://www.w3.org/TR/sampleml1/
Previous version:
<previous version uri>
Authors:
Nadia Coolpod (MyOrganization)
Dirk Silvertongue (Example.Com)

Abstract

....abstract text...

Status of this document

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

...Your custom paragraph here; see examples ...

This document was developed by the Sample Working Group. The Working Group expects to advance this Working Draft to Recommendation Status. A complete list of changes to this document is available.

Please send comments about this document to public-mailing-list@w3.org (with public archive).

Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This document was produced by a group operating under the 5 February 2004 W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

Table of Contents

...table of contents...

Ian Jacobs, W3C Head of Communications.
This document is based on contributions from Ian Jacobs, Matthieu Fuzellier, Dan Connolly, Chris Lilley, Hugo Haas, Dominique Hazaël-Massieux, Susan Lesch, Vivien Lacourba, and others. A filter is applied to the document source to provide specific views.
Created 3 Feb 2000.
$Id: 13-pubrules-src.html,v 1.617 2014-07-21 14:55:34 ijacobs Exp $