/[suikacvs]/markup/html/whatpm/readme.en.html

Diff of /markup/html/whatpm/readme.en.html

Parent Directory | Revision Log | View Patch Patch

-revision 1.14 by wakaba,
Sun Nov  4 04:15:06 2007 UTC
+revision 1.25 by wakaba,
Wed Sep 17 05:48:06 2008 UTC
 Line 13 
 Technologies (beta)</title>
  <div class="section" id="introduction">
  <h2>Introduction</h2>
- <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
- Web hypertext application technologies.  It is part
+ <m>m</m>odules for <m>W</m>eb <m>h</m>ypertext <m>a</m>pplication
+ <m>t</m>echnologies.  It is part
  of the <a href="http://suika.fam.cx/www/2006/manakai/" rel=up>manakai</a>
  project.</p>
  <dl>
  <dt>Modules</dt>
  <dd><dl>
+ <dt><a href="Whatpm/CacheManifest.html"><code>Whatpm::CacheManifest</code></a></dt>
+   <dd>An
+   <a href="http://www.whatwg.org/specs/web-apps/current-work/#manifests">HTML5
+   cache manifest</a> parser.</dd>
+ <dt id=whatpm-charset-universalchardet><a href="Whatpm/Charset/UniversalCharDet.html"><code>Whatpm::Charset::UniversalCharDet</code></a></dt>
+   <dd>A Perl interface to universalchardet character encoding detection
+   library.</dd>
  <dt><a href="Whatpm/ContentChecker.html"><code>Whatpm::ContentChecker</code></a></dt>
    <dd>A DOM5 HTML (in-memory representation of a document) conformance
    checker with a partial support for Atom 1.0.  (See also
    <a href="#demo-html-parser">demo</a>.)</dd>
  <dt><a href="Whatpm/ContentType.html"><code>Whatpm::ContentType</code></a></dt>
    <dd>An implementation of HTML5 Content Type sniffing algorithm.</dd>
+   <dt><a href="Whatpm/CSS/Cascade.html"><code>Whatpm::CSS::Cascade</code></a>
+     <dd>A media-independent implementation of CSS cascading and value
+     computation.  (See also <a href="#demo-css-parser">demo</a>.)
+   <dt><a href="Whatpm/CSS/Parser.html"><code>Whatpm::CSS::Parser</code></a>
+     <dd>A CSS parser that constructs CSSOM trees from style sheets.  (See
+     also <a href="#demo-css-parser">demo</a>.)
  <dt><a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a></dt>
    <dd>A <a href="http://www.w3.org/TR/css3-selectors/#grouping">group of
    selectors</a> parser.  (See also <a href="#demo-css-parser">demo</a>.)</dd>
-Line 36 
 project.</p>
+Line 52 
 project.</p>
    and <a href="#demo-css-parser">demo</a>.)</dd>
  <dt><a href="Whatpm/CSS/Tokenizer.html"><code>Whatpm::CSS::Tokenizer</code></a></dt>
    <dd>A CSS tokenizer.  (See also <a href="#demo-css-parser">demo</a>.)</dd>
- <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>
-   <dd>An implementation of HTML5 parsing algorithm, fragment
+   <dd>An implementation of HTML5 document and fragment
-   parsing, and fragment serialization algorithms.  It can be used
+   parsing algorithms.  It can be used
-   to convert a string into DOM, or <i lang="">vice versa</i>.
+   to convert an arbitrary string into a
+   <abbr title="Document Object Model">DOM</abbr>.  (See also
+   <a href="#demo-html-parser">demo</a>.)</dd>
+ <dt id=module-whatpm-html-serializer><a href="Whatpm/HTML/Serializer.html"><code>Whatpm::HTML::Serializer</code></a></dt>
+   <dd>An implementation of HTML5 fragment serialization algorithm.
    (See also <a href="#demo-html-parser">demo</a>.)</dd>
  <dt><a href="Whatpm/HTMLTable.html"><code>Whatpm::HTMLTable</code></a></dt>
    <dd>An implementation of the HTML5 table algorithm.  It can be
-Line 48 
 project.</p>
+Line 68 
 project.</p>
  <dt><a href="Whatpm/IMTChecker.html"><code>Whatpm::IMTChecker</code></a></dt>
    <dd>An Internet Media Type (<abbr>aka</abbr> MIME type) label
    conformance checker.</dd>
  <dt><a href="Whatpm/URIChecker.html"><code>Whatpm::URIChecker</code></a></dt>
    <dd>An IRI reference conformance checker.</dd>
