Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
98 lines (96 sloc) 2.63 KB
#
# = htree.rb
#
# HTML/XML document tree
#
# Author:: Tanaka Akira <akr@m17n.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: link:files/htree/template_rb.html
# - recursive template expansion
# - REXML tree generator: link: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(<i>html_string</i>) -> HTree::Doc
# - HTree.parse(<i>input</i>) -> HTree::Doc
#
# - Generation Methods
# - HTree::Node#display_xml -> STDOUT
# - HTree::Node#display_xml(<i>out</i>) -> <i>out</i>
# - HTree::Node#display_xml(<i>out</i>, <i>encoding</i>) -> <i>out</i>
# - HTree::Text#to_s -> String
#
# - Template Methods
# - HTree.expand_template{<i>template_string</i>} -> STDOUT
# - HTree.expand_template(<i>out</i>){<i>template_string</i>} -> <i>out</i>
# - HTree.expand_template(<i>out</i>, <i>encoding</i>){<i>template_string</i>} -> <i>out</i>
# - HTree.compile_template(<i>template_string</i>) -> Module
# - HTree{<i>template_string</i>} -> 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
require 'htree/parse'
require 'htree/extract_text'
require 'htree/equality'
require 'htree/inspect'
require 'htree/display'
require 'htree/loc'
require 'htree/traverse'
require 'htree/template'
require 'htree/rexml'