/[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.8 - (hide annotations) (download) (as text)
Sat Aug 25 03:43:45 2007 UTC (17 years, 2 months ago) by wakaba
Branch: MAIN
Changes since 1.7: +27 -11 lines
File MIME type: text/html
Documentation updated

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

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24