gluon-config-mode-geo-location-with-map: integrate a location picker map #1484
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| gluon-config-mode-geo-location | ||
| ============================== | ||
|
|
||
| This package allows the user to set latitude, longitude and optionally altitude | ||
| to be advertised from within the config mode. There are two types of this | ||
| package: | ||
|
|
||
| It is possible to include **either** ``gluon-config-mode-geo-location`` **or** | ||
| ``gluon-config-mode-geo-location-with-map`` in the ``site.mk``. | ||
|
|
||
| If you want to use ``gluon-config-mode-geo-location-with-map`` together with | ||
| the GLUON_FEATURE ``web-wizard`` then you have to exclude | ||
| ``gluon-config-mode-geo-location``, i.e.: | ||
|
|
||
| GLUON_SITE_PACKAGES += \ | ||
| -gluon-config-mode-geo-location \ | ||
| gluon-config-mode-geo-location-with-map | ||
|
|
||
| gluon-config-mode-geo-location-with-map | ||
| --------------------------------------- | ||
|
|
||
| This package enhances the config mode by providing users a map that can be used | ||
| to pick a position. The map requires an internet connection on the users | ||
| computer and will be hidden if there is none. | ||
|
|
||
| site.conf | ||
| ^^^^^^^^^ | ||
|
|
||
| This option is valid for both ``gluon-config-mode-geo-location`` and | ||
| ``gluon-config-mode-geo-location-with-map``: | ||
|
|
||
| config_mode.geo_location.show_altitude \: optional | ||
| - ``true`` the altitude section in config mode is shown | ||
|
There was a problem hiding this comment. show altitude field in config mode |
||
| - ``false`` the altitude section in config mode is hidden | ||
|
There was a problem hiding this comment. hide altitude field in config mode |
||
| - defaults to ``false`` | ||
|
|
||
| The remaining options are only valid for the | ||
| ``gluon-config-mode-geo-location-with-map`` package: | ||
|
|
||
| config_mode.geo_location.map.lon \: optional | ||
| - represents the default longitude value to use for the center of the map. | ||
| - defaults to ``0.0`` | ||
|
There was a problem hiding this comment. set the default to the center of europe instead of the Golf of Guinea. There was a problem hiding this comment. It's the center of the wold because this project ins not only designed for Germany or Europe. I think some people form US use Gluon as well. So 0.0/0.0 is the best in my opinion. There was a problem hiding this comment. Another approach: treat missing value as nil and don't show the map. |
||
|
|
||
| config_mode.geo_location.map.lat \: optional | ||
| - represents the default latitude value to use for the center of the map. | ||
| - defaults to ``0.0`` | ||
|
|
||
| The map will center to the position defined in **lat** and **lon**, unless a | ||
| location was already defined. The new defined location will become the | ||
| new center. | ||
|
|
||
| config_mode.geo_location.map.zoom \: optional | ||
| - Natural number between ``0-17`` for the zoom level of the map. | ||
| - defaults to ``12`` | ||
|
|
||
| config_mode.geo_location.map.openlayers_js_url \: optional | ||
| - ``url`` set an URL for OpenStreetMap layers. | ||
| - defaults to ``https://openlayers.org/api/OpenLayers.js`` | ||
|
|
||
| Example:: | ||
|
|
||
| config_mode = { | ||
| geo_location = { | ||
| map = { | ||
| lon = 52.951947558, | ||
| lat = 7.844238281, | ||
| zoom = 12, | ||
| openlayers_js_url = 'http://osm.ffnw.de/.static/ol/OpenLayers.js', | ||
| }, | ||
| show_altitude = true, | ||
| }, | ||
| }, | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I Think this is redundancy in the gluon doc ... but I'll include it anyway.
applied