source: subversion/applications/lib/Geo-OSM-MapFeatures/README

Last change on this file was 11736, checked in by bobkare, 11 years ago

Initial release of Geo::OSM::MapFeatures?, which parses and represents map features as a perl object

File size: 2.1 KB
Line 
1Geo::OSM::MapFeatures -- Parses and represents OpenStreetMap Map Features
2
3OpenStreetMap does not have any content restrictions on tags that can
4be assigned to Nodes, Ways or Areas. You can use any tags you
5like. However, there is benefit in agreeing a recommended set of
6features and corresponding tags in order to create, interpret and
7display a common basemap. Map Features contains a core recommended
8feature set and corresponding tags.
9
10This module downloads and parses map features and tries to make it
11easy access for software, something the original wiki page is most
12certainly not.
13
14INSTALLATION
15
16To install this module, run the following commands:
17
18        perl Makefile.PL
19        make
20        make test
21        make install
22
23EXAMPLE
24
25use Geo::OSM::MapFeatures;
26
27my $mf = new Geo::OSM::MapFeatures;
28$mf->download();
29$mf->parse();
30
31# To print a simple ascii representation:
32foreach my $category ( $mf->categories() ){
33    print "\n\n===== $category =====\n";
34    foreach my $feature ( $mf->features($category) ){
35        print "$feature\n";
36    }
37}
38
39# Or you can choose not to use the string overloading and get the
40# individual elements yourself:
41foreach my $category ( $mf->categories() ){
42    print "\n\n===== $category =====\n";
43    foreach my $feature ( $mf->features($category) ){
44        print "Key: ".$feature->key()."\n";
45        print "Value(s): ". join("\n          ", @{$feature->values()})."\n";
46        print "Description: ".$feature->description()."\n\n";
47    }
48}
49
50SUPPORT AND DOCUMENTATION
51
52After installing, you can find documentation for this module with the
53perldoc command.
54
55    perldoc Geo::OSM::MapFeatures
56
57You can also look for information at:
58
59    RT, CPAN's request tracker
60        http://rt.cpan.org/NoAuth/Bugs.html?Dist=Geo-OSM-MapFeatures
61
62    AnnoCPAN, Annotated CPAN documentation
63        http://annocpan.org/dist/Geo-OSM-MapFeatures
64
65    CPAN Ratings
66        http://cpanratings.perl.org/d/Geo-OSM-MapFeatures
67
68    Search CPAN
69        http://search.cpan.org/dist/Geo-OSM-MapFeatures
70
71
72COPYRIGHT AND LICENCE
73
74Copyright (C) 2008 Knut Arne Bjørndal
75
76This program is free software; you can redistribute it and/or modify it
77under the same terms as Perl itself.
78
Note: See TracBrowser for help on using the repository browser.