/[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.7 by wakaba, Sat Aug 25 03:04:24 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>, part of
17    <a href="http://suika.fam.cx/www/2006/manakai/" rel=up>manakai</a>,
18    is a <em>work-in-progress</em> set of Perl modules for
19  Web hypertext application technologies.</p>  Web hypertext application technologies.</p>
20    
 <p>It currently contains two Perl modules:</p>  
   
21  <dl>  <dl>
22    <dt><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt>
23      <dd>A DOM5 HTML (in-memory representation of a document) conformance
24      checker.</dd>
25  <dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>  <dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>
26    <dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>    <dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>
27  <dt><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>  <dt><a href="Whatpm/HTML.html"><code>Whatpm::HTML</code></a></dt>
28    <dd>An implementation of HTML5 parsing algorithm and    <dd>An implementation of HTML5 parsing algorithm and
29    <code>innerHTML</code> serialization.</dd>    <code>innerHTML</code> serialization.</dd>
30    <dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>
31      <dd>An implementation of the HTML5 table algorithm.</dd>
32    <dt><a href="Whatpm/IMTChecker.html"><code>Whatpm::IMTChecker</code></a></dt>
33      <dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label
34      conformance checker.</dd>
35    <dt><a href="Whatpm/URIChecker.html"><code>Whatpm::URIChecker</code></a></dt>
36      <dd>An IRI reference conformance checker.</dd>
37    <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
38      <dd>A simple XML serializer.</dd>
39    <dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
40  </dl>  </dl>
41    
42    <p>Note that all of these modules are <em>work in progress</em>
43    and have <a href="#todo">a number of unresolved problems</a>.</p>
44  </div>  </div>
45    
46  <div class="section" id="demo">  <div class="section" id="demo">
47  <h2>Demo</h2>  <h2>Demo</h2>
48    
49  <p><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser  <ul>
50  demo</a></p>  <li><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser
51    and checker demo</a></li>
52    <li><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table
53    structure visualization demo</a></li>
54    </ul>
55    </div>
56    
57    <div class="section" id="dependency">
58    <h2>Dependency</h2>
59    
60    <dl>
61    <dt>Perl 5.8 or later</dt>
62      <dd>It is recommended to use newer release of Perl 5.8 or later.</dd>
63    <dt><code>Message::IMT::InternetMediaType</code></dt>
64      <dd><code>Whatpm::IMTChecker</code> depends on
65      <code>Message::IMT::InternetMediaType</code>, which is part of
66      <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>
67    <dt><code>Message::URI::URIReference</code></dt>
68      <dd><code>Whatpm::URIChecker</code> depends on
69      <code>Message::URI::URIReference</code>, which is part of
70      <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.</dd>
71    <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
72    charlib</a></dt>
73      <dd><code>Whatpm::Charset::DeocdeHandle</code> depends on
74      modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
75      charlib</a> for <em>decoding Japanese character encodings</em>.
76      See the documentation for
77      <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
78      charlib</a> for more information.</dd>
79    <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
80      <dd><em>Testing</em> for <code>Whatpm::ContentChecker</code>
81      depends on <code>Message::DOM::DOMImplementation</code> and related modules
82      in <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.
83      They are not required in practice.</dd>
84    <dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>
85      <dd><em>Testing</em> for <code>Whatpm::HTML</code>
86      depends on <a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code> and related modules</a>.
87      They are not required in practice.</dd>
88    </dl>
89  </div>  </div>
90    
91  <div class="section" id="download">  <div class="section" id="download">
92  <h2>Distribution</h2>  <h2>Distribution</h2>
93    
 <p>Tarball will be available when setter for <code>innerHTML</code>  
 is implemented.</p>  
   
94  <p>The development version of Whatpm may be found in the  <p>The development version of Whatpm may be found in the
95  <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS  <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS
96  repository</a>.</p>  repository</a>.</p>
97    
98  </div>  </div>
99    
100    <div class="section" id="todo">
101    <h2>TO DO</h2>
102    
103    <ul>
104      <li>Bug fix (Test results:
105        <a href="t/content-type-result"><code>Whatpm::ContentType</code></a>,
106        <a href="t/tokenizer-result">HTML tokenization</a>,
107        <a href="t/tree-construction-result">HTML tree construction</a>,
108        <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
109      <li>Charset detection.</li>
110      <li>Validation for <code>meta</code>.</li>
111      <li>Validation for media queries, IRIs (against URI schemes), language tags,
112        and so on.</li>
113      <li>Documentations are missing for some features.</li>
114      <li><q>Whatpm</q> is a code name in fact.  Please let me know
115        if you have a better name.</li>
116      <li>In addition, each module has its own TO DO items.
117        (Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>
118    </ul>
119    </div>
120    
121    <div class=section id=acknowledgments>
122    <h2>Acknowledgments</h2>
123    
124    <p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a>
125    team for <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
126    parser test data</a>.</p>
127    </div>
128    
129  <div class="section" id="author">  <div class="section" id="author">
130  <h2>Author</h2>  <h2>Author</h2>
131    
132  <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>
133  </div>  </div>
134    
135  <div class="section" id="license">  <div class="section" id="license">
136  <h2>License</h2>  <h2>License</h2>
137    
138  <p>Copyright 2007 Wakaba &lt;w@suika.fam.cx></p>  <p>Copyright 2007 Wakaba
139    <code class="mail">&lt;<a href="mailto:w@suika.fam.cx"
140        rel="author">w@suika.fam.cx</a>></code>.</p>
141    
142  <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
143  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.7

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24