]> git.street.me.uk Git - andy/viking.git/blame - help/C/viking.xml
[DOC] Expand keys used for panning the map.
[andy/viking.git] / help / C / viking.xml
CommitLineData
f8b8a0b5 1<?xml version="1.0"?>
c94657d1
RN
2<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
f8b8a0b5
GB
4 <!ENTITY appname "Viking">
5 <!ENTITY app "<application>Viking</application>">
b1f2d51f
RN
6 <!ENTITY appversion "1.5">
7 <!ENTITY manrevision "1.5">
8 <!ENTITY date "October 2013">
f8b8a0b5
GB
9]>
10<!--
11 (Do not remove this comment block.)
12 Maintained by the GNOME Documentation Project
13 http://live.gnome.org/DocumentationProject
14 Template version: 3.0 beta
15 Template last modified 2006-11-21
16
17-->
18<!-- =============Document Header ============================= -->
19<article id="index" lang="en">
20 <articleinfo>
21 <title>&app; Manual</title>
22 <abstract role="description">
23 <para>&app; is a free/open source program to manage GPS data.</para>
24 </abstract>
25
26 <copyright>
1b5f6653 27 <year>2013</year>
f8b8a0b5 28 <holder>Guilhem Bonnefille</holder>
bbfdcbed 29 <holder>Rob Norris</holder>
f8b8a0b5
GB
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>
25c0a45b
RN
47 <author>
48 <firstname>Rob</firstname>
49 <surname>Norris</surname>
50 </author>
a43e638f
RN
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 -->
f8b8a0b5
GB
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>
bbfdcbed 81 <para role="author">Rob Norris <email>rw_norris@hotmail.com</email></para>
f8b8a0b5 82 <para role="publisher">GNOME Documentation Project</para>
bbfdcbed 83 <para>This document was generated on <?dbtimestamp format="Y-m-d"?>.</para>
f8b8a0b5 84 </revdescription>
845a6b70 85 </revision>
f8b8a0b5
GB
86 </revhistory>
87
4502fc82 88 <releaseinfo>This manual describes version &appversion; of &appname;.</releaseinfo>
f8b8a0b5
GB
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 ============================= -->
4502fc82 103<section id="introduction">
f8b8a0b5 104 <title>Introduction</title>
6928e16b 105<para>
7233fcb6
RN
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:
6928e16b
GB
108</para>
109<itemizedlist mark="opencircle"><listitem>
110<para>
c3eb4a65 111Uploading and downloading waypoints, tracks and routes to/from GPS.
6928e16b
GB
112</para>
113</listitem>
114<listitem>
c3eb4a65
RN
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.
6928e16b
GB
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>
9ca89c29 127Analyzing Off Highway Vehicle (OHV) and hiking trips, understanding where you went and how far you were from something.
6928e16b
GB
128</para>
129</listitem>
130<listitem>
c3eb4a65 131<para>Making waypoints, tracks and routes to follow to easily get someplace
9ca89c29 132you've never been before or don't have GPS data for but online
6928e16b
GB
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>
3e8e3227 153Downloading and storing OpenStreetMap and/or Terraserver maps on your hard drive and looking at them later.
6928e16b
GB
154</para>
155</listitem>
156<listitem>
157<para>
c3eb4a65 158Editing routes or tracks and their trackpoints, joining and splitting up tracks and routes.
6928e16b
GB
159</para>
160</listitem>
0ef60ec1 161<listitem>
6928e16b 162<para>
73919102 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.
6928e16b
GB
164</para>
165</listitem>
76b8a4e8
RN
166<listitem>
167<para>
c3eb4a65 168Import track, route and waypoint files of various types via <application>GPSBabel</application>
76b8a4e8
RN
169</para>
170</listitem>
dae48936
RN
171<listitem>
172<para>
173View, create and update Geotagged Images (using EXIF data).
174</para>
175</listitem>
9ca89c29
RN
176</itemizedlist>
177<note>
6928e16b 178<para>
9ca89c29 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>:
6928e16b 180</para>
9ca89c29 181</note>
d4a2cefb
RN
182<figure>
183<title>Screenshot: OSM Cycle Map and Many Tracks</title>
184<screenshot>
185 <graphic format="JPG" fileref="figures/Viking-OSM-CycleMap-ManyTracks.jpg"/>
186</screenshot>
187</figure>
4502fc82 188</section>
7233fcb6 189
6928e16b 190<section><title>General Concepts</title>
63396406 191<section id="gc_layers" xreflabel="Layers"><title>Layers</title>
7233fcb6 192<para>
84017394 193<emphasis>Layers</emphasis> is concept one may know from powerful graphics editors such as <application>Photoshop</application> or <application>GIMP</application>.
7233fcb6 194Instead of putting all the data on the same level, it is stacked (i.e. layered) with different data over one another.
73919102 195This can be useful for analysis and general handling of various sets of data.
7233fcb6
RN
196</para>
197<para>
198Unfortunately the downside of this complexity is remembering how differing layers of data can obscure other data.
199</para>
200<para>
201The Map layers have <ulink url="http://en.wikipedia.org/wiki/Alpha_compositing"><citetitle>Alpha Compositing</citetitle></ulink>,
202to create the appearance of partial transparency.
203By controlling this value one can see data below it in the layer heirarchy for interesting effects.
204</para>
205</section>
63396406 206<section id="gc_layers_panel" xreflabel="Layers Panel"><title>Layers Panel</title>
6928e16b
GB
207<para>
208The panel on the left is called the <emphasis role="bold">layers panel</emphasis>.
209It determines which layers and sublayers (such as tracks and waypoints)
c3a02429
RN
210are shown, and the order in which they are drawn. Layers on the
211top of the layers panel list are drawn last. You can change the order by
6928e16b
GB
212drag and drop, or by selecting a layer and using the up and down
213buttons at the bottom of the layers panel.
214</para>
7233fcb6
RN
215</section>
216<section><title>Viewport</title>
6928e16b 217<para>
7233fcb6 218The main &appname; area where the layer data is drawn, is called the <emphasis role="bold">viewport</emphasis>.
6928e16b 219</para>
6928e16b 220</section>
7233fcb6 221<section><title>Statusbar</title>
7233fcb6 222<para>This provides a readout of various information:</para>
eabf51fc
GB
223<itemizedlist>
224<listitem><para>The currently selected (mouse pointer) tool</para></listitem>
225<listitem><para>The number of items to process in the background - normally this the number in the map tile download queue</para></listitem>
226<listitem><para>The zoom factor</para></listitem>
227<listitem><para>The location of the mouse pointer (and potentially height information if DEM data is available)</para></listitem>
228</itemizedlist>
9a3538f5
GB
229<para>When creating a track/route, the statusbar also displays some information about the track/route.</para>
230<figure>
231<title>Statusbar</title>
232<screenshot>
233 <graphic format="PNG" fileref="figures/trw_statusbar.png"/>
234</screenshot>
235</figure>
236<para>This part of the statusbar displays:
237<itemizedlist>
238<listitem><para>The total distance of the track/route (including currently edited segment).</para></listitem>
239<listitem><para>The bearing of the currently edited segment.</para></listitem>
240<listitem><para>The distance of the currently edited segment.</para></listitem>
241</itemizedlist>
242</para>
c4b6a67d
GB
243<para>For convenience, a zoom selector can be opened from the status bar. Simply left-click on the zoom factor.</para>
244<figure>
245 <title>The zoom selector available from status bar</title>
246 <screenshot>
247 <graphic format="PNG" fileref="figures/zoom_status_popup.png"/>
248 </screenshot>
249</figure>
7233fcb6 250</section>
d587678a
GB
251
252<section><title>Projections</title>
253<para>
254&appname; supports differents projections:
255<itemizedlist>
256<listitem>
257<para>UTM</para>
258</listitem>
259<listitem>
260<para>LatLon (also called EPSG:4326)</para>
261</listitem>
262<listitem>
263<para>Mercator (also called Spherical Mercator)</para>
264</listitem>
265</itemizedlist>
266</para>
267</section>
76936a96 268
5d1c714b
RN
269<section><title>Map Cache</title>
270<para>
271&appname; stores downloaded map tiles to disk for a couple of reasons:
272</para>
273<itemizedlist>
274<listitem><para>Enables off line usage</para></listitem>
275<listitem><para>Reduces loading on the map tile provider</para></listitem>
276</itemizedlist>
277<para>
278The &appname; automatic caching strategy is two fold:
279</para>
280<itemizedlist>
281<listitem>
282<para>
fef1084a 283 If the age of the tile on disk is less than the specified tile age (see <xref linkend="prefs"/>),
5d1c714b
RN
284 it will <emphasis>not</emphasis> attempt to contact the server to get a new version of the tile.
285</para>
286</listitem>
287<listitem>
288<para>
289 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.
290</para>
291</listitem>
292</itemizedlist>
293<para>
294 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.
295</para>
296<note>
297<para>
298 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>)
299</para>
300</note>
301</section>
302
fef1084a 303<section id="shortcut_keys" xreflabel="Shortcut Keys"><title>Shortcut Keys</title>
76936a96
RN
304<para>
305&appname; has several shortcut keys or key combinations for commands as listed in the main window along side the command.
306</para>
307<para>
308Some function keys follow standard GUI behaviour:
309</para>
310<itemizedlist>
311<listitem><para><keycap>F1</keycap> Help (view this manual)</para></listitem>
6b59f63d 312<listitem><para><keycap>F5</keycap> or <keycap>Ctrl+R</keycap> Refresh the maps on screen</para></listitem>
76936a96
RN
313<listitem><para><keycap>F10</keycap> Select the Menubar (in built behaviour)</para></listitem>
314<listitem><para><keycap>F11</keycap> Full Screen</para></listitem>
6b59f63d 315<listitem><para><keycap>Ctrl+F5</keycap> or <keycap>Ctrl+Shift+R</keycap> Redownload the maps on screen</para></listitem>
76936a96 316</itemizedlist>
6b59f63d
RN
317<note>
318<para>
319Refresh attempts to get new maps only if the local tile cache time period has expired for any particular map tile.
320Redownload gets all on screen maps from the server, ignoring the local tile cache.
321</para>
322</note>
76936a96
RN
323<para>
324Other function keys control turn on/off visibility of various elements:
325</para>
326<itemizedlist>
327<listitem><para><keycap>F3</keycap> Toggle visibility of the Toolbar</para></listitem>
328<listitem><para><keycap>F4</keycap> Toggle visibility of the Menubar</para></listitem>
6b59f63d 329<listitem><para><keycap>Shift+F5</keycap> Toggle visibility of the Scale indicator on the viewport</para></listitem>
76936a96
RN
330<listitem><para><keycap>F6</keycap> Toggle visibility of the Center Crosshairs on the viewport</para></listitem>
331<listitem><para><keycap>F7</keycap> Toggle showing selected items (e.g. tracks or waypoints) in the highlight colour in the viewport</para></listitem>
332<listitem><para><keycap>F9</keycap> Toggle visibility of the Layers Panel</para></listitem>
333<listitem><para><keycap>F12</keycap> Toggle visibility of the Statusbar</para></listitem>
334</itemizedlist>
335<para>
336Standard shortcuts are provided for normal GUI operations: such as creating new files, opening, saving and exitting.
4200b261
RN
337Then there are shortcuts specific to &appname; to switch projection modes, zoom in/out, create layers,switch the active tool mode and move the map:
338<itemizedlist>
339<listitem><para><keycap>Ctrl+Up</keycap> Pan the viewport North</para></listitem>
340<listitem><para><keycap>Ctrl+Right</keycap> Pan the viewport East</para></listitem>
341<listitem><para><keycap>Ctrl+Down</keycap> Pan the viewport South</para></listitem>
342<listitem><para><keycap>Ctrl+Left</keycap> Pan the viewport West</para></listitem>
343<listitem><note><para>These work irrespective of the <xref linkend="tools"/> mode selected</para></note></listitem>
344</itemizedlist>
345For other combinations see the menu entry themselves.
76936a96 346</para>
7233fcb6
RN
347</section>
348
c3eb4a65
RN
349<section><title>Tracks vs Routes</title>
350<para>
351In 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.
352</para>
353<para>
84017394 354Q. When planning a <emphasis>route</emphasis> what difference does it make if it's a route or a track?
c3eb4a65
RN
355</para>
356<para>
357A. One difference is in how a GPS device navigates following the route or track.
358Or you may want to consider interoperability with other software.
359Otherwise it is probably best to use tracks as they are a superset of the route functionality.
360</para>
361<para>
362For example on Garmin Etrex:
363</para>
364<itemizedlist>
365<listitem>
366<para>Route following: Uses navigation mode with compass and estimated time to next point.</para>
367<para>If following on road it can calculate a route on fly.</para>
368<para>I (RN) always use this mode to follow pre planned routes.</para>
369</listitem>
370<listitem>
371<para>Track following: Uses a <trademark>TracBack</trademark> mode</para>
372<para>I (RN) never use this so I can't comment on how it actually compares to the route mode.</para>
373</listitem>
374</itemizedlist>
375<note><para>
376There are often restrictions on the numbers of route points the GPS Device can handle - may be 250 or as little as 50.
377This generally not a problem for single day routes, but needs managing for multi-day events or for highly detailed routes.
378</para></note>
379</section>
380
76936a96
RN
381</section><!--General Concepts End-->
382
7bb499bc
RN
383<section><title>File Types and the Main Window</title>
384
385<para>
386&appname; has it's own file type traditionally marked by the <emphasis>.vik</emphasis> file extension.
387This 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...).
388</para>
389<para>
390Besides it's own file type, &appname; can open (and save to via export methods) GPX and KML file types.
391</para>
392<note>
393<para>
394&appname; does not handle GPX 1.1 particularly well - it prefers GPX 1.0
395</para>
396</note>
397<para>
6db85a50 398By default &appname; opens a default blank window centered on the home location. This behaviour can be changed by the <xref linkend="prefs_startup"/>.
7bb499bc 399Each window contains menus, a toolbar, a viewport, layers panel and a statusbar.
fef1084a 400Each section (apart from the viewport) can be hidden using the <xref linkend="shortcut_keys"/> or from the
7bb499bc
RN
401<menuchoice><guimenu>View</guimenu><guisubmenu>Show</guisubmenu></menuchoice> choices.
402</para>
403<para>
404One may consider each &appname; window to be a separate project - each with it's project <emphasis>Viking</emphasis> file.
405However generally one window is enough for most purposes!
406</para>
407<para>
408Several operations apply at the window level as follows next.
fef1084a 409Also see <xref linkend="tools"/> for the operational modes that generally work in conjunction with a selected layer.
7bb499bc
RN
410</para>
411
412<section><title>New</title>
413<para>
414Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>New</guisubmenu></menuchoice> menu and on the toolbar <guibutton>New</guibutton>.
415</para>
416<para>
417This creates a new window with the default settings.
418</para>
419</section>
420
421<section><title>Open</title>
422<para>
423Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Open</guisubmenu></menuchoice> menu and on the toolbar <guibutton>Open</guibutton>.
424</para>
425<para>
426This opens a file chooser dialog to select one (or more) files of the supported GPS data file types:
427<itemizedlist>
428<listitem><para>Viking</para></listitem>
429<listitem><para>GPX</para></listitem>
430<listitem><para>KML</para></listitem>
5bed0ef6 431<listitem><para>JPG</para></listitem>
7bb499bc
RN
432</itemizedlist>
433</para>
434<para>
5bed0ef6 435GPX, KML and JPG 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.
7bb499bc
RN
436</para>
437<tip>
438<para>
439&appname; handles more file types via the <link linkend="acquire">Acquire</link> methods below.
440</para>
441</tip>
442</section>
443
444<section><title>Save</title>
445<para>
446Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Save</guisubmenu></menuchoice> menu and on the toolbar <guibutton>Save</guibutton>.
447</para>
448<para>
449If the current opened file is <emphasis>Viking</emphasis> file, this save will simply update it.
450If 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.
451</para>
452</section>
453
454<section><title>Save As</title>
455<para>
456Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Save As</guisubmenu></menuchoice> menu only.
457</para>
458<para>
459This 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).
460</para>
461</section>
462
463<section><title>Append</title>
464<para>
465Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Append</guisubmenu></menuchoice> menu only.
466</para>
467<para>
468Selecting a <emphasis>Viking</emphasis> file from this method will join the file contents to the current window (instead of creating a new one).
469GPX and KML files may also be appended, but this is exactly the same as the normal file open method.
470</para>
471</section>
472
fef1084a 473<section id="acquire" xreflabel="acquire"><title>Acquire</title>
7bb499bc
RN
474
475<para>
c025f801 476Available on the <menuchoice><guimenu>File</guimenu><guisubmenu>Acquire</guisubmenu></menuchoice> menu and from the <xref linkend="TrackWaypoint"/> layer menu.
7bb499bc
RN
477</para>
478<para>
9cc13848 479If used from the <guimenu>File</guimenu> menu these methods place the results in a new TrackWaypoint layer.
c025f801
RN
480</para>
481<para>
482If used from the <xref linkend="TrackWaypoint"/> layer menu these methods place the results in that TrackWaypoint layer.
7bb499bc
RN
483</para>
484
485<section>
486<title>From GPS</title>
487<para>
488<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From GPS</guimenuitem></menuchoice>
489Probably the easiest way of getting information from a GPS Device.
490</para>
491<para>
492Select the GPS Device communication settings and then hit <guibutton>OK</guibutton>.
493See the <link linkend="method_c">Getting Started</link> section for more info about the settings.
494</para>
495<note>
496<para>
497Some 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.
498</para>
499</note>
500</section>
501
502<section>
503<title>Import File With GPSBabel</title>
504<para>
505<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>Import File With GPSBabel</guimenuitem></menuchoice>
506</para>
507<para>
508Other formats can be imported that are supported by GPSBabel.
509</para>
510<para>
511You need to select the file <emphasis>and</emphasis> the type of the file that is going to be opened,
512since there is no automatic detection of the file kind.
513</para>
514</section>
515
516<section>
517<title>OSM Traces</title>
518<para>
519<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>OSM Traces</guimenuitem></menuchoice>
5f526098
RN
520</para>
521<para>
522See <xref linkend="osm_dl"/> section for more information.
523</para>
524</section>
525
526<section>
527<title>My OSM Traces</title>
528<para>
529<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>My OSM Traces</guimenuitem></menuchoice>
530</para>
531<para>
532See <xref linkend="osm_my_dl"/> section for more information.
7bb499bc
RN
533</para>
534</section>
535
536<section>
537<title>From Geotagged Images</title>
538<para>
539<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From Geotagged Images</guimenuitem></menuchoice>
540Enables automatic creation of waypoints from geotagged images.
541</para>
542<para>
543This menu opens a dialog to select such image files.
c025f801 544If 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.
7bb499bc
RN
545</para>
546</section>
547
075d1614
RN
548<section>
549<title>From Wikipedia Waypoints</title>
550<para>
551<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From Wikipedia Waypoints</guimenuitem></menuchoice>
552</para>
553<para>
84017394 554This gets <emphasis>interesting</emphasis> points from Wikipedia for the specified view: either within the extent of layer bounds or within the current viewport boundary.
075d1614
RN
555</para>
556</section>
557
7f95fd54
GB
558<section>
559<title>From Routing</title>
560<para>
561<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From Directions</guimenuitem></menuchoice>
562</para>
563<para>
564This gets a route from given directions.
565</para>
566</section>
567
c6acf18d
RN
568<section>
569<title>From URL</title>
570<para>
571<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From URL</guimenuitem></menuchoice>
572</para>
573<para>
574This gets a file from the entered URL.
575File formats that can be opened are those supported by GPSBabel.
576</para>
577<note>
578<para>
579You need to select the type of the file that is going to be returned, since there is no automatic detection of the file kind.
580</para>
581</note>
582</section>
583
c0c5893f
RN
584<section>
585<title>Import GeoJSON File</title>
586<para>
587<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>Import GeoJSON File</guimenuitem></menuchoice>
588</para>
589<para>
590This uses the program <ulink url="https://github.com/tyrasd/togpx">togpx</ulink> to load .geojson files.
591If the program is not detected on your system, then this option will not be available.
592See <ulink url="https://www.npmjs.org/package/togpx">here</ulink> for the installation method.
593</para>
594<para>
595The current version (1.4.4) of GPSBabel does not support the <ulink url="http://geojson.org/">GeoJSON</ulink> file format.
596</para>
597</section>
598
7bb499bc
RN
599</section> <!-- End Acquire -->
600
601<section><title>Print</title>
602<para>
603Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Print</guisubmenu></menuchoice> menu and on the toolbar <guibutton>Print</guibutton>.
604</para>
605<para>
606Print 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
607cross hairs and the scale.
608</para>
609<para>
610It uses a standard system print dialog using an image the size of the current viewport in pixel terms.
611On the <emphasis>Image Settings</emphasis> you can move the image around the page and scale the image up / or down.
612</para>
613</section>
614
615<section><title>Generate Image File</title>
616<para>
617Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Generate Image File</guisubmenu></menuchoice> menu only.
618</para>
619<para>
620Allows generation of larger (pixel) area images than the standard Print method above.
621From the generated image you can use the facilities of the <application>Operating System</application> to print the image
622or perform other actions.
623</para>
624<para>
625You should have previously downloaded the tile images for the chosen zoom level,
626otherwise the image produced will have missing sections.
627</para>
628<warning>
629<para>
630Using large areas takes some time to process and due to the method used it may run out of memory to complete the operation.
631Unfortunately under <trademark>Windows</trademark> systems it can not detect this failure and may crash the program.
632So the maximum size is dependent on the capabilities of your system.
633For instance the largest successful image generated on my (RN) Debian system is a pixel area of 20,000 x 20,000.
634</para>
635</warning>
636</section>
637
638<section><title>Generate Directory of Images</title>
639<para>
640Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Generate Directory of Images</guisubmenu></menuchoice> menu only.
641</para>
4e859f76 642<note>
7bb499bc
RN
643<para>
644This is only available in UTM mode.
645</para>
4e859f76 646</note>
7bb499bc
RN
647</section>
648
649</section> <!-- End File Types -->
650
6928e16b 651<section><title>Layers</title>
036c28fc 652
28f39a51
RN
653<para>
654Layers supported by &appname; are:
655</para>
656<itemizedlist>
6a997af7
RN
657<listitem><para><xref linkend="Aggregate"/></para></listitem>
658<listitem><para><xref linkend="TrackWaypoint"/></para></listitem>
659<listitem><para><xref linkend="GPS"/></para></listitem>
660<listitem><para><xref linkend="DEM"/></para></listitem>
661<listitem><para><xref linkend="Coordinate"/></para></listitem>
662<listitem><para><xref linkend="Maps"/></para></listitem>
663<listitem><para><xref linkend="GeoRef"/></para></listitem>
28f39a51
RN
664</itemizedlist>
665<para>
666For each layer there are a few standard options:
667</para>
668<itemizedlist>
669<listitem><para>Properties - Layer setup / configuration settings</para></listitem>
670<listitem><para>Cut</para></listitem>
671<listitem><para>Copy</para></listitem>
672<listitem><para>Paste</para></listitem>
673<listitem><para>Delete</para></listitem>
674<listitem><para>Visibility - This checkbox on the Layers Panel controls whether the layer is shown in the viewport or not</para></listitem>
675</itemizedlist>
676<para>
677The cut/copy/paste options can be accessed in a variety of ways once the layer has been selected:
678</para>
679<itemizedlist>
680<listitem><para>Standard keys: <keycap>Ctrl+x|c|v</keycap></para></listitem>
681<listitem><para>Main menu <guimenuitem>Edit</guimenuitem></para></listitem>
682<listitem><para>From the right click menu</para></listitem>
683<listitem><para>Buttons at the bottom of the Layers Panel</para></listitem>
684</itemizedlist>
685<para>
2ed09ddf
RN
686Default values used for each layer's properties can be altered via the <menuchoice><guimenu>Edit</guimenu><guisubmenu>Layer Defaults</guisubmenu></menuchoice> menu options.
687</para>
688<para>
28f39a51
RN
689See the individual section for detail about each layer.
690</para>
6a997af7 691</section>
28f39a51 692
c025f801 693<section id="TrackWaypoint" xreflabel="TrackWaypoint"><title>TrackWaypoint Layer</title>
6928e16b 694<para>
c3eb4a65 695TrackWaypoint layers display GPS data (tracks, routes and waypoints).
6928e16b 696</para>
7233fcb6 697<para>One way to create new waypoints is to copy a
6928e16b 698latitude/longitude coordinate pair, such as the one shown on most
0ef60ec1
GB
699geocaches, and paste it into an active TrackWaypoint layer. &appname; can
700automatically recognize several variations of the lat/lon format.
701</para>
6928e16b 702<para>
c3a02429 703By right-clicking on tracks, routes or waypoints in the <xref linkend="gc_layers_panel"/>, you can access many commands on them.
c3eb4a65
RN
704You can easily find a specific track, route or waypoint by expanding the appropriate containing Tracks, Routes or Waypoints sublayer in the
705layers panel to show all the individual items and then typing the name of the track, route or waypoint.
706</para>
707
708<para>
709The containing Tracks, Routes or Waypoints sublayers are only shown when items of that type exist.
710To start creating them enter into a create mode via either the <guibutton>Create</guibutton> toolbar commands or the <guimenuitem>New</guimenuitem> menu commands.
711</para>
712
179bfc90
RN
713<para>
714The sublayers also offer right click menu options.
715These are the same as those available at the TrackWaypoint level, but only those that relate to the sublayer type.
716</para>
717
c3eb4a65
RN
718<para>
719By default routes are coloured red. Tracks are automatically assigned a spread of colours.
720</para>
721
722<para>
9f30939a 723Most operations 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.
c3eb4a65 724It 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).
6928e16b 725</para>
036c28fc 726
6928e16b
GB
727<section><title>Layer Operations</title>
728<para>
729The layer has a context menu with several operations.
730</para>
036c28fc
RN
731
732<section><title>View Layer</title>
733<para>
c3eb4a65 734Version1.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).
036c28fc
RN
735</para>
736</section>
737
c3eb4a65
RN
738<section><title>View</title>
739
179bfc90 740<section id="track_view_all"><title>View All Tracks</title>
036c28fc 741<para>
c3eb4a65
RN
742Version1.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).
743</para>
744</section>
745
179bfc90 746<section id="route_view_all"><title>View All Routes</title>
c3eb4a65
RN
747<para>
748Version1.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).
036c28fc
RN
749</para>
750</section>
751
179bfc90 752<section id="wp_view_all"><title>View All Waypoints</title>
036c28fc 753<para>
c3eb4a65 754Version1.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).
036c28fc
RN
755</para>
756</section>
757
c3eb4a65
RN
758</section>
759
036c28fc
RN
760<section><title>Goto Center of Layer</title>
761<para>
c3eb4a65 762This will automatically move the viewport to see the whole layer (i.e. tracks, routes and waypoints). It does not adjust the zoom level.
036c28fc
RN
763</para>
764</section>
765
179bfc90 766<section id="wp_goto"><title>Goto Waypoint</title>
036c28fc
RN
767<para>
768This opens a dialog box to enter a name of waypoint to search for. If it is found the viewport is centred on it.
769</para>
770<note>
771<para>
772Note this search is not very clever and only finds exact matches.
773You are probably better off expanding the waypoint list and directly start typing, as mentioned above, which finds a match based on each letter typed.
774</para>
775</note>
776</section>
777
778<section><title>Export Layer</title>
779<para>
1ca082d7
RN
780The layer (all tracks, routes and waypoints) can be exported to following file formats:
781</para>
782<orderedlist>
783 <listitem>
784 <para>GPX</para>
785 </listitem>
786 <listitem>
787 <para>GPSPoint</para>
788 </listitem>
789 <listitem>
790 <para>GPSMapper</para>
791 </listitem>
792 <listitem>
793 <para>Google's KML</para>
794 </listitem>
795 <listitem>
796 <para>Any GPSBabel <ulink url="http://www.gpsbabel.org/capabilities.html">File Formats</ulink></para>
797 </listitem>
798 <listitem>
799 <para>GeoJSON. Via the program <ulink url="https://github.com/mapbox/togeojson">togeojson</ulink></para>
800 <para>This option will not be available if the program is not detected on your system.
801 See <ulink url="https://www.npmjs.org/package/togeojson">here</ulink> for the installation method.</para>
802 </listitem>
803</orderedlist>
036c28fc
RN
804<para>
805Version1.1+: An individual track can be exported to a GPX file via the track menu.
806</para>
807</section>
808
333ad216 809<section id="finish_track"><title>Finish Track or Route</title>
179bfc90 810<para>
179bfc90
RN
811Selecting this option ends the creation of that individual track or route.
812</para>
4e859f76
GB
813<note>
814<para>
815This is only available when a track or route is being created by the <xref linkend="track_create"/> or <xref linkend="route_create"/> tools.
816</para>
817</note>
179bfc90
RN
818</section>
819
820<section><title>New</title>
cc1083b3 821<section id="new_wp"><title>New Waypoint</title>
036c28fc
RN
822<para>
823This 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.
824</para>
825</section>
179bfc90
RN
826<section id="new_track"><title>New Track</title>
827<para>
828This turns on the <xref linkend="track_create"/> tool.
829</para>
830</section>
831<section id="new_route"><title>New Route</title>
832<para>
833This turns on the <xref linkend="route_create"/> tool.
834</para>
835</section>
836</section>
036c28fc 837
dae48936
RN
838<section><title>Geotag Images</title>
839<para>
840This starts the Geotagging Images dialog against all tracks in the layer.
841See <link linkend="geotagging">Geotagging</link> for further detail.
842</para>
843</section>
844
7bb499bc
RN
845<section><title>Acquire</title>
846<para>
fef1084a 847This offers the same choice from <xref linkend="acquire"/> methods as on the <guimenu>File</guimenu> menu.
7bb499bc
RN
848However when invoked from here, the results will be stored in this layer (instead of creating a new one).
849</para>
850</section>
851
364f9e0a
RN
852<section><title>Upload</title>
853
854<section id="gps_upload"><title>Upload to GPS</title>
855<para>
856This opens a dialog to select the GPS Device and port to which the layer information will be transferred.
857</para>
858<para>
c3eb4a65 859The types of GPS information (tracks, routes or waypoints) to be transferred can be selected.
364f9e0a
RN
860</para>
861<para>
c3eb4a65 862Tracks, Routes or Waypoints that are invisible will not be transferred.
364f9e0a
RN
863</para>
864</section>
865
fef1084a 866<section id="osm_upload" xreflabel="Upload To OSM" ><title>Upload To OSM</title>
036c28fc 867<para>
3e8e3227 868This opens a dialog to upload all tracks and waypoints to <ulink url="http://openstreetmap.org/">OpenStreetMap</ulink> traces.
fef1084a 869Useful if you are an OpenStreetMap contributor (you will need an OpenStreetMap account), these details can be stored in &appname; <xref linkend="prefs_osm"/>
036c28fc 870</para>
6928e16b 871<para>
3e8e3227 872 &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.
6928e16b 873</para>
7bb499bc 874<warning>
6928e16b 875<para>
4cdc9eb3 876The 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.
6928e16b 877</para>
4cdc9eb3 878<para>Currently &appname; does not support the <ulink url="http://oauth.net/">OAuth</ulink> mechanism.</para>
7bb499bc 879</warning>
036c28fc 880</section>
6928e16b 881
364f9e0a
RN
882</section>
883
179bfc90
RN
884<section><title>Delete</title>
885<para>Offers deletion of various parts of a TrackWaypoint layer:</para>
886<section id="delete_all_tracks"><title>Delete All Tracks</title>
887<para>Deletes all the tracks in this layer.</para>
888</section>
889<section id="delete_selection_tracks"><title>Delete Tracks from Selection</title>
890<para>Opens a dialog with list of all the tracks from this layer to choose the ones to delete.</para>
891</section>
892<section id="delete_all_routes"><title>Delete All Routes</title>
893<para>Deletes all the routes in this layer.</para>
894</section>
895<section id="delete_selection_routes"><title>Delete Routes from Selection</title>
896<para>Opens a dialog with list of all the routes from this layer to choose the ones to delete.</para>
897</section>
898<section id="delete_all_waypoints"><title>Delete All Waypoints</title>
899<para>Deletes all the waypoints in this layer.</para>
900</section>
901<section id="delete_selection_waypoints"><title>Delete Waypoints from Selection</title>
902<para>Opens a dialog with list of all the waypoints from this layer to choose the ones to delete.</para>
903</section>
904</section>
905
036c28fc
RN
906<section><title>Filter</title>
907<section><title>Simplify All Tracks</title>
908<para>
909This 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.
910</para>
911</section>
b4295f59
RN
912<section><title>Compress Tracks</title>
913<para>
914Enables compression of tracks and routes via <application>GPSBabel</application>'s <emphasis>Crosstrack</emphasis> simplify method.
915It opens a dialog to request the Error factor value which is the maximum allowable error that may be introduced by removing a single point.
916It is expressed a distance in units as specified by the <xref linkend="prefs"/> distance option.
917Thus a higher value will remove more points.
918The result is put into a new layer.
919</para>
920</section>
036c28fc
RN
921<section><title>Remove Duplicate Waypoints</title>
922<para>
923Remove Duplicate Waypoints - fairly self explainatory, with the results created in a new layer.
924</para>
925<note>
926<para>
927However 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.
928</para>
929</note>
930</section>
6928e16b
GB
931</section>
932
036c28fc
RN
933<section id="filter_with_track"><title>Filter With <emphasis>Trackname</emphasis></title>
934<para>
935This 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:
936</para>
937<itemizedlist>
938<listitem><para>Waypoints Inside This</para></listitem>
939<listitem><para>Waypoints Outside This</para></listitem>
940</itemizedlist>
941<para>
942The result is generated in a new Track/Waypoint layer.
943</para>
6928e16b 944</section>
036c28fc 945
dae48936
RN
946<section><title>Geotag Images</title>
947<para>
948This starts the Geotagging Images dialog using the specific track.
949See <link linkend="geotagging">Geotagging</link> for further detail.
950</para>
951</section>
952
f85716b8
RN
953<section><title>List Tracks or Routes</title>
954<para>
955Opens a new dialog with the list. As described in the Aggregrate layer <xref linkend="track_list"/>
956</para>
957</section>
958
959<section><title>List Waypoints</title>
960<para>
961Opens a new dialog with the list. As described in the Aggregrate layer <xref linkend="waypoint_list"/>
962</para>
963</section>
964
036c28fc
RN
965</section><!-- End TRW Layer Options -->
966
179bfc90
RN
967<section><title>Track and Route Sublayer Options</title>
968<para>Repeats options available at the TrackWaypoint level, but only those for tracks and routes:</para>
969<itemizedlist>
970<listitem><para>Finish Track or Route. Same as the layer <link linkend="finish_track">Finish Track or Route</link></para></listitem>
971<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>
972<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>
973<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>
974<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>
f85716b8
RN
975<listitem><para>List Tracks or Routes. Opens a new dialog with the list. As described in the Aggregrate layer <xref linkend="track_list"/></para></listitem>
976</itemizedlist>
977<para>Also gives other options for handling multiple items:</para>
978<itemizedlist>
979<listitem><para>Sort. Gives the ability to sort the items in the treeview alphabetically</para></listitem>
980<listitem><para>Visibility. Offers options to quickly control the visibility of all items within the sublayer, as per <xref linkend="vis_options"/></para></listitem>
179bfc90
RN
981</itemizedlist>
982</section>
983
0f29139c 984<section xreflabel="Track and Route Properties"><title>Track and Route Properties</title>
6928e16b 985<para>
0f29139c
RN
986This shows several tabs for properties and useful statistics about a track or a route, including elevation-distance and speed-time graphs (if data is available).
987Moving the mouse pointer over the graph displays values related to that point along the track.
988You can click on these graphs to jump to the point in the track.
989You can reverse it, delete duplicates, split at marked position or split a track from its component segments (discontinuous breaks in a track) into separate tracks.
990</para>
991<section id='track_properties' xreflabel="Track and Route Properties"><title>Track and Route Properties Tab</title>
992<para>
993<figure>
994<title>Properties Tab: Example</title>
995<screenshot>
996 <graphic format="PNG" fileref="figures/Track_properties.png"/>
997</screenshot>
998</figure>
999</para>
1000</section>
1001<section id='track_statistics' xreflabel="Track and Route Statistics"><title>Track and Route Statistics Tab</title>
1002<para>
1003<figure>
1004<title>Statistics Tab: Example</title>
1005<screenshot>
1006 <graphic format="PNG" fileref="figures/Track_statistics.png"/>
1007</screenshot>
1008</figure>
1009</para>
1010</section>
1011<section id='track_elev_graphs' xreflabel="Track Elevation Graph"><title>Track Elevation Graph</title>
1012<para>
1013<figure>
1014<title>Elevation Distance Tab: Example</title>
1015<screenshot>
1016 <graphic format="PNG" fileref="figures/Track_elevation_graph.png"/>
1017</screenshot>
1018</figure>
6928e16b
GB
1019</para>
1020<para>
1021The following colors are used in the elevation-distance graph:
1022</para>
0ef60ec1
GB
1023<variablelist>
1024<varlistentry>
84017394 1025<term><emphasis>Main</emphasis> colour - this is dependent on your Desktop theme - often blue by default</term>
0ef60ec1
GB
1026<listitem><para>elevation data in graph</para></listitem>
1027</varlistentry>
1028<varlistentry>
1029<term>Yellow</term>
6928e16b 1030<listitem>
0ef60ec1 1031<para>no elevation data</para>
6928e16b 1032</listitem>
0ef60ec1
GB
1033</varlistentry>
1034<varlistentry>
1035<term>Green</term>
6928e16b 1036<listitem>
0ef60ec1 1037<para>elevation data from DEM</para>
6928e16b 1038</listitem>
0ef60ec1
GB
1039</varlistentry>
1040<varlistentry>
1041<term>Red</term>
6928e16b 1042<listitem>
0ef60ec1 1043<para>speed</para>
6928e16b 1044</listitem>
0ef60ec1
GB
1045</varlistentry>
1046</variablelist>
0f29139c 1047</section>
6928e16b 1048</section>
d45662d5 1049
c3eb4a65 1050<section><title>Track and Route Operations</title>
d45662d5 1051
179bfc90
RN
1052<section><title>Finish Track</title>
1053<para>
179bfc90
RN
1054Selecting this option ends the creation of the individual track.
1055</para>
4e859f76
GB
1056<note>
1057<para>
1058This is only available when a track is being created by the <xref linkend="track_create"/> tool.
1059</para>
1060</note>
179bfc90
RN
1061</section>
1062
d45662d5
RN
1063<section><title>Goto</title>
1064<para>
1065This centers the viewport on the selected position on the track:
1066</para>
1067<itemizedlist>
1068<listitem><para>Startpoint</para></listitem>
1069<listitem><para>"Center" - the notional center from the bounds of the track</para></listitem>
1070<listitem><para>Endpoint</para></listitem>
1071<listitem><para>Version1.1+: Highest Altitude</para></listitem>
1072<listitem><para>Version1.1+: Lowest Altitude</para></listitem>
c3eb4a65 1073<listitem><para>Version1.1+: Maximum Speed (Not Available on Routes)</para></listitem>
d45662d5
RN
1074</itemizedlist>
1075</section>
1076
1077<section><title>View</title>
1078<para>
1079Version1.1+: This centers the viewport on the track and selects the best zoom level to see it.
1080</para>
1081</section>
1082
9552af08 1083<section><title>Combine</title>
d45662d5 1084<section><title>Merge By Time</title>
0ef60ec1
GB
1085<para>
1086This operation repeatedly tries to merge the right-clicked track
6928e16b
GB
1087with tracks in the same TrackWaypoint layer. The tracks which are
1088merged are those which have at least one trackpoint less than some
1089threshold time away. This way, if you somehow end up with lots of small
1090segments (say, caused by turning the GPS on and off) you can merge them
0ef60ec1
GB
1091easily into one track.
1092</para>
4e859f76 1093<note>
c3eb4a65
RN
1094<para>
1095This is not available on routes as they have no timestamps.
1096</para>
4e859f76 1097</note>
d45662d5 1098</section>
6928e16b 1099
d45662d5
RN
1100<section><title>Merge With Other Tracks</title>
1101<para>
1102This opens a dialog listing the other tracks in the same TrackWaypoint layer, from which one can select the other tracks to merge with.
1103</para>
6928e16b 1104</section>
d45662d5 1105
9552af08
RN
1106<section><title>Merge Segments</title>
1107<para>
1108Combines track segments. Effectively removing track segment markers to leave one segment for the whole track.
1109</para>
1110</section>
1111
c3eb4a65 1112<section><title>Append Track or Route</title>
9552af08
RN
1113<para>
1114Enable joining of a single track to the end of the current track.
1115This opens a dialog listing the other tracks in the same TrackWaypoint layer from which one can make the selection.
1116</para>
1117</section>
1118</section>
1119
1120<section><title>Split</title>
d45662d5 1121<section><title>Split By Time</title>
6928e16b
GB
1122<para>
1123This operation will split a single track into segments wherever the
1124time interval between successive trackpoints is larger than some
1125threshold. This is useful when processing raw NMEA GPS data, especially
0ef60ec1
GB
1126taken over a long time.
1127</para>
4e859f76 1128<note>
c3eb4a65
RN
1129<para>
1130This is not available on routes as they have no timestamps.
1131</para>
4e859f76 1132</note>
6928e16b 1133</section>
d45662d5 1134
43e67498
RN
1135<section><title>Split By Number of Points</title>
1136<para>
1137Version1.2+: This operation will split a single track into segments by the number of points specified.
1138This can be useful with devices which may have limits on the number of points it supports.
1139</para>
1140</section>
1141
9552af08
RN
1142<section><title>Split Segments</title>
1143<para>
1144Splits track segments into new tracks.
1145</para>
4e859f76 1146<note>
c3eb4a65
RN
1147<para>
1148This is not available on routes as they do not have route segments.
1149</para>
4e859f76 1150</note>
9552af08
RN
1151</section>
1152
468f536d 1153<section id='trkpt_split' xreflabel="Split at Trackpoint"><title>Split at Trackpoint</title>
9552af08 1154<para>
4e859f76
GB
1155Splits the track at the currently selected trackpoint.
1156</para>
468f536d
RN
1157<para>
1158The current track will finish at this trackpoint.
1159A new track will start from a copy of this trackpoint.
1160</para>
4e859f76
GB
1161<note>
1162<para>
1163This is only enabled when a trackpoint is selected.
9552af08 1164</para>
4e859f76 1165</note>
9552af08
RN
1166</section>
1167</section>
1168
ec71b5b6
RN
1169<section><title>Insert Points</title>
1170<note>
1171<para>
1172These options are only enabled when a trackpoint is selected.
1173</para>
1174</note>
1175<section><title>Insert Point Before Selected Point</title>
1176<para>
1177Inserts a track point halfway between the previous track point and the current track point.
1178All track point properties are interpolated between the two points.
1179</para>
1180</section>
1181<section><title>Insert Point After Selected Point</title>
1182<para>
1183Inserts a track point halfway between the current track point and the next track point.
1184All track point properties are interpolated between the two points.
1185</para>
1186</section>
1187</section>
1188
9552af08 1189<section><title>Delete Points</title>
ec71b5b6
RN
1190<section><title>Delete Selected Point</title>
1191<para>
1192Deletes the currently selected track point.
1193</para>
1194<note>
1195<para>
1196This is only enabled when a trackpoint is selected.
1197</para>
1198</note>
1199</section>
9552af08
RN
1200<section><title>Delete Points With the Same Position</title>
1201<para>
1202Deletes subsequent points that have the same position (but have different timestamps).
1203</para>
1204</section>
1205<section><title>Delete Points With the Same Time</title>
1206<para>
1207Deletes subsequent points that have the same time stamp (but may have different positions).
1208</para>
4e859f76 1209<note>
c3eb4a65
RN
1210<para>
1211This is not available on routes as they have no timestamps.
1212</para>
4e859f76 1213</note>
9552af08
RN
1214</section>
1215
1216</section>
1217
62320d37 1218<section id="transform" xreflabel="Transform"><title>Transform</title>
c2368fa6
RN
1219<para>
1220These options alter the data of trackpoints of a track but not add or remove trackpoints.
1221And don't seem to fit any other category :)
1222</para>
6928e16b
GB
1223<section><title>Apply DEM data</title>
1224<para>
1225If any DEM data is loaded, this will apply the DEM data to give the track elevation data.
c2368fa6
RN
1226Two ways of applying DEM data are offered:
1227<orderedlist>
1228<listitem><para>Keep. Retains the existing elevation data of trackpoints and only those missing an elevation value are set.</para></listitem>
1229<listitem><para>Overwrite. Elevation data are set on all trackpoints even if they already elevation values.</para></listitem>
1230</orderedlist>
1231</para>
1232</section>
1233<section><title>Smooth Missing Elevation data</title>
1234<para>
1235In various locations across the world, there are missing DEM values (AKA DEM Holes) from the SRTM data.
1236This is particularly noticeable in mountainous areas.
1237Two ways of applying elevation data to trackpoints that do not have elevation values are offered:
1238<orderedlist>
1239<listitem><para>Interpolated. Missing elevation data is interpolated between the previous and next known values.</para></listitem>
1240<listitem><para>Flat. Elevation data is filled in from the last previously known value.</para></listitem>
1241</orderedlist>
1242</para>
1243</section>
1244<section>
1245<title>Convert to Track or Route</title>
1246<para>
1247If this is a Route then it will convert it to a Track.
1248</para>
1249<para>
1250If this is Track then convert it to a Route.
1251</para>
c2368fa6 1252<note>
6d07b697 1253<para>
c2368fa6 1254Converting from a Track to a Route may involve a loss of information, in particular timestamp values (hence you are required to confirm this operation before it happens).
6928e16b 1255</para>
6d07b697 1256</note>
d45662d5 1257</section>
c2368fa6
RN
1258<section>
1259<title>Anonymize Times</title>
1260<para>
1261Timestamp information of a track can be shifted to be all offset from 1901-01-01.
1262</para>
1263<para>
1264Thus the timestamps themselves will no longer reveal exactly when a track was taken.
1265However the relative difference between the timestamps is kept thus one is still able to calculate some properties such as speeds along the track.
1266</para>
c2368fa6 1267<note>
6d07b697 1268<para>
c2368fa6 1269This is not available for routes, as they have no timestamps.
c2368fa6 1270</para>
6d07b697 1271</note>
c2368fa6
RN
1272</section>
1273</section>
6928e16b 1274
d45662d5
RN
1275<section><title>Export Track as GPX</title>
1276<para>
1277Version1.1+: This allows exporting the track as a GPX file by opening a file save dialog.
1278</para>
6928e16b 1279</section>
d45662d5
RN
1280
1281<section><title>Extend Track End</title>
6928e16b 1282<para>
d45662d5 1283Changes the current tool to add trackpoints to the end of the track.
6928e16b 1284</para>
d45662d5 1285</section>
6928e16b 1286
0db79fc5 1287<section><title>Extend Using Route Finder</title>
d45662d5 1288<para>
9f30939a 1289Enables 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 the default route service and applied to the track.
d45662d5 1290</para>
6928e16b 1291</section>
d45662d5 1292
364f9e0a
RN
1293<section><title>Upload</title>
1294
1295<section><title>Upload to GPS</title>
1296<para>
1297Same as the layer <link linkend="gps_upload">Upload to GPS</link> command, but only applies to the track.
1298</para>
1299</section>
1300
6928e16b
GB
1301<section><title>Upload to OSM</title>
1302<para>
73919102 1303Same as the layer <link linkend="osm_upload">Upload to OSM</link> command, but only applies to the track.
6928e16b 1304</para>
d45662d5 1305</section>
6928e16b 1306
364f9e0a
RN
1307</section>
1308
d45662d5
RN
1309<section><title>Use With Filter</title>
1310<para>
1311This selects the track to be used in the <link linkend="filter_with_track">Filter With <emphasis>Trackname</emphasis></link> feature.
1312</para>
4e859f76 1313<note>
c3eb4a65
RN
1314<para>
1315This is not available on routes.
1316</para>
4e859f76 1317</note>
6928e16b 1318</section>
d45662d5 1319
468f536d
RN
1320<section><title>Edit Trackpoint</title>
1321<para>
1322This opens the Trackpoint edit dialog. See <xref linkend="Trackpoint_edit"/>.
1323</para>
1324<note>
1325<para>
1326This is only enabled when a trackpoint is selected.
1327</para>
1328</note>
1329</section>
1330
1a3be6a8
GB
1331<section><title>Refine Route...</title>
1332<para>
1333This function allows to request a Routing Engine in order to refine a given route.
1334By "refining" we mean computing all real intermediates points between some given major points.
1335This could be useful to compute a trip giving only the wished important steps.
1336</para>
1337<note>
1338<para>
1339This is only available on routes.
1340</para>
1341</note>
1342</section>
1343
6928e16b 1344<section><title>View Google Directions</title>
0ef60ec1 1345<para>
0db79fc5 1346This option is only available on a track created using the Route Finder tool.
d45662d5
RN
1347</para>
1348<para>
1349Launch a web browser to see the Google directions page which yielded the route.
0ef60ec1
GB
1350</para>
1351<note>
1352<para>
0db79fc5 1353The record of the Google route is stored in the track's comment, so if the comment is changed (or the route was created by something other than the Route Finder tool) this will not work correctly.
6928e16b 1354</para>
0ef60ec1 1355</note>
6928e16b 1356</section>
55340efa 1357
d45662d5 1358</section><!-- End Track Options -->
cc1083b3 1359
179bfc90
RN
1360<section><title>Waypoint Sublayer Options</title>
1361<para>Repeats options available at the TrackWaypoint level, but only those for waypoints:</para>
1362<itemizedlist>
1363<listitem><para>New Waypoint. Same as the layer <link linkend="new_wp">New Waypoint</link></para></listitem>
1364<listitem><para>View All Waypoints. Same as the layer <link linkend="wp_view_all">View All Waypoints</link></para></listitem>
1365<listitem><para>Goto Waypoint. Same as the layer <link linkend="wp_goto">Goto Waypoint</link></para></listitem>
1366<listitem><para>Delete All Waypoints. Same as the layer <link linkend="delete_all_waypoints">Delete All Waypoints</link></para></listitem>
1367<listitem><para>Delete Waypoints from Selection. Same as the layer <link linkend="delete_selection_waypoints">Delete Waypoints from Selection</link></para></listitem>
f85716b8 1368<listitem><para>List Waypoints. Opens a new dialog with the list. As described in the Aggregrate layer <xref linkend="waypoint_list"/></para></listitem>
179bfc90
RN
1369</itemizedlist>
1370</section>
1371
440ef68c
RN
1372<section><title>Waypoint Properties</title>
1373
1374<para>
1375This 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).
1376</para>
dae48936
RN
1377<para>
1378If the waypoint has an associated image, then the Geotag information may be updated, either with updating the file's modification timestamp or not.
1379This can be useful when the waypoint has been moved.
1380</para>
440ef68c
RN
1381
1382</section><!-- WP Prop END -->
1383
6928e16b 1384<section><title>Waypoint Operations</title>
cc1083b3
RN
1385
1386<section><title>Goto</title>
6928e16b 1387<para>
cc1083b3 1388This centers the viewport on the selected waypoint.
6928e16b 1389</para>
cc1083b3 1390</section>
6928e16b 1391
41f4abac
RN
1392<section><title>Geotag Images...</title>
1393<para>
1394This opens the <link linkend="geotagging">Geotag Dialog</link> to allow Geotagging multiple images to the position of this waypoint.
1395In this circumstance creation of waypoint options are disabled and only the options related to writing the EXIF information are available.
1396</para>
1397</section>
1398
62320d37
RN
1399<section><title>Transform</title>
1400<para>
1401Offers a subset of the track <xref linkend="transform"/> utilities.
1402Currently only setting the altitude from DEM data methods are available.
1403</para>
1404</section>
1405
179bfc90
RN
1406<section><title>Visit Webpage</title>
1407<para>
84017394 1408If the waypoint's comment (or description) starts with <literal>http:</literal> then this option is available and allows launching a web browser to go to the webpage.
179bfc90
RN
1409</para>
1410</section>
1411
cc1083b3
RN
1412<section><title>Visit Geocache Webpage</title>
1413<para>
179bfc90 1414If 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.
cc1083b3 1415</para>
6928e16b
GB
1416</section>
1417
cc1083b3
RN
1418<section><title>New Waypoint</title>
1419<para>
1420Same as the layer <link linkend="new_wp">New Waypoint</link>.
1421</para>
6928e16b
GB
1422</section>
1423
cc1083b3
RN
1424</section><!-- WP END -->
1425
fef1084a 1426<section id="geotagging" xreflabel="Geotagging"><title>Version1.3+: Geotag Images</title>
dae48936 1427<para>
41f4abac 1428This dialog allows geotagging images (normally taken with a digital camera) against a specific waypoint or via interpolation against a specific track or all tracks in the TrackWaypoint layer - depending on how it is invoked.
dae48936
RN
1429</para>
1430<para>
41f4abac 1431When geotagging against tracks, images 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.
dae48936
RN
1432</para>
1433<note>
1434<para>
1435Generally 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.
1436</para>
1437</note>
1438<para>
1439Various options allow control of how the geotagging process is performed:
1440</para>
1441<itemizedlist>
1442<listitem><para>Images - Add the images used for geotagging</para></listitem>
1443<listitem><para>Create Waypoints</para></listitem>
269865aa 1444<listitem><para>Overwrite Existing Waypoints</para></listitem>
dae48936
RN
1445<listitem><para>Write EXIF</para></listitem>
1446<listitem><para>Overwrite Existing GPS Information</para></listitem>
1447<listitem><para>Interpolate Between Track Segments</para></listitem>
1448<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>
1449<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>
1450</itemizedlist>
1451</section>
1452
036c28fc
RN
1453</section><!-- TRW Layer END -->
1454
6a997af7 1455<section id="GPS" xreflabel="GPS"><title>GPS Layer</title>
0ef60ec1 1456<para>
7233fcb6 1457The GPS layer is responsible for uploading and downloading GPS data
6928e16b 1458from a GPS device. It also is responsible for realtime GPS tracking.
c025f801 1459Expand the GPS layer in the layers panel to see the two <xref linkend="TrackWaypoint"/> layers it
6928e16b 1460uses for uploading and downloading. To upload, download, or use
7233fcb6 1461realtime tracking, right-click the GPS layer and click the appropiate
6928e16b
GB
1462menu item.
1463</para>
0ef60ec1 1464
6928e16b
GB
1465<section><title>Download</title>
1466<para>
7233fcb6 1467To download data from the GPS, right-click the GPS layer and click <guimenuitem>Download from GPS</guimenuitem>.
6928e16b 1468</para>
6928e16b 1469</section>
ca2f3f23 1470
6928e16b 1471<section><title>Upload</title>
0ef60ec1
GB
1472<para>
1473To upload data to the GPS, first populate the GPS Upload child
c3eb4a65
RN
1474layer of the GPS layer (either by creating waypoints/tracks/routes in it, or
1475copying and pasting or dragging waypoints/tracks/routes from another layer).
7233fcb6 1476Then right-click the GPS layer and click <guimenuitem>Upload to GPS</guimenuitem>.
6928e16b 1477</para>
6928e16b 1478</section>
ca2f3f23 1479
7233fcb6 1480<section><title>Realtime Tracking</title>
0ef60ec1
GB
1481<para>
1482You must set up gpsd correctly or use a GPSD server and put the
7233fcb6
RN
1483correct information in the GPS layer properties dialog. Then right-click
1484the layer and select <guimenuitem>Start Realtime Tracking</guimenuitem>.
6928e16b 1485</para>
6928e16b
GB
1486</section>
1487
ca2f3f23
RN
1488<section><title>Empty <emphasis>Item</emphasis></title>
1489<para>
1490There are several options to quickly delete a subsection of data:
1491</para>
1492<itemizedlist>
1493<listitem><para>Empty Realtime</para></listitem>
1494<listitem><para>Empty Upload</para></listitem>
1495<listitem><para>Empty Download</para></listitem>
1496<listitem><para>Empty All</para></listitem>
1497</itemizedlist>
6928e16b 1498</section>
ca2f3f23
RN
1499
1500</section><!-- End GPS -->
1501
6a997af7 1502<section id="DEM" xreflabel="DEM"><title>DEM (Digital Elevation Model) Layer</title>
6928e16b 1503<para>
6fa00cca 1504This layer provides elevation data from the <ulink url="http://www2.jpl.nasa.gov/srtm/">Shuttle Radar Topography Mission (SRTM)</ulink>
6928e16b 1505</para>
6fa00cca
RN
1506<para>
1507Elevation 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]
1508</para>
1509<para>
1510To 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.
1511</para>
1512<para>
1513The current data server is: <ulink url="http://dds.cr.usgs.gov/srtm/version2_1/">NASA STRM 2.1</ulink>.
1514</para>
1515<para>
1516ATM &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.
1517</para>
1518<note>
1519<para>
1520Using 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"
1521</para>
1522</note>
6928e16b 1523
6fa00cca 1524</section><!-- End DEM -->
6928e16b 1525
f1b908b1 1526
6a997af7 1527<section id="Maps" xreflabel="Maps"><title>Maps Layer</title>
f1b908b1
RN
1528<para>
1529This layer provides a single map resource, you may have multiple map layers but only top one (if enabled) will be visible.
1530You 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.
1531</para>
1532<para>
84017394 1533Some 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 - <emphasis>Tile Age</emphasis> 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.
f1b908b1
RN
1534</para>
1535<para>
263cedca 1536Inbuilt maps include various <ulink url="http://openstreetmap.org/">OpenStreetMap (OSM)</ulink> ones and more:
f1b908b1
RN
1537</para>
1538<itemizedlist>
e2eb2a7b 1539<listitem><para>Bing Bird's Eye (Aerial) Maps (&appname; Version1.2+)</para></listitem>
f71b9997
RN
1540<listitem><para>OpenStreetMap (Mapquest) - This is the default (&appname; Version1.3+)</para></listitem>
1541<listitem><para>OpenStreetMap (Mapnik)</para></listitem>
f1b908b1 1542<listitem><para>OpenStreetMap (Cycle)</para></listitem>
f71b9997 1543<listitem><para>OpenStreetMap (Transport) (&appname; Version1.3+)</para></listitem>
263cedca 1544<listitem><para>OpenStreetMap (Humanitarian) (&appname; Version1.5+)</para></listitem>
f1b908b1 1545<listitem><para>NASA BlueMarble</para></listitem>
f1b908b1
RN
1546</itemizedlist>
1547
1548<para>
fef1084a 1549&appname; can be configured to handle additional maps. See <xref linkend="extend_viking"/> for further detail.
f1b908b1
RN
1550</para>
1551
1552<section><title>Layer Operations</title>
1553<section><title>Download Missing Onscreen Maps</title>
1554<para>
1555This requests map tiles for areas of the viewport that do not currently have one.
1556</para>
1557</section>
1558
1559<section><title>Download New Onscreen Maps</title>
1560<para>
1561This requests map tiles only if the maps are older than the Tile Age preference.
1562</para>
1563</section>
1564
1565<section><title>Reload All Onscreen Maps</title>
1566<para>
1567Force a refresh of all visible map tiles.
1568</para>
1569</section>
175e9bd0
RN
1570
1571<section><title>Download Maps in Zoom Levels</title>
1572<para>
1573This opens a dialog to enable requesting the download of maps for the region in the viewport over a specified number of zoom levels.
1574The download method type can be specified to help limit the number of requests.
1575</para>
1576<warning>
1577<para>
1578There are some inbuilt limits to prevent downloading large amounts of map tiles.
1579</para>
1580<para>
1581Please respect the usage policy of the tile set provider.
1582Such as <ulink url="http://wiki.openstreetmap.org/wiki/Tile_usage_policy"><citetitle>OSM Tile Usage Policy</citetitle></ulink>.
1583</para>
1584</warning>
1585<para>
1586<figure>
1587<title>Maps Download Dialog: Example</title>
1588<screenshot>
1589 <graphic format="PNG" fileref="figures/Maps_download_region_dialog.png"/>
1590</screenshot>
1591</figure>
1592</para>
1593</section>
f1b908b1
RN
1594</section>
1595
1596
1597</section><!-- End Maps -->
1598
6a997af7 1599<section id="Aggregate" xreflabel="Aggregate"><title>Aggregate Layer</title>
ce269944 1600<para>
8be6e73e 1601This 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.
ce269944
RN
1602</para>
1603<para>
c025f801 1604This 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.
ce269944
RN
1605Here are some suggestions:
1606<itemizedlist>
1607<listitem><para>Hiking</para></listitem>
1608<listitem><para>Mountain Biking</para></listitem>
1609<listitem><para>Road Cycling</para></listitem>
1610<listitem><para>Car Trips</para></listitem>
1611<listitem><para>Sailing</para></listitem>
1612<listitem><para>Holidays</para></listitem>
1613<listitem><para>UK Points of Interest</para></listitem>
1614<listitem><para>USA Points of Interest</para></listitem>
1615<listitem><para>etc...</para></listitem>
1616</itemizedlist>
1617</para>
1618<para>
1619Thus one can have a list of all your tracks, but groups can be shown or not using the relevant layers visibility checkbox.
1620</para>
1621
f85716b8 1622<section><title>Layer Operations</title>
ce269944 1623<para>
f85716b8 1624The following are available on Aggregate Layers:
ce269944 1625</para>
f85716b8 1626</section>
ce269944
RN
1627
1628<section><title>New Layer</title>
1629<para>
1630Add a new layer of the selected type.
1631</para>
1632</section>
1633
f85716b8
RN
1634<section id="sort_items" xreflabel="Sort"><title>Sort</title>
1635<para>
1636The list within the treeview can be sorted.
1637</para>
1638<para>
1639Currently alphabetical (A to Z or Z to A) sorts are available, since only the name can be seen in the treeview.
1640</para>
1641</section>
1642
1643<section id="track_list" xreflabel="Track List"><title>Track List</title>
1644<para>
1645Selecting this opens a dialog listing all the tracks in a table along side statistics such as track length and maximum speed.
1646Each column header is clickable and will reorder the list according to that particular column.
1647</para>
1648<para>
1649This table may be invoked from a variety of different layer levels and will then list only the relevant tracks (and/or routes).
1650<itemizedlist>
1651<listitem><para>Aggregate Layer: Lists Tracks and Routes and the TrackWaypoint Layer they are in</para></listitem>
1652<listitem><para>TrackWaypoint Layer: Lists Tracks and Routes</para></listitem>
1653<listitem><para>TrackWaypoint Track sublayer: Lists Tracks only</para></listitem>
1654<listitem><para>TrackWaypoint Route sublayer: Lists Routes only</para></listitem>
1655</itemizedlist>
1656</para>
1657<para>
1658<figure>
1659<title>Track List Dialog: Example</title>
af16464c
GB
1660<blockquote>
1661<para>
f85716b8
RN
1662This is showing all tracks and routes (although there are no actual routes here!) in multiple TrackWaypoint layers, that has been sorted by height.
1663Note that routes will not have timestamps or speeds, but may have elevations and should have some distance!
af16464c
GB
1664</para>
1665</blockquote>
f85716b8
RN
1666<screenshot>
1667 <graphic format="PNG" fileref="figures/LayersTracksList.png"/>
1668</screenshot>
1669</figure>
1670</para>
1671<para>
1672Hovering the mouse over an entry will show a tooltip of the comment or description if it is available.
1673</para>
1674<para>
1675Each entry in the track list can be selected and on mouse right click offers these options:
1676<itemizedlist>
1677<listitem><para>View. Move the viewport to the area of the item and highlight it.</para></listitem>
0f29139c 1678<listitem><para>Statistics. Opens the Properties dialog on the <xref linkend="track_statistics"/> tab. Note this will close the track list dialog.</para></listitem>
f85716b8
RN
1679</itemizedlist>
1680</para>
1681</section>
1682
1683<section id="waypoint_list" xreflabel="Waypoint List"><title>Waypoint List</title>
1684<para>
1685Selecting this opens a dialog listing all the waypoints to give a overview of the waypoint information.
1686Each column header is clickable and will reorder the list according to that particular column.
1687</para>
1688<para>
1689This table may be invoked from a variety of different layer levels and will then list only the relevant waypoints.
1690<itemizedlist>
1691<listitem><para>Aggregate Layer: Lists Waypoints and the TrackWaypoint Layer they are in</para></listitem>
1692<listitem><para>TrackWaypoint Layer: : Lists Waypoints</para></listitem>
1693<listitem><para>TrackWaypoint Waypoint sublayer: Lists Waypoints</para></listitem>
1694</itemizedlist>
1695</para>
1696<para>
1697<figure>
1698<title>Waypoint List Dialog: Example</title>
af16464c
GB
1699<blockquote>
1700<para>
f85716b8 1701This was invoked on a TrackWaypoint layer and shows all waypoints from that single layer. It has been sorted by the symbols.
af16464c
GB
1702</para>
1703</blockquote>
f85716b8
RN
1704<screenshot>
1705 <graphic format="PNG" fileref="figures/WaypointsList.png"/>
1706</screenshot>
1707</figure>
1708</para>
1709<para>
1710Hovering the mouse over an entry will show a tooltip of the description if it is available.
1711</para>
1712<para>
1713Each entry in the list can be selected and on mouse right click offers these options:
1714<itemizedlist>
1715<listitem><para>View. Move the viewport to the area of the item and highlight it.</para></listitem>
1716<listitem><para>Properties. This will open the properties dialog. Note this will close the waypoint list dialog.</para></listitem>
1717<listitem><para>Show Picture. If enabled, this will open the associated image in an external Image Viewer program.</para></listitem>
1718</itemizedlist>
1719</para>
1720</section>
1721
1722<section id="vis_options" xreflabel="Visibility Options"><title>Visibility Options</title>
1723<para>
1724This offers a quick way to set all the visibilities of each item within the containing layer, rather than having to change each one individually.
1725<itemizedlist>
1726<listitem><para>Show All. Ensures all items are set to be visible.</para></listitem>
1727<listitem><para>Hide All. Ensures all items are set to be invisible. This is useful for then turning on single items afterwards so the display is not cluttered.</para></listitem>
1728<listitem><para>Toggle. Inverts the visibility status of each item.</para></listitem>
1729</itemizedlist>
1730</para>
1731</section>
1732
a77c32c8
RN
1733<section id="search_date" xreflabel="Search by Date"><title>Search by Date</title>
1734<para>
1735This opens calendar dialog to select a date to search by within this Aggregate layer.
1736The first item that is found on that date will be selected.
1737Tracks are searched first in preference over waypoints.
1738</para>
1739</section>
1740
ce269944
RN
1741</section><!-- End Agg -->
1742
6a997af7 1743<section id="GeoRef" xreflabel="GeoRef"><title>GeoRef Layer</title>
ce269944
RN
1744<para>
1745This 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.
1746</para>
1747<section><title>Layer Operations</title>
1748<section><title>Zoom to Fit Map</title>
1749<para>
1750Automatically set a zoom level to see the entire map coverage.
1751</para>
1752</section>
1753
1754<section><title>Goto Map Center</title>
1755<para>
1756Center the viewport on this map.
1757</para>
1758
1759</section>
1760<section><title>Export to World File</title>
1761<para>
1762Opens 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>.
1763</para>
1764</section>
1765</section>
1766
1767</section><!-- End GeoRef -->
1768
6a997af7 1769<section id="Coordinate" xreflabel="Coordinate"><title>Coordinate Layer</title>
ce269944
RN
1770<para>
1771This layer is allows drawing of grid lines on the viewport.
1772</para>
1773</section><!-- End Coord -->
1774
845a6b70 1775
fef1084a 1776<section id="tools" xreflabel="Tools"><title>Tools</title>
6928e16b 1777<para>
a2322aa1
RN
1778&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.
1779</para>
1780<para>
2348ca1b 1781You 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.
6928e16b
GB
1782</para>
1783<para>
0f67220f 1784<keycap>Scroll</keycap>: zoom in and out keeping the mouse over same location
6928e16b
GB
1785</para>
1786<para>
0f67220f 1787<keycap>Ctrl-scroll</keycap>: pan north-south (also <keycap>Ctrl-up</keycap>, <keycap>Ctrl-down</keycap>)
6928e16b
GB
1788</para>
1789<para>
0f67220f 1790<keycap>Shift-scroll</keycap>: pan east-west (also <keycap>Ctrl-left</keycap>, <keycap>Ctrl-right</keycap>)
6928e16b
GB
1791</para>
1792<para>
0f67220f 1793<keycap>Ctrl-shift-scroll</keycap>: zoom in and out, without changing the center (also <keycap>Ctrl+</keycap>, <keycap>Ctrl-</keycap> [*not* KeyPad +/-])
6928e16b
GB
1794</para>
1795<para>
0f67220f 1796<keycap>Middle-click</keycap>: make the clicked point on the map the center
6928e16b
GB
1797</para>
1798<para>
0f67220f 1799<keycap>Middle-click</keycap> and drag: pan
6928e16b 1800</para>
f95c9f7c 1801
e2eb2a7b
RN
1802<section><title>Pan</title>
1803<para>
a2322aa1
RN
1804This is the default mode of operation for &appname;.
1805</para>
1806<para>
1807This mode is entered by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/mover_22.png"/></guiicon>
1808</para>
1809<para>
e2eb2a7b
RN
1810Pan moves the viewpoint. A single click centers the viewport at that point, whereas click and drag dynamically moves the view around.
1811This is the default tool.
1812</para>
416c8737
RN
1813<para>
1814This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+P</keycap>
1815</para>
beb9d63a
RN
1816<para>
1817Double clicking the left mouse button will zoom the map in.
1818<keycap>Shift</keycap> + double clicking the left mouse button will zoom the map out.
1819Double clicking the right mouse button will also zoom the map out.
1820</para>
e2eb2a7b
RN
1821</section>
1822
6928e16b
GB
1823<section><title>Zoom</title>
1824<para>
a2322aa1
RN
1825This mode is entered by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/zoom_18.png"/></guiicon>
1826</para>
1827<para>
2eea9a36 1828Zooms in and out on the clicked part of the map or by the selected area.
6928e16b 1829</para>
416c8737
RN
1830<para>
1831This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+Z</keycap>
1832</para>
130ac805 1833<para>
0f67220f 1834<keycap>Ctrl</keycap> + left or right click: Zoom in/out and center the map on the clicked location
130ac805 1835</para>
2eea9a36 1836<para>
0f67220f 1837<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.
2eea9a36 1838</para>
2067d6de
RN
1839<para>
1840<keycap>Shift</keycap> + left click button: Jump Zoom In by up to factor of 3 standard zooms.
1841</para>
1842<para>
1843<keycap>Shift</keycap> + right click button: Jump Zoom Out by up to factor of 3 standard zooms.
1844</para>
6928e16b 1845</section>
f95c9f7c 1846
6928e16b 1847<section><title>Ruler</title>
9ca89c29 1848<para>
a2322aa1
RN
1849This mode is entered by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/ruler_18.png"/></guiicon>
1850</para>
1851<para>
9ca89c29 1852The 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.
84017394 1853A second click will <emphasis>freeze</emphasis> the ruler at that point.
6928e16b 1854</para>
416c8737 1855<para>
6b59f63d 1856This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+U</keycap>
416c8737 1857</para>
6928e16b 1858</section>
f95c9f7c 1859
fef1084a 1860<section id="select" xreflabel="Select"><title>Version1.1+: Select</title>
e2eb2a7b 1861<para>
a2322aa1
RN
1862This mode is entered by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/select_18.png"/></guiicon>
1863</para>
1864<para>
e2eb2a7b
RN
1865The select tool allows one to choose any waypoint or track by clicking on it (or reasonably near) in the viewpoint.
1866</para>
1867<para>
1868ATM to select a track one must actually click on a trackpoint, which is also selected.
1869</para>
416c8737
RN
1870<para>
1871This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+S</keycap>
1872</para>
e2eb2a7b
RN
1873</section>
1874
6928e16b
GB
1875<section><title>TrackWaypoint Layer Tools</title>
1876<para>
6a997af7 1877You must have a <xref linkend="TrackWaypoint"/> Layer selected to use these tools.
6928e16b 1878</para>
fef1084a 1879<section id="createwptool" xreflabel="Create Waypoint"><title>Create Waypoint</title>
6928e16b 1880<para>
a2322aa1
RN
1881Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/addwp_18.png"/></guiicon>
1882</para>
1883<para>
f95c9f7c 1884Left click will open the new waypoint dialog using the specified position.
6928e16b 1885</para>
f95c9f7c
RN
1886</section>
1887
179bfc90 1888<section id="track_create" xreflabel="Create Track"><title>Create Track</title>
6928e16b 1889<para>
a2322aa1
RN
1890Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/addtr_18.png"/></guiicon>
1891</para>
1892<para>
f95c9f7c
RN
1893Left click to create a new trackpoint. If it's the initial trackpoint you will be asked to enter a name for the track.
1894If <keycap>Ctrl</keycap> is held at the same time, it will jump the new trackpoint position to a nearby existing trackpoint.
845a6b70 1895Right click or <keycap>Backspace</keycap>: undo one point.
6928e16b
GB
1896</para>
1897<para>
179bfc90
RN
1898Double click or <keycap>Escape</keycap>: to finish track creation.
1899Finishing the track is also available via the right click <xref linkend="TrackWaypoint"/> and track menus.
1900</para>
1901<para>
1902One must finish the current track to be able to create another track.
1903</para>
1904</section>
1905
1906<section id="route_create" xreflabel="Create Route"><title>Create Route</title>
1907<para>
1908Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/vik_new_route_18.png"/></guiicon>
1909</para>
1910<para>
1911This operates in exactly the same way as the <link linkend="track_create">Create Track</link> above.
1912</para>
1913<para>
1914One must finish the current route to be able to create another route.
6928e16b 1915</para>
d5b9bc1b
MH
1916<para>
1917One can switch between the <link linkend="route_create">Create Route</link> and <link linkend="route_finder">Route Finder</link> tools while editing routes.
1918</para>
1919</section>
1920
1921<section id="route_finder" xreflabel="Route Finder"><title>Create Route Using the Route Finder</title>
1922<para>
1923Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/route_finder_18.png"/></guiicon>
1924</para>
1925<para>
1926Requires an internet connection.
1927Left click to create a new trackpoint.
1928If it's the initial trackpoint you will be asked to enter a name for the route, otherwise the default routing engine will be queried to find a route to the new trackpoint.
1929Right click or <keycap>Backspace</keycap>: remove the last added route.
1930</para>
1931<para>
1932<keycap>Escape</keycap>: to finish route creation.
1933Finishing the track is also available via the right click <xref linkend="TrackWaypoint"/> and track menus.
1934</para>
1935<para>
1936One must finish the current route to be able to create another route.
1937</para>
1938<para>
1939One can switch between the <link linkend="route_create">Create Route</link> and <link linkend="route_finder">Route Finder</link> tools while editing routes.
1940</para>
6928e16b 1941</section>
f95c9f7c 1942
6928e16b
GB
1943<section><title>Edit Waypoint</title>
1944<para>
a2322aa1
RN
1945Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/edwp_18.png"/></guiicon>
1946</para>
1947<para>
f95c9f7c
RN
1948Left Click/drag: select/move a waypoint.
1949If <keycap>Ctrl</keycap> is held at the same time, it will jump the waypoint position to a nearby existing trackpoint.
1950If <keycap>Shift</keycap> is held at the same time, it will jump the waypoint position to a nearby existing waypoint.
6928e16b
GB
1951</para>
1952<para>Right-click on waypoint: opens a menu with waypoint actions (the
1953same menu accessed by right-clicking the waypoint in the layers panel)
1954</para>
6928e16b 1955</section>
f95c9f7c 1956
6928e16b
GB
1957<section><title>Edit Trackpoint</title>
1958<para>
a2322aa1
RN
1959Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/edtr_18.png"/></guiicon>
1960</para>
1961<para>
f95c9f7c
RN
1962Left click near a trackpoint (in screen pixel terms) to bring up the Track Point Edit dialog on that trackpoint.
1963Whilst the edit dialog is already open, left click again and drag enables moving of the trackpoint.
1964If <keycap>Ctrl</keycap> is held at the same time, it will jump the new trackpoint position to a nearby existing trackpoint.
6928e16b 1965</para>
468f536d 1966<section id="Trackpoint_edit" xreflabel="Edit Trackpoint Dialog"><title>Edit Trackpoint Dialog</title>
6928e16b 1967<para>
468f536d
RN
1968Editing options in the Trackpoint Edit dialog include:
1969<itemizedlist>
6d07b697
GB
1970<listitem><para>Edit the trackpoint name</para></listitem>
1971<listitem><para>Changing raw lat/long position and altitude</para></listitem>
1972<listitem><para>Forward (go to the next trackpoint)</para></listitem>
1973<listitem><para>Back (go to the previous trackpoint)</para></listitem>
1974<listitem><para>Delete</para></listitem>
1975<listitem><para>Insert. Inserts a point halfway to next trackpoint</para></listitem>
1976<listitem><para>Split. <xref linkend="trkpt_split"/></para></listitem>
468f536d
RN
1977</itemizedlist>
1978</para>
1979<para>
1980Several fields are read only for reference purposes, values are shown if the trackpoint has such information:
1981<itemizedlist>
6d07b697
GB
1982<listitem><para>Time.</para></listitem>
1983<listitem><para>Speed and course.</para></listitem>
1984<listitem><para>'Between' values: Speed, Time Difference and Distance Difference. When moving between trackpoints (via the Back and Forward buttons) these values are calculated.</para></listitem>
1985<listitem><para>GPS precision factors.</para></listitem>
468f536d
RN
1986</itemizedlist>
1987</para>
1988<para>
1989<figure>
1990<title>Trackpoint Edit Dialog: Example</title>
1991<screenshot>
1992 <graphic format="PNG" fileref="figures/Trackpoint_edit_dialog.png"/>
1993</screenshot>
1994</figure>
1995One must have been going downhill here to get a reasonable speed by bicycle!
6928e16b 1996</para>
6928e16b 1997</section>
468f536d 1998</section>
f95c9f7c 1999
6928e16b
GB
2000<section><title>Show Picture</title>
2001<para>
a2322aa1
RN
2002Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/showpic_18.png"/></guiicon>
2003</para>
2004<para>
f95c9f7c 2005Opens an image viewer with the picture associated with the waypoint.
73919102 2006By default this uses the default system image viewer.
fef1084a 2007For Linux you can override this with the setting in the <xref linkend="prefs_external"/>
6928e16b 2008</para>
6928e16b 2009</section>
f95c9f7c 2010
6928e16b 2011</section>
f95c9f7c 2012
6928e16b
GB
2013<section><title>Georef Map Layer Tools</title>
2014<para>
6a997af7 2015You must have a <xref linkend="GeoRef"/> Map Layer selected to use these tools.
6928e16b
GB
2016</para>
2017<section><title>Georef zoom</title>
a2322aa1
RN
2018<para>
2019Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/geozoom_18.png"/></guiicon>
2020</para>
6928e16b 2021<para>Changes the zoom level of the georeferenced map and changes the
7233fcb6 2022&appname; zoom level accordingly. Useful if you are trying to match GPS
6928e16b
GB
2023data to a georeferenced map.
2024</para>
6928e16b 2025</section>
f95c9f7c 2026
6928e16b
GB
2027<section><title>Georef move</title>
2028<para>
a2322aa1
RN
2029Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/geomove_18.png"/></guiicon>
2030</para>
2031<para>
6928e16b
GB
2032Drag to move the georeferenced map.
2033</para>
6928e16b 2034</section>
6928e16b 2035</section>
f95c9f7c 2036
63396406 2037<section id="map_tool_dl" xreflabel="Map Download"><title>Map Download</title>
6928e16b 2038<para>
6a997af7 2039You must have a <xref linkend="Maps"/> Layer selected to use this.
f95c9f7c
RN
2040</para>
2041<para>
a2322aa1
RN
2042Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/mapdl_18.png"/></guiicon>
2043</para>
2044<para>
6928e16b
GB
2045Click to download a single tile. Drag to download tiles in the dragged rectangle area.
2046</para>
2047<para>
3988e165
RN
2048Right-click to redownload tiles via the selected method. Right-click and drag to redownload tiles in the dragged rectangle area by the selected method.
2049The possible methods to redownload one or more tiles are:
2050</para>
2051<para>
2052<itemizedlist>
2053<listitem><para>Bad - Only if the tile is corrupt in some way or missing, then this will download a new copy</para></listitem>
2054<listitem><para>New - Refresh the tile according to the local map cache and if server has a newer version</para></listitem>
2055<listitem><para>All - Redownload the tile</para></listitem>
2056</itemizedlist>
2057</para>
2058<formalpara><title>Map Tile Information</title>
2059<para>
5bcd6904 2060By right clicking on viewport and selecting <guimenu>Show Tile Information</guimenu> you can see the tile properties of this location for the current map layer and current zoom level.
3988e165
RN
2061This includes the remote source URL for the tile and the cached version on the local filesystem with timestamp details.
2062</para>
2063</formalpara>
2064<para>
2065<figure>
2066<title>Map Tile Info Dialog: Example</title>
2067<screenshot>
2068 <graphic format="PNG" fileref="figures/map_tile_info_dialog.png"/>
2069</screenshot>
2070</figure>
2071This is using MapQuest at &appname; zoom level 128 over the Isle of Wight, UK.
6928e16b 2072</para>
6928e16b 2073</section>
f95c9f7c 2074
6928e16b
GB
2075<section><title>DEM Download</title>
2076<para>
6a997af7 2077You must have a <xref linkend="DEM"/> Layer selected to use this.
f95c9f7c
RN
2078</para>
2079<para>
a2322aa1
RN
2080Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/demdl_18.png"/></guiicon>
2081</para>
2082<para>
6928e16b
GB
2083Click to download and import a DEM file.
2084</para>
131af8c0
RN
2085<formalpara><title>DEM File Information</title>
2086<para>
2087By right clicking on viewport and selecting <guimenu>Show DEM File Infomation</guimenu> you can see the file properties of the DEM file for this location.
2088This includes the remote source URL for the file and the cached version on the local filesystem with timestamp details.
2089</para>
2090</formalpara>
2091<para>
2092<figure>
2093<title>DEM File Info Dialog: Example</title>
2094<screenshot>
2095 <graphic format="PNG" fileref="figures/DEM_file_info_dialog.png"/>
2096</screenshot>
2097</figure>
2098This is for block 51N, 003W - covering Bristol in the UK.
2099</para>
6928e16b
GB
2100</section>
2101
7233fcb6 2102<section><title>Webtools</title>
5ab84304
GB
2103<para>
2104Many services are available only via a web browser (Google Maps, OpenStreetMap Potlach editor, etc.).
2105</para>
2106<para>
2107Jumping from &app; to such service can become annoying.
2108</para>
2109<para>
0ef60ec1 2110&appname; allows you to open such service directly at the position currently viewed in &app;.
5ab84304
GB
2111</para>
2112<para>
7233fcb6 2113This feature is called <guilabel>Webtools</guilabel>. It is also known as External Tools.
5ab84304 2114</para>
5ab84304
GB
2115</section>
2116
3e850af1 2117</section>
f95c9f7c 2118
0ef60ec1 2119<!-- Preferences -->
fef1084a 2120<section id="prefs" xreflabel="Preferences"><title>Preferences</title>
4cdc9eb3 2121<section><title>General</title>
3e850af1
GB
2122<section><title>Localisation</title>
2123<para>You can select units displayed by &appname; to best fit your usage.</para>
2124<figure>
2125<title>Properties dialog: units part</title>
2126<screenshot>
2127 <graphic format="PNG" fileref="figures/properties_units.png"/>
2128</screenshot>
2129</figure>
2130<para>Concerning degrees, you can select the way to display them:
2131<variablelist>
2132<varlistentry>
2133<term>DDD</term><listitem><para>decimal degree</para></listitem>
2134</varlistentry>
2135<varlistentry>
73919102 2136<term>DMM</term><listitem><para>partial sexagesimal display: degrees, minutes and decimal part of minutes</para></listitem>
3e850af1
GB
2137</varlistentry>
2138<varlistentry>
2139<term>DMS</term><listitem><para>sexagesimal display: degrees, minutes and seconds</para></listitem>
2140</varlistentry>
2141</variablelist>
2142</para>
2143<figure>
2144<title>Properties dialog: degree display options</title>
2145<screenshot>
2146 <graphic format="PNG" fileref="figures/properties_degree.png"/>
2147</screenshot>
2148</figure>
2149</section>
4cdc9eb3
RN
2150<section><title>Waypoint Icon Size</title>
2151<para>An option exists to control the icon (symbol) size used for waypoints
2152</para>
2153</section>
84017394
GB
2154<section><title><emphasis>Home</emphasis> Default Location: Latitude and Longitude</title>
2155<para>You can set the <emphasis>Home</emphasis> location directly by inputting the latitude and longitude in decimal degrees.
4cdc9eb3
RN
2156</para>
2157</section>
0d71f232
RN
2158<section><title>Time Display</title>
2159<para>This controls the reference timezone that times are shown in.</para>
2160<para><emphasis>Locale</emphasis> is the current user's system preference. This was how all times were shown up to version 1.5.</para>
2161<para><emphasis>World</emphasis> will attempt to determine the timezone at an object's position.</para>
2162<para><emphasis>UTC</emphasis> enforces this standard timezone.</para>
2163</section>
a067ca58
GB
2164<section><title>Tile's age</title>
2165<para>This age is used to decided wether or not a new request to tile server must be done.
2166</para>
2167<para>Changing this value, you will increase or decrese the network load.</para>
2168</section>
0d71f232 2169<section><title>Default map layer directory</title>
897e919b
GB
2170<para>This property sets the default directory of the tiles cache.
2171This value is used when you create a new map layer.
2172</para>
2173<para>You are still able to change this value in each map layer properties.</para>
2174</section>
4cdc9eb3
RN
2175<section><title>Map Cache Memory Size</title>
2176<para>This controls the amount of maps that are stored in memory, rather than having to reread from disk.
2177Generally if you have a system with lots of memory it's recommended to increase this value.
2178</para>
2179</section>
2180</section>
2181
fef1084a 2182<section id="prefs_external" xreflabel="Export/External Preferences"><title>Export/External</title>
4cdc9eb3
RN
2183<section><title>KML Export Units</title>
2184<para>Allows setting the units used when saved as the KML file type, such as Metric or Statue units</para>
2185</section>
2186<section><title>Image Viewer (Not Windows)</title>
2187<para>Allows setting the program used to view images associated with Waypoints.</para>
73919102 2188<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>
4cdc9eb3
RN
2189<para>Note: for Windows systems, viewing images associated with Waypoints always uses the system's default image viewer.</para>
2190</section>
2191<section><title>External GPX programs</title>
c025f801 2192<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>
4cdc9eb3 2193<para>Two options are given so that it can be configured for various uses such as:</para>
9d097bf5 2194<itemizedlist>
4cdc9eb3 2195<listitem><para>An OSM editor (default)</para></listitem>
4cdc9eb3 2196<listitem><para>Some other user defined program</para></listitem>
9d097bf5 2197</itemizedlist>
4cdc9eb3 2198</section>
6928e16b 2199</section>
4cdc9eb3 2200
fef1084a 2201<section id="prefs_osm" xreflabel="OpenStreetMap Traces Preferences"><title>OpenStreetMap Traces</title>
4cdc9eb3 2202<section><title>OSM Username + Password</title>
fef1084a 2203<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>
9d097bf5
GB
2204<warning>
2205<para>
2206Your OSM password will be stored in plain text.
2207</para>
2208</warning>
4cdc9eb3
RN
2209</section>
2210</section>
2211
9f30939a
GB
2212<section id="prefs_routing" xreflabel="Routing Preferences"><title>Routing</title>
2213<section><title>Routing engine</title>
2214<para>You can select the routing engine used by default, ie by features that do not propose a live selection, like <xref linkend="route_finder"/>.</para>
2215</section>
2216</section>
2217
6db85a50
RN
2218<section id="prefs_startup" xreflabel="Startup Preferences"><title>Startup</title>
2219<para>Naturally since these preferences effect the startup, the values will not be used until &appname; is restarted.</para>
2220<section><title>Restore Window Setup</title>
2221<para>When this is enabled, the main window size and layout (such as whether the statusbar or layers panel are shown) is restored to the values from last use.</para>
2222</section>
2223<section><title>Default Map Layer</title>
2224<para>When this is enabled, a map layer is automatically added whenever &appname; is opened and a &appname; file is not to be loaded.</para>
2225<para>The map layer used is defined by the map layer's default values.</para>
2226</section>
2227<section><title>Startup Method</title>
2228<para>Enables selection of how the startup position should be determined.</para>
2229<itemizedlist>
2230<listitem><para>Home Location (default) - Position as set by the <guilabel>Set the Default Location</guilabel></para></listitem>
2231<listitem><para>Last Location - Uses the last position viewed on the viewport</para></listitem>
2232<listitem><para>Specified File - Load the file as specified below</para></listitem>
2233<listitem><para>Auto Location - Use the web service <ulink url="http://www.hostip.info">hostip.info</ulink> to attempt to determine your location via IP lookup</para></listitem>
2234</itemizedlist>
2235</section>
2236<section><title>Startup File</title>
2237<para>Loads this specified file when the Startup method is set to <guilabel>Specified File</guilabel></para>
2238</section>
2239<section><title>Check For New Version</title>
2240<para>Periodically (no more than once every 14 days), check to see if there is a new version of &appname; available.</para>
2241</section>
2242</section>
2243
4cdc9eb3
RN
2244</section>
2245
2246<!-- HOWTOS-->
b088c7a0 2247<section><title>Howto's</title>
519414cf 2248<section id="howto_start"><title>Getting Started</title>
6928e16b 2249<para>
6db85a50
RN
2250&appname; from version 1.5 has several features to ease the start up process.
2251On the very first run, you will be asked if you want to enable these features which make use of an Internet connection.
2252If you select no or you have upgraded from an earlier version you can choose to enable any of the startup options via the <xref linkend="prefs_startup"/>.
2253</para>
2254<para>
2255Some other general use cases for using &appname;, are as follows:
6928e16b
GB
2256</para>
2257<section><title>Go to an area of interest</title>
2258<para>
519414cf 2259&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.
6928e16b 2260</para>
0ef60ec1
GB
2261<procedure>
2262<title>Method A</title>
2263<step>
6928e16b 2264<para>
519414cf 2265 Use the online location address/place search.
6928e16b 2266</para>
519414cf
RN
2267<para>
2268 Use the <guibutton>Go to Location</guibutton> toolbar button or from the menus
2269 <menuchoice><guimenu>View</guimenu><guimenuitem>Go to Location</guimenuitem></menuchoice>.
2270 You can change the search location provider if desired.
2271 Enter the name of place you wish to go to (you may need to specify the country to refine the search).
2272 Also you can enter a post code or a ZIP code instead.
2273</para>
2274<note>
2275 <para>You will need an internet connection for this search to work</para>
2276</note>
0ef60ec1
GB
2277</step>
2278</procedure>
2279<procedure>
2280<title>Method B</title>
2281<step>
519414cf
RN
2282<para>
2283 If you know the coordinates of where you want to view:
2284</para>
2285<para>
2286Use <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.
2287</para>
2288</step>
2289</procedure>
2290<procedure>
7bb499bc 2291<title id="method_c">Method C</title>
519414cf 2292<step>
7233fcb6
RN
2293<para>Use the GPS Layer or <menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From GPS</guimenuitem></menuchoice>
2294to load data directly from your GPS into &appname;.
519414cf 2295</para>
c3eb4a65 2296<para>You can specify the types of data to acquire: Tracks, Routes and/or Waypoints.
0ef60ec1 2297</para>
7233fcb6 2298<note>
519414cf
RN
2299<para>You must have write permission to the port used. For <trademark>Unix</trademark> like OS:</para>
2300<itemizedlist>
2301 <listitem><para>/dev/ttyS0 is the first serial port</para></listitem>
2302 <listitem><para>/dev/ttyUSB0 is the first USB port</para></listitem>
2303 <listitem><para>usb: is any USB port</para></listitem>
2304</itemizedlist>
2305<para>Depending on your distribution only one of the USB port types may work</para>
2306<para>For <trademark>Windows</trademark>:</para>
2307<itemizedlist>
2308 <listitem><para>com1: is the first serial port</para></listitem>
2309 <listitem><para>usb: is any USB port</para></listitem>
2310</itemizedlist>
2311</note>
2312<note>
2313 <para>The GPS devices supported are those supported by <application>GPSBabel</application>.</para>
2314 <para>Garmin and Magellan GPS devices supported by all versions, later versions of GPSBabel support more devices such as DeLorme and Navilink.</para>
7233fcb6 2315</note>
0ef60ec1
GB
2316</step>
2317</procedure>
2318<procedure>
519414cf 2319<title>Method D</title>
0ef60ec1 2320<step>
76b8a4e8
RN
2321<para>
2322Get data from files in GPX or KML format, which can be opened directly.
2323Use <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice>
6928e16b
GB
2324</para>
2325<para>
76b8a4e8
RN
2326Other formats can be imported that are supported by GPSBabel.
2327<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>Import File With GPSBabel...</guimenuitem></menuchoice>
6928e16b 2328</para>
a364c076 2329<note>
6928e16b 2330<para>
a364c076 2331The viewport will be automatically moved and resized to view the contents of the file.
6928e16b 2332</para>
a364c076 2333</note>
0ef60ec1
GB
2334</step>
2335</procedure>
6928e16b 2336</section>
c3a02429 2337<section><title>Add a Map Layer</title>
6928e16b 2338<para>
c3a02429 2339Use <menuchoice><guimenu>Layers</guimenu><guimenuitem>New Map Layer</guimenuitem></menuchoice>, and choose a suitable cache directory
0ef60ec1 2340where you would like to store your tracks and click <guilabel>OK</guilabel>. Zoom to a
6928e16b
GB
2341comfortable level (I suggest 4 mpp) by clicking the left and right
2342mouse buttons on the gray area where your tracks are. Now from the menu
c3a02429 2343choose the <xref linkend="map_tool_dl"/> Tool. Click where you would like to download a
6928e16b
GB
2344map. Regardless of what tool you are using, the middle mouse button
2345always pans. </para>
0ef60ec1 2346<note>
6928e16b 2347<para>
9ca89c29 2348You need an open internet connection when you are downloading maps.
6928e16b 2349</para>
0ef60ec1 2350</note>
6928e16b 2351<para>
c3a02429
RN
2352If you can no longer see your tracks or waypoints and only the map,
2353it is because the layer named <emphasis>Map</emphasis> is <emphasis>ABOVE</emphasis> your TrackWaypoint layer that your GPS data is in.
2354This means that it will be drawn last and on top of the other <xref linkend="gc_layers"/>.
2355Look at the <xref linkend="gc_layers_panel"/> to the left which shows this order.
2356Select the Map layer from the list and click the down arrow button beneath the list until the Map layer is below the TrackWaypoint layer.
2357Your tracks will now be drawn over the map.
2358</para>
519414cf 2359</section>
6928e16b 2360
519414cf
RN
2361<section><title>Set Your Home Location</title>
2362<para>
2363 You can save the current center position of the viewport as the default location AKA the Home Location by
2364 <menuchoice><guimenu>Edit</guimenu><guimenuitem>Set the Default Location</guimenuitem></menuchoice>.
2365</para>
2366<para>
2367 Then at any time you can return to this place by clicking on the <guibutton>Home</guibutton> icon on the toolbar.
2368</para>
2369<para>
fef1084a 2370 You can also set the default location via specifing the exact latitude and longitude in the <xref linkend="prefs"/>.
519414cf 2371</para>
6928e16b
GB
2372</section>
2373
2374</section>
7233fcb6 2375<section><title>From 1st startup to GPS track (including offline maps)</title>
6928e16b 2376<para>
7233fcb6 2377The first you'll see is an empty map, because &appname; in its default configuration will download maps only on demand.
84017394 2378Before 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 <userinput>Stuttgart</userinput>.
6928e16b 2379</para>
6928e16b
GB
2380<section><title>Fetching the maps</title>
2381<para>
0ef60ec1 2382<emphasis role="bold">Map</emphasis>
6928e16b 2383</para>
0ef60ec1 2384<procedure>
7233fcb6 2385<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New Map Layer</guimenuitem></menuchoice></para></step>
4502fc82 2386<step><para>in the layer properties dialogue choose e.g. <guilabel>OpenStreetMap (Mapnik)</guilabel>.</para></step>
0ef60ec1 2387<step>
4502fc82
GB
2388<para>For the moment, we keep the default <guilabel>Maps Directory</guilabel> (the directory in
2389which the maps will be stored and can be used for offline usage).</para>
0ef60ec1
GB
2390</step>
2391<step>
2392<para>Check <guilabel>Autodownload maps</guilabel> and keep the zoom level as <guilabel>Use Viking
2393Zoom Level</guilabel>.</para>
2394<note>
2395<para>
2396however, that these settings will play an important
2397role in the pre-fetch for offline usage discussed later
2398</para>
2399</note>
2400</step>
2401</procedure>
6928e16b 2402<para>You'll see a map of Stuttgart. Using the mouse wheel, you can
73919102 2403zoom in and out. The maps for the choosen resolution will be downloaded
6928e16b
GB
2404automatically.
2405</para>
2406<para>
7233fcb6 2407<emphasis role="bold">DEM Layer (Height Map)</emphasis>
4502fc82 2408</para>
0ef60ec1 2409<procedure>
7233fcb6
RN
2410<step><para>Zoom out to 512.</para></step>
2411<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New DEM Layer</guimenuitem></menuchoice></para></step>
4502fc82 2412<step><para>Keep the download source as is (SRTM Global 90m), hit <guilabel>OK</guilabel>.</para></step>
0ef60ec1 2413</procedure>
4502fc82 2414
6a997af7 2415<para>In the layer listing on the left, the <xref linkend="DEM"/> layer should reside
6928e16b 2416above the map layer. If this is not the case, highlight the DEM layer
0ef60ec1 2417an shift it one up (using the arrow up button).
4502fc82 2418</para>
0ef60ec1 2419<procedure>
4502fc82
GB
2420<step><para>highlight the DEM layer in the layer listing on the left</para></step>
2421<step><para>in the toolbar, check DEM layer download/import (the last symbol)</para></step>
2422<step><para>a left-click in the map window should then fetch the DEM data</para></step>
0ef60ec1 2423</procedure>
0ef60ec1 2424<para>
7233fcb6 2425This might take some time.
6928e16b
GB
2426</para>
2427<para>
2428Sometimes, a tile does not show up correctly (you might see only a
2429black frame in the map window) because it got corrupted during
0ef60ec1 2430transfer. In order to correct this, you can delete the corresponding
7233fcb6 2431datafile in the cache. <programlisting> right-click the DEM layer properties</programlisting>
6928e16b
GB
2432</para>
2433<para>
0ef60ec1 2434The <guilabel>DEM Files</guilabel> listing allows you to delete the specific tiles (alternatively do this from the command line).
6928e16b
GB
2435</para>
2436<para>
0ef60ec1 2437You can also alter the Min. and Max. elevation in this dialogue.
6928e16b
GB
2438</para>
2439
2440</section>
7233fcb6 2441<section><title>GPS Track with Height Profile</title>
0ef60ec1 2442<procedure>
6a997af7 2443<step><para>Uncheck the <xref linkend="DEM"/> layer (the map is shown again)</para></step>
7233fcb6 2444<step>
73919102
RN
2445 <para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New TrackWaypoint Layer</guimenuitem></menuchoice></para>
2446 <para>Ensure the new track layer is above the map layer.</para>
2447</step>
6a997af7 2448<step><para>Expand the <xref linkend="TrackWaypoint"/> layer, select <guimenuitem>Tracks</guimenuitem></para></step>
c3eb4a65 2449<step><para>In the tools menu choose <guiicon><inlinegraphic fileref="figures/addtr_18.png"/></guiicon> <guibutton>Create Track</guibutton>
7233fcb6 2450</para></step>
73919102
RN
2451<step><para>Leftclick in the map window, enter a name</para></step>
2452<step>
2453 <para>Click several times to generate a track (a right-click removes the last point).</para>
2454 <para>Height data is set automatically since DEM data is available</para>
2455</step>
2456<step><para>Expand tracks in the layer menu, your track should show up, select it</para></step>
2457<step><para>Right click your track, select <guimenuitem>Properties</guimenuitem></para></step>
2458<step><para>Click the tab <guilabel>Elevation-distance</guilabel> - enjoy the plot</para></step>
0ef60ec1 2459</procedure>
6928e16b 2460<para>
0ef60ec1 2461In order to save this setting for later usage
4502fc82 2462</para>
0ef60ec1 2463<procedure>
7233fcb6
RN
2464<step><para>click <guilabel>OK</guilabel> in the <guilabel>Track Properties</guilabel> dialog</para></step>
2465<step><para><menuchoice><guimenu>File</guimenu><guimenuitem>Save As</guimenuitem></menuchoice>, choose a name (you can open this <emphasis>view</emphasis> later via <menuchoice><guimenu>file</guimenu><guimenuitem>Open</guimenuitem></menuchoice>).</para></step>
0ef60ec1 2466</procedure>
6928e16b
GB
2467
2468</section>
2469<section><title>Usecase: offline data for holiday</title>
2470<para>
6a997af7 2471Suppose you want to have the <xref linkend="Maps"/> and <xref linkend="DEM"/> data offline for your holiday in Italy near Bologna.
0ef60ec1
GB
2472</para>
2473<procedure>
7233fcb6
RN
2474<step><para>Start a new &appname; session.</para></step>
2475<step><para><menuchoice><guimenu>View</guimenu><guimenuitem>Go to Location</guimenuitem></menuchoice>, enter Bologna</para></step>
2476<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New Map Layer</guimenuitem></menuchoice></para></step>
4502fc82
GB
2477<step><para>Choose e.g. <guilabel>OpenStreetMap (mapnik)</guilabel>.</para></step>
2478<step><para>adapt the <guilabel>maps directory</guilabel> e.g. to <filename>/home/user/.viking-map-holiday/</filename>.
0ef60ec1 2479This allows you to delete the map stuff after holiday without purging the rest of your maps.
4502fc82
GB
2480</para></step>
2481<step><para>check <guilabel>autodownload map</guilabel></para></step>
2482<step><para>keep <guilabel>viking zoom level</guilabel></para></step>
7233fcb6 2483<step><para>zoom out to 1024</para></step>
6a997af7 2484<step><para>add a <xref linkend="DEM"/> layer (as discussed above)</para></step>
4502fc82 2485<step><para>download the DEM data</para></step>
0ef60ec1
GB
2486</procedure>
2487<para>In the &app; version discussed here, the DEM data automatically
2488are stored in <filename>/home/user/.viking-maps/</filename>. You can move the corresponding
2489tiles into <filename>.viking-map-holiday/</filename> if you like.
2490</para>
2491<para>
2492<emphasis role="bold">Download map data for all zoom levels</emphasis>
2493</para>
2494<procedure>
4502fc82
GB
2495<step><para>uncheck the DEM layer for the map to show up</para></step>
2496<step><para>navigate the map to be centered at Bologna</para></step>
7233fcb6 2497<step><para>choose the zoom such, that all regions of interest are displayed in the map window (e.g. 1024)</para></step>
0ef60ec1
GB
2498<step>
2499<para>follow this sequence until you have all tiles for all zoom levels you need</para>
2500<substeps>
7233fcb6 2501<step><para>right-click the map layer properties</para></step>
4502fc82 2502<step><para>set the zoomlevel explicitely one below the last (in the first cycle 512), hit OK</para></step>
7233fcb6
RN
2503<step><para>right click the map layer <guimenuitem>Download Missing Onscreen Maps</guimenuitem></para></step>
2504<step><para>wait until all tiles for that resolution have been downloaded</para></step>
0ef60ec1
GB
2505</substeps>
2506</step>
2507</procedure>
73919102 2508<para>This may take some time and some hard disk capacity.</para>
6928e16b
GB
2509<para>
2510Do not forget to save your configuration (as discussed above).
2511</para>
2512
2513</section>
2514
2515</section>
9c4555df
GB
2516<section><title>OpenStreetMap project</title>
2517<para>
2518<ulink url="http://openstreetmap.org/">OpenStreetMap (OSM)</ulink> is a collaborative project to create a free editable map of the world.
2519One of sources of data for this project is GPS tracks.
2520&appname; supports this project via the GPS Traces methods, both uploading and downloading such data.
2521</para>
5f526098
RN
2522<para>
2523Also see <ulink url="http://wiki.openstreetmap.org/wiki/API_v0.6#GPS_Traces"/> for further detail.
2524</para>
6928e16b
GB
2525<section><title>Uploading data to OpenStreetMap</title>
2526<para>
7233fcb6 2527It is possible to upload data directly from &appname; to OpenStreetMap.
6928e16b 2528</para>
0ef60ec1
GB
2529<formalpara>
2530<title>Upload a layer</title>
6928e16b 2531<para>
6a997af7 2532One solution is to upload whole a <xref linkend="TrackWaypoint"/> layer. To do this,
0ef60ec1
GB
2533simply select the layer and right click on it. Then, select <guimenuitem>Upload to
2534OSM</guimenuitem>.
6928e16b 2535</para>
0ef60ec1
GB
2536</formalpara>
2537<formalpara>
2538<title>Upload a single track</title>
6a997af7
RN
2539<para>Another solution is to upload an individual track. Simply select the track and right click on it.
2540Then select <guimenuitem>Upload to OSM</guimenuitem>.
6928e16b 2541</para>
0ef60ec1
GB
2542</formalpara>
2543<formalpara>
2544<title>Fill in the form</title>
6928e16b 2545<para>
7233fcb6 2546In both cases, &appname; will retain some information.
3e8e3227 2547The email field is the email you used to subscribed into OpenStreetMap.
6928e16b 2548The password field is the password you used with this account.
6928e16b 2549The filename is the name you want your upload has on the server. This information is displayed by the osm server.
6928e16b 2550The description is some descriptive information.
6a997af7 2551The tags field is a white separated list of tags.
0ef60ec1
GB
2552</para>
2553</formalpara>
6928e16b 2554</section>
5f526098
RN
2555
2556<section id="osm_dl" xreflabel="OpenStreetMap Traces Download"><title>Downloading Traces from OpenStreetMap</title>
9c4555df
GB
2557<para>
2558It is possible to download GPS traces directly from OpenStreetMap into &appname;.
2559This feature can be really useful for checking existing data before uploading new ones.
2560</para>
2561<formalpara>
2562<title>Download all visible tracks</title>
2563<para>One solution is to select
2564<menuchoice>
2565<guimenu>File</guimenu>
2566<guisubmenu>Acquire</guisubmenu>
2567<guimenuitem>OSM traces...</guimenuitem>
2568</menuchoice>.
2569Each request can get up to 5,000 points.
84017394 2570The dialog box allows setting which group of 5,000 points to get. These groups are known as <emphasis>Page Numbers</emphasis> which start at 0.
9c4555df 2571Increasing the page number parameter allows one to request the subsequent sets of point groups.
9c4555df
GB
2572</para>
2573</formalpara>
2574</section>
5f526098
RN
2575<section id="osm_my_dl" xreflabel="OpenStreetMap My Traces Download"><title>Downloading Your Own Traces from OpenStreetMap</title>
2576<para>
2577It is possible to download any of <emphasis>your personal</emphasis> GPS traces previously uploaded to OpenStreetMap into &appname;.
2578</para>
2579<para>
2580You will need to provide your OSM username and password to get the list of your OSM Traces.
2581From this list you can select which traces to retrieve.
2582This 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.
2583</para>
2584</section>
2585
9c4555df
GB
2586</section>
2587
269865aa
RN
2588<section><title>Geotagging</title>
2589<para>
6a997af7 2590 This assumes you already have a <xref linkend="Maps"/> layer enabled for ease of use (if not see above to get one).
269865aa
RN
2591</para>
2592<section><title>Manual Positioning</title>
2593<para>
2594 This is useful for instances when you already know exactly where the image was taken (no need for tracklog).
2595 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.
2596 ATM this process only works on an individual image, so it will be tedious for handling lots of images.
2597</para>
2598<para>
c3a02429 2599 First create a <xref linkend="TrackWaypoint"/> layer or use an existing one; and select it in the <xref linkend="gc_layers_panel"/>.
269865aa
RN
2600 NB Make sure this layer is above the map layer in the Layers Panel list.
2601 Create a new waypoint (or move an existing one) to exact location desired:
2602<itemizedlist>
fef1084a
RN
2603 <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>
2604 <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>
269865aa
RN
2605</itemizedlist>
2606 Then using the Select tool left click on waypoint to select it, then right click to access the Waypoint properties menu, then choose
2607 <menuchoice><guimenu>Update Geotag on Image</guimenu><guisubmenu>Update</guisubmenu></menuchoice>
2608</para>
2609<para>
2610 The <guilabel>Update Geotag on Image</guilabel> options are only available when a waypoint has an image associated with it.
2611</para>
2612</section>
2613
2614<section><title>Automatic Positioning Against a Tracklog</title>
2615<para>
2616 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 -
2617 see <link linkend="howto_start">Getting Started</link>.
2618 It helps if this is the track that was recorded at the time you took some photographs!
2619</para>
2620<para>
fef1084a
RN
2621 Select the track either from the layers panel on the left or via the viewport using the <xref linkend="select"/> tool.
2622 Then right click on it and chose the <menuchoice><guimenu>Geotag Images...</guimenu></menuchoice> leading you to the <xref linkend="geotagging"/> Dialog.
269865aa
RN
2623</para>
2624<para>
2625 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.
2626 If things are succesful, new waypoints with thumbnail images of the photographs will appear.
2627 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.
2628</para>
2629<formalpara><title>Option: Overwrite Waypoints</title>
2630<para>
2631 This is particularly useful when one finds an attempt at geotagging gives wrong locations, often due to time offset issues.
2632 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).
2633</para>
2634</formalpara>
2635<para>
2636 If you have multiple tracks in a TrackWaypoint layer, then invoking the <menuchoice><guimenu>Geotag Images...</guimenu></menuchoice> action on the layer
2637 will search all the tracks to find location matches.
2638</para>
2639</section>
2640</section>
2641
9eada844
RN
2642<section><title>GPS Real Time Location (Not <trademark>Windows</trademark>)</title>
2643<para>
2644 &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.
2645 Unfortunately <application>gpsd</application> is not available on <trademark>Windows</trademark>,
2646 so currently this functionality is disabled in <trademark>Windows</trademark> builds of &appname;
2647</para>
2648<para>
6a997af7 2649 This assumes you already have a <xref linkend="Maps"/> layer enabled for ease of use (if not see above to get one).
9eada844
RN
2650</para>
2651<para>
2652 Turn on the GPS Device, ensure it has figured out it's location and plug it in to your computer.
2653</para>
2654<section><title>Set Up GPS Layer</title>
2655<para>
6a997af7 2656 You will need a <xref linkend="GPS"/> layer. One can be added via <menuchoice><guimenu>Layers</guimenu><guisubmenu>Add GPS Layer</guisubmenu></menuchoice>.
9eada844
RN
2657</para>
2658<para>
2659 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.
2660</para>
2661<para>
2662 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.
2663</para>
2664<para>
2665 Then right-click the layer and select <guimenuitem>Start Realtime Tracking</guimenuitem>.
2666 Hopefully the viewport should jump to the GPS location.
2667</para>
2668<para>
2669 Troubleshooting checklist:
2670</para>
2671<procedure><step><para>Confirm <application>gpsd</application> is running.</para></step></procedure>
2672<procedure><step><para>Confirm on the GPS device it has a location.</para></step></procedure>
2673<procedure><step><para>Confirm the <emphasis>Realtime Tracking Mode</emphasis> settings.</para></step></procedure>
2674</section>
2675</section>
2676
935bb09f
RN
2677<section><title>What to Do if &appname; Does Not Seem to Work</title>
2678<para>
2679In order to get some information about what &appname; is doing, start it in verbose debug mode via the command line:
2680<programlisting>viking -dV</programlisting>
2681</para>
2682<para>
2683For instance you can check the correct URLs &appname; is using in requesting remote data for DEMs or map tiles in the verbose debug output.
2684E.g. Something like this for DEMs:
2685<screen>
2686** (viking:28778): DEBUG: curl_download_uri: uri=http://dds.cr.usgs.gov/srtm/version2_1/SRTM3/Eurasia/N48E008.hgt.zip
2687* About to connect() to dds.cr.usgs.gov port 80 (#0)
2688* Trying 152.61.128.95... * connected
2689* Connected to dds.cr.usgs.gov (152.61.128.95) port 80 (#0)
2690 GET /srtm/version2_1/SRTM3/Eurasia/N48E008.hgt.zip HTTP/1.1
2691User-Agent: viking/0.9.8 libcurl/7.18.2 GnuTLS/2.4.2 zlib/1.2.3.3 libidn/1.8
2692Host: dds.cr.usgs.gov
2693Accept: */*
2694 HTTP/1.1 200 OK
2695 Date: Sun, 26 Jul 2009 18:13:38 GMT
2696 Server: Apache
2697 Last-Modified: Tue, 21 Jul 2009 19:57:35 GMT
2698 ETag: eac3f8-1828f5-46f3caa76070a
2699 Accept-Ranges: bytes
2700 Content-Length: 1583349
2701 Content-Type: application/zip
2702
2703* Connection #0 to host dds.cr.usgs.gov left intact
2704* Closing connection #0
2705** (viking:28778): DEBUG: dem_layer_add_file: /home/username/.viking-maps/srtm3-Eurasia/N48E008.hgt.zip
2706</screen>
2707Or for OSM Mapnik tile server:
2708<screen>
2709* About to connect() to tile.openstreetmap.org port 80 (#0)
2710* Trying 193.63.75.28... * connected
2711* Connected to tile.openstreetmap.org (193.63.75.28) port 80 (#0)
2712 GET /13/4065/2748.png HTTP/1.1
2713User-Agent: viking/0.9.96 libcurl/7.20.1 GnuTLS/2.8.6 zlib/1.2.3.4 libidn/1.18
2714Host: tile.openstreetmap.org
2715Accept: */*
2716
2717* HTTP 1.0, assume close after body
2718 HTTP/1.0 200 OK
2719 Date: Thu, 14 Oct 2010 22:18:42 GMT
2720 Server: Apache/2.2.8 (Ubuntu)
2721 ETag: "b66ff9d46474bab68262a3483428a232"
2722** (viking:16704): DEBUG: curl_get_etag_func: ETAG found: "b66ff9d46474bab68262a3483428a232"
2723 Content-Length: 17194
2724 Cache-Control: max-age=94805
2725 Expires: Sat, 16 Oct 2010 00:38:47 GMT
2726 Content-Type: image/png
2727 Age: 5153
2728 X-Cache: HIT from konqi.openstreetmap.org
2729 X-Cache-Lookup: HIT from konqi.openstreetmap.org:3128
2730 Via: 1.1 konqi.openstreetmap.org:3128 (squid/2.7.STABLE7)
2731 Connection: close
2732
2733* Closing connection #0
2734* About to connect() to a.andy.sandbox.cloudmade.com port 80 (#0)
2735* Trying 178.63.75.195... ** (viking:16704): DEBUG: curl_download_uri: uri=http://tile.openstreetmap.org/13/4065/2749.png
2736* About to connect() to tile.openstreetmap.org port 80 (#0)
2737* Trying 193.63.75.28... * connected
2738* Connected to a.andy.sandbox.cloudmade.com (178.63.75.195) port 80 (#0)
2739 GET /tiles/cycle/13/4065/2747.png HTTP/1.1
2740User-Agent: viking/0.9.96 libcurl/7.20.1 GnuTLS/2.8.6 zlib/1.2.3.4 libidn/1.18
2741Host: a.andy.sandbox.cloudmade.com
2742Accept: */*
2743
2744* connected
2745* Connected to tile.openstreetmap.org (193.63.75.28) port 80 (#0)
2746 GET /13/4065/2749.png HTTP/1.1
2747User-Agent: viking/0.9.96 libcurl/7.20.1 GnuTLS/2.8.6 zlib/1.2.3.4 libidn/1.18
2748Host: tile.openstreetmap.org
2749Accept: */*
2750
2751* HTTP 1.0, assume close after body
2752 HTTP/1.0 200 OK
2753 Date: Thu, 14 Oct 2010 23:44:35 GMT
2754 Server: Apache/2.2.8 (Ubuntu)
2755 ETag: "8e520ad47ce9c1b63430554886eb5fab"
2756** (viking:16704): DEBUG: curl_get_etag_func: ETAG found: "8e520ad47ce9c1b63430554886eb5fab"
2757 Content-Length: 18094
2758 Cache-Control: max-age=87742
2759 Expires: Sat, 16 Oct 2010 00:06:57 GMT
2760 Content-Type: image/png
2761 X-Cache: MISS from konqi.openstreetmap.org
2762 X-Cache-Lookup: MISS from konqi.openstreetmap.org:3128
2763 Via: 1.1 konqi.openstreetmap.org:3128 (squid/2.7.STABLE7)
2764 Connection: close
2765</screen>
2766</para>
2767</section>
2768
2769</section>
2770<!-- End of Howtos -->
2771
fef1084a 2772<section id="extend_viking" xreflabel="Extending Viking">
ba322d06
GB
2773 <title>Extending Viking</title>
2774
2775 <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>
2776 <para>Here is an example:
2777<programlisting><![CDATA[
2778<objects>
2779 <object class="ClassName">
2780 <property name="property_name1">Property value</property>
2781 <property name="property_name2">Property value</property>
2782 </object>
2783 ...
2784<objects>
2785]]>
2786</programlisting>
2787</para>
2788 <para>You can find more examples in the documentation part of the distribution.</para>
4502fc82 2789 <section>
ba322d06 2790 <title>Map Source</title>
8ee1f484 2791 <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>
f1b908b1
RN
2792 <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>
2793
f5ae8c7e 2794 <para>The <classname>VikSlippyMapSource</classname> allows to declare any map's source working like OpenStreetMap. It supports the following properties:
ba322d06
GB
2795 <variablelist>
2796 <varlistentry>
2797 <term>id</term>
2798 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
2799 </varlistentry>
2800 <varlistentry>
2801 <term>label</term>
2802 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
2803 </varlistentry>
2804 <varlistentry>
2805 <term>hostname</term>
2806 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
2807 </varlistentry>
2808 <varlistentry>
2809 <term>url</term>
413e9753
RN
2810 <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for Z, X and Y (in that order) (eg. "/%d/%d/%d.png")</para></listitem>
2811 </varlistentry>
2812 <varlistentry>
2813 <term>switch-xy (optional)</term>
2814 <listitem><para>Swap the X,Y values around in the URL parametrized ordering.</para></listitem>
ba322d06
GB
2815 </varlistentry>
2816 </variablelist>
2817 </para>
f5ae8c7e 2818 <para>The <classname>VikTmsMapSource</classname> allows to declare any TMS service. It supports the following properties:
1b6659bd
GB
2819 <variablelist>
2820 <varlistentry>
2821 <term>id</term>
2822 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
2823 </varlistentry>
2824 <varlistentry>
2825 <term>label</term>
2826 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
2827 </varlistentry>
2828 <varlistentry>
2829 <term>hostname</term>
2830 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
2831 </varlistentry>
2832 <varlistentry>
2833 <term>url</term>
2834 <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>
2835 </varlistentry>
2836 </variablelist>
2837 </para>
f5ae8c7e 2838 <para>The <classname>VikWmscMapSource</classname> allows to declare any WMS or WMS-C service. It supports the following properties:
90f15672
GB
2839 <variablelist>
2840 <varlistentry>
2841 <term>id</term>
2842 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
2843 </varlistentry>
2844 <varlistentry>
2845 <term>label</term>
2846 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
2847 </varlistentry>
2848 <varlistentry>
2849 <term>hostname</term>
2850 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
2851 </varlistentry>
2852 <varlistentry>
2853 <term>url</term>
2854 <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>
2855 </varlistentry>
2856 </variablelist>
2857 </para>
4502fc82 2858 </section>
ba322d06 2859
4502fc82 2860 <section>
ba322d06
GB
2861 <title>Go-to search engines</title>
2862 <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>
2863 <para>An example of the file in the distribution <filename>doc/examples/goto_tools.xml</filename>.</para>
f5ae8c7e 2864 <para>Currently, there is a single object class available: <classname>VikGotoXmlTool</classname>. Such feature allows to declare any search engine using a XML format as result.</para>
ba322d06
GB
2865 <para>The related properties are:
2866 <variablelist>
2867 <varlistentry>
2868 <term>label</term>
2869 <listitem><para>the text displayed in the <guilabel>Go-To</guilabel> dialog</para></listitem>
2870 </varlistentry>
2871 <varlistentry>
2872 <term>url-format</term>
2873 <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>
2874 </varlistentry>
2875 <varlistentry>
2876 <term>lat-path</term>
2877 <listitem><para>XML path of the latitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
2878 </varlistentry>
2879 <varlistentry>
2880 <term>lat-attr (optional)</term>
2881 <listitem><para>name of the attribute (of previous element) containing the latitude</para></listitem>
2882 </varlistentry>
2883 <varlistentry>
2884 <term>lon-path</term>
2885 <listitem><para>XML path of the longitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
2886 </varlistentry>
2887 <varlistentry>
2888 <term>lon-attr (optional)</term>
2889 <listitem><para>name of the attribute (of previous element) containing the longiude</para></listitem>
2890 </varlistentry>
2891 </variablelist>
2892 </para>
2893 <para>As a facility (or readability) it is possible to set both path and attribute name in a single property, like an XPath expression. To do so, simply set both info in lat-path (or lon-path) in the following format: <literal>/root/parent/elem@attribute</literal>.</para>
4502fc82 2894 </section>
ba322d06 2895
4502fc82 2896 <section>
29f1598c 2897 <title>External tools</title>
ba322d06
GB
2898 <para>It is possible to add new external tools. The file is <filename>~/.viking/external_tools.xml</filename>.</para>
2899 <para>An example of the file in the distribution <filename>doc/examples/external_tools.xml</filename>.</para>
f5ae8c7e 2900 <para>The <classname>VikWebtoolCenter</classname> allows to declare any Webtool using a logic based on center coordinates and zoom level value.</para>
ba322d06
GB
2901 <para>The related properties are:
2902 <variablelist>
ba322d06
GB
2903 <varlistentry>
2904 <term>label</term>
2905 <listitem><para>the text displayed in the menu entry</para></listitem>
2906 </varlistentry>
2907 <varlistentry>
2908 <term>url</term>
3bdd680c
GB
2909 <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>
2910 </varlistentry>
2911 </variablelist>
2912 </para>
f5ae8c7e 2913 <para>The <classname>VikWebtoolBounds</classname> allows to declare any Webtool using a logic based on bounds coordinates.</para>
3bdd680c
GB
2914 <para>The related properties are:
2915 <variablelist>
3bdd680c
GB
2916 <varlistentry>
2917 <term>label</term>
2918 <listitem><para>the text displayed in the menu entry</para></listitem>
2919 </varlistentry>
2920 <varlistentry>
2921 <term>url</term>
2922 <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>
ba322d06
GB
2923 </varlistentry>
2924 </variablelist>
2925 </para>
4502fc82 2926 </section>
29f1598c 2927
b44a5ac5
GB
2928 <section>
2929 <title>Routing engine</title>
2930 <para>It is possible to declare new routing engines. The file is <filename>~/.viking/routing.xml</filename>.</para>
2931 <para>An example of the file in the distribution <filename>doc/examples/routing.xml</filename>.</para>
2932 <para>The <classname>VikRoutingWebEngine</classname> allows to declare a routing engine available via HTTP.</para>
2933 <para>The related properties are:
2934 <variablelist>
2935 <varlistentry>
2936 <term>id</term>
2937 <listitem><para>a string, should be unique as it used to identify the routing engine</para></listitem>
2938 </varlistentry>
2939 <varlistentry>
2940 <term>label</term>
2941 <listitem><para>the text displayed in the menu entry</para></listitem>
2942 </varlistentry>
2943 <varlistentry>
2944 <term>url-base</term>
2945 <listitem><para>the base URL of the web service (eg. "http://hostname/service?")</para></listitem>
2946 </varlistentry>
2947 <varlistentry>
2948 <term>url-start-ll</term>
2949 <listitem><para>the part of the URL setting the starting point location, parametrized in the spirit of C printf format, with 2 "%s" for coordinates (eg. "&amp;start=%s,%s")</para></listitem>
2950 </varlistentry>
2951 <varlistentry>
2952 <term>url-stop-ll</term>
661703c0 2953 <listitem><para>the part of the URL setting the end point location, parametrized in the spirit of C printf format, with 2 "%s" for coordinates (eg. "&amp;stop=%s,%s")</para></listitem>
b44a5ac5 2954 </varlistentry>
1a3be6a8
GB
2955 <varlistentry>
2956 <term>url-via-ll</term>
2957 <listitem><para>the part of the URL setting via point location, parametrized in the spirit of C printf format, with 2 "%s" for coordinates (eg. "&amp;via=%s,%s")</para></listitem>
2958 </varlistentry>
7f95fd54
GB
2959 <varlistentry>
2960 <term>url-start-dir</term>
2961 <listitem><para>the part of the URL setting the starting point location for direction based routing, parametrized in the spirit of C printf format, with one "%s" for direction (eg. "&amp;start=%s")</para>
2962 <para>(Optional)</para></listitem>
2963 </varlistentry>
2964 <varlistentry>
2965 <term>url-stop-dir</term>
2966 <listitem><para>the part of the URL setting the end point location for direction based routing, parametrized in the spirit of C printf format, with one "%s" for direction (eg. "&amp;start=%s")</para>
2967 <para>(Optional)</para></listitem>
2968 </varlistentry>
b44a5ac5
GB
2969 <varlistentry>
2970 <term>referer</term>
2971 <listitem><para>an URL to serve as referer for the HTTP request (eg. "http://hostname/")</para></listitem>
2972 </varlistentry>
2973 <varlistentry>
2974 <term>follow-location</term>
2975 <listitem><para>the max depth of recursive redirections</para></listitem>
2976 </varlistentry>
2977 </variablelist>
2978 </para>
2979 </section>
2980
95272265
RN
2981 <section>
2982 <title>Remote File Datasources</title>
2983 <para>It is possible to add web references expected to return a file which can then be opened directly or converted via GPSBabel.</para>
2984 <para>The file is <filename>~/.viking/datasources.xml</filename>.</para>
2985 <para>An example of the file is in the source distribution <filename>doc/examples/datasources.xml</filename>.</para>
f5ae8c7e 2986 <para>The <classname>VikWebtoolDatasource</classname> allows to declare any URL using logic based on coordinates.</para>
95272265
RN
2987 <para>The related properties are:
2988 <variablelist>
2989 <varlistentry>
2990 <term>label</term>
2991 <listitem><para>the text displayed in the menu entry</para></listitem>
2992 </varlistentry>
2993 <varlistentry>
2994 <term>url</term>
2995 <listitem>
2996 <para>the parametrized URL to open in the spirit of C printf format, with up to 7 "%s" values. e.g. <literal>http://hostname/getfile?lat=%s&amp;lon=%s</literal></para>
2997 <para>The order and meaning of these parameters is given by the url_format_code below</para>
2998 </listitem>
2999 </varlistentry>
3000 <varlistentry>
3001 <term>url_format_code</term>
3002 <listitem>
3003 <para>A string describing the parametrized URL substitution parameters, each character represents how to translate each term.</para>
3004 <para>B = Bottom of the current view i.e. minimum latitude</para>
3005 <para>L = Left of the current view i.e. minimum longitude</para>
3006 <para>T = Top of the current view i.e. maximum latitude</para>
3007 <para>R = Right of the current view i.e. maximum longitude</para>
3008 <para>A = center lAtitude of the current view</para>
3009 <para>O = center lOngitude of the current view</para>
3010 <para>Z = OSM Zoom value of the current view. See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para>
3011 <para>Thus for the url example above then the format code should be <emphasis>AO</emphasis></para>
3012 </listitem>
3013 </varlistentry>
3014 <varlistentry>
3015 <term>file_type</term>
3016 <listitem>
3017 <para>This value is passed on for the -i parameter in interfacing with GPSBabel.</para>
3018 <para>If it is not defined then the returned file is interpreted internally as a GPX file.</para>
63396406 3019 <para>Possible values such as 'kml', 'mapsource' etc.. can be used. See <ulink url="http://www.gpsbabel.org/capabilities.html">GPSBabel File Formats</ulink> for the full list.</para>
95272265
RN
3020 </listitem>
3021 </varlistentry>
3022 </variablelist>
3023 </para>
3024 </section>
3025
29f1598c
GB
3026 <section>
3027 <title>More</title>
95272265 3028 <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>, <filename>datasources.xml</filename>) are also searched in <filename>/etc/viking</filename> and <filename>/usr/share/viking</filename> directories (or related in your system).</para>
29f1598c 3029 <para>The <envar>XDG_DATA_DIRS</envar> environment variable can be used to change these directories.</para>
95272265 3030 <para>The <envar>XDG_DATA_HOME</envar> environment variable is also used (if set) to look for these extension files.</para>
29f1598c 3031 </section>
ba322d06 3032
78609471
RN
3033
3034 <section>
3035 <title>Miscellaneous Settings</title>
3036 <para>Various individual values are automatically saved between &app; sessions in the <filename>~/.viking/viking.ini</filename> file.</para>
3037 <para>This file is not intended to be manually edited, but since it is a plain text file it can be changed if desired.</para>
3038 <para>Some values in this file are <emphasis>read only</emphasis>, in the sense that there is no way to set it other than by manually entering in the keys and values (the key will not exist in the file otherwise). This allows some fine tuning of &app; behaviours, without resorting to recompiling the code. However is it not expected that these values should need to be changed for a normal user, hence no GUI options for these have been provided.</para>
3039 <para>Here is the list of the <emphasis>read only</emphasis> keys and their default values.</para>
3040 <orderedlist>
3041 <listitem>
3042 <para>maps_max_tiles=1000</para>
3043 </listitem>
3044 <listitem>
3045 <para>maps_min_shrinkfactor=0.0312499</para>
3046 </listitem>
3047 <listitem>
3048 <para>maps_max_shrinkfactor=8.0000001</para>
3049 </listitem>
3050 <listitem>
3051 <para>maps_real_min_shrinkfactor=0.0039062499</para>
3052 </listitem>
3053 <listitem>
3054 <para>background_max_threads=10</para>
3055 </listitem>
3056 <listitem>
3057 <para>window_menubar=true</para>
3058 </listitem>
7c8bddff
RN
3059 <listitem>
3060 <para>window_copy_centre_full_format=false</para>
3061 </listitem>
78609471
RN
3062 <listitem>
3063 <para>version_check_period_days=14</para>
3064 </listitem>
e3c19112
RN
3065 <listitem>
3066 <para>trackwaypoint_start_end_distance_diff=100.0</para>
3067 </listitem>
8549385f
RN
3068 <listitem>
3069 <para>gps_statusbar_format=GSA</para>
3070 <para>This string is in the Message Format Code</para>
3071 </listitem>
3072 <listitem>
b45865b4 3073 <para>trkpt_selected_statusbar_format=KEATDN</para>
8549385f
RN
3074 <para>This string is in the Message Format Code</para>
3075 </listitem>
0d71f232
RN
3076 <listitem>
3077 <para>utils_nearest_tz_factor=1.0</para>
3078 </listitem>
be5554c5
RN
3079 <listitem>
3080 <para>viewport_history_size=20</para>
3081 </listitem>
3082 <listitem>
3083 <para>viewport_history_diff_dist=500</para>
3084 <para>In metres.</para>
3085 <para>
3086 Go Back or Go Forward requests over this range from the last history location will move back to that position.
3087 If within this range it will skip over this location and move on to the next saved history location.
3088 </para>
3089 </listitem>
78609471 3090 </orderedlist>
8549385f
RN
3091
3092 <section>
3093 <title>Message Format Code</title>
3094 <para>Currently for ease of implementation the message format code is a string of characters.</para>
3095 <para>Each character represents what should be inserted in relation to a Trackpoint.</para>
3096 <para>One day it might evolve into something more user friendly with a frontend to control it, perhaps allowing arbitary text too. However for now at least some control is offered :)</para>
3097 <para>
3098 <variablelist>
3099 <varlistentry>
3100 <term>Character Code</term>
3101 <listitem>
3102 <para>G = Some text to display at the start of the message - <emphasis>GPSD</emphasis></para>
3103 <para>K = Some text to display at the start of the message - <emphasis>Trkpt</emphasis></para>
3104 <para>A = Altitude of a Trackpoint</para>
3105 <para>S = Speed of a Trackpoint</para>
3106 <para>C = Course of a Trackpoint</para>
3107 <para>L = Location of a Trackpoint</para>
3108 <para>T = Time of a Trackpoint</para>
3109 <para>M = Time diff of a Trackpoint from the previous trackpoint</para>
3110 <para>X = Number of satellites used in the trackpoint fix</para>
3111 <para>D = Distance of the trackpoint from the start of a track (following along the track)</para>
62525c73 3112 <para>F = Distance of the trackpoint from the finish (end) of a track (following along the track)</para>
8549385f
RN
3113 <para>P = Distance difference of the trackpoint from the previous trackpoint</para>
3114 <para>N = Name of track to which the trackpoint belongs</para>
b45865b4 3115 <para>E = Name of the trackpoint</para>
8549385f
RN
3116 </listitem>
3117 </varlistentry>
3118 <varlistentry>
3119 <term>Output Notes</term>
3120 <listitem>
41e7014c
RN
3121 <para>If the output has <emphasis>*</emphasis> after it, then the value has been calculated via interpolation (such as speed when the Trackpoint does not contain a speed value).</para>
3122 <para>If the output has <emphasis>**</emphasis> after it, then difficulties were encountered in trying to work the value so probably a default of 0 will be shown.</para>
8549385f
RN
3123 </listitem>
3124 </varlistentry>
3125 </variablelist>
3126 </para>
3127 </section>
78609471
RN
3128 </section>
3129
ba322d06 3130</section>
935bb09f 3131<!-- End of Extending Viking -->
f8b8a0b5 3132
12227063
GB
3133<section><title>Dependencies</title>
3134<formalpara><title>gpsbabel</title>
3135<para>&appname; uses <ulink url="http://gpsbabel.org/">GPSBabel</ulink> to convert data.</para>
3136</formalpara>
3137<formalpara><title>unbuffer (optional)</title>
3138<para>&appname; uses unbuffer command to optimize conversion calls.</para>
3139</formalpara>
73919102
RN
3140<formalpara><title>gpsd (optional - but not <trademark>Windows</trademark>)</title>
3141<para>&appname; can use <ulink url="http://www.catb.org/gpsd/">gpsd</ulink> to get the current location.</para>
3142</formalpara>
12227063
GB
3143</section>
3144
e3332d41
RN
3145<xi:include href="attribution.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
3146
f8b8a0b5 3147</article>