/[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.9 - (show annotations) (download) (as text)
Sun Sep 9 05:35:49 2007 UTC (17 years, 1 month ago) by wakaba
Branch: MAIN
Changes since 1.8: +4 -0 lines
File MIME type: text/html
++ ChangeLog	9 Sep 2007 05:35:45 -0000
2007-09-09  Wakaba  <wakaba@suika.fam.cx>

	* readme.en.html: Links to CSS tokenizer module & demo
	are added.

++ whatpm/Whatpm/ChangeLog	9 Sep 2007 05:35:16 -0000
2007-09-09  Wakaba  <wakaba@suika.fam.cx>

	* LangTag.pm: New module.

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

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24