]> git.street.me.uk Git - andy/viking.git/blobdiff - help/C/viking.xml
Improve tile info dialog message to print out the filename even when cache file is...
[andy/viking.git] / help / C / viking.xml
index 73ad9755d7385460b05bd98c0389e173a9f91667..3101c77af42143ff2de4a0698bf657f6450bb814 100644 (file)
@@ -1,6 +1,6 @@
 <?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">
@@ -334,8 +334,17 @@ Other function keys control turn on/off visibility of various elements:
 </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>
 
@@ -902,6 +911,15 @@ The password is transferred <emphasis role="bold">unencrypted</emphasis> in ever
 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.
@@ -2139,12 +2157,18 @@ This feature is called <guilabel>Webtools</guilabel>. It is also known as Extern
 <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>
@@ -2766,7 +2790,7 @@ Accept: */*
       <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:
@@ -2775,6 +2799,10 @@ Accept: */*
               <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>
@@ -2787,6 +2815,17 @@ Accept: */*
               <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>switch-xy (optional)</term>
               <listitem><para>Swap the X,Y values around in the URL parametrized ordering.</para></listitem>
@@ -3034,6 +3073,9 @@ Accept: */*
          <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>
@@ -3048,6 +3090,9 @@ Accept: */*
            <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>
@@ -3081,6 +3126,7 @@ Accept: */*
               <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>
@@ -3113,4 +3159,6 @@ Accept: */*
 </formalpara>
 </section>
 
+<xi:include href="attribution.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
 </article>