<?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">
</para>
</listitem>
<listitem>
-<para>Preparing tracks, routes and waypoints for trips using maps from services such as OpenStreetMap (OSM) and/or Terrasever.
+<para>Preparing tracks, routes and waypoints for trips using maps from services such as OpenStreetMap (OSM).
The data is only needed to be uploaded to your GPS before you leave.
The maps together with your tracks, routes and waypoints can also be printed and used during the trip.
</para>
</listitem>
<listitem>
<para>
-Downloading and storing OpenStreetMap and/or Terraserver maps on your hard drive and looking at them later.
+Downloading and storing OpenStreetMap and/or other map types on your hard drive and looking at them later.
</para>
</listitem>
<listitem>
</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>
</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>
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.
<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>
<term>url</term>
<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></listitem>
+ <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>
<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>
projects / andy / viking.git / blobdiff