+ <dt><a href="Whatpm/WebIDL.html"><code>Whatpm::WebIDL</code></a></dt>
+   <dd>A WebIDL fragment parser.  It parses an IDL fragment, whether conforming
+   or not, and constructs a DOM-like object model for further processing.
+   Non-conforming (or broken) IDL fragment-like string will be parsed using
+   CSS-like error-tolerant parsing rules, e.g. ignoring anything until next
+   <code>;</code> character.
+   <dt><a href="Whatpm/LangTag.html"><code>Whatpm::LangTag</code></a>
+     <dd>A language tag parser and conformance checker, supporting both
+     older RFC 3066 definition and latest RFC 4646 definition.  (See also
+     <a href="#demo-langtag">demo</a>.)
  <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
    <dd>A simple XML serializer.</dd>
    </dl>
-Line 59 
 project.</p>
+Line 93 
 project.</p>
    <p>Note also that some modules have no documentation for now.</p>
    </dd>
- <dt id=spec>Specification</dt>
+ <dt id=spec>Specifications</dt>
    <dd><dl>
      <dt id=spec-ssft><a href="http://suika.fam.cx/www/markup/selectors/ssft/ssft"><abbr title="Selectors Serialization Format for Testing">SSFT</abbr>
      Specification</a></dt>
-Line 75 
 project.</p>
+Line 109 
 project.</p>
  <dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
    <dd>Description of errors to be notified to callback functions by Whatpm
    modules.</dd>
-     </dd>
      <dt><a href="Whatpm/CSS/selectors-object">Selectors object</a></dt>
-       <dd>Description of data structure of Selectors object as used by
+       <dd>Description of data structure for Selectors, as implemented by
        <a href="Whatpm/CSS/SelectorsParser.html"><code>Whatpm::CSS::SelectorsParser</code></a>
        (as output), and
        <a href="Whatpm/CSS/SelectorsSerializer.html"><code>Whatpm::CSS::SelectorsSerializer</code></a>
        (as input)<!--, and
        <a href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/SelectorsAPI.html"><code>Message::DOM::SelectorsAPI</code></a>-->.</dd>
+     <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>
+       <dd>List of user data names defined by Whatpm modules.</dd>
+     <dt id=doc-handles><a href="Whatpm/Charset/handles">Handle objects</a>
+       <dd>Description of character or byte stream input handle interfaces.
      </dl>
    </dd>
  </dl>
+ <!-- Whatpm::ContentChecker::*, Whatpm::H2H, Whatpm::NanoDOM, and
+      Whatpm::XMLParser are intentionally omitted from the list. -->
  </div>
  <div class="section" id="demo">
-Line 103 
 parser and checker demo, with manakai's
