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