summaryrefslogtreecommitdiff
path: root/perl/perl-HTML-Formatter/README
diff options
context:
space:
mode:
Diffstat (limited to 'perl/perl-HTML-Formatter/README')
-rw-r--r--perl/perl-HTML-Formatter/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/perl/perl-HTML-Formatter/README b/perl/perl-HTML-Formatter/README
new file mode 100644
index 0000000000..50906a3942
--- /dev/null
+++ b/perl/perl-HTML-Formatter/README
@@ -0,0 +1,14 @@
+perl-HTML-Formatter
+
+HTML::Formatter is a base class for classes that take HTML and format
+it to some output format. When you take an object of such a base class
+and call $formatter-format( $tree )> with an HTML::TreeBuilder (or
+HTML::Element) object, they return the appropriately formatted string
+for the input HTML.
+
+HTML formatters are able to format a HTML syntax tree into various
+printable formats. Different formatters produce output for different
+output media. Common for all formatters are that they will return the
+formatted output when the format() method is called. The format()
+method takes a HTML::Element object (usually the HTML::TreeBuilder root
+object) as parameter.