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