/[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.3 by wakaba, Sun May 20 11:12:25 2007 UTC revision 1.27 by wakaba, Wed Sep 17 06:34:12 2008 UTC
# Line 8  Technologies (beta)</title> Line 8  Technologies (beta)</title>
8  <link rel="author" href="#author">  <link rel="author" href="#author">
9  </head>  </head>
10  <body>  <body>
11  <h1>Whatpm (<em>beta</em>)</h1>  <h1>Whatpm &mdash; Perl modules for Web hypertext application technologies
12    (<em>beta</em>)</h1>
13    
14  <div class="section" id="introduction">  <div class="section" id="introduction">
15  <h2>Introduction</h2>  <h2>Introduction</h2>
16    
17  <p><dfn>Whatpm</dfn> is a <em>work-in-progress</em> set of Perl modules for  <p><dfn>Whatpm</dfn> is a <em>work-in-progress</em> set of
18  Web hypertext application technologies.</p>  <mark>P</mark>erl <mark>m</mark>odules for <mark>W</mark>eb
19    <mark>h</mark>ypertext <mark>a</mark>pplication
20    <mark>t</mark>echnologies.  It is part of the <a
21    href="http://suika.fam.cx/www/2006/manakai/" rel=up>manakai</a>
22    project.</p>
23    
24    <p>Whatpm supports various Web standard technologies, including <a
25    href="#modules-html">HTML, XHTML</a>, <a href="#modules-xml">XML</a>,
26    <a hreF="#modules-css">CSS</a>, <a href="#modules-http">HTTP</a>, and
27    <a href="#modules-url">URL</a>.
28    </div>
29    
30    <div class=section id=modules>
31    <h2>Modules</h2>
32    
33  <p>It currently contains three Perl modules:</p>  <div class=section id=modules-html-xml>
34    <h3>Modules for HTML and XML</h3>
35    
36    <p id=modules-html>Modules related to HTML and XHTML are as follows:
37    <dl>
38    <dt id=module-whatpm-html><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>
39      <dd>An implementation of HTML5 document and fragment
40      parsing algorithms.  It can be used
41      to convert an arbitrary string into a
42      <abbr title="Document Object Model">DOM</abbr>.  (See also
43      <a href="#demo-html-parser">demo</a>.)</dd>
44    <dt id=module-whatpm-html-serializer><a href="Whatpm/HTML/Serializer.html"><code>Whatpm::HTML::Serializer</code></a></dt>
45      <dd>An implementation of HTML5 fragment serialization algorithm.
46      (See also <a href="#demo-html-parser">demo</a>.)</dd>
47    <dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>
48      <dd>An implementation of the HTML5 table algorithm.  It can be
49      used to extract a table structure from a DOM <code>table</code>
50      element node.  (See also <a href="#demo-html-table">demo</a>.)</dd>
51    </dl>
52    
53    <p id=modules-xml>The module for <i>tentative</i> XML support is as follow:
54    <dl>
55    <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
56      <dd>A simple XML serializer.</dd>
57    </dl>
58    
59    <p><i>Real</i> XML parser and serializer are currently not available yet.
60    
61    <p id=modules-cc>The module for conformance checking of a DOM tree (i.e.
62    a in-memory representation of a HTML or XML document) is as follows:
63  <dl>  <dl>
 <dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>  
   <dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>  
 <dt><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>  
   <dd>An implementation of HTML5 parsing algorithm and  
   <code>innerHTML</code> serialization.</dd>  
64  <dt><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt>  <dt><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt>
65    <dd>A DOM5 HTML (in-memory representation of a document) conformance    <dd>A DOM5 HTML (in-memory representation of a document) conformance
66    checker.</dd>    checker with a partial support for Atom 1.0.  (See also
67      <a href="#demo-html-parser">demo</a>.)</dd>
68    </dl>
69    
70    <p>Currently, conformance checking of HTML/XHTML and Atom documents
71    is supported.
72    
73    <p>For these modules, a DOM implementation that supports the manakai's
74    Perl binding<!-- @@ TODO: ref --> is necessary to represent a document
75    in memory.  The <a
76    href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai-core</a>
77    package contains such an implementation,
78    <code>Message::DOM::Implementation</code><!-- @@ TODO: ref -->, but it
79    should also be possible to use any other implementation that supports
80    the binding.
81    </div>
82    
83    <div class=section id=modules-css>
84    <h3>Modules for CSS</h3>
85    
86    <p>Modules for CSS and related technologies are as follows:
87    <dl>
88    <dt><a href="Whatpm/CSS/Cascade.html"><code>Whatpm::CSS::Cascade</code></a>
89      <dd>A media-independent implementation of CSS cascading and value
90      computation.  (See also <a href="#demo-css-parser">demo</a>.)
91    <dt><a href="Whatpm/CSS/MediaQueryParser.pm"><code>Whatpm::CSS::MediaQueryParser</code></a>
92      <dd>A media query parser.
93    <dt><a href="Whatpm/CSS/MediaQuerySerializer.pm"><code>Whatpm::CSS::MediaQuerySerializer</code></a>
94      <dd>A media query serializer.
95    <dt><a href="Whatpm/CSS/Parser.html"><code>Whatpm::CSS::Parser</code></a>
96      <dd>A CSS parser that constructs CSSOM trees from style sheets.  (See
97      also <a href="#demo-css-parser">demo</a>.)
98    <dt><a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a></dt>
99      <dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of
100      selectors</a> parser.  (See also <a href="#demo-css-parser">demo</a>.)</dd>
101    <dt><a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a></dt>
102      <dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of
103      selectors</a> serializer.  (See also <a href="#spec-ssft">specification</a>
104      and <a href="#demo-css-parser">demo</a>.)</dd>
105    <dt><a href="Whatpm/CSS/Tokenizer.html"><code>Whatpm::CSS::Tokenizer</code></a></dt>
106      <dd>A CSS tokenizer.  (See also <a href="#demo-css-parser">demo</a>.)</dd>
107    </dl>
108    
109    <p>For the <code>Whatpm::CSS::Parser</code> module reresents a CSSOM
110    tree, modules in the <a
111    href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai-core</a>
112    package are used.  Those modules also provide the serializer for the
113    CSSOM tree, as the standard <code>css_text</code> attribute.
114    </div>
115    
116    <div class=section id=modules-http>
117    <h3>Modules for HTTP</h3>
118    
119    <p>Modules for HTTP and related technologies are as follows:
120    <dl>
121    <dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>
122      <dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>
123    <dt><a href="Whatpm/IMTChecker.html"><code>Whatpm::IMTChecker</code></a></dt>
124      <dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label
125      conformance checker.</dd>
126    </dl>
127    
128    <p>Currently, support for parsing of HTTP headers and as such is not
129    yet available.
130    </div>
131    
132    <div class=section id=modules-url>
133    <h3>Module for URL</h3>
134    
135    <p>Module for the URL support is as follows:
136    <dl>
137    <dt><a href="Whatpm/URIChecker.html"><code>Whatpm::URIChecker</code></a></dt>
138      <dd>An IRI reference conformance checker.</dd>
139    </dl>
140    
141    <p>Support for HTML5's realistic definition of URL is not available yet.
142    </div>
143    
144    <div class=section id=modules-misc>
145    <h3>Modules for other technologies</h3>
146    
147    <p>Following modules provide support for other Web-related technologies:
148    <dl>
149    <dt><a href="Whatpm/CacheManifest.html"><code>Whatpm::CacheManifest</code></a></dt>
150      <dd>An
151      <a href="http://www.whatwg.org/specs/web-apps/current-work/#manifests">HTML5
152      cache manifest</a> parser.</dd>
153    <dt><a href="Whatpm/Charset/DecodeHandle.html"><code>Whatpm::Charset::DecodeHandle</code></a>
154      <dd>A filehandle-like wrapper <a href="#doc-handles">interface</a> to
155      decode byte stream encoded in some character encoding.
156    <dt><a href="Whatpm/Charset/UnicodeChecker.html"><code>Whatpm::Charset::UnicodeChecker</code></a>
157      <dd>A Unicode character string checker.
158    <dt id=whatpm-charset-universalchardet><a href="Whatpm/Charset/UniversalCharDet.html"><code>Whatpm::Charset::UniversalCharDet</code></a></dt>
159      <dd>A Perl interface to universalchardet character encoding detection
160      library.</dd>
161      <dt><a href="Whatpm/LangTag.html"><code>Whatpm::LangTag</code></a>
162        <dd>A language tag parser and conformance checker, supporting both
163        older RFC 3066 definition and latest RFC 4646 definition.  (See also
164        <a href="#demo-langtag">demo</a>.)
165    <dt><a href="Whatpm/WebIDL.html"><code>Whatpm::WebIDL</code></a></dt>
166      <dd>A WebIDL fragment parser.  It parses an IDL fragment, whether conforming
167      or not, and constructs a DOM-like object model for further processing.
168      Non-conforming (or broken) IDL fragment-like string will be parsed using
169      CSS-like error-tolerant parsing rules, e.g. ignoring anything until next
170      <code>;</code> character.
171    </dl>
172    </div>
173    
174      <p>Note that all of these modules are <em>work in progress</em>
175      and have <a href="#todo">a number of unresolved problems</a>.</p>
176    
177      <p>Note also that some modules have no documentation for now.</p>
178    
179    <!-- Whatpm::ContentChecker::*, Whatpm::H2H, Whatpm::NanoDOM, and
180         Whatpm::XMLParser are intentionally omitted from the list. -->
181    </div>
182    
183    <div class=section id=documents>
184    <h2>Documents</h2>
185    
186    <p>For the description of functionalities provided by each module, see
187    <abbr>pod</abbr> documentation of the module.  HTML version of
188    <abbr>pod</abbr> documentations are linked from the <a
189    href="#modules">list of modules above</a>.
190    
191    <p>In addition, there are additional documents for some topics:
192    <dl>
193    <dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
194    <!-- @@ TODO: Need to update the link - the document above is out of date -->
195      <dd>Description of errors to be notified to callback functions by Whatpm
196      modules.</dd>
197    
198    <dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>
199      <dd>Description of data structure for Selectors, as implemented by
200      <a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a>
201      (as output), and
202      <a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a>
203      (as input)<!--, and
204      <a href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/SelectorsAPI.html"><code>Message::DOM::SelectorsAPI</code></a>-->.</dd>
205    
206    <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>
207      <dd>List of user data names defined by Whatpm modules.</dd>
208    
209    <dt id=doc-handles><a href="Whatpm/Charset/handles">Handle objects</a>
210      <dd>Description of character or byte stream input handle interfaces.
211    </dl>
212    
213    <p>Following specifications define Whatpm-specific formats and extensions:
214    <dl id=spec>
215    <dt id=spec-ssft><a href="http://suika.fam.cx/www/markup/selectors/ssft/ssft"><abbr title="Selectors Serialization Format for Testing">SSFT</abbr>
216    Specification</a></dt>
217      <dd>The specification for the serialization format used for
218      testing Selectors-related modules.</dd>
219    
220    <dt id=spec-manakai-selectors"><a href="http://suika.fam.cx/gate/2005/sw/manakai/Selectors%20Extensions">manakai's
221    Selectors Extensions</a></dt>
222      <dd>The specification for <code>:-manakai-<var>*</var></code>
223      pseudo-classes implemented by Selectors-related modules.</dd>
224  </dl>  </dl>
225  </div>  </div>
226    
227  <div class="section" id="demo">  <div class="section" id="demo">
228  <h2>Demo</h2>  <h2>Demo</h2>
229    
230  <p><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser  <ul>
231  and checker demo</a></p>  <li id=demo-html-parser-nanodom><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser
232    and checker demo</a>
233    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser.cgi">source</a>,
234    with <a href="Whatpm/NanoDOM.html">a lightweight non-conforming
235    DOM implementation</a>)</li>
236    <li id=demo-html-parser-manakai><a href="http://suika.fam.cx/gate/2007/html/parser-manakai-interface">HTML5
237    parser and checker demo, with manakai's DOM implementation</a>
238    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser-manakai.cgi">source</a>)</li>
239    <li id=demo-html-table><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table
240    structure visualization demo</a>
241    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/table.cgi">source</a>)</li>
242    
243    <li id=demo-css-parser><a href="http://suika.fam.cx/gate/2007/css/parser-interface">CSS
244    tokenizer, parser, and computed style computation demo</a>
245    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/css/parser.cgi">source</a>)</li>
246    
247    <li id=demo-langtag><a href="http://suika.fam.cx/gate/2007/langtag/langtag-demo-interface">Language
248    tag parsing and conformance checking demo</a>
249    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/langtag/langtag-demo.cgi">source</a>)
250    </ul>
251    </div>
252    
253    <div class=section id=applications>
254    <h2>Application</h2>
255    
256    <ul>
257    <li><a href="http://suika.fam.cx/gate/2007/html/cc/"><abbr>WebHACC</abbr>
258    (Web hypertext application conformance checker)</a>
259    </ul>
260    </div>
261    
262    <div class="section" id="dependency">
263    <h2>Dependency</h2>
264    
265    <dl>
266    <dt id=dependency-perl>Perl 5.8 or later</dt>
267      <dd>It is recommended to use newer stable release of Perl 5.8 (or
268      later).</dd>
269      <dd id=dependency-encode>Some modules require <code>Encode</code>
270      modules, which are part of standard Perl distribution.</dd>
271    <dt id=dependency-manakai-core>Modules from
272    <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a></dt>
273      <dd>
274        <dl>
275    <dt id=dependency-error><a href="http://search.cpan.org/author/SHLOMIF/Error-0.17009/lib/Error.pm"><code>Error</code></a></dt>
276      <dd>Module <code>Whatpm::HTML</code> requires <code>Error</code>,
277      which is bundled in
278      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
279    <dt><code>Message::IMT::InternetMediaType</code></dt>
280      <dd>Module <code>Whatpm::IMTChecker</code> depends on
281      <code>Message::IMT::InternetMediaType</code>, which is part of
282      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
283    <dt><code>Message::URI::URIReference</code></dt>
284      <dd>Modules <code>Whatpm::URIChecker</code> and
285      <code>Whatpm::CacheManifest</code> depend on
286      <a href="http://suika.fam.cx/www/manakai-core/lib/Message/URI/URIReference.html"><code>Message::URI::URIReference</code></a>,
287      which is part of
288      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
289      <dt><code>Message::Charset::Info</code></dt>
290        <dd>Module <code>Whatpm::ContentChecker</code> depends on
291        <a href="http://suika.fam.cx/www/manakai-core/lib/Message/Charset/Info.html"><code>Message::Charset::Info</code></a>,
292        which is part of
293        <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
294    <dt><code>Message::DOM::DOMImplementation</code>
295      <dd>Module <code>Whatpm::URIChecker</code> depends on
296      <code>Message::DOM::DOMImplementation</code>,
297        which is part of
298        <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
299    <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
300      <dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
301      depends on <code>Message::DOM::DOMImplementation</code> and related modules
302      in <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
303      They are not required in practice.</dd>
304        </dl>
305      </dd>
306    <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
307    charlib</a></dt>
308      <dd>Module <code>Whatpm::Charset::DecodeHandle</code> depends on
309      modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
310      charlib</a> for decoding of <em>Japanese character encodings</em>.
311      See the documentation for
312      <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
313      charlib</a> for more information.</dd>
314    <dt><a href="http://www.python.org/">Python</a>, Perl
315    <a href="http://search.cpan.org/~neilw/Inline-Python-0.22/"><code>Inline::Python</code></a>
316    module, and <a href="http://chardet.feedparser.org/">Universal Encoding
317    Detector</a></dt>
318      <dd>For the module <code>Whatpm::Charset::UniversalCharDet</code> being
319      meaningful, these softwares are required on the system.  See the
320      <a href="Whatpm/Charset/UniversalCharDet.html#dependency">documentation</a>
321      for more information.</dd>
322    <dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>
323      <dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and
324      <code>Whatpm::CSS::Tokenizer</code>
325      depends on <a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code> and related modules</a>.
326      They are not required in practice.</dd>
327    </dl>
328  </div>  </div>
329    
330  <div class="section" id="download">  <div class="section" id="download">
# Line 44  and checker demo</a></p> Line 334  and checker demo</a></p>
334  <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS  <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS
335  repository</a>.</p>  repository</a>.</p>
336    
337    <p><a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/whatpm.tar.gz?tarball=1">The
338    latest developmenet version of the Whatpm</a> is also available as a
339    tarball.
340    
341  </div>  </div>
342    
343  <div class="section" id="todo">  <div class="section" id="todo">
# Line 55  repository</a>.</p> Line 349  repository</a>.</p>
349      <a href="t/tokenizer-result">HTML tokenization</a>,      <a href="t/tokenizer-result">HTML tokenization</a>,
350      <a href="t/tree-construction-result">HTML tree construction</a>,      <a href="t/tree-construction-result">HTML tree construction</a>,
351      <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>      <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
352      <li>Merge with the <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>
353          code tree.
354    <li>Charset detection.</li>    <li>Charset detection.</li>
355    <li>Table validation.</li>    <li>Validation for <code>meta</code>.</li>
356    <li>Validation for <code>rel</code>, <code>meta</code>.</li>    <li>Validation for media queries, IRIs (against URI schemes), language tags,
   <li>Validation for media types, media queries, IRIs, language tags,  
