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