/[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.13 by wakaba, Wed Oct 17 12:04:54 2007 UTC revision 1.23 by wakaba, Sat Aug 30 04:31:57 2008 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 <em>work-in-progress</em> 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.  It is part  <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  of the <a href="http://suika.fam.cx/www/2006/manakai/" rel=up>manakai</a>  of the <a href="http://suika.fam.cx/www/2006/manakai/" rel=up>manakai</a>
20  project.</p>  project.</p>
21    
22  <dl>  <dl>
23  <dt>Modules</dt>  <dt>Modules</dt>
24  <dd><dl>  <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 id=whatpm-charset-universalchardet><a href="Whatpm/Charset/UniversalCharDet.html"><code>Whatpm::Charset::UniversalCharDet</code></a></dt>
30      <dd>A Perl interface to universalchardet character encoding detection
31      library.</dd>
32  <dt><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt>  <dt><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt>
33    <dd>A DOM5 HTML (in-memory representation of a document) conformance    <dd>A DOM5 HTML (in-memory representation of a document) conformance
34    checker with a partial support for Atom 1.0.  (See also    checker with a partial support for Atom 1.0.  (See also
# Line 36  project.</p> Line 44  project.</p>
44    and <a href="#demo-css-parser">demo</a>.)</dd>    and <a href="#demo-css-parser">demo</a>.)</dd>
45  <dt><a href="Whatpm/CSS/Tokenizer.html"><code>Whatpm::CSS::Tokenizer</code></a></dt>  <dt><a href="Whatpm/CSS/Tokenizer.html"><code>Whatpm::CSS::Tokenizer</code></a></dt>
46    <dd>A CSS tokenizer.  (See also <a href="#demo-css-parser">demo</a>.)</dd>    <dd>A CSS tokenizer.  (See also <a href="#demo-css-parser">demo</a>.)</dd>
47  <dt><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>  <dt id=module-whatpm-html><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>
48    <dd>An implementation of HTML5 parsing algorithm, fragment    <dd>An implementation of HTML5 document and fragment
49    parsing, and fragment serialization algorithms.  It can be used    parsing algorithms.  It can be used
50    to convert a string into DOM, or <i lang="">vice versa</i>.    to convert an arbitrary string into a
51      <abbr title="Document Object Model">DOM</abbr>.  (See also
52      <a href="#demo-html-parser">demo</a>.)</dd>
53    <dt id=module-whatpm-html-serializer><a href="Whatpm/HTML/Serializer.html"><code>Whatpm::HTML::Serializer</code></a></dt>
54      <dd>An implementation of HTML5 fragment serialization algorithm.
55    (See also <a href="#demo-html-parser">demo</a>.)</dd>    (See also <a href="#demo-html-parser">demo</a>.)</dd>
56  <dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>  <dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>
57    <dd>An implementation of the HTML5 table algorithm.  It can be    <dd>An implementation of the HTML5 table algorithm.  It can be
# Line 50  project.</p> Line 62  project.</p>
62    conformance checker.</dd>    conformance checker.</dd>
63  <dt><a href="Whatpm/URIChecker.html"><code>Whatpm::URIChecker</code></a></dt>  <dt><a href="Whatpm/URIChecker.html"><code>Whatpm::URIChecker</code></a></dt>
64    <dd>An IRI reference conformance checker.</dd>    <dd>An IRI reference conformance checker.</dd>
65    
66    <dt><a href="Whatpm/WebIDL.html"><code>Whatpm::WebIDL</code></a></dt>
67      <dd>A WebIDL fragment parser.  It parses an IDL fragment, whether conforming
68      or not, and constructs a DOM-like object model for further processing.
69      Non-conforming (or broken) IDL fragment-like string will be parsed using
70      CSS-like error-tolerant parsing rules, e.g. ignoring anything until next
71      <code>;</code> character.
72    
73  <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>  <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
74    <dd>A simple XML serializer.</dd>    <dd>A simple XML serializer.</dd>
75    </dl>    </dl>
# Line 59  project.</p> Line 79  project.</p>
79    
80    <p>Note also that some modules have no documentation for now.</p>    <p>Note also that some modules have no documentation for now.</p>
81    </dd>    </dd>
82  <dt id=spec>Specification</dt>  <dt id=spec>Specifications</dt>
83    <dd><dl>    <dd><dl>
84      <dt id=spec-ssft><a href="http://suika.fam.cx/www/markup/selectors/ssft/ssft"><abbr title="Selectors Serialization Format for Testing">SSFT</abbr>      <dt id=spec-ssft><a href="http://suika.fam.cx/www/markup/selectors/ssft/ssft"><abbr title="Selectors Serialization Format for Testing">SSFT</abbr>
85      Specification</a></dt>      Specification</a></dt>
# Line 75  project.</p> Line 95  project.</p>
95  <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>
96    <dd>Description of errors to be notified to callback functions by Whatpm    <dd>Description of errors to be notified to callback functions by Whatpm
97    modules.</dd>    modules.</dd>
     </dd>  
98      <dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>      <dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>
99        <dd>Description of data structure of Selectors object as used by        <dd>Description of data structure for Selectors, as implemented by
100        <a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a>        <a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a>
101        (as output), and        (as output), and
102        <a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a>        <a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a>
103        (as input)<!--, and        (as input)<!--, and
104        <a href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/SelectorsAPI.html"><code>Message::DOM::SelectorsAPI</code></a>-->.</dd>        <a href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/SelectorsAPI.html"><code>Message::DOM::SelectorsAPI</code></a>-->.</dd>
105        <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>
106          <dd>List of user data names defined by Whatpm modules.</dd>
107      </dl>      </dl>
108    </dd>    </dd>
109  </dl>  </dl>
# Line 113  demo</a> Line 134  demo</a>
134  <h2>Dependency</h2>  <h2>Dependency</h2>
135    
136  <dl>  <dl>
137  <dt>Perl 5.8 or later</dt>  <dt id=dependency-perl>Perl 5.8 or later</dt>
138    <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
139      later).</dd>
140      <dd id=dependency-encode>Some modules require <code>Encode</code>
141      modules, which are part of standard Perl distribution.</dd>
142    <dt id=dependency-manakai-core>Modules from
143    <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a></dt>
144      <dd>
145        <dl>
146    <dt id=dependency-error><a href="http://search.cpan.org/author/SHLOMIF/Error-0.17009/lib/Error.pm"><code>Error</code></a></dt>
147      <dd>Module <code>Whatpm::HTML</code> requires <code>Error</code>,
148      which is bundled in
149      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
150  <dt><code>Message::IMT::InternetMediaType</code></dt>  <dt><code>Message::IMT::InternetMediaType</code></dt>
151    <dd><code>Whatpm::IMTChecker</code> depends on    <dd>Module <code>Whatpm::IMTChecker</code> depends on
152    <code>Message::IMT::InternetMediaType</code>, which is part of    <code>Message::IMT::InternetMediaType</code>, which is part of
153    <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>    <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
154  <dt><code>Message::URI::URIReference</code></dt>  <dt><code>Message::URI::URIReference</code></dt>
155    <dd><code>Whatpm::URIChecker</code> depends on    <dd>Modules <code>Whatpm::URIChecker</code> and
156    <code>Message::URI::URIReference</code>, which is part of    <code>Whatpm::CacheManifest</code> depend on
157    <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>    <a href="http://suika.fam.cx/www/manakai-core/lib/Message/URI/URIReference.html"><code>Message::URI::URIReference</code></a>,
158      which is part of
159      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
160      <dt><code>Message::Charset::Info</code></dt>
161        <dd>Module <code>Whatpm::ContentChecker</code> depends on
162        <a href="http://suika.fam.cx/www/manakai-core/lib/Message/Charset/Info.html"><code>Message::Charset::Info</code></a>,
163        which is part of
164        <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
165    <dt><code>Message::DOM::DOMImplementation</code>
166      <dd>Module <code>Whatpm::URIChecker</code> depends on
167      <code>Message::DOM::DOMImplementation</code>,
168        which is part of
169        <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
170    <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
171      <dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
172      depends on <code>Message::DOM::DOMImplementation</code> and related modules
173      in <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
174      They are not required in practice.</dd>
175        </dl>
176      </dd>
177  <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai  <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
178  charlib</a></dt>  charlib</a></dt>
179    <dd><code>Whatpm::Charset::DeocdeHandle</code> depends on    <dd>Module <code>Whatpm::Charset::DecodeHandle</code> depends on
180    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
181    charlib</a> for <em>decoding Japanese character encodings</em>.    charlib</a> for decoding of <em>Japanese character encodings</em>.
182    See the documentation for    See the documentation for
183    <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai    <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
184    charlib</a> for more information.</dd>    charlib</a> for more information.</dd>
185  <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>  <dt><a href="http://www.python.org/">Python</a>, Perl
186    <dd><em>Testing</em> for <code>Whatpm::ContentChecker</code>  <a href="http://search.cpan.org/~neilw/Inline-Python-0.22/"><code>Inline::Python</code></a>
187    depends on <code>Message::DOM::DOMImplementation</code> and related modules  module, and <a href="http://chardet.feedparser.org/">Universal Encoding
188    in <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.  Detector</a></dt>
189    They are not required in practice.</dd>    <dd>For the module <code>Whatpm::Charset::UniversalCharDet</code> being
190      meaningful, these softwares are requires on the system.  See the
191      <a href="Whatpm/Charset/UniversalCharDet.html#dependency">documentation</a>
192      for more information.</dd>
193  <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>
194    <dd><em>Testing</em> for <code>Whatpm::HTML</code> and    <dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and
195    <code>Whatpm::CSS::Tokenizer</code>    <code>Whatpm::CSS::Tokenizer</code>
196    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>.
197    They are not required in practice.</dd>    They are not required in practice.</dd>
# Line 162  repository</a>.</p> Line 216  repository</a>.</p>
216      <a href="t/tokenizer-result">HTML tokenization</a>,      <a href="t/tokenizer-result">HTML tokenization</a>,
217      <a href="t/tree-construction-result">HTML tree construction</a>,      <a href="t/tree-construction-result">HTML tree construction</a>,
218      <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>      <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
219      <li>Merge with the <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>
220          code tree.
221    <li>Charset detection.</li>    <li>Charset detection.</li>
222    <li>Validation for <code>meta</code>.</li>    <li>Validation for <code>meta</code>.</li>
223    <li>Validation for media queries, IRIs (against URI schemes), language tags,    <li>Validation for media queries, IRIs (against URI schemes), language tags,
224      and so on.</li>      and so on.</li>
225    <li>Documentations are missing for some features.</li>    <li>Documentations are missing for some features.</li>
226    <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>  
227    <li>In addition, each module has its own TO DO items.    <li>In addition, each module has its own TO DO items.
228      (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>
229  </ul>  </ul>
# Line 178  repository</a>.</p> Line 233  repository</a>.</p>
233  <h2>Acknowledgments</h2>  <h2>Acknowledgments</h2>
234    
235  <p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a>  <p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a>
236  team for <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5  team for their
237    <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
238  parser test data</a>.</p>  parser test data</a>.</p>
239  </div>  </div>
240    
# Line 191  parser test data</a>.</p> Line 247  parser test data</a>.</p>
247  <div class="section" id="license">  <div class="section" id="license">
248  <h2>License</h2>  <h2>License</h2>
249    
250  <p>Copyright 2007 Wakaba  <p>Copyright 2007$B!>(B2008 Wakaba
251  <code class="mail">&lt;<a href="mailto:w@suika.fam.cx"  <code class="mail">&lt;<a href="mailto:w@suika.fam.cx"
252      rel="author">w@suika.fam.cx</a>></code>.</p>      rel="author">w@suika.fam.cx</a>></code>.</p>
253    
Legend:
Removed from v.1.13  
changed lines
  Added in v.1.23
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24