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