html/whatpm/readme.en.html

<!DOCTYPE html>
<html lang="en">
<head>
<title>Whatpm &mdash; Perl Modules for Web Hypertext Application 
Technologies (beta)</title>
<link rel="stylesheet" href="http://suika.fam.cx/www/style/html/xhtml">
<link rel="license" href="#license">
<link rel="author" href="#author">
</head>
<body>
<h1>Whatpm (<em>beta</em>)</h1>

<div class="section" id="introduction">
<h2>Introduction</h2>

<p><dfn>Whatpm</dfn> is a <em>work-in-progress</em> set of
<mark>P</mark>erl <mark>m</mark>odules for <mark>W</mark>eb
<mark>h</mark>ypertext <mark>a</mark>pplication
<mark>t</mark>echnologies.  It is part of the <a
href="http://suika.fam.cx/www/2006/manakai/" rel=up>manakai</a>
project.</p>

<p>Whatpm supports various Web standard technologies, including <a
href="#modules-html">HTML, XHTML</a>, <a href="#modules-xml">XML</a>,
<a hreF="#modules-css">CSS</a>, <a href="#modules-http">HTTP</a>, and
<a href="#modules-url">URL</a>.
</div>

<div class=section id=modules>
<h2>Modules</h2>

<div class=section id=modules-html-xml>
<h3>Modules for HTML and XML</h3>

<p id=modules-html>Modules related to HTML and XHTML are as follows:
<dl>
<dt id=module-whatpm-html><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>
  <dd>An implementation of HTML5 document and fragment
  parsing algorithms.  It can be used
  to convert an arbitrary string into a 
  <abbr title="Document Object Model">DOM</abbr>.  (See also
  <a href="#demo-html-parser">demo</a>.)</dd>
<dt id=module-whatpm-html-serializer><a href="Whatpm/HTML/Serializer.html"><code>Whatpm::HTML::Serializer</code></a></dt>
  <dd>An implementation of HTML5 fragment serialization algorithm.
  (See also <a href="#demo-html-parser">demo</a>.)</dd>
<dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>
  <dd>An implementation of the HTML5 table algorithm.  It can be
  used to extract a table structure from a DOM <code>table</code>
  element node.  (See also <a href="#demo-html-table">demo</a>.)</dd>
</dl>

<p id=modules-xml>The module for <i>tentative</i> XML support is as follow:
<dl>
<dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
  <dd>A simple XML serializer.</dd>
</dl>

<p><i>Real</i> XML parser and serializer are currently not available yet.

<p id=modules-cc>The module for conformance checking of a DOM tree (i.e.
a in-memory representation of a HTML or XML document) is as follows:
<dl>
<dt><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt>
  <dd>A DOM5 HTML (in-memory representation of a document) conformance
  checker with a partial support for Atom 1.0.  (See also
  <a href="#demo-html-parser">demo</a>.)</dd>
</dl>

<p>Currently, conformance checking of HTML/XHTML and Atom documents
is supported.
</div>

<div class=section id=modules-css>
<h3>Modules for CSS</h3>

<p>Modules for CSS and related technologies are as follows:
<dl>
<dt><a href="Whatpm/CSS/Cascade.html"><code>Whatpm::CSS::Cascade</code></a>
  <dd>A media-independent implementation of CSS cascading and value
  computation.  (See also <a href="#demo-css-parser">demo</a>.)
<dt><a href="Whatpm/CSS/Parser.html"><code>Whatpm::CSS::Parser</code></a>
  <dd>A CSS parser that constructs CSSOM trees from style sheets.  (See
  also <a href="#demo-css-parser">demo</a>.)
<dt><a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a></dt>
  <dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of
  selectors</a> parser.  (See also <a href="#demo-css-parser">demo</a>.)</dd>
<dt><a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a></dt>
  <dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of
  selectors</a> serializer.  (See also <a href="#spec-ssft">specification</a>
  and <a href="#demo-css-parser">demo</a>.)</dd>
<dt><a href="Whatpm/CSS/Tokenizer.html"><code>Whatpm::CSS::Tokenizer</code></a></dt>
  <dd>A CSS tokenizer.  (See also <a href="#demo-css-parser">demo</a>.)</dd>
</dl>
</div>

