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