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

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

Parent Directory | Revision Log | View Patch Patch

-revision 1.26 by wakaba,
Wed Sep 17 06:16:06 2008 UTC
+revision 1.33 by wakaba,
Mon Jan 12 02:36:18 2009 UTC
 Line 6 
 Technologies (beta)</title>
  <link rel="stylesheet" href="http://suika.fam.cx/www/style/html/xhtml">
  <link rel="license" href="#license">
  <link rel="author" href="#author">
+ <link rel=feed href="whatpm-commit" type="application/atom+xml"
+     title="ChangeLog diffs">
  </head>
  <body>
- <h1>Whatpm (<em>beta</em>)</h1>
+ <h1>Whatpm &mdash; Perl modules for Web hypertext application technologies
+ (<em>beta</em>)</h1>
  <div class="section" id="introduction">
  <h2>Introduction</h2>
-Line 26 
 href="#modules-html">HTML, XHTML</a>, <a
+Line 29 
 href="#modules-html">HTML, XHTML</a>, <a
  <a href="#modules-url">URL</a>.
  </div>
+ <div class=section id=news>
+ <h2>What's new?</h2>
+ <p><a href="whatpm-commit" rel=feed type="application/atom+xml">An
+ Atom feed for ChangeLog diffs</a> is available.
+ <ul>
+ <li><tiem>2009-01-12</time>: <a href="#bts">The bug tacking system</a>
+ ia available.
+ <li><time>2008-10-21</time>: <a href="#module-whatpm-xml-parser">An
+ XML parser with non-draconian error handling</a> released.
+ (Documentation is not available yet.)
+ </ul>
+ </div>
  <div class=section id=modules>
  <h2>Modules</h2>
+   <p>Note that all of these modules are <em>work in progress</em>
+   and have <a href="#todo">a number of unresolved problems</a>.</p>
+   <p>Note also that some modules have no documentation yet.
  <div class=section id=modules-html-xml>
  <h3>Modules for HTML and XML</h3>
-Line 49 
 href="#modules-html">HTML, XHTML</a>, <a
+Line 76 
 href="#modules-html">HTML, XHTML</a>, <a
    element node.  (See also <a href="#demo-html-table">demo</a>.)</dd>
  </dl>
- <p id=modules-xml>The module for <i>tentative</i> XML support is as follow:
+ <p id=modules-xml>Modules for the XML support is as follow:
  <dl>
+ <dt id=module-whatpm-xml-parser><a
+ href="Whatpm/XML/Parser.html"><code>Whatpm::XML::Parser</code></a>
+ <dd><p>An XML parser with non-draconian error handling.  It can
+ construct a DOM tree from XML 1.0/1.1 documents that does <em>not</em>
+ rely on external entities (including the external subset entity) and
+ that does <em>not</em> contain general entity reference that
+ references an entity whose replacement text contains character
+ <code>&</code> or <code>&lt;</code>.  It also supports XML namespaces.
+ <p>It does not stop the process to construct a DOM tree even if it
+ detects a well-formedness or a namespace well-formedness error.  It
+ recovers from errors in a manner similar to HTML5's tokenization
+ algorithm.  It is expected that the combination of this module and a
+ future extension to the <code>Whatpm::ContentChecker</code> framework
+ will provide a mean to detect all well-formedness and validity errors,
+ if desired.
+ <p>(See also <a href="#demo-html-parser-manakai">demo</a>.)
  <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
-   <dd>A simple XML serializer.</dd>
- </dl>
- <p><i>Real</i> XML parser and serializer are currently not available yet.
+ <dd>A simple XML serializer.  It does namespace prefix fixups and
+ suitable for the serialization of a carefully build XML DOM tree.  It
+ does not assure that the output is well-formed.
+ </dl>
  <p id=modules-cc>The module for conformance checking of a DOM tree (i.e.
- a in-memory representation of a HTML or XML document) is as follows:
+ a in-memory representation of an HTML or XML document) is as follows:
  <dl>
  <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
