]> git.street.me.uk Git - andy/viking.git/blame - help/C/viking.xml
Fix internal tile locking
[andy/viking.git] / help / C / viking.xml
CommitLineData
f8b8a0b5
GB
1<?xml version="1.0"?>
2<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4 <!ENTITY appname "Viking">
5 <!ENTITY app "<application>Viking</application>">
6 <!ENTITY appversion "0.9.9">
7 <!ENTITY manrevision "0.1">
8 <!ENTITY date "Septembre 2009">
9]>
10<!--
11 (Do not remove this comment block.)
12 Maintained by the GNOME Documentation Project
13 http://live.gnome.org/DocumentationProject
14 Template version: 3.0 beta
15 Template last modified 2006-11-21
16
17-->
18<!-- =============Document Header ============================= -->
19<article id="index" lang="en">
20 <articleinfo>
21 <title>&app; Manual</title>
22 <abstract role="description">
23 <para>&app; is a free/open source program to manage GPS data.</para>
24 </abstract>
25
26 <copyright>
27 <year>2009</year>
28 <holder>Guilhem Bonnefille</holder>
29 </copyright>
30
31 <!-- An address can be added to the publisher information. -->
32 <publisher role="maintainer">
33 <publishername>GNOME Documentation Project</publishername>
34 </publisher>
35
36 <xi:include href="legal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
37 <!-- The file legal.xml contains link to license for the documentation,
38 and other legal stuff such as "NO WARRANTY" statement.
39 Please do not change any of this. -->
40
41 <authorgroup>
42 <author>
43 <firstname>Guilhem</firstname>
44 <surname>Bonnefille</surname>
45 </author>
46 </authorgroup>
47
48 <revhistory>
49 <revision>
50 <revnumber>&appname; Manual V&manrevision;</revnumber>
51 <date>&date;</date>
52 <revdescription>
53 <para role="author">Guilhem Bonnefille <email>guilhem.bonnefille@gmail.com</email></para>
54 <para role="publisher">GNOME Documentation Project</para>
55 </revdescription>
56 </revision>
57 </revhistory>
58
4502fc82 59 <releaseinfo>This manual describes version &appversion; of &appname;.</releaseinfo>
f8b8a0b5
GB
60
61 <legalnotice>
62 <title>Feedback</title>
63 <para>To report a bug or make a suggestion regarding the &app; application or
64 this manual, follow the directions in the
65 <ulink url="ghelp:user-guide?feedback-bugs" type="help">Feedback section of the GNOME User Guide</ulink>.
66 </para>
67 </legalnotice>
68 </articleinfo>
69
70 <indexterm zone="index">
71 <primary>&app;</primary>
72 </indexterm>
73<!-- ============= Document Body ============================= -->
4502fc82 74<section id="introduction">
f8b8a0b5 75 <title>Introduction</title>
6928e16b
GB
76<para>
77Viking aims to be easy to use, yet powerful in accomplishing a wide
78variety of tasks. Some of the things you can now use Viking for are:
79</para>
80<itemizedlist mark="opencircle"><listitem>
81<para>
82Uploading and downloading waypoints, tracks to/from GPS.
83</para>
84</listitem>
85<listitem>
86<para>Preparing tracks and waypoints for trips using maps from services
87such as Googlemaps, Terrasever. The data is only needed to upload to
88your GPS before you leave. The maps together with your tracks and
89waypoints can also be printed and used during the trip.
90</para>
91</listitem>
92<listitem>
93<para>
94After trips, tracks and waypoints from GPS can be downloaded, stored, managed and reused in your (or your friends') later trips.
95</para>
96</listitem>
97<listitem>
98<para>
99Analyzing OHV and hiking trips, understanding where you went and how far you were from something.
100</para>
101</listitem>
102<listitem>
103<para>Making waypoints and tracks to follow to easily get someplace
104you've never been before or don't have GPS data for but Terraserver
105maps exist for it.
106</para>
107</listitem>
108<listitem>
109<para>
110Making maps with coordinate lines.
111</para>
112</listitem>
113<listitem>
114<para>
115Grouping data from multiple trips using a hierarchical data manager.
116</para>
117</listitem>
118<listitem>
119<para>
120Analyzing speed at different places (to some degree), adding waypoints where you forgot to mark one but did slow down or stop.
121</para>
122</listitem>
123<listitem>
124<para>
125Downloading and storing Terraserver maps on your hard drive and looking at them later.
126</para>
127</listitem>
128<listitem>
129<para>
130Editing tracks and trackpoints, joining and splitting up tracks
131</para>
132</listitem>
133</itemizedlist>
134<para>
135Other things which Viking will be able to do in the future include:
136</para>
0ef60ec1
GB
137<itemizedlist mark="opencircle">
138<listitem>
6928e16b
GB
139<para>
140Show the live GPS position on the Topo or Ortho map (for use on a laptop)
141</para>
142</listitem>
143<listitem>
144<para>
145Preparing tracks and waypoints to be made into Garmin maps
146</para>
147</listitem>
148</itemizedlist>
4502fc82 149</section>
6928e16b
GB
150<section><title>General Concepts</title>
151<para>
152The panel on the left is called the <emphasis role="bold">layers panel</emphasis>.
153It determines which layers and sublayers (such as tracks and waypoints)
154are shown, and the order in which they are drawn. Layers list on the
155top of the layers panel are drawn last. You can change the order by
156drag and drop, or by selecting a layer and using the up and down
157buttons at the bottom of the layers panel.
158</para>
159<para>
0ef60ec1 160The main &appname; area where the layers are draw is called the <emphasis role="bold">viewport</emphasis>.
6928e16b
GB
161</para>
162
163</section>
164<section><title>Layers</title>
165<section><title>TrackWaypoint Layer</title>
166<para>
167TrackWaypoint layers display GPS data (tracks and waypoints).
168</para>
169<para>An easy way to create new waypoints is to copy a
170latitude/longitude coordinate pair, such as the one shown on most
0ef60ec1
GB
171geocaches, and paste it into an active TrackWaypoint layer. &appname; can
172automatically recognize several variations of the lat/lon format.
173</para>
6928e16b
GB
174<para>
175By right-clicking tracks and waypoints in the layers panel, you can do
176many things with tracks and waypoints. You can easily find a specific
177track or waypoint by expanding the Tracks or Waypoints sublayers in the
178layers panel to show all tracks or waypoints, and typing the name of
179the track/waypoint.
180</para>
181<section><title>Layer Operations</title>
182<para>
183The layer has a context menu with several operations.
184</para>
185<section><title>Export</title>
186<para>
187The layer can be exported to a file GPX, GPSPoint or GPSMapper format.
188</para>
0ef60ec1 189<note>
6928e16b 190<para>
0ef60ec1
GB
191Only the entire layer can be exported, it is currently
192not possible to export an individual track.
6928e16b 193</para>
0ef60ec1 194</note>
6928e16b
GB
195
196</section>
197
198</section>
199<section><title>Track Properties</title>
200<para>
201Show many useful statistics about a track, including a
202elevation-distance graph and a speed-time graph (if data is available).
203You can click these graphs to jump to the point in the track. You can
204also reverse a track, delete duplicates, and split a track from its
205component segments (discontinuous breaks in a track) into separate
206tracks.
207</para>
208<para>
209The following colors are used in the elevation-distance graph:
210</para>
0ef60ec1
GB
211<variablelist>
212<varlistentry>
213<term>Brown profile</term>
214<listitem><para>elevation data in graph</para></listitem>
215</varlistentry>
216<varlistentry>
217<term>Yellow</term>
6928e16b 218<listitem>
0ef60ec1 219<para>no elevation data</para>
6928e16b 220</listitem>
0ef60ec1
GB
221</varlistentry>
222<varlistentry>
223<term>Green</term>
6928e16b 224<listitem>
0ef60ec1 225<para>elevation data from DEM</para>
6928e16b 226</listitem>
0ef60ec1
GB
227</varlistentry>
228<varlistentry>
229<term>Red</term>
6928e16b 230<listitem>
0ef60ec1 231<para>speed</para>
6928e16b 232</listitem>
0ef60ec1
GB
233</varlistentry>
234</variablelist>
6928e16b
GB
235
236</section>
237<section><title>Track Operations</title>
238<section><title>Merge by time</title>
0ef60ec1
GB
239<para>
240This operation repeatedly tries to merge the right-clicked track
6928e16b
GB
241with tracks in the same TrackWaypoint layer. The tracks which are
242merged are those which have at least one trackpoint less than some
243threshold time away. This way, if you somehow end up with lots of small
244segments (say, caused by turning the GPS on and off) you can merge them
0ef60ec1
GB
245easily into one track.
246</para>
6928e16b
GB
247
248</section>
249<section><title>Split by time</title>
250<para>
251This operation will split a single track into segments wherever the
252time interval between successive trackpoints is larger than some
253threshold. This is useful when processing raw NMEA GPS data, especially
0ef60ec1
GB
254taken over a long time.
255</para>
6928e16b
GB
256
257</section>
258<section><title>Apply DEM data</title>
259<para>
260If any DEM data is loaded, this will apply the DEM data to give the track elevation data.
261</para>
262
263</section>
264<section><title>Extend track end</title>
265<para>
266Change the current tool to add track and add points to the end of the track.
267</para>
268
269</section>
270<section><title>Upload to OSM</title>
271<para>
272Useful if you are an OpenStreetMap.org (OSM) contributor. Viking
273allowing you to import a track, edit it if you so wish to remove
274duplicate points, perhaps track points leading to your home, and then
275directly export the track to OSM
276</para>
277
278</section>
279<section><title>View Google Directions</title>
0ef60ec1
GB
280<para>
281Launch a web browser to see the Google directions page which
282yielded the route.
283</para>
284<note>
285<para>
286The record of the Google route is stored in
6928e16b
GB
287the track's comment, so if the comment is changed (or the route was
288created by something other than the Magic Scissors tool) this will not
289work correctly.
290</para>
0ef60ec1 291</note>
6928e16b
GB
292
293</section>
294
295</section>
296<section><title>Waypoint Operations</title>
297<section><title>Goto Geocache page</title>
298<para>
299If the waypoint's name is in Geocache form (GCXXXXX) you can launch a web browser to go to the Geocache page.
300</para>
301
302</section>
303
304</section>
305
306</section>
307<section><title>GPSLayer</title>
0ef60ec1
GB
308<para>
309GPSLayer is responsible for uploading and downloading GPS data
6928e16b
GB
310from a GPS device. It also is responsible for realtime GPS tracking.
311Expand the GPSLayer in the layers panel to see the two TRWLayers it
312uses for uploading and downloading. To upload, download, or use
313realtime tracking, right-click the GPSLayer and click the appropiate
314menu item.
315</para>
0ef60ec1 316
6928e16b
GB
317<section><title>Download</title>
318<para>
0ef60ec1 319To download data from the GPS, right-click the GPSLayer and click <guimenuitem>Download from GPS</guimenuitem>.
6928e16b
GB
320</para>
321
322</section>
323<section><title>Upload</title>
0ef60ec1
GB
324<para>
325To upload data to the GPS, first populate the GPS Upload child
6928e16b
GB
326layer of the GPS layer (either by creating waypoints/tracks in it, or
327copying and pasting or dragging waypoints/tracks from another layer).
0ef60ec1 328Then right-click the GPSLayer and click <guimenuitem>Upload to GPS</guimenuitem>.
6928e16b
GB
329</para>
330
331</section>
332<section><title>Realtime tracking</title>
0ef60ec1
GB
333<para>
334You must set up gpsd correctly or use a GPSD server and put the
6928e16b 335correct information in the GPSLayer properties dialog. Then right-cilck
0ef60ec1 336the layer and select <guimenuitem>Start realtime tracking</guimenuitem>.
6928e16b
GB
337</para>
338
339</section>
340
341</section>
342<section><title>DEM Layer (todo)</title>
343<para>
344current NASA SRTM server: http://dds.cr.usgs.gov/srtm/version2_1/
345</para>
346
347</section>
348
349</section>
350<section><title>Tools</title>
351<para>
352You can use the scroll wheel and the right-click to zoom and pan no matter what tool you are using.
353</para>
354<para>
355Scroll: zoom in and out without changing center (also Ctrl+, Ctrl-)
356</para>
357<para>
358Ctrl-scroll: pan north-south (also Ctrl-up, Ctrl-down)
359</para>
360<para>
361Shift-scroll: pan east-west (also Ctrl-left, Ctrl-right)
362</para>
363<para>
364Ctrl-shift-scroll: zoom in and out, keeping mouse over same location (like Google maps)
365</para>
366<para>
367Middle-click: make the clicked point on the map the center
368</para>
369<para>
370Middle-click and drag: pan
371</para>
372<section><title>Zoom</title>
373<para>
374Zooms in and out on the clicked part of the map.
375</para>
376
377</section>
378<section><title>Ruler</title>
379<para>Used to measure bearing distance between two point:Click on first
380point,click on second point - after few seconds the bearing distance
381between points will be displayed.
382</para>
383
384</section>
385<section><title>TrackWaypoint Layer Tools</title>
386<para>
387You must have a TrackWaypoint Layer selected to use these.
388</para>
389<section><title>New Waypoint</title>
4502fc82 390<para></para>
6928e16b
GB
391</section>
392<section><title>New Track</title>
393<para>
394Right-click: undo one point
395</para>
396<para>
397Ctrl: snap to trackpoint
398</para>
399<para>
400Shift: snap to waypoint
401</para>
402
403</section>
404<section><title>Edit Waypoint</title>
405<para>
406Click/drag: select/move a waypoint
407</para>
408<para>
4502fc82 409<keycap>Ctrl</keycap>: snap to trackpoint
6928e16b
GB
410</para>
411<para>
412Shift: snap to waypoint
413</para>
414<para>Right-click on waypoint: opens a menu with waypoint actions (the
415same menu accessed by right-clicking the waypoint in the layers panel)
416</para>
417
418</section>
419<section><title>Edit Trackpoint</title>
420<para>
421Ctrl: snap to trackpoint
422</para>
423<para>
424Shift: snap to waypoint
425</para>
426
427</section>
428<section><title>Show Picture</title>
429<para>
0ef60ec1 430Uses <application>eog</application> to open a picture shown as a picture waypoint.
6928e16b
GB
431</para>
432
433</section>
434<section><title>Magic Scissors</title>
435<para>Creates a track using Google maps routing between two points.
436Requires internet connection. Click one point, then click another to
437create a track.
438</para>
439<para>
440Right-click: undo last routing
441</para>
442<para>
443Ctrl: continue previous track
444</para>
445
446</section>
447
448</section>
449<section><title>Georef Map Layer Tools</title>
450<para>
451You must have a Georef Map Layer selected to use these tools.
452</para>
453<section><title>Georef zoom</title>
454<para>Changes the zoom level of the georeferenced map and changes the
455Viking zoom level accordingly. Useful if you are trying to match GPS
456data to a georeferenced map.
457</para>
458
459</section>
460<section><title>Georef move</title>
461<para>
462Drag to move the georeferenced map.
463</para>
464
465</section>
466
467</section>
468<section><title>Map Download</title>
469<para>
470Click to download a single tile. Drag to download tiles in the dragged rectangle area.
471</para>
472<para>
473Right-click to redownload bad/all tiles. Right-click and drag to redownload bad/all tiles in the dragged rectangle area.
474</para>
475
476</section>
477<section><title>DEM Download</title>
478<para>
479Click to download and import a DEM file.
480</para>
481
482</section>
483
5ab84304
GB
484<section><title>External tools</title>
485<para>
486Many services are available only via a web browser (Google Maps, OpenStreetMap Potlach editor, etc.).
487</para>
488<para>
489Jumping from &app; to such service can become annoying.
490</para>
491<para>
0ef60ec1 492&appname; allows you to open such service directly at the position currently viewed in &app;.
5ab84304
GB
493</para>
494<para>
495This feature is called <guilabel>External tools</guilabel>.
496</para>
497
498</section>
499
3e850af1 500</section>
0ef60ec1 501<!-- Preferences -->
3e850af1
GB
502<section><title>Preferences</title>
503<section><title>Localisation</title>
504<para>You can select units displayed by &appname; to best fit your usage.</para>
505<figure>
506<title>Properties dialog: units part</title>
507<screenshot>
508 <graphic format="PNG" fileref="figures/properties_units.png"/>
509</screenshot>
510</figure>
511<para>Concerning degrees, you can select the way to display them:
512<variablelist>
513<varlistentry>
514<term>DDD</term><listitem><para>decimal degree</para></listitem>
515</varlistentry>
516<varlistentry>
517<term>DDD</term><listitem><para>partial sexagesimal display: degrees, minutes and décimal part of minutes</para></listitem>
518</varlistentry>
519<varlistentry>
520<term>DMS</term><listitem><para>sexagesimal display: degrees, minutes and seconds</para></listitem>
521</varlistentry>
522</variablelist>
523</para>
524<figure>
525<title>Properties dialog: degree display options</title>
526<screenshot>
527 <graphic format="PNG" fileref="figures/properties_degree.png"/>
528</screenshot>
529</figure>
530</section>
a067ca58
GB
531<section><title>Tile's age</title>
532<para>This age is used to decided wether or not a new request to tile server must be done.
533</para>
534<para>Changing this value, you will increase or decrese the network load.</para>
535</section>
897e919b
GB
536<section><title>Default maplayer directory</title>
537<para>This property sets the default directory of the tiles cache.
538This value is used when you create a new map layer.
539</para>
540<para>You are still able to change this value in each map layer properties.</para>
541</section>
6928e16b
GB
542</section>
543<section><title>Mini-Howto's</title>
544<section><title>Getting Started</title>
545<para>
0ef60ec1 546To quickly get started using &appname;, follow these instructions.
6928e16b
GB
547</para>
548<section><title>Go to an area of interest</title>
549<para>
0ef60ec1 550&appname;'s default location is a 0 latitude and longitude, so you need to pick a place that interests you.
6928e16b 551</para>
0ef60ec1
GB
552<procedure>
553<title>Method A</title>
554<step>
6928e16b 555<para>
0ef60ec1 556Use View - Go to to move to a coordinate of interest.
6928e16b 557</para>
0ef60ec1
GB
558</step>
559</procedure>
560<procedure>
561<title>Method B</title>
562<step>
563<para>Use GPS Layer or File - Acquire - From GPS to load data
6928e16b 564directly from your GPS into Viking. Currently Garmin and Magellan are
0ef60ec1
GB
565supported.
566</para>
567<note><para>You must have write permission to the port used.
568/dev/ttyS0 is the first serial port</para></note>
569</step>
570</procedure>
571<procedure>
572<title>Method C</title>
573<step>
574<para>Get data from files in GPX format. For other formats (kml,
575ozi...), use a converter such as GPSBabel to convert the files to GPX
576format first.
6928e16b 577</para>
0ef60ec1
GB
578</step>
579<step>
6928e16b 580<para>
0ef60ec1
GB
581Open up viking and use File - Open or File - Append
582file to open the file.
6928e16b 583</para>
0ef60ec1
GB
584</step>
585<step>
6928e16b 586<para>
0ef60ec1
GB
587Expand Tracks or Waypoints. Right-click on the
588track or waypoint of interest and select <guimenuitem>Goto</guimenuitem>.
6928e16b 589</para>
0ef60ec1
GB
590</step>
591</procedure>
592<procedure>
593<title>Method D</title>
594<step>
6928e16b 595<para>
0ef60ec1 596Use File - Append File to add your track and waypoint data to
6928e16b 597Viking. This has been tested with Geocaching.com's *.loc format,
0ef60ec1
GB
598(others(?)).
599</para>
600</step>
601<step>
602<para>
603Expand Tracks or Waypoints. Right-click on the tack or
604point of interest and select <guimenuitem>Goto</guimenuitem>.
605</para>
606</step>
607</procedure>
6928e16b
GB
608</section>
609<section><title>Add a map layer</title>
610<para>
6111. Use Layers - New Map Layer, and choose a suitable cache directory
0ef60ec1 612where you would like to store your tracks and click <guilabel>OK</guilabel>. Zoom to a
6928e16b
GB
613comfortable level (I suggest 4 mpp) by clicking the left and right
614mouse buttons on the gray area where your tracks are. Now from the menu
615choose Tools - Map Download, Click where you would like to download a
616map. Regardless of what tool you are using, the middle mouse button
617always pans. </para>
0ef60ec1 618<note>
6928e16b 619<para>
0ef60ec1 620You MUST have an open internet connection when you are downloading maps. If not, &app; will likely hang.
6928e16b 621</para>
0ef60ec1 622</note>
6928e16b
GB
623<para>
6241. You will notice the maps are being drawn on top of the tracks, which
625is probably not what you want. Look at the Layers Panel to the left.
626Notice how the layer named Map is ABOVE your TrackWaypoint layer that
627your GPS data is in. This means that it will be drawn last, or on top
628of the other layers. Select the Map layer from the list and click the
629down arrow button beneath the list. Your tracks will now be drawn over
630the map. </para>
631
632</section>
633
634</section>
635<section><title>From 1st startup to gps track (including offline maps)</title>
636<section><title>Prerequistites</title>
637<para>
638The following refers to the version 0.9.8 from the git repository
639(26.07.2009).In the source, check in vikdemlayer.c around line 66 to
640have the correct address for the SRTM3 database. For the version
641referenced above, you should change <programlisting>#define SRTM_HTTP_URI /srtm/version2/SRTM3/</programlisting>
0ef60ec1 642to <programlisting>#define SRTM_HTTP_URI /srtm/version2_1/SRTM3/</programlisting>
6928e16b
GB
643</para>
644<para>
0ef60ec1 645For further information, see this <ulink url="https://sourceforge.net/tracker/?func=detail&amp;amp;aid=2812856&amp;amp;group_id=83870&amp;amp;atid=570954"><citetitle>discussion</citetitle></ulink>.
6928e16b
GB
646</para>
647
648</section>
649<section><title>Start in verbose debug mode</title>
650<para>
0ef60ec1
GB
651In order to get some informations about not functioning modules, start viking in verbose debug mode:
652<programlisting>viking -dV</programlisting>
6928e16b
GB
653</para>
654<para>
655The first you'll see is an empty map, because viking in its default
656configurations will download maps only on demand. Before fetching
0ef60ec1 657unneeded data, we position to a location of interest, e.g. Stuttgart: <menuchoice><guimenu>view</guimenu><guimenuitem>goto location</guimenuitem></menuchoice>, enter 'Stuttgart'.
6928e16b
GB
658</para>
659
660</section>
661<section><title>Fetching the maps</title>
662<para>
0ef60ec1 663<emphasis role="bold">Map</emphasis>
6928e16b 664</para>
0ef60ec1 665<procedure>
4502fc82
GB
666<step><para>layers new map layer</para></step>
667<step><para>in the layer properties dialogue choose e.g. <guilabel>OpenStreetMap (Mapnik)</guilabel>.</para></step>
0ef60ec1 668<step>
4502fc82
GB
669<para>For the moment, we keep the default <guilabel>Maps Directory</guilabel> (the directory in
670which the maps will be stored and can be used for offline usage).</para>
0ef60ec1
GB
671</step>
672<step>
673<para>Check <guilabel>Autodownload maps</guilabel> and keep the zoom level as <guilabel>Use Viking
674Zoom Level</guilabel>.</para>
675<note>
676<para>
677however, that these settings will play an important
678role in the pre-fetch for offline usage discussed later
679</para>
680</note>
681</step>
682</procedure>
6928e16b
GB
683<para>You'll see a map of Stuttgart. Using the mouse wheel, you can
684zoom in and out. The maps for the choosen resoltion will be downloaded
685automatically.
686</para>
687<para>
0ef60ec1 688<emphasis role="bold">DEM Layer (height map)</emphasis>
4502fc82 689</para>
0ef60ec1 690<procedure>
4502fc82
GB
691<step><para>Zoom out to 512/512.</para></step>
692<step><para><menuchoice><guimenu>layers</guimenu><guimenuitem>new DEM layer</guimenuitem></menuchoice></para></step>
693<step><para>Keep the download source as is (SRTM Global 90m), hit <guilabel>OK</guilabel>.</para></step>
0ef60ec1 694</procedure>
4502fc82 695
6928e16b
GB
696<para>In the layer listing on the left, the DEM layer should reside
697above the map layer. If this is not the case, highlight the DEM layer
0ef60ec1 698an shift it one up (using the arrow up button).
4502fc82 699</para>
0ef60ec1 700<procedure>
4502fc82
GB
701<step><para>highlight the DEM layer in the layer listing on the left</para></step>
702<step><para>in the toolbar, check DEM layer download/import (the last symbol)</para></step>
703<step><para>a left-click in the map window should then fetch the DEM data</para></step>
0ef60ec1 704</procedure>
0ef60ec1
GB
705<para>
706This might take some time. You can check the correct source in the verbose debug output: it should look something like:
707<screen>
708** (viking:28778): DEBUG: curl_download_uri: uri=http://dds.cr.usgs.gov/srtm/version2_1/SRTM3/Eurasia/N48E008.hgt.zip
709* About to connect() to dds.cr.usgs.gov port 80 (#0)
710* Trying 152.61.128.95... * connected
711* Connected to dds.cr.usgs.gov (152.61.128.95) port 80 (#0)
712 GET /srtm/version2_1/SRTM3/Eurasia/N48E008.hgt.zip HTTP/1.1
713User-Agent: viking/0.9.8 libcurl/7.18.2 GnuTLS/2.4.2 zlib/1.2.3.3 libidn/1.8
714Host: dds.cr.usgs.gov
715Accept: */*
716 HTTP/1.1 200 OK
717 Date: Sun, 26 Jul 2009 18:13:38 GMT
718 Server: Apache
719 Last-Modified: Tue, 21 Jul 2009 19:57:35 GMT
720 ETag: eac3f8-1828f5-46f3caa76070a
721 Accept-Ranges: bytes
722 Content-Length: 1583349
723 Content-Type: application/zip
724
725* Connection #0 to host dds.cr.usgs.gov left intact
726* Closing connection #0
727** (viking:28778): DEBUG: dem_layer_add_file: /home/username/.viking-maps/srtm3-Eurasia/N48E008.hgt.zip
728</screen>
6928e16b
GB
729</para>
730<para>
731Sometimes, a tile does not show up correctly (you might see only a
732black frame in the map window) because it got corrupted during
0ef60ec1 733transfer. In order to correct this, you can delete the corresponding
6928e16b
GB
734datafile in the cache. <programlisting> right-click the DEM layer properties</programlisting>
735</para>
736<para>
0ef60ec1 737The <guilabel>DEM Files</guilabel> listing allows you to delete the specific tiles (alternatively do this from the command line).
6928e16b
GB
738</para>
739<para>
0ef60ec1 740You can also alter the Min. and Max. elevation in this dialogue.
6928e16b
GB
741</para>
742
743</section>
744<section><title>GPS Track with height profile</title>
0ef60ec1
GB
745<procedure>
746<step><para>uncheck the DEM layer (the map show up again)</para></step>
747<step><para><menuchoice><guimenu>layers</guimenu><guimenuitem>new trackwaypoint layer</guimenuitem></menuchoice></para></step>
748</procedure>
6928e16b 749<para>
0ef60ec1 750Check to have the new track layer above the map layer.
4502fc82 751</para>
0ef60ec1
GB
752<procedure>
753<step><para>expand trackwaypointlayer, select <guimenuitem>Tracks</guimenuitem></para></step>
754<step><para>in the tools menu choose <guimenuitem>begin track</guimenuitem> (red cross)<!-- TODO insert icon --></para></step>
755<step><para>leftclick in the map window, enter a name</para></step>
756<step><para>click several times to generate a track (a right-click removes the last point)</para></step>
757<step><para>expand tracks in the layer menu, your track should show up, select it</para></step>
758<step><para>right click your track, select <guimenuitem>apply DEM data</guimenuitem></para></step>
759<step><para>right click your track again, select <guimenuitem>properies</guimenuitem></para></step>
760<step><para>click the tab <guilabel>elevation distance</guilabel> - enjoy the plot</para></step>
761</procedure>
6928e16b 762<para>
0ef60ec1 763In order to save this setting for later usage
4502fc82 764</para>
0ef60ec1
GB
765<procedure>
766<step><para>click <guilabel>OK</guilabel> in the <guilabel>track properties</guilabel> dialog</para></step>
767<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>
768</procedure>
6928e16b
GB
769
770</section>
771<section><title>Usecase: offline data for holiday</title>
772<para>
0ef60ec1
GB
773Suppose you want to have the map and DEM data offline for your holiday in Italy near Bologna.
774</para>
775<procedure>
4502fc82
GB
776<step><para>Start a new viking session.</para></step>
777<step><para><menuchoice><guimenu>view</guimenu><guimenuitem>goto location</guimenuitem></menuchoice>, enter Bologna</para></step>
778<step><para><menuchoice><guimenu>layers</guimenu><guimenuitem>new map layer</guimenuitem></menuchoice></para></step>
779<step><para>Choose e.g. <guilabel>OpenStreetMap (mapnik)</guilabel>.</para></step>
780<step><para>adapt the <guilabel>maps directory</guilabel> e.g. to <filename>/home/user/.viking-map-holiday/</filename>.
0ef60ec1 781This allows you to delete the map stuff after holiday without purging the rest of your maps.
4502fc82
GB
782</para></step>
783<step><para>check <guilabel>autodownload map</guilabel></para></step>
784<step><para>keep <guilabel>viking zoom level</guilabel></para></step>
785<step><para>zoom out to 1024/1024</para></step>
786<step><para>add a DEM layer (as discussed above)</para></step>
787<step><para>download the DEM data</para></step>
0ef60ec1
GB
788</procedure>
789<para>In the &app; version discussed here, the DEM data automatically
790are stored in <filename>/home/user/.viking-maps/</filename>. You can move the corresponding
791tiles into <filename>.viking-map-holiday/</filename> if you like.
792</para>
793<para>
794<emphasis role="bold">Download map data for all zoom levels</emphasis>
795</para>
796<procedure>
4502fc82
GB
797<step><para>uncheck the DEM layer for the map to show up</para></step>
798<step><para>navigate the map to be centered at Bologna</para></step>
799<step><para>choose the zoom such, that all regions of interest are displayed in the map window (e.g. 1024/1024)</para></step>
0ef60ec1
GB
800<step>
801<para>follow this sequence until you have all tiles for all zoom levels you need</para>
802<substeps>
4502fc82
GB
803<step><para>right-click the map layer properties</para></step>
804<step><para>set the zoomlevel explicitely one below the last (in the first cycle 512), hit OK</para></step>
805<step><para>right click the map layer <guimenuitem>download onscreen maps</guimenuitem></para></step>
806<step><para>wait untill all tiles for that resolution have been downloaded</para></step>
0ef60ec1
GB
807</substeps>
808</step>
809</procedure>
810<para>This may take some time and hd capacity. Lixus wrote a set of
6928e16b 811scripts which allow to download the map tiles for several zoom-level in
0ef60ec1 812parallel from the command line.
6928e16b
GB
813</para>
814<para>
815Do not forget to save your configuration (as discussed above).
816</para>
817
818</section>
819
820</section>
821<section><title>Uploading data to OpenStreetMap</title>
822<para>
823It is possible to upload data directly from Viking to OpenStreetMap.
824</para>
0ef60ec1
GB
825<formalpara>
826<title>Upload a layer</title>
6928e16b
GB
827<para>
828One solution is to upload whole a TrackWaypoint layer. To do this,
0ef60ec1
GB
829simply select the layer and right click on it. Then, select <guimenuitem>Upload to
830OSM</guimenuitem>.
6928e16b 831</para>
0ef60ec1
GB
832</formalpara>
833<formalpara>
834<title>Upload a single track</title>
6928e16b
GB
835<para>One solution is to upload whole a TrackWaypoint layer. To do
836this, simply select the layer and right click on it. Then, select
0ef60ec1 837<guimenuitem>Upload to OSM</guimenuitem>.
6928e16b 838</para>
0ef60ec1
GB
839</formalpara>
840<formalpara>
841<title>Fill in the form</title>
6928e16b
GB
842<para>
843On both case, Viking will reclaim some informations.
6928e16b 844The email field is the email you used to subscribed into OSM.
6928e16b 845The password field is the password you used with this account.
6928e16b 846The filename is the name you want your upload has on the server. This information is displayed by the osm server.
6928e16b 847The description is some descriptive information.
0ef60ec1
GB
848The tags field is a white separated list of tag.
849</para>
850</formalpara>
6928e16b
GB
851
852</section>
853<section><title>Geocoded Photo</title>
854<para>
855HOWTO GEOCODE YOUR PHOTOS AND SEE THEM IN VIKING
856</para>
857<para>1) Synchronize your camera's clock with your GPS clock. If your
858camera's clock doesn't have a seconds value you can change, you might
859try setting the minute value just when the minute changes.
860</para>
861<para>
8622) Activate the track log on your GPS.
863</para>
864<para>3) Get outside and take some pictures with your camera while
865making sure your GPS has reception. If you forgot to turn your GPS on
866or forgot to bring it when you took a picture but you know where you
867took the picture, you can make a waypoint with a name of the format
868YYMMDDhhmm, representing the time the picture was taken, to record
869where you were at that time.
870</para>
871<para>4) Get home and download your pictures and GPS data. You can
872download the GPS data several ways. The first is using gpspoint to
873download from a Garmin GPS: <programlisting>gpspoint -p /dev/ttyS0 -dw -dt -of 2004-04-02-trip1</programlisting>
874</para>
875<para>
876Where /dev/ttyS0 is the serial port the GPS is connected to. If you
877don't have a Garmin GPS, or if you don't feel like install gpspoint,
878you can use my version of gpsbabel with support for gpspoint files. You
879can use gpsbabel to either translate the GPS data from a format you
880already have the data in or download it directly from your GPS
881reciever. A typical command line would something like this:<programlisting>gpsbabel -i garmin -f /dev/ttyS0 -o gpspoint -F 2004-04-02-trip1</programlisting>
882</para>
883<para>
8845) Launch GPSPhoto.
885</para>
886<para>
8876) You must now bring your photos into GPSPhoto. Either drag them (or
888the directory containing them) from your favorite file manager to the
889list on the left of the GPSPhoto window, or use the buttons below the
890list to find them.
891</para>
892<para>
8937) Do the same for your GPS data file(s), dragging them to the list on the right of the GPSPhoto Window.
894</para>
895<para>8) Click the Execute button, and choose a location to save the
896gpspoint file containing the waypoints for your photos. Then click OK
897to write the waypoints to this file.
898</para>
899<para>
9009) Open Viking and open both your original GPS data file and your image waypoint file just created.
901</para>
902</section>
903
ba322d06
GB
904<section>
905 <title>Extending Viking</title>
906
907 <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>
908 <para>Here is an example:
909<programlisting><![CDATA[
910<objects>
911 <object class="ClassName">
912 <property name="property_name1">Property value</property>
913 <property name="property_name2">Property value</property>
914 </object>
915 ...
916<objects>
917]]>
918</programlisting>
919</para>
920 <para>You can find more examples in the documentation part of the distribution.</para>
4502fc82 921 <section>
ba322d06
GB
922 <title>Map Source</title>
923 <para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename>.</para>
924 <para>An example of the file in the distribution <filename>doc/examples/maps.xml</filename>.</para>
925 <para>Currently, there is a single object class available: VikSlippyMapSource. Such feature allows to declare any map's source working like OpenStreetMap.</para>
926 <para>The related properties are:
927 <variablelist>
928 <varlistentry>
929 <term>id</term>
930 <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
931 </varlistentry>
932 <varlistentry>
933 <term>label</term>
934 <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
935 </varlistentry>
936 <varlistentry>
937 <term>hostname</term>
938 <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
939 </varlistentry>
940 <varlistentry>
941 <term>url</term>
942 <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>
943 </varlistentry>
944 </variablelist>
945 </para>
4502fc82 946 </section>
ba322d06 947
4502fc82 948 <section>
ba322d06
GB
949 <title>Go-to search engines</title>
950 <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>
951 <para>An example of the file in the distribution <filename>doc/examples/goto_tools.xml</filename>.</para>
952 <para>Currently, there is a single object class available: VikGotoXmlTool. Such feature allows to declare any search engine using a XML format as result.</para>
953 <para>The related properties are:
954 <variablelist>
955 <varlistentry>
956 <term>label</term>
957 <listitem><para>the text displayed in the <guilabel>Go-To</guilabel> dialog</para></listitem>
958 </varlistentry>
959 <varlistentry>
960 <term>url-format</term>
961 <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>
962 </varlistentry>
963 <varlistentry>
964 <term>lat-path</term>
965 <listitem><para>XML path of the latitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
966 </varlistentry>
967 <varlistentry>
968 <term>lat-attr (optional)</term>
969 <listitem><para>name of the attribute (of previous element) containing the latitude</para></listitem>
970 </varlistentry>
971 <varlistentry>
972 <term>lon-path</term>
973 <listitem><para>XML path of the longitude (eg. <literal>/root/parent/elem</literal>)</para></listitem>
974 </varlistentry>
975 <varlistentry>
976 <term>lon-attr (optional)</term>
977 <listitem><para>name of the attribute (of previous element) containing the longiude</para></listitem>
978 </varlistentry>
979 </variablelist>
980 </para>
981 <para>As a facility (or readability) it is possible to set both path and attribute name in a single property, like an XPath expression. To do so, simply set both info in lat-path (or lon-path) in the following format: <literal>/root/parent/elem@attribute</literal>.</para>
4502fc82 982 </section>
ba322d06 983
4502fc82 984 <section>
ba322d06
GB
985 <title>External tools</title>
986 <para>It is possible to add new external tools. The file is <filename>~/.viking/external_tools.xml</filename>.</para>
987 <para>An example of the file in the distribution <filename>doc/examples/external_tools.xml</filename>.</para>
988 <para>Currently, there is a single object class available: VikWebtoolCenter. Such feature allows to declare any Webtool using a logic based on center coordinates and zoom level value.</para>
989 <para>The related properties are:
990 <variablelist>
991 <varlistentry>
992 <term>id</term>
993 <listitem><para>this is an integer and should be unique as it used to identify the tool</para></listitem>
994 </varlistentry>
995 <varlistentry>
996 <term>label</term>
997 <listitem><para>the text displayed in the menu entry</para></listitem>
998 </varlistentry>
999 <varlistentry>
1000 <term>url</term>
1001 <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for X, Y and Z (zoom level) (eg. "http://hostname/%d/%d/%d.png")</para></listitem>
1002 </varlistentry>
1003 </variablelist>
1004 </para>
4502fc82 1005 </section>
ba322d06
GB
1006
1007</section>
1008
6928e16b 1009</section>
f8b8a0b5
GB
1010
1011</article>
1012