/[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.6 by wakaba, Sun Jul 29 05:20:12 2007 UTC revision 1.18 by wakaba, Sun Nov 18 04:26:50 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>, a subproject of  <p><dfn>Whatpm</dfn> is a <em>work-in-progress</em> set of <m>P</m>erl
17  <a href="http://suika.fam.cx/www/2006/manakai/" rel=up>manakai</a>,  <m>m</m>odules for <m>W</m>eb <m>h</m>ypertext <m>a</m>pplication
18  is a <em>work-in-progress</em> set of Perl modules for  <m>t</m>echnologies.  It is part
19  Web hypertext application technologies.</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>  <dt><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt>
30    <dd>A DOM5 HTML (in-memory representation of a document) conformance    <dd>A DOM5 HTML (in-memory representation of a document) conformance
31    checker.</dd>    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>  <dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>
54    <dd>An implementation of the HTML5 table algorithm.</dd>    <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>  <dt><a href="Whatpm/IMTChecker.html"><code>Whatpm::IMTChecker</code></a></dt>
58    <dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label    <dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label
59    conformance checker.</dd>    conformance checker.</dd>
# Line 36  Web hypertext application technologies.< Line 61  Web hypertext application technologies.<
61    <dd>An IRI reference conformance checker.</dd>    <dd>An IRI reference conformance checker.</dd>
62  <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>  <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
63    <dd>A simple XML serializer.</dd>    <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>  <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>
   
 <p>Note that all of these modules are <em>work in progress</em>  
 and have <a href="#todo">a number of unresolved problems</a>.</p>  
98  </div>  </div>
99    
100  <div class="section" id="demo">  <div class="section" id="demo">
101  <h2>Demo</h2>  <h2>Demo</h2>
102    
103  <ul>  <ul>
104  <li><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser  <li id=demo-html-parser-nanodom><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser
105  and checker demo</a></li>  and checker demo</a>
106  <li><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table  (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser.cgi">source</a>,
107  structure visualization demo</a></li>  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>  </ul>
119  </div>  </div>
120    
# Line 58  structure visualization demo</a></li> Line 122  structure visualization demo</a></li>
122  <h2>Dependency</h2>  <h2>Dependency</h2>
123    
124  <dl>  <dl>
125  <dt>Perl 5.8 or later</dt>  <dt id=dependency-perl>Perl 5.8 or later</dt>
126    <dd>It is recommended to use newer release of Perl 5.8 or later.</dd>    <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>  <dt><code>Message::IMT::InternetMediaType</code></dt>
135    <dd><code>Whatpm::IMTChecker</code> depends on    <dd>Module <code>Whatpm::IMTChecker</code> depends on
136    <code>Message::IMT::InternetMediaType</code>, which is part of    <code>Message::IMT::InternetMediaType</code>, which is part of
137    <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>    <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>
138  <dt><code>Message::URI::URIReference</code></dt>  <dt><code>Message::URI::URIReference</code></dt>
139    <dd><code>Whatpm::URIChecker</code> depends on    <dd>Modules <code>Whatpm::URIChecker</code> and
140    <code>Message::URI::URIReference</code>, which is part of    <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>    <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  <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
145  charlib</a></dt>  charlib</a></dt>
146    <dd><code>Whatpm::Charset::DeocdeHandle</code> depends on    <dd>Module <code>Whatpm::Charset::DeocdeHandle</code> depends on
147    modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai    modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
148    charlib</a> for <em>decoding Japanese character encodings</em>.    charlib</a> for decoding of <em>Japanese character encodings</em>.
149    See the documentation for    See the documentation for
150    <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai    <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
151    charlib</a> for more information.</dd>    charlib</a> for more information.</dd>
152  <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>  <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
153    <dd><em>Testing</em> for <code>Whatpm::ContentChecker</code>    <dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
154    depends on <code>Message::DOM::DOMImplementation</code> and related modules    depends on <code>Message::DOM::DOMImplementation</code> and related modules
155    in <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.    in <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.
156    They are not required in practice.</dd>    They are not required in practice.</dd>
157  <dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>  <dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>
158    <dd><em>Testing</em> for <code>Whatpm::HTML</code>    <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>.    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>    They are not required in practice.</dd>
162  </dl>  </dl>
# Line 111  repository</a>.</p> Line 185  repository</a>.</p>
185    <li>Validation for media queries, IRIs (against URI schemes), language tags,    <li>Validation for media queries, IRIs (against URI schemes), language tags,
186      and so on.</li>      and so on.</li>
187    <li>Documentations are missing for some features.</li>    <li>Documentations are missing for some features.</li>
188    <li><q>Whatpm</q> is a code name in fact.  Please let me know    <li>XML parser<!-- with application cache selection algorithm hook-->.</li>
     if you have a better name.</li>  
189    <li>In addition, each module has its own TO DO items.    <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>      (Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>
191  </ul>  </ul>
192  </div>  </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    
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.18
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24