<div class=section id=modules-http>
<h3>Modules for HTTP</h3>

<p>Modules for HTTP and related technologies are as follows:
<dl>
<dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>
  <dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>
<dt><a href="Whatpm/IMTChecker.html"><code>Whatpm::IMTChecker</code></a></dt>
  <dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label
  conformance checker.</dd>
</dl>

<p>Currently, support for parsing of HTTP headers and as such is not
yet available.
</div>

<div class=section id=modules-url>
<h3>Module for URL</h3>

<p>Module for the URL support is as follows:
<dl>
<dt><a href="Whatpm/URIChecker.html"><code>Whatpm::URIChecker</code></a></dt>
  <dd>An IRI reference conformance checker.</dd>
</dl>

<p>Support for HTML5's realistic definition of URL is not available yet.
</div>

<div class=section id=modules-misc>
<h3>Modules for other technologies</h3>

<p>Following modules provide support for other Web-related technologies:
<dl>
<dt><a href="Whatpm/CacheManifest.html"><code>Whatpm::CacheManifest</code></a></dt>
  <dd>An
  <a href="http://www.whatwg.org/specs/web-apps/current-work/#manifests">HTML5
  cache manifest</a> parser.</dd>
<dt id=whatpm-charset-universalchardet><a href="Whatpm/Charset/UniversalCharDet.html"><code>Whatpm::Charset::UniversalCharDet</code></a></dt>
  <dd>A Perl interface to universalchardet character encoding detection
  library.</dd>
  <dt><a href="Whatpm/LangTag.html"><code>Whatpm::LangTag</code></a>
    <dd>A language tag parser and conformance checker, supporting both
    older RFC 3066 definition and latest RFC 4646 definition.  (See also
    <a href="#demo-langtag">demo</a>.)
<dt><a href="Whatpm/WebIDL.html"><code>Whatpm::WebIDL</code></a></dt>
  <dd>A WebIDL fragment parser.  It parses an IDL fragment, whether conforming
  or not, and constructs a DOM-like object model for further processing.
  Non-conforming (or broken) IDL fragment-like string will be parsed using
  CSS-like error-tolerant parsing rules, e.g. ignoring anything until next
  <code>;</code> character.
</dl>
</div>

  <p>Note that all of these modules are <em>work in progress</em>
  and have <a href="#todo">a number of unresolved problems</a>.</p>

  <p>Note also that some modules have no documentation for now.</p>

<!-- Whatpm::ContentChecker::*, Whatpm::H2H, Whatpm::NanoDOM, and
     Whatpm::XMLParser are intentionally omitted from the list. -->
</div>

<div class=section id=documents>
<h2>Documents</h2>

<p>For the description of functionalities provided by each module, see
<abbr>pod</abbr> documentation of the module.  HTML version of
<abbr>pod</abbr> documentations are linked from the <a
href="#modules">list of modules above</a>.

<p>In addition, there are additional documents for some topics:
<dl>
<dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
<!-- @@ TODO: Need to update the link - the document above is out of date -->
  <dd>Description of errors to be notified to callback functions by Whatpm
  modules.</dd>

<dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>
  <dd>Description of data structure for Selectors, as implemented by
  <a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a>
  (as output), and
  <a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a>
  (as input)<!--, and
  <a href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/SelectorsAPI.html"><code>Message::DOM::SelectorsAPI</code></a>-->.</dd>

<dt id=doc-user-data-names><a href="http://suika.fam.cx/gate/2005/sw/manakai/Predefined%20User%20Data%20Names">List of predefined user data names</a></dt>
  <dd>List of user data names defined by Whatpm modules.</dd>

<dt id=doc-handles><a href="Whatpm/Charset/handles">Handle objects</a>
  <dd>Description of character or byte stream input handle interfaces.
</dl>

<p>Following specifications define Whatpm-specific formats and extensions:
<dl id=spec>
<dt id=spec-ssft><a href="http://suika.fam.cx/www/markup/selectors/ssft/ssft"><abbr title="Selectors Serialization Format for Testing">SSFT</abbr>
Specification</a></dt>
  <dd>The specification for the serialization format used for
  testing Selectors-related modules.</dd>

