]> git.street.me.uk Git - andy/viking.git/blame_incremental - help/C/viking.xml
[DOC] Update map download tool text.
[andy/viking.git] / help / C / viking.xml
... / ...
CommitLineData
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>">
6 <!ENTITY appversion "1.3">
7 <!ENTITY manrevision "0.2">
8 <!ENTITY date "September 2012">
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>2012</year>
28 <holder>Guilhem Bonnefille</holder>
29 <holder>Rob Norris</holder>
30 </copyright>
31
32 <!-- An address can be added to the publisher information. -->
33 <publisher role="maintainer">
34 <publishername>GNOME Documentation Project</publishername>
35 </publisher>
36
37 <xi:include href="legal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
38 <!-- The file legal.xml contains link to license for the documentation,
39 and other legal stuff such as "NO WARRANTY" statement.
40 Please do not change any of this. -->
41
42 <authorgroup>
43 <author>
44 <firstname>Guilhem</firstname>
45 <surname>Bonnefille</surname>
46 </author>
47 <author>
48 <firstname>Rob</firstname>
49 <surname>Norris</surname>
50 </author>
51 <!-- Contributors from the Wiki history -->
52 <author>
53 <firstname>username:</firstname>
54 <surname>Alexxy</surname>
55 </author>
56 <author>
57 <firstname>username:</firstname>
58 <surname>Vikingis</surname>
59 </author>
60 <author>
61 <firstname>username:</firstname>
62 <surname>Tallguy</surname>
63 </author>
64 <author>
65 <firstname>username:</firstname>
66 <surname>EliotB</surname>
67 </author>
68 <author>
69 <firstname>Alex</firstname>
70 <surname>Foobarian</surname>
71 </author>
72 <!-- END -->
73 </authorgroup>
74
75 <revhistory>
76 <revision>
77 <revnumber>&appname; Manual V&manrevision;</revnumber>
78 <date>&date;</date>
79 <revdescription>
80 <para role="author">Guilhem Bonnefille <email>guilhem.bonnefille@gmail.com</email></para>
81 <para role="author">Rob Norris <email>rw_norris@hotmail.com</email></para>
82 <para role="publisher">GNOME Documentation Project</para>
83 <para>This document was generated on <?dbtimestamp format="Y-m-d"?>.</para>
84 </revdescription>
85 </revision>
86 </revhistory>
87
88 <releaseinfo>This manual describes version &appversion; of &appname;.</releaseinfo>
89
90 <legalnotice>
91 <title>Feedback</title>
92 <para>To report a bug or make a suggestion regarding the &app; application or
93 this manual, follow the directions in the
94 <ulink url="ghelp:user-guide?feedback-bugs" type="help">Feedback section of the GNOME User Guide</ulink>.
95 </para>
96 </legalnotice>
97 </articleinfo>
98
99 <indexterm zone="index">
100 <primary>&app;</primary>
101 </indexterm>
102<!-- ============= Document Body ============================= -->
103<section id="introduction">
104 <title>Introduction</title>
105<para>
106&appname; aims to be easy to use, yet powerful in accomplishing a wide
107variety of tasks. Some of the things you can use &appname; for are:
108</para>
109<itemizedlist mark="opencircle"><listitem>
110<para>
111Uploading and downloading waypoints, tracks and routes to/from GPS.
112</para>
113</listitem>
114<listitem>
115<para>Preparing tracks, routes and waypoints for trips using maps from services such as OpenStreetMap (OSM) and/or Terrasever.
116The data is only needed to be uploaded to your GPS before you leave.
117The maps together with your tracks, routes and waypoints can also be printed and used during the trip.
118</para>
119</listitem>
120<listitem>
121<para>
122After trips, tracks and waypoints from GPS can be downloaded, stored, managed and reused in your (or your friends') later trips.
123</para>
124</listitem>
125<listitem>
126<para>
127Analyzing Off Highway Vehicle (OHV) and hiking trips, understanding where you went and how far you were from something.
128</para>
129</listitem>
130<listitem>
131<para>Making waypoints, tracks and routes to follow to easily get someplace
132you've never been before or don't have GPS data for but online
133maps exist for it.
134</para>
135</listitem>
136<listitem>
137<para>
138Making maps with coordinate lines.
139</para>
140</listitem>
141<listitem>
142<para>
143Grouping data from multiple trips using a hierarchical data manager.
144</para>
145</listitem>
146<listitem>
147<para>
148Analyzing speed at different places (to some degree), adding waypoints where you forgot to mark one but did slow down or stop.
149</para>
150</listitem>
151<listitem>
152<para>
153Downloading and storing OpenStreetMap and/or Terraserver maps on your hard drive and looking at them later.
154</para>
155</listitem>
156<listitem>
157<para>
158Editing routes or tracks and their trackpoints, joining and splitting up tracks and routes.
159</para>
160</listitem>
161<listitem>
162<para>
163Show the live GPS position on the map (for use on a mobile device - e.g. a laptop). Not <trademark>Windows</trademark> at the moment.
164</para>
165</listitem>
166<listitem>
167<para>
168Import track, route and waypoint files of various types via <application>GPSBabel</application>
169</para>
170</listitem>
171<listitem>
172<para>
173View, create and update Geotagged Images (using EXIF data).
174</para>
175</listitem>
176</itemizedlist>
177<note>
178<para>
179&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>:
180</para>
181</note>
182</section>
183
184<section><title>General Concepts</title>
185<section><title>Layers</title>
186<para>
187'Layers' is concept one may know from powerful graphics editors such as <application>Photoshop</application> or <application>GIMP</application>.
188Instead of putting all the data on the same level, it is stacked (i.e. layered) with different data over one another.
189This can be useful for analysis and general handling of various sets of data.
190</para>
191<para>
192Unfortunately the downside of this complexity is remembering how differing layers of data can obscure other data.
193</para>
194<para>
195The Map layers have <ulink url="http://en.wikipedia.org/wiki/Alpha_compositing"><citetitle>Alpha Compositing</citetitle></ulink>,
196to create the appearance of partial transparency.
197By controlling this value one can see data below it in the layer heirarchy for interesting effects.
198</para>
199</section>
200<section><title>Layers Panel</title>
201<para>
202The panel on the left is called the <emphasis role="bold">layers panel</emphasis>.
203It determines which layers and sublayers (such as tracks and waypoints)
204are shown, and the order in which they are drawn. Layers list on the
205top of the layers panel are drawn last. You can change the order by
206drag and drop, or by selecting a layer and using the up and down
207buttons at the bottom of the layers panel.
208</para>
209</section>
210<section><title>Viewport</title>
211<para>
212The main &appname; area where the layer data is drawn, is called the <emphasis role="bold">viewport</emphasis>.
213</para>
214</section>
215<section><title>Statusbar</title>
216<para>This provides a readout of various information:</para>
217<itemizedlist>
218<listitem><para>The currently selected (mouse pointer) tool</para></listitem>
219<listitem><para>The number of items to process in the background - normally this the number in the map tile download queue</para></listitem>
220<listitem><para>The zoom factor</para></listitem>
221<listitem><para>The location of the mouse pointer (and potentially height information if DEM data is available)</para></listitem>
222</itemizedlist>
223<para>When creating a track/route, the statusbar also displays some information about the track/route.</para>
224<figure>
225<title>Statusbar</title>
226<screenshot>
227 <graphic format="PNG" fileref="figures/trw_statusbar.png"/>
228</screenshot>
229</figure>
230<para>This part of the statusbar displays:
231<itemizedlist>
232<listitem><para>The total distance of the track/route (including currently edited segment).</para></listitem>
233<listitem><para>The bearing of the currently edited segment.</para></listitem>
234<listitem><para>The distance of the currently edited segment.</para></listitem>
235</itemizedlist>
236</para>
237<para>For convenience, a zoom selector can be opened from the status bar. Simply left-click on the zoom factor.</para>
238<figure>
239 <title>The zoom selector available from status bar</title>
240 <screenshot>
241 <graphic format="PNG" fileref="figures/zoom_status_popup.png"/>
242 </screenshot>
243</figure>
244</section>
245
246<section><title>Projections</title>
247<para>
248&appname; supports differents projections:
249<itemizedlist>
250<listitem>
251<para>UTM</para>
252</listitem>
253<listitem>
254<para>LatLon (also called EPSG:4326)</para>
255</listitem>
256<listitem>
257<para>Mercator (also called Spherical Mercator)</para>
258</listitem>
259</itemizedlist>
260</para>
261</section>
262
263<section><title>Map Cache</title>
264<para>
265&appname; stores downloaded map tiles to disk for a couple of reasons:
266</para>
267<itemizedlist>
268<listitem><para>Enables off line usage</para></listitem>
269<listitem><para>Reduces loading on the map tile provider</para></listitem>
270</itemizedlist>
271<para>
272The &appname; automatic caching strategy is two fold:
273</para>
274<itemizedlist>
275<listitem>
276<para>
277 If the age of the tile on disk is less than the specified tile age (see <xref linkend="prefs"/>),
278 it will <emphasis>not</emphasis> attempt to contact the server to get a new version of the tile.
279</para>
280</listitem>
281<listitem>
282<para>
283 When the tile age has expired &appname; will attempt a <emphasis>refresh</emphasis> update, so that it provides the cached tile generation timestamp so the server can determine if a new tile image needs to be returned. Not all map types support this refresh method.
284</para>
285</listitem>
286</itemizedlist>
287<para>
288 You can override the caching scheme by using right-click on the Map on the layers panel and selecting <guimenuitem>Redownload All Onscreen Maps</guimenuitem>, or <keycap>Ctrl+F5</keycap> for the top most map displayed. This will get the latest version held by the server.
289</para>
290<note>
291<para>
292 This can be useful if you contribute to OpenStreetMap and wish to see your modifications (of course give time for the server to have processed your changes - see <ulink url="http://help.openstreetmap.org/questions/102/i-have-made-edits-but-they-dont-show-up-on-the-map">I have made edits but they don't show up on the map</ulink>)
293</para>
294</note>
295</section>
296
297<section id="shortcut_keys" xreflabel="Shortcut Keys"><title>Shortcut Keys</title>
298<para>
299&appname; has several shortcut keys or key combinations for commands as listed in the main window along side the command.
300</para>
301<para>
302Some function keys follow standard GUI behaviour:
303</para>
304<itemizedlist>
305<listitem><para><keycap>F1</keycap> Help (view this manual)</para></listitem>
306<listitem><para><keycap>F5</keycap> or <keycap>Ctrl+R</keycap> Refresh the maps on screen</para></listitem>
307<listitem><para><keycap>F10</keycap> Select the Menubar (in built behaviour)</para></listitem>
308<listitem><para><keycap>F11</keycap> Full Screen</para></listitem>
309<listitem><para><keycap>Ctrl+F5</keycap> or <keycap>Ctrl+Shift+R</keycap> Redownload the maps on screen</para></listitem>
310</itemizedlist>
311<note>
312<para>
313Refresh attempts to get new maps only if the local tile cache time period has expired for any particular map tile.
314Redownload gets all on screen maps from the server, ignoring the local tile cache.
315</para>
316</note>
317<para>
318Other function keys control turn on/off visibility of various elements:
319</para>
320<itemizedlist>
321<listitem><para><keycap>F3</keycap> Toggle visibility of the Toolbar</para></listitem>
322<listitem><para><keycap>F4</keycap> Toggle visibility of the Menubar</para></listitem>
323<listitem><para><keycap>Shift+F5</keycap> Toggle visibility of the Scale indicator on the viewport</para></listitem>
324<listitem><para><keycap>F6</keycap> Toggle visibility of the Center Crosshairs on the viewport</para></listitem>
325<listitem><para><keycap>F7</keycap> Toggle showing selected items (e.g. tracks or waypoints) in the highlight colour in the viewport</para></listitem>
326<listitem><para><keycap>F9</keycap> Toggle visibility of the Layers Panel</para></listitem>
327<listitem><para><keycap>F12</keycap> Toggle visibility of the Statusbar</para></listitem>
328</itemizedlist>
329<para>
330Standard shortcuts are provided for normal GUI operations: such as creating new files, opening, saving and exitting.
331Then there are shortcuts specific to &appname; to switch projection modes, zoom in/out, create layers and switch the active tool mode.
332For these combinations see the menu entry themselves.
333</para>
334</section>
335
336<section><title>Tracks vs Routes</title>
337<para>
338In theory a route is path you are planning to follow and a track of where you have actually been. The GPX specification splits these into two separate catergories, although tracks contain everything route may have.
339</para>
340<para>
341Q. When planning a 'route' what difference does it make if it's a route or a track?
342</para>
343<para>
344A. One difference is in how a GPS device navigates following the route or track.
345Or you may want to consider interoperability with other software.
346Otherwise it is probably best to use tracks as they are a superset of the route functionality.
347</para>
348<para>
349For example on Garmin Etrex:
350</para>
351<itemizedlist>
352<listitem>
353<para>Route following: Uses navigation mode with compass and estimated time to next point.</para>
354<para>If following on road it can calculate a route on fly.</para>
355<para>I (RN) always use this mode to follow pre planned routes.</para>
356</listitem>
357<listitem>
358<para>Track following: Uses a <trademark>TracBack</trademark> mode</para>
359<para>I (RN) never use this so I can't comment on how it actually compares to the route mode.</para>
360</listitem>
361</itemizedlist>
362<note><para>
363There are often restrictions on the numbers of route points the GPS Device can handle - may be 250 or as little as 50.
364This generally not a problem for single day routes, but needs managing for multi-day events or for highly detailed routes.
365</para></note>
366</section>
367
368</section><!--General Concepts End-->
369
370<section><title>File Types and the Main Window</title>
371
372<para>
373&appname; has it's own file type traditionally marked by the <emphasis>.vik</emphasis> file extension.
374This is a plain text file saving all information of the current window including the view location, zoom level, projection type and then all the layer information (aggregrates, maps, tracks, waypoints, etc...).
375</para>
376<para>
377Besides it's own file type, &appname; can open (and save to via export methods) GPX and KML file types.
378</para>
379<note>
380<para>
381&appname; does not handle GPX 1.1 particularly well - it prefers GPX 1.0
382</para>
383</note>
384<para>
385By default &appname; opens a default blank window centered on the home location.
386Each window contains menus, a toolbar, a viewport, layers panel and a statusbar.
387Each section (apart from the viewport) can be hidden using the <xref linkend="shortcut_keys"/> or from the
388<menuchoice><guimenu>View</guimenu><guisubmenu>Show</guisubmenu></menuchoice> choices.
389</para>
390<para>
391One may consider each &appname; window to be a separate project - each with it's project <emphasis>Viking</emphasis> file.
392However generally one window is enough for most purposes!
393</para>
394<para>
395Several operations apply at the window level as follows next.
396Also see <xref linkend="tools"/> for the operational modes that generally work in conjunction with a selected layer.
397</para>
398
399<section><title>New</title>
400<para>
401Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>New</guisubmenu></menuchoice> menu and on the toolbar <guibutton>New</guibutton>.
402</para>
403<para>
404This creates a new window with the default settings.
405</para>
406</section>
407
408<section><title>Open</title>
409<para>
410Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Open</guisubmenu></menuchoice> menu and on the toolbar <guibutton>Open</guibutton>.
411</para>
412<para>
413This opens a file chooser dialog to select one (or more) files of the supported GPS data file types:
414<itemizedlist>
415<listitem><para>Viking</para></listitem>
416<listitem><para>GPX</para></listitem>
417<listitem><para>KML</para></listitem>
418</itemizedlist>
419</para>
420<para>
421GPX and KML files will be loaded into the existing &appname; view. A <emphasis>Viking</emphasis> file will be given a new window if the current window is already assigned.
422</para>
423<tip>
424<para>
425&appname; handles more file types via the <link linkend="acquire">Acquire</link> methods below.
426</para>
427</tip>
428</section>
429
430<section><title>Save</title>
431<para>
432Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Save</guisubmenu></menuchoice> menu and on the toolbar <guibutton>Save</guibutton>.
433</para>
434<para>
435If the current opened file is <emphasis>Viking</emphasis> file, this save will simply update it.
436If it is a new file or the file loaded was an external type (i.e. GPX or KML), then this will ask for a <emphasis>new name</emphasis> to save as a <emphasis>Viking</emphasis> file.
437</para>
438</section>
439
440<section><title>Save As</title>
441<para>
442Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Save As</guisubmenu></menuchoice> menu only.
443</para>
444<para>
445This will ask for a <emphasis>new name</emphasis> to save as a <emphasis>Viking</emphasis> file (even it was already a <emphasis>Viking</emphasis> file).
446</para>
447</section>
448
449<section><title>Append</title>
450<para>
451Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Append</guisubmenu></menuchoice> menu only.
452</para>
453<para>
454Selecting a <emphasis>Viking</emphasis> file from this method will join the file contents to the current window (instead of creating a new one).
455GPX and KML files may also be appended, but this is exactly the same as the normal file open method.
456</para>
457</section>
458
459<section id="acquire" xreflabel="acquire"><title>Acquire</title>
460
461<para>
462Available on the <menuchoice><guimenu>File</guimenu><guisubmenu>Acquire</guisubmenu></menuchoice> menu and from the <xref linkend="TrackWaypoint"/> layer menu.
463</para>
464<para>
465If used from the <guimenu>File</guimenu> menu and a TrackWaypoint layer is not currently selected, these methods place the results in a new TrackWaypoint layer. When a TrackWaypoint layer is selected, then using the <menuchoice><guimenu>File</guimenu><guisubmenu>Acquire</guisubmenu></menuchoice> will put the results into the selected TrackWaypoint layer.
466</para>
467<para>
468If used from the <xref linkend="TrackWaypoint"/> layer menu these methods place the results in that TrackWaypoint layer.
469</para>
470
471<section>
472<title>From GPS</title>
473<para>
474<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From GPS</guimenuitem></menuchoice>
475Probably the easiest way of getting information from a GPS Device.
476</para>
477<para>
478Select the GPS Device communication settings and then hit <guibutton>OK</guibutton>.
479See the <link linkend="method_c">Getting Started</link> section for more info about the settings.
480</para>
481<note>
482<para>
483Some GPS devices (such as the <trademark>Garmin Nuvi 255</trademark>) support a native file system and write information to a <filename>Current.gpx</filename> file or similar. You will have to browse the file system on the device and open it directly.
484</para>
485</note>
486</section>
487
488<section>
489<title>Import File With GPSBabel</title>
490<para>
491<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>Import File With GPSBabel</guimenuitem></menuchoice>
492</para>
493<para>
494Other formats can be imported that are supported by GPSBabel.
495</para>
496<para>
497You need to select the file <emphasis>and</emphasis> the type of the file that is going to be opened,
498since there is no automatic detection of the file kind.
499</para>
500</section>
501
502<section>
503<title>OSM Traces</title>
504<para>
505<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>OSM Traces</guimenuitem></menuchoice>
506</para>
507<para>
508See <xref linkend="osm_dl"/> section for more information.
509</para>
510</section>
511
512<section>
513<title>My OSM Traces</title>
514<para>
515<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>My OSM Traces</guimenuitem></menuchoice>
516</para>
517<para>
518See <xref linkend="osm_my_dl"/> section for more information.
519</para>
520</section>
521
522<section>
523<title>From Geotagged Images</title>
524<para>
525<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From Geotagged Images</guimenuitem></menuchoice>
526Enables automatic creation of waypoints from geotagged images.
527</para>
528<para>
529This menu opens a dialog to select such image files.
530If the image files have geotag information in them, then a <xref linkend="TrackWaypoint"/> layer with named waypoints positioned at the location of each image with a thumbnail of that image is created.
531</para>
532</section>
533
534<section>
535<title>From Wikipedia Waypoints</title>
536<para>
537<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From Wikipedia Waypoints</guimenuitem></menuchoice>
538</para>
539<para>
540This gets 'interesting' points from Wikipedia for the specified view: either within the extent of layer bounds or within the current viewport boundary.
541</para>
542</section>
543
544</section> <!-- End Acquire -->
545
546<section><title>Print</title>
547<para>
548Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Print</guisubmenu></menuchoice> menu and on the toolbar <guibutton>Print</guibutton>.
549</para>
550<para>
551Print uses what is displayed on the current map view for printing: i.e. what ever map, tracks and waypoints that are in view, including the
552cross hairs and the scale.
553</para>
554<para>
555It uses a standard system print dialog using an image the size of the current viewport in pixel terms.
556On the <emphasis>Image Settings</emphasis> you can move the image around the page and scale the image up / or down.
557</para>
558</section>
559
560<section><title>Generate Image File</title>
561<para>
562Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Generate Image File</guisubmenu></menuchoice> menu only.
563</para>
564<para>
565Allows generation of larger (pixel) area images than the standard Print method above.
566From the generated image you can use the facilities of the <application>Operating System</application> to print the image
567or perform other actions.
568</para>
569<para>
570You should have previously downloaded the tile images for the chosen zoom level,
571otherwise the image produced will have missing sections.
572</para>
573<warning>
574<para>
575Using large areas takes some time to process and due to the method used it may run out of memory to complete the operation.
576Unfortunately under <trademark>Windows</trademark> systems it can not detect this failure and may crash the program.
577So the maximum size is dependent on the capabilities of your system.
578For instance the largest successful image generated on my (RN) Debian system is a pixel area of 20,000 x 20,000.
579</para>
580</warning>
581</section>
582
583<section><title>Generate Directory of Images</title>
584<para>
585Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Generate Directory of Images</guisubmenu></menuchoice> menu only.
586</para>
587<para>
588This is only available in UTM mode.
589</para>
590</section>
591
592</section> <!-- End File Types -->
593
594<section><title>Layers</title>
595
596<para>
597Layers supported by &appname; are:
598</para>
599<itemizedlist>
600<listitem><para><xref linkend="Aggregate"/></para></listitem>
601<listitem><para><xref linkend="TrackWaypoint"/></para></listitem>
602<listitem><para><xref linkend="GPS"/></para></listitem>
603<listitem><para><xref linkend="DEM"/></para></listitem>
604<listitem><para><xref linkend="Coordinate"/></para></listitem>
605<listitem><para><xref linkend="Maps"/></para></listitem>
606<listitem><para><xref linkend="GeoRef"/></para></listitem>
607</itemizedlist>
608<para>
609For each layer there are a few standard options:
610</para>
611<itemizedlist>
612<listitem><para>Properties - Layer setup / configuration settings</para></listitem>
613<listitem><para>Cut</para></listitem>
614<listitem><para>Copy</para></listitem>
615<listitem><para>Paste</para></listitem>
616<listitem><para>Delete</para></listitem>
617<listitem><para>Visibility - This checkbox on the Layers Panel controls whether the layer is shown in the viewport or not</para></listitem>
618</itemizedlist>
619<para>
620The cut/copy/paste options can be accessed in a variety of ways once the layer has been selected:
621</para>
622<itemizedlist>
623<listitem><para>Standard keys: <keycap>Ctrl+x|c|v</keycap></para></listitem>
624<listitem><para>Main menu <guimenuitem>Edit</guimenuitem></para></listitem>
625<listitem><para>From the right click menu</para></listitem>
626<listitem><para>Buttons at the bottom of the Layers Panel</para></listitem>
627</itemizedlist>
628<para>
629See the individual section for detail about each layer.
630</para>
631</section>
632
633<section id="TrackWaypoint" xreflabel="TrackWaypoint"><title>TrackWaypoint Layer</title>
634<para>
635TrackWaypoint layers display GPS data (tracks, routes and waypoints).
636</para>
637<para>One way to create new waypoints is to copy a
638latitude/longitude coordinate pair, such as the one shown on most
639geocaches, and paste it into an active TrackWaypoint layer. &appname; can
640automatically recognize several variations of the lat/lon format.
641</para>
642<para>
643By right-clicking on tracks, routes or waypoints in the layers panel, you can access many commands on them.
644You can easily find a specific track, route or waypoint by expanding the appropriate containing Tracks, Routes or Waypoints sublayer in the
645layers panel to show all the individual items and then typing the name of the track, route or waypoint.
646</para>
647
648<para>
649The containing Tracks, Routes or Waypoints sublayers are only shown when items of that type exist.
650To start creating them enter into a create mode via either the <guibutton>Create</guibutton> toolbar commands or the <guimenuitem>New</guimenuitem> menu commands.
651</para>
652
653<para>
654The sublayers also offer right click menu options.
655These are the same as those available at the TrackWaypoint level, but only those that relate to the sublayer type.
656</para>
657
658<para>
659By default routes are coloured red. Tracks are automatically assigned a spread of colours.
660</para>
661
662<para>
663Most operations are available on tracks are available on routes, except for functionality that relies on having timestamps - since routes by definition have no timing information. Thus for example, uploading a route to OpenStreetMap Traces is not available nor is Geotagging on a route.
664It is possible to convert between Tracks and Routes, although converting from a Track to a Route may involve a loss of information (hence you are required to confirm this operation before it happens).
665</para>
666
667<section><title>Layer Operations</title>
668<para>
669The layer has a context menu with several operations.
670</para>
671
672<section><title>View Layer</title>
673<para>
674Version1.1+: This will automatically move the viewport and select the best zoom level to see the whole layer (i.e. all tracks, routes and waypoints).
675</para>
676</section>
677
678<section><title>View</title>
679
680<section id="track_view_all"><title>View All Tracks</title>
681<para>
682Version1.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 routes or waypoints).
683</para>
684</section>
685
686<section id="route_view_all"><title>View All Routes</title>
687<para>
688Version1.4+: This will automatically move the viewport and select the best zoom level to see the all the routes in the layer (ignoring positions of any tracks or waypoints).
689</para>
690</section>
691
692<section id="wp_view_all"><title>View All Waypoints</title>
693<para>
694Version1.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 or routes).
695</para>
696</section>
697
698</section>
699
700<section><title>Goto Center of Layer</title>
701<para>
702This will automatically move the viewport to see the whole layer (i.e. tracks, routes and waypoints). It does not adjust the zoom level.
703</para>
704</section>
705
706<section id="wp_goto"><title>Goto Waypoint</title>
707<para>
708This opens a dialog box to enter a name of waypoint to search for. If it is found the viewport is centred on it.
709</para>
710<note>
711<para>
712Note this search is not very clever and only finds exact matches.
713You are probably better off expanding the waypoint list and directly start typing, as mentioned above, which finds a match based on each letter typed.
714</para>
715</note>
716</section>
717
718<section><title>Export Layer</title>
719<para>
720The layer (all tracks, routes and waypoints) can be exported to a file GPX, GPSPoint, GPSMapper or Google's KML format.
721</para>
722<para>
723Version1.1+: An individual track can be exported to a GPX file via the track menu.
724</para>
725</section>
726
727<section id="finish_track"><title>Finish Track or Route</title>
728<para>
729This is only available when a track or route is being created by the <xref linkend="track_create"/> or <xref linkend="route_create"/> tools.
730Selecting this option ends the creation of that individual track or route.
731</para>
732</section>
733
734<section><title>New</title>
735<section id="new_wp"><title>New Waypoint</title>
736<para>
737This 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.
738</para>
739</section>
740<section id="new_track"><title>New Track</title>
741<para>
742This turns on the <xref linkend="track_create"/> tool.
743</para>
744</section>
745<section id="new_route"><title>New Route</title>
746<para>
747This turns on the <xref linkend="route_create"/> tool.
748</para>
749</section>
750</section>
751
752<section><title>Geotag Images</title>
753<para>
754This starts the Geotagging Images dialog against all tracks in the layer.
755See <link linkend="geotagging">Geotagging</link> for further detail.
756</para>
757</section>
758
759<section><title>Acquire</title>
760<para>
761This offers the same choice from <xref linkend="acquire"/> methods as on the <guimenu>File</guimenu> menu.
762However when invoked from here, the results will be stored in this layer (instead of creating a new one).
763</para>
764</section>
765
766<section><title>Upload</title>
767
768<section id="gps_upload"><title>Upload to GPS</title>
769<para>
770This opens a dialog to select the GPS Device and port to which the layer information will be transferred.
771</para>
772<para>
773The types of GPS information (tracks, routes or waypoints) to be transferred can be selected.
774</para>
775<para>
776Tracks, Routes or Waypoints that are invisible will not be transferred.
777</para>
778</section>
779
780<section id="osm_upload" xreflabel="Upload To OSM" ><title>Upload To OSM</title>
781<para>
782This opens a dialog to upload all tracks and waypoints to <ulink url="http://openstreetmap.org/">OpenStreetMap</ulink> traces.
783Useful if you are an OpenStreetMap contributor (you will need an OpenStreetMap account), these details can be stored in &appname; <xref linkend="prefs_osm"/>
784</para>
785<para>
786 &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 OpenStreetMap.
787</para>
788<warning>
789<para>
790The password is transferred <emphasis role="bold">unencrypted</emphasis> in every request sent to the OpenStreetMap server. This is due to the use of OpenStreetMap's basic authentication method.
791</para>
792<para>Currently &appname; does not support the <ulink url="http://oauth.net/">OAuth</ulink> mechanism.</para>
793</warning>
794</section>
795
796</section>
797
798<section><title>Delete</title>
799<para>Offers deletion of various parts of a TrackWaypoint layer:</para>
800<section id="delete_all_tracks"><title>Delete All Tracks</title>
801<para>Deletes all the tracks in this layer.</para>
802</section>
803<section id="delete_selection_tracks"><title>Delete Tracks from Selection</title>
804<para>Opens a dialog with list of all the tracks from this layer to choose the ones to delete.</para>
805</section>
806<section id="delete_all_routes"><title>Delete All Routes</title>
807<para>Deletes all the routes in this layer.</para>
808</section>
809<section id="delete_selection_routes"><title>Delete Routes from Selection</title>
810<para>Opens a dialog with list of all the routes from this layer to choose the ones to delete.</para>
811</section>
812<section id="delete_all_waypoints"><title>Delete All Waypoints</title>
813<para>Deletes all the waypoints in this layer.</para>
814</section>
815<section id="delete_selection_waypoints"><title>Delete Waypoints from Selection</title>
816<para>Opens a dialog with list of all the waypoints from this layer to choose the ones to delete.</para>
817</section>
818</section>
819
820<section><title>Filter</title>
821<section><title>Simplify All Tracks</title>
822<para>
823This 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.
824</para>
825</section>
826<section><title>Remove Duplicate Waypoints</title>
827<para>
828Remove Duplicate Waypoints - fairly self explainatory, with the results created in a new layer.
829</para>
830<note>
831<para>
832However 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.
833</para>
834</note>
835</section>
836</section>
837
838<section id="filter_with_track"><title>Filter With <emphasis>Trackname</emphasis></title>
839<para>
840This 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:
841</para>
842<itemizedlist>
843<listitem><para>Waypoints Inside This</para></listitem>
844<listitem><para>Waypoints Outside This</para></listitem>
845</itemizedlist>
846<para>
847The result is generated in a new Track/Waypoint layer.
848</para>
849</section>
850
851<section><title>Geotag Images</title>
852<para>
853This starts the Geotagging Images dialog using the specific track.
854See <link linkend="geotagging">Geotagging</link> for further detail.
855</para>
856</section>
857
858</section><!-- End TRW Layer Options -->
859
860<section><title>Track and Route Sublayer Options</title>
861<para>Repeats options available at the TrackWaypoint level, but only those for tracks and routes:</para>
862<itemizedlist>
863<listitem><para>Finish Track or Route. Same as the layer <link linkend="finish_track">Finish Track or Route</link></para></listitem>
864<listitem><para>New Track or Route. Same as the layer <link linkend="new_track">New Track</link> or <link linkend="new_route">New Route</link></para></listitem>
865<listitem><para>View All Tracks or Routes. Same as the layer <link linkend="track_view_all">View All Tracks</link> or <link linkend="route_view_all">View All Routes</link></para></listitem>
866<listitem><para>Delete All Tracks or Routes. Same as the layer <link linkend="delete_all_tracks">Delete All Tracks</link> or <link linkend="delete_all_routes">Delete All Routes</link></para></listitem>
867<listitem><para>Delete Tracks or Routes from Selection. Same as the layer <link linkend="delete_selection_tracks">Delete Tracks from Selection</link> or <link linkend="delete_selection_routes">Delete Routes from Selection</link></para></listitem>
868</itemizedlist>
869</section>
870
871<section><title>Track and Route Properties</title>
872<para>
873Show many useful statistics about a track or a route, including a
874elevation-distance graph and a speed-time graph (if data is available).
875You can click these graphs to jump to the point in the track. You can
876also reverse it, delete duplicates, and split a track from its
877component segments (discontinuous breaks in a track) into separate
878tracks.
879</para>
880<para>
881The following colors are used in the elevation-distance graph:
882</para>
883<variablelist>
884<varlistentry>
885<term>'Main' colour - this is dependent on your Desktop theme - often blue by default</term>
886<listitem><para>elevation data in graph</para></listitem>
887</varlistentry>
888<varlistentry>
889<term>Yellow</term>
890<listitem>
891<para>no elevation data</para>
892</listitem>
893</varlistentry>
894<varlistentry>
895<term>Green</term>
896<listitem>
897<para>elevation data from DEM</para>
898</listitem>
899</varlistentry>
900<varlistentry>
901<term>Red</term>
902<listitem>
903<para>speed</para>
904</listitem>
905</varlistentry>
906</variablelist>
907
908</section>
909
910<section><title>Track and Route Operations</title>
911
912<section><title>Finish Track</title>
913<para>
914This is only available when a track is being created by the <xref linkend="track_create"/> tool.
915Selecting this option ends the creation of the individual track.
916</para>
917</section>
918
919<section><title>Goto</title>
920<para>
921This centers the viewport on the selected position on the track:
922</para>
923<itemizedlist>
924<listitem><para>Startpoint</para></listitem>
925<listitem><para>"Center" - the notional center from the bounds of the track</para></listitem>
926<listitem><para>Endpoint</para></listitem>
927<listitem><para>Version1.1+: Highest Altitude</para></listitem>
928<listitem><para>Version1.1+: Lowest Altitude</para></listitem>
929<listitem><para>Version1.1+: Maximum Speed (Not Available on Routes)</para></listitem>
930</itemizedlist>
931</section>
932
933<section><title>View</title>
934<para>
935Version1.1+: This centers the viewport on the track and selects the best zoom level to see it.
936</para>
937</section>
938
939<section><title>Combine</title>
940<section><title>Merge By Time</title>
941<para>
942This operation repeatedly tries to merge the right-clicked track
943with tracks in the same TrackWaypoint layer. The tracks which are
944merged are those which have at least one trackpoint less than some
945threshold time away. This way, if you somehow end up with lots of small
946segments (say, caused by turning the GPS on and off) you can merge them
947easily into one track.
948</para>
949<para>
950This is not available on routes as they have no timestamps.
951</para>
952</section>
953
954<section><title>Merge With Other Tracks</title>
955<para>
956This opens a dialog listing the other tracks in the same TrackWaypoint layer, from which one can select the other tracks to merge with.
957</para>
958</section>
959
960<section><title>Merge Segments</title>
961<para>
962Combines track segments. Effectively removing track segment markers to leave one segment for the whole track.
963</para>
964</section>
965
966<section><title>Append Track or Route</title>
967<para>
968Enable joining of a single track to the end of the current track.
969This opens a dialog listing the other tracks in the same TrackWaypoint layer from which one can make the selection.
970</para>
971</section>
972</section>
973
974<section><title>Split</title>
975<section><title>Split By Time</title>
976<para>
977This operation will split a single track into segments wherever the
978time interval between successive trackpoints is larger than some
979threshold. This is useful when processing raw NMEA GPS data, especially
980taken over a long time.
981</para>
982<para>
983This is not available on routes as they have no timestamps.
984</para>
985</section>
986
987<section><title>Split By Number of Points</title>
988<para>
989Version1.2+: This operation will split a single track into segments by the number of points specified.
990This can be useful with devices which may have limits on the number of points it supports.
991</para>
992</section>
993
994<section><title>Split Segments</title>
995<para>
996Splits track segments into new tracks.
997</para>
998<para>
999This is not available on routes as they do not have route segments.
1000</para>
1001</section>
1002
1003<section><title>Split at Trackpoint</title>
1004<para>
1005Splits the track at the currently selected trackpoint. This is only enabled when a trackpoint is selected.
1006</para>
1007</section>
1008</section>
1009
1010<section><title>Delete Points</title>
1011<section><title>Delete Points With the Same Position</title>
1012<para>
1013Deletes subsequent points that have the same position (but have different timestamps).
1014</para>
1015</section>
1016<section><title>Delete Points With the Same Time</title>
1017<para>
1018Deletes subsequent points that have the same time stamp (but may have different positions).
1019</para>
1020<para>
1021This is not available on routes as they have no timestamps.
1022</para>
1023</section>
1024
1025</section>
1026
1027<section><title>Apply DEM data</title>
1028<para>
1029If any DEM data is loaded, this will apply the DEM data to give the track elevation data.
1030</para>
1031</section>
1032
1033<section><title>Export Track as GPX</title>
1034<para>
1035Version1.1+: This allows exporting the track as a GPX file by opening a file save dialog.
1036</para>
1037</section>
1038
1039<section><title>Extend Track End</title>
1040<para>
1041Changes the current tool to add trackpoints to the end of the track.
1042</para>
1043</section>
1044
1045<section><title>Extend Using Route Finder</title>
1046<para>
1047Enables 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.
1048</para>
1049</section>
1050
1051<section><title>Upload</title>
1052
1053<section><title>Upload to GPS</title>
1054<para>
1055Same as the layer <link linkend="gps_upload">Upload to GPS</link> command, but only applies to the track.
1056</para>
1057</section>
1058
1059<section><title>Upload to OSM</title>
1060<para>
1061Same as the layer <link linkend="osm_upload">Upload to OSM</link> command, but only applies to the track.
1062</para>
1063</section>
1064
1065</section>
1066
1067<section><title>Use With Filter</title>
1068<para>
1069This selects the track to be used in the <link linkend="filter_with_track">Filter With <emphasis>Trackname</emphasis></link> feature.
1070</para>
1071<para>
1072This is not available on routes.
1073</para>
1074</section>
1075
1076<section><title>View Google Directions</title>
1077<para>
1078This option is only available on a track created using the Route Finder tool.
1079</para>
1080<para>
1081Launch a web browser to see the Google directions page which yielded the route.
1082</para>
1083<note>
1084<para>
1085The 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.
1086</para>
1087</note>
1088</section>
1089
1090</section><!-- End Track Options -->
1091
1092<section><title>Waypoint Sublayer Options</title>
1093<para>Repeats options available at the TrackWaypoint level, but only those for waypoints:</para>
1094<itemizedlist>
1095<listitem><para>New Waypoint. Same as the layer <link linkend="new_wp">New Waypoint</link></para></listitem>
1096<listitem><para>View All Waypoints. Same as the layer <link linkend="wp_view_all">View All Waypoints</link></para></listitem>
1097<listitem><para>Goto Waypoint. Same as the layer <link linkend="wp_goto">Goto Waypoint</link></para></listitem>
1098<listitem><para>Delete All Waypoints. Same as the layer <link linkend="delete_all_waypoints">Delete All Waypoints</link></para></listitem>
1099<listitem><para>Delete Waypoints from Selection. Same as the layer <link linkend="delete_selection_waypoints">Delete Waypoints from Selection</link></para></listitem>
1100</itemizedlist>
1101</section>
1102
1103<section><title>Waypoint Properties</title>
1104
1105<para>
1106This 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).
1107</para>
1108<para>
1109If the waypoint has an associated image, then the Geotag information may be updated, either with updating the file's modification timestamp or not.
1110This can be useful when the waypoint has been moved.
1111</para>
1112
1113</section><!-- WP Prop END -->
1114
1115<section><title>Waypoint Operations</title>
1116
1117<section><title>Goto</title>
1118<para>
1119This centers the viewport on the selected waypoint.
1120</para>
1121</section>
1122
1123<section><title>Visit Webpage</title>
1124<para>
1125If the waypoint's comment (or description) starts with 'http:' then this option is available and allows launching a web browser to go to the webpage.
1126</para>
1127</section>
1128
1129<section><title>Visit Geocache Webpage</title>
1130<para>
1131If the waypoint's name is in Geocache form (GCXXXXX) then this option is available and allows launching a web browser to go to the Geocache page.
1132</para>
1133</section>
1134
1135<section><title>New Waypoint</title>
1136<para>
1137Same as the layer <link linkend="new_wp">New Waypoint</link>.
1138</para>
1139</section>
1140
1141</section><!-- WP END -->
1142
1143<section id="geotagging" xreflabel="Geotagging"><title>Version1.3+: Geotag Images</title>
1144<para>
1145This dialog allows geotagging images (normally taken with a digital camera) via interpolation against a specific track or all tracks in the TrackWaypoint layer - depending on how it is invoked.
1146</para>
1147<para>
1148Images need to have an EXIF DATE_TIME_ORIGINAL (nearly always set by a camera). This timestamp is then used to find the location when the image(s) was taken by searching through the track(s) to find the nearest time - interpolating between points if necessary to set the location.
1149</para>
1150<note>
1151<para>
1152Generally it is good policy to synchronize your camera's clock with your GPS clock before taking photographs. However the times can be adjusted afterwards (if necessary) to take into consideration clock differences.
1153</para>
1154</note>
1155<para>
1156Various options allow control of how the geotagging process is performed:
1157</para>
1158<itemizedlist>
1159<listitem><para>Images - Add the images used for geotagging</para></listitem>
1160<listitem><para>Create Waypoints</para></listitem>
1161<listitem><para>Overwrite Existing Waypoints</para></listitem>
1162<listitem><para>Write EXIF</para></listitem>
1163<listitem><para>Overwrite Existing GPS Information</para></listitem>
1164<listitem><para>Interpolate Between Track Segments</para></listitem>
1165<listitem><para>Image Time Offset - The number of seconds to ADD to the photos time to make it match the GPS data. Calculate this with (GPS - Photo). Can be negative or positive. Useful to adjust times when a camera's timestamp was incorrect.</para></listitem>
1166<listitem><para>Image Timezone - The timezone that the used when the images were created. For example, if a camera is set to AWST or +8:00 hours. Enter +8:00 here so that the correct adjustment to the images' time can be made. GPS data is always in UTC.</para></listitem>
1167</itemizedlist>
1168</section>
1169
1170</section><!-- TRW Layer END -->
1171
1172<section id="GPS" xreflabel="GPS"><title>GPS Layer</title>
1173<para>
1174The GPS layer is responsible for uploading and downloading GPS data
1175from a GPS device. It also is responsible for realtime GPS tracking.
1176Expand the GPS layer in the layers panel to see the two <xref linkend="TrackWaypoint"/> layers it
1177uses for uploading and downloading. To upload, download, or use
1178realtime tracking, right-click the GPS layer and click the appropiate
1179menu item.
1180</para>
1181
1182<section><title>Download</title>
1183<para>
1184To download data from the GPS, right-click the GPS layer and click <guimenuitem>Download from GPS</guimenuitem>.
1185</para>
1186</section>
1187
1188<section><title>Upload</title>
1189<para>
1190To upload data to the GPS, first populate the GPS Upload child
1191layer of the GPS layer (either by creating waypoints/tracks/routes in it, or
1192copying and pasting or dragging waypoints/tracks/routes from another layer).
1193Then right-click the GPS layer and click <guimenuitem>Upload to GPS</guimenuitem>.
1194</para>
1195</section>
1196
1197<section><title>Realtime Tracking</title>
1198<para>
1199You must set up gpsd correctly or use a GPSD server and put the
1200correct information in the GPS layer properties dialog. Then right-click
1201the layer and select <guimenuitem>Start Realtime Tracking</guimenuitem>.
1202</para>
1203</section>
1204
1205<section><title>Empty <emphasis>Item</emphasis></title>
1206<para>
1207There are several options to quickly delete a subsection of data:
1208</para>
1209<itemizedlist>
1210<listitem><para>Empty Realtime</para></listitem>
1211<listitem><para>Empty Upload</para></listitem>
1212<listitem><para>Empty Download</para></listitem>
1213<listitem><para>Empty All</para></listitem>
1214</itemizedlist>
1215</section>
1216
1217</section><!-- End GPS -->
1218
1219<section id="DEM" xreflabel="DEM"><title>DEM (Digital Elevation Model) Layer</title>
1220<para>
1221This layer provides elevation data from the <ulink url="http://www2.jpl.nasa.gov/srtm/">Shuttle Radar Topography Mission (SRTM)</ulink>
1222</para>
1223<para>
1224Elevation 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]
1225</para>
1226<para>
1227To 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.
1228</para>
1229<para>
1230The current data server is: <ulink url="http://dds.cr.usgs.gov/srtm/version2_1/">NASA STRM 2.1</ulink>.
1231</para>
1232<para>
1233ATM &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.
1234</para>
1235<note>
1236<para>
1237Using 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"
1238</para>
1239</note>
1240
1241</section><!-- End DEM -->
1242
1243
1244<section id="Maps" xreflabel="Maps"><title>Maps Layer</title>
1245<para>
1246This layer provides a single map resource, you may have multiple map layers but only top one (if enabled) will be visible.
1247You 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.
1248</para>
1249<para>
1250Some maps are continually improving over time (e.g. OpenStreetMap) 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.
1251</para>
1252<para>
1253Inbuilt maps include various <ulink url="http://en.wikipedia.org/wiki/TerraServer-USA">Terraserver</ulink> (Primarily USA coverage) and <ulink url="http://openstreetmap.org/">OpenStreetMap (OSM)</ulink> ones and more:
1254</para>
1255<itemizedlist>
1256<listitem><para>Bing Bird's Eye (Aerial) Maps (&appname; Version1.2+)</para></listitem>
1257<listitem><para>Terraserver Topos</para></listitem>
1258<listitem><para>Terraserver Aerials</para></listitem>
1259<listitem><para>Terraserver Urban Areas</para></listitem>
1260<listitem><para>OpenStreetMap (Mapquest) - This is the default (&appname; Version1.3+)</para></listitem>
1261<listitem><para>OpenStreetMap (Mapnik)</para></listitem>
1262<listitem><para>OpenStreetMap (Cycle)</para></listitem>
1263<listitem><para>OpenStreetMap (Transport) (&appname; Version1.3+)</para></listitem>
1264<listitem><para>NASA BlueMarble</para></listitem>
1265<listitem><para>SpotMap (&appname; Version1.1+)</para></listitem>
1266</itemizedlist>
1267
1268<para>
1269&appname; can be configured to handle additional maps. See <xref linkend="extend_viking"/> for further detail.
1270</para>
1271
1272<section><title>Layer Operations</title>
1273<section><title>Download Missing Onscreen Maps</title>
1274<para>
1275This requests map tiles for areas of the viewport that do not currently have one.
1276</para>
1277</section>
1278
1279<section><title>Download New Onscreen Maps</title>
1280<para>
1281This requests map tiles only if the maps are older than the Tile Age preference.
1282</para>
1283</section>
1284
1285<section><title>Reload All Onscreen Maps</title>
1286<para>
1287Force a refresh of all visible map tiles.
1288</para>
1289</section>
1290</section>
1291
1292
1293</section><!-- End Maps -->
1294
1295<section id="Aggregate" xreflabel="Aggregate"><title>Aggregate Layer</title>
1296<para>
1297This layer is a container layer to hold other layers. There is always an initial and controlling <emphasis>Top Layer</emphasis> that can not be removed or renamed.
1298</para>
1299<para>
1300This layer type is useful for grouping other layers, especially <xref linkend="TrackWaypoint"/> layers, in whatever categories are relevant to you: such as by activity, location or date.
1301Here are some suggestions:
1302<itemizedlist>
1303<listitem><para>Hiking</para></listitem>
1304<listitem><para>Mountain Biking</para></listitem>
1305<listitem><para>Road Cycling</para></listitem>
1306<listitem><para>Car Trips</para></listitem>
1307<listitem><para>Sailing</para></listitem>
1308<listitem><para>Holidays</para></listitem>
1309<listitem><para>UK Points of Interest</para></listitem>
1310<listitem><para>USA Points of Interest</para></listitem>
1311<listitem><para>etc...</para></listitem>
1312</itemizedlist>
1313</para>
1314<para>
1315Thus one can have a list of all your tracks, but groups can be shown or not using the relevant layers visibility checkbox.
1316</para>
1317
1318<para>
1319This layer only has one operation: <guilabel>New Layer</guilabel>
1320</para>
1321
1322<section><title>New Layer</title>
1323<para>
1324Add a new layer of the selected type.
1325</para>
1326</section>
1327
1328</section><!-- End Agg -->
1329
1330<section id="GeoRef" xreflabel="GeoRef"><title>GeoRef Layer</title>
1331<para>
1332This 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.
1333</para>
1334<section><title>Layer Operations</title>
1335<section><title>Zoom to Fit Map</title>
1336<para>
1337Automatically set a zoom level to see the entire map coverage.
1338</para>
1339</section>
1340
1341<section><title>Goto Map Center</title>
1342<para>
1343Center the viewport on this map.
1344</para>
1345
1346</section>
1347<section><title>Export to World File</title>
1348<para>
1349Opens 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>.
1350</para>
1351</section>
1352</section>
1353
1354</section><!-- End GeoRef -->
1355
1356<section id="Coordinate" xreflabel="Coordinate"><title>Coordinate Layer</title>
1357<para>
1358This layer is allows drawing of grid lines on the viewport.
1359</para>
1360</section><!-- End Coord -->
1361
1362
1363<section id="tools" xreflabel="Tools"><title>Tools</title>
1364<para>
1365&appname;'s mouse actions on the viewport are controlled by which tool is active. Only one tool can be active at a time. The default mode is pan.
1366</para>
1367<para>
1368You can use the scroll wheel, the middle-click, the middle-click+drag to zoom, center map at position and pan respectively no matter what tool you are using.
1369</para>
1370<para>
1371<keycap>Scroll</keycap>: zoom in and out keeping the mouse over same location
1372</para>
1373<para>
1374<keycap>Ctrl-scroll</keycap>: pan north-south (also <keycap>Ctrl-up</keycap>, <keycap>Ctrl-down</keycap>)
1375</para>
1376<para>
1377<keycap>Shift-scroll</keycap>: pan east-west (also <keycap>Ctrl-left</keycap>, <keycap>Ctrl-right</keycap>)
1378</para>
1379<para>
1380<keycap>Ctrl-shift-scroll</keycap>: zoom in and out, without changing the center (also <keycap>Ctrl+</keycap>, <keycap>Ctrl-</keycap> [*not* KeyPad +/-])
1381</para>
1382<para>
1383<keycap>Middle-click</keycap>: make the clicked point on the map the center
1384</para>
1385<para>
1386<keycap>Middle-click</keycap> and drag: pan
1387</para>
1388
1389<section><title>Pan</title>
1390<para>
1391This is the default mode of operation for &appname;.
1392</para>
1393<para>
1394This mode is entered by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/mover_22.png"/></guiicon>
1395</para>
1396<para>
1397Pan moves the viewpoint. A single click centers the viewport at that point, whereas click and drag dynamically moves the view around.
1398This is the default tool.
1399</para>
1400<para>
1401This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+P</keycap>
1402</para>
1403</section>
1404
1405<section><title>Zoom</title>
1406<para>
1407This mode is entered by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/zoom_18.png"/></guiicon>
1408</para>
1409<para>
1410Zooms in and out on the clicked part of the map or by the selected area.
1411</para>
1412<para>
1413This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+Z</keycap>
1414</para>
1415<para>
1416<keycap>Ctrl</keycap> + left or right click: Zoom in/out and center the map on the clicked location
1417</para>
1418<para>
1419<keycap>Shift</keycap> (and hold) + left mouse button: Draws a bounding box area on which to zoom in. The zoom action is performed when the left mouse button is released.
1420</para>
1421</section>
1422
1423<section><title>Ruler</title>
1424<para>
1425This mode is entered by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/ruler_18.png"/></guiicon>
1426</para>
1427<para>
1428The 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.
1429A second click will 'freeze' the ruler at that point.
1430</para>
1431<para>
1432This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+U</keycap>
1433</para>
1434</section>
1435
1436<section id="select" xreflabel="Select"><title>Version1.1+: Select</title>
1437<para>
1438This mode is entered by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/select_18.png"/></guiicon>
1439</para>
1440<para>
1441The select tool allows one to choose any waypoint or track by clicking on it (or reasonably near) in the viewpoint.
1442</para>
1443<para>
1444ATM to select a track one must actually click on a trackpoint, which is also selected.
1445</para>
1446<para>
1447This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+S</keycap>
1448</para>
1449</section>
1450
1451<section><title>TrackWaypoint Layer Tools</title>
1452<para>
1453You must have a <xref linkend="TrackWaypoint"/> Layer selected to use these tools.
1454</para>
1455<section id="createwptool" xreflabel="Create Waypoint"><title>Create Waypoint</title>
1456<para>
1457Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/addwp_18.png"/></guiicon>
1458</para>
1459<para>
1460Left click will open the new waypoint dialog using the specified position.
1461</para>
1462</section>
1463
1464<section id="track_create" xreflabel="Create Track"><title>Create Track</title>
1465<para>
1466Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/addtr_18.png"/></guiicon>
1467</para>
1468<para>
1469Left click to create a new trackpoint. If it's the initial trackpoint you will be asked to enter a name for the track.
1470If <keycap>Ctrl</keycap> is held at the same time, it will jump the new trackpoint position to a nearby existing trackpoint.
1471Right click or <keycap>Backspace</keycap>: undo one point.
1472</para>
1473<para>
1474Double click or <keycap>Escape</keycap>: to finish track creation.
1475Finishing the track is also available via the right click <xref linkend="TrackWaypoint"/> and track menus.
1476</para>
1477<para>
1478One must finish the current track to be able to create another track.
1479</para>
1480</section>
1481
1482<section id="route_create" xreflabel="Create Route"><title>Create Route</title>
1483<para>
1484Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/vik_new_route_18.png"/></guiicon>
1485</para>
1486<para>
1487This operates in exactly the same way as the <link linkend="track_create">Create Track</link> above.
1488</para>
1489<para>
1490One must finish the current route to be able to create another route.
1491</para>
1492</section>
1493
1494<section><title>Edit Waypoint</title>
1495<para>
1496Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/edwp_18.png"/></guiicon>
1497</para>
1498<para>
1499Left Click/drag: select/move a waypoint.
1500If <keycap>Ctrl</keycap> is held at the same time, it will jump the waypoint position to a nearby existing trackpoint.
1501If <keycap>Shift</keycap> is held at the same time, it will jump the waypoint position to a nearby existing waypoint.
1502</para>
1503<para>Right-click on waypoint: opens a menu with waypoint actions (the
1504same menu accessed by right-clicking the waypoint in the layers panel)
1505</para>
1506</section>
1507
1508<section><title>Edit Trackpoint</title>
1509<para>
1510Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/edtr_18.png"/></guiicon>
1511</para>
1512<para>
1513Left click near a trackpoint (in screen pixel terms) to bring up the Track Point Edit dialog on that trackpoint.
1514Whilst the edit dialog is already open, left click again and drag enables moving of the trackpoint.
1515If <keycap>Ctrl</keycap> is held at the same time, it will jump the new trackpoint position to a nearby existing trackpoint.
1516</para>
1517<para>
1518Options 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.
1519</para>
1520</section>
1521
1522<section><title>Show Picture</title>
1523<para>
1524Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/showpic_18.png"/></guiicon>
1525</para>
1526<para>
1527Opens an image viewer with the picture associated with the waypoint.
1528By default this uses the default system image viewer.
1529For Linux you can override this with the setting in the <xref linkend="prefs_external"/>
1530</para>
1531</section>
1532
1533<section><title>Route Finder</title>
1534<para>
1535Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/route_finder_18.png"/></guiicon>
1536</para>
1537<para>Creates a track using Google maps routing between two points.
1538Requires an internet connection. Click one point, then click another to
1539create a track.
1540</para>
1541<para>
1542Right-click: undo last routing (only track removed - not any waypoints)
1543</para>
1544<para>
1545<keycap>Ctrl</keycap>: continue previous track
1546</para>
1547</section>
1548
1549</section>
1550
1551<section><title>Georef Map Layer Tools</title>
1552<para>
1553You must have a <xref linkend="GeoRef"/> Map Layer selected to use these tools.
1554</para>
1555<section><title>Georef zoom</title>
1556<para>
1557Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/geozoom_18.png"/></guiicon>
1558</para>
1559<para>Changes the zoom level of the georeferenced map and changes the
1560&appname; zoom level accordingly. Useful if you are trying to match GPS
1561data to a georeferenced map.
1562</para>
1563</section>
1564
1565<section><title>Georef move</title>
1566<para>
1567Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/geomove_18.png"/></guiicon>
1568</para>
1569<para>
1570Drag to move the georeferenced map.
1571</para>
1572</section>
1573</section>
1574
1575<section><title>Map Download</title>
1576<para>
1577You must have a <xref linkend="Maps"/> Layer selected to use this.
1578</para>
1579<para>
1580Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/mapdl_18.png"/></guiicon>
1581</para>
1582<para>
1583Click to download a single tile. Drag to download tiles in the dragged rectangle area.
1584</para>
1585<para>
1586Right-click to redownload tiles via the selected method. Right-click and drag to redownload tiles in the dragged rectangle area by the selected method.
1587The possible methods to redownload one or more tiles are:
1588</para>
1589<para>
1590<itemizedlist>
1591<listitem><para>Bad - Only if the tile is corrupt in some way or missing, then this will download a new copy</para></listitem>
1592<listitem><para>New - Refresh the tile according to the local map cache and if server has a newer version</para></listitem>
1593<listitem><para>All - Redownload the tile</para></listitem>
1594</itemizedlist>
1595</para>
1596<formalpara><title>Map Tile Information</title>
1597<para>
1598By right clicking on viewport you can see the tile properties of the that location for the current map layer and current zoom level.
1599This includes the remote source URL for the tile and the cached version on the local filesystem with timestamp details.
1600</para>
1601</formalpara>
1602<para>
1603<figure>
1604<title>Map Tile Info Dialog: Example</title>
1605<screenshot>
1606 <graphic format="PNG" fileref="figures/map_tile_info_dialog.png"/>
1607</screenshot>
1608</figure>
1609This is using MapQuest at &appname; zoom level 128 over the Isle of Wight, UK.
1610</para>
1611</section>
1612
1613<section><title>DEM Download</title>
1614<para>
1615You must have a <xref linkend="DEM"/> Layer selected to use this.
1616</para>
1617<para>
1618Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/demdl_18.png"/></guiicon>
1619</para>
1620<para>
1621Click to download and import a DEM file.
1622</para>
1623</section>
1624
1625<section><title>Webtools</title>
1626<para>
1627Many services are available only via a web browser (Google Maps, OpenStreetMap Potlach editor, etc.).
1628</para>
1629<para>
1630Jumping from &app; to such service can become annoying.
1631</para>
1632<para>
1633&appname; allows you to open such service directly at the position currently viewed in &app;.
1634</para>
1635<para>
1636This feature is called <guilabel>Webtools</guilabel>. It is also known as External Tools.
1637</para>
1638</section>
1639
1640</section>
1641
1642<!-- Preferences -->
1643<section id="prefs" xreflabel="Preferences"><title>Preferences</title>
1644<section><title>General</title>
1645<section><title>Localisation</title>
1646<para>You can select units displayed by &appname; to best fit your usage.</para>
1647<figure>
1648<title>Properties dialog: units part</title>
1649<screenshot>
1650 <graphic format="PNG" fileref="figures/properties_units.png"/>
1651</screenshot>
1652</figure>
1653<para>Concerning degrees, you can select the way to display them:
1654<variablelist>
1655<varlistentry>
1656<term>DDD</term><listitem><para>decimal degree</para></listitem>
1657</varlistentry>
1658<varlistentry>
1659<term>DMM</term><listitem><para>partial sexagesimal display: degrees, minutes and decimal part of minutes</para></listitem>
1660</varlistentry>
1661<varlistentry>
1662<term>DMS</term><listitem><para>sexagesimal display: degrees, minutes and seconds</para></listitem>
1663</varlistentry>
1664</variablelist>
1665</para>
1666<figure>
1667<title>Properties dialog: degree display options</title>
1668<screenshot>
1669 <graphic format="PNG" fileref="figures/properties_degree.png"/>
1670</screenshot>
1671</figure>
1672</section>
1673<section><title>Waypoint Icon Size</title>
1674<para>An option exists to control the icon (symbol) size used for waypoints
1675</para>
1676</section>
1677<section><title>'Home' Default Location: Latitude and Longitude</title>
1678<para>You can set the 'Home' location directly by inputting the latitude and longitude in decimal degrees.
1679</para>
1680</section>
1681<section><title>Tile's age</title>
1682<para>This age is used to decided wether or not a new request to tile server must be done.
1683</para>
1684<para>Changing this value, you will increase or decrese the network load.</para>
1685</section>
1686<section><title>Default maplayer directory</title>
1687<para>This property sets the default directory of the tiles cache.
1688This value is used when you create a new map layer.
1689</para>
1690<para>You are still able to change this value in each map layer properties.</para>
1691</section>
1692<section><title>Map Cache Memory Size</title>
1693<para>This controls the amount of maps that are stored in memory, rather than having to reread from disk.
1694Generally if you have a system with lots of memory it's recommended to increase this value.
1695</para>
1696</section>
1697</section>
1698
1699<section id="prefs_external" xreflabel="Export/External Preferences"><title>Export/External</title>
1700<section><title>KML Export Units</title>
1701<para>Allows setting the units used when saved as the KML file type, such as Metric or Statue units</para>
1702</section>
1703<section><title>Image Viewer (Not Windows)</title>
1704<para>Allows setting the program used to view images associated with Waypoints.</para>
1705<para>By default this is set to <application>xdg-open</application> which should open the system's default image viewer, however this can be overridden with this setting.</para>
1706<para>Note: for Windows systems, viewing images associated with Waypoints always uses the system's default image viewer.</para>
1707</section>
1708<section><title>External GPX programs</title>
1709<para>Allows setting the programs invoked via the <xref linkend="TrackWaypoint"/> Layer menu <menuchoice><guimenu>Export Layer</guimenu><guisubmenu>Open With 'program'</guisubmenu></menuchoice></para>
1710<para>Two options are given so that it can be configured for various uses such as:</para>
1711<itemizedlist>
1712<listitem><para>An OSM editor (default)</para></listitem>
1713<listitem><para>Some other user defined program</para></listitem>
1714</itemizedlist>
1715</section>
1716</section>
1717
1718<section id="prefs_osm" xreflabel="OpenStreetMap Traces Preferences"><title>OpenStreetMap Traces</title>
1719<section><title>OSM Username + Password</title>
1720<para>Store your OSM details here, so that you don't need to enter it in every time in the <xref linkend="osm_upload"/> procedure.</para>
1721<warning>
1722<para>
1723Your OSM password will be stored in plain text.
1724</para>
1725</warning>
1726</section>
1727</section>
1728
1729</section>
1730
1731<!-- HOWTOS-->
1732<section><title>Howto's</title>
1733<section id="howto_start"><title>Getting Started</title>
1734<para>
1735To quickly get started using &appname;, follow these instructions.
1736</para>
1737<section><title>Go to an area of interest</title>
1738<para>
1739&appname;'s default location is a Manhatten, New York, USA, so you may need to pick another place that interests you - such as where you live.
1740</para>
1741<procedure>
1742<title>Method A</title>
1743<step>
1744<para>
1745 Use the online location address/place search.
1746</para>
1747<para>
1748 Use the <guibutton>Go to Location</guibutton> toolbar button or from the menus
1749 <menuchoice><guimenu>View</guimenu><guimenuitem>Go to Location</guimenuitem></menuchoice>.
1750 You can change the search location provider if desired.
1751 Enter the name of place you wish to go to (you may need to specify the country to refine the search).
1752 Also you can enter a post code or a ZIP code instead.
1753</para>
1754<note>
1755 <para>You will need an internet connection for this search to work</para>
1756</note>
1757</step>
1758</procedure>
1759<procedure>
1760<title>Method B</title>
1761<step>
1762<para>
1763 If you know the coordinates of where you want to view:
1764</para>
1765<para>
1766Use <menuchoice><guimenu>View</guimenu></menuchoice> and select from either <menuchoice><guimenu>Go to Lat/Lon</guimenu></menuchoice> or <menuchoice><guimenu>Go to UTM</guimenu></menuchoice> and then enter in the specific coordinates.
1767</para>
1768</step>
1769</procedure>
1770<procedure>
1771<title id="method_c">Method C</title>
1772<step>
1773<para>Use the GPS Layer or <menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From GPS</guimenuitem></menuchoice>
1774to load data directly from your GPS into &appname;.
1775</para>
1776<para>You can specify the types of data to acquire: Tracks, Routes and/or Waypoints.
1777</para>
1778<note>
1779<para>You must have write permission to the port used. For <trademark>Unix</trademark> like OS:</para>
1780<itemizedlist>
1781 <listitem><para>/dev/ttyS0 is the first serial port</para></listitem>
1782 <listitem><para>/dev/ttyUSB0 is the first USB port</para></listitem>
1783 <listitem><para>usb: is any USB port</para></listitem>
1784</itemizedlist>
1785<para>Depending on your distribution only one of the USB port types may work</para>
1786<para>For <trademark>Windows</trademark>:</para>
1787<itemizedlist>
1788 <listitem><para>com1: is the first serial port</para></listitem>
1789 <listitem><para>usb: is any USB port</para></listitem>
1790</itemizedlist>
1791</note>
1792<note>
1793 <para>The GPS devices supported are those supported by <application>GPSBabel</application>.</para>
1794 <para>Garmin and Magellan GPS devices supported by all versions, later versions of GPSBabel support more devices such as DeLorme and Navilink.</para>
1795</note>
1796</step>
1797</procedure>
1798<procedure>
1799<title>Method D</title>
1800<step>
1801<para>
1802Get data from files in GPX or KML format, which can be opened directly.
1803Use <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice>
1804</para>
1805<para>
1806Other formats can be imported that are supported by GPSBabel.
1807<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>Import File With GPSBabel...</guimenuitem></menuchoice>
1808</para>
1809<note>
1810<para>
1811The viewport will be automatically moved and resized to view the contents of the file.
1812</para>
1813</note>
1814</step>
1815</procedure>
1816</section>
1817<section><title>Add a map layer</title>
1818<para>
18191. Use Layers - New Map Layer, and choose a suitable cache directory
1820where you would like to store your tracks and click <guilabel>OK</guilabel>. Zoom to a
1821comfortable level (I suggest 4 mpp) by clicking the left and right
1822mouse buttons on the gray area where your tracks are. Now from the menu
1823choose Tools - Map Download, Click where you would like to download a
1824map. Regardless of what tool you are using, the middle mouse button
1825always pans. </para>
1826<note>
1827<para>
1828You need an open internet connection when you are downloading maps.
1829</para>
1830</note>
1831<para>
18321. You will notice the maps are being drawn on top of the tracks, which
1833is probably not what you want. Look at the Layers Panel to the left.
1834Notice how the layer named Map is ABOVE your TrackWaypoint layer that
1835your GPS data is in. This means that it will be drawn last, or on top
1836of the other layers. Select the Map layer from the list and click the
1837down arrow button beneath the list. Your tracks will now be drawn over
1838the map. </para>
1839</section>
1840
1841<section><title>Set Your Home Location</title>
1842<para>
1843 You can save the current center position of the viewport as the default location AKA the Home Location by
1844 <menuchoice><guimenu>Edit</guimenu><guimenuitem>Set the Default Location</guimenuitem></menuchoice>.
1845</para>
1846<para>
1847 Then at any time you can return to this place by clicking on the <guibutton>Home</guibutton> icon on the toolbar.
1848</para>
1849<para>
1850 You can also set the default location via specifing the exact latitude and longitude in the <xref linkend="prefs"/>.
1851</para>
1852</section>
1853
1854</section>
1855<section><title>From 1st startup to GPS track (including offline maps)</title>
1856<para>
1857The first you'll see is an empty map, because &appname; in its default configuration will download maps only on demand.
1858Before 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'.
1859</para>
1860<section><title>Fetching the maps</title>
1861<para>
1862<emphasis role="bold">Map</emphasis>
1863</para>
1864<procedure>
1865<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New Map Layer</guimenuitem></menuchoice></para></step>
1866<step><para>in the layer properties dialogue choose e.g. <guilabel>OpenStreetMap (Mapnik)</guilabel>.</para></step>
1867<step>
1868<para>For the moment, we keep the default <guilabel>Maps Directory</guilabel> (the directory in
1869which the maps will be stored and can be used for offline usage).</para>
1870</step>
1871<step>
1872<para>Check <guilabel>Autodownload maps</guilabel> and keep the zoom level as <guilabel>Use Viking
1873Zoom Level</guilabel>.</para>
1874<note>
1875<para>
1876however, that these settings will play an important
1877role in the pre-fetch for offline usage discussed later
1878</para>
1879</note>
1880</step>
1881</procedure>
1882<para>You'll see a map of Stuttgart. Using the mouse wheel, you can
1883zoom in and out. The maps for the choosen resolution will be downloaded
1884automatically.
1885</para>
1886<para>
1887<emphasis role="bold">DEM Layer (Height Map)</emphasis>
1888</para>
1889<procedure>
1890<step><para>Zoom out to 512.</para></step>
1891<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New DEM Layer</guimenuitem></menuchoice></para></step>
1892<step><para>Keep the download source as is (SRTM Global 90m), hit <guilabel>OK</guilabel>.</para></step>
1893</procedure>
1894
1895<para>In the layer listing on the left, the <xref linkend="DEM"/> layer should reside
1896above the map layer. If this is not the case, highlight the DEM layer
1897an shift it one up (using the arrow up button).
1898</para>
1899<procedure>
1900<step><para>highlight the DEM layer in the layer listing on the left</para></step>
1901<step><para>in the toolbar, check DEM layer download/import (the last symbol)</para></step>
1902<step><para>a left-click in the map window should then fetch the DEM data</para></step>
1903</procedure>
1904<para>
1905This might take some time.
1906</para>
1907<para>
1908Sometimes, a tile does not show up correctly (you might see only a
1909black frame in the map window) because it got corrupted during
1910transfer. In order to correct this, you can delete the corresponding
1911datafile in the cache. <programlisting> right-click the DEM layer properties</programlisting>
1912</para>
1913<para>
1914The <guilabel>DEM Files</guilabel> listing allows you to delete the specific tiles (alternatively do this from the command line).
1915</para>
1916<para>
1917You can also alter the Min. and Max. elevation in this dialogue.
1918</para>
1919
1920</section>
1921<section><title>GPS Track with Height Profile</title>
1922<procedure>
1923<step><para>Uncheck the <xref linkend="DEM"/> layer (the map is shown again)</para></step>
1924<step>
1925 <para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New TrackWaypoint Layer</guimenuitem></menuchoice></para>
1926 <para>Ensure the new track layer is above the map layer.</para>
1927</step>
1928<step><para>Expand the <xref linkend="TrackWaypoint"/> layer, select <guimenuitem>Tracks</guimenuitem></para></step>
1929<step><para>In the tools menu choose <guiicon><inlinegraphic fileref="figures/addtr_18.png"/></guiicon> <guibutton>Create Track</guibutton>
1930</para></step>
1931<step><para>Leftclick in the map window, enter a name</para></step>
1932<step>
1933 <para>Click several times to generate a track (a right-click removes the last point).</para>
1934 <para>Height data is set automatically since DEM data is available</para>
1935</step>
1936<step><para>Expand tracks in the layer menu, your track should show up, select it</para></step>
1937<step><para>Right click your track, select <guimenuitem>Properties</guimenuitem></para></step>
1938<step><para>Click the tab <guilabel>Elevation-distance</guilabel> - enjoy the plot</para></step>
1939</procedure>
1940<para>
1941In order to save this setting for later usage
1942</para>
1943<procedure>
1944<step><para>click <guilabel>OK</guilabel> in the <guilabel>Track Properties</guilabel> dialog</para></step>
1945<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>
1946</procedure>
1947
1948</section>
1949<section><title>Usecase: offline data for holiday</title>
1950<para>
1951Suppose you want to have the <xref linkend="Maps"/> and <xref linkend="DEM"/> data offline for your holiday in Italy near Bologna.
1952</para>
1953<procedure>
1954<step><para>Start a new &appname; session.</para></step>
1955<step><para><menuchoice><guimenu>View</guimenu><guimenuitem>Go to Location</guimenuitem></menuchoice>, enter Bologna</para></step>
1956<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New Map Layer</guimenuitem></menuchoice></para></step>
1957<step><para>Choose e.g. <guilabel>OpenStreetMap (mapnik)</guilabel>.</para></step>
1958<step><para>adapt the <guilabel>maps directory</guilabel> e.g. to <filename>/home/user/.viking-map-holiday/</filename>.
1959This allows you to delete the map stuff after holiday without purging the rest of your maps.
1960</para></step>
1961<step><para>check <guilabel>autodownload map</guilabel></para></step>
1962<step><para>keep <guilabel>viking zoom level</guilabel></para></step>
1963<step><para>zoom out to 1024</para></step>
1964<step><para>add a <xref linkend="DEM"/> layer (as discussed above)</para></step>
1965<step><para>download the DEM data</para></step>
1966</procedure>
1967<para>In the &app; version discussed here, the DEM data automatically
1968are stored in <filename>/home/user/.viking-maps/</filename>. You can move the corresponding
1969tiles into <filename>.viking-map-holiday/</filename> if you like.
1970</para>
1971<para>
1972<emphasis role="bold">Download map data for all zoom levels</emphasis>
1973</para>
1974<procedure>
1975<step><para>uncheck the DEM layer for the map to show up</para></step>
1976<step><para>navigate the map to be centered at Bologna</para></step>
1977<step><para>choose the zoom such, that all regions of interest are displayed in the map window (e.g. 1024)</para></step>
1978<step>
1979<para>follow this sequence until you have all tiles for all zoom levels you need</para>
1980<substeps>
1981<step><para>right-click the map layer properties</para></step>
1982<step><para>set the zoomlevel explicitely one below the last (in the first cycle 512), hit OK</para></step>
1983<step><para>right click the map layer <guimenuitem>Download Missing Onscreen Maps</guimenuitem></para></step>
1984<step><para>wait until all tiles for that resolution have been downloaded</para></step>
1985</substeps>
1986</step>
1987</procedure>
1988<para>This may take some time and some hard disk capacity.</para>
1989<para>
1990Do not forget to save your configuration (as discussed above).
1991</para>
1992
1993</section>
1994
1995</section>
1996<section><title>OpenStreetMap project</title>
1997<para>
1998<ulink url="http://openstreetmap.org/">OpenStreetMap (OSM)</ulink> is a collaborative project to create a free editable map of the world.
1999One of sources of data for this project is GPS tracks.
2000&appname; supports this project via the GPS Traces methods, both uploading and downloading such data.
2001</para>
2002<para>
2003Also see <ulink url="http://wiki.openstreetmap.org/wiki/API_v0.6#GPS_Traces"/> for further detail.
2004</para>
2005<section><title>Uploading data to OpenStreetMap</title>
2006<para>
2007It is possible to upload data directly from &appname; to OpenStreetMap.
2008</para>
2009<formalpara>
2010<title>Upload a layer</title>
2011<para>
2012One solution is to upload whole a <xref linkend="TrackWaypoint"/> layer. To do this,
2013simply select the layer and right click on it. Then, select <guimenuitem>Upload to
2014OSM</guimenuitem>.
2015</para>
2016</formalpara>
2017<formalpara>
2018<title>Upload a single track</title>
2019<para>Another solution is to upload an individual track. Simply select the track and right click on it.
2020Then select <guimenuitem>Upload to OSM</guimenuitem>.
2021</para>
2022</formalpara>
2023<formalpara>
2024<title>Fill in the form</title>
2025<para>
2026In both cases, &appname; will retain some information.
2027The email field is the email you used to subscribed into OpenStreetMap.
2028The password field is the password you used with this account.
2029The filename is the name you want your upload has on the server. This information is displayed by the osm server.
2030The description is some descriptive information.
2031The tags field is a white separated list of tags.
2032</para>
2033</formalpara>
2034</section>
2035
2036<section id="osm_dl" xreflabel="OpenStreetMap Traces Download"><title>Downloading Traces from OpenStreetMap</title>
2037<para>
2038It is possible to download GPS traces directly from OpenStreetMap into &appname;.
2039This feature can be really useful for checking existing data before uploading new ones.
2040</para>
2041<formalpara>
2042<title>Download all visible tracks</title>
2043<para>One solution is to select
2044<menuchoice>
2045<guimenu>File</guimenu>
2046<guisubmenu>Acquire</guisubmenu>
2047<guimenuitem>OSM traces...</guimenuitem>
2048</menuchoice>.
2049Each request can get up to 5,000 points.
2050The dialog box allows setting which group of 5,000 points to get. These groups are known as 'Page Numbers' which start at 0.
2051Increasing the page number parameter allows one to request the subsequent sets of point groups.
2052</para>
2053</formalpara>
2054</section>
2055<section id="osm_my_dl" xreflabel="OpenStreetMap My Traces Download"><title>Downloading Your Own Traces from OpenStreetMap</title>
2056<para>
2057It is possible to download any of <emphasis>your personal</emphasis> GPS traces previously uploaded to OpenStreetMap into &appname;.
2058</para>
2059<para>
2060You will need to provide your OSM username and password to get the list of your OSM Traces.
2061From this list you can select which traces to retrieve.
2062This list can be sorted on each column so that it easier to find an individual trace or select a group of traces by similar properties.
2063</para>
2064</section>
2065
2066</section>
2067
2068<section><title>Geotagging</title>
2069<para>
2070 This assumes you already have a <xref linkend="Maps"/> layer enabled for ease of use (if not see above to get one).
2071</para>
2072<section><title>Manual Positioning</title>
2073<para>
2074 This is useful for instances when you already know exactly where the image was taken (no need for tracklog).
2075 Or maybe you want to adjust an automatically generated waypoint for the position of the subject of the image rather than the location that the photograph is taken from.
2076 ATM this process only works on an individual image, so it will be tedious for handling lots of images.
2077</para>
2078<para>
2079 First create a <xref linkend="TrackWaypoint"/> layer or use an existing one; and select it in the Layers Panel.
2080 NB Make sure this layer is above the map layer in the Layers Panel list.
2081 Create a new waypoint (or move an existing one) to exact location desired:
2082<itemizedlist>
2083 <listitem><para>Select the <xref linkend="createwptool"/> tool, then left click on the map at the location desired, choosing an image to associate with it in the new waypoint dialog</para></listitem>
2084 <listitem><para>Select the <xref linkend="select"/> tool, then left click on waypoint to be moved. Left click again and drag the waypoint to the location desired</para></listitem>
2085</itemizedlist>
2086 Then using the Select tool left click on waypoint to select it, then right click to access the Waypoint properties menu, then choose
2087 <menuchoice><guimenu>Update Geotag on Image</guimenu><guisubmenu>Update</guisubmenu></menuchoice>
2088</para>
2089<para>
2090 The <guilabel>Update Geotag on Image</guilabel> options are only available when a waypoint has an image associated with it.
2091</para>
2092</section>
2093
2094<section><title>Automatic Positioning Against a Tracklog</title>
2095<para>
2096 First you will need a tracklog with timestamps in it. Either load one from a previously saved file or freshly acquired from a GPS device -
2097 see <link linkend="howto_start">Getting Started</link>.
2098 It helps if this is the track that was recorded at the time you took some photographs!
2099</para>
2100<para>
2101 Select the track either from the layers panel on the left or via the viewport using the <xref linkend="select"/> tool.
2102 Then right click on it and chose the <menuchoice><guimenu>Geotag Images...</guimenu></menuchoice> leading you to the <xref linkend="geotagging"/> Dialog.
2103</para>
2104<para>
2105 Load some images that where taken around the time the track log was recorded. Confirm the other options in the dialog - normally the defaults should be alright and select OK.
2106 If things are succesful, new waypoints with thumbnail images of the photographs will appear.
2107 You should probably check they are really in the right place as often the timestamp of the camera may not be aligned to the GPS correctly leading to inferring incorrect locations.
2108</para>
2109<formalpara><title>Option: Overwrite Waypoints</title>
2110<para>
2111 This is particularly useful when one finds an attempt at geotagging gives wrong locations, often due to time offset issues.
2112 Simply try again with a new time offset (often 1 hour adjustments due to Daylight Savings or Summer Time times) and the old waypoints will be updated (instead of creating new ones).
2113</para>
2114</formalpara>
2115<para>
2116 If you have multiple tracks in a TrackWaypoint layer, then invoking the <menuchoice><guimenu>Geotag Images...</guimenu></menuchoice> action on the layer
2117 will search all the tracks to find location matches.
2118</para>
2119</section>
2120</section>
2121
2122<section><title>GPS Real Time Location (Not <trademark>Windows</trademark>)</title>
2123<para>
2124 &appname; relies on <ulink url="http://www.catb.org/gpsd/">gpsd</ulink> to provide the current location from a real time feed from a GPS device.
2125 Unfortunately <application>gpsd</application> is not available on <trademark>Windows</trademark>,
2126 so currently this functionality is disabled in <trademark>Windows</trademark> builds of &appname;
2127</para>
2128<para>
2129 This assumes you already have a <xref linkend="Maps"/> layer enabled for ease of use (if not see above to get one).
2130</para>
2131<para>
2132 Turn on the GPS Device, ensure it has figured out it's location and plug it in to your computer.
2133</para>
2134<section><title>Set Up GPS Layer</title>
2135<para>
2136 You will need a <xref linkend="GPS"/> layer. One can be added via <menuchoice><guimenu>Layers</guimenu><guisubmenu>Add GPS Layer</guisubmenu></menuchoice>.
2137</para>
2138<para>
2139 Adjust the <emphasis>Realtime Tracking Mode</emphasis> settings to interface with <ulink url="http://www.catb.org/gpsd/">gpsd</ulink> as necessary. Normally the defaults should suffice.
2140</para>
2141<para>
2142 Current Linux distributions should run <application>gpsd</application> automatically when a GPS Device is plugged in. Otherwise you may have to run <application>gpsd</application> manually.
2143</para>
2144<para>
2145 Then right-click the layer and select <guimenuitem>Start Realtime Tracking</guimenuitem>.
2146 Hopefully the viewport should jump to the GPS location.
2147</para>
2148<para>
2149 Troubleshooting checklist:
2150</para>
2151<procedure><step><para>Confirm <application>gpsd</application> is running.</para></step></procedure>
2152<procedure><step><para>Confirm on the GPS device it has a location.</para></step></procedure>
2153<procedure><step><para>Confirm the <emphasis>Realtime Tracking Mode</emphasis> settings.</para></step></procedure>
2154</section>
2155</section>
2156
2157<section id="extend_viking" xreflabel="Extending Viking">
2158 <title>Extending Viking</title>
2159
2160 <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>
2161 <para>Here is an example:
2162<programlisting><![CDATA[
2163<objects>
2164 <object class="ClassName">
2165 <property name="property_name1">Property value</property>
2166 <property name="property_name2">Property value</property>
2167 </object>
2168 ...
2169<objects>
2170]]>
2171</programlisting>
2172</para>
2173 <para>You can find more examples in the documentation part of the distribution.</para>
2174 <section>
2175 <title>Map Source</title>
2176 <para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename> for <trademark>UNIX</trademark> like systems and <filename>C:\Documents and Settings\<replaceable>username</replaceable>\.viking\maps.xml</filename> on <trademark>Windows XP</trademark>.</para>
2177 <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>
2178
2179 <para>The VikSlippyMapSource allows to declare any map's source working like OpenStreetMap. It supports the following properties:
2180 <variablelist>
2181 <varlistentry>
2182 <term>id</term>
2183 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
2184 </varlistentry>
2185 <varlistentry>
2186 <term>label</term>
2187 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
2188 </varlistentry>
2189 <varlistentry>
2190 <term>hostname</term>
2191 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
2192 </varlistentry>
2193 <varlistentry>
2194 <term>url</term>
2195 <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>
2196 </varlistentry>
2197 </variablelist>
2198 </para>
2199 <para>The VikTmsMapSource allows to declare any TMS service. It supports the following properties:
2200 <variablelist>
2201 <varlistentry>
2202 <term>id</term>
2203 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
2204 </varlistentry>
2205 <varlistentry>
2206 <term>label</term>
2207 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
2208 </varlistentry>
2209 <varlistentry>
2210 <term>hostname</term>
2211 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
2212 </varlistentry>
2213 <varlistentry>
2214 <term>url</term>
2215 <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>
2216 </varlistentry>
2217 </variablelist>
2218 </para>
2219 <para>The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties:
2220 <variablelist>
2221 <varlistentry>
2222 <term>id</term>
2223 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
2224 </varlistentry>
2225 <varlistentry>
2226 <term>label</term>
2227 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
2228 </varlistentry>
2229 <varlistentry>
2230 <term>hostname</term>
2231 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
2232 </varlistentry>
2233 <varlistentry>
2234 <term>url</term>
2235 <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>
2236 </varlistentry>
2237 </variablelist>
2238 </para>
2239 </section>
2240
2241 <section>
2242 <title>Go-to search engines</title>
2243 <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>
2244 <para>An example of the file in the distribution <filename>doc/examples/goto_tools.xml</filename>.</para>
2245 <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>
2246 <para>The related properties are:
2247 <variablelist>
2248 <varlistentry>
2249 <term>label</term>
2250 <listitem><para>the text displayed in the <guilabel>Go-To</guilabel> dialog</para></listitem>
2251 </varlistentry>
2252 <varlistentry>
2253 <term>url-format</term>
2254 <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>
2255 </varlistentry>
2256 <varlistentry>
2257 <term>lat-path</term>
2258 <listitem><para>XML path of the latitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
2259 </varlistentry>
2260 <varlistentry>
2261 <term>lat-attr (optional)</term>
2262 <listitem><para>name of the attribute (of previous element) containing the latitude</para></listitem>
2263 </varlistentry>
2264 <varlistentry>
2265 <term>lon-path</term>
2266 <listitem><para>XML path of the longitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
2267 </varlistentry>
2268 <varlistentry>
2269 <term>lon-attr (optional)</term>
2270 <listitem><para>name of the attribute (of previous element) containing the longiude</para></listitem>
2271 </varlistentry>
2272 </variablelist>
2273 </para>
2274 <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>
2275 </section>
2276
2277 <section>
2278 <title>External tools</title>
2279 <para>It is possible to add new external tools. The file is <filename>~/.viking/external_tools.xml</filename>.</para>
2280 <para>An example of the file in the distribution <filename>doc/examples/external_tools.xml</filename>.</para>
2281 <para>The VikWebtoolCenter allows to declare any Webtool using a logic based on center coordinates and zoom level value.</para>
2282 <para>The related properties are:
2283 <variablelist>
2284 <varlistentry>
2285 <term>id</term>
2286 <listitem><para>this is an integer and should be unique as it used to identify the tool</para></listitem>
2287 </varlistentry>
2288 <varlistentry>
2289 <term>label</term>
2290 <listitem><para>the text displayed in the menu entry</para></listitem>
2291 </varlistentry>
2292 <varlistentry>
2293 <term>url</term>
2294 <listitem><para>the parametrized URL to open, in the spirit of C printf format, with 2 "%s" and a "%d" fields for X, Y and Z (zoom level) (eg. "http://hostname/?lat=%s&amp;lon=%s&amp;zoom=%d")</para></listitem>
2295 </varlistentry>
2296 </variablelist>
2297 </para>
2298 <para>The VikWebtoolBounds allows to declare any Webtool using a logic based on bounds coordinates.</para>
2299 <para>The related properties are:
2300 <variablelist>
2301 <varlistentry>
2302 <term>id</term>
2303 <listitem><para>this is an integer and should be unique as it used to identify the tool</para></listitem>
2304 </varlistentry>
2305 <varlistentry>
2306 <term>label</term>
2307 <listitem><para>the text displayed in the menu entry</para></listitem>
2308 </varlistentry>
2309 <varlistentry>
2310 <term>url</term>
2311 <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 4 "%s" fields for left, right, bottom and top (eg. "http://hostname:8111/load_and_zoom?left=%s&amp;right=%s&amp;bottom=%s&amp;top=%s")</para></listitem>
2312 </varlistentry>
2313 </variablelist>
2314 </para>
2315 </section>
2316
2317 <section>
2318 <title>More</title>
2319 <para>Note that, on <trademark>UNIX</trademark> like systems, the extension files (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>, <filename>external_tools.xml</filename>) are also searched in <filename>/etc/viking</filename> and <filename>/usr/share/viking</filename> directories (or related in your system).</para>
2320 <para>The <envar>XDG_DATA_DIRS</envar> environment variable can be used to change these directories.</para>
2321 <para>The <envar>XDG_DATA_HOME</envar> environment variable s also used (if set) to look for these extension files.</para>
2322 </section>
2323
2324</section>
2325
2326<section><title>What to Do if &appname; Does Not Seem to Work</title>
2327<para>
2328In order to get some information about what &appname; is doing, start it in verbose debug mode via the command line:
2329<programlisting>viking -dV</programlisting>
2330</para>
2331<para>
2332For instance you can check the correct URLs &appname; is using in requesting remote data for DEMs or map tiles in the verbose debug output.
2333E.g. Something like this for DEMs:
2334<screen>
2335** (viking:28778): DEBUG: curl_download_uri: uri=http://dds.cr.usgs.gov/srtm/version2_1/SRTM3/Eurasia/N48E008.hgt.zip
2336* About to connect() to dds.cr.usgs.gov port 80 (#0)
2337* Trying 152.61.128.95... * connected
2338* Connected to dds.cr.usgs.gov (152.61.128.95) port 80 (#0)
2339 GET /srtm/version2_1/SRTM3/Eurasia/N48E008.hgt.zip HTTP/1.1
2340User-Agent: viking/0.9.8 libcurl/7.18.2 GnuTLS/2.4.2 zlib/1.2.3.3 libidn/1.8
2341Host: dds.cr.usgs.gov
2342Accept: */*
2343 HTTP/1.1 200 OK
2344 Date: Sun, 26 Jul 2009 18:13:38 GMT
2345 Server: Apache
2346 Last-Modified: Tue, 21 Jul 2009 19:57:35 GMT
2347 ETag: eac3f8-1828f5-46f3caa76070a
2348 Accept-Ranges: bytes
2349 Content-Length: 1583349
2350 Content-Type: application/zip
2351
2352* Connection #0 to host dds.cr.usgs.gov left intact
2353* Closing connection #0
2354** (viking:28778): DEBUG: dem_layer_add_file: /home/username/.viking-maps/srtm3-Eurasia/N48E008.hgt.zip
2355</screen>
2356Or for OSM Mapnik tile server:
2357<screen>
2358* About to connect() to tile.openstreetmap.org port 80 (#0)
2359* Trying 193.63.75.28... * connected
2360* Connected to tile.openstreetmap.org (193.63.75.28) port 80 (#0)
2361 GET /13/4065/2748.png HTTP/1.1
2362User-Agent: viking/0.9.96 libcurl/7.20.1 GnuTLS/2.8.6 zlib/1.2.3.4 libidn/1.18
2363Host: tile.openstreetmap.org
2364Accept: */*
2365
2366* HTTP 1.0, assume close after body
2367 HTTP/1.0 200 OK
2368 Date: Thu, 14 Oct 2010 22:18:42 GMT
2369 Server: Apache/2.2.8 (Ubuntu)
2370 ETag: "b66ff9d46474bab68262a3483428a232"
2371** (viking:16704): DEBUG: curl_get_etag_func: ETAG found: "b66ff9d46474bab68262a3483428a232"
2372 Content-Length: 17194
2373 Cache-Control: max-age=94805
2374 Expires: Sat, 16 Oct 2010 00:38:47 GMT
2375 Content-Type: image/png
2376 Age: 5153
2377 X-Cache: HIT from konqi.openstreetmap.org
2378 X-Cache-Lookup: HIT from konqi.openstreetmap.org:3128
2379 Via: 1.1 konqi.openstreetmap.org:3128 (squid/2.7.STABLE7)
2380 Connection: close
2381
2382* Closing connection #0
2383* About to connect() to a.andy.sandbox.cloudmade.com port 80 (#0)
2384* Trying 178.63.75.195... ** (viking:16704): DEBUG: curl_download_uri: uri=http://tile.openstreetmap.org/13/4065/2749.png
2385* About to connect() to tile.openstreetmap.org port 80 (#0)
2386* Trying 193.63.75.28... * connected
2387* Connected to a.andy.sandbox.cloudmade.com (178.63.75.195) port 80 (#0)
2388 GET /tiles/cycle/13/4065/2747.png HTTP/1.1
2389User-Agent: viking/0.9.96 libcurl/7.20.1 GnuTLS/2.8.6 zlib/1.2.3.4 libidn/1.18
2390Host: a.andy.sandbox.cloudmade.com
2391Accept: */*
2392
2393* connected
2394* Connected to tile.openstreetmap.org (193.63.75.28) port 80 (#0)
2395 GET /13/4065/2749.png HTTP/1.1
2396User-Agent: viking/0.9.96 libcurl/7.20.1 GnuTLS/2.8.6 zlib/1.2.3.4 libidn/1.18
2397Host: tile.openstreetmap.org
2398Accept: */*
2399
2400* HTTP 1.0, assume close after body
2401 HTTP/1.0 200 OK
2402 Date: Thu, 14 Oct 2010 23:44:35 GMT
2403 Server: Apache/2.2.8 (Ubuntu)
2404 ETag: "8e520ad47ce9c1b63430554886eb5fab"
2405** (viking:16704): DEBUG: curl_get_etag_func: ETAG found: "8e520ad47ce9c1b63430554886eb5fab"
2406 Content-Length: 18094
2407 Cache-Control: max-age=87742
2408 Expires: Sat, 16 Oct 2010 00:06:57 GMT
2409 Content-Type: image/png
2410 X-Cache: MISS from konqi.openstreetmap.org
2411 X-Cache-Lookup: MISS from konqi.openstreetmap.org:3128
2412 Via: 1.1 konqi.openstreetmap.org:3128 (squid/2.7.STABLE7)
2413 Connection: close
2414</screen>
2415</para>
2416</section>
2417
2418</section>
2419
2420<section><title>Dependencies</title>
2421<formalpara><title>gpsbabel</title>
2422<para>&appname; uses <ulink url="http://gpsbabel.org/">GPSBabel</ulink> to convert data.</para>
2423</formalpara>
2424<formalpara><title>unbuffer (optional)</title>
2425<para>&appname; uses unbuffer command to optimize conversion calls.</para>
2426</formalpara>
2427<formalpara><title>gpsd (optional - but not <trademark>Windows</trademark>)</title>
2428<para>&appname; can use <ulink url="http://www.catb.org/gpsd/">gpsd</ulink> to get the current location.</para>
2429</formalpara>
2430</section>
2431
2432</article>