Author image Brendan Francis O'Connor
and 1 contributors

NAME

Data::Microformat::geo - A module to parse and create geos

VERSION

This documentation refers to Data::Microformat::geo version 0.03.

SYNOPSIS

        use Data::Microformat::geo;

        my $geo = Data::Microformat::geo->parse($a_web_page);

        print "The latitude we found in this geo was:\n";
        print $adr->latitude."\n";
        
        print "The longitude we found in this geo was:\n";
        print $adr->longitude."\n";

        # To create a new geo:
        my $new_geo = Data::Microformat::geo->new;
        $new_adr->latitude("37.779598");
        $new_adr->longitude("-122.398453");

        print "Here's the new adr I've just made:\n";
        print $new_adr->to_hcard."\n";

DESCRIPTION

A geo is the geolocation microformat used primarily in hCards. It exists as its own separate specification.

This module exists both to parse existing geos from web pages, and to create new geos so that they can be put onto the Internet.

To use it to parse an existing geo (or geos), simply give it the content of the page containing them (there is no need to first eliminate extraneous content, as the module will handle that itself):

        my $geo = Data::Microformat::geo->parse($content);

If you would like to get all the geos on the webpage, simply ask using an array:

        my @geos = Data::Microformat::geo->parse($content);

To create a new geo, first create the new object:

        my $geo = Data::Microformat::geo->new;
        

Then use the helper methods to add any data you would like. When you're ready to output the geo in the hCard HTML format, simply write

        my $output = $geo->to_hcard;

And $output will be filled with an hCard representation, using <div> tags exclusively with the relevant class names.

SUBROUTINES/METHODS

class_name

The hCard class name for a geolocation; to wit, "geo."

singular_fields

This is a method to list all the fields on a geo that can hold exactly one value.

They are as follows:

latitude

The latitude of the encoded location.

longitude

The longitude of the encoded location.

plural_fields

This is a method to list all the fields on an address that can hold multiple values.

There are none for a geo.

BUGS

Please report any bugs or feature requests to bug-data-microformat at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Data-Microformat. I will be notified,and then you'll automatically be notified of progress on your bug as I make changes.

AUTHOR

Brendan O'Connor, <perl at ussjoin.com>

COPYRIGHT

Copyright 2008, Six Apart Ltd. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.