diff --git a/openstreetmap/README b/openstreetmap/README.md similarity index 64% rename from openstreetmap/README rename to openstreetmap/README.md index 48402e29..d8709a18 100644 --- a/openstreetmap/README +++ b/openstreetmap/README.md @@ -1,10 +1,12 @@ - ____ OpenStreetMap Addon ____ -by Mike Macgirvin - Klaus Weidenbach +OpenStreetMap Addon +=== + + by Mike Macgirvin + Klaus Weidenbach This addon allows you to use OpenStreetMap for displaying locations. -___ Requirements ___ +## Requirements To use this addon you need a tile Server that provides the maps. OpenStreetMap data is free for everyone to use. Their tile servers are not. @@ -14,7 +16,7 @@ You can run your own tile server or choose one from their list of public tile servers: http://wiki.openstreetmap.org/wiki/TMS Support the OpenStreetMap community and share the load. -___ Configuration ___ +## Configuration If you for any reason prefer to use a configuration file instead of the admin panels, please refer to the Alternative Configuration below. @@ -30,21 +32,28 @@ level on the map in the Default Zoom box. 1 will show the whole world and 18 is zoom level available. -___ Alternative Configuration ___ +## Alternative Configuration -Open the config/local.ini.php file and add "openstreetmap" to the list of activated -addons. +Open the `config/local.config.php` file and add "openstreetmap" to the list of activated addons. - [system] - addon = ...,openstreetmap + 'system' => [ + ... + 'addon' => '...,openstreetmap' + ... + ] -You can change two configuration variables for the addon in the config/addon.ini.php file: +You can set configuration variables for the addon in the `config/addon.config.php` file: - [openstreetmap] - tmsserver = https://www.openstreetmap.org - zoom = 18 + 'openstreetmap' => [ + 'tmsserver' => 'https://www.openstreetmap.org', + 'nomserver' => 'https://nominatim.openstreetmap.org/search.php', + 'zoom' => 16, + 'marker' => 0, + ], The *tmsserver* points to the tile server you want to use. Use the full URL, with protocol (http/s) and trailing slash. You can configure the default zoom level on the map with *zoom*. 1 will show the whole world and 18 is the highest -zoom level available. \ No newline at end of file +zoom level available. + +Please see provided `config/openstreetmap.php` file for explanation on the additional configuration keys. \ No newline at end of file diff --git a/openstreetmap/config/openstreetmap.config.php b/openstreetmap/config/openstreetmap.config.php new file mode 100644 index 00000000..e9252ca5 --- /dev/null +++ b/openstreetmap/config/openstreetmap.config.php @@ -0,0 +1,23 @@ + [ + // tmsserver (String) + // This points to the tile server you want to use. Use the full URL, with protocol (http/s) and trailing slash. + 'tmsserver' => 'https://www.openstreetmap.org', + + // nomserver (String) + 'nomserver' => 'https://nominatim.openstreetmap.org/search.php', + + // zoom (Integer) + // The default zoom level on the map. + // 1 will show the whole world and 18 is the highest zoom level available. + 'zoom' => 16, + + // marker (Integer) + 'marker' => 0, + ], +]; diff --git a/openstreetmap/config/openstreetmap.ini.php b/openstreetmap/config/openstreetmap.ini.php deleted file mode 100644 index 986843b4..00000000 --- a/openstreetmap/config/openstreetmap.ini.php +++ /dev/null @@ -1,23 +0,0 @@ -loadConfigFile(__DIR__. '/config/openstreetmap.ini.php'); + $a->loadConfigFile(__DIR__ . '/config/openstreetmap.config.php'); } function openstreetmap_alterheader($a, &$navHtml)