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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1 by wakaba, Tue May 1 11:10:37 2007 UTC revision 1.21 by wakaba, Fri Nov 23 07:35:02 2007 UTC
# Line 2  Line 2 
2  <html lang="en">  <html lang="en">
3  <head>  <head>
4  <title>Whatpm &mdash; Perl Modules for Web Hypertext Application  <title>Whatpm &mdash; Perl Modules for Web Hypertext Application
5  Technologies</title>  Technologies (beta)</title>
6  <link rel="stylesheet" href="http://suika.fam.cx/www/style/html/xhtml">  <link rel="stylesheet" href="http://suika.fam.cx/www/style/html/xhtml">
7  <link rel="license" href="#license">  <link rel="license" href="#license">
8  <link rel="author" href="#author">  <link rel="author" href="#author">
9  </head>  </head>
10  <body>  <body>
11  <h1>Whatpm</h1>  <h1>Whatpm (<em>beta</em>)</h1>
12    
13  <div class="section" id="introduction">  <div class="section" id="introduction">
14  <h2>Introduction</h2>  <h2>Introduction</h2>
15    
16  <p><dfn>Whatpm</dfn> is a set of Perl modules for  <p><dfn>Whatpm</dfn> is a <em>work-in-progress</em> set of <m>P</m>erl
17  Web hypertext application technologies.</p>  <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  <p>It currently contains two Perl modules:</p>  of the <a href="http://suika.fam.cx/www/2006/manakai/" rel=up>manakai</a>
20    project.</p>
21    
22  <dl>  <dl>
23    <dt>Modules</dt>
24    <dd><dl>
25    <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    <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    <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      checker with a partial support for Atom 1.0.  (See also
35      <a href="#demo-html-parser">demo</a>.)</dd>
36  <dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>  <dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>
37    <dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>    <dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>
38  <dt><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>  <dt><a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a></dt>
39    <dd>An implementation of HTML5 parsing algorithm and    <dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of
40    <code>innerHTML</code> serialization.</dd>    selectors</a> parser.  (See also <a href="#demo-css-parser">demo</a>.)</dd>
41    <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      selectors</a> serializer.  (See also <a href="#spec-ssft">specification</a>
44      and <a href="#demo-css-parser">demo</a>.)</dd>
45    <dt><a href="Whatpm/CSS/Tokenizer.html"><code>Whatpm::CSS::Tokenizer</code></a></dt>
46      <dd>A CSS tokenizer.  (See also <a href="#demo-css-parser">demo</a>.)</dd>
47    <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      <a href="#demo-html-parser">demo</a>.)</dd>
53    <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    <dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>
57      <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      element node.  (See also <a href="#demo-html-table">demo</a>.)</dd>
60    <dt><a href="Whatpm/IMTChecker.html"><code>Whatpm::IMTChecker</code></a></dt>
61      <dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label
62      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    <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
66      <dd>A simple XML serializer.</dd>
67      </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    <dt id=spec>Specification</dt>
75      <dd><dl>
76        <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        Specification</a></dt>
78          <dd>The specification for the serialization format used for
79          testing Selectors-related modules.</dd>
80        <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      </dl></dd>
85    <dt>Documentations</dt>
86      <dd><dl>
87    <dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
88      <dd>Description of errors to be notified to callback functions by Whatpm
89      modules.</dd>
90        <dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>
91          <dd>Description of data structure for Selectors, as implemented by
92          <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        <dt id=doc-user-data-names><a href="http://suika.fam.cx/gate/2005/sw/manakai/Predefined%20User%20Data%20Names">List of predefined user data names</a></dt>
98          <dd>List of user data names defined by Whatpm modules.</dd>
99        </dl>
100      </dd>
101  </dl>  </dl>
102  </div>  </div>
103    
104  <div class="section" id="demo">  <div class="section" id="demo">
105  <h2>Demo</h2>  <h2>Demo</h2>
106    
107  <p><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser  <ul>
108  demo</a></p>  <li id=demo-html-parser-nanodom><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser
109    and checker demo</a>
110    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser.cgi">source</a>,
111    with <a href="Whatpm/NanoDOM.html">a lightweight non-conforming
112    DOM implementation</a>)</li>
113    <li id=demo-html-parser-manakai><a href="http://suika.fam.cx/gate/2007/html/parser-manakai-interface">HTML5
114    parser and checker demo, with manakai's DOM implementation</a>
115    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser-manakai.cgi">source</a>)</li>
116    <li id=demo-html-table><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table
117    structure visualization demo</a>
118    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/table.cgi">source</a>)</li>
119    <li id=demo-css-parser><a href="http://suika.fam.cx/gate/2007/css/parser-interface">CSS tokenizer
120    demo</a>
121    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/css/parser.cgi">source</a>)</li>
122    </ul>
123    </div>
124    
125    <div class="section" id="dependency">
126    <h2>Dependency</h2>
127    
128    <dl>
129    <dt id=dependency-perl>Perl 5.8 or later</dt>
130      <dd>It is recommended to use newer stable release of Perl 5.8 (or
131      later).</dd>
132      <dd id=dependency-encode>Some modules require <code>Encode</code>
133      modules, which are part of standard Perl distribution.</dd>
134    <dt id=dependency-manakai-core>Modules from
135    <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a></dt>
136      <dd>
137        <dl>
138    <dt id=dependency-error><a href="http://search.cpan.org/author/SHLOMIF/Error-0.17009/lib/Error.pm"><code>Error</code></a></dt>
139      <dd>Module <code>Whatpm::HTML</code> requires <code>Error</code>,
140      which is bundled in
141      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
142    <dt><code>Message::IMT::InternetMediaType</code></dt>
143      <dd>Module <code>Whatpm::IMTChecker</code> depends on
144      <code>Message::IMT::InternetMediaType</code>, which is part of
145      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
146    <dt><code>Message::URI::URIReference</code></dt>
147      <dd>Modules <code>Whatpm::URIChecker</code> and
148      <code>Whatpm::CacheManifest</code> depend on
149      <a href="http://suika.fam.cx/www/manakai-core/lib/Message/URI/URIReference.html"><code>Message::URI::URIReference</code></a>,
150      which is part of
151      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
152      <dt><code>Message::Charset::Info</code></dt>
153        <dd>Module <code>Whatpm::ContentChecker</code> depends on
154        <a href="http://suika.fam.cx/www/manakai-core/lib/Message/Charset/Info.html"><code>Message::Charset::Info</code></a>,
155        which is part of
156        <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
157    <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
158      <dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
159      depends on <code>Message::DOM::DOMImplementation</code> and related modules
160      in <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
161      They are not required in practice.</dd>
162        </dl>
163      </dd>
164    <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
165    charlib</a></dt>
166      <dd>Module <code>Whatpm::Charset::DecodeHandle</code> depends on
167      modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
168      charlib</a> for decoding of <em>Japanese character encodings</em>.
169      See the documentation for
170      <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
171      charlib</a> for more information.</dd>
172    <dt><a href="http://www.python.org/">Python</a>, Perl
173    <a href="http://search.cpan.org/~neilw/Inline-Python-0.22/"><code>Inline::Python</code></a>
174    module, and <a href="http://chardet.feedparser.org/">Universal Encoding
175    Detector</a></dt>
176      <dd>For the module <code>Whatpm::Charset::UniversalCharDet</code> being
177      meaningful, these softwares are requires on the system.  See the
178      <a href="Whatpm/Charset/UniversalCharDet.html#dependency">documentation</a>
179      for more information.</dd>
180    <dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>
181      <dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and
182      <code>Whatpm::CSS::Tokenizer</code>
183      depends on <a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code> and related modules</a>.
184      They are not required in practice.</dd>
185    </dl>
186  </div>  </div>
187    
188  <div class="section" id="download">  <div class="section" id="download">
189  <h2>Distribution</h2>  <h2>Distribution</h2>
190    
 <p>Tarball will be available when setter for <code>innerHTML</code>  
 is implemented.</p>  
   