<dt id=spec-manakai-selectors"><a href="http://suika.fam.cx/gate/2005/sw/manakai/Selectors%20Extensions">manakai's
Selectors Extensions</a></dt>
  <dd>The specification for <code>:-manakai-<var>*</var></code>
  pseudo-classes implemented by Selectors-related modules.</dd>
</dl>
</div>

<div class="section" id="demo">
<h2>Demo</h2>

<ul>
<li id=demo-html-parser-nanodom><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser 
and checker demo</a>
(<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser.cgi">source</a>, 
with <a href="Whatpm/NanoDOM.html">a lightweight non-conforming 
DOM implementation</a>)</li>
<li id=demo-html-parser-manakai><a href="http://suika.fam.cx/gate/2007/html/parser-manakai-interface">HTML5
parser and checker demo, with manakai's DOM implementation</a>
(<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser-manakai.cgi">source</a>)</li>
<li id=demo-html-table><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table
structure visualization demo</a>
(<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/table.cgi">source</a>)</li>

<li id=demo-css-parser><a href="http://suika.fam.cx/gate/2007/css/parser-interface">CSS
tokenizer, parser, and computed style computation demo</a>
(<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/css/parser.cgi">source</a>)</li>

<li id=demo-langtag><a href="http://suika.fam.cx/gate/2007/langtag/langtag-demo-interface">Language
tag parsing and conformance checking demo</a>
(<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/langtag/langtag-demo.cgi">source</a>)
</ul>
</div>

<div class=section id=applications>
<h2>Application</h2>

<ul>
<li><a href="http://suika.fam.cx/gate/2007/html/cc/"><abbr>WebHACC</abbr> 
(Web hypertext application conformance checker)</a>
</ul>
</div>

<div class="section" id="dependency">
<h2>Dependency</h2>

<dl>
<dt id=dependency-perl>Perl 5.8 or later</dt>
  <dd>It is recommended to use newer stable release of Perl 5.8 (or
  later).</dd>
  <dd id=dependency-encode>Some modules require <code>Encode</code>
  modules, which are part of standard Perl distribution.</dd>
<dt id=dependency-manakai-core>Modules from
<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a></dt>
  <dd>
    <dl>
<dt id=dependency-error><a href="http://search.cpan.org/author/SHLOMIF/Error-0.17009/lib/Error.pm"><code>Error</code></a></dt>
  <dd>Module <code>Whatpm::HTML</code> requires <code>Error</code>,
  which is bundled in
  <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
<dt><code>Message::IMT::InternetMediaType</code></dt>
  <dd>Module <code>Whatpm::IMTChecker</code> depends on
  <code>Message::IMT::InternetMediaType</code>, which is part of 
  <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
<dt><code>Message::URI::URIReference</code></dt>
  <dd>Modules <code>Whatpm::URIChecker</code> and 
  <code>Whatpm::CacheManifest</code> depend on
  <a href="http://suika.fam.cx/www/manakai-core/lib/Message/URI/URIReference.html"><code>Message::URI::URIReference</code></a>,
  which is part of 
  <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
  <dt><code>Message::Charset::Info</code></dt>
    <dd>Module <code>Whatpm::ContentChecker</code> depends on
    <a href="http://suika.fam.cx/www/manakai-core/lib/Message/Charset/Info.html"><code>Message::Charset::Info</code></a>,
    which is part of
    <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
<dt><code>Message::DOM::DOMImplementation</code>
  <dd>Module <code>Whatpm::URIChecker</code> depends on
  <code>Message::DOM::DOMImplementation</code>,
    which is part of
    <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
<dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
  <dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
  depends on <code>Message::DOM::DOMImplementation</code> and related modules
  in <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
  They are not required in practice.</dd>
    </dl>
  </dd>
<dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai 
charlib</a></dt>
  <dd>Module <code>Whatpm::Charset::DecodeHandle</code> depends on
  modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
  charlib</a> for decoding of <em>Japanese character encodings</em>.
  See the documentation for 
  <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
  charlib</a> for more information.</dd>
<dt><a href="http://www.python.org/">Python</a>, Perl 
<a href="http://search.cpan.org/~neilw/Inline-Python-0.22/"><code>Inline::Python</code></a>
module, and <a href="http://chardet.feedparser.org/">Universal Encoding
Detector</a></dt>
  <dd>For the module <code>Whatpm::Charset::UniversalCharDet</code> being
  meaningful, these softwares are required on the system.  See the
  <a href="Whatpm/Charset/UniversalCharDet.html#dependency">documentation</a>
  for more information.</dd>
<dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>
  <dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and
  <code>Whatpm::CSS::Tokenizer</code>
  depends on <a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code> and related modules</a>.
  They are not required in practice.</dd>
</dl>
</div>

<div class="section" id="download">
<h2>Distribution</h2>

<p>The development version of Whatpm may be found in the 
<a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS 
repository</a>.</p>

<p><a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/whatpm.tar.gz?tarball=1">The
latest developmenet version of the Whatpm</a> is also available as a
tarball.

</div>

<div class="section" id="todo">
<h2>TO DO</h2>

<ul>
  <li>Bug fix (Test results: 
    <a href="t/content-type-result"><code>Whatpm::ContentType</code></a>,
    <a href="t/tokenizer-result">HTML tokenization</a>,
    <a href="t/tree-construction-result">HTML tree construction</a>,
    <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
  <li>Merge with the <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>
      code tree.
  <li>Charset detection.</li>
  <li>Validation for <code>meta</code>.</li>
  <li>Validation for media queries, IRIs (against URI schemes), language tags,
    and so on.</li>
  <li>Documentations are missing for some features.</li>
  <li>XML parser<!-- with application cache selection algorithm hook-->.</li>
  <li>In addition, each module has its own TO DO items.
    (Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>
</ul>
</div>

<div class=section id=acknowledgments>
<h2>Acknowledgments</h2>

<p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a> 
team for their
<a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5 
parser test data</a>.</p>
</div>

<div class="section" id="author">
<h2>Author</h2>

<p><a href="http://suika.fam.cx/~wakaba/who?" rel="author">Wakaba</a>.</p>
</div>

<div class="section" id="license">
<h2>License</h2>

<p>Copyright 2007$B!>(B2008 Wakaba 
<code class="mail">&lt;<a href="mailto:w@suika.fam.cx"
    rel="author">w@suika.fam.cx</a>></code>.</p>

<p>This library is free software; you can redistribute it and/or modify 
it under the same terms as Perl itself.</p>
</div>

</body>
</html>
1	wakaba	1.1	<!DOCTYPE html>
2			<html lang="en">
3			<head>
4			<title>Whatpm — Perl Modules for Web Hypertext Application
5	wakaba	1.2	Technologies (beta)</title>
6	wakaba	1.1	<link rel="stylesheet" href="http://suika.fam.cx/www/style/html/xhtml">
7			<link rel="license" href="#license">
8			<link rel="author" href="#author">
9			</head>
10			<body>
11	wakaba	1.2	<h1>Whatpm (<em>beta</em>)</h1>
12	wakaba	1.1
13			<div class="section" id="introduction">
14			<h2>Introduction</h2>
15
16	wakaba	1.26	<p><dfn>Whatpm</dfn> is a <em>work-in-progress</em> set of
17			<mark>P</mark>erl <mark>m</mark>odules for <mark>W</mark>eb
18			<mark>h</mark>ypertext <mark>a</mark>pplication
19			<mark>t</mark>echnologies. It is part of the <a
20			href="http://suika.fam.cx/www/2006/manakai/" rel=up>manakai</a>
21	wakaba	1.8	project.</p>
22	wakaba	1.1
23	wakaba	1.26	<p>Whatpm supports various Web standard technologies, including <a
24			href="#modules-html">HTML, XHTML</a>, <a href="#modules-xml">XML</a>,
25			<a hreF="#modules-css">CSS</a>, <a href="#modules-http">HTTP</a>, and
26			<a href="#modules-url">URL</a>.
27			</div>
28
29			<div class=section id=modules>
30			<h2>Modules</h2>
31
32			<div class=section id=modules-html-xml>
33			<h3>Modules for HTML and XML</h3>
34
35			<p id=modules-html>Modules related to HTML and XHTML are as follows:
36			<dl>
37			<dt id=module-whatpm-html><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>
38			<dd>An implementation of HTML5 document and fragment
39			parsing algorithms. It can be used
40			to convert an arbitrary string into a
41			<abbr title="Document Object Model">DOM</abbr>. (See also
42			<a href="#demo-html-parser">demo</a>.)</dd>
43			<dt id=module-whatpm-html-serializer><a href="Whatpm/HTML/Serializer.html"><code>Whatpm::HTML::Serializer</code></a></dt>
44			<dd>An implementation of HTML5 fragment serialization algorithm.
45			(See also <a href="#demo-html-parser">demo</a>.)</dd>
46			<dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>
47			<dd>An implementation of the HTML5 table algorithm. It can be
48			used to extract a table structure from a DOM <code>table</code>
49			element node. (See also <a href="#demo-html-table">demo</a>.)</dd>
50			</dl>
51
52			<p id=modules-xml>The module for <i>tentative</i> XML support is as follow:
53			<dl>
54			<dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
55			<dd>A simple XML serializer.</dd>
56			</dl>
57
58			<p><i>Real</i> XML parser and serializer are currently not available yet.
59
60			<p id=modules-cc>The module for conformance checking of a DOM tree (i.e.
61			a in-memory representation of a HTML or XML document) is as follows:
62	wakaba	1.1	<dl>
63	wakaba	1.4	<dt><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt>
64			<dd>A DOM5 HTML (in-memory representation of a document) conformance
65	wakaba	1.11	checker with a partial support for Atom 1.0. (See also
66			<a href="#demo-html-parser">demo</a>.)</dd>
67	wakaba	1.26	</dl>
68
69			<p>Currently, conformance checking of HTML/XHTML and Atom documents
70			is supported.
71			</div>
72	wakaba	1.25
73	wakaba	1.26	<div class=section id=modules-css>
74			<h3>Modules for CSS</h3>
75	wakaba	1.25
76	wakaba	1.26	<p>Modules for CSS and related technologies are as follows:
77			<dl>
78			<dt><a href="Whatpm/CSS/Cascade.html"><code>Whatpm::CSS::Cascade</code></a>
79			<dd>A media-independent implementation of CSS cascading and value
80			computation. (See also <a href="#demo-css-parser">demo</a>.)
81			<dt><a href="Whatpm/CSS/Parser.html"><code>Whatpm::CSS::Parser</code></a>
82			<dd>A CSS parser that constructs CSSOM trees from style sheets. (See
83			also <a href="#demo-css-parser">demo</a>.)
84	wakaba	1.10	<dt><a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a></dt>
85			<dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of
86	wakaba	1.11	selectors</a> parser. (See also <a href="#demo-css-parser">demo</a>.)</dd>
87	wakaba	1.10	<dt><a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a></dt>
88			<dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of
89	wakaba	1.11	selectors</a> serializer. (See also <a href="#spec-ssft">specification</a>
90			and <a href="#demo-css-parser">demo</a>.)</dd>
91	wakaba	1.9	<dt><a href="Whatpm/CSS/Tokenizer.html"><code>Whatpm::CSS::Tokenizer</code></a></dt>
92	wakaba	1.11	<dd>A CSS tokenizer. (See also <a href="#demo-css-parser">demo</a>.)</dd>
93	wakaba	1.26	</dl>
94			</div>
95
96			<div class=section id=modules-http>
97			<h3>Modules for HTTP</h3>
98
99			<p>Modules for HTTP and related technologies are as follows:
100			<dl>
101			<dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>
102			<dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>
103	wakaba	1.4	<dt><a href="Whatpm/IMTChecker.html"><code>Whatpm::IMTChecker</code></a></dt>
104	wakaba	1.5	<dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label
105	wakaba	1.4	conformance checker.</dd>
106	wakaba	1.26	</dl>
107
108			<p>Currently, support for parsing of HTTP headers and as such is not
109			yet available.
110			</div>
111
112			<div class=section id=modules-url>
113			<h3>Module for URL</h3>
114	wakaba	1.25
115	wakaba	1.26	<p>Module for the URL support is as follows:
116			<dl>
117	wakaba	1.4	<dt><a href="Whatpm/URIChecker.html"><code>Whatpm::URIChecker</code></a></dt>
118			<dd>An IRI reference conformance checker.</dd>
119	wakaba	1.26	</dl>
120
121			<p>Support for HTML5's realistic definition of URL is not available yet.
122			</div>
123	wakaba	1.22
124	wakaba	1.26	<div class=section id=modules-misc>
125			<h3>Modules for other technologies</h3>
126
127			<p>Following modules provide support for other Web-related technologies:
128			<dl>
129			<dt><a href="Whatpm/CacheManifest.html"><code>Whatpm::CacheManifest</code></a></dt>
130			<dd>An
131			<a href="http://www.whatwg.org/specs/web-apps/current-work/#manifests">HTML5
132			cache manifest</a> parser.</dd>
133			<dt id=whatpm-charset-universalchardet><a href="Whatpm/Charset/UniversalCharDet.html"><code>Whatpm::Charset::UniversalCharDet</code></a></dt>
134			<dd>A Perl interface to universalchardet character encoding detection
135			library.</dd>
136			<dt><a href="Whatpm/LangTag.html"><code>Whatpm::LangTag</code></a>
137			<dd>A language tag parser and conformance checker, supporting both
138			older RFC 3066 definition and latest RFC 4646 definition. (See also
139			<a href="#demo-langtag">demo</a>.)
140	wakaba	1.22	<dt><a href="Whatpm/WebIDL.html"><code>Whatpm::WebIDL</code></a></dt>
141			<dd>A WebIDL fragment parser. It parses an IDL fragment, whether conforming
142			or not, and constructs a DOM-like object model for further processing.
143			Non-conforming (or broken) IDL fragment-like string will be parsed using
144			CSS-like error-tolerant parsing rules, e.g. ignoring anything until next
145			<code>;</code> character.
146	wakaba	1.26	</dl>
147			</div>
148	wakaba	1.8
149			<p>Note that all of these modules are <em>work in progress</em>
150			and have <a href="#todo">a number of unresolved problems</a>.</p>
151
152			<p>Note also that some modules have no documentation for now.</p>
153	wakaba	1.26
154			<!-- Whatpm::ContentChecker::*, Whatpm::H2H, Whatpm::NanoDOM, and
155			Whatpm::XMLParser are intentionally omitted from the list. -->
156			</div>
157
158			<div class=section id=documents>
159			<h2>Documents</h2>
160
161			<p>For the description of functionalities provided by each module, see
162			<abbr>pod</abbr> documentation of the module. HTML version of
163			<abbr>pod</abbr> documentations are linked from the <a
164			href="#modules">list of modules above</a>.
165
166			<p>In addition, there are additional documents for some topics:
167			<dl>
168	wakaba	1.5	<dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
169	wakaba	1.26	<!-- @@ TODO: Need to update the link - the document above is out of date -->
170	wakaba	1.8	<dd>Description of errors to be notified to callback functions by Whatpm
171			modules.</dd>
172	wakaba	1.26
173			<dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>
174			<dd>Description of data structure for Selectors, as implemented by
175			<a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a>
176			(as output), and
177			<a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a>
178			(as input)<!--, and
179			<a href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/SelectorsAPI.html"><code>Message::DOM::SelectorsAPI</code></a>-->.</dd>
180
181			<dt id=doc-user-data-names><a href="http://suika.fam.cx/gate/2005/sw/manakai/Predefined%20User%20Data%20Names">List of predefined user data names</a></dt>
182			<dd>List of user data names defined by Whatpm modules.</dd>
183
184			<dt id=doc-handles><a href="Whatpm/Charset/handles">Handle objects</a>
185			<dd>Description of character or byte stream input handle interfaces.
186			</dl>
187
188			<p>Following specifications define Whatpm-specific formats and extensions:
189			<dl id=spec>
190			<dt id=spec-ssft><a href="http://suika.fam.cx/www/markup/selectors/ssft/ssft"><abbr title="Selectors Serialization Format for Testing">SSFT</abbr>
191			Specification</a></dt>
192			<dd>The specification for the serialization format used for
193			testing Selectors-related modules.</dd>
194
195			<dt id=spec-manakai-selectors"><a href="http://suika.fam.cx/gate/2005/sw/manakai/Selectors%20Extensions">manakai's
196			Selectors Extensions</a></dt>
197			<dd>The specification for <code>:-manakai-<var>*</var></code>
198			pseudo-classes implemented by Selectors-related modules.</dd>
199	wakaba	1.1	</dl>
200			</div>
201
202			<div class="section" id="demo">
203			<h2>Demo</h2>
204
205	wakaba	1.4	<ul>
206	wakaba	1.11	<li id=demo-html-parser-nanodom><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser
207			and checker demo</a>
208			(<a href="http://suika.fam.cx/gate/cvs/checkout/webroot/gate/2007/html/parser.cgi">source</a>,
209			with <a href="Whatpm/NanoDOM.html">a lightweight non-conforming
210			DOM implementation</a>)</li>
211			<li id=demo-html-parser-manakai><a href="http://suika.fam.cx/gate/2007/html/parser-manakai-interface">HTML5
212			parser and checker demo, with manakai's DOM implementation</a>
213			(<a href="http://suika.fam.cx/gate/cvs/checkout/webroot/gate/2007/html/parser-manakai.cgi">source</a>)</li>
214			<li id=demo-html-table><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table
215			structure visualization demo</a>
216			(<a href="http://suika.fam.cx/gate/cvs/checkout/webroot/gate/2007/html/table.cgi">source</a>)</li>
217	wakaba	1.25
218			<li id=demo-css-parser><a href="http://suika.fam.cx/gate/2007/css/parser-interface">CSS
219			tokenizer, parser, and computed style computation demo</a>
220	wakaba	1.11	(<a href="http://suika.fam.cx/gate/cvs/checkout/webroot/gate/2007/css/parser.cgi">source</a>)</li>
221	wakaba	1.25
222			<li id=demo-langtag><a href="http://suika.fam.cx/gate/2007/langtag/langtag-demo-interface">Language
223			tag parsing and conformance checking demo</a>
224			(<a href="http://suika.fam.cx/gate/cvs/checkout/webroot/gate/2007/langtag/langtag-demo.cgi">source</a>)
225			</ul>
226			</div>
227
228			<div class=section id=applications>
229			<h2>Application</h2>
230
231			<ul>
232			<li><a href="http://suika.fam.cx/gate/2007/html/cc/"><abbr>WebHACC</abbr>
233			(Web hypertext application conformance checker)</a>
234	wakaba	1.4	</ul>
235	wakaba	1.6	</div>
236
237			<div class="section" id="dependency">
238			<h2>Dependency</h2>
239
240			<dl>
241	wakaba	1.17	<dt id=dependency-perl>Perl 5.8 or later</dt>
242	wakaba	1.15	<dd>It is recommended to use newer stable release of Perl 5.8 (or
243			later).</dd>
244	wakaba	1.17	<dd id=dependency-encode>Some modules require <code>Encode</code>
245			modules, which are part of standard Perl distribution.</dd>
246	wakaba	1.19	<dt id=dependency-manakai-core>Modules from
247			<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a></dt>
248			<dd>
249			<dl>
250	wakaba	1.17	<dt id=dependency-error><a href="http://search.cpan.org/author/SHLOMIF/Error-0.17009/lib/Error.pm"><code>Error</code></a></dt>
251			<dd>Module <code>Whatpm::HTML</code> requires <code>Error</code>,
252			which is bundled in
253	wakaba	1.19	<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
254	wakaba	1.6	<dt><code>Message::IMT::InternetMediaType</code></dt>
255	wakaba	1.15	<dd>Module <code>Whatpm::IMTChecker</code> depends on
256	wakaba	1.6	<code>Message::IMT::InternetMediaType</code>, which is part of
257	wakaba	1.19	<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
258	wakaba	1.6	<dt><code>Message::URI::URIReference</code></dt>
259	wakaba	1.15	<dd>Modules <code>Whatpm::URIChecker</code> and
260			<code>Whatpm::CacheManifest</code> depend on
261			<a href="http://suika.fam.cx/www/manakai-core/lib/Message/URI/URIReference.html"><code>Message::URI::URIReference</code></a>,
262			which is part of
263	wakaba	1.19	<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
264	wakaba	1.20	<dt><code>Message::Charset::Info</code></dt>
265			<dd>Module <code>Whatpm::ContentChecker</code> depends on
266			<a href="http://suika.fam.cx/www/manakai-core/lib/Message/Charset/Info.html"><code>Message::Charset::Info</code></a>,
267			which is part of
268			<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
269	wakaba	1.23	<dt><code>Message::DOM::DOMImplementation</code>
270			<dd>Module <code>Whatpm::URIChecker</code> depends on
271			<code>Message::DOM::DOMImplementation</code>,
272			which is part of
273			<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
274	wakaba	1.19	<dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
275			<dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
276			depends on <code>Message::DOM::DOMImplementation</code> and related modules
277			in <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
278			They are not required in practice.</dd>
279			</dl>
280			</dd>
281	wakaba	1.6	<dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
282			charlib</a></dt>
283	wakaba	1.19	<dd>Module <code>Whatpm::Charset::DecodeHandle</code> depends on
284	wakaba	1.6	modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
285	wakaba	1.15	charlib</a> for decoding of <em>Japanese character encodings</em>.
286	wakaba	1.6	See the documentation for
287			<a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
288			charlib</a> for more information.</dd>
289	wakaba	1.19	<dt><a href="http://www.python.org/">Python</a>, Perl
290			<a href="http://search.cpan.org/~neilw/Inline-Python-0.22/"><code>Inline::Python</code></a>
291			module, and <a href="http://chardet.feedparser.org/">Universal Encoding
292			Detector</a></dt>
293			<dd>For the module <code>Whatpm::Charset::UniversalCharDet</code> being
294	wakaba	1.25	meaningful, these softwares are required on the system. See the
295	wakaba	1.19	<a href="Whatpm/Charset/UniversalCharDet.html#dependency">documentation</a>
296			for more information.</dd>
297	wakaba	1.6	<dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>
298	wakaba	1.15	<dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and
299	wakaba	1.11	<code>Whatpm::CSS::Tokenizer</code>
300	wakaba	1.6	depends on <a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code> and related modules</a>.
301			They are not required in practice.</dd>
302			</dl>
303	wakaba	1.1	</div>
304
305			<div class="section" id="download">
306			<h2>Distribution</h2>
307
308			<p>The development version of Whatpm may be found in the
309			<a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS
310			repository</a>.</p>
311	wakaba	1.25
312			<p><a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/whatpm.tar.gz?tarball=1">The
313			latest developmenet version of the Whatpm</a> is also available as a
314			tarball.
315	wakaba	1.1
316	wakaba	1.2	</div>
317
318			<div class="section" id="todo">
319			<h2>TO DO</h2>
320
321			<ul>
322			<li>Bug fix (Test results:
323	wakaba	1.3	<a href="t/content-type-result"><code>Whatpm::ContentType</code></a>,
324	wakaba	1.2	<a href="t/tokenizer-result">HTML tokenization</a>,
325	wakaba	1.3	<a href="t/tree-construction-result">HTML tree construction</a>,
326			<a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
327	wakaba	1.22	<li>Merge with the <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>
328			code tree.
329	wakaba	1.3	<li>Charset detection.</li>
330	wakaba	1.4	<li>Validation for <code>meta</code>.</li>
331			<li>Validation for media queries, IRIs (against URI schemes), language tags,
332	wakaba	1.3	and so on.</li>
333	wakaba	1.4	<li>Documentations are missing for some features.</li>
334	wakaba	1.14	<li>XML parser<!-- with application cache selection algorithm hook-->.</li>
335	wakaba	1.3	<li>In addition, each module has its own TO DO items.
336			(Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>
337	wakaba	1.2	</ul>
338	wakaba	1.7	</div>
339
340			<div class=section id=acknowledgments>
341			<h2>Acknowledgments</h2>
342
343			<p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a>
344	wakaba	1.17	team for their
345			<a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
346	wakaba	1.7	parser test data</a>.</p>
347	wakaba	1.1	</div>
348
349			<div class="section" id="author">
350			<h2>Author</h2>
351
352	wakaba	1.4	<p><a href="http://suika.fam.cx/~wakaba/who?" rel="author">Wakaba</a>.</p>
353	wakaba	1.1	</div>
354
355			<div class="section" id="license">
356			<h2>License</h2>
357
358	wakaba	1.22	<p>Copyright 2007$B!>(B2008 Wakaba
359	wakaba	1.4	<code class="mail"><<a href="mailto:w@suika.fam.cx"
360			rel="author">w@suika.fam.cx</a>></code>.</p>
361	wakaba	1.1
362			<p>This library is free software; you can redistribute it and/or modify
363			it under the same terms as Perl itself.</p>
364			</div>
365
366			</body>
367			</html>