--- markup/html/whatpm/readme.en.html 2008/09/17 05:48:06 1.25 +++ markup/html/whatpm/readme.en.html 2008/09/17 06:16:06 1.26 @@ -13,36 +13,74 @@

Introduction

-

Whatpm is a work-in-progress set of Perl -modules for Web hypertext application -technologies. It is part -of the manakai +

Whatpm is a work-in-progress set of +Perl modules for Web +hypertext application +technologies. It is part of the manakai project.

+

Whatpm supports various Web standard technologies, including HTML, XHTML, XML, +CSS, HTTP, and +URL. +

+ +
+

Modules

+ +
+

Modules for HTML and XML

+ +

Modules related to HTML and XHTML are as follows: +

+
Whatpm::HTML
+
An implementation of HTML5 document and fragment + parsing algorithms. It can be used + to convert an arbitrary string into a + DOM. (See also + demo.)
+
Whatpm::HTML::Serializer
+
An implementation of HTML5 fragment serialization algorithm. + (See also demo.)
+
Whatpm::HTMLTable
+
An implementation of the HTML5 table algorithm. It can be + used to extract a table structure from a DOM table + element node. (See also demo.)
+
+ +

The module for tentative XML support is as follow: +

+
Whatpm::XMLSerializer
+
A simple XML serializer.
+
+ +

Real XML parser and serializer are currently not available yet. + +

The module for conformance checking of a DOM tree (i.e. +a in-memory representation of a HTML or XML document) is as follows:

-
Modules
-
-
Whatpm::CacheManifest
-
An - HTML5 - cache manifest parser.
-
Whatpm::Charset::UniversalCharDet
-
A Perl interface to universalchardet character encoding detection - library.
Whatpm::ContentChecker
A DOM5 HTML (in-memory representation of a document) conformance checker with a partial support for Atom 1.0. (See also demo.)
-
Whatpm::ContentType
-
An implementation of HTML5 Content Type sniffing algorithm.
+
+ +

Currently, conformance checking of HTML/XHTML and Atom documents +is supported. +

-
Whatpm::CSS::Cascade -
A media-independent implementation of CSS cascading and value - computation. (See also demo.) -
Whatpm::CSS::Parser -
A CSS parser that constructs CSSOM trees from style sheets. (See - also demo.) +
+

Modules for CSS

+

Modules for CSS and related technologies are as follows: +

+
Whatpm::CSS::Cascade +
A media-independent implementation of CSS cascading and value + computation. (See also demo.) +
Whatpm::CSS::Parser +
A CSS parser that constructs CSSOM trees from style sheets. (See + also demo.)
Whatpm::CSS::SelectorsParser
A group of selectors parser. (See also demo.)
@@ -52,79 +90,113 @@ and demo.)
Whatpm::CSS::Tokenizer
A CSS tokenizer. (See also demo.)
-
Whatpm::HTML
-
An implementation of HTML5 document and fragment - parsing algorithms. It can be used - to convert an arbitrary string into a - DOM. (See also - demo.)
-
Whatpm::HTML::Serializer
-
An implementation of HTML5 fragment serialization algorithm. - (See also demo.)
-
Whatpm::HTMLTable
-
An implementation of the HTML5 table algorithm. It can be - used to extract a table structure from a DOM table - element node. (See also demo.)
+ +
+ +
+

Modules for HTTP

+ +

Modules for HTTP and related technologies are as follows: +

+
Whatpm::ContentType
+
An implementation of HTML5 Content Type sniffing algorithm.
Whatpm::IMTChecker
An Internet Media Type (aka MIME type) label conformance checker.
+
+

Currently, support for parsing of HTTP headers and as such is not +yet available. +

+ +
+

Module for URL

+ +

Module for the URL support is as follows: +

Whatpm::URIChecker
An IRI reference conformance checker.
+
+ +

Support for HTML5's realistic definition of URL is not available yet. +

+ +
+

Modules for other technologies

+

Following modules provide support for other Web-related technologies: +

+
Whatpm::CacheManifest
+
An + HTML5 + cache manifest parser.
+
Whatpm::Charset::UniversalCharDet
+
A Perl interface to universalchardet character encoding detection + library.
+
Whatpm::LangTag +
A language tag parser and conformance checker, supporting both + older RFC 3066 definition and latest RFC 4646 definition. (See also + demo.)
Whatpm::WebIDL
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 ; character. - -
Whatpm::LangTag -
A language tag parser and conformance checker, supporting both - older RFC 3066 definition and latest RFC 4646 definition. (See also - demo.) - -
Whatpm::XMLSerializer
-
A simple XML serializer.
-
+ +

Note that all of these modules are work in progress and have a number of unresolved problems.

Note also that some modules have no documentation for now.

- -
Specifications
-
-
SSFT - Specification
-
The specification for the serialization format used for - testing Selectors-related modules.
-
manakai's - Selectors Extensions
-
The specification for :-manakai-* - pseudo-classes implemented by Selectors-related modules.
-
-
Documentations
-
+ + + + +
+

Documents

+ +

For the description of functionalities provided by each module, see +pod documentation of the module. HTML version of +pod documentations are linked from the list of modules above. + +

In addition, there are additional documents for some topics: +

List of error types
+
Description of errors to be notified to callback functions by Whatpm modules.
-
Selectors object
-
Description of data structure for Selectors, as implemented by - Whatpm::CSS::SelectorsParser - (as output), and - Whatpm::CSS::SelectorsSerializer - (as input).
-
List of predefined user data names
-
List of user data names defined by Whatpm modules.
-
Handle objects -
Description of character or byte stream input handle interfaces. -
-
+ +
Selectors object
+
Description of data structure for Selectors, as implemented by + Whatpm::CSS::SelectorsParser + (as output), and + Whatpm::CSS::SelectorsSerializer + (as input).
+ +
List of predefined user data names
+
List of user data names defined by Whatpm modules.
+ +
Handle objects +
Description of character or byte stream input handle interfaces. + + +

Following specifications define Whatpm-specific formats and extensions: +

+
SSFT +Specification
+
The specification for the serialization format used for + testing Selectors-related modules.
+ +
manakai's +Selectors Extensions
+
The specification for :-manakai-* + pseudo-classes implemented by Selectors-related modules.
-