summaryrefslogtreecommitdiff
path: root/src/location/doc
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@theqtcompany.com>2016-07-29 15:37:19 +0200
committerAlex Blasche <alexander.blasche@theqtcompany.com>2016-07-29 15:37:19 +0200
commit76e3fea9e77713860211c599b2a0aff3a72902c6 (patch)
tree0a24d1c3b987a6f4ebc2fbde6cb0d0a2daae7142 /src/location/doc
parent1753409f92a6b865b71612465b887f808568ada2 (diff)
parent1a1d2e3fff5856dc9d1283b510a9f325c6fb8a93 (diff)
downloadqtlocation-76e3fea9e77713860211c599b2a0aff3a72902c6.tar.gz
Merge remote-tracking branch 'gerrit/5.7' into dev
Change-Id: I6a1a72547077c628429ee9a0781070ad3ae787f1
Diffstat (limited to 'src/location/doc')
-rw-r--r--src/location/doc/images/api-map.pngbin62031 -> 0 bytes
-rw-r--r--src/location/doc/src/plugins/osm.qdoc25
-rw-r--r--src/location/doc/src/qml-maps.qdoc4
3 files changed, 22 insertions, 7 deletions
diff --git a/src/location/doc/images/api-map.png b/src/location/doc/images/api-map.png
deleted file mode 100644
index 6e7255d4..00000000
--- a/src/location/doc/images/api-map.png
+++ /dev/null
Binary files differ
diff --git a/src/location/doc/src/plugins/osm.qdoc b/src/location/doc/src/plugins/osm.qdoc
index 9f4979b5..2f1b0504 100644
--- a/src/location/doc/src/plugins/osm.qdoc
+++ b/src/location/doc/src/plugins/osm.qdoc
@@ -60,15 +60,30 @@ a prefix.
\li User agent string set when making network requests. This parameter should be set to a
value that uniquely identifies the application.
\row
- \li osm.mapping.host
+ \li osm.mapping.custom.host
\li Url string set when making network requests to the tile server. This parameter should be set to a
valid server url with the correct osm api and the \l{Map::activeMapType} to the corresponding \l{MapType}.CustomMap.
The CustomMap will only be available if this parameter is set.
- \note Setting the mapping.host parameter to a new server renders the map tile cache useless for the old custommap style.
+ \note Setting the mapping.custom.host parameter to a new server renders the map tile cache useless for the old custommap style.
\row
- \li osm.mapping.copyright
- \li Custom copryright string is used when setting the \l{Map::activeMapType} to \l{MapType}.CustomMap via urlprefix parameter.
- This copyright will only be used when using the CustomMap from above. If empty no copyright will be displayed for the custom map.
+ \li osm.mapping.custom.mapcopyright
+ \li Custom map copryright string is used when setting the \l{Map::activeMapType} to \l{MapType}.CustomMap via urlprefix parameter.
+ This copyright will only be used when using the CustomMap from above. If empty no map copyright will be displayed for the custom map.
+\row
+ \li osm.mapping.custom.datacopyright
+ \li Custom data copryright string is used when setting the \l{Map::activeMapType} to \l{MapType}.CustomMap via urlprefix parameter.
+ This copyright will only be used when using the CustomMap from above. If empty no data copyright will be displayed for the custom map.
+\row
+ \li osm.mapping.providersrepository.address
+ \li The OpenStreetMap plugin retrieves the provider's information from a remote repository. This is done to prevent using hardcoded
+ servers by default, which may become unavailable. By default this information is fetched from \l {http://maps-redirect.qt.io} {maps-redirect.qt.io}.
+ Setting this parameter changes the provider repository address to a user-specified one, which must contain the files
+ \tt{street}, \tt{satellite}, \tt{cycle}, \tt{transit}, \tt{night-transit}, \tt{terrain} and \tt{hiking}.
+\row
+ \li osm.mapping.providersrepository.disabled
+ \li By default, the OpenStreetMap plugin retrieves the provider's information from a remote repository to avoid a loss of service due to unavailability of hardcoded services.
+ The plugin, however, still contains fallback hardcoded provider data, in case the provider repository becomes unreachable.
+ Setting this parameter to \b true makes the plugin use the hardcoded urls only and therefore prevents the plugin from fetching provider data from the remote repository.
\row
\li osm.routing.host
\li Url string set when making network requests to the routing server. This parameter should be set to a
diff --git a/src/location/doc/src/qml-maps.qdoc b/src/location/doc/src/qml-maps.qdoc
index 9b6232f5..ecc21672 100644
--- a/src/location/doc/src/qml-maps.qdoc
+++ b/src/location/doc/src/qml-maps.qdoc
@@ -47,7 +47,7 @@ Map item you can center the map, zoom, pinch and make the item flickable.
The places to be added to the map are
\l {Maps and Navigation (QML)#Putting Objects on a Map (Map Overlay Objects)}{MapItems}. The item's
-position is defined by a \l {coordinate}{coordinate} which includes latitude,
+position is defined by a \l {coordinate} which includes latitude,
longitude and altitude. The item is then displayed automatically after it is added to the \l Map.
\section2 Position on map
@@ -112,7 +112,7 @@ snippet we see an \l [QML]{Address} object filled with the desired parameters.
\snippet mapviewer/mapviewer.qml geocode0
The \l [QML]{Address} is later used in a query for the \l GeocodeModel to
-process and determine the geographical \l [QML]{Coordinate}{coordinates}.
+process and determine the geographical \l [QML]{coordinate}{coordinates}.
\snippet mapviewer/map/MapComponent.qml geocode1