Publication Policies

Resources

Tools

Also On This Page →

on document identified by this URI , then view result requirements and sample.

Checker uses values below; please verify.

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:
  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:

Highlighted test results appear after each provision. Several resulttypes require attention: Errors, Warnings, and those marked "Please verify." For the latter, some test results include a link to a tool to help verify the requirement has been satisfied.

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.
    Please verify manually; not tested.
  2. valideHTMLTestrecursive 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:
    • HTML5 is not yet permitted for Recommendations.
    • 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.
    Please verify manually; not tested.
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. goodStylesheetTestrecursive 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"/>

    Error. The W3C style sheet should be http://www.w3.org/StyleSheets/TR/W3C-WD. No style sheet found.
  2. lastStylesheetTestrecursive Any internal style sheets MUST be cascaded before this link; i.e., the internal style sheets MUST NOT override the W3C tech report styles.
    Is the last style sheet used the W3C one? Error : There seems to be a style sheet link that follows the required W3C style sheet in the cascade order. Found instead /2008/site/css/print.
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.
    Is there a <div class="head"> section? Error No div element with class="head" found.

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.
    W3C
    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>
    Error No div element with class="head" found.

Title, Date, Maturity Level

  1. titleTest The document's title MUST be in the title element and in an h1 element.
    Error No div element with class="head" found.
  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
    Please verify manually; not tested.
  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 0001</h2>
    Is the dated status h2 title correct? Error: No appropriate document status found within 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.
    Error: "This version" link not found
  2. docIDOrder Document identifier information MUST be present in this order:
    Error No div element with class="head" found.
  3. docIDThisVersion The syntax of a "This Version" URI MUST be <http://www.w3.org/TR/0001/WD-shortname-0001MMDD/>.
    Error No div element with class="head" found.
  4. docIDLatestVersion The syntax of a "Latest Version" URI MUST be <http://www.w3.org/TR/shortname/>.
    Error No div element with class="head" found.
  5. docIDDate The title page date and the date at the end of the "This Version" URI MUST match.
    Error, the date of the document (00010101) and the one of the URI () don't match (or the status subtitle is not in the expected format W3C Status [D]D Month YYYY)

Editor/Author Information

  1. editorSectionTestThe 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.
    Is there an Editor or Author section in the head of the document? Error (no <dt> elements begining by 'Author' or 'Editor' found)

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>

    Please verify manually; not tested.

