/usr/share/qt5/doc/qtlocation/location-plugin-osm.html is in qtlocation5-doc-html 5.5.1-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- osm.qdoc -->
<title>Qt Location Open Street Map Plugin | Qt Location 5.5</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.5</li>
<li><a href="qtlocation-index.html">Qt Location</a></li>
<li>Qt Location Open Street Map Plugin</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#overview">Overview</a></li>
<li class="level1"><a href="#parameters">Parameters</a></li>
<li class="level2"><a href="#optional-parameters">Optional parameters</a></li>
<li class="level1"><a href="#parameter-usage-example">Parameter Usage Example</a></li>
<li class="level2"><a href="#qml">QML</a></li>
<li class="level1"><a href="#other-plugin-specific-information">Other Plugin-specific Information</a></li>
<li class="level2"><a href="#tile-cache">Tile cache</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt Location Open Street Map Plugin</h1>
<span class="subtitle"></span>
<!-- $$$location-plugin-osm.html-description -->
<div class="descr"> <a name="details"></a>
<a name="overview"></a>
<h2 id="overview">Overview</h2>
<p>This geo services plugin allows applications to access <a href="http://openstreetmap.org">Open Street Map</a> location based services using the Qt Location API.</p>
<p>Data, imagery and map information provided by <a href="http://www.mapquest.com">MapQuest</a>, <a href="http://www.thunderforest.com/">ThunderForest</a>, OpenStreetMap and contributors. The data is available under the <a href="http://www.opendatacommons.org/licenses/odbl">Open Database License</a>.</p>
<p>The Open Street Map geo services plugin can be loaded by using the plugin key "osm".</p>
<a name="parameters"></a>
<h2 id="parameters">Parameters</h2>
<a name="optional-parameters"></a>
<h3 >Optional parameters</h3>
<p>The following table lists optional parameters that can be passed to the Open Street Map plugin.</p>
<p><b>Note: </b>Since Qt 5.5 all parameters below must be prefixed with <code>osm</code>. Previous versions did not require a prefix.</p><div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Parameter</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td >osm.useragent</td><td >User agent string set when making network requests. This parameter should be set to a value that uniquely identifies the application.</td></tr>
<tr valign="top" class="even"><td >osm.mapping.host</td><td >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 <a href="qml-qtlocation-map.html#activeMapType-prop">Map::activeMapType</a> to the corresponding <a href="qml-qtlocation-maptype.html">MapType</a>.CustomMap. The CustomMap will only be available if this parameter is set.<p><b>Note: </b>Setting the mapping.host parameter to a new server renders the map tile cache useless for the old custommap style.</p></td></tr>
<tr valign="top" class="odd"><td >osm.mapping.copyright</td><td >Custom copryright string is used when setting the <a href="qml-qtlocation-map.html#activeMapType-prop">Map::activeMapType</a> to <a href="qml-qtlocation-maptype.html">MapType</a>.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.</td></tr>
<tr valign="top" class="even"><td >osm.routing.host</td><td >Url string set when making network requests to the routing server. This parameter should be set to a valid server url with the correct osrm API. If not specified the default <a href="http://router.project-osrm.org/viaroute">url</a> will be used.<p><b>Note: </b>The API documentation and sources are available at <a href="http://project-osrm.org/">Project OSRM</a>.</p></td></tr>
<tr valign="top" class="odd"><td >osm.geocoding.host</td><td >Url string set when making network requests to the geocoding server. This parameter should be set to a valid server url with the correct osm API. If not specified the default <a href="http://nominatim.openstreetmap.org/">url</a> will be used.<p><b>Note: </b>The API documentation is available at <a href="https://wiki.openstreetmap.org/wiki/Nominatim">Project OSM Nominatim</a>.</p></td></tr>
<tr valign="top" class="even"><td >osm.places.host</td><td >Url string set when making network requests to the places server. This parameter should be set to a valid server url with the correct osm API. If not specified the default <a href="http://nominatim.openstreetmap.org/search">url</a> will be used.<p><b>Note: </b>The API documentation is available at <a href="https://wiki.openstreetmap.org/wiki/Nominatim">Project OSM Nominatim</a>.</p></td></tr>
</table></div>
<a name="parameter-usage-example"></a>
<h2 id="parameter-usage-example">Parameter Usage Example</h2>
<p>The following example shows how to create an OSM plugin instance with parameters supplied for an useragent, and if necessary, a custom server url plus the corresponding copyright information for the tile provider. Additionally, it is possible to choose another routing server than the public osrm one.</p>
<a name="qml"></a>
<h3 >QML</h3>
<pre class="cpp">Plugin {
name: <span class="string">"osm"</span>
PluginParameter { name: <span class="string">"osm.useragent"</span>; value: <span class="string">"My great Qt OSM application"</span> }
PluginParameter { name: <span class="string">"osm.mapping.host"</span>; value: <span class="string">"http://osm.tile.server.address/"</span> }
PluginParameter { name: <span class="string">"osm.mapping.copyright"</span>; value: <span class="string">"All mine"</span> }
PluginParameter { name: <span class="string">"osm.routing.host"</span>; value: <span class="string">"http://osrm.server.address/viaroute"</span> }
PluginParameter { name: <span class="string">"osm.geocoding.host"</span>; value: <span class="string">"http://geocoding.server.address"</span> }
}</pre>
<a name="other-plugin-specific-information"></a>
<h2 id="other-plugin-specific-information">Other Plugin-specific Information</h2>
<a name="tile-cache"></a>
<h3 >Tile cache</h3>
<p>The tiles are cached in a <code>QtLocation/osm</code> directory in <a href="../qtcore/qstandardpaths.html#writableLocation">QStandardPaths::writableLocation</a> (<a href="../qtcore/qstandardpaths.html#StandardLocation-enum">QStandardPaths::GenericCacheLocation</a>). On systems that have no concept of a shared cache, the application-specific <a href="../qtcore/qstandardpaths.html#StandardLocation-enum">QStandardPaths::CacheLocation</a> is used instead.</p>
</div>
<!-- @@@location-plugin-osm.html -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|