357      and so on.</li>      and so on.</li>
358    <li><q>Whatpm</q> is a code name in fact.  Please let me know    <li>Documentations are missing for some features.</li>
359      if you have a better name.</li>    <li>XML parser<!-- with application cache selection algorithm hook-->.</li>
360    <li>In addition, each module has its own TO DO items.    <li>In addition, each module has its own TO DO items.
361      (Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>      (Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>
362  </ul>  </ul>
363  </div>  </div>
364    
365    <div class=section id=acknowledgments>
366    <h2>Acknowledgments</h2>
367    
368    <p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a>
369    team for their
370    <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
371    parser test data</a>.</p>
372    </div>
373    
374  <div class="section" id="author">  <div class="section" id="author">
375  <h2>Author</h2>  <h2>Author</h2>
376    
377  <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>
378  </div>  </div>
379    
380  <div class="section" id="license">  <div class="section" id="license">
381  <h2>License</h2>  <h2>License</h2>
382    
383  <p>Copyright 2007 Wakaba &lt;w@suika.fam.cx></p>  <p>Copyright 2007$B!>(B2008 Wakaba
384    <code class="mail">&lt;<a href="mailto:w@suika.fam.cx"
385        rel="author">w@suika.fam.cx</a>></code>.</p>
386    
387  <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
388  it under the same terms as Perl itself.</p>  it under the same terms as Perl itself.</p>
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.27
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24