aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristopher Baines <mail@cbaines.net>2014-07-13 21:37:12 +0100
committerChristopher Baines <mail@cbaines.net>2014-07-13 21:37:12 +0100
commit229c0594d58ce6012931c62e5f9b6a6e05ad9bab (patch)
tree1cacad2ff9737e706fcde4fe7dacabecf365859a /doc
parentf08288409be0ec432db5a968e6910db94984ebf3 (diff)
downloadikiwiki-229c0594d58ce6012931c62e5f9b6a6e05ad9bab.tar
ikiwiki-229c0594d58ce6012931c62e5f9b6a6e05ad9bab.tar.gz
Add some examples for the OSM plugin
Note that these examples are intended to be used more for testing and fixing the plugin, rather than demonstrating its functionality.
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/osm.mdwn16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/plugins/osm.mdwn b/doc/plugins/osm.mdwn
index d15dfbfd8..a2455a4be 100644
--- a/doc/plugins/osm.mdwn
+++ b/doc/plugins/osm.mdwn
@@ -15,6 +15,22 @@ if the [[!cpan JSON]] perl module is installed.
This provides the [[ikiwiki/directive/waypoint]] and [[ikiwiki/directive/osm]] directives.
+### Examples
+
+A [[basic set of examples|http://cbaines.net/osm-examples]] is available
+([[repository|http://git.cbaines.net/?p=ikiwiki/osm-examples.git;a=summary]]).
+Note that none of these will work without patching the plugin. With the
+following patches, most of the examples will work (while each patch is
+seperate, the branch includes all previous patches in the list, so the
+cbaines/osm-icon-fixes branch includes all patches).
+
+ - [[bugs/osm plugin error TypeError: mapProjection is null]]
+ - [[todo/osm plugin GeoJSON popup patch]]
+ - [[todo/osm plugin icon patch]]
+
+Even with these patches, the CSV examples do not work, and there are cosmetic
+issues with a few of the other examples.
+
---
The plugin was originally written by