/[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.2 by wakaba, Wed May 2 13:44:33 2007 UTC revision 1.19 by wakaba, Mon Nov 19 12:18:26 2007 UTC
# Line 13  Technologies (beta)</title> Line 13  Technologies (beta)</title>
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        </dd>
91        <dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>
92          <dd>Description of data structure for Selectors, as implemented by
93          <a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a>
94          (as output), and
95          <a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a>
96          (as input)<!--, and
97          <a href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/SelectorsAPI.html"><code>Message::DOM::SelectorsAPI</code></a>-->.</dd>
98        </dl>
99      </dd>
100  </dl>  </dl>
101  </div>  </div>
102    
103  <div class="section" id="demo">  <div class="section" id="demo">
104  <h2>Demo</h2>  <h2>Demo</h2>
105    
106  <p><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser  <ul>
107  demo</a></p>  <li id=demo-html-parser-nanodom><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser
108    and checker demo</a>
109    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser.cgi">source</a>,
110    with <a href="Whatpm/NanoDOM.html">a lightweight non-conforming
111    DOM implementation</a>)</li>
112    <li id=demo-html-parser-manakai><a href="http://suika.fam.cx/gate/2007/html/parser-manakai-interface">HTML5
113    parser and checker demo, with manakai's DOM implementation</a>
114    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser-manakai.cgi">source</a>)</li>
115    <li id=demo-html-table><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table
116    structure visualization demo</a>
117    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/table.cgi">source</a>)</li>
118    <li id=demo-css-parser><a href="http://suika.fam.cx/gate/2007/css/parser-interface">CSS tokenizer
119    demo</a>
120    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/css/parser.cgi">source</a>)</li>
121    </ul>
122    </div>
123    
124    <div class="section" id="dependency">
125    <h2>Dependency</h2>
126    
127    <dl>
128    <dt id=dependency-perl>Perl 5.8 or later</dt>
129      <dd>It is recommended to use newer stable release of Perl 5.8 (or
130      later).</dd>
131      <dd id=dependency-encode>Some modules require <code>Encode</code>
132      modules, which are part of standard Perl distribution.</dd>
133    <dt id=dependency-manakai-core>Modules from
134    <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a></dt>
135      <dd>
136        <dl>
137    <dt id=dependency-error><a href="http://search.cpan.org/author/SHLOMIF/Error-0.17009/lib/Error.pm"><code>Error</code></a></dt>
138      <dd>Module <code>Whatpm::HTML</code> requires <code>Error</code>,
139      which is bundled in
140      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
141    <dt><code>Message::IMT::InternetMediaType</code></dt>
142      <dd>Module <code>Whatpm::IMTChecker</code> depends on
143      <code>Message::IMT::InternetMediaType</code>, which is part of
144      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
145    <dt><code>Message::URI::URIReference</code></dt>
146      <dd>Modules <code>Whatpm::URIChecker</code> and
147      <code>Whatpm::CacheManifest</code> depend on
148      <a href="http://suika.fam.cx/www/manakai-core/lib/Message/URI/URIReference.html"><code>Message::URI::URIReference</code></a>,
149      which is part of
150      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
151    <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
152      <dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
153      depends on <code>Message::DOM::DOMImplementation</code> and related modules
154      in <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
155      They are not required in practice.</dd>
156        </dl>
157      </dd>
158    <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
159    charlib</a></dt>
160      <dd>Module <code>Whatpm::Charset::DecodeHandle</code> depends on
161      modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
162      charlib</a> for decoding of <em>Japanese character encodings</em>.
163      See the documentation for
164      <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
165      charlib</a> for more information.</dd>
166    <dt><a href="http://www.python.org/">Python</a>, Perl
167    <a href="http://search.cpan.org/~neilw/Inline-Python-0.22/"><code>Inline::Python</code></a>
168    module, and <a href="http://chardet.feedparser.org/">Universal Encoding
169    Detector</a></dt>
170      <dd>For the module <code>Whatpm::Charset::UniversalCharDet</code> being
171      meaningful, these softwares are requires on the system.  See the
172      <a href="Whatpm/Charset/UniversalCharDet.html#dependency">documentation</a>
173      for more information.</dd>
174    <dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>
175      <dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and
176      <code>Whatpm::CSS::Tokenizer</code>
177      depends on <a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code> and related modules</a>.
178      They are not required in practice.</dd>
179    </dl>
180  </div>  </div>
181    
182  <div class="section" id="download">  <div class="section" id="download">
183  <h2>Distribution</h2>  <h2>Distribution</h2>
184    
 <p>Tarball will be available when setter for <code>innerHTML</code>  
 is implemented.</p>  
   
185  <p>The development version of Whatpm may be found in the  <p>The development version of Whatpm may be found in the
186  <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS  <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS
187  repository</a>.</p>  repository</a>.</p>
# Line 51  repository</a>.</p> Line 193  repository</a>.</p>
193    
194  <ul>  <ul>
195    <li>Bug fix (Test results:    <li>Bug fix (Test results:
196        <a href="t/content-type-result"><code>Whatpm::ContentType</code></a>,
197      <a href="t/tokenizer-result">HTML tokenization</a>,      <a href="t/tokenizer-result">HTML tokenization</a>,
198      <a href="t/tree-construction-result">HTML tree construction</a>)</li>      <a href="t/tree-construction-result">HTML tree construction</a>,
199    <li><code>innerHTML</code> setter</li>      <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
200    <li>Charset detection</li>    <li>Charset detection.</li>
201    <li><q>Whatpm</q> is a code name in fact.  Please let me know    <li>Validation for <code>meta</code>.</li>
202      if you have a better name.</li>    <li>Validation for media queries, IRIs (against URI schemes), language tags,
203    <li>Each module has its own TO DO list.</li>      and so on.</li>
204      <li>Documentations are missing for some features.</li>
205      <li>XML parser<!-- with application cache selection algorithm hook-->.</li>
206      <li>In addition, each module has its own TO DO items.
207        (Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>
208  </ul>  </ul>
209  </div>  </div>
210    
211    <div class=section id=acknowledgments>
212    <h2>Acknowledgments</h2>
213    
214    <p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a>
215    team for their
216    <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
217    parser test data</a>.</p>
218    </div>
219    
220  <div class="section" id="author">  <div class="section" id="author">
221  <h2>Author</h2>  <h2>Author</h2>
222    
223  <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>
224  </div>  </div>
225    
226  <div class="section" id="license">  <div class="section" id="license">
227  <h2>License</h2>  <h2>License</h2>
228    
229  <p>Copyright 2007 Wakaba &lt;w@suika.fam.cx></p>  <p>Copyright 2007 Wakaba
230    <code class="mail">&lt;<a href="mailto:w@suika.fam.cx"
231        rel="author">w@suika.fam.cx</a>></code>.</p>
232    
233  <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
234  it under the same terms as Perl itself.</p>  it under the same terms as Perl itself.</p>
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.19
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24