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