# OSM examples for ikiwiki

This repository contains a number of examples for the ikiwiki osm
(OpenStreetMap) plugin.

The osm plugin is included in Ikiwiki, but at the time of writing this README,
none of the included examples will work without patching the plugin. The
Makefile will build the examples using a patched version of Ikiwiki, that will
get most of them working.

## Known Issues

 - The icon on the map for the icon-kml is distorted (compare with the
 icon-geojson example)
 - The simple-csv example does not work
 - There are no map icons in the tags-geojson example
 - The (non square) map icon is distorted in the tags-kml example

## Build Details

Unless each example is viewed at the root of the webserver, the example will
not work. You must set the url option in each of the setup files to the correct
url. For example, if you symlink the dest directory to osm-examples in the
public_html of "username", then this would be the valid url for the
osm-icon-geojson.setup file.

    url: 'http://localhost/~username/osm-examples/icon-geojson/'

The included makefile will download ikiwiki, build it, and then use it to
build all of the examples.

The examples will end up in dest.

You may need some packages to build ikiwiki, running the following will
probably work:

    apt-get build-dep ikiwiki