/[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.29 by wakaba, Sun Oct 5 06:42:04 2008 UTC revision 1.33 by wakaba, Mon Jan 12 02:36:18 2009 UTC
# Line 6  Technologies (beta)</title> Line 6  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    <link rel=feed href="whatpm-commit" type="application/atom+xml"
10        title="ChangeLog diffs">
11  </head>  </head>
12  <body>  <body>
13  <h1>Whatpm &mdash; Perl modules for Web hypertext application technologies  <h1>Whatpm &mdash; Perl modules for Web hypertext application technologies
# Line 27  href="#modules-html">HTML, XHTML</a>, <a Line 29  href="#modules-html">HTML, XHTML</a>, <a
29  <a href="#modules-url">URL</a>.  <a href="#modules-url">URL</a>.
30  </div>  </div>
31    
32    <div class=section id=news>
33    <h2>What's new?</h2>
34    
35    <p><a href="whatpm-commit" rel=feed type="application/atom+xml">An
36    Atom feed for ChangeLog diffs</a> is available.
37    
38    <ul>
39    
40    <li><tiem>2009-01-12</time>: <a href="#bts">The bug tacking system</a>
41    ia available.
42    
43    <li><time>2008-10-21</time>: <a href="#module-whatpm-xml-parser">An
44    XML parser with non-draconian error handling</a> released.
45    (Documentation is not available yet.)
46    
47    </ul>
48    
49    </div>
50    
51  <div class=section id=modules>  <div class=section id=modules>
52  <h2>Modules</h2>  <h2>Modules</h2>
53    
54    <p>Note that all of these modules are <em>work in progress</em>    <p>Note that all of these modules are <em>work in progress</em>
55    and have <a href="#todo">a number of unresolved problems</a>.</p>    and have <a href="#todo">a number of unresolved problems</a>.</p>
56    
57    <p>Note also that some modules have no documentation for now.</p>    <p>Note also that some modules have no documentation yet.
58    
59  <div class=section id=modules-html-xml>  <div class=section id=modules-html-xml>
60  <h3>Modules for HTML and XML</h3>  <h3>Modules for HTML and XML</h3>
# Line 55  href="#modules-html">HTML, XHTML</a>, <a Line 76  href="#modules-html">HTML, XHTML</a>, <a
76    element node.  (See also <a href="#demo-html-table">demo</a>.)</dd>    element node.  (See also <a href="#demo-html-table">demo</a>.)</dd>
77  </dl>  </dl>
78    
79  <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:
80    
81  <dl>  <dl>
82    
83    <dt id=module-whatpm-xml-parser><a
84    href="Whatpm/XML/Parser.html"><code>Whatpm::XML::Parser</code></a>
85    
86    <dd><p>An XML parser with non-draconian error handling.  It can
87    construct a DOM tree from XML 1.0/1.1 documents that does <em>not</em>
88    rely on external entities (including the external subset entity) and
89    that does <em>not</em> contain general entity reference that
90    references an entity whose replacement text contains character
91    <code>&</code> or <code>&lt;</code>.  It also supports XML namespaces.
92    
93    <p>It does not stop the process to construct a DOM tree even if it
94    detects a well-formedness or a namespace well-formedness error.  It
95    recovers from errors in a manner similar to HTML5's tokenization
96    algorithm.  It is expected that the combination of this module and a
97    future extension to the <code>Whatpm::ContentChecker</code> framework
98    will provide a mean to detect all well-formedness and validity errors,
99    if desired.
100    
101    <p>(See also <a href="#demo-html-parser-manakai">demo</a>.)
102    
103  <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>  <dt><a href="Whatpm/XMLSerializer.html"><code>Whatpm::XMLSerializer</code></a></dt>
   <dd>A simple XML serializer.</dd>  
 </dl>  
104    
105  <p><i>Real</i> XML parser and serializer are currently not available yet.  <dd>A simple XML serializer.  It does namespace prefix fixups and
106    suitable for the serialization of a carefully build XML DOM tree.  It
107    does not assure that the output is well-formed.
108    
109    </dl>
110    
111  <p id=modules-cc>The module for conformance checking of a DOM tree (i.e.  <p id=modules-cc>The module for conformance checking of a DOM tree (i.e.
112  a in-memory representation of an HTML or XML document) is as follows:  a in-memory representation of an HTML or XML document) is as follows:
# Line 76  href="#app-webhacc">application</a>.) Line 121  href="#app-webhacc">application</a>.)
121    
122  </dl>  </dl>
123    
124  <p>Currently, conformance checking of HTML/XHTML and Atom documents  <p>For these modules, a DOM implementation that supports <a
125  is supported.  href="http://suika.fam.cx/gate/2005/sw/manakai/DOM%20Perl%20Binding">the
126    manakai's Perl binding</a> of DOM is necessary to represent a document
127  <p>For these modules, a DOM implementation that supports the manakai's  in memory.  The <a
 Perl binding<!-- @@ TODO: ref --> of DOM is necessary to represent a  
 document in memory.  The <a  
128  href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai-core</a>  href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai-core</a>
129  package contains such an implementation,  package contains such an implementation,
130  <code>Message::DOM::Implementation</code><!-- @@ TODO: ref -->, but it  <code>Message::DOM::Implementation</code><!-- @@ TODO: ref -->, but it
# Line 127  are supported at the moment. Line 170  are supported at the moment.
170  tree, modules in the <a  tree, modules in the <a
171  href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai-core</a>  href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai-core</a>
172  package are used.  Those modules also provide the serializer for the  package are used.  Those modules also provide the serializer for the
173  CSSOM tree, in the form of the standard <code>css_text</code> CSSOM  CSSOM tree, in the form of <a href="#howtouse">the standard
174  attribute.  <code>css_text</code> CSSOM attribute</a>.
175    
176  </div>  </div>
177    
# Line 197  yet available. Line 240  yet available.
240    
241  <!-- Whatpm::ContentChecker::*, Whatpm::H2H, Whatpm::NanoDOM, and  <!-- Whatpm::ContentChecker::*, Whatpm::H2H, Whatpm::NanoDOM, and
242       Whatpm::XMLParser are intentionally omitted from the list. -->       Whatpm::XMLParser are intentionally omitted from the list. -->
243    
244    <div class=section id=howtouse>
245    <h3>How to use modules</h3>
246    
247    <p><a href="#modules">Modules</a> listed above, which are included in
248    the Whatpm package, can be used by directly <code>use</code>ing or
249    <code>require</code>ing these modules and then invoking their native
250    interface.  For more information on those native interfaces, see the
251    document of those modules and the source code of them.
252    
253    <p>In addition, some of functionality provided by those modules can be
254    accessed via standardized DOM interfaces implemented by modules
255    included in the <a
256    href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai-core</a>
257    package.  See the document of the module <a
258    href="http://suika.fam.cx/www/manakai-core/lib/Message/DOM/DOMImplementation.html"><code>Message::DOM::DOMImplementation</code></a>
259    for the way to access to the DOM interfaces.
260    
261    <p>The table below summarizes the relationship between Whatpm modules
262    and DOM methods/attributes implemented by manakai-core modules:
263    
264    <table>
265    <thead>
266    <tr><th scope=col>Whatpm module
267    <th scope=col>DOM methods/attributes
268    
269    <tbody>
270    
271    <tr><td><code>Whatpm::CSS::Cascade</code>
272    <td><code>get_computed_style</code> (<code>ViewCSS</code>),
273    <code>current_style</code> (<code>ElementCSS</code>)
274    
275    <tr><td><code>Whatpm::CSS::Parser</code>
276    <td rowspan=2><code>CSSStyleDeclaration</code>'s attributes and methods,
277    <code>css_text</code> (CSSOM interfaces)
278    
279    <tr><td><code>Whatpm::CSS::Serializer</code>
280    
281    <tr><td rowspan=2><code>Whatpm::CSS::SelectorsParser</code>
282    <td><code>query_selector</code>, <code>query_selector_all</code>
283    (<code>DocumentSelector</code>, <code>ElementSelector</code>)
284    <tr><td rowspan=2><code>selector_text</code> (<code>CSSStyleRule</code>)
285    
286    <tr><td><code>Whatpm::CSS::SelectorsSerializer</code>
287    
288    <tr><td><code>Whatpm::HTML</code>
289    <td rowspan=4><code>inner_html</code> (<code>HTMLDocument</code>,
290    <code>Element</code>)
291    
292    <tr><td><code>Whatpm::HTML::Serializer</code>
293    
294    <tr><td><code>Whatpm::XML::Parser</code>
295    
296    <tr><td><code>Whatpm::XMLSerializer</code>
297    
298    </table>
299    
300    </div>
301    
302  </div>  </div>
303    
304  <div class=section id=documents>  <div class=section id=documents>
# Line 250  Specification</a></dt> Line 352  Specification</a></dt>
352  CSS extensions</a>  CSS extensions</a>
353    <dd>The specification for <code>-manakai-<var>*</var></code> properties    <dd>The specification for <code>-manakai-<var>*</var></code> properties
354    and property values implemented by CSS-related modules.    and property values implemented by CSS-related modules.
355  <dt id=spec-manakai-selectors"><a href="http://suika.fam.cx/gate/2005/sw/manakai/Selectors%20Extensions">manakai's  <dt id=spec-manakai-selectors><a href="http://suika.fam.cx/gate/2005/sw/manakai/Selectors%20Extensions">manakai's
356  Selectors extensions</a>  Selectors extensions</a>
357    <dd>The specification for <code>:-manakai-<var>*</var></code>    <dd>The specification for <code>:-manakai-<var>*</var></code>
358    pseudo-classes implemented by Selectors-related modules.</dd>    pseudo-classes implemented by Selectors-related modules.</dd>
# Line 284  tag parsing and conformance checking dem Line 386  tag parsing and conformance checking dem
386  </div>  </div>
387    
388  <div class=section id=applications>  <div class=section id=applications>
389  <h2>Application</h2>  <h2>Applications</h2>
390    
391  <ul>  <ul>
392    
# Line 292  tag parsing and conformance checking dem Line 394  tag parsing and conformance checking dem
394  href="http://suika.fam.cx/gate/2007/html/cc/"><abbr>WebHACC</abbr>  href="http://suika.fam.cx/gate/2007/html/cc/"><abbr>WebHACC</abbr>
395  (Web hypertext application conformance checker)</a> (See also <a  (Web hypertext application conformance checker)</a> (See also <a
396  href="http://suika.fam.cx/gate/2007/html/cc-about"><cite>about  href="http://suika.fam.cx/gate/2007/html/cc-about"><cite>about
397  WebHACC</cite></a>)  WebHACC</cite></a>).
398    
399    <li><a href="http://suika.fam.cx/www/webidl2tests/readme">wttjs</a>, a
400    WebIDL ECMAScript binding test suite generator.
401    
402  </ul>  </ul>
403    
404    <p>See also <a
405    href="http://suika.fam.cx/www/manakai-core/doc/web/#applications">a
406    list of applications using modules in the manakai-core package</a>;
407    some of them indirectly use Whatpm modules via DOM interfaces provided
408    by <a
409    href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai-core</a>.
410    
411  </div>  </div>
412    
413  <div class="section" id="dependency">  <div class="section" id="dependency">
# Line 394  tarball. Line 507  tarball.
507    <li>Validation for media queries (level 3), IRIs (against URI schemes),    <li>Validation for media queries (level 3), IRIs (against URI schemes),
508      and so on.</li>      and so on.</li>
509    <li>Documentations are missing for some features.</li>    <li>Documentations are missing for some features.</li>
   <li>XML parser<!-- with application cache selection algorithm hook-->.</li>  
510    <li>In addition, each module has its own TO DO items.    <li>In addition, each module has its own TO DO items.
511      (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>
512  </ul>  </ul>
513    
514    <p id=bts>See also <a href="http://manakai.g.hatena.ne.jp/task/">the
515    bug tracking system</a>.
516    
517  </div>  </div>
518    
519  <div class=section id=acknowledgments>  <div class=section id=acknowledgments>
# Line 418  parser test data</a>.</p> Line 534  parser test data</a>.</p>
534  <div class="section" id="license">  <div class="section" id="license">
535  <h2>License</h2>  <h2>License</h2>
536    
537  <p>Copyright 2007$B!>(B2008 Wakaba  <p>Copyright 2007$B!>(B2009 Wakaba <code class="mail">&lt;<a
538  <code class="mail">&lt;<a href="mailto:w@suika.fam.cx"  href="mailto:w@suika.fam.cx"
539      rel="author">w@suika.fam.cx</a>></code>.</p>  rel="author">w@suika.fam.cx</a>></code>.</p>
540    
541  <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
542  it under the same terms as Perl itself.</p>  modify it under the same terms as Perl itself.
 </div>  
543    
544  </body>  </div>
 </html>  
Legend:
Removed from v.1.29  
changed lines
  Added in v.1.33
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24