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 <m>P</m>erl
<m>m</m>odules for <m>W</m>eb <m>h</m>ypertext <m>a</m>pplication 
<m>t</m>echnologies.  It is part
of the <a href="http://suika.fam.cx/www/2006/manakai/" rel=up>manakai</a>
project.</p>

<dl>
<dt>Modules</dt>
<dd><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><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>
<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/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>
<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>
<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>
<dt><a href="Whatpm/URIChecker.html"><code>Whatpm::URIChecker</code></a></dt>
  <dd>An IRI reference conformance checker.</dd>
<dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
  <dd>A simple XML serializer.</dd>
  </dl>

  <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>
  </dd>
<dt id=spec>Specification</dt>
  <dd><dl>
    <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></dd>
<dt>Documentations</dt>
  <dd><dl>
<dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
  <dd>Description of errors to be notified to callback functions by Whatpm
  modules.</dd>
    </dd>
    <dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>
      <dd>Description of data structure of Selectors object as used 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>
    </dl>
  </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
demo</a>
(<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/css/parser.cgi">source</a>)</li>
</ul>
</div>

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

<dl>
<dt>Perl 5.8 or later</dt>
  <dd>It is recommended to use newer stable release of Perl 5.8 (or
  later).</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</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</a>.</dd>
<dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai 
charlib</a></dt>
  <dd>Module <code>Whatpm::Charset::DeocdeHandle</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><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</a>.
  They are not required in practice.</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>

</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>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 <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 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	<!DOCTYPE html>
2	<html lang="en">
3	<head>
4	<title>Whatpm — Perl Modules for Web Hypertext Application
5	Technologies (beta)</title>
6	<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	<h1>Whatpm (<em>beta</em>)</h1>
12
13	<div class="section" id="introduction">
14	<h2>Introduction</h2>
15
16	<p><dfn>Whatpm</dfn> is a <em>work-in-progress</em> set of <m>P</m>erl
17	<m>m</m>odules for <m>W</m>eb <m>h</m>ypertext <m>a</m>pplication
18	<m>t</m>echnologies. It is part
19	of the <a href="http://suika.fam.cx/www/2006/manakai/" rel=up>manakai</a>
20	project.</p>
21
22	<dl>
23	<dt>Modules</dt>
24	<dd><dl>
25	<dt><a href="Whatpm/CacheManifest.html"><code>Whatpm::CacheManifest</code></a></dt>
26	<dd>An
27	<a href="http://www.whatwg.org/specs/web-apps/current-work/#manifests">HTML5
28	cache manifest</a> parser.</dd>
29	<dt><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt>
30	<dd>A DOM5 HTML (in-memory representation of a document) conformance
31	checker with a partial support for Atom 1.0. (See also
32	<a href="#demo-html-parser">demo</a>.)</dd>
33	<dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>
34	<dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>
35	<dt><a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a></dt>
36	<dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of
37	selectors</a> parser. (See also <a href="#demo-css-parser">demo</a>.)</dd>
38	<dt><a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a></dt>
39	<dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of
40	selectors</a> serializer. (See also <a href="#spec-ssft">specification</a>
41	and <a href="#demo-css-parser">demo</a>.)</dd>
42	<dt><a href="Whatpm/CSS/Tokenizer.html"><code>Whatpm::CSS::Tokenizer</code></a></dt>
43	<dd>A CSS tokenizer. (See also <a href="#demo-css-parser">demo</a>.)</dd>
44	<dt id=module-whatpm-html><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>
45	<dd>An implementation of HTML5 document and fragment
46	parsing algorithms. It can be used
47	to convert an arbitrary string into a
48	<abbr title="Document Object Model">DOM</abbr>. (See also
49	<a href="#demo-html-parser">demo</a>.)</dd>
50	<dt id=module-whatpm-html-serializer><a href="Whatpm/HTML/Serializer.html"><code>Whatpm::HTML::Serializer</code></a></dt>
51	<dd>An implementation of HTML5 fragment serialization algorithm.
52	(See also <a href="#demo-html-parser">demo</a>.)</dd>
53	<dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>
54	<dd>An implementation of the HTML5 table algorithm. It can be
55	used to extract a table structure from a DOM <code>table</code>
56	element node. (See also <a href="#demo-html-table">demo</a>.)</dd>
57	<dt><a href="Whatpm/IMTChecker.html"><code>Whatpm::IMTChecker</code></a></dt>
58	<dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label
59	conformance checker.</dd>
60	<dt><a href="Whatpm/URIChecker.html"><code>Whatpm::URIChecker</code></a></dt>
61	<dd>An IRI reference conformance checker.</dd>
62	<dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
63	<dd>A simple XML serializer.</dd>
64	</dl>
65
66	<p>Note that all of these modules are <em>work in progress</em>
67	and have <a href="#todo">a number of unresolved problems</a>.</p>
68
69	<p>Note also that some modules have no documentation for now.</p>
70	</dd>
71	<dt id=spec>Specification</dt>
72	<dd><dl>
73	<dt id=spec-ssft><a href="http://suika.fam.cx/www/markup/selectors/ssft/ssft"><abbr title="Selectors Serialization Format for Testing">SSFT</abbr>
74	Specification</a></dt>
75	<dd>The specification for the serialization format used for
76	testing Selectors-related modules.</dd>
77	<dt id=spec-manakai-selectors"><a href="http://suika.fam.cx/gate/2005/sw/manakai/Selectors%20Extensions">manakai's
78	Selectors Extensions</a></dt>
79	<dd>The specification for <code>:-manakai-<var>*</var></code>
80	pseudo-classes implemented by Selectors-related modules.</dd>
81	</dl></dd>
82	<dt>Documentations</dt>
83	<dd><dl>
84	<dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
85	<dd>Description of errors to be notified to callback functions by Whatpm
86	modules.</dd>
87	</dd>
88	<dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>
89	<dd>Description of data structure of Selectors object as used by
90	<a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a>
91	(as output), and
92	<a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a>
93	(as input)<!--, and
94	<a href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/SelectorsAPI.html"><code>Message::DOM::SelectorsAPI</code></a>-->.</dd>
95	</dl>
96	</dd>
97	</dl>
98	</div>
99
100	<div class="section" id="demo">
101	<h2>Demo</h2>
102
103	<ul>
104	<li id=demo-html-parser-nanodom><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser
105	and checker demo</a>
106	(<a href="http://suika.fam.cx/gate/cvs/checkout/webroot/gate/2007/html/parser.cgi">source</a>,
107	with <a href="Whatpm/NanoDOM.html">a lightweight non-conforming
108	DOM implementation</a>)</li>
109	<li id=demo-html-parser-manakai><a href="http://suika.fam.cx/gate/2007/html/parser-manakai-interface">HTML5
110	parser and checker demo, with manakai's DOM implementation</a>
111	(<a href="http://suika.fam.cx/gate/cvs/checkout/webroot/gate/2007/html/parser-manakai.cgi">source</a>)</li>
112	<li id=demo-html-table><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table
113	structure visualization demo</a>
114	(<a href="http://suika.fam.cx/gate/cvs/checkout/webroot/gate/2007/html/table.cgi">source</a>)</li>
115	<li id=demo-css-parser><a href="http://suika.fam.cx/gate/2007/css/parser-interface">CSS tokenizer
116	demo</a>
117	(<a href="http://suika.fam.cx/gate/cvs/checkout/webroot/gate/2007/css/parser.cgi">source</a>)</li>
118	</ul>
119	</div>
120
121	<div class="section" id="dependency">
122	<h2>Dependency</h2>
123
124	<dl>
125	<dt>Perl 5.8 or later</dt>
126	<dd>It is recommended to use newer stable release of Perl 5.8 (or
127	later).</dd>
128	<dt><code>Message::IMT::InternetMediaType</code></dt>
129	<dd>Module <code>Whatpm::IMTChecker</code> depends on
130	<code>Message::IMT::InternetMediaType</code>, which is part of
131	<a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>
132	<dt><code>Message::URI::URIReference</code></dt>
133	<dd>Modules <code>Whatpm::URIChecker</code> and
134	<code>Whatpm::CacheManifest</code> depend on
135	<a href="http://suika.fam.cx/www/manakai-core/lib/Message/URI/URIReference.html"><code>Message::URI::URIReference</code></a>,
136	which is part of
137	<a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>
138	<dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
139	charlib</a></dt>
140	<dd>Module <code>Whatpm::Charset::DeocdeHandle</code> depends on
141	modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
142	charlib</a> for decoding of <em>Japanese character encodings</em>.
143	See the documentation for
144	<a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
145	charlib</a> for more information.</dd>
146	<dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
147	<dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
148	depends on <code>Message::DOM::DOMImplementation</code> and related modules
149	in <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.
150	They are not required in practice.</dd>
151	<dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>
152	<dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and
153	<code>Whatpm::CSS::Tokenizer</code>
154	depends on <a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code> and related modules</a>.
155	They are not required in practice.</dd>
156	</dl>
157	</div>
158
159	<div class="section" id="download">
160	<h2>Distribution</h2>
161
162	<p>The development version of Whatpm may be found in the
163	<a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS
164	repository</a>.</p>
165
166	</div>
167
168	<div class="section" id="todo">
169	<h2>TO DO</h2>
170
171	<ul>
172	<li>Bug fix (Test results:
173	<a href="t/content-type-result"><code>Whatpm::ContentType</code></a>,
174	<a href="t/tokenizer-result">HTML tokenization</a>,
175	<a href="t/tree-construction-result">HTML tree construction</a>,
176	<a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
177	<li>Charset detection.</li>
178	<li>Validation for <code>meta</code>.</li>
179	<li>Validation for media queries, IRIs (against URI schemes), language tags,
180	and so on.</li>
181	<li>Documentations are missing for some features.</li>
182	<li>XML parser<!-- with application cache selection algorithm hook-->.</li>
183	<li>In addition, each module has its own TO DO items.
184	(Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>
185	</ul>
186	</div>
187
188	<div class=section id=acknowledgments>
189	<h2>Acknowledgments</h2>
190
191	<p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a>
192	team for <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
193	parser test data</a>.</p>
194	</div>
195
196	<div class="section" id="author">
197	<h2>Author</h2>
198
199	<p><a href="http://suika.fam.cx/~wakaba/who?" rel="author">Wakaba</a>.</p>
200	</div>
201
202	<div class="section" id="license">
203	<h2>License</h2>
204
205	<p>Copyright 2007 Wakaba
206	<code class="mail"><<a href="mailto:w@suika.fam.cx"
207	rel="author">w@suika.fam.cx</a>></code>.</p>
208
209	<p>This library is free software; you can redistribute it and/or modify
210	it under the same terms as Perl itself.</p>
211	</div>
212
213	</body>
214	</html>