/[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.17 - (hide annotations) (download) (as text)
Sun Nov 11 06:54:36 2007 UTC (16 years, 11 months ago) by wakaba
Branch: MAIN
Changes since 1.16: +9 -2 lines
File MIME type: text/html
++ whatpm/Whatpm/ChangeLog	11 Nov 2007 06:54:02 -0000
	* HTML.pm.src (parse_byte_string): New method.
	(parse_char_string): New alias for |parse_string|.
	(main phase): Invoking "change the encoding" algorithm if desired.

	* HTML.pod: Updated.

2007-11-11  Wakaba  <wakaba@suika.fam.cx>

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.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.16 <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 wakaba 1.15 <a href="#demo-html-parser">demo</a>.)</dd>
50 wakaba 1.16 <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 wakaba 1.4 <dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>
54 wakaba 1.8 <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 wakaba 1.11 element node. (See also <a href="#demo-html-table">demo</a>.)</dd>
57 wakaba 1.4 <dt><a href="Whatpm/IMTChecker.html"><code>Whatpm::IMTChecker</code></a></dt>
58 wakaba 1.5 <dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label
59 wakaba 1.4 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 wakaba 1.5 <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
63     <dd>A simple XML serializer.</dd>
64 wakaba 1.8 </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 wakaba 1.11 <dt id=spec>Specification</dt>
72 wakaba 1.10 <dd><dl>
73 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>
74 wakaba 1.10 Specification</a></dt>
75     <dd>The specification for the serialization format used for
76     testing Selectors-related modules.</dd>
77 wakaba 1.12 <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 wakaba 1.10 </dl></dd>
82 wakaba 1.13 <dt>Documentations</dt>
83 wakaba 1.8 <dd><dl>
84 wakaba 1.5 <dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
85 wakaba 1.8 <dd>Description of errors to be notified to callback functions by Whatpm
86     modules.</dd>
87 wakaba 1.13 </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 wakaba 1.1 </dl>
98     </div>
99    
100     <div class="section" id="demo">
101     <h2>Demo</h2>
102    
103 wakaba 1.4 <ul>
104 wakaba 1.11 <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 wakaba 1.4 </ul>
119 wakaba 1.6 </div>
120    
121     <div class="section" id="dependency">
122     <h2>Dependency</h2>
123    
124     <dl>
125 wakaba 1.17 <dt id=dependency-perl>Perl 5.8 or later</dt>
126 wakaba 1.15 <dd>It is recommended to use newer stable release of Perl 5.8 (or
127     later).</dd>
128 wakaba 1.17 <dd id=dependency-encode>Some modules require <code>Encode</code>
129     modules, which are part of standard Perl distribution.</dd>
130     <dt id=dependency-error><a href="http://search.cpan.org/author/SHLOMIF/Error-0.17009/lib/Error.pm"><code>Error</code></a></dt>
131     <dd>Module <code>Whatpm::HTML</code> requires <code>Error</code>,
132     which is bundled in
133     <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>
134 wakaba 1.6 <dt><code>Message::IMT::InternetMediaType</code></dt>
135 wakaba 1.15 <dd>Module <code>Whatpm::IMTChecker</code> depends on
136 wakaba 1.6 <code>Message::IMT::InternetMediaType</code>, which is part of
137     <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>
138     <dt><code>Message::URI::URIReference</code></dt>
139 wakaba 1.15 <dd>Modules <code>Whatpm::URIChecker</code> and
140     <code>Whatpm::CacheManifest</code> depend on
141     <a href="http://suika.fam.cx/www/manakai-core/lib/Message/URI/URIReference.html"><code>Message::URI::URIReference</code></a>,
142     which is part of
143 wakaba 1.6 <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>
144     <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
145     charlib</a></dt>
146 wakaba 1.15 <dd>Module <code>Whatpm::Charset::DeocdeHandle</code> depends on
147 wakaba 1.6 modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
148 wakaba 1.15 charlib</a> for decoding of <em>Japanese character encodings</em>.
149 wakaba 1.6 See the documentation for
150     <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
151     charlib</a> for more information.</dd>
152     <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
153 wakaba 1.15 <dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
154 wakaba 1.6 depends on <code>Message::DOM::DOMImplementation</code> and related modules
155     in <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.
156     They are not required in practice.</dd>
157     <dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>
158 wakaba 1.15 <dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and
159 wakaba 1.11 <code>Whatpm::CSS::Tokenizer</code>
160 wakaba 1.6 depends on <a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code> and related modules</a>.
161     They are not required in practice.</dd>
162     </dl>
163 wakaba 1.1 </div>
164    
165     <div class="section" id="download">
166     <h2>Distribution</h2>
167    
168     <p>The development version of Whatpm may be found in the
169     <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS
170     repository</a>.</p>
171    
172 wakaba 1.2 </div>
173    
174     <div class="section" id="todo">
175     <h2>TO DO</h2>
176    
177     <ul>
178     <li>Bug fix (Test results:
179 wakaba 1.3 <a href="t/content-type-result"><code>Whatpm::ContentType</code></a>,
180 wakaba 1.2 <a href="t/tokenizer-result">HTML tokenization</a>,
181 wakaba 1.3 <a href="t/tree-construction-result">HTML tree construction</a>,
182     <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
183     <li>Charset detection.</li>
184 wakaba 1.4 <li>Validation for <code>meta</code>.</li>
185     <li>Validation for media queries, IRIs (against URI schemes), language tags,
186 wakaba 1.3 and so on.</li>
187 wakaba 1.4 <li>Documentations are missing for some features.</li>
188 wakaba 1.14 <li>XML parser<!-- with application cache selection algorithm hook-->.</li>
189 wakaba 1.3 <li>In addition, each module has its own TO DO items.
190     (Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>
191 wakaba 1.2 </ul>
192 wakaba 1.7 </div>
193    
194     <div class=section id=acknowledgments>
195     <h2>Acknowledgments</h2>
196    
197     <p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a>
198 wakaba 1.17 team for their
199     <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
200 wakaba 1.7 parser test data</a>.</p>
201 wakaba 1.1 </div>
202    
203     <div class="section" id="author">
204     <h2>Author</h2>
205    
206 wakaba 1.4 <p><a href="http://suika.fam.cx/~wakaba/who?" rel="author">Wakaba</a>.</p>
207 wakaba 1.1 </div>
208    
209     <div class="section" id="license">
210     <h2>License</h2>
211    
212 wakaba 1.4 <p>Copyright 2007 Wakaba
213     <code class="mail">&lt;<a href="mailto:w@suika.fam.cx"
214     rel="author">w@suika.fam.cx</a>></code>.</p>
215 wakaba 1.1
216     <p>This library is free software; you can redistribute it and/or modify
217     it under the same terms as Perl itself.</p>
218     </div>
219    
220     </body>
221     </html>

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24