summaryrefslogtreecommitdiff
path: root/src/location/doc
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@theqtcompany.com>2015-02-26 07:53:28 +0100
committerAlex Blasche <alexander.blasche@theqtcompany.com>2015-02-26 08:17:34 +0000
commit29d5221f666aab83db010e7f4027e34804af020e (patch)
tree7725c570ecbe0f11e51c64dd1bf7d5c218a5e2bd /src/location/doc
parent3ca6b6c2ea271a8ba0719afd7e51b4d04fef4e4a (diff)
downloadqtlocation-29d5221f666aab83db010e7f4027e34804af020e.tar.gz
Rename Nokia to HERE plugin
This only addresses the documentation. The source code still has plenty of references. The plugin name remains "nokia" as it is part of the API. Change-Id: I0c10226ac418f3045157247b0ca6e7ff598087f7 Reviewed-by: Aaron McCarthy <mccarthy.aaron@gmail.com>
Diffstat (limited to 'src/location/doc')
-rw-r--r--src/location/doc/src/examples/declarative-mapviewer.qdoc8
-rw-r--r--src/location/doc/src/examples/declarative-places.qdoc4
-rw-r--r--src/location/doc/src/examples/places-list.qdoc9
-rw-r--r--src/location/doc/src/places.qdoc4
-rw-r--r--src/location/doc/src/plugins/nokia.qdoc42
5 files changed, 35 insertions, 32 deletions
diff --git a/src/location/doc/src/examples/declarative-mapviewer.qdoc b/src/location/doc/src/examples/declarative-mapviewer.qdoc
index 4b85ffcd..7bf95f54 100644
--- a/src/location/doc/src/examples/declarative-mapviewer.qdoc
+++ b/src/location/doc/src/examples/declarative-mapviewer.qdoc
@@ -47,8 +47,8 @@
\endcode
Refer to the documentation for each of the geo services plugins for details on what plugin
- parameters they support. The Nokia services plugin supplied with Qt requires an \e app_id and
- \e token pair. See "\l {Qt Location Nokia Plugin}" for details.
+ parameters they support. The HERE services plugin supplied with Qt requires an \e app_id and
+ \e token pair. See "\l {Qt Location HERE Plugin}" for details.
QML types shown in this example:
@@ -93,8 +93,8 @@
a mouse.
As we do not specify a plugin for supplying map data, the platform default
- will be used. This is typically the "nokia" plugin, which provides data from
- Nokia services. Additional licensing conditions do apply to the use of this data,
+ will be used. This is typically the "osm" plugin, which provides data from
+ OpenStreetMap services. Additional licensing conditions do apply to the use of this data,
please see the documentation for further details.
\section2 Finding an Address (Geocoding)
diff --git a/src/location/doc/src/examples/declarative-places.qdoc b/src/location/doc/src/examples/declarative-places.qdoc
index f29f53d5..26bcd228 100644
--- a/src/location/doc/src/examples/declarative-places.qdoc
+++ b/src/location/doc/src/examples/declarative-places.qdoc
@@ -70,8 +70,8 @@
\endcode
Refer to the documentation for each of the geo services plugins for details on what plugin
- parameters they support. The Nokia services plugin supplied with Qt requires an \e app_id and
- \e token pair. See "\l {Qt Location Nokia Plugin}" for details.
+ parameters they support. The HERE services plugin supplied with Qt requires an \e app_id and
+ \e token pair. See "\l {Qt Location HERE Plugin}" for details.
\section1 Displaying Categories
diff --git a/src/location/doc/src/examples/places-list.qdoc b/src/location/doc/src/examples/places-list.qdoc
index a1a3ee23..6248afa1 100644
--- a/src/location/doc/src/examples/places-list.qdoc
+++ b/src/location/doc/src/examples/places-list.qdoc
@@ -39,9 +39,12 @@
\snippet places_list/places_list.qml Imports
Instantiate a \l Plugin instance. The \l Plugin is effectively the backend
- from where places are sourced from. Because the \c nokia plugin has been
- specified, some mandatory parameters need to be filled in, see the \l
- {Mandatory Parameters} {Nokia Plugin} documentation for details:
+ from where places are sourced from. Depending on the type of the plugin,
+ some mandatory parameters may be need to be filled in. The most likely type
+ of PluginParameter are some form of service access token which are documented
+ in the service plugin. As an example see the \l
+ {Mandatory Parameters} {HERE Plugin} documentation. In this snippet the \c osm
+ plugin is used which does not require any further parameter:
\snippet places_list/places_list.qml Initialize Plugin
diff --git a/src/location/doc/src/places.qdoc b/src/location/doc/src/places.qdoc
index 7cea3813..9b141c37 100644
--- a/src/location/doc/src/places.qdoc
+++ b/src/location/doc/src/places.qdoc
@@ -52,8 +52,8 @@
\snippet places_list/places_list.qml Initialize Plugin
- \note The Nokia plugin must be supplied with some mandatory parameters as outlined
- in the \l {Mandatory Parameters} {Nokia Plugin} documentation.
+ \note The HERE plugin must be supplied with some mandatory parameters as outlined
+ in the \l {Mandatory Parameters} {HERE Plugin} documentation.
\section2 Models, Views and Delegates
The QML Places API is built around the notion of models, views and delegates.
diff --git a/src/location/doc/src/plugins/nokia.qdoc b/src/location/doc/src/plugins/nokia.qdoc
index 427126ef..773caf95 100644
--- a/src/location/doc/src/plugins/nokia.qdoc
+++ b/src/location/doc/src/plugins/nokia.qdoc
@@ -27,22 +27,22 @@
/*!
\page location-plugin-nokia.html
-\title Qt Location Nokia Plugin
+\title Qt Location HERE Plugin
\ingroup QtLocation-plugins
-\brief Uses the relevant Nokia services provided by Nokia.
+\brief Uses the relevant services provided by HERE.
\section1 Overview
-Included with Qt Location is a geo services plugin which accesses the relevant Nokia services
+Included with Qt Location is a geo services plugin which accesses the relevant HERE services
provided by Nokia. The use of these services is governed by the terms and conditions
available at \l {https://developer.here.com/terms-conditions}.
Note that accepting the terms and conditions only applies those terms and conditions to the use of
-the Nokia geo services plugin and does not limit the use of the other geo services plugins that may
+the HERE geo services plugin and does not limit the use of the other geo services plugins that may
be included with Qt.
-The Nokia geo services plugin can be loaded by using the plugin key "nokia".
+The HERE geo services plugin can be loaded by using the plugin key "nokia".
The online plugin uses the tiled map classes, which caches tile data in heap memory and texture
memory.
@@ -50,7 +50,7 @@ memory.
\section1 Parameters
\section2 Mandatory parameters
-The following table lists mandatory parameters that \e must be passed to the Nokia plugin.
+The following table lists mandatory parameters that \e must be passed to the HERE plugin.
\table
\header
\li Parameter
@@ -63,12 +63,12 @@ The following table lists mandatory parameters that \e must be passed to the Nok
\li Client \e token part of the app_id/token pair for the service used for authentication by all managers.
\endtable
-The Nokia geo services plugin requires an application id and token pair to authenticate the
-application with the Nokia services. To obtain an application id and token pair visit
-\l{http://api.developer.nokia.com/}
+The HERE geo services plugin requires an application id and token pair to authenticate the
+application with the HERE services. To obtain an application id and token pair visit
+\l{https://developer.here.com/}
\section2 Optional parameters
-The following table lists optional parameters that can be passed to the Nokia plugin.
+The following table lists optional parameters that can be passed to the HERE plugin.
\table
\header
\li Parameter
@@ -122,7 +122,7 @@ The following table lists optional parameters that can be passed to the Nokia pl
\section1 Parameter Usage Example
-The following two examples show how to create a Nokia plugin instance with
+The following two examples show how to create a HERE plugin instance with
parameters supplied for an application id and token, which is required for
authentication.
@@ -147,7 +147,7 @@ QGeoServiceProvider *gsp = new QGeoServiceProvider("nokia", params);
\endcode
\section1 Places
-The Nokia provider remotely accesses places (read-only) from a REST based server. The specific capabilities
+The HERE provider remotely accesses places (read-only) from a REST based server. The specific capabilities
and behaviours are outlined below:
\section2 Capabilities
@@ -230,7 +230,7 @@ via QPlaceManager::getDetails()
\section3 Searching for Places
\section4 Search Term and Categories
-The \c nokia plugin supports searching with a \e {search term} and \e {category or categories}, however
+The HERE plugin supports searching with a \e {search term} and \e {category or categories}, however
both are not supported simultaneously.
\list
@@ -239,10 +239,10 @@ both are not supported simultaneously.
\li Invalid usage: \e {search term} + \e {category} + \e {search center}
\endlist
-This limitation applies when using the \c nokia plugin with \l PlaceSearchModel and QPlaceManager::search().
+This limitation applies when using the HERE plugin with \l PlaceSearchModel and QPlaceManager::search().
\section4 Search Area
-The \c nokia plugin only supports provision of a \e {search center} when searching for places via \l PlaceSearchModel
+The HERE plugin only supports provision of a \e {search center} when searching for places via \l PlaceSearchModel
and QPlaceManager::search(). A search center can be provided via a bounding circle, however the
radius should be kept at the default value of -1. Typically a developer should not have to set the radius at all.
If a developer sets a radius, it is ignored by the plugin and the boundaries are not honored.
@@ -253,19 +253,19 @@ of the box are not honored.
A search center \e {must} be provided for all searches.
\section4 Relevancy Hints
-The \c nokia plugin does not support relevancy hints. Any relevancy hints supplied to
+The HERE plugin does not support relevancy hints. Any relevancy hints supplied to
a search request are consequently ignored.
\section3 Search Term suggestions
Only a partial \e {search term} and \e {search center} is supported when retrieving suggestions.
-This limitation applies when using the \c nokia plugin with the \l PlaceSearchSuggestionModel and QPlaceManager::searchSuggestions().
+This limitation applies when using the HERE plugin with the \l PlaceSearchSuggestionModel and QPlaceManager::searchSuggestions().
Both search term and search center \e {must} be provided when retrieving search term suggestions.
\section3 Recommendations
Only a given \e {place identifier} is supported as a parameter for a recommendations. No other parameters
such as limit, offset, and search area are supported. This limitation applies when using the
-\c nokia plugin with \l PlaceSearchModel and QPlaceManager::search().
+HERE plugin with \l PlaceSearchModel and QPlaceManager::search().
\section3 Icons themes, base urls and variants
Icons are provided in the form of "base urls" which reference valid icon images.
@@ -276,7 +276,7 @@ However these urls are "base urls" in the sense that they can be appended onto,
For example, one could add ".list.png" to the above url to get the list variant of the icon,
http://<server>/01.icon.wp7_dark.list.png.
-The following table shows the themes provided by the \c nokia plugin, along with any
+The following table shows the themes provided by the HERE plugin, along with any
variants supported for those themes:
\table
@@ -297,7 +297,7 @@ variants supported for those themes:
\endtable
\section3 Extended Attributes
-The supported set of attributes provided by \c nokia plugin are not fixed and
+The supported set of attributes provided by the HERE plugin are not fixed and
may grow over time. Also the attributes provided may vary according to a place
by place basis, e.g one place may provide opening hours while another does not.
At the time of writing, it is known that some places provide \c openingHours
@@ -312,6 +312,6 @@ to be saved. For QML this is related to \l Place::extendedAttributes, \l ImageM
\l ReviewModel, and \l EditorialModel. For C++ this relates to QPlace::extendedAttribute(),
QPlace::content() and QPlaceManager::getPlaceContent().
-(Note that the \c nokia plugin is a read-only source of places and
+(Note that the HERE plugin is a read-only source of places and
does not support saving functionality at all.)
*/