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.19 |
<dt id=whatpm-charset-universalchardet><a href="Whatpm/Charset/UniversalCharDet.html"><code>Whatpm::Charset::UniversalCharDet</code></a></dt> |
30 |
|
|
<dd>A Perl interface to universalchardet character encoding detection |
31 |
|
|
library.</dd> |
32 |
wakaba |
1.4 |
<dt><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt> |
33 |
|
|
<dd>A DOM5 HTML (in-memory representation of a document) conformance |
34 |
wakaba |
1.11 |
checker with a partial support for Atom 1.0. (See also |
35 |
|
|
<a href="#demo-html-parser">demo</a>.)</dd> |
36 |
wakaba |
1.1 |
<dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt> |
37 |
|
|
<dd>An implementation of HTML5 Content Type sniffing algorithm.</dd> |
38 |
wakaba |
1.10 |
<dt><a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a></dt> |
39 |
|
|
<dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of |
40 |
wakaba |
1.11 |
selectors</a> parser. (See also <a href="#demo-css-parser">demo</a>.)</dd> |
41 |
wakaba |
1.10 |
<dt><a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a></dt> |
42 |
|
|
<dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of |
43 |
wakaba |
1.11 |
selectors</a> serializer. (See also <a href="#spec-ssft">specification</a> |
44 |
|
|
and <a href="#demo-css-parser">demo</a>.)</dd> |
45 |
wakaba |
1.9 |
<dt><a href="Whatpm/CSS/Tokenizer.html"><code>Whatpm::CSS::Tokenizer</code></a></dt> |
46 |
wakaba |
1.11 |
<dd>A CSS tokenizer. (See also <a href="#demo-css-parser">demo</a>.)</dd> |
47 |
wakaba |
1.16 |
<dt id=module-whatpm-html><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt> |
48 |
|
|
<dd>An implementation of HTML5 document and fragment |
49 |
|
|
parsing algorithms. It can be used |
50 |
|
|
to convert an arbitrary string into a |
51 |
|
|
<abbr title="Document Object Model">DOM</abbr>. (See also |
52 |
wakaba |
1.15 |
<a href="#demo-html-parser">demo</a>.)</dd> |
53 |
wakaba |
1.16 |
<dt id=module-whatpm-html-serializer><a href="Whatpm/HTML/Serializer.html"><code>Whatpm::HTML::Serializer</code></a></dt> |
54 |
|
|
<dd>An implementation of HTML5 fragment serialization algorithm. |
55 |
|
|
(See also <a href="#demo-html-parser">demo</a>.)</dd> |
56 |
wakaba |
1.4 |
<dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt> |
57 |
wakaba |
1.8 |
<dd>An implementation of the HTML5 table algorithm. It can be |
58 |
|
|
used to extract a table structure from a DOM <code>table</code> |
59 |
wakaba |
1.11 |
element node. (See also <a href="#demo-html-table">demo</a>.)</dd> |
60 |
wakaba |
1.4 |
<dt><a href="Whatpm/IMTChecker.html"><code>Whatpm::IMTChecker</code></a></dt> |
61 |
wakaba |
1.5 |
<dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label |
62 |
wakaba |
1.4 |
conformance checker.</dd> |
63 |
|
|
<dt><a href="Whatpm/URIChecker.html"><code>Whatpm::URIChecker</code></a></dt> |
64 |
|
|
<dd>An IRI reference conformance checker.</dd> |
65 |
wakaba |
1.22 |
|
66 |
|
|
<dt><a href="Whatpm/WebIDL.html"><code>Whatpm::WebIDL</code></a></dt> |
67 |
|
|
<dd>A WebIDL fragment parser. It parses an IDL fragment, whether conforming |
68 |
|
|
or not, and constructs a DOM-like object model for further processing. |
69 |
|
|
Non-conforming (or broken) IDL fragment-like string will be parsed using |
70 |
|
|
CSS-like error-tolerant parsing rules, e.g. ignoring anything until next |
71 |
|
|
<code>;</code> character. |
72 |
|
|
|
73 |
wakaba |
1.5 |
<dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt> |
74 |
|
|
<dd>A simple XML serializer.</dd> |
75 |
wakaba |
1.8 |
</dl> |
76 |
|
|
|
77 |
|
|
<p>Note that all of these modules are <em>work in progress</em> |
78 |
|
|
and have <a href="#todo">a number of unresolved problems</a>.</p> |
79 |
|
|
|
80 |
|
|
<p>Note also that some modules have no documentation for now.</p> |
81 |
|
|
</dd> |
82 |
wakaba |
1.22 |
<dt id=spec>Specifications</dt> |
83 |
wakaba |
1.10 |
<dd><dl> |
84 |
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> |
85 |
wakaba |
1.10 |
Specification</a></dt> |
86 |
|
|
<dd>The specification for the serialization format used for |
87 |
|
|
testing Selectors-related modules.</dd> |
88 |
wakaba |
1.12 |
<dt id=spec-manakai-selectors"><a href="http://suika.fam.cx/gate/2005/sw/manakai/Selectors%20Extensions">manakai's |
89 |
|
|
Selectors Extensions</a></dt> |
90 |
|
|
<dd>The specification for <code>:-manakai-<var>*</var></code> |
91 |
|
|
pseudo-classes implemented by Selectors-related modules.</dd> |
92 |
wakaba |
1.10 |
</dl></dd> |
93 |
wakaba |
1.13 |
<dt>Documentations</dt> |
94 |
wakaba |
1.8 |
<dd><dl> |
95 |
wakaba |
1.5 |
<dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt> |
96 |
wakaba |
1.8 |
<dd>Description of errors to be notified to callback functions by Whatpm |
97 |
|
|
modules.</dd> |
98 |
wakaba |
1.13 |
<dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt> |
99 |
wakaba |
1.18 |
<dd>Description of data structure for Selectors, as implemented by |
100 |
wakaba |
1.13 |
<a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a> |
101 |
|
|
(as output), and |
102 |
|
|
<a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a> |
103 |
|
|
(as input)<!--, and |
104 |
|
|
<a href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/SelectorsAPI.html"><code>Message::DOM::SelectorsAPI</code></a>-->.</dd> |
105 |
wakaba |
1.21 |
<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> |
106 |
|
|
<dd>List of user data names defined by Whatpm modules.</dd> |
107 |
wakaba |
1.13 |
</dl> |
108 |
|
|
</dd> |
109 |
wakaba |
1.1 |
</dl> |
110 |
|
|
</div> |
111 |
|
|
|
112 |
|
|
<div class="section" id="demo"> |
113 |
|
|
<h2>Demo</h2> |
114 |
|
|
|
115 |
wakaba |
1.4 |
<ul> |
116 |
wakaba |
1.11 |
<li id=demo-html-parser-nanodom><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser |
117 |
|
|
and checker demo</a> |
118 |
|
|
(<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser.cgi">source</a>, |
119 |
|
|
with <a href="Whatpm/NanoDOM.html">a lightweight non-conforming |
120 |
|
|
DOM implementation</a>)</li> |
121 |
|
|
<li id=demo-html-parser-manakai><a href="http://suika.fam.cx/gate/2007/html/parser-manakai-interface">HTML5 |
122 |
|
|
parser and checker demo, with manakai's DOM implementation</a> |
123 |
|
|
(<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser-manakai.cgi">source</a>)</li> |
124 |
|
|
<li id=demo-html-table><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table |
125 |
|
|
structure visualization demo</a> |
126 |
|
|
(<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/table.cgi">source</a>)</li> |
127 |
|
|
<li id=demo-css-parser><a href="http://suika.fam.cx/gate/2007/css/parser-interface">CSS tokenizer |
128 |
|
|
demo</a> |
129 |
|
|
(<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/css/parser.cgi">source</a>)</li> |
130 |
wakaba |
1.4 |
</ul> |
131 |
wakaba |
1.6 |
</div> |
132 |
|
|
|
133 |
|
|
<div class="section" id="dependency"> |
134 |
|
|
<h2>Dependency</h2> |
135 |
|
|
|
136 |
|
|
<dl> |
137 |
wakaba |
1.17 |
<dt id=dependency-perl>Perl 5.8 or later</dt> |
138 |
wakaba |
1.15 |
<dd>It is recommended to use newer stable release of Perl 5.8 (or |
139 |
|
|
later).</dd> |
140 |
wakaba |
1.17 |
<dd id=dependency-encode>Some modules require <code>Encode</code> |
141 |
|
|
modules, which are part of standard Perl distribution.</dd> |
142 |
wakaba |
1.19 |
<dt id=dependency-manakai-core>Modules from |
143 |
|
|
<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a></dt> |
144 |
|
|
<dd> |
145 |
|
|
<dl> |
146 |
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> |
147 |
|
|
<dd>Module <code>Whatpm::HTML</code> requires <code>Error</code>, |
148 |
|
|
which is bundled in |
149 |
wakaba |
1.19 |
<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd> |
150 |
wakaba |
1.6 |
<dt><code>Message::IMT::InternetMediaType</code></dt> |
151 |
wakaba |
1.15 |
<dd>Module <code>Whatpm::IMTChecker</code> depends on |
152 |
wakaba |
1.6 |
<code>Message::IMT::InternetMediaType</code>, which is part of |
153 |
wakaba |
1.19 |
<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd> |
154 |
wakaba |
1.6 |
<dt><code>Message::URI::URIReference</code></dt> |
155 |
wakaba |
1.15 |
<dd>Modules <code>Whatpm::URIChecker</code> and |
156 |
|
|
<code>Whatpm::CacheManifest</code> depend on |
157 |
|
|
<a href="http://suika.fam.cx/www/manakai-core/lib/Message/URI/URIReference.html"><code>Message::URI::URIReference</code></a>, |
158 |
|
|
which is part of |
159 |
wakaba |
1.19 |
<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd> |
160 |
wakaba |
1.20 |
<dt><code>Message::Charset::Info</code></dt> |
161 |
|
|
<dd>Module <code>Whatpm::ContentChecker</code> depends on |
162 |
|
|
<a href="http://suika.fam.cx/www/manakai-core/lib/Message/Charset/Info.html"><code>Message::Charset::Info</code></a>, |
163 |
|
|
which is part of |
164 |
|
|
<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd> |
165 |
wakaba |
1.23 |
<dt><code>Message::DOM::DOMImplementation</code> |
166 |
|
|
<dd>Module <code>Whatpm::URIChecker</code> depends on |
167 |
|
|
<code>Message::DOM::DOMImplementation</code>, |
168 |
|
|
which is part of |
169 |
|
|
<a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>. |
170 |
wakaba |
1.19 |
<dt><code>Message::DOM::DOMImplementation</code> and related modules</dt> |
171 |
|
|
<dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code> |
172 |
|
|
depends on <code>Message::DOM::DOMImplementation</code> and related modules |
173 |
|
|
in <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>. |
174 |
|
|
They are not required in practice.</dd> |
175 |
|
|
</dl> |
176 |
|
|
</dd> |
177 |
wakaba |
1.6 |
<dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai |
178 |
|
|
charlib</a></dt> |
179 |
wakaba |
1.19 |
<dd>Module <code>Whatpm::Charset::DecodeHandle</code> depends on |
180 |
wakaba |
1.6 |
modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai |
181 |
wakaba |
1.15 |
charlib</a> for decoding of <em>Japanese character encodings</em>. |
182 |
wakaba |
1.6 |
See the documentation for |
183 |
|
|
<a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai |
184 |
|
|
charlib</a> for more information.</dd> |
185 |
wakaba |
1.19 |
<dt><a href="http://www.python.org/">Python</a>, Perl |
186 |
|
|
<a href="http://search.cpan.org/~neilw/Inline-Python-0.22/"><code>Inline::Python</code></a> |
187 |
|
|
module, and <a href="http://chardet.feedparser.org/">Universal Encoding |
188 |
|
|
Detector</a></dt> |
189 |
|
|
<dd>For the module <code>Whatpm::Charset::UniversalCharDet</code> being |
190 |
|
|
meaningful, these softwares are requires on the system. See the |
191 |
|
|
<a href="Whatpm/Charset/UniversalCharDet.html#dependency">documentation</a> |
192 |
|
|
for more information.</dd> |
193 |
wakaba |
1.6 |
<dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt> |
194 |
wakaba |
1.15 |
<dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and |
195 |
wakaba |
1.11 |
<code>Whatpm::CSS::Tokenizer</code> |
196 |
wakaba |
1.6 |
depends on <a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code> and related modules</a>. |
197 |
|
|
They are not required in practice.</dd> |
198 |
|
|
</dl> |
199 |
wakaba |
1.1 |
</div> |
200 |
|
|
|
201 |
|
|
<div class="section" id="download"> |
202 |
|
|
<h2>Distribution</h2> |
203 |
|
|
|
204 |
|
|
<p>The development version of Whatpm may be found in the |
205 |
|
|
<a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS |
206 |
|
|
repository</a>.</p> |
207 |
|
|
|
208 |
wakaba |
1.2 |
</div> |
209 |
|
|
|
210 |
|
|
<div class="section" id="todo"> |
211 |
|
|
<h2>TO DO</h2> |
212 |
|
|
|
213 |
|
|
<ul> |
214 |
|
|
<li>Bug fix (Test results: |
215 |
wakaba |
1.3 |
<a href="t/content-type-result"><code>Whatpm::ContentType</code></a>, |
216 |
wakaba |
1.2 |
<a href="t/tokenizer-result">HTML tokenization</a>, |
217 |
wakaba |
1.3 |
<a href="t/tree-construction-result">HTML tree construction</a>, |
218 |
|
|
<a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li> |
219 |
wakaba |
1.22 |
<li>Merge with the <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a> |
220 |
|
|
code tree. |
221 |
wakaba |
1.3 |
<li>Charset detection.</li> |
222 |
wakaba |
1.4 |
<li>Validation for <code>meta</code>.</li> |
223 |
|
|
<li>Validation for media queries, IRIs (against URI schemes), language tags, |
224 |
wakaba |
1.3 |
and so on.</li> |
225 |
wakaba |
1.4 |
<li>Documentations are missing for some features.</li> |
226 |
wakaba |
1.14 |
<li>XML parser<!-- with application cache selection algorithm hook-->.</li> |
227 |
wakaba |
1.3 |
<li>In addition, each module has its own TO DO items. |
228 |
|
|
(Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li> |
229 |
wakaba |
1.2 |
</ul> |
230 |
wakaba |
1.7 |
</div> |
231 |
|
|
|
232 |
|
|
<div class=section id=acknowledgments> |
233 |
|
|
<h2>Acknowledgments</h2> |
234 |
|
|
|
235 |
|
|
<p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a> |
236 |
wakaba |
1.17 |
team for their |
237 |
|
|
<a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5 |
238 |
wakaba |
1.7 |
parser test data</a>.</p> |
239 |
wakaba |
1.1 |
</div> |
240 |
|
|
|
241 |
|
|
<div class="section" id="author"> |
242 |
|
|
<h2>Author</h2> |
243 |
|
|
|
244 |
wakaba |
1.4 |
<p><a href="http://suika.fam.cx/~wakaba/who?" rel="author">Wakaba</a>.</p> |
245 |
wakaba |
1.1 |
</div> |
246 |
|
|
|
247 |
|
|
<div class="section" id="license"> |
248 |
|
|
<h2>License</h2> |
249 |
|
|
|
250 |
wakaba |
1.22 |
<p>Copyright 2007$B!>(B2008 Wakaba |
251 |
wakaba |
1.4 |
<code class="mail"><<a href="mailto:w@suika.fam.cx" |
252 |
|
|
rel="author">w@suika.fam.cx</a>></code>.</p> |
253 |
wakaba |
1.1 |
|
254 |
|
|
<p>This library is free software; you can redistribute it and/or modify |
255 |
|
|
it under the same terms as Perl itself.</p> |
256 |
|
|
</div> |
257 |
|
|
|
258 |
|
|
</body> |
259 |
|
|
</html> |