191  <p>The development version of Whatpm may be found in the  <p>The development version of Whatpm may be found in the
192  <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS  <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS
193  repository</a>.</p>  repository</a>.</p>
194    
195  </div>  </div>
196    
197    <div class="section" id="todo">
198    <h2>TO DO</h2>
199    
200    <ul>
201      <li>Bug fix (Test results:
202        <a href="t/content-type-result"><code>Whatpm::ContentType</code></a>,
203        <a href="t/tokenizer-result">HTML tokenization</a>,
204        <a href="t/tree-construction-result">HTML tree construction</a>,
205        <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
206      <li>Charset detection.</li>
207      <li>Validation for <code>meta</code>.</li>
208      <li>Validation for media queries, IRIs (against URI schemes), language tags,
209        and so on.</li>
210      <li>Documentations are missing for some features.</li>
211      <li>XML parser<!-- with application cache selection algorithm hook-->.</li>
212      <li>In addition, each module has its own TO DO items.
213        (Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>
214    </ul>
215    </div>
216    
217    <div class=section id=acknowledgments>
218    <h2>Acknowledgments</h2>
219    
220    <p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a>
221    team for their
222    <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
223    parser test data</a>.</p>
224    </div>
225    
226  <div class="section" id="author">  <div class="section" id="author">
227  <h2>Author</h2>  <h2>Author</h2>
228    
229  <p><a href="http://suika.fam.cx/~wakaba/who?">Wakaba</a>.</p>  <p><a href="http://suika.fam.cx/~wakaba/who?" rel="author">Wakaba</a>.</p>
230  </div>  </div>
231    
232  <div class="section" id="license">  <div class="section" id="license">
233  <h2>License</h2>  <h2>License</h2>
234    
235  <p>Copyright 2007 Wakaba &lt;w@suika.fam.cx></p>  <p>Copyright 2007 Wakaba
236    <code class="mail">&lt;<a href="mailto:w@suika.fam.cx"
237        rel="author">w@suika.fam.cx</a>></code>.</p>
238    
239  <p>This library is free software; you can redistribute it and/or modify  <p>This library is free software; you can redistribute it and/or modify
240  it under the same terms as Perl itself.</p>  it under the same terms as Perl itself.</p>
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.21
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24