- EXTENDING Text::Microformat
- SEE ALSO
- COPYRIGHT & LICENSE
Text::Microformat - A Microformat parser
use Text::Microformat; use LWP::Simple; # Parse a document my $doc = Text::Microformat->new( get('http://phil.windley.org/hcard.html') ); # Extract all known Microformats my @formats = $doc->find; my $hcard = shift @formats; # Easiest way to get a value (returns the first one found, else undef) my $full_name = $hcard->Get('fn'); my $family_name = $hcard->Get('n.family-name'); my $city = $hcard->Get('adr.locality'); # Get the human-readable version specifically my $family_name = $hcard->GetH('n.family-name'); # Get the machine-readable version specifically my $family_name = $hcard->GetM('n.family-name'); # The more powerful interface (access multiple properties) my $family_name = $hcard->n->->family_name->->Value; # Dump to a hash my $hash = $hcard->AsHash; # Dump to YAML print $hcard->ToYAML, "\n"; # Free the document and all the formats $doc->delete;
Text::Microformat is a Microformat parser for Perl.
Text::Microformat sports a very pluggable API, which allows not only new kinds of Microformats to be added, but also extension of the parser itself, to allow new parsing metaphors and source document encodings.
Extracting Microformats from HTML, XHTML and XML
Extracting Microformats from entity-encoded or CDATA sections in RSS feeds.
The include pattern
Microformats built from other Microformats
Parses the string $content and creates a new Text::Microformat object.
Returns an array of all known Microformats in the document.
Deletes the underlying parse tree - which is required by HTML::TreeBuilder to free up memory. Behavior of Text::Microformat::Element::* objects is undefined after this method is called.
This is as easy as creating a new module in the Text::Microformat::Element::* namespace, having Text::Microformat::Element as a super-class. It will be auto-loaded by Text::Microformat.
Every Microformat element has it's own namespace auto-generated, for example:
So it's easy to override the default behavior of Text::Microformat::Element via inheritance.
See existing formats for hints.
This is as easy as creating a new module in the Text::Microformat::Plugin::* namespace. It will be auto-loaded by Text::Microformat. Text::Microformat has several processing phases, and uses NEXT to traverse the plugin chain.
Current processing phases are, in order of execution:
Set default options in $c->opts
Pre-parsing activities (Operations on the document source, perhaps)
Parsing - at least one plugin must parse $c->content into $c->tree
Post-parsing activities (E.g. the include pattern happens here)
Before looking for Microformats
Populate the $c->formats array with Text::Microformat::Element objects
After looking for Microformats
A plugin may add handlers to one or more phases.
See existing plugins for hints.
Add more formats
Add filtering options to the find() method
Parsing and format-finding performance could definitely be improved
<kgrennan at cpan.org>
Log bugs and feature requests here: http://code.google.com/p/ufperl/issues/list
Project homepage: http://code.google.com/p/ufperl/
Copyright 2007 Keith Grennan, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.