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