<?xml version="1.0"?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY appname "Viking">
<!ENTITY app "<application>Viking</application>">
<!ENTITY appversion "1.5">
</itemizedlist>
<para>
Standard shortcuts are provided for normal GUI operations: such as creating new files, opening, saving and exitting.
-Then there are shortcuts specific to &appname; to switch projection modes, zoom in/out, create layers and switch the active tool mode.
-For these combinations see the menu entry themselves.
+Then there are shortcuts specific to &appname; to switch projection modes, zoom in/out, create layers,switch the active tool mode and move the map:
+<itemizedlist>
+<listitem><para><keycap>Ctrl+Up</keycap> Pan the viewport North</para></listitem>
+<listitem><para><keycap>Ctrl+Right</keycap> Pan the viewport East</para></listitem>
+<listitem><para><keycap>Ctrl+Down</keycap> Pan the viewport South</para></listitem>
+<listitem><para><keycap>Ctrl+Left</keycap> Pan the viewport West</para></listitem>
+<listitem><para><keycap>Ctrl+Keypad+</keycap> Zoom In</para></listitem>
+<listitem><para><keycap>Ctrl+Keypad-</keycap> Zoom Out</para></listitem>
+<listitem><note><para>These work irrespective of the <xref linkend="tools"/> mode selected</para></note></listitem>
+</itemizedlist>
+For other combinations see the menu entry themselves.
</para>
</section>
<listitem><para>Viking</para></listitem>
<listitem><para>GPX</para></listitem>
<listitem><para>KML</para></listitem>
+<listitem><para>JPG</para></listitem>
</itemizedlist>
</para>
<para>
-GPX and KML files will be loaded into the existing &appname; view. A <emphasis>Viking</emphasis> file will be given a new window if the current window is already assigned.
+GPX, KML and JPG files will be loaded into the existing &appname; view. A <emphasis>Viking</emphasis> file will be given a new window if the current window is already assigned.
</para>
<tip>
<para>
Available on the <menuchoice><guimenu>File</guimenu><guisubmenu>Acquire</guisubmenu></menuchoice> menu and from the <xref linkend="TrackWaypoint"/> layer menu.
</para>
<para>
-If used from the <guimenu>File</guimenu> menu and a TrackWaypoint layer is not currently selected, these methods place the results in a new TrackWaypoint layer. When a TrackWaypoint layer is selected, then using the <menuchoice><guimenu>File</guimenu><guisubmenu>Acquire</guisubmenu></menuchoice> will put the results into the selected TrackWaypoint layer.
+If used from the <guimenu>File</guimenu> menu these methods place the results in a new TrackWaypoint layer.
</para>
<para>
If used from the <xref linkend="TrackWaypoint"/> layer menu these methods place the results in that TrackWaypoint layer.
</note>
</section>
+<section>
+<title>Import GeoJSON File</title>
+<para>
+<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>Import GeoJSON File</guimenuitem></menuchoice>
+</para>
+<para>
+This uses the program <ulink url="https://github.com/tyrasd/togpx">togpx</ulink> to load .geojson files.
+If the program is not detected on your system, then this option will not be available.
+See <ulink url="https://www.npmjs.org/package/togpx">here</ulink> for the installation method.
+</para>
+<para>
+The current version (1.4.4) of GPSBabel does not support the <ulink url="http://geojson.org/">GeoJSON</ulink> file format.
+</para>
+</section>
+
</section> <!-- End Acquire -->
<section><title>Print</title>
<section><title>Export Layer</title>
<para>
-The layer (all tracks, routes and waypoints) can be exported to a file GPX, GPSPoint, GPSMapper or Google's KML format.
+The layer (all tracks, routes and waypoints) can be exported to following file formats:
</para>
+<orderedlist>
+ <listitem>
+ <para>GPX</para>
+ </listitem>
+ <listitem>
+ <para>GPSPoint</para>
+ </listitem>
+ <listitem>
+ <para>GPSMapper</para>
+ </listitem>
+ <listitem>
+ <para>Google's KML</para>
+ </listitem>
+ <listitem>
+ <para>Any GPSBabel <ulink url="http://www.gpsbabel.org/capabilities.html">File Formats</ulink></para>
+ </listitem>
+ <listitem>
+ <para>GeoJSON. Via the program <ulink url="https://github.com/mapbox/togeojson">togeojson</ulink></para>
+ <para>This option will not be available if the program is not detected on your system.
+ See <ulink url="https://www.npmjs.org/package/togeojson">here</ulink> for the installation method.</para>
+ </listitem>
+</orderedlist>
<para>
Version1.1+: An individual track can be exported to a GPX file via the track menu.
</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>Compress Tracks</title>
+<para>
+Enables compression of tracks and routes via <application>GPSBabel</application>'s <emphasis>Crosstrack</emphasis> simplify method.
+It opens a dialog to request the Error factor value which is the maximum allowable error that may be introduced by removing a single point.
+It is expressed a distance in units as specified by the <xref linkend="prefs"/> distance option.
+Thus a higher value will remove more points.
+The result is put into a new layer.
+</para>
+</section>
<section><title>Remove Duplicate Waypoints</title>
<para>
Remove Duplicate Waypoints - fairly self explainatory, with the results created in a new layer.
Some maps are continually improving over time (e.g. OpenStreetMap) and so in order to not to have to (re)download the data all the time &appname; employs a timeout method - <emphasis>Tile Age</emphasis> to determine whether to access the server. However a forced refresh for the current view can be made via the <guilabel>Reload All Onscreen Maps</guilabel> option.
</para>
<para>
-Inbuilt maps include various <ulink url="http://en.wikipedia.org/wiki/TerraServer-USA">Terraserver</ulink> (Primarily USA coverage) and <ulink url="http://openstreetmap.org/">OpenStreetMap (OSM)</ulink> ones and more:
+Inbuilt maps include various <ulink url="http://openstreetmap.org/">OpenStreetMap (OSM)</ulink> ones and more:
</para>
<itemizedlist>
<listitem><para>Bing Bird's Eye (Aerial) Maps (&appname; Version1.2+)</para></listitem>
-<listitem><para>Terraserver Topos</para></listitem>
-<listitem><para>Terraserver Aerials</para></listitem>
-<listitem><para>Terraserver Urban Areas</para></listitem>
<listitem><para>OpenStreetMap (Mapquest) - This is the default (&appname; Version1.3+)</para></listitem>
<listitem><para>OpenStreetMap (Mapnik)</para></listitem>
<listitem><para>OpenStreetMap (Cycle)</para></listitem>
<listitem><para>OpenStreetMap (Transport) (&appname; Version1.3+)</para></listitem>
+<listitem><para>OpenStreetMap (Humanitarian) (&appname; Version1.5+)</para></listitem>
<listitem><para>NASA BlueMarble</para></listitem>
-<listitem><para>SpotMap (&appname; Version1.1+)</para></listitem>
</itemizedlist>
<para>
<para>
This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+P</keycap>
</para>
+<para>
+Double clicking the left mouse button will zoom the map in.
+<keycap>Shift</keycap> + double clicking the left mouse button will zoom the map out.
+Double clicking the right mouse button will also zoom the map out.
+</para>
</section>
<section><title>Zoom</title>
<para>
<keycap>Shift</keycap> (and hold) + left mouse button: Draws a bounding box area on which to zoom in. The zoom action is performed when the left mouse button is released.
</para>
+<para>
+<keycap>Shift</keycap> + left click button: Jump Zoom In by up to factor of 3 standard zooms.
+</para>
+<para>
+<keycap>Shift</keycap> + right click button: Jump Zoom Out by up to factor of 3 standard zooms.
+</para>
</section>
<section><title>Ruler</title>
<para>
One must finish the current route to be able to create another route.
</para>
+<para>
+One can switch between the <link linkend="route_create">Create Route</link> and <link linkend="route_finder">Route Finder</link> tools while editing routes.
+</para>
+</section>
+
+<section id="route_finder" xreflabel="Route Finder"><title>Create Route Using the Route Finder</title>
+<para>
+Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/route_finder_18.png"/></guiicon>
+</para>
+<para>
+Requires an internet connection.
+Left click to create a new trackpoint.
+If it's the initial trackpoint you will be asked to enter a name for the route, otherwise the default routing engine will be queried to find a route to the new trackpoint.
+Right click or <keycap>Backspace</keycap>: remove the last added route.
+</para>
+<para>
+<keycap>Escape</keycap>: to finish route creation.
+Finishing the track is also available via the right click <xref linkend="TrackWaypoint"/> and track menus.
+</para>
+<para>
+One must finish the current route to be able to create another route.
+</para>
+<para>
+One can switch between the <link linkend="route_create">Create Route</link> and <link linkend="route_finder">Route Finder</link> tools while editing routes.
+</para>
</section>
<section><title>Edit Waypoint</title>
</para>
</section>
-<section id="route_finder" xreflabel="Route Finder"><title>Route Finder</title>
-<para>
-Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/route_finder_18.png"/></guiicon>
-</para>
-<para>Creates a track using default routing engine between two points.
-Requires an internet connection. Click one point, then click another to
-create a track.
-</para>
-<para>
-Right-click: undo last routing (only track removed - not any waypoints)
-</para>
-<para>
-<keycap>Ctrl</keycap>: continue previous track
-</para>
-</section>
-
</section>
<section><title>Georef Map Layer Tools</title>
<para>You can set the <emphasis>Home</emphasis> location directly by inputting the latitude and longitude in decimal degrees.
</para>
</section>
+<section><title>Time Display</title>
+<para>This controls the reference timezone that times are shown in.</para>
+<para><emphasis>Locale</emphasis> is the current user's system preference. This was how all times were shown up to version 1.5.</para>
+<para><emphasis>World</emphasis> will attempt to determine the timezone at an object's position.</para>
+<para><emphasis>UTC</emphasis> enforces this standard timezone.</para>
+</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>
+<section><title>Default map layer 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 can find more examples in the documentation part of the distribution.</para>
<section>
<title>Map Source</title>
- <para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename> for <trademark>UNIX</trademark> like systems and <filename>C:\Documents and Settings\<replaceable>username</replaceable>\.viking\maps.xml</filename> on <trademark>Windows XP</trademark>.</para>
+ <para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename> for <trademark>UNIX</trademark> like systems, <filename>C:\Documents and Settings\<replaceable>username</replaceable>\.viking\maps.xml</filename> on <trademark>Windows XP</trademark> or <filename>C:\Users\<replaceable>username</replaceable>\.viking\maps.xml</filename> on <trademark>Windows 7</trademark> onwards.</para>
<para>An example of the file is in the distribution <filename>doc/examples/maps.xml</filename>. Further examples and values are online in the <ulink url="http://sourceforge.net/apps/mediawiki/viking/index.php?title=Maps">Maps Wiki</ulink></para>
<para>The <classname>VikSlippyMapSource</classname> allows to declare any map's source working like OpenStreetMap. It supports the following properties:
<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>name</term>
+ <listitem><para>a string (should be unique) that is used for the OSM style cache directory name when the Map Cache directory is the default (<filename>~/.viking-maps</filename>)</para></listitem>
+ </varlistentry>
<varlistentry>
<term>label</term>
<listitem><para>the text displayed in the map's source selection dialog</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>
+ <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for Z, X and Y (in that order) (eg. "/%d/%d/%d.png")</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-min (optional)</term>
+ <listitem><para>The minimum zoom value supported by the tile server. The Default is 0 if not specified.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-max (optional)</term>
+ <listitem>
+ <para>The maximum zoom value supported by the tile server. The Default is 18 if not specified.</para>
+ <para>See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>file-extension (optional)</term>
+ <listitem>
+ <para>The file extension of the files on disk. The default is <emphasis>.png</emphasis></para>
+ <para>If the tile source URL ends in something other than .png, then this parameter will need to match it.</para>
+ <para>This can also be useful in reading a tileset from other software which may name tiles in an alternative form,
+ e.g. for Mobile Atlas creator it names them <emphasis>.png.tile</emphasis></para>
+ <note><para>The file types actually usable are those supported by GDK Pixbuf Library, which includes at least PNG and JPEG.</para></note>
+ <note><para>Remember to include the beginning <emphasis>'.'</emphasis> when specifying this parameter.</para></note>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>switch-xy (optional)</term>
+ <listitem>
+ <para>Swap the X,Y values around in the URL parametrized ordering.</para>
+ <para>The default is false.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>check-file-server-time (optional)</term>
+ <listitem>
+ <para>Sends the timestamp of the tile to the server, so the server can decide whether it should send a new tile or not.</para>
+ <para>The default is false.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>use-etag (optional)</term>
+ <listitem>
+ <para>Use and compare the <ulink url="http://en.wikipedia.org/wiki/HTTP_ETag">ETag</ulink> value in determining whether to download a newer tile. The default is false.</para>
+ <para>The ETag value is stored in a separate file in the same directory as the tile to enable checking the value across multiple runs of the program.</para>
+ </listitem>
</varlistentry>
</variablelist>
</para>
- <para>The <classname>VikTmsMapSource</classname> allows to declare any TMS service. It supports the following properties:
+ <para>The <classname>VikTmsMapSource</classname> allows to declare any TMS service. It supports the following properties (as per VikSlippyMapSource above):
<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>
+ <varlistentry>
+ <term>check-file-server-time (optional)</term>
</varlistentry>
</variablelist>
</para>
- <para>The <classname>VikWmscMapSource</classname> allows to declare any WMS or WMS-C service. It supports the following properties:
+ <para>The <classname>VikWmscMapSource</classname> allows to declare any WMS or WMS-C service. It supports the following properties (as per VikSlippyMapSource above):
<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>
+ <varlistentry>
+ <term>check-file-server-time (optional)</term>
</varlistentry>
</variablelist>
</para>
<listitem>
<para>window_menubar=true</para>
</listitem>
+ <listitem>
+ <para>window_copy_centre_full_format=false</para>
+ </listitem>
<listitem>
<para>version_check_period_days=14</para>
</listitem>
<para>trkpt_selected_statusbar_format=KEATDN</para>
<para>This string is in the Message Format Code</para>
</listitem>
+ <listitem>
+ <para>utils_nearest_tz_factor=1.0</para>
+ </listitem>
+ <listitem>
+ <para>viewport_history_size=20</para>
+ </listitem>
+ <listitem>
+ <para>viewport_history_diff_dist=500</para>
+ <para>In metres.</para>
+ <para>
+ Go Back or Go Forward requests over this range from the last history location will move back to that position.
+ If within this range it will skip over this location and move on to the next saved history location.
+ </para>
+ </listitem>
</orderedlist>
<section>
<para>M = Time diff of a Trackpoint from the previous trackpoint</para>
<para>X = Number of satellites used in the trackpoint fix</para>
<para>D = Distance of the trackpoint from the start of a track (following along the track)</para>
+ <para>F = Distance of the trackpoint from the finish (end) of a track (following along the track)</para>
<para>P = Distance difference of the trackpoint from the previous trackpoint</para>
<para>N = Name of track to which the trackpoint belongs</para>
<para>E = Name of the trackpoint</para>
</formalpara>
</section>
+<xi:include href="attribution.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
</article>