Copy the template locally.
For your convenience, here is a list of current templates at the time of edition of this manual (2006-09):
(If you are looking for a report template that is not listed, please check its Working Group page.)
Rename it for your specific user agent, optionally with version number and OS, e.g.:
implementreportIE517Mac9.html
and keep it to a max of 31 characters (including extension) if you want to be friendly to MacOS9 users.
Include this information in the title
and h1
elements also, by replacing the all CAPS word "TEMPLATE" with a string
representative of the user agent name, version, and operating system(s)
e.g.:
<h1>Selectors implementation report IE5.1.7/MacOS9</h1>
Search and replace all occurances of the string
"/current/
" with the particular YYYYMMDD
of the
test suite version you are using.
Note: The template may already be tied to a particular version of the test suite, since additions in the test suite are likely to require changes in the template.
Fill in the proper information in the top section for:
If your user agent only supports some of the languages listed (e.g. only HTML and XML, but not XML with Namespaces or thus XHTML), then:
class='na'
(or add "na
" to the class
attribute already present) to the hyperlink markup for tests in those
columns.The determination of whether a UA supports a language is for markup
language support, and is independent of any support (or lack thereof) for
any CSS feature (e.g.
@namespace
).
Run the tests (using the test suite navigation pages or by clicking on the hyperlinks in the results table).
Record the results in the report by annotating the respective hyperlinks to the tests in each column with the following class names:
Presence of unnecessary XML prolog. The XML prolog, e.g.:
<?xml version="1.0"?>
is both unnecessary and undesirable in a simple XHTML document that is intended to be backward compatible (see XHTML 1.0 Appendix C).
Solution: remove any XML prolog.
Missing DOCTYPE
. Some editors appear to remove the
DOCTYPE from a valid XHTML document.
Solution: Please be sure that your report has a DOCTYPE, e.g:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
at the top of the document (there should be nothing before it).
Invalid document. Some editors appear to make the document invalid.
Solution: Please be sure to validate your report with the W3C validator: http://validator.w3.org/
Generic filename. Do not use a file name like
"report.html
", as that lacks any information about the
purpose and user agent, and impedes/complicates efforts to place multiple
reports in a single directory.
Solution: Replace the all CAPS word "TEMPLATE" in the template file name:
implementreportTEMPLATE.html
with an abbreviation for your specific user agent, optionally with version number and OS, e.g.:
implementreportIE517Mac9.html
and keep it to a max of 31 characters (including extension) if you want to be friendly to MacOS9 users.
Generic title
/h1
tags. Some folks appear
to simply delete the word "TEMPLATE" from the title
and
h1
tags in the report template. This is suboptimal.
Solution: Replacing the all CAPS word "TEMPLATE" in
the title
and h1
elements in the template with
a string representative of the user agent name, version, and operating
system(s) e.g.:
Change:
<h1>Selectors implementation report TEMPLATE</h1>
To the equivalent of (for your user agent):
<h1>Selectors implementation report IE5.1.7/MacOS9</h1>