/[suikacvs]/markup/html/whatpm/readme.en.html
Suika

Contents of /markup/html/whatpm/readme.en.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.20 - (hide annotations) (download) (as text)
Fri Nov 23 05:39:43 2007 UTC (16 years, 11 months ago) by wakaba
Branch: MAIN
Changes since 1.19: +5 -1 lines
File MIME type: text/html
++ ChangeLog	23 Nov 2007 05:35:10 -0000
2007-11-23  Wakaba  <wakaba@suika.fam.cx>

	* readme.en.html: Whatpm::ContentChecker now depends
	on Message::Charset::Info.

++ whatpm/t/ChangeLog	23 Nov 2007 05:38:36 -0000
2007-11-23  Wakaba  <wakaba@suika.fam.cx>

	* ContentChecker.t: Unset |input_encoding| attribute.

	* content-model-1.dat, content-model-2.dat: New tests
	for |charset| attribute value are added.

++ whatpm/Whatpm/ChangeLog	23 Nov 2007 05:37:17 -0000
2007-11-23  Wakaba  <wakaba@suika.fam.cx>

	* NanoDOM.pm (input_encoding, manakai_charset, manakai_has_bom): New
	attributes.

	* ContentChecker.pm (check_document): Warn if charset requirements
	cannot be tested.

++ whatpm/Whatpm/ContentChecker/ChangeLog	23 Nov 2007 05:37:42 -0000
2007-11-23  Wakaba  <wakaba@suika.fam.cx>

	* HTML.pm (meta): |charset| value tests implemented.

