Description

htree.rb

HTML/XML document tree

Author

Tanaka Akira <akr@fsij.org>

Features

• Permissive unified HTML/XML parser

• byte-to-byte round-tripping unparser

• XML namespace support

• Dedicated class for escaped string. This ease sanitization.

• XHTML/XML generator

• template engine: files/htree/template_rb.html

• recursive template expansion

• REXML tree generator: files/htree/rexml_rb.html

Example

The following one-liner prints parsed tree object.

% ruby -rhtree -e 'pp HTree(ARGF)' html-file

The following two-line script convert HTML to XHTML.

require 'htree'
HTree(STDIN).display_xml

The conversion method to REXML is provided as to_rexml.

HTree(...).to_rexml

Module/Class Hierarchy

• HTree

  • HTree::Name

  • HTree::Context

  • HTree::Location

  • HTree::Node

    • HTree::Doc

    • HTree::Elem

    • HTree::Text

    • HTree::XMLDecl

    • HTree::DocType

    • HTree::ProcIns

    • HTree::Comment

    • HTree::BogusETag

• HTree::Error

Method Summary

HTree provides following methods.

• Parsing Methods

  • HTree(html_string) -> HTree::Doc

  • HTree.parse(input) -> HTree::Doc

• Generation Methods

  • HTree::Node#display_xml -> STDOUT

  • HTree::Node#display_xml(out) -> out

  • HTree::Node#display_xml(out, encoding) -> out

  • HTree::Text#to_s -> String

• Template Methods

  • HTree.expand_template{template_string} -> STDOUT

  • HTree.expand_template(out){template_string} -> out

  • HTree.expand_template(out, encoding){template_string} -> out

  • HTree.compile_template(template_string) -> Module

  • HTree{template_string} -> HTree::Doc

• Traverse Methods

  • HTree::Elem#attributes -> Hash[HTree::Name -> HTree::Text]

  • HTree::Elem::Location#attributes -> Hash[HTree::Name -> HTree::Location]

• Predicate Methods

  • HTree::Traverse#doc? -> true or false

  • HTree::Traverse#elem? -> true or false

  • HTree::Traverse#text? -> true or false

  • HTree::Traverse#xmldecl? -> true or false

  • HTree::Traverse#doctype? -> true or false

  • HTree::Traverse#procins? -> true or false

  • HTree::Traverse#comment? -> true or false

  • HTree::Traverse#bogusetag? -> true or false

• REXML Tree Generator

  • HTree::Node#to_rexml -> REXML::Child