+ checker with a partial support for Atom 1.0.  (See also <a
-   <a href="#demo-html-parser">demo</a>.)</dd>
+ href="#demo-html-parser">demo</a> and <a
+ href="#app-webhacc">application</a>.)
  </dl>
- <p>Currently, conformance checking of HTML/XHTML and Atom documents
+ <p>For these modules, a DOM implementation that supports <a
- is supported.
+ href="http://suika.fam.cx/gate/2005/sw/manakai/DOM%20Perl%20Binding">the
+ manakai's Perl binding</a> of DOM is necessary to represent a document
+ in memory.  The <a
+ href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai-core</a>
+ package contains such an implementation,
+ <code>Message::DOM::Implementation</code><!-- @@ TODO: ref -->, but it
+ should also be possible to use any other implementation that supports
+ the binding.
  </div>
  <div class=section id=modules-css>
-Line 77 
 is supported.
+Line 140 
 is supported.
  <dl>
  <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>.)
+   computations.  (See also <a href="#demo-css-parser">demo</a>.)
+ <dt><a href="Whatpm/CSS/MediaQueryParser.pm"><code>Whatpm::CSS::MediaQueryParser</code></a>
+   <dd>A media query parser.  Note that only CSS 2.1 media types are
+ supported at the moment.
+ <dt><a href="Whatpm/CSS/MediaQuerySerializer.pm"><code>Whatpm::CSS::MediaQuerySerializer</code></a>
+   <dd>A media query serializer.  Note that only CSS 2.1 media types
+ are supported at the moment.
  <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>.)
-Line 91 
 is supported.
+Line 165 
 is supported.
  <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>
  </dl>
+ <p>For the <code>Whatpm::CSS::Parser</code> module reresenting a CSSOM
+ tree, modules in the <a
+ href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai-core</a>
+ package are used.  Those modules also provide the serializer for the
+ CSSOM tree, in the form of <a href="#howtouse">the standard
+ <code>css_text</code> CSSOM attribute</a>.
  </div>
  <div class=section id=modules-http>
-Line 130 
 yet available.
+Line 212 
 yet available.
    <dd>An
    <a href="http://www.whatwg.org/specs/web-apps/current-work/#manifests">HTML5
    cache manifest</a> parser.</dd>
+ <dt><a href="Whatpm/Charset/DecodeHandle.html"><code>Whatpm::Charset::DecodeHandle</code></a>
+   <dd>A filehandle-like wrapper <a href="#doc-handles">interface</a> to
+   decode byte stream encoded in some character encoding.
+ <dt><a href="Whatpm/Charset/UnicodeChecker.html"><code>Whatpm::Charset::UnicodeChecker</code></a>
+   <dd>A Unicode character string checker.
  <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>
-Line 137 
 yet available.
+Line 224 
 yet available.
      <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/RDFXML.html"><code>Whatpm::RDFXML</code></a>
+   <dd>An implementation of RDF/XML by which RDF triples can be extracted
+   from RDF/XML documents.
  <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.
-Line 146 
 yet available.
+Line 238 
 yet available.
  </dl>
  </div>
-   <p>Note that all of these modules are <em>work in progress</em>
-   and have <a href="#todo">a number of unresolved problems</a>.</p>
-   <p>Note also that some modules have no documentation for now.</p>
  <!-- Whatpm::ContentChecker::*, Whatpm::H2H, Whatpm::NanoDOM, and
       Whatpm::XMLParser are intentionally omitted from the list. -->
