[openstreetmap] Update config file style/name

diff --git a/openstreetmap/README b/openstreetmap/README
deleted file mode 100644 (file)
index 48402e2..0000000
--- a/openstreetmap/README
+++ /dev/null
@@ -1,50 +0,0 @@
- ____ OpenStreetMap Addon ____
-by Mike Macgirvin
-   Klaus Weidenbach
-
-This addon allows you to use OpenStreetMap for displaying locations.
-
-___ 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.
-Please take a look at their "Tile Usage Policy":
-http://wiki.openstreetmap.org/wiki/Tile_usage_policy
-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 ___
-
-If you for any reason prefer to use a configuration file instead
-of the admin panels, please refer to the Alternative Configuration below.
-
-Activate the addon from your admin panel.
-
-You can now add a Tile Server and default zoom level in the addon settings
-page of your admin panel.
-
-The Time Server URL 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 in the Default Zoom box.  1 will show the whole world and 18 is the highest
-zoom level available.
-
-
-___ Alternative Configuration ___
-
-Open the config/local.ini.php file and add "openstreetmap" to the list of activated
-addons.
-
-    [system]
-       addon = ...,openstreetmap
-
-You can change two configuration variables for the addon in the config/addon.ini.php file:
-
-       [openstreetmap]
-       tmsserver = https://www.openstreetmap.org
-    zoom = 18
-
-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

diff --git a/openstreetmap/README.md b/openstreetmap/README.md
new file mode 100644 (file)
index 0000000..d8709a1
--- /dev/null
+++ b/openstreetmap/README.md
@@ -0,0 +1,59 @@
+OpenStreetMap Addon
+===
+
+       by Mike Macgirvin
+          Klaus Weidenbach
+
+This addon allows you to use OpenStreetMap for displaying locations.
+
+## 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.
+Please take a look at their "Tile Usage Policy":
+http://wiki.openstreetmap.org/wiki/Tile_usage_policy
+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
+
+If you for any reason prefer to use a configuration file instead
+of the admin panels, please refer to the Alternative Configuration below.
+
+Activate the addon from your admin panel.
+
+You can now add a Tile Server and default zoom level in the addon settings
+page of your admin panel.
+
+The Time Server URL 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 in the Default Zoom box.  1 will show the whole world and 18 is the highest
+zoom level available.
+
+
+## Alternative Configuration
+
+Open the `config/local.config.php` file and add "openstreetmap" to the list of activated addons.
+
+     'system' => [
+         ...
+         'addon' => '...,openstreetmap'
+         ...
+     ]
+
+You can set configuration variables for the addon in the `config/addon.config.php` file:
+
+       '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.
+
+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 (file)
index 0000000..e9252ca
--- /dev/null
+++ b/openstreetmap/config/openstreetmap.config.php
@@ -0,0 +1,23 @@
+<?php
+
+// Warning: Don't change this file! It only holds the default config values for this addon.
+// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+
+return [
+       'openstreetmap' => [
+               // 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 (file)
index 986843b..0000000
--- a/openstreetmap/config/openstreetmap.ini.php
+++ /dev/null
@@ -1,23 +0,0 @@
-<?php return <<<INI
-
-; Warning: Don't change this file! It only holds the default config values for this addon.
-; Instead overwrite these config values in config/addon.ini.php in your Friendica directory
-
-[openstreetmap]
-; 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
-
-INI;
-//Keep this line
\ No newline at end of file

diff --git a/openstreetmap/openstreetmap.php b/openstreetmap/openstreetmap.php
index 0410931e71074423939c73df6024c933cf4bceed..e4863e9b464ab9106352f08d516a4e78e0a1d2b8 100644 (file)
--- a/openstreetmap/openstreetmap.php
+++ b/openstreetmap/openstreetmap.php
@@ -49,7 +49,7 @@ function openstreetmap_uninstall()
 
 function openstreetmap_load_config(\Friendica\App $a)
 {
-       $a->loadConfigFile(__DIR__. '/config/openstreetmap.ini.php');
+       $a->loadConfigFile(__DIR__ . '/config/openstreetmap.config.php');
 }
 
 function openstreetmap_alterheader($a, &$navHtml)