/[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.18 by wakaba, Sun Nov 18 04:26:50 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><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt>
30      <dd>A DOM5 HTML (in-memory representation of a document) conformance
31      checker with a partial support for Atom 1.0.  (See also
32      <a href="#demo-html-parser">demo</a>.)</dd>
33  <dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>  <dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>
34    <dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>    <dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>
35  <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>
36    <dd>An implementation of HTML5 parsing algorithm and    <dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of
37    <code>innerHTML</code> serialization.</dd>    selectors</a> parser.  (See also <a href="#demo-css-parser">demo</a>.)</dd>
38    <dt><a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a></dt>
39      <dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of
40      selectors</a> serializer.  (See also <a href="#spec-ssft">specification</a>
41      and <a href="#demo-css-parser">demo</a>.)</dd>
42    <dt><a href="Whatpm/CSS/Tokenizer.html"><code>Whatpm::CSS::Tokenizer</code></a></dt>
43      <dd>A CSS tokenizer.  (See also <a href="#demo-css-parser">demo</a>.)</dd>
44    <dt id=module-whatpm-html><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>
45      <dd>An implementation of HTML5 document and fragment
46      parsing algorithms.  It can be used
47      to convert an arbitrary string into a
48      <abbr title="Document Object Model">DOM</abbr>.  (See also
49      <a href="#demo-html-parser">demo</a>.)</dd>
50    <dt id=module-whatpm-html-serializer><a href="Whatpm/HTML/Serializer.html"><code>Whatpm::HTML::Serializer</code></a></dt>
51      <dd>An implementation of HTML5 fragment serialization algorithm.
52      (See also <a href="#demo-html-parser">demo</a>.)</dd>
53    <dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>
54      <dd>An implementation of the HTML5 table algorithm.  It can be
55      used to extract a table structure from a DOM <code>table</code>
56      element node.  (See also <a href="#demo-html-table">demo</a>.)</dd>
57    <dt><a href="Whatpm/IMTChecker.html"><code>Whatpm::IMTChecker</code></a></dt>
58      <dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label
59      conformance checker.</dd>
60    <dt><a href="Whatpm/URIChecker.html"><code>Whatpm::URIChecker</code></a></dt>
61      <dd>An IRI reference conformance checker.</dd>
62    <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
63      <dd>A simple XML serializer.</dd>
64      </dl>
65    
66      <p>Note that all of these modules are <em>work in progress</em>
67      and have <a href="#todo">a number of unresolved problems</a>.</p>
68    
69      <p>Note also that some modules have no documentation for now.</p>
70      </dd>
71    <dt id=spec>Specification</dt>
72      <dd><dl>
73        <dt id=spec-ssft><a href="http://suika.fam.cx/www/markup/selectors/ssft/ssft"><abbr title="Selectors Serialization Format for Testing">SSFT</abbr>
74        Specification</a></dt>
75          <dd>The specification for the serialization format used for
76          testing Selectors-related modules.</dd>
77        <dt id=spec-manakai-selectors"><a href="http://suika.fam.cx/gate/2005/sw/manakai/Selectors%20Extensions">manakai's
78        Selectors Extensions</a></dt>
79          <dd>The specification for <code>:-manakai-<var>*</var></code>
80          pseudo-classes implemented by Selectors-related modules.</dd>
81      </dl></dd>
82    <dt>Documentations</dt>
83      <dd><dl>
84    <dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
85      <dd>Description of errors to be notified to callback functions by Whatpm
86      modules.</dd>
87        </dd>
88        <dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>
89          <dd>Description of data structure for Selectors, as implemented by
90          <a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a>
91          (as output), and
92          <a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a>
93          (as input)<!--, and
94          <a href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/SelectorsAPI.html"><code>Message::DOM::SelectorsAPI</code></a>-->.</dd>
95        </dl>
96      </dd>
97  </dl>  </dl>
98  </div>  </div>
99    
100  <div class="section" id="demo">  <div class="section" id="demo">
101  <h2>Demo</h2>  <h2>Demo</h2>
102    
103  <p><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser  <ul>
104  demo</a></p>  <li id=demo-html-parser-nanodom><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser
105    and checker demo</a>
106    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser.cgi">source</a>,
107    with <a href="Whatpm/NanoDOM.html">a lightweight non-conforming
108    DOM implementation</a>)</li>
109    <li id=demo-html-parser-manakai><a href="http://suika.fam.cx/gate/2007/html/parser-manakai-interface">HTML5
110    parser and checker demo, with manakai's DOM implementation</a>
111    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser-manakai.cgi">source</a>)</li>
112    <li id=demo-html-table><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table
113    structure visualization demo</a>
114    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/table.cgi">source</a>)</li>
115    <li id=demo-css-parser><a href="http://suika.fam.cx/gate/2007/css/parser-interface">CSS tokenizer
116    demo</a>
117    (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/css/parser.cgi">source</a>)</li>
118    </ul>
119    </div>
120    
121    <div class="section" id="dependency">
122    <h2>Dependency</h2>
123    
124    <dl>
125    <dt id=dependency-perl>Perl 5.8 or later</dt>
126      <dd>It is recommended to use newer stable release of Perl 5.8 (or
127      later).</dd>
128      <dd id=dependency-encode>Some modules require <code>Encode</code>
129      modules, which are part of standard Perl distribution.</dd>
130    <dt id=dependency-error><a href="http://search.cpan.org/author/SHLOMIF/Error-0.17009/lib/Error.pm"><code>Error</code></a></dt>
131      <dd>Module <code>Whatpm::HTML</code> requires <code>Error</code>,
132      which is bundled in
133      <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>
134    <dt><code>Message::IMT::InternetMediaType</code></dt>
135      <dd>Module <code>Whatpm::IMTChecker</code> depends on
136      <code>Message::IMT::InternetMediaType</code>, which is part of
137      <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>
138    <dt><code>Message::URI::URIReference</code></dt>
139      <dd>Modules <code>Whatpm::URIChecker</code> and
140      <code>Whatpm::CacheManifest</code> depend on
141      <a href="http://suika.fam.cx/www/manakai-core/lib/Message/URI/URIReference.html"><code>Message::URI::URIReference</code></a>,
142      which is part of
143      <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>
144    <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
145    charlib</a></dt>
146      <dd>Module <code>Whatpm::Charset::DeocdeHandle</code> depends on
147      modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
148      charlib</a> for decoding of <em>Japanese character encodings</em>.
149      See the documentation for
150      <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
151      charlib</a> for more information.</dd>
152    <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
153      <dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
154      depends on <code>Message::DOM::DOMImplementation</code> and related modules
155      in <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.
156      They are not required in practice.</dd>
157    <dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>
158      <dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and
159      <code>Whatpm::CSS::Tokenizer</code>
160      depends on <a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code> and related modules</a>.
161      They are not required in practice.</dd>
162    </dl>
163  </div>  </div>
164    
165  <div class="section" id="download">  <div class="section" id="download">
166  <h2>Distribution</h2>  <h2>Distribution</h2>
167    
 <p>Tarball will be available when setter for <code>innerHTML</code>  
 is implemented.</p>  
   
168  <p>The development version of Whatpm may be found in the  <p>The development version of Whatpm may be found in the
169  <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS  <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS
170  repository</a>.</p>  repository</a>.</p>
171    
172  </div>  </div>
173    
174    <div class="section" id="todo">
175    <h2>TO DO</h2>
176    
177    <ul>
178      <li>Bug fix (Test results:
179        <a href="t/content-type-result"><code>Whatpm::ContentType</code></a>,
180        <a href="t/tokenizer-result">HTML tokenization</a>,
181        <a href="t/tree-construction-result">HTML tree construction</a>,
182        <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
183      <li>Charset detection.</li>
184      <li>Validation for <code>meta</code>.</li>
185      <li>Validation for media queries, IRIs (against URI schemes), language tags,
186        and so on.</li>
187      <li>Documentations are missing for some features.</li>
188      <li>XML parser<!-- with application cache selection algorithm hook-->.</li>
189      <li>In addition, each module has its own TO DO items.
190        (Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>
191    </ul>
192    </div>
193    
194    <div class=section id=acknowledgments>
195    <h2>Acknowledgments</h2>
196    
197    <p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a>
198    team for their
199    <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
200    parser test data</a>.</p>
201    </div>
202    
203  <div class="section" id="author">  <div class="section" id="author">
204  <h2>Author</h2>  <h2>Author</h2>
205    
206  <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>
207  </div>  </div>
208    
209  <div class="section" id="license">  <div class="section" id="license">
210  <h2>License</h2>  <h2>License</h2>
211    
212  <p>Copyright 2007 Wakaba &lt;w@suika.fam.cx></p>  <p>Copyright 2007 Wakaba
213    <code class="mail">&lt;<a href="mailto:w@suika.fam.cx"
214        rel="author">w@suika.fam.cx</a>></code>.</p>
215    
216  <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
217  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.18
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24