From 0218bb6ceea8bb03b2510cc719c166dd5438b367 Mon Sep 17 00:00:00 2001
From: Jan-Tarek Butt <tarek@ring0.de>
Date: Fri, 20 Jul 2018 21:00:42 +0200
Subject: [PATCH] gluon-config-mode-geo-location-with-map: add package doc

---
 docs/index.rst                                |  1 +
 .../gluon-config-mode-geo-location.rst        | 55 +++++++++++++++++++
 2 files changed, 56 insertions(+)
 create mode 100644 docs/package/gluon-config-mode-geo-location.rst

diff --git a/docs/index.rst b/docs/index.rst
index 41a64ad7..3865b07c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -58,6 +58,7 @@ Several Freifunk communities in Germany use Gluon as the foundation of their Fre
 
    package/gluon-client-bridge
    package/gluon-config-mode-domain-select
+   package/gluon-config-mode-geo-location
    package/gluon-ebtables-filter-multicast
    package/gluon-ebtables-filter-ra-dhcp
    package/gluon-ebtables-limit-arp
diff --git a/docs/package/gluon-config-mode-geo-location.rst b/docs/package/gluon-config-mode-geo-location.rst
new file mode 100644
index 00000000..ad5fd8b3
--- /dev/null
+++ b/docs/package/gluon-config-mode-geo-location.rst
@@ -0,0 +1,55 @@
+gluon-config-mode-geo-location
+==============================
+
+This package allows the user to set latitude, longitude and optionally altitude
+within config mode. There are 2 types of this package.
+
+It is possible to include ``gluon-config-mode-geo-location`` or
+``gluon-config-mode-geo-location-with-map`` in the ``site.mk``.
+
+gluon-config-mode-geo-location-with-map
+---------------------------------------
+
+The package ``gluon-config-mode-geo-location-with-map`` will additionally and a
+map where users can pick a position. This map will only shown if the users
+computer will have an internet connection.
+
+site.conf
+^^^^^^^^^
+
+This option is valid for both typ of package.
+
+config_mode.geo_location.show_altitude \: optional
+  - ``true`` the altitude section in config mode is shown
+  - ``false`` the altitude section in config mode is hidden
+  - defaults to ``false``
+
+All following options are only valid for the package
+``gluon-config-mode-geo-location-with-map``.
+
+config_mode.geo_location.map_lon \: optional
+  - represents the default longitude center of the location picker map.
+  - defaults to ``0.0``
+
+config_mode.geo_location.map_lat \: optional
+  - represents the default latitude center of the location picker map.
+  - defaults to ``0.0``
+
+The above 2 options will usually shown on a factory flashed Router. If a node
+is reenter the config mode the maps center will be on the last defined
+position.
+
+config_mode.geo_location.olurl \: optional
+  - ``url`` set an url for OpenStreetMap layers.
+  - defaults to ``http://dev.openlayers.org/OpenLayers.js``
+
+Example::
+
+  config_mode = {
+            geo_location = {
+                    map_lon = 52.951947558,
+                    map_lat = 7.844238281,
+                    olurl = 'http://osm.ffnw.de/.static/ol/OpenLayers.js',
+                    show_altitude = true,
+            },
+  },