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