]> git.street.me.uk Git - andy/viking.git/blame - help/C/viking.xml
[DOC] Improve reference documentation for babel.c
[andy/viking.git] / help / C / viking.xml
CommitLineData
f8b8a0b5
GB
1<?xml version="1.0"?>
2<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4 <!ENTITY appname "Viking">
5 <!ENTITY app "<application>Viking</application>">
b6a29a6b 6 <!ENTITY appversion "1.2">
2d336346 7 <!ENTITY manrevision "0.2">
b6a29a6b 8 <!ENTITY date "June 2011">
f8b8a0b5
GB
9]>
10<!--
11 (Do not remove this comment block.)
12 Maintained by the GNOME Documentation Project
13 http://live.gnome.org/DocumentationProject
14 Template version: 3.0 beta
15 Template last modified 2006-11-21
16
17-->
18<!-- =============Document Header ============================= -->
19<article id="index" lang="en">
20 <articleinfo>
21 <title>&app; Manual</title>
22 <abstract role="description">
23 <para>&app; is a free/open source program to manage GPS data.</para>
24 </abstract>
25
26 <copyright>
27 <year>2009</year>
28 <holder>Guilhem Bonnefille</holder>
29 </copyright>
30
31 <!-- An address can be added to the publisher information. -->
32 <publisher role="maintainer">
33 <publishername>GNOME Documentation Project</publishername>
34 </publisher>
35
36 <xi:include href="legal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
37 <!-- The file legal.xml contains link to license for the documentation,
38 and other legal stuff such as "NO WARRANTY" statement.
39 Please do not change any of this. -->
40
41 <authorgroup>
42 <author>
43 <firstname>Guilhem</firstname>
44 <surname>Bonnefille</surname>
45 </author>
25c0a45b
RN
46 <author>
47 <firstname>Rob</firstname>
48 <surname>Norris</surname>
49 </author>
a43e638f
RN
50 <!-- Contributors from the Wiki history -->
51 <author>
52 <firstname>username:</firstname>
53 <surname>Alexxy</surname>
54 </author>
55 <author>
56 <firstname>username:</firstname>
57 <surname>Vikingis</surname>
58 </author>
59 <author>
60 <firstname>username:</firstname>
61 <surname>Tallguy</surname>
62 </author>
63 <author>
64 <firstname>username:</firstname>
65 <surname>EliotB</surname>
66 </author>
67 <author>
68 <firstname>Alex</firstname>
69 <surname>Foobarian</surname>
70 </author>
71 <!-- END -->
f8b8a0b5
GB
72 </authorgroup>
73
74 <revhistory>
75 <revision>
76 <revnumber>&appname; Manual V&manrevision;</revnumber>
77 <date>&date;</date>
78 <revdescription>
79 <para role="author">Guilhem Bonnefille <email>guilhem.bonnefille@gmail.com</email></para>
80 <para role="publisher">GNOME Documentation Project</para>
81 </revdescription>
82 </revision>
83 </revhistory>
84
4502fc82 85 <releaseinfo>This manual describes version &appversion; of &appname;.</releaseinfo>
f8b8a0b5
GB
86
87 <legalnotice>
88 <title>Feedback</title>
89 <para>To report a bug or make a suggestion regarding the &app; application or
90 this manual, follow the directions in the
91 <ulink url="ghelp:user-guide?feedback-bugs" type="help">Feedback section of the GNOME User Guide</ulink>.
92 </para>
93 </legalnotice>
94 </articleinfo>
95
96 <indexterm zone="index">
97 <primary>&app;</primary>
98 </indexterm>
99<!-- ============= Document Body ============================= -->
4502fc82 100<section id="introduction">
f8b8a0b5 101 <title>Introduction</title>
6928e16b 102<para>
7233fcb6
RN
103&appname; aims to be easy to use, yet powerful in accomplishing a wide
104variety of tasks. Some of the things you can use &appname; for are:
6928e16b
GB
105</para>
106<itemizedlist mark="opencircle"><listitem>
107<para>
108Uploading and downloading waypoints, tracks to/from GPS.
109</para>
110</listitem>
111<listitem>
112<para>Preparing tracks and waypoints for trips using maps from services
7233fcb6 113such as OpenStreetMap (OSM) and/or Terrasever. The data is only needed to be uploaded to
6928e16b
GB
114your GPS before you leave. The maps together with your tracks and
115waypoints can also be printed and used during the trip.
116</para>
117</listitem>
118<listitem>
119<para>
120After trips, tracks and waypoints from GPS can be downloaded, stored, managed and reused in your (or your friends') later trips.
121</para>
122</listitem>
123<listitem>
124<para>
9ca89c29 125Analyzing Off Highway Vehicle (OHV) and hiking trips, understanding where you went and how far you were from something.
6928e16b
GB
126</para>
127</listitem>
128<listitem>
129<para>Making waypoints and tracks to follow to easily get someplace
9ca89c29 130you've never been before or don't have GPS data for but online
6928e16b
GB
131maps exist for it.
132</para>
133</listitem>
134<listitem>
135<para>
136Making maps with coordinate lines.
137</para>
138</listitem>
139<listitem>
140<para>
141Grouping data from multiple trips using a hierarchical data manager.
142</para>
143</listitem>
144<listitem>
145<para>
146Analyzing speed at different places (to some degree), adding waypoints where you forgot to mark one but did slow down or stop.
147</para>
148</listitem>
149<listitem>
150<para>
9ca89c29 151Downloading and storing OSM and/or Terraserver maps on your hard drive and looking at them later.
6928e16b
GB
152</para>
153</listitem>
154<listitem>
155<para>
156Editing tracks and trackpoints, joining and splitting up tracks
157</para>
158</listitem>
0ef60ec1 159<listitem>
6928e16b 160<para>
9ca89c29 161Show the live GPS position on the map (for use on a mobile device - e.g. a laptop)
6928e16b
GB
162</para>
163</listitem>
9ca89c29
RN
164</itemizedlist>
165<note>
6928e16b 166<para>
9ca89c29 167&appname; is under continual improvement: see the potential areas in the <ulink url="http://sourceforge.net/apps/mediawiki/viking/index.php?title=Main_Page#TODO_.2F_Ideas"><citetitle>Roadmap / Wishlist</citetitle></ulink>:
6928e16b 168</para>
9ca89c29 169</note>
4502fc82 170</section>
7233fcb6 171
6928e16b 172<section><title>General Concepts</title>
7233fcb6
RN
173<section><title>Layers</title>
174<para>
175'Layers' is concept one may know from powerful graphics editors such as Photoshop or GIMP.
176Instead of putting all the data on the same level, it is stacked (i.e. layered) with different data over one another.
177This can make useful for analysis and general handling of various sets of data.
178</para>
179<para>
180Unfortunately the downside of this complexity is remembering how differing layers of data can obscure other data.
181</para>
182<para>
183The Map layers have <ulink url="http://en.wikipedia.org/wiki/Alpha_compositing"><citetitle>Alpha Compositing</citetitle></ulink>,
184to create the appearance of partial transparency.
185By controlling this value one can see data below it in the layer heirarchy for interesting effects.
186</para>
187</section>
188<section><title>Layers Panel</title>
6928e16b
GB
189<para>
190The panel on the left is called the <emphasis role="bold">layers panel</emphasis>.
191It determines which layers and sublayers (such as tracks and waypoints)
192are shown, and the order in which they are drawn. Layers list on the
193top of the layers panel are drawn last. You can change the order by
194drag and drop, or by selecting a layer and using the up and down
195buttons at the bottom of the layers panel.
196</para>
7233fcb6
RN
197</section>
198<section><title>Viewport</title>
6928e16b 199<para>
7233fcb6 200The main &appname; area where the layer data is drawn, is called the <emphasis role="bold">viewport</emphasis>.
6928e16b 201</para>
6928e16b 202</section>
7233fcb6 203<section><title>Statusbar</title>
7233fcb6 204<para>This provides a readout of various information:</para>
eabf51fc
GB
205<itemizedlist>
206<listitem><para>The currently selected (mouse pointer) tool</para></listitem>
207<listitem><para>The number of items to process in the background - normally this the number in the map tile download queue</para></listitem>
208<listitem><para>The zoom factor</para></listitem>
209<listitem><para>The location of the mouse pointer (and potentially height information if DEM data is available)</para></listitem>
210</itemizedlist>
7233fcb6 211</section>
d587678a
GB
212
213<section><title>Projections</title>
214<para>
215&appname; supports differents projections:
216<itemizedlist>
217<listitem>
218<para>UTM</para>
219</listitem>
220<listitem>
221<para>LatLon (also called EPSG:4326)</para>
222</listitem>
223<listitem>
224<para>Mercator (also called Spherical Mercator)</para>
225</listitem>
226</itemizedlist>
227</para>
228</section>
7233fcb6
RN
229</section>
230
6928e16b 231<section><title>Layers</title>
036c28fc 232
28f39a51
RN
233<para>
234Layers supported by &appname; are:
235</para>
236<itemizedlist>
237<listitem><para>Aggregate</para></listitem>
238<listitem><para>TrackWaypoint</para></listitem>
239<listitem><para>GPS</para></listitem>
240<listitem><para>DEM</para></listitem>
241<listitem><para>Coord</para></listitem>
242<listitem><para>GeoRef</para></listitem>
243</itemizedlist>
244<para>
245For each layer there are a few standard options:
246</para>
247<itemizedlist>
248<listitem><para>Properties - Layer setup / configuration settings</para></listitem>
249<listitem><para>Cut</para></listitem>
250<listitem><para>Copy</para></listitem>
251<listitem><para>Paste</para></listitem>
252<listitem><para>Delete</para></listitem>
253<listitem><para>Visibility - This checkbox on the Layers Panel controls whether the layer is shown in the viewport or not</para></listitem>
254</itemizedlist>
255<para>
256The cut/copy/paste options can be accessed in a variety of ways once the layer has been selected:
257</para>
258<itemizedlist>
259<listitem><para>Standard keys: <keycap>Ctrl+x|c|v</keycap></para></listitem>
260<listitem><para>Main menu <guimenuitem>Edit</guimenuitem></para></listitem>
261<listitem><para>From the right click menu</para></listitem>
262<listitem><para>Buttons at the bottom of the Layers Panel</para></listitem>
263</itemizedlist>
264<para>
265See the individual section for detail about each layer.
266</para>
267
268</section>
269
6928e16b
GB
270<section><title>TrackWaypoint Layer</title>
271<para>
272TrackWaypoint layers display GPS data (tracks and waypoints).
273</para>
7233fcb6 274<para>One way to create new waypoints is to copy a
6928e16b 275latitude/longitude coordinate pair, such as the one shown on most
0ef60ec1
GB
276geocaches, and paste it into an active TrackWaypoint layer. &appname; can
277automatically recognize several variations of the lat/lon format.
278</para>
6928e16b
GB
279<para>
280By right-clicking tracks and waypoints in the layers panel, you can do
281many things with tracks and waypoints. You can easily find a specific
282track or waypoint by expanding the Tracks or Waypoints sublayers in the
283layers panel to show all tracks or waypoints, and typing the name of
284the track/waypoint.
285</para>
036c28fc 286
6928e16b
GB
287<section><title>Layer Operations</title>
288<para>
289The layer has a context menu with several operations.
290</para>
036c28fc
RN
291
292<section><title>View Layer</title>
293<para>
294Version1.1+: This will automatically move the viewport and select the best zoom level to see the whole layer (i.e. tracks and waypoints).
295</para>
296</section>
297
298<section><title>View All Tracks</title>
299<para>
300Version1.1+: This will automatically move the viewport and select the best zoom level to see the all the tracks in the layer (ignoring positions of any waypoints).
301</para>
302</section>
303
304<section><title>View All Waypoints</title>
305<para>
306Version1.1+: This will automatically move the viewport and select the best zoom level to see the all the waypoints in the layer (ignoring positions of any tracks).
307</para>
308</section>
309
310<section><title>Goto Center of Layer</title>
311<para>
312This will automatically move the viewport to see the whole layer (i.e. tracks and waypoints). It does not adjust the zoom level.
313</para>
314</section>
315
316<section><title>Goto Waypoint</title>
317<para>
318This opens a dialog box to enter a name of waypoint to search for. If it is found the viewport is centred on it.
319</para>
320<note>
321<para>
322Note this search is not very clever and only finds exact matches.
323You are probably better off expanding the waypoint list and directly start typing, as mentioned above, which finds a match based on each letter typed.
324</para>
325</note>
326</section>
327
328<section><title>Export Layer</title>
329<para>
ba9d0a00 330The layer (all tracks and waypoints) can be exported to a file GPX, GPSPoint, GPSMapper or Google's KML format.
036c28fc
RN
331</para>
332<para>
333Version1.1+: An individual track can be exported to a GPX file via the track menu.
334</para>
335</section>
336
cc1083b3 337<section id="new_wp"><title>New Waypoint</title>
036c28fc
RN
338<para>
339This opens a dialog box to create a new waypoint. A default name will be suggested and the default position is the center of the viewport.
340</para>
341</section>
342
343<section><title>Add Wikipedia Waypoints</title>
344<para>
345This gets 'interesting' points from Wikipedia for the specified view: either within the extent of layer bounds or within the current viewport boundary.
346</para>
347</section>
348
349<section id="osm_upload"><title>Upload To OSM</title>
350<para>
351This opens a dialog to upload all tracks and waypoints to OSM traces.
352Useful if you are an OSM contributor (you will need an OSM account), these details can be stored in &appname; preferences.
353</para>
6928e16b 354<para>
036c28fc 355 &appname; allows you to edit a track, e.g. remove duplicate points, perhaps remove track points leading to your home and then upload it to OSM.
6928e16b 356</para>
0ef60ec1 357<note>
6928e16b 358<para>
036c28fc
RN
359 <emphasis role="bold">Warning!</emphasis>
360The password is transferred <emphasis role="bold">unencrypted</emphasis> in every request sent to the OSM server. This is due to OSM's basic authentication method.
6928e16b 361</para>
0ef60ec1 362</note>
036c28fc 363</section>
6928e16b 364
036c28fc
RN
365<section><title>Filter</title>
366<section><title>Simplify All Tracks</title>
367<para>
368This opens dialog to request the number of points each track will be simplified using <application>GPSBabel</application>. The result is put into a new layer. The simplification method removes points considered to be in a 'near straight line', thus reducing the number of points and attempting to keep the most important turning points.
369</para>
370</section>
371<section><title>Remove Duplicate Waypoints</title>
372<para>
373Remove Duplicate Waypoints - fairly self explainatory, with the results created in a new layer.
374</para>
375<note>
376<para>
377However it only considers a precise position (waypoints only 1 metre away from each other are considered different) and also doesn't consider if the waypoints have different comments, symbols or images.
378</para>
379</note>
380</section>
6928e16b
GB
381</section>
382
036c28fc
RN
383<section id="filter_with_track"><title>Filter With <emphasis>Trackname</emphasis></title>
384<para>
385This runs <application>GPSBabel</application> on the layer using information from a previously selected track (select via the track menu "Use With Filter" option) with the following command types:
386</para>
387<itemizedlist>
388<listitem><para>Waypoints Inside This</para></listitem>
389<listitem><para>Waypoints Outside This</para></listitem>
390</itemizedlist>
391<para>
392The result is generated in a new Track/Waypoint layer.
393</para>
6928e16b 394</section>
036c28fc
RN
395
396</section><!-- End TRW Layer Options -->
397
6928e16b
GB
398<section><title>Track Properties</title>
399<para>
400Show many useful statistics about a track, including a
401elevation-distance graph and a speed-time graph (if data is available).
402You can click these graphs to jump to the point in the track. You can
403also reverse a track, delete duplicates, and split a track from its
404component segments (discontinuous breaks in a track) into separate
405tracks.
406</para>
407<para>
408The following colors are used in the elevation-distance graph:
409</para>
0ef60ec1
GB
410<variablelist>
411<varlistentry>
7233fcb6 412<term>'Main' colour - this is dependent on your Desktop theme - often blue by default</term>
0ef60ec1
GB
413<listitem><para>elevation data in graph</para></listitem>
414</varlistentry>
415<varlistentry>
416<term>Yellow</term>
6928e16b 417<listitem>
0ef60ec1 418<para>no elevation data</para>
6928e16b 419</listitem>
0ef60ec1
GB
420</varlistentry>
421<varlistentry>
422<term>Green</term>
6928e16b 423<listitem>
0ef60ec1 424<para>elevation data from DEM</para>
6928e16b 425</listitem>
0ef60ec1
GB
426</varlistentry>
427<varlistentry>
428<term>Red</term>
6928e16b 429<listitem>
0ef60ec1 430<para>speed</para>
6928e16b 431</listitem>
0ef60ec1
GB
432</varlistentry>
433</variablelist>
6928e16b
GB
434
435</section>
d45662d5 436
6928e16b 437<section><title>Track Operations</title>
d45662d5
RN
438
439<section><title>Goto</title>
440<para>
441This centers the viewport on the selected position on the track:
442</para>
443<itemizedlist>
444<listitem><para>Startpoint</para></listitem>
445<listitem><para>"Center" - the notional center from the bounds of the track</para></listitem>
446<listitem><para>Endpoint</para></listitem>
447<listitem><para>Version1.1+: Highest Altitude</para></listitem>
448<listitem><para>Version1.1+: Lowest Altitude</para></listitem>
449<listitem><para>Version1.1+: Maximum Speed</para></listitem>
450</itemizedlist>
451</section>
452
453<section><title>View</title>
454<para>
455Version1.1+: This centers the viewport on the track and selects the best zoom level to see it.
456</para>
457</section>
458
459<section><title>Merge By Time</title>
0ef60ec1
GB
460<para>
461This operation repeatedly tries to merge the right-clicked track
6928e16b
GB
462with tracks in the same TrackWaypoint layer. The tracks which are
463merged are those which have at least one trackpoint less than some
464threshold time away. This way, if you somehow end up with lots of small
465segments (say, caused by turning the GPS on and off) you can merge them
0ef60ec1
GB
466easily into one track.
467</para>
d45662d5 468</section>
6928e16b 469
d45662d5
RN
470<section><title>Merge With Other Tracks</title>
471<para>
472This opens a dialog listing the other tracks in the same TrackWaypoint layer, from which one can select the other tracks to merge with.
473</para>
6928e16b 474</section>
d45662d5
RN
475
476<section><title>Split By Time</title>
6928e16b
GB
477<para>
478This operation will split a single track into segments wherever the
479time interval between successive trackpoints is larger than some
480threshold. This is useful when processing raw NMEA GPS data, especially
0ef60ec1
GB
481taken over a long time.
482</para>
6928e16b 483</section>
d45662d5 484
43e67498
RN
485<section><title>Split By Number of Points</title>
486<para>
487Version1.2+: This operation will split a single track into segments by the number of points specified.
488This can be useful with devices which may have limits on the number of points it supports.
489</para>
490</section>
491
6928e16b
GB
492<section><title>Apply DEM data</title>
493<para>
494If any DEM data is loaded, this will apply the DEM data to give the track elevation data.
495</para>
d45662d5 496</section>
6928e16b 497
d45662d5
RN
498<section><title>Export Track as GPX</title>
499<para>
500Version1.1+: This allows exporting the track as a GPX file by opening a file save dialog.
501</para>
6928e16b 502</section>
d45662d5
RN
503
504<section><title>Extend Track End</title>
6928e16b 505<para>
d45662d5 506Changes the current tool to add trackpoints to the end of the track.
6928e16b 507</para>
d45662d5 508</section>
6928e16b 509
0db79fc5 510<section><title>Extend Using Route Finder</title>
d45662d5 511<para>
0db79fc5 512Enables the Route Finder tool. Thus on a subsequent left click in the viewport, a route is calculated from the end of track to that point using Google's route service and applied to the track.
d45662d5 513</para>
6928e16b 514</section>
d45662d5 515
6928e16b
GB
516<section><title>Upload to OSM</title>
517<para>
d45662d5 518Same as the layer <link linkend="osm_upload">Upload to OSM</link>, but only applies to the track.
6928e16b 519</para>
d45662d5 520</section>
6928e16b 521
d45662d5
RN
522<section><title>Use With Filter</title>
523<para>
524This selects the track to be used in the <link linkend="filter_with_track">Filter With <emphasis>Trackname</emphasis></link> feature.
525</para>
6928e16b 526</section>
d45662d5 527
6928e16b 528<section><title>View Google Directions</title>
0ef60ec1 529<para>
0db79fc5 530This option is only available on a track created using the Route Finder tool.
d45662d5
RN
531</para>
532<para>
533Launch a web browser to see the Google directions page which yielded the route.
0ef60ec1
GB
534</para>
535<note>
536<para>
0db79fc5 537The record of the Google route is stored in the track's comment, so if the comment is changed (or the route was created by something other than the Route Finder tool) this will not work correctly.
6928e16b 538</para>
0ef60ec1 539</note>
6928e16b
GB
540</section>
541
d45662d5 542</section><!-- End Track Options -->
cc1083b3 543
440ef68c
RN
544<section><title>Waypoint Properties</title>
545
546<para>
547This shows a dialog with detailed information for the waypoint. Many properties of the waypoint can changed here, such as the comment, the symbol used in drawing or the image (normally a photograph taken at this position) assiocated with it. When a waypoint has an image, a thumbnail of it is drawn in the viewport for the waypoint (in preference to the symbol).
548</para>
549
550</section><!-- WP Prop END -->
551
6928e16b 552<section><title>Waypoint Operations</title>
cc1083b3
RN
553
554<section><title>Goto</title>
6928e16b 555<para>
cc1083b3 556This centers the viewport on the selected waypoint.
6928e16b 557</para>
cc1083b3 558</section>
6928e16b 559
cc1083b3
RN
560<section><title>Visit Geocache Webpage</title>
561<para>
562If the waypoint's name is in Geocache form (GCXXXXX) you can launch a web browser to go to the Geocache page.
563</para>
6928e16b
GB
564</section>
565
cc1083b3
RN
566<section><title>New Waypoint</title>
567<para>
568Same as the layer <link linkend="new_wp">New Waypoint</link>.
569</para>
6928e16b
GB
570</section>
571
cc1083b3
RN
572</section><!-- WP END -->
573
036c28fc
RN
574</section><!-- TRW Layer END -->
575
7233fcb6 576<section><title>GPS Layer</title>
0ef60ec1 577<para>
7233fcb6 578The GPS layer is responsible for uploading and downloading GPS data
6928e16b 579from a GPS device. It also is responsible for realtime GPS tracking.
ca2f3f23 580Expand the GPS layer in the layers panel to see the two TrackWaypoint layers it
6928e16b 581uses for uploading and downloading. To upload, download, or use
7233fcb6 582realtime tracking, right-click the GPS layer and click the appropiate
6928e16b
GB
583menu item.
584</para>
0ef60ec1 585
6928e16b
GB
586<section><title>Download</title>
587<para>
7233fcb6 588To download data from the GPS, right-click the GPS layer and click <guimenuitem>Download from GPS</guimenuitem>.
6928e16b 589</para>
6928e16b 590</section>
ca2f3f23 591
6928e16b 592<section><title>Upload</title>
0ef60ec1
GB
593<para>
594To upload data to the GPS, first populate the GPS Upload child
6928e16b
GB
595layer of the GPS layer (either by creating waypoints/tracks in it, or
596copying and pasting or dragging waypoints/tracks from another layer).
7233fcb6 597Then right-click the GPS layer and click <guimenuitem>Upload to GPS</guimenuitem>.
6928e16b 598</para>
6928e16b 599</section>
ca2f3f23 600
7233fcb6 601<section><title>Realtime Tracking</title>
0ef60ec1
GB
602<para>
603You must set up gpsd correctly or use a GPSD server and put the
7233fcb6
RN
604correct information in the GPS layer properties dialog. Then right-click
605the layer and select <guimenuitem>Start Realtime Tracking</guimenuitem>.
6928e16b 606</para>
6928e16b
GB
607</section>
608
ca2f3f23
RN
609<section><title>Empty <emphasis>Item</emphasis></title>
610<para>
611There are several options to quickly delete a subsection of data:
612</para>
613<itemizedlist>
614<listitem><para>Empty Realtime</para></listitem>
615<listitem><para>Empty Upload</para></listitem>
616<listitem><para>Empty Download</para></listitem>
617<listitem><para>Empty All</para></listitem>
618</itemizedlist>
6928e16b 619</section>
ca2f3f23
RN
620
621</section><!-- End GPS -->
622
6fa00cca 623<section><title> DEM (Digital Elevation Model) Layer</title>
6928e16b 624<para>
6fa00cca 625This layer provides elevation data from the <ulink url="http://www2.jpl.nasa.gov/srtm/">Shuttle Radar Topography Mission (SRTM)</ulink>
6928e16b 626</para>
6fa00cca
RN
627<para>
628Elevation data can be useful in planning trips, as you many wish to avoid/minimise the hills encountered. [OSM Cyclemap is also useful this way too]
629</para>
630<para>
631To download the data use the DEM Download tool (shown on the toolbar), and then click on a area of the viewport. Once files have been downloaded they can then be loaded from disk via the DEM properties in future application runs.
632</para>
633<para>
634The current data server is: <ulink url="http://dds.cr.usgs.gov/srtm/version2_1/">NASA STRM 2.1</ulink>.
635</para>
636<para>
637ATM &appname; does not auto download DEM data. If you want to get lots of data blocks, you may wish to use some other program get such as <application>curl</application> or <application>wget</application> to download them for an area.
638</para>
639<note>
640<para>
641Using many DEMs is CPU/memory intensive. Depending on your computer's capability, &appname; will be less responsive when about 50+ DEM blocks are loaded. It is probably unwise to attempt using 200+ blocks, so trying to use DEMs covering large countries/continents (USA, Australia etc...) is unlikely to work. In these conditions under Linux, &appname; may be automatically stopped by the "<ulink url="http://en.wikipedia.org/wiki/Out_of_memory/">OOM</ulink> Killer"
642</para>
643</note>
6928e16b 644
6fa00cca 645</section><!-- End DEM -->
6928e16b 646
f1b908b1
RN
647
648<section><title>Maps Layer</title>
649<para>
650This layer provides a single map resource, you may have multiple map layers but only top one (if enabled) will be visible.
651You will need an open internet connection when you are downloading maps, but once downloaded they are available from the hard disk cache. When map are avaliable from the disk cache it is much faster and can be used offline.
652</para>
653<para>
654Some maps are continually improving over time (e.g. OSM) and so in order to not to have to (re)download the data all the time &appname; employs a timeout method - 'Tile Age' to determine whether to access the server. However a forced refresh for the current view can be made via the <guilabel>Reload All Onscreen Maps</guilabel> option.
655</para>
656<para>
657Inbuilt maps include various <ulink url="http://en.wikipedia.org/wiki/TerraServer-USA">Terraserver</ulink> (Primarily USA coverage) and <ulink url="http://en.wikipedia.org/wiki/OpenStreetMap">OpenStreetMap (OSM)</ulink> ones and more:
658</para>
659<itemizedlist>
660<listitem><para>Terraserver Topos</para></listitem>
661<listitem><para>Terraserver Aerials</para></listitem>
662<listitem><para>Terraserver Urban Areas</para></listitem>
663<listitem><para>OpenStreetMap (Osmarender)</para></listitem>
664<listitem><para>OpenStreetMap (Mapnik) - This is the default</para></listitem>
665<listitem><para>OpenStreetMap (Maplint)</para></listitem>
666<listitem><para>OpenStreetMap (Cycle)</para></listitem>
667<listitem><para>NASA BlueMarble</para></listitem>
668<listitem><para>SpotMap (&appname; Version1.1+)</para></listitem>
669</itemizedlist>
670
671<para>
672&appname; can be configured to handle additional maps. See <link linkend="extend_viking">Extending &appname;</link> for further detail.
673</para>
674
675<section><title>Layer Operations</title>
676<section><title>Download Missing Onscreen Maps</title>
677<para>
678This requests map tiles for areas of the viewport that do not currently have one.
679</para>
680</section>
681
682<section><title>Download New Onscreen Maps</title>
683<para>
684This requests map tiles only if the maps are older than the Tile Age preference.
685</para>
686</section>
687
688<section><title>Reload All Onscreen Maps</title>
689<para>
690Force a refresh of all visible map tiles.
691</para>
692</section>
693</section>
694
695
696</section><!-- End Maps -->
697
ce269944
RN
698<section><title>Aggregrate Layer</title>
699<para>
700This layer is a container layer to hold other layers. There is always an initial and controlling 'Top Layer' that can not be removed, although it can be renamed.
701</para>
702<para>
703This layer type is useful for grouping other layers, especially TrackWaypoint layers, in whatever categories are relevant to you: such as by activity, location or date.
704Here are some suggestions:
705<itemizedlist>
706<listitem><para>Hiking</para></listitem>
707<listitem><para>Mountain Biking</para></listitem>
708<listitem><para>Road Cycling</para></listitem>
709<listitem><para>Car Trips</para></listitem>
710<listitem><para>Sailing</para></listitem>
711<listitem><para>Holidays</para></listitem>
712<listitem><para>UK Points of Interest</para></listitem>
713<listitem><para>USA Points of Interest</para></listitem>
714<listitem><para>etc...</para></listitem>
715</itemizedlist>
716</para>
717<para>
718Thus one can have a list of all your tracks, but groups can be shown or not using the relevant layers visibility checkbox.
719</para>
720
721<para>
722This layer only has one operation: <guilabel>New Layer</guilabel>
723</para>
724
725<section><title>New Layer</title>
726<para>
727Add a new layer of the selected type.
728</para>
729</section>
730
731</section><!-- End Agg -->
732
733<section><title>GeoRef Layer</title>
734<para>
735This layer allows one to use any image as a map. You will need to tell it how to align the map to a position in the world and the scale of map.
736</para>
737<section><title>Layer Operations</title>
738<section><title>Zoom to Fit Map</title>
739<para>
740Automatically set a zoom level to see the entire map coverage.
741</para>
742</section>
743
744<section><title>Goto Map Center</title>
745<para>
746Center the viewport on this map.
747</para>
748
749</section>
750<section><title>Export to World File</title>
751<para>
752Opens a file save dialog to save the scale and position information as a <ulink url="http://en.wikipedia.org/wiki/World_file">World File</ulink>.
753</para>
754</section>
755</section>
756
757</section><!-- End GeoRef -->
758
759<section><title>Coord Layer</title>
760<para>
761This layer is allows drawing of grid lines on the viewport.
762</para>
763</section><!-- End Coord -->
764
6928e16b
GB
765<section><title>Tools</title>
766<para>
767You can use the scroll wheel and the right-click to zoom and pan no matter what tool you are using.
768</para>
769<para>
f95c9f7c 770Scroll: zoom in and out without changing the center (also Ctrl+, Ctrl- [*not* KeyPad +/-])
6928e16b
GB
771</para>
772<para>
773Ctrl-scroll: pan north-south (also Ctrl-up, Ctrl-down)
774</para>
775<para>
776Shift-scroll: pan east-west (also Ctrl-left, Ctrl-right)
777</para>
778<para>
779Ctrl-shift-scroll: zoom in and out, keeping mouse over same location (like Google maps)
780</para>
781<para>
f95c9f7c 782Left or Middle-click: make the clicked point on the map the center
6928e16b
GB
783</para>
784<para>
785Middle-click and drag: pan
786</para>
f95c9f7c 787
6928e16b
GB
788<section><title>Zoom</title>
789<para>
790Zooms in and out on the clicked part of the map.
791</para>
6928e16b 792</section>
f95c9f7c 793
6928e16b 794<section><title>Ruler</title>
9ca89c29
RN
795<para>
796The ruler is used to measure the bearing and distance between two points: Click on first point and then move the mouse point around - the values will be continually updated.
797A second click will 'freeze' the ruler at that point.
6928e16b 798</para>
6928e16b 799</section>
f95c9f7c 800
6928e16b
GB
801<section><title>TrackWaypoint Layer Tools</title>
802<para>
f95c9f7c 803You must have a TrackWaypoint Layer selected to use these tools.
6928e16b 804</para>
f95c9f7c 805<section><title>Create Waypoint</title>
6928e16b 806<para>
f95c9f7c 807Left click will open the new waypoint dialog using the specified position.
6928e16b 808</para>
f95c9f7c
RN
809</section>
810
811<section><title>Create/Begin Track</title>
6928e16b 812<para>
f95c9f7c
RN
813Left click to create a new trackpoint. If it's the initial trackpoint you will be asked to enter a name for the track.
814If <keycap>Ctrl</keycap> is held at the same time, it will jump the new trackpoint position to a nearby existing trackpoint.
815Right click or <keycap>Backspace</keycap> : undo one point.
6928e16b
GB
816</para>
817<para>
f95c9f7c 818Double click or <keycap>Escape</keycap> : finish track creation.
6928e16b 819</para>
6928e16b 820</section>
f95c9f7c 821
6928e16b
GB
822<section><title>Edit Waypoint</title>
823<para>
f95c9f7c
RN
824Left Click/drag: select/move a waypoint.
825If <keycap>Ctrl</keycap> is held at the same time, it will jump the waypoint position to a nearby existing trackpoint.
826If <keycap>Shift</keycap> is held at the same time, it will jump the waypoint position to a nearby existing waypoint.
6928e16b
GB
827</para>
828<para>Right-click on waypoint: opens a menu with waypoint actions (the
829same menu accessed by right-clicking the waypoint in the layers panel)
830</para>
6928e16b 831</section>
f95c9f7c 832
6928e16b
GB
833<section><title>Edit Trackpoint</title>
834<para>
f95c9f7c
RN
835Left click near a trackpoint (in screen pixel terms) to bring up the Track Point Edit dialog on that trackpoint.
836Whilst the edit dialog is already open, left click again and drag enables moving of the trackpoint.
837If <keycap>Ctrl</keycap> is held at the same time, it will jump the new trackpoint position to a nearby existing trackpoint.
6928e16b
GB
838</para>
839<para>
f95c9f7c 840Options in the Track Point Edit dialog include: change position, go to next, go to previous, delete, insert (halfway to next trackpoint) and splitting the track.
6928e16b 841</para>
6928e16b 842</section>
f95c9f7c 843
6928e16b
GB
844<section><title>Show Picture</title>
845<para>
f95c9f7c
RN
846Opens an image viewer with the picture associated with the waypoint.
847On Linux this uses <application>eog</application>.
848On Windows this uses the default system image viewer.
6928e16b 849</para>
6928e16b 850</section>
f95c9f7c 851
0db79fc5 852<section><title>Route Finder</title>
6928e16b 853<para>Creates a track using Google maps routing between two points.
f95c9f7c 854Requires an internet connection. Click one point, then click another to
6928e16b
GB
855create a track.
856</para>
857<para>
f95c9f7c 858Right-click: undo last routing (only track removed - not any waypoints)
6928e16b
GB
859</para>
860<para>
f95c9f7c 861<keycap>Ctrl</keycap>: continue previous track
6928e16b 862</para>
6928e16b
GB
863</section>
864
865</section>
f95c9f7c 866
6928e16b
GB
867<section><title>Georef Map Layer Tools</title>
868<para>
869You must have a Georef Map Layer selected to use these tools.
870</para>
871<section><title>Georef zoom</title>
872<para>Changes the zoom level of the georeferenced map and changes the
7233fcb6 873&appname; zoom level accordingly. Useful if you are trying to match GPS
6928e16b
GB
874data to a georeferenced map.
875</para>
6928e16b 876</section>
f95c9f7c 877
6928e16b
GB
878<section><title>Georef move</title>
879<para>
880Drag to move the georeferenced map.
881</para>
6928e16b 882</section>
6928e16b 883</section>
f95c9f7c 884
6928e16b
GB
885<section><title>Map Download</title>
886<para>
f95c9f7c
RN
887You must have a Map Layer selected to use this.
888</para>
889<para>
6928e16b
GB
890Click to download a single tile. Drag to download tiles in the dragged rectangle area.
891</para>
892<para>
893Right-click to redownload bad/all tiles. Right-click and drag to redownload bad/all tiles in the dragged rectangle area.
894</para>
6928e16b 895</section>
f95c9f7c 896
6928e16b
GB
897<section><title>DEM Download</title>
898<para>
f95c9f7c
RN
899You must have a DEM Layer selected to use this.
900</para>
901<para>
6928e16b
GB
902Click to download and import a DEM file.
903</para>
6928e16b
GB
904</section>
905
7233fcb6 906<section><title>Webtools</title>
5ab84304
GB
907<para>
908Many services are available only via a web browser (Google Maps, OpenStreetMap Potlach editor, etc.).
909</para>
910<para>
911Jumping from &app; to such service can become annoying.
912</para>
913<para>
0ef60ec1 914&appname; allows you to open such service directly at the position currently viewed in &app;.
5ab84304
GB
915</para>
916<para>
7233fcb6 917This feature is called <guilabel>Webtools</guilabel>. It is also known as External Tools.
5ab84304 918</para>
5ab84304
GB
919</section>
920
3e850af1 921</section>
f95c9f7c 922
0ef60ec1 923<!-- Preferences -->
3e850af1
GB
924<section><title>Preferences</title>
925<section><title>Localisation</title>
926<para>You can select units displayed by &appname; to best fit your usage.</para>
927<figure>
928<title>Properties dialog: units part</title>
929<screenshot>
930 <graphic format="PNG" fileref="figures/properties_units.png"/>
931</screenshot>
932</figure>
933<para>Concerning degrees, you can select the way to display them:
934<variablelist>
935<varlistentry>
936<term>DDD</term><listitem><para>decimal degree</para></listitem>
937</varlistentry>
938<varlistentry>
939<term>DDD</term><listitem><para>partial sexagesimal display: degrees, minutes and décimal part of minutes</para></listitem>
940</varlistentry>
941<varlistentry>
942<term>DMS</term><listitem><para>sexagesimal display: degrees, minutes and seconds</para></listitem>
943</varlistentry>
944</variablelist>
945</para>
946<figure>
947<title>Properties dialog: degree display options</title>
948<screenshot>
949 <graphic format="PNG" fileref="figures/properties_degree.png"/>
950</screenshot>
951</figure>
952</section>
a067ca58
GB
953<section><title>Tile's age</title>
954<para>This age is used to decided wether or not a new request to tile server must be done.
955</para>
956<para>Changing this value, you will increase or decrese the network load.</para>
957</section>
897e919b
GB
958<section><title>Default maplayer directory</title>
959<para>This property sets the default directory of the tiles cache.
960This value is used when you create a new map layer.
961</para>
962<para>You are still able to change this value in each map layer properties.</para>
963</section>
6928e16b
GB
964</section>
965<section><title>Mini-Howto's</title>
966<section><title>Getting Started</title>
967<para>
0ef60ec1 968To quickly get started using &appname;, follow these instructions.
6928e16b
GB
969</para>
970<section><title>Go to an area of interest</title>
971<para>
9ca89c29 972&appname;'s default location is a Manhatten, New York, USA, so you may need to pick another place that interests you.
6928e16b 973</para>
0ef60ec1
GB
974<procedure>
975<title>Method A</title>
976<step>
6928e16b 977<para>
0ef60ec1 978Use View - Go to to move to a coordinate of interest.
6928e16b 979</para>
0ef60ec1
GB
980</step>
981</procedure>
982<procedure>
983<title>Method B</title>
984<step>
7233fcb6
RN
985<para>Use the GPS Layer or <menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From GPS</guimenuitem></menuchoice>
986to load data directly from your GPS into &appname;.
4136d029 987Currently Garmin, Magellan, DeLorme and Navilink protocols are supported.
0ef60ec1 988</para>
7233fcb6
RN
989<note>
990<para>You must have write permission to the port used. For Unix like OS:</para>
991<para>/dev/ttyS0 is the first serial port</para>
992<para>/dev/ttyUSB0 is the first USB port</para>
993</note>
ad606d98 994<note><para>For DeLorme device support you will need GPSBabel v1.4.0+ installed</para></note>
0ef60ec1
GB
995</step>
996</procedure>
997<procedure>
998<title>Method C</title>
999<step>
1000<para>Get data from files in GPX format. For other formats (kml,
1001ozi...), use a converter such as GPSBabel to convert the files to GPX
1002format first.
6928e16b 1003</para>
0ef60ec1
GB
1004</step>
1005<step>
6928e16b 1006<para>
7233fcb6 1007Open up &appname; and use File - Open or File - Append
0ef60ec1 1008file to open the file.
6928e16b 1009</para>
0ef60ec1
GB
1010</step>
1011<step>
6928e16b 1012<para>
0ef60ec1 1013Expand Tracks or Waypoints. Right-click on the
7233fcb6 1014track or waypoint of interest and select <guimenuitem>Goto "Center"</guimenuitem>.
6928e16b 1015</para>
0ef60ec1
GB
1016</step>
1017</procedure>
1018<procedure>
1019<title>Method D</title>
1020<step>
6928e16b 1021<para>
0ef60ec1 1022Use File - Append File to add your track and waypoint data to
7233fcb6 1023&appname;. This has been tested with Geocaching.com's *.loc format,
0ef60ec1
GB
1024(others(?)).
1025</para>
1026</step>
1027<step>
1028<para>
1029Expand Tracks or Waypoints. Right-click on the tack or
7233fcb6 1030point of interest and select <guimenuitem>Goto "Center"</guimenuitem>.
0ef60ec1
GB
1031</para>
1032</step>
1033</procedure>
6928e16b
GB
1034</section>
1035<section><title>Add a map layer</title>
1036<para>
10371. Use Layers - New Map Layer, and choose a suitable cache directory
0ef60ec1 1038where you would like to store your tracks and click <guilabel>OK</guilabel>. Zoom to a
6928e16b
GB
1039comfortable level (I suggest 4 mpp) by clicking the left and right
1040mouse buttons on the gray area where your tracks are. Now from the menu
1041choose Tools - Map Download, Click where you would like to download a
1042map. Regardless of what tool you are using, the middle mouse button
1043always pans. </para>
0ef60ec1 1044<note>
6928e16b 1045<para>
9ca89c29 1046You need an open internet connection when you are downloading maps.
6928e16b 1047</para>
0ef60ec1 1048</note>
6928e16b
GB
1049<para>
10501. You will notice the maps are being drawn on top of the tracks, which
1051is probably not what you want. Look at the Layers Panel to the left.
1052Notice how the layer named Map is ABOVE your TrackWaypoint layer that
1053your GPS data is in. This means that it will be drawn last, or on top
1054of the other layers. Select the Map layer from the list and click the
1055down arrow button beneath the list. Your tracks will now be drawn over
1056the map. </para>
1057
1058</section>
1059
1060</section>
7233fcb6 1061<section><title>From 1st startup to GPS track (including offline maps)</title>
6928e16b 1062<para>
7233fcb6
RN
1063The first you'll see is an empty map, because &appname; in its default configuration will download maps only on demand.
1064Before fetching unneeded data, one can position to a location of interest, e.g. Stuttgart: <menuchoice><guimenu>View</guimenu><guimenuitem>Go to Location</guimenuitem></menuchoice>, enter 'Stuttgart'.
6928e16b
GB
1065</para>
1066
6928e16b
GB
1067<section><title>Fetching the maps</title>
1068<para>
0ef60ec1 1069<emphasis role="bold">Map</emphasis>
6928e16b 1070</para>
0ef60ec1 1071<procedure>
7233fcb6 1072<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New Map Layer</guimenuitem></menuchoice></para></step>
4502fc82 1073<step><para>in the layer properties dialogue choose e.g. <guilabel>OpenStreetMap (Mapnik)</guilabel>.</para></step>
0ef60ec1 1074<step>
4502fc82
GB
1075<para>For the moment, we keep the default <guilabel>Maps Directory</guilabel> (the directory in
1076which the maps will be stored and can be used for offline usage).</para>
0ef60ec1
GB
1077</step>
1078<step>
1079<para>Check <guilabel>Autodownload maps</guilabel> and keep the zoom level as <guilabel>Use Viking
1080Zoom Level</guilabel>.</para>
1081<note>
1082<para>
1083however, that these settings will play an important
1084role in the pre-fetch for offline usage discussed later
1085</para>
1086</note>
1087</step>
1088</procedure>
6928e16b
GB
1089<para>You'll see a map of Stuttgart. Using the mouse wheel, you can
1090zoom in and out. The maps for the choosen resoltion will be downloaded
1091automatically.
1092</para>
1093<para>
7233fcb6 1094<emphasis role="bold">DEM Layer (Height Map)</emphasis>
4502fc82 1095</para>
0ef60ec1 1096<procedure>
7233fcb6
RN
1097<step><para>Zoom out to 512.</para></step>
1098<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New DEM Layer</guimenuitem></menuchoice></para></step>
4502fc82 1099<step><para>Keep the download source as is (SRTM Global 90m), hit <guilabel>OK</guilabel>.</para></step>
0ef60ec1 1100</procedure>
4502fc82 1101
6928e16b
GB
1102<para>In the layer listing on the left, the DEM layer should reside
1103above the map layer. If this is not the case, highlight the DEM layer
0ef60ec1 1104an shift it one up (using the arrow up button).
4502fc82 1105</para>
0ef60ec1 1106<procedure>
4502fc82
GB
1107<step><para>highlight the DEM layer in the layer listing on the left</para></step>
1108<step><para>in the toolbar, check DEM layer download/import (the last symbol)</para></step>
1109<step><para>a left-click in the map window should then fetch the DEM data</para></step>
0ef60ec1 1110</procedure>
0ef60ec1 1111<para>
7233fcb6 1112This might take some time.
6928e16b
GB
1113</para>
1114<para>
1115Sometimes, a tile does not show up correctly (you might see only a
1116black frame in the map window) because it got corrupted during
0ef60ec1 1117transfer. In order to correct this, you can delete the corresponding
7233fcb6 1118datafile in the cache. <programlisting> right-click the DEM layer properties</programlisting>
6928e16b
GB
1119</para>
1120<para>
0ef60ec1 1121The <guilabel>DEM Files</guilabel> listing allows you to delete the specific tiles (alternatively do this from the command line).
6928e16b
GB
1122</para>
1123<para>
0ef60ec1 1124You can also alter the Min. and Max. elevation in this dialogue.
6928e16b
GB
1125</para>
1126
1127</section>
7233fcb6 1128<section><title>GPS Track with Height Profile</title>
0ef60ec1
GB
1129<procedure>
1130<step><para>uncheck the DEM layer (the map show up again)</para></step>
7233fcb6 1131<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New TrackWaypoint Layer</guimenuitem></menuchoice></para></step>
0ef60ec1 1132</procedure>
6928e16b 1133<para>
7233fcb6 1134Ensure the new track layer is above the map layer.
4502fc82 1135</para>
0ef60ec1
GB
1136<procedure>
1137<step><para>expand trackwaypointlayer, select <guimenuitem>Tracks</guimenuitem></para></step>
7233fcb6
RN
1138<step>
1139<para>
1140in the tools menu choose <guimenuitem>Begin Track</guimenuitem> which looks like this:
1141<figure>
1142<title>Begin Track Icon</title>
1143<screenshot>
1144 <graphic format="PNG" fileref="figures/begintr_18.png"/>
1145</screenshot>
1146</figure>
1147</para></step>
0ef60ec1
GB
1148<step><para>leftclick in the map window, enter a name</para></step>
1149<step><para>click several times to generate a track (a right-click removes the last point)</para></step>
1150<step><para>expand tracks in the layer menu, your track should show up, select it</para></step>
7233fcb6
RN
1151<step><para>right click your track, select <guimenuitem>Apply DEM data</guimenuitem></para></step>
1152<step><para>right click your track again, select <guimenuitem>Properies</guimenuitem></para></step>
1153<step><para>click the tab <guilabel>Elevation-distance</guilabel> - enjoy the plot</para></step>
0ef60ec1 1154</procedure>
6928e16b 1155<para>
0ef60ec1 1156In order to save this setting for later usage
4502fc82 1157</para>
0ef60ec1 1158<procedure>
7233fcb6
RN
1159<step><para>click <guilabel>OK</guilabel> in the <guilabel>Track Properties</guilabel> dialog</para></step>
1160<step><para><menuchoice><guimenu>File</guimenu><guimenuitem>Save As</guimenuitem></menuchoice>, choose a name (you can open this <emphasis>view</emphasis> later via <menuchoice><guimenu>file</guimenu><guimenuitem>Open</guimenuitem></menuchoice>).</para></step>
0ef60ec1 1161</procedure>
6928e16b
GB
1162
1163</section>
1164<section><title>Usecase: offline data for holiday</title>
1165<para>
0ef60ec1
GB
1166Suppose you want to have the map and DEM data offline for your holiday in Italy near Bologna.
1167</para>
1168<procedure>
7233fcb6
RN
1169<step><para>Start a new &appname; session.</para></step>
1170<step><para><menuchoice><guimenu>View</guimenu><guimenuitem>Go to Location</guimenuitem></menuchoice>, enter Bologna</para></step>
1171<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New Map Layer</guimenuitem></menuchoice></para></step>
4502fc82
GB
1172<step><para>Choose e.g. <guilabel>OpenStreetMap (mapnik)</guilabel>.</para></step>
1173<step><para>adapt the <guilabel>maps directory</guilabel> e.g. to <filename>/home/user/.viking-map-holiday/</filename>.
0ef60ec1 1174This allows you to delete the map stuff after holiday without purging the rest of your maps.
4502fc82
GB
1175</para></step>
1176<step><para>check <guilabel>autodownload map</guilabel></para></step>
1177<step><para>keep <guilabel>viking zoom level</guilabel></para></step>
7233fcb6 1178<step><para>zoom out to 1024</para></step>
4502fc82
GB
1179<step><para>add a DEM layer (as discussed above)</para></step>
1180<step><para>download the DEM data</para></step>
0ef60ec1
GB
1181</procedure>
1182<para>In the &app; version discussed here, the DEM data automatically
1183are stored in <filename>/home/user/.viking-maps/</filename>. You can move the corresponding
1184tiles into <filename>.viking-map-holiday/</filename> if you like.
1185</para>
1186<para>
1187<emphasis role="bold">Download map data for all zoom levels</emphasis>
1188</para>
1189<procedure>
4502fc82
GB
1190<step><para>uncheck the DEM layer for the map to show up</para></step>
1191<step><para>navigate the map to be centered at Bologna</para></step>
7233fcb6 1192<step><para>choose the zoom such, that all regions of interest are displayed in the map window (e.g. 1024)</para></step>
0ef60ec1
GB
1193<step>
1194<para>follow this sequence until you have all tiles for all zoom levels you need</para>
1195<substeps>
7233fcb6 1196<step><para>right-click the map layer properties</para></step>
4502fc82 1197<step><para>set the zoomlevel explicitely one below the last (in the first cycle 512), hit OK</para></step>
7233fcb6
RN
1198<step><para>right click the map layer <guimenuitem>Download Missing Onscreen Maps</guimenuitem></para></step>
1199<step><para>wait until all tiles for that resolution have been downloaded</para></step>
0ef60ec1
GB
1200</substeps>
1201</step>
1202</procedure>
1203<para>This may take some time and hd capacity. Lixus wrote a set of
6928e16b 1204scripts which allow to download the map tiles for several zoom-level in
0ef60ec1 1205parallel from the command line.
6928e16b
GB
1206</para>
1207<para>
1208Do not forget to save your configuration (as discussed above).
1209</para>
1210
1211</section>
1212
1213</section>
1214<section><title>Uploading data to OpenStreetMap</title>
1215<para>
7233fcb6 1216It is possible to upload data directly from &appname; to OpenStreetMap.
6928e16b 1217</para>
0ef60ec1
GB
1218<formalpara>
1219<title>Upload a layer</title>
6928e16b
GB
1220<para>
1221One solution is to upload whole a TrackWaypoint layer. To do this,
0ef60ec1
GB
1222simply select the layer and right click on it. Then, select <guimenuitem>Upload to
1223OSM</guimenuitem>.
6928e16b 1224</para>
0ef60ec1
GB
1225</formalpara>
1226<formalpara>
1227<title>Upload a single track</title>
6928e16b
GB
1228<para>One solution is to upload whole a TrackWaypoint layer. To do
1229this, simply select the layer and right click on it. Then, select
0ef60ec1 1230<guimenuitem>Upload to OSM</guimenuitem>.
6928e16b 1231</para>
0ef60ec1
GB
1232</formalpara>
1233<formalpara>
1234<title>Fill in the form</title>
6928e16b 1235<para>
7233fcb6 1236In both cases, &appname; will retain some information.
6928e16b 1237The email field is the email you used to subscribed into OSM.
6928e16b 1238The password field is the password you used with this account.
6928e16b 1239The filename is the name you want your upload has on the server. This information is displayed by the osm server.
6928e16b 1240The description is some descriptive information.
0ef60ec1
GB
1241The tags field is a white separated list of tag.
1242</para>
1243</formalpara>
6928e16b
GB
1244
1245</section>
1246<section><title>Geocoded Photo</title>
1247<para>
1248HOWTO GEOCODE YOUR PHOTOS AND SEE THEM IN VIKING
1249</para>
1250<para>1) Synchronize your camera's clock with your GPS clock. If your
1251camera's clock doesn't have a seconds value you can change, you might
1252try setting the minute value just when the minute changes.
1253</para>
1254<para>
12552) Activate the track log on your GPS.
1256</para>
1257<para>3) Get outside and take some pictures with your camera while
1258making sure your GPS has reception. If you forgot to turn your GPS on
1259or forgot to bring it when you took a picture but you know where you
1260took the picture, you can make a waypoint with a name of the format
1261YYMMDDhhmm, representing the time the picture was taken, to record
1262where you were at that time.
1263</para>
1264<para>4) Get home and download your pictures and GPS data. You can
1265download the GPS data several ways. The first is using gpspoint to
1266download from a Garmin GPS: <programlisting>gpspoint -p /dev/ttyS0 -dw -dt -of 2004-04-02-trip1</programlisting>
1267</para>
1268<para>
1269Where /dev/ttyS0 is the serial port the GPS is connected to. If you
1270don't have a Garmin GPS, or if you don't feel like install gpspoint,
1271you can use my version of gpsbabel with support for gpspoint files. You
1272can use gpsbabel to either translate the GPS data from a format you
1273already have the data in or download it directly from your GPS
1274reciever. A typical command line would something like this:<programlisting>gpsbabel -i garmin -f /dev/ttyS0 -o gpspoint -F 2004-04-02-trip1</programlisting>
1275</para>
1276<para>
12775) Launch GPSPhoto.
1278</para>
1279<para>
12806) You must now bring your photos into GPSPhoto. Either drag them (or
1281the directory containing them) from your favorite file manager to the
1282list on the left of the GPSPhoto window, or use the buttons below the
1283list to find them.
1284</para>
1285<para>
12867) Do the same for your GPS data file(s), dragging them to the list on the right of the GPSPhoto Window.
1287</para>
1288<para>8) Click the Execute button, and choose a location to save the
1289gpspoint file containing the waypoints for your photos. Then click OK
1290to write the waypoints to this file.
1291</para>
1292<para>
12939) Open Viking and open both your original GPS data file and your image waypoint file just created.
1294</para>
1295</section>
1296
f1b908b1 1297<section id="extend_viking">
ba322d06
GB
1298 <title>Extending Viking</title>
1299
1300 <para>Currently, &app; has some extention points based on configuration files. The file format is heavily inspired by the GtkBuilder file format: you specify the class of the GObject to build and set its properties. Technically, it is a XML file containing a "objects" root element. Inside this element, you set a collection of "object".</para>
1301 <para>Here is an example:
1302<programlisting><![CDATA[
1303<objects>
1304 <object class="ClassName">
1305 <property name="property_name1">Property value</property>
1306 <property name="property_name2">Property value</property>
1307 </object>
1308 ...
1309<objects>
1310]]>
1311</programlisting>
1312</para>
1313 <para>You can find more examples in the documentation part of the distribution.</para>
4502fc82 1314 <section>
ba322d06
GB
1315 <title>Map Source</title>
1316 <para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename>.</para>
f1b908b1
RN
1317 <para>An example of the file is in the distribution <filename>doc/examples/maps.xml</filename>. Further examples and values are online in the <ulink url="http://sourceforge.net/apps/mediawiki/viking/index.php?title=Maps">Maps Wiki</ulink></para>
1318
90f15672 1319 <para>The VikSlippyMapSource allows to declare any map's source working like OpenStreetMap. It supports the following properties:
ba322d06
GB
1320 <variablelist>
1321 <varlistentry>
1322 <term>id</term>
1323 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
1324 </varlistentry>
1325 <varlistentry>
1326 <term>label</term>
1327 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
1328 </varlistentry>
1329 <varlistentry>
1330 <term>hostname</term>
1331 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
1332 </varlistentry>
1333 <varlistentry>
1334 <term>url</term>
1335 <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for X, Y and Z (zoom level) (eg. "/%d/%d/%d.png")</para></listitem>
1336 </varlistentry>
1337 </variablelist>
1338 </para>
1b6659bd
GB
1339 <para>The VikTmsMapSource allows to declare any TMS service. It supports the following properties:
1340 <variablelist>
1341 <varlistentry>
1342 <term>id</term>
1343 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
1344 </varlistentry>
1345 <varlistentry>
1346 <term>label</term>
1347 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
1348 </varlistentry>
1349 <varlistentry>
1350 <term>hostname</term>
1351 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
1352 </varlistentry>
1353 <varlistentry>
1354 <term>url</term>
1355 <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for X, Y and Z (zoom level) (eg. "/%d/%d/%d.png")</para></listitem>
1356 </varlistentry>
1357 </variablelist>
1358 </para>
90f15672
GB
1359 <para>The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties:
1360 <variablelist>
1361 <varlistentry>
1362 <term>id</term>
1363 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
1364 </varlistentry>
1365 <varlistentry>
1366 <term>label</term>
1367 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
1368 </varlistentry>
1369 <varlistentry>
1370 <term>hostname</term>
1371 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
1372 </varlistentry>
1373 <varlistentry>
1374 <term>url</term>
1375 <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 4 "%s" fields for bounding box coordinates (eg. "/coord=%s,%s,%s,%s")</para></listitem>
1376 </varlistentry>
1377 </variablelist>
1378 </para>
4502fc82 1379 </section>
ba322d06 1380
4502fc82 1381 <section>
ba322d06
GB
1382 <title>Go-to search engines</title>
1383 <para>It is possible to add new new search engines for the "Go-To" feature. The file is <filename>~/.viking/goto_tools.xml</filename>.</para>
1384 <para>An example of the file in the distribution <filename>doc/examples/goto_tools.xml</filename>.</para>
1385 <para>Currently, there is a single object class available: VikGotoXmlTool. Such feature allows to declare any search engine using a XML format as result.</para>
1386 <para>The related properties are:
1387 <variablelist>
1388 <varlistentry>
1389 <term>label</term>
1390 <listitem><para>the text displayed in the <guilabel>Go-To</guilabel> dialog</para></listitem>
1391 </varlistentry>
1392 <varlistentry>
1393 <term>url-format</term>
1394 <listitem><para>the parametrized address of the query, in the spirit of C <function>printf</function> format, with a single "%s" field (replaced by the query string)</para></listitem>
1395 </varlistentry>
1396 <varlistentry>
1397 <term>lat-path</term>
1398 <listitem><para>XML path of the latitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
1399 </varlistentry>
1400 <varlistentry>
1401 <term>lat-attr (optional)</term>
1402 <listitem><para>name of the attribute (of previous element) containing the latitude</para></listitem>
1403 </varlistentry>
1404 <varlistentry>
1405 <term>lon-path</term>
1406 <listitem><para>XML path of the longitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
1407 </varlistentry>
1408 <varlistentry>
1409 <term>lon-attr (optional)</term>
1410 <listitem><para>name of the attribute (of previous element) containing the longiude</para></listitem>
1411 </varlistentry>
1412 </variablelist>
1413 </para>
1414 <para>As a facility (or readability) it is possible to set both path and attribute name in a single property, like an XPath expression. To do so, simply set both info in lat-path (or lon-path) in the following format: <literal>/root/parent/elem@attribute</literal>.</para>
4502fc82 1415 </section>
ba322d06 1416
4502fc82 1417 <section>
7233fcb6 1418 <title>Webtools</title>
ba322d06
GB
1419 <para>It is possible to add new external tools. The file is <filename>~/.viking/external_tools.xml</filename>.</para>
1420 <para>An example of the file in the distribution <filename>doc/examples/external_tools.xml</filename>.</para>
1421 <para>Currently, there is a single object class available: VikWebtoolCenter. Such feature allows to declare any Webtool using a logic based on center coordinates and zoom level value.</para>
1422 <para>The related properties are:
1423 <variablelist>
1424 <varlistentry>
1425 <term>id</term>
1426 <listitem><para>this is an integer and should be unique as it used to identify the tool</para></listitem>
1427 </varlistentry>
1428 <varlistentry>
1429 <term>label</term>
1430 <listitem><para>the text displayed in the menu entry</para></listitem>
1431 </varlistentry>
1432 <varlistentry>
1433 <term>url</term>
1434 <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for X, Y and Z (zoom level) (eg. "http://hostname/%d/%d/%d.png")</para></listitem>
1435 </varlistentry>
1436 </variablelist>
1437 </para>
4502fc82 1438 </section>
ba322d06
GB
1439
1440</section>
1441
7233fcb6
RN
1442<section><title>What to Do if &appname; Does Not Seem to Work</title>
1443<para>
1444In order to get some information about what &appname; is doing, start it in verbose debug mode via the command line:
1445<programlisting>viking -dV</programlisting>
1446</para>
1447<para>
1448For instance you can check the correct URLs &appname; is using in requesting remote data for DEMs or map tiles in the verbose debug output.
1449E.g. Something like this for DEMs:
1450<screen>
1451** (viking:28778): DEBUG: curl_download_uri: uri=http://dds.cr.usgs.gov/srtm/version2_1/SRTM3/Eurasia/N48E008.hgt.zip
1452* About to connect() to dds.cr.usgs.gov port 80 (#0)
1453* Trying 152.61.128.95... * connected
1454* Connected to dds.cr.usgs.gov (152.61.128.95) port 80 (#0)
1455 GET /srtm/version2_1/SRTM3/Eurasia/N48E008.hgt.zip HTTP/1.1
1456User-Agent: viking/0.9.8 libcurl/7.18.2 GnuTLS/2.4.2 zlib/1.2.3.3 libidn/1.8
1457Host: dds.cr.usgs.gov
1458Accept: */*
1459 HTTP/1.1 200 OK
1460 Date: Sun, 26 Jul 2009 18:13:38 GMT
1461 Server: Apache
1462 Last-Modified: Tue, 21 Jul 2009 19:57:35 GMT
1463 ETag: eac3f8-1828f5-46f3caa76070a
1464 Accept-Ranges: bytes
1465 Content-Length: 1583349
1466 Content-Type: application/zip
1467
1468* Connection #0 to host dds.cr.usgs.gov left intact
1469* Closing connection #0
1470** (viking:28778): DEBUG: dem_layer_add_file: /home/username/.viking-maps/srtm3-Eurasia/N48E008.hgt.zip
1471</screen>
1472Or for OSM Mapnik tile server:
1473<screen>
1474* About to connect() to tile.openstreetmap.org port 80 (#0)
1475* Trying 193.63.75.28... * connected
1476* Connected to tile.openstreetmap.org (193.63.75.28) port 80 (#0)
1477 GET /13/4065/2748.png HTTP/1.1
1478User-Agent: viking/0.9.96 libcurl/7.20.1 GnuTLS/2.8.6 zlib/1.2.3.4 libidn/1.18
1479Host: tile.openstreetmap.org
1480Accept: */*
1481
1482* HTTP 1.0, assume close after body
1483 HTTP/1.0 200 OK
1484 Date: Thu, 14 Oct 2010 22:18:42 GMT
1485 Server: Apache/2.2.8 (Ubuntu)
1486 ETag: "b66ff9d46474bab68262a3483428a232"
1487** (viking:16704): DEBUG: curl_get_etag_func: ETAG found: "b66ff9d46474bab68262a3483428a232"
1488 Content-Length: 17194
1489 Cache-Control: max-age=94805
1490 Expires: Sat, 16 Oct 2010 00:38:47 GMT
1491 Content-Type: image/png
1492 Age: 5153
1493 X-Cache: HIT from konqi.openstreetmap.org
1494 X-Cache-Lookup: HIT from konqi.openstreetmap.org:3128
1495 Via: 1.1 konqi.openstreetmap.org:3128 (squid/2.7.STABLE7)
1496 Connection: close
1497
1498* Closing connection #0
1499* About to connect() to a.andy.sandbox.cloudmade.com port 80 (#0)
1500* Trying 178.63.75.195... ** (viking:16704): DEBUG: curl_download_uri: uri=http://tile.openstreetmap.org/13/4065/2749.png
1501* About to connect() to tile.openstreetmap.org port 80 (#0)
1502* Trying 193.63.75.28... * connected
1503* Connected to a.andy.sandbox.cloudmade.com (178.63.75.195) port 80 (#0)
1504 GET /tiles/cycle/13/4065/2747.png HTTP/1.1
1505User-Agent: viking/0.9.96 libcurl/7.20.1 GnuTLS/2.8.6 zlib/1.2.3.4 libidn/1.18
1506Host: a.andy.sandbox.cloudmade.com
1507Accept: */*
1508
1509* connected
1510* Connected to tile.openstreetmap.org (193.63.75.28) port 80 (#0)
1511 GET /13/4065/2749.png HTTP/1.1
1512User-Agent: viking/0.9.96 libcurl/7.20.1 GnuTLS/2.8.6 zlib/1.2.3.4 libidn/1.18
1513Host: tile.openstreetmap.org
1514Accept: */*
1515
1516* HTTP 1.0, assume close after body
1517 HTTP/1.0 200 OK
1518 Date: Thu, 14 Oct 2010 23:44:35 GMT
1519 Server: Apache/2.2.8 (Ubuntu)
1520 ETag: "8e520ad47ce9c1b63430554886eb5fab"
1521** (viking:16704): DEBUG: curl_get_etag_func: ETAG found: "8e520ad47ce9c1b63430554886eb5fab"
1522 Content-Length: 18094
1523 Cache-Control: max-age=87742
1524 Expires: Sat, 16 Oct 2010 00:06:57 GMT
1525 Content-Type: image/png
1526 X-Cache: MISS from konqi.openstreetmap.org
1527 X-Cache-Lookup: MISS from konqi.openstreetmap.org:3128
1528 Via: 1.1 konqi.openstreetmap.org:3128 (squid/2.7.STABLE7)
1529 Connection: close
1530</screen>
1531</para>
1532</section>
1533
6928e16b 1534</section>
f8b8a0b5
GB
1535
1536</article>