+Line 142 
 parser and checker demo, with manakai's
  <li id=demo-html-table><a href="http://suika.fam.cx/gate/2007/html/table-interface">HTML5 table
  structure visualization demo</a>
  (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/table.cgi">source</a>)</li>
- <li id=demo-css-parser><a href="http://suika.fam.cx/gate/2007/css/parser-interface">CSS tokenizer
- demo</a>
+ <li id=demo-css-parser><a href="http://suika.fam.cx/gate/2007/css/parser-interface">CSS
+ tokenizer, parser, and computed style computation demo</a>
  (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/css/parser.cgi">source</a>)</li>
+ <li id=demo-langtag><a href="http://suika.fam.cx/gate/2007/langtag/langtag-demo-interface">Language
+ tag parsing and conformance checking demo</a>
+ (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/langtag/langtag-demo.cgi">source</a>)
+ </ul>
+ </div>
+ <div class=section id=applications>
+ <h2>Application</h2>
+ <ul>
+ <li><a href="http://suika.fam.cx/gate/2007/html/cc/"><abbr>WebHACC</abbr>
+ (Web hypertext application conformance checker)</a>
  </ul>
  </div>
-Line 113 
 demo</a>
+Line 166 
 demo</a>
  <h2>Dependency</h2>
  <dl>
- <dt>Perl 5.8 or later</dt>
+ <dt id=dependency-perl>Perl 5.8 or later</dt>
-   <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
+   later).</dd>
+   <dd id=dependency-encode>Some modules require <code>Encode</code>
+   modules, which are part of standard Perl distribution.</dd>
+ <dt id=dependency-manakai-core>Modules from
+ <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a></dt>
+   <dd>
+     <dl>
+ <dt id=dependency-error><a href="http://search.cpan.org/author/SHLOMIF/Error-0.17009/lib/Error.pm"><code>Error</code></a></dt>
+   <dd>Module <code>Whatpm::HTML</code> requires <code>Error</code>,
+   which is bundled in
+   <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
  <dt><code>Message::IMT::InternetMediaType</code></dt>
-   <dd><code>Whatpm::IMTChecker</code> depends on
+   <dd>Module <code>Whatpm::IMTChecker</code> depends on
    <code>Message::IMT::InternetMediaType</code>, which is part of
-   <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>
  <dt><code>Message::URI::URIReference</code></dt>
-   <dd><code>Whatpm::URIChecker</code> depends on
+   <dd>Modules <code>Whatpm::URIChecker</code> and
-   <code>Message::URI::URIReference</code>, which is part of
+   <code>Whatpm::CacheManifest</code> depend on
-   <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>,
+   which is part of
+   <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
+   <dt><code>Message::Charset::Info</code></dt>
+     <dd>Module <code>Whatpm::ContentChecker</code> depends on
+     <a href="http://suika.fam.cx/www/manakai-core/lib/Message/Charset/Info.html"><code>Message::Charset::Info</code></a>,
+     which is part of
+     <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.</dd>
+ <dt><code>Message::DOM::DOMImplementation</code>
+   <dd>Module <code>Whatpm::URIChecker</code> depends on
+   <code>Message::DOM::DOMImplementation</code>,
+     which is part of
+     <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
+ <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
+   <dd><em>Testing</em> for module <code>Whatpm::ContentChecker</code>
+   depends on <code>Message::DOM::DOMImplementation</code> and related modules
+   in <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>.
+   They are not required in practice.</dd>
+     </dl>
+   </dd>
  <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
  charlib</a></dt>
-   <dd><code>Whatpm::Charset::DeocdeHandle</code> depends on
+   <dd>Module <code>Whatpm::Charset::DecodeHandle</code> depends on
    modules in <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
-   charlib</a> for <em>decoding Japanese character encodings</em>.
+   charlib</a> for decoding of <em>Japanese character encodings</em>.
    See the documentation for
    <a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
    charlib</a> for more information.</dd>
- <dt><code>Message::DOM::DOMImplementation</code> and related modules</dt>
+ <dt><a href="http://www.python.org/">Python</a>, Perl
-   <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>
-   depends on <code>Message::DOM::DOMImplementation</code> and related modules
+ module, and <a href="http://chardet.feedparser.org/">Universal Encoding
-   in <a href="http://suika.fam.cx/www/2006/manakai/">manakai</a>.
+ Detector</a></dt>
-   They are not required in practice.</dd>
+   <dd>For the module <code>Whatpm::Charset::UniversalCharDet</code> being
+   meaningful, these softwares are required on the system.  See the
+   <a href="Whatpm/Charset/UniversalCharDet.html#dependency">documentation</a>
+   for more information.</dd>
  <dt><a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code></a></dt>
-   <dd><em>Testing</em> for <code>Whatpm::HTML</code> and
+   <dd><em>Testing</em> for modules <code>Whatpm::HTML</code> and
    <code>Whatpm::CSS::Tokenizer</code>
    depends on <a href="http://search.cpan.org/~makamaka/JSON-1.14/"><code>JSON</code> and related modules</a>.
    They are not required in practice.</dd>
-Line 151 
 charlib</a></dt>
+Line 237 
 charlib</a></dt>
  <a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/">CVS
  repository</a>.</p>
+ <p><a href="http://suika.fam.cx/gate/cvs/markup/html/whatpm/whatpm.tar.gz?tarball=1">The
+ latest developmenet version of the Whatpm</a> is also available as a
+ tarball.
  </div>
  <div class="section" id="todo">
-Line 162 
 repository</a>.</p>
+Line 252 
 repository</a>.</p>
      <a href="t/tokenizer-result">HTML tokenization</a>,
      <a href="t/tree-construction-result">HTML tree construction</a>,
      <a href="t/content-checker-result"><code>Whatpm::ContentChecker</code></a>).</li>
+   <li>Merge with the <a href="http://suika.fam.cx/www/2006/manakai/">manakai-core</a>
+       code tree.
    <li>Charset detection.</li>
    <li>Validation for <code>meta</code>.</li>
    <li>Validation for media queries, IRIs (against URI schemes), language tags,
-Line 177 
 repository</a>.</p>
+Line 269 
 repository</a>.</p>
  <h2>Acknowledgments</h2>
  <p>Thanks to the <a href="http://code.google.com/p/html5lib/">html5lib</a>
- team for <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
+ team for their
+ <a href="http://html5lib.googlecode.com/svn/trunk/testdata/">HTML5
  parser test data</a>.</p>
  </div>
-Line 190 
 parser test data</a>.</p>
+Line 283 
 parser test data</a>.</p>
  <div class="section" id="license">
  <h2>License</h2>
- <p>Copyright 2007 Wakaba
+ <p>Copyright 2007$B!>(B2008 Wakaba
  <code class="mail">&lt;<a href="mailto:w@suika.fam.cx"
      rel="author">w@suika.fam.cx</a>></code>.</p>

 Legend:



Removed from v.1.14
 


changed lines


 
Added in v.1.25
 Legend:



Removed from v.1.14
 


changed lines


 
Added in v.1.25
-Removed from v.1.14
+Added in v.1.25

admin@suikawiki.org	ViewVC Help
Powered by ViewVC 1.1.24