Skip to content

Commit abd8ddb

Browse files
committed
polished app documentation
1 parent 1e30ab6 commit abd8ddb

File tree

3 files changed

+29
-18
lines changed

3 files changed

+29
-18
lines changed

LocationMapViewer/src/main/res/values/donottranslate.xml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,17 +63,19 @@ plug-in/device-driver through an Intent interface or through html-a-href-links.
6363
href="http://tools.ietf.org/html/draft-mayrhofer-geo-uri-00">geo
6464
uri</a>
6565
<ul>
66-
<li> <a href="geo:53.0,8.0?q=(Hello)">geo:53.0,8.0?q=(Hello)</a>
66+
<li> <a href="geo:0,0?q=53.0,8.0(Hello)">geo:0,0?q=53.0,8.0(Hello)</a>
6767
<ul>
6868
<li> displays "hello" at the location lat=53.0 north
6969
and lon= 8.0 east </li>
70-
<li>in html you can use &lt;a href=&quot;geo:53.0,8.0?q=(Hello)&quot;&gt;geo:53.0,8.0?q=(Hello)&lt;/a&gt;</li>
70+
<li>in html you can use &lt;a href=&quot;geo:0,0?q=53.0,8.0(Hello)&quot;&gt;geo:0,0?q=53.0,8.0(Hello)&lt;/a&gt;</li>
71+
<li>This format is compatible with google-maps for android.</li>
7172
</ul>
7273
</li>
73-
<li> <a href="geo:0,0?q=53.0,8.0(Hello)">geo:0,0?q=53.0,8.0(Hello)</a>
74+
<li> <a href="geo:53.0,8.0?q=(Hello)">geo:53.0,8.0?q=(Hello)</a>
7475
<ul>
7576
<li> displays "hello" at the location lat=53.0 north
7677
and lon= 8.0 east </li>
78+
<li>This format is <b>not</b> compatible with google-maps for android.</li>
7779
</ul>
7880
</li>
7981
<li> <a href="geo:53.0,8.0?z=6">geo:53.0,8.0?z=6</a>

LocationMapViewer/src/main/res/values/strings.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,10 @@ support for <strong>gpx</strong> and <strong>kml</strong>
3333
files and <strong>geo-uri-s</strong> and can work offline
3434
(without internet/wifi) once geodata is downloaded and cached. </p>
3535
<p> Other Android apps can use LocationMapViewer through an
36-
Intent interface. (See GeoIntentDemo)<br />
37-
</p>
36+
Intent interface (see <a
37+
href="https://github.com/k3b/LocationMapViewer/blob/master/geoIntentDemo/src/main/java/de/k3b/android/locationMapViewer/demo/GeoIntentDemoActivity.java">
38+
GeoIntentDemo.java</a>) or through html links similar to <a href="geo:0,0?q=53.0,8.0(Hello)">geo:0,0?q=53.0,8.0(Hello)</a>
39+
(&lt;a href=&quot;geo:0,0?q=53.0,8.0(Hello)&quot;&gt;geo:0,0?q=53.0,8.0(Hello)&lt;/a&gt;)<br />
40+
</p>
3841
]]>"</string>
3942
</resources>

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,14 @@ An app that can display geografic info in a map. It has support for **gpx** and
44
and can work offline (without internet/wifi)
55
once geodata is downloaded and cached.
66

7-
Other Android apps can use LocationMapViewer through an Intent interface.
8-
(See GeoIntentDemo)<br/>
7+
Other Android apps can use LocationMapViewer through an Intent interface
8+
(see [GeoIntentDemo.java](https://github.com/k3b/LocationMapViewer/blob/master/geoIntentDemo/src/main/java/de/k3b/android/locationMapViewer/demo/GeoIntentDemoActivity.java) )
9+
or through html links like &lt;a href=&quot;geo:0,0?q=53.0,8.0(Hello)&quot;&gt;geo:0,0?q=53.0,8.0(Hello)&lt;/a&gt;<br/>
910

1011
Minimal requirements: Android 2.1 (Eclair, API 7), internet/wifi-connection to download geodata and a SD-Card to cache geodata<br/>
12+
1113
Licence: [GPLv3](http://www.gnu.org/licenses/gpl-3.0)<br/>
14+
1215
Requred permissions:
1316

1417
* INTERNET: to download map data from Open Streetmap Server
@@ -18,23 +21,26 @@ Requred permissions:
1821
* to load gpx/kml-Files to be displayed in the map
1922
* ACCESS_FINE_LOCATION and ACCESS_COARSE_LOCATION: to display my own location in the map, too
2023

21-
The code uses [osmdroid library](https://github.com/osmdroid/osmdroid) to
22-
display maps from [Open Street Map](http://www.openstreetmap.org)
23-
24-
LocationMapViewer is based on "org.osmdroid.samples.SampleWithMinimapItemizedoverlay"
25-
from DemoApp "OsmDroid-OpenStreetMapViewer"
24+
The code uses [osmdroid library](https://github.com/osmdroid/osmdroid)
25+
with [osmbonuspack library](http://code.google.com/p/osmbonuspack/)
26+
to display maps from [Open Street Map](http://www.openstreetmap.org).
2627

2728
##Intent Interface
2829

29-
Other Android apps can use LocationMapViewer as plug-in/device-driver through an Intent interface.
30+
Other Android apps can use LocationMapViewer as plug-in/device-driver through an Intent interface
31+
or through html-a-href-links.
32+
3033
Examples:
3134

3235
* uri=geo:... displays (and zomms to) a [geo uri](http://tools.ietf.org/html/draft-mayrhofer-geo-uri-00)
33-
* geo:54.0,8.0?q=(Hello)
34-
* displays "hello" at the location lat=54.0 north and lon= 8.0 east
35-
* geo:0,0?q=54.0,8.0(Hello)
36-
* displays "hello" at the location lat=54.0 north and lon= 8.0 east
37-
* geo:54.0,8.0?z=6
36+
* geo:0,0?q=53.0,8.0(Hello)
37+
* displays "hello" at the location lat=53.0 north and lon= 8.0 east.
38+
* in html you can use &lt;a href=&quot;geo:0,0?q=53.0,8.0(Hello)&quot;&gt;geo:0,0?q=53.0,8.0(Hello)&lt;/a&gt;
39+
* this format is compatible with google-maps for android
40+
* geo:53.0,8.0?q=(Hello)
41+
* displays "hello" at the location lat=53.0 north and lon= 8.0 east
42+
* this format is **not** compatible with google-maps for android
43+
* geo:53.0,8.0?z=6
3844
* displays a pin at the location using zoomlevel "6"
3945
* uri=file:/path/to/waypoints.gpx
4046
* displays a xml+gpx waypointfile

0 commit comments

Comments
 (0)