+ <div class=section id=howtouse>
+ <h3>How to use modules</h3>
+ <p><a href="#modules">Modules</a> listed above, which are included in
+ the Whatpm package, can be used by directly <code>use</code>ing or
+ <code>require</code>ing these modules and then invoking their native
+ interface.  For more information on those native interfaces, see the
+ document of those modules and the source code of them.
+ <p>In addition, some of functionality provided by those modules can be
+ accessed via standardized DOM interfaces implemented by modules
+ included in the <a
+ href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai-core</a>
+ package.  See the document of the module <a
+ href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/DOMImplementation.html"><code>Message::DOM::DOMImplementation</code></a>
+ for the way to access to the DOM interfaces.
+ <p>The table below summarizes the relationship between Whatpm modules
+ and DOM methods/attributes implemented by manakai-core modules:
+ <table>
+ <thead>
+ <tr><th scope=col>Whatpm module
+ <th scope=col>DOM methods/attributes
+ <tbody>
+ <tr><td><code>Whatpm::CSS::Cascade</code>
+ <td><code>get_computed_style</code> (<code>ViewCSS</code>),
+ <code>current_style</code> (<code>ElementCSS</code>)
+ <tr><td><code>Whatpm::CSS::Parser</code>
+ <td rowspan=2><code>CSSStyleDeclaration</code>'s attributes and methods,
+ <code>css_text</code> (CSSOM interfaces)
+ <tr><td><code>Whatpm::CSS::Serializer</code>
+ <tr><td rowspan=2><code>Whatpm::CSS::SelectorsParser</code>
+ <td><code>query_selector</code>, <code>query_selector_all</code>
+ (<code>DocumentSelector</code>, <code>ElementSelector</code>)
+ <tr><td rowspan=2><code>selector_text</code> (<code>CSSStyleRule</code>)
+ <tr><td><code>Whatpm::CSS::SelectorsSerializer</code>
+ <tr><td><code>Whatpm::HTML</code>
+ <td rowspan=4><code>inner_html</code> (<code>HTMLDocument</code>,
+ <code>Element</code>)
+ <tr><td><code>Whatpm::HTML::Serializer</code>
+ <tr><td><code>Whatpm::XML::Parser</code>
+ <tr><td><code>Whatpm::XMLSerializer</code>
+ </table>
+ </div>
  </div>
  <div class=section id=documents>
-Line 165 
 href="#modules">list of modules above</a
+Line 311 
 href="#modules">list of modules above</a
  <p>In addition, there are additional documents for some topics:
  <dl>
+ <dt><a href="http://suika.fam.cx/gate/2007/html/standards">Standards
+ supported by WebHACC</a>
+   <dd>List and description of Web standards supported by the WebHACC
+ conformance checker.  Although it is a documentation for the WebHACC,
+ it is also applicable to Whatpm in general (note that WebHACC is an
+ interactive user interface for the conformance checking feature
+ provided by Whatpm).
  <dt><a href="http://suika.fam.cx/gate/2005/sw/Whatpm%20Error%20Types">List of error types</a></dt>
  <!-- @@ TODO: Need to update the link - the document above is out of date -->
    <dd>Description of errors to be notified to callback functions by Whatpm
-Line 192 
 Specification</a></dt>
+Line 348 
 Specification</a></dt>
    <dd>The specification for the serialization format used for
    testing Selectors-related modules.</dd>
- <dt id=spec-manakai-selectors"><a href="http://suika.fam.cx/gate/2005/sw/manakai/Selectors%20Extensions">manakai's
+ <dt><a href="http://suika.fam.cx/gate/2005/sw/manakai/CSS%20Extensions">manakai's
- Selectors Extensions</a></dt>
+ CSS extensions</a>
+   <dd>The specification for <code>-manakai-<var>*</var></code> properties
+   and property values implemented by CSS-related modules.
+ <dt id=spec-manakai-selectors><a href="http://suika.fam.cx/gate/2005/sw/manakai/Selectors%20Extensions">manakai's
+ Selectors extensions</a>
    <dd>The specification for <code>:-manakai-<var>*</var></code>
    pseudo-classes implemented by Selectors-related modules.</dd>
  </dl>
-Line 202 
 Selectors Extensions</a></dt>
+Line 362 
 Selectors Extensions</a></dt>
  <div class="section" id="demo">
  <h2>Demo</h2>