Copyright Information

  1. copyrightTest The copyright MUST use the following markup (fill in with the appropriate year, years, or year range). The abbr element MAY be used in place of acronym.
    Include this source code:
    <p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> © 0001 <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a><sup>®</sup> (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>, <a href="http://www.ercim.eu/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>, <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>, <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a> and <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a> rules apply.</p>
    Error. Required boilerplate text not found. Hint: Are there some whitespace differences after the year? Instead found:
  2. hrAfterCopyrightTest A horizontal rule (hr) MUST follow the copyright.
    Is there a <hr/> after the copyright? Error. No proper hr element found.

4. Document Abstract

  1. abstractTest There MUST be an abstract, labeled with an h2 element with content "Abstract" that follows the hr element.
    If there is an abstract, is it marked up by <h2> and is it at the right location (just after the hr)? Error. Did not find an Abstract in an h2 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.
    Is there a status of the document and is it correctly marked up? Error : SOTD not found (note that some tests relying on the SOTD won't be done because of this)
  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>
    Error. Required boilerplate text not found in status section.
  3. datesFormatTest All dates MUST have the form DD Month YYYY. A leading zero in the day is OPTIONAL.
    Please verify manually; not tested.
  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.
    Please verify manually; not tested.
  5. mailingListNameTest It MUST include the name of a mailing list for comments that has a public archive.
    Error No status section found.
  6. mailingListLinkTest It MUST include a link to the public archive of that mailing list.
    Error No status section found.
  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.
    Please verify manually; not tested.
  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).
    Please verify manually; not tested.
  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>
    Error. Required boilerplate text not found. Instead found:
  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.

    Please verify manually; not tested.
  11. knownDisclosureNumberTest It MUST NOT indicate the number of known disclosures at the time of publication.
    Please verify manually; not tested.

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".
    Warning (did not find an h2 with text "Table of Contents").

7. Document Body

  1. headingWithoutIDTestrecursive 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 element of the heading element (where the heading element is the first child of the div), a descendant of the heading element, or an a immediately preceding the heading element.
    Error, heading(s) found without a target anchor (specified using one of the allowed techniques):
    h2: Site Navigation
    h3: Standards
    h3: Web for All
    h3: Community and Business Groups
    h3: Working Groups
    h3: Member-only Home
    h2: News
    h3: W3C Community Groups Growing Source of Web Innovation
    h3: W3C Invites Implementations of Emotion Markup Language (EmotionML) 1.0
    h3: Registration for W3C Online Course on Programming Mobile Web Apps; Early Bird Rate through 25 May
    h3: Call for Review: Geolocation API Specification Proposed Recommendation Published
    h3: W3C Launches Linked Data Platform Working Group
    h3: MITRE Corporation
    h3: Navigation
    h3: Contact W3C
    h3: W3C Updates
  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.
    Please verify using Link Checker
  3. cssValideTestrecursive The document MUST NOT have any style sheet errors.
  4. namespacesTestrecursive All proposed XML namespaces created by the publication of the document MUST follow URIs for W3C Namespaces.
    OK The Namespaces Checker was used for this test.
  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/0001/WD-shortname-0001MMDD/
    Error. While I did not check that all resources are located in the correct directory, I did find some problematic URIs (e.g., they refer to resources not hosted by W3C or to style sheets or icons expected in other directories):
  2. compoundOverviewTestThe main page SHOULD be called Overview.html.
    OK, using the URI provided to the checker. Found <http://www.w3.org/Overview.html > Note: No "Overview.html" was found using the "this version" URI, however.
  3. compoundTestAll other files MUST be reachable by links from the document.
    Please verify. For your convenience, this is the list of files linked from the main document that seem to be part of a multipart document. Please verify whether it is complete. Note: Because you have not selected "HTML and CSS recursive check" the checks below have not been run automatically. You may run the tests manually via the links below.
    Linked Resources
    ResourceHTML validationCSS ValidationNamespaces
    2007/eGov/HTML validatorCSS validatorNamespaces checker
    2008/MW4D/HTML validatorCSS validatorNamespaces checker
    Consortium/HTML validatorCSS validatorNamespaces checker
    Consortium/Legal/ipr-noticeHTML validatorCSS validatorNamespaces checker
    Consortium/Member/ListHTML validatorCSS validatorNamespaces checker
    Consortium/Member/Testimonial/HTML validatorCSS validatorNamespaces checker
    Consortium/Recruitment/HTML validatorCSS validatorNamespaces checker
    Consortium/contactHTML validatorCSS validatorNamespaces checker
    Consortium/membershipHTML validatorCSS validatorNamespaces checker
    Consortium/siteindexHTML validatorCSS validatorNamespaces checker
    Consortium/sponsor/HTML validatorCSS validatorNamespaces checker
    Guide/HTML validatorCSS validatorNamespaces checker
    Help/HTML validatorCSS validatorNamespaces checker
    International/HTML validatorCSS validatorNamespaces checker
    Member/HTML validatorCSS validatorNamespaces checker
    Mobile/HTML validatorCSS validatorNamespaces checker
    News/2012HTML validatorCSS validatorNamespaces checker
    News/archiveHTML validatorCSS validatorNamespaces checker
    News/atom.xmlHTML validatorCSS validatorNamespaces checker
    News/news.rssHTML validatorCSS validatorNamespaces checker
    People/Jeff/HTML validatorCSS validatorNamespaces checker
    QA/HTML validatorCSS validatorNamespaces checker
    TR/HTML validatorCSS validatorNamespaces checker
    TR/tr-groups-allHTML validatorCSS validatorNamespaces checker
    Talks/HTML validatorCSS validatorNamespaces checker
    WAI/HTML validatorCSS validatorNamespaces checker
    community/HTML validatorCSS validatorNamespaces checker
    community/about/HTML validatorCSS validatorNamespaces checker
    community/groups/HTML validatorCSS validatorNamespaces checker
    community/groups/proposed/HTML validatorCSS validatorNamespaces checker
    participate/HTML validatorCSS validatorNamespaces checker
    participate/eventscal.htmlHTML validatorCSS validatorNamespaces checker
    standards/HTML validatorCSS validatorNamespaces checker
    standards/agents/HTML validatorCSS validatorNamespaces checker
    standards/semanticweb/HTML validatorCSS validatorNamespaces checker
    standards/webarch/HTML validatorCSS validatorNamespaces checker
    standards/webdesign/HTML validatorCSS validatorNamespaces checker
    standards/webofdevices/HTML validatorCSS validatorNamespaces checker
    standards/webofservices/HTML validatorCSS validatorNamespaces checker
    standards/xml/HTML validatorCSS validatorNamespaces checker
    Consortium/activitiesHTML validatorCSS validatorNamespaces checker
    Consortium/mission.htmlHTML validatorCSS validatorNamespaces checker
    Consortium/siteindex.htmlHTML validatorCSS validatorNamespaces checker
    QA/Tools/DonateHTML validatorCSS validatorNamespaces checker
    Status.htmlHTML validatorCSS validatorNamespaces checker
    2001/sw/HTML validatorCSS validatorNamespaces checker
    2002/mmi/HTML validatorCSS validatorNamespaces checker
    2002/mmi/Activity.htmlHTML validatorCSS validatorNamespaces checker
    2007/uwa/HTML validatorCSS validatorNamespaces checker
    2008/geolocation/HTML validatorCSS validatorNamespaces checker
    2009/cheatsheet/HTML validatorCSS validatorNamespaces checker
    2011/08/cg-pr.htmlHTML validatorCSS validatorNamespaces checker
    2012/04/membership2012-testimonialsHTML validatorCSS validatorNamespaces checker
    2012/04/membership2012.html.enHTML validatorCSS validatorNamespaces checker
    2012/ldp/HTML validatorCSS validatorNamespaces checker
    2012/ldp/charter.htmlHTML validatorCSS validatorNamespaces checker
    Consortium/activitiesHTML validatorCSS validatorNamespaces checker
    Help/Account/Request/MemberHTML validatorCSS validatorNamespaces checker
    Member/Meeting/2012ac/May/OverviewHTML validatorCSS validatorNamespaces checker
    People/Dom/HTML validatorCSS validatorNamespaces checker
    People/Jacobs/HTML validatorCSS validatorNamespaces checker
    People/mcf/HTML validatorCSS validatorNamespaces checker
    QA/2012/05/events_on_interoperability_for.htmlHTML validatorCSS validatorNamespaces checker
    QA/2012/05/help_create_a_world_of_mobile_web_apps.htmlHTML validatorCSS validatorNamespaces checker
    QA/2012/05/interview_bbc_on_publishing_an.htmlHTML validatorCSS validatorNamespaces checker
    TR/2012/CR-emotionml-20120510/HTML validatorCSS validatorNamespaces checker
    TR/2012/NOTE-emotion-voc-20120510/HTML validatorCSS validatorNamespaces checker
    TR/2012/PR-geolocation-API-20120510/HTML validatorCSS validatorNamespaces checker
    community/about/agreements/summary/HTML validatorCSS validatorNamespaces checker

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 0001

This version:
http://www.w3.org/TR/0001/WD-sampleml1-0001MMDD/
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.589 2012/04/03 13:19:05 denis Exp $