/[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.10 - (hide annotations) (download) (as text)
Sat Sep 22 12:50:47 2007 UTC (17 years, 1 month ago) by wakaba
Branch: MAIN
Changes since 1.9: +13 -0 lines
File MIME type: text/html
Link to new modules and spec

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

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24