This Guidebook is the collected wisdom of the W3C Group Chairs and other collaborators.
This Pubrules checker is now deprecated. Please use the new pubrules checker.
This resource provides three services:
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.
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:
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.
http://www.w3.org/StyleSheets/TR/2016/W3C-WDhttp://www.w3.org/StyleSheets/TR/2016/W3C-CRhttp://www.w3.org/StyleSheets/TR/2016/W3C-PRhttp://www.w3.org/StyleSheets/TR/2016/W3C-REChttp://www.w3.org/StyleSheets/TR/2016/W3C-PERhttp://www.w3.org/StyleSheets/TR/2016/W3C-RSCNDhttp://www.w3.org/StyleSheets/TR/2016/W3C-WG-NOTEhttp://www.w3.org/StyleSheets/TR/2016/W3C-IG-NOTEhttp://www.w3.org/StyleSheets/TR/2016/W3C-CG-NOTEhttp://www.w3.org/StyleSheets/TR/2016/W3C-Member-SUBMhttp://www.w3.org/StyleSheets/TR/2016/W3C-Team-SUBMhttp://www.w3.org/StyleSheets/TR/2016/W3C-XGR
Include this source code:
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/2016/W3C-WDhttp://www.w3.org/StyleSheets/TR/2016/W3C-CRhttp://www.w3.org/StyleSheets/TR/2016/W3C-PRhttp://www.w3.org/StyleSheets/TR/2016/W3C-REChttp://www.w3.org/StyleSheets/TR/2016/W3C-PERhttp://www.w3.org/StyleSheets/TR/2016/W3C-RSCNDhttp://www.w3.org/StyleSheets/TR/2016/W3C-WG-NOTEhttp://www.w3.org/StyleSheets/TR/2016/W3C-IG-NOTEhttp://www.w3.org/StyleSheets/TR/2016/W3C-CG-NOTEhttp://www.w3.org/StyleSheets/TR/2016/W3C-Member-SUBMhttp://www.w3.org/StyleSheets/TR/2016/2016/W3C-Team-SUBMhttp://www.w3.org/StyleSheets/TR/2016/W3C-XGR"/>
Include this source code:
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
See also Style Guidelines for Group-Internal Drafts.
hr
element after the
copyright MAY appear inside
or after the div
element.
Editors SHOULD NOT include
other information in this section.title
element and in an h1
element.h2
element as follows (see also
date syntax):
<h2>W3C STATUS 14 August YYYY</h2>
If this is a modified Recommendation that was modified in place or is a new edition, the document MUST include both the original publication date and the modification date. For example:
<h2>W3C Recommendation 7 April 2004, edited in place 19 August2004</h2>
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.
<p>Please check the <a
href="http://www.w3.org/..."><strong>errata</strong></a>
for any errors or issues reported since publication.</p>
The order of the a
and strong
elements
MAY be reversed.
See also suggestions on errata page
structure in the Manual of Style. Note: Do not
put the errata document in TR space as the expectation is that
we will not modify document in TR space after publication; see the policy for
in-place modification of
W3C Technical Reports.
<p>This document is also available in these
non-normative formats:
<a href="STATUS-shortname-20020101.html">single HTML
file</a>, <a href="STATUS-shortname-20020101.tgz">gzipped tar file of
HTML</a>.</p>
<a href="shortname-20020101.html">single HTML
file</a>, <a href="shortname-20020101.tgz">gzipped tar file of HTML</a>.</p>
<p>See also
<a href="
http://www.w3.org/2003/03/Translations/byTechnology?technology=shortname">
<strong>translations</strong></a>.</p>
See suggestions on translations in the manual of style.
hr
) MUST
follow the copyright.h2
element with content "Abstract" that follows the hr
element.h2
element with content "Status of This
Document". The Team maintains the status section of a 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/.
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.
This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of Final Incubator Group Reports is available. See also the W3C technical reports index at http://www.w3.org/TR/.
Publication as a an STATUS 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 has been reviewed by W3C Members, by software developers, and by other W3C groups and interested parties, and is endorsed by the Director as a W3C Recommendation. It is a stable document and may be used as reference material or cited from another document. W3C's role in making the Recommendation is to draw attention to the specification and to promote its widespread deployment. This enhances the functionality and interoperability of the Web.
Publication of this document by W3C as part of the W3C Incubator Activity 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. Participation in Incubator Groups and publication of Incubator Group Reports at the W3C site are benefits of W3C Membership.
This document was produced by a group operating under the 5 February 2004 W3C Patent Policy. This document was produced by a group operating under the 5 February 2004 W3C Patent Policy. This document is governed by the 24 January 2002 CPP as amended by the W3C Patent Policy Transition Procedure. This document is governed by the 24 January 2002 CPP as amended by the W3C Patent Policy Transition Procedure. The group does not expect this document to become a W3C Recommendation. This document is informative only. 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.
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.
The disclosure obligations of the Participants of this group are described in the charter.
Incubator Groups have as a goal to produce work that can be implemented on a Royalty Free basis, as defined in the W3C Patent Policy. Participants in this Incubator Group have made no statements about whether they will offer licenses according to the licensing requirements of the W3C Patent Policy for portions of this Incubator Group Report that are subsequently incorporated in a W3C Recommendation.
This document is governed by the 1 September 2015 W3C Process Document. 14 October 2005 W3C Process Document.
h2
element with content
"Table of Contents".Include this source code:
<nav id="toc"><h2>Table of Contents</h2>
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.fixup.js
.
Include this source code:
<script src="//www.w3.org/scripts/TR/2016/fixup.js"></script>
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:
title
element includes document title.<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-WD" />
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-CR" />
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-PR" />
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-REC" />
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-PER" />
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-RSCND" />
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-WG-NOTE"
/>
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-IG-NOTE"
/>
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-CG-NOTE"
/>
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-Member-SUBM"
/>
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-Team-SUBM"
/>
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-XGR" />
Please refer to the errata for this document, which may include some normative corrections.
This document is also available in these non-normative formats: ...links to formats here....
See also translations.
Copyright © YYYY ...copyright holder information .... This document is available under the W3C Document License. See the W3C Intellectual Rights Notice and Legal Disclaimers for additional information.
Copyright © YYYY W3C® (MIT, ERCIM, Keio, Beihang). W3C liability, trademark document use rules apply.
....abstract 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/.
This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of Final Incubator Group Reports is available. See also the W3C technical reports index at http://www.w3.org/TR/.
This is a First Public both a First Public Working Draft and a Last Call a Last Call Working Draft of "SampleML 1.0." "SampleML 1.0 (Second Edition)." "SampleML 1.1." The W3C Membership and other interested parties are invited to review the document and send comments to public-mailing-list@w3.org (with public archive) through DD Month YYYY.
W3C publishes a Candidate Recommendation to indicate that the document is believed to be stable and to encourage implementation by the developer community. The Sample Working Group expects to request that the Director advance this document to Proposed Recommendation once the Working Group has ...your PR entrance criteria here.... The Sample Working Group, working closely with the developer community, expects to show these implementations by ...estimate of when requirements will be fulfilled.... This estimate is based on the Working Group's preliminary implementation report. The Working Group expects to revise this report over the course of the implementation period. The Working Group does not plan to request to advance to Proposed Recommendation prior to DD Month YYYY.
The W3C Membership and other interested parties are invited to review the document and send comments to public-mailing-list@w3.org (with public archive) through DD Month YYYY. Advisory Committee Representatives should consult their WBS questionnaires. Note that substantive technical comments were expected during the Last Call review period that ended DD Month YYY.
Please see the Working Group's implementation report (...or a statement that no report was used as part of the Director's decision...).
The following features have been identified as "features at risk" by the Sample Working Group: ...list of features or link to list of features...
This Recommendation is an editorial revision of supersedes SampleML 1.0, which was published DD Month YYYY. ...State here what is expected of various audiences, such as authors, authoring tool developers, and user agent developers....
W3C has chosen to rescind the SampleML 1.0 Recommendation for the following reasons: ...list of reasons.... For additional information about replacement or alternative technologies, please refer to ...reference to information....
...Your custom paragraph here; see examples ... ...If the document was published due to a W3C decision to stop work on this material, include rationale for that decision...
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. The list also indicates those changes that may affect conformance with respect to the Candidate Recommendation.
This document was developed by the Sample Incubator Group.
At the time of this publication, the most recent W3C Recommendation of SampleML 1.x is the DD Month YYYY SampleML 1.0 Recommendation.
...indicate the level of endorsement within the group Team for the material, set expectations that the group Team has completed work on the topics covered by the document, and set expectations about the group's Team's commitment to respond to comments about the document....
Please send comments about this document to public-mailing-list@w3.org (with public archive).
This document has been reviewed by W3C Members, by software developers, and by other W3C groups and interested parties, and is endorsed by the Director as a W3C Recommendation. It is a stable document and may be used as reference material or cited from another document. W3C's role in making the Recommendation is to draw attention to the specification and to promote its widespread deployment. This enhances the functionality and interoperability of the Web.
Publication as a an STATUS 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.
Publication of this document by W3C as part of the W3C Incubator Activity 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. Participation in Incubator Groups and publication of Incubator Group Reports at the W3C site are benefits of W3C Membership.
...Optional custom paragraph here...
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.
Please consult the complete list of Team Submissions.