Three Services: Pubrules, Checker, Sample
This resource provides three services:
-
Pubrules filter,
which shows only the relevant requirements for publication of a
W3C Technical Report, Submission, or
Incubator Report.
- 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.
- 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:
- Document type:
Incubator Group Report
-
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.
-
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.
- 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.
-
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-XGR
Include this source code:
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-XGR"/>
-
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
-
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
-
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>
-
logoTest In addition to the W3C logo, use
this logo:
Include this source code:
<a href="http://www.w3.org/2005/Incubator/XGR/">
<img height="48" width="160" alt="W3C Incubator Report" src="http://www.w3.org/2005/Incubator/images/XGR"/></a>
Title, Date, Maturity Level
-
titleTest The document's title MUST be in the
title element and in an h1 element.
- Technical report version information, i.e., version and edition numbers.
- See the (non-normative)
Version Management in W3C Technical Reports
for more information
-
dateTitleH2Test The document's status and date MUST be in
an
h2 element as follows (see also
date syntax):
<h2>W3C Incubator Group Report 14 August 2006</h2>
Document Identifiers
-
docIDOrder
Document identifier information MUST be
present in this order:
-
docIDThisVersion
The syntax of a "This Version" URI
SHOULD
be
<http://www.w3.org/2005/Incubator/xgname/XGR-shortname-2006MMDD/>.
-
docIDLatestVersion
The syntax of a "Latest Version" URI
SHOULD
be
<http://www.w3.org/2005/Incubator/xgname/XGR-shortname/>.
Editor/Author Information
-
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 , 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
- 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="shortname-20020101.html">single HTML
file</a>, <a href="shortname-20020101.tgz">gzipped tar file of HTML</a>.</p>
Copyright Information
-
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> © 2006 <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>, <a href="http://ev.buaa.edu.cn/">Beihang</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>
-
hrAfterCopyrightTest A horizontal rule (
hr) MUST
follow the copyright.
4. Document Abstract
-
abstractTest There MUST be an abstract, labeled with an
h2 element with content "Abstract" that follows the hr element.
5. Document Status Section
-
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.
-
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 Final Incubator Group Reports is available. See also 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 <a href="http://www.w3.org/2005/Incubator/XGR/">Final Incubator Group Reports</a> is available. See also the <a href="http://www.w3.org/TR/">W3C technical reports index</a>
at http://www.w3.org/TR/.</em></p>
-
datesFormatTest All dates MUST have the form DD Month YYYY. A leading zero
in the day is OPTIONAL.
-
XGLinkTest
It MUST include the name of the W3C Incubator Group that produced the document. The name MUST be
a link to a public page for the group.
-
stabilityTest It MUST set expectations about the stability of the
document. The RECOMMENDED text is:
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.
Include this source code:
<p>Publication of this document by W3C as part of the <a href="http://www.w3.org/2005/Incubator/">W3C Incubator Activity</a>
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 <a href="http://www.w3.org/Consortium/join">W3C Membership</a>.</p>
-
Note:
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. Please contact the Communications Team for information about what text to include related to patent policy requirements. Sample
text for XGs where Participants have made no statements:
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.
Include this source code:
<p>Incubator Groups have as a <a href="http://www.w3.org/2005/Incubator/procedures.html#Patent">goal</a>
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
<a href="http://www.w3.org/Consortium/Patent-Policy-20030520.html#sec-Requirements">licensing requirements of the W3C Patent Policy</a>
for portions of this Incubator Group Report that are subsequently
incorporated in a W3C Recommendation.</p>
6. Table of Contents
-
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
-
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.
-
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.
-
cssValideTest
recursive
The document MUST NOT have any style sheet
errors.
-
namespacesTest
recursive
All proposed XML namespaces
created by the publication of the document MUST
follow
URIs for W3C Namespaces
.
-
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
-
compoundFilesLocationTest If the document is compound (i.e., if it consists of more than one
file), all the files MUST be under a directory
/2005/Incubator/xgname/XGR-shortname-2006MMDD/
-
compoundOverviewTestThe main
page SHOULD be called Overview.html.
-
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:
-
title element includes document title.
- Link to style sheet in head:
<link rel="stylesheet" type="text/css"
href="http://www.w3.org/StyleSheets/TR/W3C-XGR" />
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 Final Incubator Group Reports is available. See also the W3C technical reports index
at http://www.w3.org/TR/.
...Your custom paragraph here; see examples ...
This document was developed by the
Sample Incubator Group.
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.
...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.
Please contact the Communications Team for information about what text to include related to patent policy requirements...