/[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.8 by wakaba, Sat Aug 25 03:43:45 2007 UTC
# Line 14  Technologies (beta)</title> Line 14  Technologies (beta)</title>
14  <h2>Introduction</h2>  <h2>Introduction</h2>
15    
16  <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 Perl modules for
17  Web hypertext application technologies.</p>  Web hypertext application technologies.  It is part
18    of the <a href="http://suika.fam.cx/www/2006/manakai/" rel=up>manakai</a>
19  <p>It currently contains three Perl modules:</p>  project.</p>
20    
21  <dl>  <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>  <dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>
28    <dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>    <dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>
29  <dt><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>  <dt><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>
30    <dd>An implementation of HTML5 parsing algorithm and    <dd>An implementation of HTML5 parsing algorithm, fragment
31    <code>innerHTML</code> serialization.</dd>    parsing, and fragment serialization algorithms.  It can be used
32  <dt><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt>    to convert a string into DOM, or <i lang="">vice versa</i>.</dd>
33    <dd>A DOM5 HTML (in-memory representation of a document) conformance  <dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>
34    checker.</dd>    <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    <dt><a href="Whatpm/IMTChecker.html"><code>Whatpm::IMTChecker</code></a></dt>
38      <dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label
39      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    <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
43      <dd>A simple XML serializer.</dd>
44      </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    <dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
54      <dd>Description of errors to be notified to callback functions by Whatpm
55      modules.</dd>
56      </dd></dl></dd>
57  </dl>  </dl>
58  </div>  </div>
59    
60  <div class="section" id="demo">  <div class="section" id="demo">
61  <h2>Demo</h2>  <h2>Demo</h2>
62    
63  <p><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser  <ul>
64  and checker demo</a></p>  <li><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser
65    and checker demo</a></li>
66    <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    <li><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table
69    structure visualization demo</a></li>
70    </ul>
71    </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  </div>  </div>
106    
107  <div class="section" id="download">  <div class="section" id="download">
# Line 56  repository</a>.</p> Line 123  repository</a>.</p>
123      <a href="t/tree-construction-result">HTML tree construction</a>,      <a href="t/tree-construction-result">HTML tree construction</a>,
124      <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>      <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
125    <li>Charset detection.</li>    <li>Charset detection.</li>
126    <li>Table validation.</li>    <li>Validation for <code>meta</code>.</li>
127    <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,  
128      and so on.</li>      and so on.</li>
129      <li>Documentations are missing for some features.</li>
130    <li><q>Whatpm</q> is a code name in fact.  Please let me know    <li><q>Whatpm</q> is a code name in fact.  Please let me know
131      if you have a better name.</li>      if you have a better name.</li>
132    <li>In addition, each module has its own TO DO items.    <li>In addition, each module has its own TO DO items.
# Line 67  repository</a>.</p> Line 134  repository</a>.</p>
134  </ul>  </ul>
135  </div>  </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    </div>
144    
145  <div class="section" id="author">  <div class="section" id="author">
146  <h2>Author</h2>  <h2>Author</h2>
147    
148  <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>
149  </div>  </div>
150    
151  <div class="section" id="license">  <div class="section" id="license">
152  <h2>License</h2>  <h2>License</h2>
153    
154  <p>Copyright 2007 Wakaba &lt;w@suika.fam.cx></p>  <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    
158  <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
159  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.8
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24