- <ul>
+ <ul id=demo-html-parser>
  <li id=demo-html-parser-nanodom><a href="http://suika.fam.cx/gate/2007/html/parser-interface">HTML5 parser
  and checker demo</a>
  (<a href="http://suika.fam.cx/gate/cvs/*checkout*/webroot/gate/2007/html/parser.cgi">source</a>,
-Line 226 
 tag parsing and conformance checking dem
+Line 386 
 tag parsing and conformance checking dem
  </div>
  <div class=section id=applications>
- <h2>Application</h2>
+ <h2>Applications</h2>
  <ul>
- <li><a href="http://suika.fam.cx/gate/2007/html/cc/"><abbr>WebHACC</abbr>
- (Web hypertext application conformance checker)</a>
+ <li id=app-webhacc><a
+ href="http://suika.fam.cx/gate/2007/html/cc/"><abbr>WebHACC</abbr>
+ (Web hypertext application conformance checker)</a> (See also <a
+ href="http://suika.fam.cx/gate/2007/html/cc-about"><cite>about
+ WebHACC</cite></a>).
+ <li><a href="http://suika.fam.cx/www/webidl2tests/readme">wttjs</a>, a
+ WebIDL ECMAScript binding test suite generator.
  </ul>
+ <p>See also <a
+ href="http://suika.fam.cx/www/manakai-core/doc/web/#applications">a
+ list of applications using modules in the manakai-core package</a>;
+ some of them indirectly use Whatpm modules via DOM interfaces provided
+ by <a
+ href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai-core</a>.
  </div>
  <div class="section" id="dependency">
-Line 275 
 tag parsing and conformance checking dem
+Line 451 
 tag parsing and conformance checking dem
    <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>
+   They are not required for any practical use of those modules.
      </dl>
    </dd>
  <dt><a href="http://suika.fam.cx/www/manakai-charlib/readme">manakai
-Line 298 
 Detector</a></dt>
+Line 474 
 Detector</a></dt>
    <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>
+   They are not required for any practical use of those modules.
  </dl>
  </div>
-Line 328 
 tarball.
+Line 504 
 tarball.
        code tree.
    <li>Charset detection.</li>
    <li>Validation for <code>meta</code>.</li>
-   <li>Validation for media queries, IRIs (against URI schemes), language tags,
+   <li>Validation for media queries (level 3), IRIs (against URI schemes),
      and so on.</li>
    <li>Documentations are missing for some features.</li>
-   <li>XML parser<!-- with application cache selection algorithm hook-->.</li>
    <li>In addition, each module has its own TO DO items.
      (Search for <q>## TODO</q> and <q>## ISSUE</q> in each module.)</li>
  </ul>
+ <p id=bts>See also <a href="http://manakai.g.hatena.ne.jp/task/">the
+ bug tracking system</a>.
  </div>
  <div class=section id=acknowledgments>
-Line 355 
 parser test data</a>.</p>
+Line 534 
 parser test data</a>.</p>
  <div class="section" id="license">
  <h2>License</h2>
- <p>Copyright 2007$B!>(B2008 Wakaba
+ <p>Copyright 2007$B!>(B2009 Wakaba <code class="mail">&lt;<a
- <code class="mail">&lt;<a href="mailto:w@suika.fam.cx"
+ href="mailto:w@suika.fam.cx"
-     rel="author">w@suika.fam.cx</a>></code>.</p>
+ rel="author">w@suika.fam.cx</a>></code>.</p>
- <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
- it under the same terms as Perl itself.</p>
+ modify it under the same terms as Perl itself.
- </div>
- </body>
+ </div>
- </html>

 Legend:



Removed from v.1.26
 


changed lines


 
Added in v.1.33
 Legend:



Removed from v.1.26
 


changed lines


 
Added in v.1.33
-Removed from v.1.26
+Added in v.1.33

admin@suikawiki.org	ViewVC Help
Powered by ViewVC 1.1.24