/[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.14 by wakaba, Sun Nov 4 04:15:06 2007 UTC revision 1.21 by wakaba, Fri Nov 23 07:35:02 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 <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 75  project.</p> Line 87  project.</p>
87  <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>
88    <dd>Description of errors to be notified to callback functions by Whatpm    <dd>Description of errors to be notified to callback functions by Whatpm
89    modules.</dd>    modules.</dd>
     </dd>  
90      <dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>      <dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>
91        <dd>Description of data structure of Selectors object as used by        <dd>Description of data structure for Selectors, as implemented by
92        <a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a>        <a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a>
93        (as output), and        (as output), and
94        <a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a>        <a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a>
95        (as input)<!--, and        (as input)<!--, and
96        <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>
97        <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>
98          <dd>List of user data names defined by Whatpm modules.</dd>
99      </dl>      </dl>
100    </dd>    </dd>
101  </dl>  </dl>
# Line 113  demo</a> Line 126  demo</a>
126  <h2>Dependency</h2>  <h2>Dependency</h2>
127    
128  <dl>  <dl>
129  <dt>Perl 5.8 or later</dt>  <dt id=dependency-perl>Perl 5.8 or later</dt>
130    <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
131      later).</dd>
132      <dd id=dependency-encode>Some modules require <code>Encode</code>
133      modules, which are part of standard Perl distribution.</dd>
134    <dt id=dependency-manakai-core>Modules from
135    <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a></dt>
136      <dd>
137        <dl>
138    <dt id=dependency-error><a href="http://search.cpan.org/author/SHLOMIF/Error-0.17009/lib/Error.pm"><code>Error</code></a></dt>
139      <dd>Module <code>Whatpm::HTML</code> requires <code>Error</code>,
140      which is bundled in
141      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
142  <dt><code>Message::IMT::InternetMediaType</code></dt>  <dt><code>Message::IMT::InternetMediaType</code></dt>
143    <dd><code>Whatpm::IMTChecker</code> depends on    <dd>Module <code>Whatpm::IMTChecker</code> depends on
144    <code>Message::IMT::InternetMediaType</code>, which is part of    <code>Message::IMT::InternetMediaType</code>, which is part of
145    <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>
146  <dt><code>Message::URI::URIReference</code></dt>  <dt><code>Message::URI::URIReference</code></dt>
147    <dd><code>Whatpm::URIChecker</code> depends on    <dd>Modules <code>Whatpm::URIChecker</code> and
148    <code>Message::URI::URIReference</code>, which is part of    <code>Whatpm::CacheManifest</code> depend on
149    <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>,
150      which is part of
151      <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
152      <dt><code>Message::Charset::Info</code></dt>
153        <dd>Module <code>Whatpm::ContentChecker</code> depends on
154        <a href="http://suika.fam.cx/www/manakai-core/lib/Message/Charset/Info.html"><code>Message::Charset::Info</code></a>,
155        which is part of
156        <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
157    <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
158      <dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
159      depends on <code>Message::DOM::DOMImplementation</code> and related modules
160      in <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
161      They are not required in practice.</dd>
162        </dl>
163      </dd>
164  <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai  <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
165  charlib</a></dt>  charlib</a></dt>
166    <dd><code>Whatpm::Charset::DeocdeHandle</code> depends on    <dd>Module <code>Whatpm::Charset::DecodeHandle</code> depends on
167    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
168    charlib</a> for <em>decoding Japanese character encodings</em>.    charlib</a> for decoding of <em>Japanese character encodings</em>.
169    See the documentation for    See the documentation for
170    <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai    <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
171    charlib</a> for more information.</dd>    charlib</a> for more information.</dd>
172  <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>  <dt><a href="http://www.python.org/">Python</a>, Perl
173    <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>
174    depends on <code>Message::DOM::DOMImplementation</code> and related modules  module, and <a href="http://chardet.feedparser.org/">Universal Encoding
175    in <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.  Detector</a></dt>
176    They are not required in practice.</dd>    <dd>For the module <code>Whatpm::Charset::UniversalCharDet</code> being
177      meaningful, these softwares are requires on the system.  See the
178      <a href="Whatpm/Charset/UniversalCharDet.html#dependency">documentation</a>
179      for more information.</dd>
180  <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>
181    <dd><em>Testing</em> for <code>Whatpm::HTML</code> and    <dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and
182    <code>Whatpm::CSS::Tokenizer</code>    <code>Whatpm::CSS::Tokenizer</code>
183    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>.
184    They are not required in practice.</dd>    They are not required in practice.</dd>
# Line 177  repository</a>.</p> Line 218  repository</a>.</p>
218  <h2>Acknowledgments</h2>  <h2>Acknowledgments</h2>
219    
220  <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>
221  team for <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5  team for their
222    <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
223  parser test data</a>.</p>  parser test data</a>.</p>
224  </div>  </div>
225    
Legend:
Removed from v.1.14  
changed lines
  Added in v.1.21
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24