1 wakaba 1.1 <!DOCTYPE html>
2     <html lang="en">
3     <head>
4     <title>Whatpm &mdash; 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.5 <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
66     <dd>A simple XML serializer.</dd>
67 wakaba 1.8 </dl>
68    
69     <p>Note that all of these modules are <em>work in progress</em>
70     and have <a href="#todo">a number of unresolved problems</a>.</p>
71    
72     <p>Note also that some modules have no documentation for now.</p>
73     </dd>
74 wakaba 1.11 <dt id=spec>Specification</dt>
75 wakaba 1.10 <dd><dl>
76 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>
77 wakaba 1.10 Specification</a></dt>
78     <dd>The specification for the serialization format used for
79     testing Selectors-related modules.</dd>
80 wakaba 1.12 <dt id=spec-manakai-selectors"><a href="http://suika.fam.cx/gate/2005/sw/manakai/Selectors%20Extensions">manakai's
81     Selectors Extensions</a></dt>
82     <dd>The specification for <code>:-manakai-<var>*</var></code>
83     pseudo-classes implemented by Selectors-related modules.</dd>
84 wakaba 1.10 </dl></dd>
85 wakaba 1.13 <dt>Documentations</dt>
86 wakaba 1.8 <dd><dl>
87 wakaba 1.5 <dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
88 wakaba 1.8 <dd>Description of errors to be notified to callback functions by Whatpm
89     modules.</dd>
90 wakaba 1.13 <dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>
91 wakaba 1.18 <dd>Description of data structure for Selectors, as implemented by
92 wakaba 1.13 <a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a>
93     (as output), and
94     <a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a>
95     (as input)<!--, and
96     <a href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/SelectorsAPI.html"><code>Message::DOM::SelectorsAPI</code></a>-->.</dd>
97     </dl>
98     </dd>
99 wakaba 1.1 </dl>
100     </div>
101    
102     <div class="section" id="demo">
103     <h2>Demo</h2>
104    
105 wakaba 1.4 <ul>
106 wakaba 1.11 <li id=demo-html-parser-nanodom><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser
107     and checker demo</a>
108     (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser.cgi">source</a>,
109     with <a href="Whatpm/NanoDOM.html">a lightweight non-conforming
110     DOM implementation</a>)</li>
111     <li id=demo-html-parser-manakai><a href="http://suika.fam.cx/gate/2007/html/parser-manakai-interface">HTML5
112     parser and checker demo, with manakai's DOM implementation</a>
113     (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser-manakai.cgi">source</a>)</li>
114     <li id=demo-html-table><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table
115     structure visualization demo</a>
116     (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/table.cgi">source</a>)</li>
117     <li id=demo-css-parser><a href="http://suika.fam.cx/gate/2007/css/parser-interface">CSS tokenizer
118     demo</a>
119     (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/css/parser.cgi">source</a>)</li>
120 wakaba 1.4 </ul>
121 wakaba 1.6 </div>
122    
123     <div class="section" id="dependency">
124     <h2>Dependency</h2>
125    
126     <dl>
127 wakaba 1.17 <dt id=dependency-perl>Perl 5.8 or later</dt>
128 wakaba 1.15 <dd>It is recommended to use newer stable release of Perl 5.8 (or
129     later).</dd>
130 wakaba 1.17 <dd id=dependency-encode>Some modules require <code>Encode</code>
131     modules, which are part of standard Perl distribution.</dd>
132 wakaba 1.19 <dt id=dependency-manakai-core>Modules from
133     <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a></dt>
134     <dd>
135     <dl>
136 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>
137     <dd>Module <code>Whatpm::HTML</code> requires <code>Error</code>,
138     which is bundled in
139 wakaba 1.19 <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
140 wakaba 1.6 <dt><code>Message::IMT::InternetMediaType</code></dt>
141 wakaba 1.15 <dd>Module <code>Whatpm::IMTChecker</code> depends on
142 wakaba 1.6 <code>Message::IMT::InternetMediaType</code>, which is part of
143 wakaba 1.19 <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
144 wakaba 1.6 <dt><code>Message::URI::URIReference</code></dt>
145 wakaba 1.15 <dd>Modules <code>Whatpm::URIChecker</code> and
146     <code>Whatpm::CacheManifest</code> depend on
147     <a href="http://suika.fam.cx/www/manakai-core/lib/Message/URI/URIReference.html"><code>Message::URI::URIReference</code></a>,
148     which is part of
149 wakaba 1.19 <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
150 wakaba 1.20 <dt><code>Message::Charset::Info</code></dt>
151     <dd>Module <code>Whatpm::ContentChecker</code> depends on
152     <a href="http://suika.fam.cx/www/manakai-core/lib/Message/Charset/Info.html"><code>Message::Charset::Info</code></a>,
153     which is part of
154     <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
155 wakaba 1.19 <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
156     <dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
157     depends on <code>Message::DOM::DOMImplementation</code> and related modules
158     in <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
159     They are not required in practice.</dd>
160     </dl>
161     </dd>
162 wakaba 1.6 <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
163     charlib</a></dt>
164 wakaba 1.19 <dd>Module <code>Whatpm::Charset::DecodeHandle</code> depends on
165 wakaba 1.6 modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
166 wakaba 1.15 charlib</a> for decoding of <em>Japanese character encodings</em>.
167 wakaba 1.6 See the documentation for
168     <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
169     charlib</a> for more information.</dd>
170 wakaba 1.19 <dt><a href="http://www.python.org/">Python</a>, Perl
171     <a href="http://search.cpan.org/~neilw/Inline-Python-0.22/"><code>Inline::Python</code></a>
172     module, and <a href="http://chardet.feedparser.org/">Universal Encoding
173     Detector</a></dt>
174     <dd>For the module <code>Whatpm::Charset::UniversalCharDet</code> being
175     meaningful, these softwares are requires on the system. See the
176     <a href="Whatpm/Charset/UniversalCharDet.html#dependency">documentation</a>
177     for more information.</dd>
178 wakaba 1.6 <dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>
179 wakaba 1.15 <dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and
180 wakaba 1.11 <code>Whatpm::CSS::Tokenizer</code>
181 wakaba 1.6 depends on <a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code> and related modules</a>.
182     They are not required in practice.</dd>
183     </dl>
184 wakaba 1.1 </div>
185    
186     <div class="section" id="download">
187     <h2>Distribution</h2>
188    
189     <p>The development version of Whatpm may be found in the
190     <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS
191     repository</a>.</p>
192    
193 wakaba 1.2 </div>
194    
195     <div class="section" id="todo">
196     <h2>TO DO</h2>
197    
198     <ul>
199     <li>Bug fix (Test results:
200 wakaba 1.3 <a href="t/content-type-result"><code>Whatpm::ContentType</code></a>,
201 wakaba 1.2 <a href="t/tokenizer-result">HTML tokenization</a>,
202 wakaba 1.3 <a href="t/tree-construction-result">HTML tree construction</a>,
203     <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
204     <li>Charset detection.</li>
205 wakaba 1.4 <li>Validation for <code>meta</code>.</li>
206     <li>Validation for media queries, IRIs (against URI schemes), language tags,
207 wakaba 1.3 and so on.</li>
208 wakaba 1.4 <li>Documentations are missing for some features.</li>
209 wakaba 1.14 <li>XML parser<!-- with application cache selection algorithm hook-->.</li>
210 wakaba 1.3 <li>In addition, each module has its own TO DO items.
211     (Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>
212 wakaba 1.2 </ul>
213 wakaba 1.7 </div>
214    
215     <div class=section id=acknowledgments>
216     <h2>Acknowledgments</h2>
217    
218     <p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a>
219 wakaba 1.17 team for their
220     <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
221 wakaba 1.7 parser test data</a>.</p>
222 wakaba 1.1 </div>
223    
224     <div class="section" id="author">
225     <h2>Author</h2>
226    
227 wakaba 1.4 <p><a href="http://suika.fam.cx/~wakaba/who?" rel="author">Wakaba</a>.</p>
228 wakaba 1.1 </div>
229    
230     <div class="section" id="license">
231     <h2>License</h2>
232    
233 wakaba 1.4 <p>Copyright 2007 Wakaba
234     <code class="mail">&lt;<a href="mailto:w@suika.fam.cx"
235     rel="author">w@suika.fam.cx</a>></code>.</p>
236 wakaba 1.1
237     <p>This library is free software; you can redistribute it and/or modify
238     it under the same terms as Perl itself.</p>
239     </div>
240    
241     </body>
242     </html>

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24