"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY appname "Viking">
<!ENTITY app "<application>Viking</application>">
- <!ENTITY appversion "0.9.9">
+ <!ENTITY appversion "1.0">
<!ENTITY manrevision "0.1">
- <!ENTITY date "Septembre 2009">
+ <!ENTITY date "October 2010">
]>
<!--
(Do not remove this comment block.)
<firstname>Guilhem</firstname>
<surname>Bonnefille</surname>
</author>
+ <author>
+ <firstname>Rob</firstname>
+ <surname>Norris</surname>
+ </author>
+ <!-- Contributors from the Wiki history -->
+ <author>
+ <firstname>username:</firstname>
+ <surname>Alexxy</surname>
+ </author>
+ <author>
+ <firstname>username:</firstname>
+ <surname>Vikingis</surname>
+ </author>
+ <author>
+ <firstname>username:</firstname>
+ <surname>Tallguy</surname>
+ </author>
+ <author>
+ <firstname>username:</firstname>
+ <surname>EliotB</surname>
+ </author>
+ <author>
+ <firstname>Alex</firstname>
+ <surname>Foobarian</surname>
+ </author>
+ <!-- END -->
</authorgroup>
<revhistory>
</revision>
</revhistory>
- <releaseinfo>This manual describes version &appversion; of &app;.</releaseinfo>
+ <releaseinfo>This manual describes version &appversion; of &appname;.</releaseinfo>
<legalnotice>
<title>Feedback</title>
<primary>&app;</primary>
</indexterm>
<!-- ============= Document Body ============================= -->
-<sect1 id="introduction">
+<section id="introduction">
<title>Introduction</title>
<para>
-Viking aims to be easy to use, yet powerful in accomplishing a wide
-variety of tasks. Some of the things you can now use Viking for are:
+&appname; aims to be easy to use, yet powerful in accomplishing a wide
+variety of tasks. Some of the things you can use &appname; for are:
</para>
<itemizedlist mark="opencircle"><listitem>
<para>
</listitem>
<listitem>
<para>Preparing tracks and waypoints for trips using maps from services
-such as Googlemaps, Terrasever. The data is only needed to upload to
+such as OpenStreetMap (OSM) and/or Terrasever. The data is only needed to be uploaded to
your GPS before you leave. The maps together with your tracks and
waypoints can also be printed and used during the trip.
</para>
</listitem>
<listitem>
<para>
-Analyzing OHV and hiking trips, understanding where you went and how far you were from something.
+Analyzing Off Highway Vehicle (OHV) and hiking trips, understanding where you went and how far you were from something.
</para>
</listitem>
<listitem>
<para>Making waypoints and tracks to follow to easily get someplace
-you've never been before or don't have GPS data for but Terraserver
+you've never been before or don't have GPS data for but online
maps exist for it.
</para>
</listitem>
</listitem>
<listitem>
<para>
-Downloading and storing Terraserver maps on your hard drive and looking at them later.
+Downloading and storing OSM and/or Terraserver maps on your hard drive and looking at them later.
</para>
</listitem>
<listitem>
Editing tracks and trackpoints, joining and splitting up tracks
</para>
</listitem>
+<listitem>
+<para>
+Show the live GPS position on the map (for use on a mobile device - e.g. a laptop)
+</para>
+</listitem>
</itemizedlist>
+<note>
<para>
-Other things which Viking will be able to do in the future include:
+&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>:
</para>
-<itemizedlist mark="opencircle"><listitem>
+</note>
+</section>
+
+<section><title>General Concepts</title>
+<section><title>Layers</title>
<para>
-Show the live GPS position on the Topo or Ortho map (for use on a laptop)
+'Layers' is concept one may know from powerful graphics editors such as Photoshop or GIMP.
+Instead of putting all the data on the same level, it is stacked (i.e. layered) with different data over one another.
+This can make useful for analysis and general handling of various sets of data.
</para>
-</listitem>
-<listitem>
<para>
-Preparing tracks and waypoints to be made into Garmin maps
+Unfortunately the downside of this complexity is remembering how differing layers of data can obscure other data.
</para>
-</listitem>
-</itemizedlist>
-</sect1>
-<section><title>General Concepts</title>
+<para>
+The Map layers have <ulink url="http://en.wikipedia.org/wiki/Alpha_compositing"><citetitle>Alpha Compositing</citetitle></ulink>,
+to create the appearance of partial transparency.
+By controlling this value one can see data below it in the layer heirarchy for interesting effects.
+</para>
+</section>
+<section><title>Layers Panel</title>
<para>
The panel on the left is called the <emphasis role="bold">layers panel</emphasis>.
It determines which layers and sublayers (such as tracks and waypoints)
drag and drop, or by selecting a layer and using the up and down
buttons at the bottom of the layers panel.
</para>
+</section>
+<section><title>Viewport</title>
<para>
-The main Viking area where the layers are draw is called the <emphasis role="bold">viewport</emphasis>.
+The main &appname; area where the layer data is drawn, is called the <emphasis role="bold">viewport</emphasis>.
</para>
+</section>
+<section><title>Statusbar</title>
+<para>This provides a readout of various information:</para>
+<itemizedlist>
+<listitem><para>The currently selected (mouse pointer) tool</para></listitem>
+<listitem><para>The number of items to process in the background - normally this the number in the map tile download queue</para></listitem>
+<listitem><para>The zoom factor</para></listitem>
+<listitem><para>The location of the mouse pointer (and potentially height information if DEM data is available)</para></listitem>
+</itemizedlist>
+</section>
+<section><title>Projections</title>
+<para>
+&appname; supports differents projections:
+<itemizedlist>
+<listitem>
+<para>UTM</para>
+</listitem>
+<listitem>
+<para>LatLon (also called EPSG:4326)</para>
+</listitem>
+<listitem>
+<para>Mercator (also called Spherical Mercator)</para>
+</listitem>
+</itemizedlist>
+</para>
</section>
+</section>
+
<section><title>Layers</title>
+
<section><title>TrackWaypoint Layer</title>
<para>
TrackWaypoint layers display GPS data (tracks and waypoints).
</para>
-<para>An easy way to create new waypoints is to copy a
+<para>One way to create new waypoints is to copy a
latitude/longitude coordinate pair, such as the one shown on most
-geocaches, and paste it into an active TrackWaypoint layer. Viking can
-automatically recognize several variations of the lat/lon format. </para>
+geocaches, and paste it into an active TrackWaypoint layer. &appname; can
+automatically recognize several variations of the lat/lon format.
+</para>
<para>
By right-clicking tracks and waypoints in the layers panel, you can do
many things with tracks and waypoints. You can easily find a specific
layers panel to show all tracks or waypoints, and typing the name of
the track/waypoint.
</para>
+
<section><title>Layer Operations</title>
<para>
The layer has a context menu with several operations.
</para>
-<section><title>Export</title>
+
+<section><title>View Layer</title>
<para>
-The layer can be exported to a file GPX, GPSPoint or GPSMapper format.
+Version1.1+: This will automatically move the viewport and select the best zoom level to see the whole layer (i.e. tracks and waypoints).
</para>
+</section>
+
+<section><title>View All Tracks</title>
<para>
-<emphasis>Note: only the entire layer can be exported, it is currently
-(SVN:897, v0.9.7) not possible to export an individual track. IMO an
-oversight.</emphasis>
+Version1.1+: This will automatically move the viewport and select the best zoom level to see the all the tracks in the layer (ignoring positions of any waypoints).
</para>
+</section>
+<section><title>View All Waypoints</title>
+<para>
+Version1.1+: This will automatically move the viewport and select the best zoom level to see the all the waypoints in the layer (ignoring positions of any tracks).
+</para>
</section>
+<section><title>Goto Center of Layer</title>
+<para>
+This will automatically move the viewport to see the whole layer (i.e. tracks and waypoints). It does not adjust the zoom level.
+</para>
</section>
+
+<section><title>Goto Waypoint</title>
+<para>
+This opens a dialog box to enter a name of waypoint to search for. If it is found the viewport is centred on it.
+</para>
+<note>
+<para>
+Note this search is not very clever and only finds exact matches.
+You are probably better off expanding the waypoint list and directly start typing, as mentioned above, which finds a match based on each letter typed.
+</para>
+</note>
+</section>
+
+<section><title>Export Layer</title>
+<para>
+The layer (all tracks and waypoints) can be exported to a file GPX, GPSPoint or GPSMapper format.
+</para>
+<para>
+Version1.1+: An individual track can be exported to a GPX file via the track menu.
+</para>
+</section>
+
+<section><title>New Waypoint</title>
+<para>
+This opens a dialog box to create a new waypoint. A default name will be suggested and the default position is the center of the viewport.
+</para>
+</section>
+
+<section><title>Add Wikipedia Waypoints</title>
+<para>
+This gets 'interesting' points from Wikipedia for the specified view: either within the extent of layer bounds or within the current viewport boundary.
+</para>
+</section>
+
+<section id="osm_upload"><title>Upload To OSM</title>
+<para>
+This opens a dialog to upload all tracks and waypoints to OSM traces.
+Useful if you are an OSM contributor (you will need an OSM account), these details can be stored in &appname; preferences.
+</para>
+<para>
+ &appname; allows you to edit a track, e.g. remove duplicate points, perhaps remove track points leading to your home and then upload it to OSM.
+</para>
+<note>
+<para>
+ <emphasis role="bold">Warning!</emphasis>
+The password is transferred <emphasis role="bold">unencrypted</emphasis> in every request sent to the OSM server. This is due to OSM's basic authentication method.
+</para>
+</note>
+</section>
+
+<section><title>Filter</title>
+<section><title>Simplify All Tracks</title>
+<para>
+This opens dialog to request the number of points each track will be simplified using <application>GPSBabel</application>. The result is put into a new layer. The simplification method removes points considered to be in a 'near straight line', thus reducing the number of points and attempting to keep the most important turning points.
+</para>
+</section>
+<section><title>Remove Duplicate Waypoints</title>
+<para>
+Remove Duplicate Waypoints - fairly self explainatory, with the results created in a new layer.
+</para>
+<note>
+<para>
+However it only considers a precise position (waypoints only 1 metre away from each other are considered different) and also doesn't consider if the waypoints have different comments, symbols or images.
+</para>
+</note>
+</section>
+</section>
+
+<section id="filter_with_track"><title>Filter With <emphasis>Trackname</emphasis></title>
+<para>
+This runs <application>GPSBabel</application> on the layer using information from a previously selected track (select via the track menu "Use With Filter" option) with the following command types:
+</para>
+<itemizedlist>
+<listitem><para>Waypoints Inside This</para></listitem>
+<listitem><para>Waypoints Outside This</para></listitem>
+</itemizedlist>
+<para>
+The result is generated in a new Track/Waypoint layer.
+</para>
+</section>
+
+</section><!-- End TRW Layer Options -->
+
<section><title>Track Properties</title>
<para>
Show many useful statistics about a track, including a
<para>
The following colors are used in the elevation-distance graph:
</para>
-<itemizedlist mark="opencircle"><listitem>
-<para>
-Brown profile: elevation data in graph
-</para>
-</listitem>
+<variablelist>
+<varlistentry>
+<term>'Main' colour - this is dependent on your Desktop theme - often blue by default</term>
+<listitem><para>elevation data in graph</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>Yellow</term>
<listitem>
-<para>
-Yellow: no elevation data
-</para>
+<para>no elevation data</para>
</listitem>
+</varlistentry>
+<varlistentry>
+<term>Green</term>
<listitem>
-<para>
-Green: elevation data from DEM
-</para>
+<para>elevation data from DEM</para>
</listitem>
+</varlistentry>
+<varlistentry>
+<term>Red</term>
<listitem>
-<para>
-Red: speed
-</para>
+<para>speed</para>
</listitem>
-</itemizedlist>
+</varlistentry>
+</variablelist>
</section>
<section><title>Track Operations</title>
<section><title>Merge by time</title>
-<para>This operation repeatedly tries to merge the right-clicked track
+<para>
+This operation repeatedly tries to merge the right-clicked track
with tracks in the same TrackWaypoint layer. The tracks which are
merged are those which have at least one trackpoint less than some
threshold time away. This way, if you somehow end up with lots of small
segments (say, caused by turning the GPS on and off) you can merge them
-easily into one track. </para>
+easily into one track.
+</para>
</section>
<section><title>Split by time</title>
This operation will split a single track into segments wherever the
time interval between successive trackpoints is larger than some
threshold. This is useful when processing raw NMEA GPS data, especially
-taken over a long time. </para>
+taken over a long time.
+</para>
</section>
<section><title>Apply DEM data</title>
</section>
<section><title>Upload to OSM</title>
<para>
-Useful if you are an OpenStreetMap.org (OSM) contributor. Viking
-allowing you to import a track, edit it if you so wish to remove
+Useful if you are an OSM contributor. &appname;
+allows you to import a track, edit it if you so wish to remove
duplicate points, perhaps track points leading to your home, and then
-directly export the track to OSM
+directly export the track to OSM.
</para>
</section>
<section><title>View Google Directions</title>
-<para>Launch a web browser to see the Google directions page which
-yielded the route. Note: the record of the Google route is stored in
+<para>
+Launch a web browser to see the Google directions page which
+yielded the route.
+</para>
+<note>
+<para>
+The record of the Google route is stored in
the track's comment, so if the comment is changed (or the route was
created by something other than the Magic Scissors tool) this will not
work correctly.
</para>
+</note>
</section>
</section>
-</section>
-<section><title>GPSLayer</title>
-<para>GPSLayer is responsible for uploading and downloading GPS data
+</section><!-- TRW Layer END -->
+
+<section><title>GPS Layer</title>
+<para>
+The GPS layer is responsible for uploading and downloading GPS data
from a GPS device. It also is responsible for realtime GPS tracking.
-Expand the GPSLayer in the layers panel to see the two TRWLayers it
+Expand the GP SLayer in the layers panel to see the two TRWLayers it
uses for uploading and downloading. To upload, download, or use
-realtime tracking, right-click the GPSLayer and click the appropiate
+realtime tracking, right-click the GPS layer and click the appropiate
menu item.
</para>
+
<section><title>Download</title>
<para>
-To download data from the GPS, right-click the GPSLayer and click Download from GPS.
+To download data from the GPS, right-click the GPS layer and click <guimenuitem>Download from GPS</guimenuitem>.
</para>
</section>
<section><title>Upload</title>
-<para>To upload data to the GPS, first populate the GPS Upload child
+<para>
+To upload data to the GPS, first populate the GPS Upload child
layer of the GPS layer (either by creating waypoints/tracks in it, or
copying and pasting or dragging waypoints/tracks from another layer).
-Then right-click the GPSLayer and click Upload to GPS.
+Then right-click the GPS layer and click <guimenuitem>Upload to GPS</guimenuitem>.
</para>
</section>
-<section><title>Realtime tracking</title>
-<para>You must set up gpsd correctly or use a GPSD server and put the
-correct information in the GPSLayer properties dialog. Then right-cilck
-the layer and select Start realtime tracking.
+<section><title>Realtime Tracking</title>
+<para>
+You must set up gpsd correctly or use a GPSD server and put the
+correct information in the GPS layer properties dialog. Then right-click
+the layer and select <guimenuitem>Start Realtime Tracking</guimenuitem>.
</para>
</section>
</section>
-<section><title>DEM Layer (todo)</title>
+<section><title>(Digital Elevation Model) DEM Layer (todo)</title>
<para>
-current NASA SRTM server: http://dds.cr.usgs.gov/srtm/version2_1/
+The current NASA SRTM server is: http://dds.cr.usgs.gov/srtm/version2_1/
</para>
</section>
</section>
<section><title>Ruler</title>
-<para>Used to measure bearing distance between two point:Click on first
-point,click on second point - after few seconds the bearing distance
-between points will be displayed.
+<para>
+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.
+A second click will 'freeze' the ruler at that point.
</para>
</section>
You must have a TrackWaypoint Layer selected to use these.
</para>
<section><title>New Waypoint</title>
-
+<para></para>
</section>
<section><title>New Track</title>
<para>
Click/drag: select/move a waypoint
</para>
<para>
-Ctrl: snap to trackpoint
+<keycap>Ctrl</keycap>: snap to trackpoint
</para>
<para>
Shift: snap to waypoint
</section>
<section><title>Show Picture</title>
<para>
-Uses eog to open a picture shown as a picture waypoint.
+Uses <application>eog</application> to open a picture shown as a picture waypoint.
</para>
</section>
</para>
<section><title>Georef zoom</title>
<para>Changes the zoom level of the georeferenced map and changes the
-Viking zoom level accordingly. Useful if you are trying to match GPS
+&appname; zoom level accordingly. Useful if you are trying to match GPS
data to a georeferenced map.
</para>
</section>
-<section><title>External tools</title>
+<section><title>Webtools</title>
<para>
Many services are available only via a web browser (Google Maps, OpenStreetMap Potlach editor, etc.).
</para>
Jumping from &app; to such service can become annoying.
</para>
<para>
-Viking allows you to open such service directly at the position currently viewed in &app;.
+&appname; allows you to open such service directly at the position currently viewed in &app;.
</para>
<para>
-This feature is called <guilabel>External tools</guilabel>.
+This feature is called <guilabel>Webtools</guilabel>. It is also known as External Tools.
</para>
</section>
+</section>
+<!-- Preferences -->
+<section><title>Preferences</title>
+<section><title>Localisation</title>
+<para>You can select units displayed by &appname; to best fit your usage.</para>
+<figure>
+<title>Properties dialog: units part</title>
+<screenshot>
+ <graphic format="PNG" fileref="figures/properties_units.png"/>
+</screenshot>
+</figure>
+<para>Concerning degrees, you can select the way to display them:
+<variablelist>
+<varlistentry>
+<term>DDD</term><listitem><para>decimal degree</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>DDD</term><listitem><para>partial sexagesimal display: degrees, minutes and décimal part of minutes</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>DMS</term><listitem><para>sexagesimal display: degrees, minutes and seconds</para></listitem>
+</varlistentry>
+</variablelist>
+</para>
+<figure>
+<title>Properties dialog: degree display options</title>
+<screenshot>
+ <graphic format="PNG" fileref="figures/properties_degree.png"/>
+</screenshot>
+</figure>
+</section>
+<section><title>Tile's age</title>
+<para>This age is used to decided wether or not a new request to tile server must be done.
+</para>
+<para>Changing this value, you will increase or decrese the network load.</para>
+</section>
+<section><title>Default maplayer directory</title>
+<para>This property sets the default directory of the tiles cache.
+This value is used when you create a new map layer.
+</para>
+<para>You are still able to change this value in each map layer properties.</para>
+</section>
</section>
<section><title>Mini-Howto's</title>
<section><title>Getting Started</title>
<para>
-To quickly get started using Viking, follow these instructions.
+To quickly get started using &appname;, follow these instructions.
</para>
<section><title>Go to an area of interest</title>
<para>
-Viking's default location is a 0 latitude and longitude, so you need to pick a place that interests you.
-</para>
-<para>
-<emphasis role="bold">Method A</emphasis>
+&appname;'s default location is a Manhatten, New York, USA, so you may need to pick another place that interests you.
+</para>
+<procedure>
+<title>Method A</title>
+<step>
+<para>
+Use View - Go to to move to a coordinate of interest.
+</para>
+</step>
+</procedure>
+<procedure>
+<title>Method B</title>
+<step>
+<para>Use the GPS Layer or <menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From GPS</guimenuitem></menuchoice>
+to load data directly from your GPS into &appname;.
+Currently Garmin, Magellan, DeLorme and Navilink protocols are supported.
+</para>
+<note>
+<para>You must have write permission to the port used. For Unix like OS:</para>
+<para>/dev/ttyS0 is the first serial port</para>
+<para>/dev/ttyUSB0 is the first USB port</para>
+</note>
+<note><para>For DeLorme device support you will need GPSBabel v1.4.0+ installed</para></note>
+</step>
+</procedure>
+<procedure>
+<title>Method C</title>
+<step>
+<para>Get data from files in GPX format. For other formats (kml,
+ozi...), use a converter such as GPSBabel to convert the files to GPX
+format first.
</para>
+</step>
+<step>
<para>
-1. Use View - Go to to move to a coordinate of interest.
+Open up &appname; and use File - Open or File - Append
+file to open the file.
</para>
+</step>
+<step>
<para>
-<emphasis role="bold">Method B</emphasis>
-</para>
-<para>1. Use GPS Layer or File - Acquire - From GPS to load data
-directly from your GPS into Viking. Currently Garmin and Magellan are
-supported. (NOTE: You must have write permission to the port used.
-/dev/ttyS0 is the first serial port)
+Expand Tracks or Waypoints. Right-click on the
+track or waypoint of interest and select <guimenuitem>Goto "Center"</guimenuitem>.
</para>
+</step>
+</procedure>
+<procedure>
+<title>Method D</title>
+<step>
<para>
-<emphasis role="bold">Method C</emphasis>
+Use File - Append File to add your track and waypoint data to
+&appname;. This has been tested with Geocaching.com's *.loc format,
+(others(?)).
</para>
-<para>1. Get data from files in GPX format. For other formats (kml,
-ozi...), use a converter such as GPSBabel to convert the files to GPX
-format first.2. Open up viking and use File - Open or File - Append
-file to open the file.3. Expand Tracks or Waypoints. Right-click on the
-track or waypoint of interest and select Goto. </para>
+</step>
+<step>
<para>
-<emphasis role="bold">Method D</emphasis>
+Expand Tracks or Waypoints. Right-click on the tack or
+point of interest and select <guimenuitem>Goto "Center"</guimenuitem>.
</para>
-<para>
-1. Use File - Append File to add your track and waypoint data to
-Viking. This has been tested with Geocaching.com's *.loc format,
-(others(?)).2. Expand Tracks or Waypoints. Right-click on the tack or
-point of interest and select Goto </para>
-
+</step>
+</procedure>
</section>
<section><title>Add a map layer</title>
<para>
1. Use Layers - New Map Layer, and choose a suitable cache directory
-where you would like to store your tracks and click OK. Zoom to a
+where you would like to store your tracks and click <guilabel>OK</guilabel>. Zoom to a
comfortable level (I suggest 4 mpp) by clicking the left and right
mouse buttons on the gray area where your tracks are. Now from the menu
choose Tools - Map Download, Click where you would like to download a
map. Regardless of what tool you are using, the middle mouse button
always pans. </para>
+<note>
<para>
-(NOTE: You MUST have an open internet connection when you are downloading maps. If not, viking will likely hang.)
+You need an open internet connection when you are downloading maps.
</para>
+</note>
<para>
1. You will notice the maps are being drawn on top of the tracks, which
is probably not what you want. Look at the Layers Panel to the left.
</section>
</section>
-<section><title>From 1st startup to gps track (including offline maps)</title>
-<section><title>Prerequistites</title>
+<section><title>From 1st startup to GPS track (including offline maps)</title>
<para>
-The following refers to the version 0.9.8 from the git repository
-(26.07.2009).In the source, check in vikdemlayer.c around line 66 to
-have the correct address for the SRTM3 database. For the version
-referenced above, you should change <programlisting>#define SRTM_HTTP_URI /srtm/version2/SRTM3/</programlisting>
-</para>
-<para>
-to<programlisting>#define SRTM_HTTP_URI /srtm/version2_1/SRTM3/</programlisting>
-</para>
-<para>
-For further information, see this <ulink url="https://sourceforge.net/tracker/?func=detail&amp;aid=2812856&amp;group_id=83870&amp;atid=570954"><citetitle>discussion</citetitle></ulink>.<programlisting></programlisting>
+The first you'll see is an empty map, because &appname; in its default configuration will download maps only on demand.
+Before fetching unneeded data, one can position to a location of interest, e.g. Stuttgart: <menuchoice><guimenu>View</guimenu><guimenuitem>Go to Location</guimenuitem></menuchoice>, enter 'Stuttgart'.
</para>
-</section>
-<section><title>Start in verbose debug mode</title>
-<para>
-In order to get some informations about not functioning modules, start viking in verbose debug mode:<programlisting>viking -dV</programlisting>
-</para>
-<para>
-The first you'll see is an empty map, because viking in its default
-configurations will download maps only on demand. Before fetching
-unneeded data, we position to a location of interest, e.g. Stuttgart:<programlisting>view goto location, enter 'Stuttgart'</programlisting>
-</para>
-
-</section>
<section><title>Fetching the maps</title>
<para>
-<emphasis role="bold">Map</emphasis><programlisting>layers new map layer</programlisting>
-</para>
-<para>
-in the layer properties dialogue choose e.g. OpenStreetMap (Mapnik).
-</para>
-<para>
-For the moment, we keep the default 'Maps Directory' (the directory in
-which the maps will be stored and can be used for offline usage).
-</para>
-<para>Check Autodownload maps and keep the zoom level as 'Use Viking
-Zoom Level' (note however, that these settings will play an important
-role in the pre-fetch for offline usage discussed later).
-</para>
+<emphasis role="bold">Map</emphasis>
+</para>
+<procedure>
+<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New Map Layer</guimenuitem></menuchoice></para></step>
+<step><para>in the layer properties dialogue choose e.g. <guilabel>OpenStreetMap (Mapnik)</guilabel>.</para></step>
+<step>
+<para>For the moment, we keep the default <guilabel>Maps Directory</guilabel> (the directory in
+which the maps will be stored and can be used for offline usage).</para>
+</step>
+<step>
+<para>Check <guilabel>Autodownload maps</guilabel> and keep the zoom level as <guilabel>Use Viking
+Zoom Level</guilabel>.</para>
+<note>
+<para>
+however, that these settings will play an important
+role in the pre-fetch for offline usage discussed later
+</para>
+</note>
+</step>
+</procedure>
<para>You'll see a map of Stuttgart. Using the mouse wheel, you can
zoom in and out. The maps for the choosen resoltion will be downloaded
automatically.
</para>
<para>
-<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>
+<emphasis role="bold">DEM Layer (Height Map)</emphasis>
</para>
+<procedure>
+<step><para>Zoom out to 512.</para></step>
+<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New DEM Layer</guimenuitem></menuchoice></para></step>
+<step><para>Keep the download source as is (SRTM Global 90m), hit <guilabel>OK</guilabel>.</para></step>
+</procedure>
+
<para>In the layer listing on the left, the DEM layer should reside
above the map layer. If this is not the case, highlight the DEM layer
-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>
+an shift it one up (using the arrow up button).
</para>
+<procedure>
+<step><para>highlight the DEM layer in the layer listing on the left</para></step>
+<step><para>in the toolbar, check DEM layer download/import (the last symbol)</para></step>
+<step><para>a left-click in the map window should then fetch the DEM data</para></step>
+</procedure>
<para>
-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>
+This might take some time.
</para>
<para>
Sometimes, a tile does not show up correctly (you might see only a
black frame in the map window) because it got corrupted during
-transfer. IN order to correct this, you can delete the corresponding
-datafile in the cache. <programlisting> right-click the DEM layer properties</programlisting>
+transfer. In order to correct this, you can delete the corresponding
+datafile in the cache. <programlisting> right-click the DEM layer properties</programlisting>
</para>
<para>
-The 'DEM Files' listing allows you to delete the specific tiles (alternatively do this from the command line).
+The <guilabel>DEM Files</guilabel> listing allows you to delete the specific tiles (alternatively do this from the command line).
</para>
<para>
-You can also alter the Min. and Max. elevation in this dialogue.<programlisting> </programlisting>
+You can also alter the Min. and Max. elevation in this dialogue.
</para>
</section>
-<section><title>GPS Track with height profile</title>
-<para>
-<programlisting>uncheck the DEM layer (the map show up again)</programlisting><programlisting>layers new trackwaypoint layer</programlisting>
-</para>
-<para>
-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>
-</para>
-<para>
-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>
-</para>
+<section><title>GPS Track with Height Profile</title>
+<procedure>
+<step><para>uncheck the DEM layer (the map show up again)</para></step>
+<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New TrackWaypoint Layer</guimenuitem></menuchoice></para></step>
+</procedure>
+<para>
+Ensure the new track layer is above the map layer.
+</para>
+<procedure>
+<step><para>expand trackwaypointlayer, select <guimenuitem>Tracks</guimenuitem></para></step>
+<step>
+<para>
+in the tools menu choose <guimenuitem>Begin Track</guimenuitem> which looks like this:
+<figure>
+<title>Begin Track Icon</title>
+<screenshot>
+ <graphic format="PNG" fileref="figures/begintr_18.png"/>
+</screenshot>
+</figure>
+</para></step>
+<step><para>leftclick in the map window, enter a name</para></step>
+<step><para>click several times to generate a track (a right-click removes the last point)</para></step>
+<step><para>expand tracks in the layer menu, your track should show up, select it</para></step>
+<step><para>right click your track, select <guimenuitem>Apply DEM data</guimenuitem></para></step>
+<step><para>right click your track again, select <guimenuitem>Properies</guimenuitem></para></step>
+<step><para>click the tab <guilabel>Elevation-distance</guilabel> - enjoy the plot</para></step>
+</procedure>
+<para>
+In order to save this setting for later usage
+</para>
+<procedure>
+<step><para>click <guilabel>OK</guilabel> in the <guilabel>Track Properties</guilabel> dialog</para></step>
+<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>
+</procedure>
</section>
<section><title>Usecase: offline data for holiday</title>
<para>
-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>
-</para>
-<para>
-Choose e.g. OpenStreetMap (mapnik).
-</para>
-<para>
-adapt the 'maps directory' e.g. to /home/user/.viking-map-holiday/.
-This allows you to delete the map stuff after holiday without purging
-the rest of your maps.
-</para>
-<para>
-check autodownload map
-</para>
-<para>
-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>
-</para>
-<para>In the viking version discussed here, the DEM data automatically
-are stored in /home/user/.viking-maps/. You can move the corresponding
-tiles into .viking-map-holiday/ if you like.
-</para>
-<para>
-<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>
-</para>
-<para>This may take some time and hd capacity.Lixus wrote a set of
+Suppose you want to have the map and DEM data offline for your holiday in Italy near Bologna.
+</para>
+<procedure>
+<step><para>Start a new &appname; session.</para></step>
+<step><para><menuchoice><guimenu>View</guimenu><guimenuitem>Go to Location</guimenuitem></menuchoice>, enter Bologna</para></step>
+<step><para><menuchoice><guimenu>Layers</guimenu><guimenuitem>New Map Layer</guimenuitem></menuchoice></para></step>
+<step><para>Choose e.g. <guilabel>OpenStreetMap (mapnik)</guilabel>.</para></step>
+<step><para>adapt the <guilabel>maps directory</guilabel> e.g. to <filename>/home/user/.viking-map-holiday/</filename>.
+This allows you to delete the map stuff after holiday without purging the rest of your maps.
+</para></step>
+<step><para>check <guilabel>autodownload map</guilabel></para></step>
+<step><para>keep <guilabel>viking zoom level</guilabel></para></step>
+<step><para>zoom out to 1024</para></step>
+<step><para>add a DEM layer (as discussed above)</para></step>
+<step><para>download the DEM data</para></step>
+</procedure>
+<para>In the &app; version discussed here, the DEM data automatically
+are stored in <filename>/home/user/.viking-maps/</filename>. You can move the corresponding
+tiles into <filename>.viking-map-holiday/</filename> if you like.
+</para>
+<para>
+<emphasis role="bold">Download map data for all zoom levels</emphasis>
+</para>
+<procedure>
+<step><para>uncheck the DEM layer for the map to show up</para></step>
+<step><para>navigate the map to be centered at Bologna</para></step>
+<step><para>choose the zoom such, that all regions of interest are displayed in the map window (e.g. 1024)</para></step>
+<step>
+<para>follow this sequence until you have all tiles for all zoom levels you need</para>
+<substeps>
+<step><para>right-click the map layer properties</para></step>
+<step><para>set the zoomlevel explicitely one below the last (in the first cycle 512), hit OK</para></step>
+<step><para>right click the map layer <guimenuitem>Download Missing Onscreen Maps</guimenuitem></para></step>
+<step><para>wait until all tiles for that resolution have been downloaded</para></step>
+</substeps>
+</step>
+</procedure>
+<para>This may take some time and hd capacity. Lixus wrote a set of
scripts which allow to download the map tiles for several zoom-level in
-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.
+parallel from the command line.
</para>
<para>
Do not forget to save your configuration (as discussed above).
</section>
<section><title>Uploading data to OpenStreetMap</title>
<para>
-It is possible to upload data directly from Viking to OpenStreetMap.
-</para>
-<para>
-<emphasis role="bold">Upload a layer</emphasis>
+It is possible to upload data directly from &appname; to OpenStreetMap.
</para>
+<formalpara>
+<title>Upload a layer</title>
<para>
One solution is to upload whole a TrackWaypoint layer. To do this,
-simply select the layer and right click on it. Then, select Upload to
-OSM.
-</para>
-<para>
-<emphasis role="bold">Upload a single track</emphasis>
+simply select the layer and right click on it. Then, select <guimenuitem>Upload to
+OSM</guimenuitem>.
</para>
+</formalpara>
+<formalpara>
+<title>Upload a single track</title>
<para>One solution is to upload whole a TrackWaypoint layer. To do
this, simply select the layer and right click on it. Then, select
-Upload to OSM.
-</para>
-<para>
-<emphasis role="bold">Fill in the form</emphasis>
-</para>
-<para>
-On both case, Viking will reclaim some informations.
+<guimenuitem>Upload to OSM</guimenuitem>.
</para>
+</formalpara>
+<formalpara>
+<title>Fill in the form</title>
<para>
+In both cases, &appname; will retain some information.
The email field is the email you used to subscribed into OSM.
-</para>
-<para>
The password field is the password you used with this account.
-</para>
-<para>
The filename is the name you want your upload has on the server. This information is displayed by the osm server.
-</para>
-<para>
The description is some descriptive information.
-</para>
-<para>
-The tags field is a white separated list of tag.
-</para>
+The tags field is a white separated list of tag.
+</para>
+</formalpara>
</section>
<section><title>Geocoded Photo</title>
</programlisting>
</para>
<para>You can find more examples in the documentation part of the distribution.</para>
- <formalpara>
+ <section>
<title>Map Source</title>
<para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename>.</para>
<para>An example of the file in the distribution <filename>doc/examples/maps.xml</filename>.</para>
- <para>Currently, there is a single object class available: VikSlippyMapSource. Such feature allows to declare any map's source working like OpenStreetMap.</para>
- <para>The related properties are:
+ <para>The VikSlippyMapSource allows to declare any map's source working like OpenStreetMap. It supports the following properties:
<variablelist>
<varlistentry>
<term>id</term>
</varlistentry>
</variablelist>
</para>
- </formalpara>
+ <para>The VikTmsMapSource allows to declare any TMS service. It supports the following properties:
+ <variablelist>
+ <varlistentry>
+ <term>id</term>
+ <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>label</term>
+ <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>hostname</term>
+ <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>url</term>
+ <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>
+ </varlistentry>
+ </variablelist>
+ </para>
+ <para>The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties:
+ <variablelist>
+ <varlistentry>
+ <term>id</term>
+ <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>label</term>
+ <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>hostname</term>
+ <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>url</term>
+ <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 4 "%s" fields for bounding box coordinates (eg. "/coord=%s,%s,%s,%s")</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
- <formalpara>
+ <section>
<title>Go-to search engines</title>
<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>
<para>An example of the file in the distribution <filename>doc/examples/goto_tools.xml</filename>.</para>
</variablelist>
</para>
<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>
- </formalpara>
+ </section>
- <formalpara>
- <title>External tools</title>
+ <section>
+ <title>Webtools</title>
<para>It is possible to add new external tools. The file is <filename>~/.viking/external_tools.xml</filename>.</para>
<para>An example of the file in the distribution <filename>doc/examples/external_tools.xml</filename>.</para>
<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>
</varlistentry>
</variablelist>
</para>
- </formalpara>
+ </section>
</section>
+<section><title>What to Do if &appname; Does Not Seem to Work</title>
+<para>
+In order to get some information about what &appname; is doing, start it in verbose debug mode via the command line:
+<programlisting>viking -dV</programlisting>
+</para>
+<para>
+For instance you can check the correct URLs &appname; is using in requesting remote data for DEMs or map tiles in the verbose debug output.
+E.g. Something like this for DEMs:
+<screen>
+** (viking:28778): DEBUG: curl_download_uri: uri=http://dds.cr.usgs.gov/srtm/version2_1/SRTM3/Eurasia/N48E008.hgt.zip
+* About to connect() to dds.cr.usgs.gov port 80 (#0)
+* Trying 152.61.128.95... * connected
+* Connected to dds.cr.usgs.gov (152.61.128.95) port 80 (#0)
+ GET /srtm/version2_1/SRTM3/Eurasia/N48E008.hgt.zip HTTP/1.1
+User-Agent: viking/0.9.8 libcurl/7.18.2 GnuTLS/2.4.2 zlib/1.2.3.3 libidn/1.8
+Host: dds.cr.usgs.gov
+Accept: */*
+ HTTP/1.1 200 OK
+ Date: Sun, 26 Jul 2009 18:13:38 GMT
+ Server: Apache
+ Last-Modified: Tue, 21 Jul 2009 19:57:35 GMT
+ ETag: eac3f8-1828f5-46f3caa76070a
+ Accept-Ranges: bytes
+ Content-Length: 1583349
+ Content-Type: application/zip
+
+* Connection #0 to host dds.cr.usgs.gov left intact
+* Closing connection #0
+** (viking:28778): DEBUG: dem_layer_add_file: /home/username/.viking-maps/srtm3-Eurasia/N48E008.hgt.zip
+</screen>
+Or for OSM Mapnik tile server:
+<screen>
+* About to connect() to tile.openstreetmap.org port 80 (#0)
+* Trying 193.63.75.28... * connected
+* Connected to tile.openstreetmap.org (193.63.75.28) port 80 (#0)
+ GET /13/4065/2748.png HTTP/1.1
+User-Agent: viking/0.9.96 libcurl/7.20.1 GnuTLS/2.8.6 zlib/1.2.3.4 libidn/1.18
+Host: tile.openstreetmap.org
+Accept: */*
+
+* HTTP 1.0, assume close after body
+ HTTP/1.0 200 OK
+ Date: Thu, 14 Oct 2010 22:18:42 GMT
+ Server: Apache/2.2.8 (Ubuntu)
+ ETag: "b66ff9d46474bab68262a3483428a232"
+** (viking:16704): DEBUG: curl_get_etag_func: ETAG found: "b66ff9d46474bab68262a3483428a232"
+ Content-Length: 17194
+ Cache-Control: max-age=94805
+ Expires: Sat, 16 Oct 2010 00:38:47 GMT
+ Content-Type: image/png
+ Age: 5153
+ X-Cache: HIT from konqi.openstreetmap.org
+ X-Cache-Lookup: HIT from konqi.openstreetmap.org:3128
+ Via: 1.1 konqi.openstreetmap.org:3128 (squid/2.7.STABLE7)
+ Connection: close
+
+* Closing connection #0
+* About to connect() to a.andy.sandbox.cloudmade.com port 80 (#0)
+* Trying 178.63.75.195... ** (viking:16704): DEBUG: curl_download_uri: uri=http://tile.openstreetmap.org/13/4065/2749.png
+* About to connect() to tile.openstreetmap.org port 80 (#0)
+* Trying 193.63.75.28... * connected
+* Connected to a.andy.sandbox.cloudmade.com (178.63.75.195) port 80 (#0)
+ GET /tiles/cycle/13/4065/2747.png HTTP/1.1
+User-Agent: viking/0.9.96 libcurl/7.20.1 GnuTLS/2.8.6 zlib/1.2.3.4 libidn/1.18
+Host: a.andy.sandbox.cloudmade.com
+Accept: */*
+
+* connected
+* Connected to tile.openstreetmap.org (193.63.75.28) port 80 (#0)
+ GET /13/4065/2749.png HTTP/1.1
+User-Agent: viking/0.9.96 libcurl/7.20.1 GnuTLS/2.8.6 zlib/1.2.3.4 libidn/1.18
+Host: tile.openstreetmap.org
+Accept: */*
+
+* HTTP 1.0, assume close after body
+ HTTP/1.0 200 OK
+ Date: Thu, 14 Oct 2010 23:44:35 GMT
+ Server: Apache/2.2.8 (Ubuntu)
+ ETag: "8e520ad47ce9c1b63430554886eb5fab"
+** (viking:16704): DEBUG: curl_get_etag_func: ETAG found: "8e520ad47ce9c1b63430554886eb5fab"
+ Content-Length: 18094
+ Cache-Control: max-age=87742
+ Expires: Sat, 16 Oct 2010 00:06:57 GMT
+ Content-Type: image/png
+ X-Cache: MISS from konqi.openstreetmap.org
+ X-Cache-Lookup: MISS from konqi.openstreetmap.org:3128
+ Via: 1.1 konqi.openstreetmap.org:3128 (squid/2.7.STABLE7)
+ Connection: close
+</screen>
+</para>
</section>
-</article>
+</section>
+</article>
projects / andy / viking.git / blobdiff