]> git.street.me.uk Git - andy/viking.git/blobdiff - help/C/viking.xml
Convert some console warnings to get reported to the GUI in the statusbar.
[andy/viking.git] / help / C / viking.xml
index 9328c8c49fde6d523b29bc7ff616313c5288d158..41d1240de6dd46cb83ff71d524998ff11127d10a 100644 (file)
@@ -3,9 +3,9 @@
 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   <!ENTITY appname          "Viking">
   <!ENTITY app "<application>Viking</application>">
-  <!ENTITY appversion   "1.4">
-  <!ENTITY manrevision  "1.4">
-  <!ENTITY date "February 2013">
+  <!ENTITY appversion   "1.5">
+  <!ENTITY manrevision  "1.5">
+  <!ENTITY date "October 2013">
 ]>
 <!--
       (Do not remove this comment block.)
@@ -421,10 +421,11 @@ This opens a file chooser dialog to select one (or more) files of the supported
 <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>
@@ -754,7 +755,7 @@ You are probably better off expanding the waypoint list and directly start typin
 
 <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 a file GPX, GPSPoint, GPSMapper, Google's KML format or any other format supported by GPSbabel.
 </para>
 <para>
 Version1.1+: An individual track can be exported to a GPX file via the track menu.
@@ -1195,11 +1196,11 @@ If this is a Route then it will convert it to a Track.
 <para>
 If this is Track then convert it to a Route.
 </para>
-<para>
 <note>
+<para>
 Converting from a Track to a Route may involve a loss of information, in particular timestamp values (hence you are required to confirm this operation before it happens).
-</note>
 </para>
+</note>
 </section>
 <section>
 <title>Anonymize Times</title>
@@ -1210,11 +1211,11 @@ Timestamp information of a track can be shifted to be all offset from 1901-01-01
 Thus the timestamps themselves will no longer reveal exactly when a track was taken.
 However the relative difference between the timestamps is kept thus one is still able to calculate some properties such as speeds along the track.
 </para>
-<para>
 <note>
+<para>
 This is not available for routes, as they have no timestamps.
-</note>
 </para>
+</note>
 </section>
 </section>
 
@@ -1491,7 +1492,6 @@ Inbuilt maps include various <ulink url="http://en.wikipedia.org/wiki/TerraServe
 <listitem><para>OpenStreetMap (Cycle)</para></listitem>
 <listitem><para>OpenStreetMap (Transport) (&appname; Version1.3+)</para></listitem>
 <listitem><para>NASA BlueMarble</para></listitem>
-<listitem><para>SpotMap (&appname; Version1.1+)</para></listitem>
 </itemizedlist>
 
 <para>
@@ -1606,8 +1606,12 @@ This table may be invoked from a variety of different layer levels and will then
 <para>
 <figure>
 <title>Track List Dialog: Example</title>
+<blockquote>
+<para>
 This is showing all tracks and routes (although there are no actual routes here!) in multiple TrackWaypoint layers, that has been sorted by height.
 Note that routes will not have timestamps or speeds, but may have elevations and should have some distance!
+</para>
+</blockquote>
 <screenshot>
   <graphic format="PNG" fileref="figures/LayersTracksList.png"/>
 </screenshot>
@@ -1641,7 +1645,11 @@ This table may be invoked from a variety of different layer levels and will then
 <para>
 <figure>
 <title>Waypoint List Dialog: Example</title>
+<blockquote>
+<para>
 This was invoked on a TrackWaypoint layer and shows all waypoints from that single layer. It has been sorted by the symbols.
+</para>
+</blockquote>
 <screenshot>
   <graphic format="PNG" fileref="figures/WaypointsList.png"/>
 </screenshot>
@@ -1671,6 +1679,14 @@ This offers a quick way to set all the visibilities of each item within the cont
 </para>
 </section>
 
+<section id="search_date" xreflabel="Search by Date"><title>Search by Date</title>
+<para>
+This opens calendar dialog to select a date to search by within this Aggregate layer.
+The first item that is found on that date will be selected.
+Tracks are searched first in preference over waypoints.
+</para>
+</section>
+
 </section><!-- End Agg -->
 
 <section id="GeoRef" xreflabel="GeoRef"><title>GeoRef Layer</title>
@@ -1746,6 +1762,11 @@ This is the default tool.
 <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>
@@ -1764,6 +1785,12 @@ This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+Z</key
 <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>
@@ -1835,6 +1862,31 @@ This operates in exactly the same way as the <link linkend="track_create">Create
 <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>
@@ -1864,22 +1916,22 @@ If <keycap>Ctrl</keycap> is held at the same time, it will jump the new trackpoi
 <para>
 Editing options in the Trackpoint Edit dialog include:
 <itemizedlist>
-<listitem>Edit the trackpoint name</listitem>
-<listitem>Changing raw lat/long position and altitude</listitem>
-<listitem>Forward (go to the next trackpoint)</listitem>
-<listitem>Back (go to the previous trackpoint)</listitem>
-<listitem>Delete</listitem>
-<listitem>Insert. Inserts a point halfway to next trackpoint</listitem>
-<listitem>Split. <xref linkend="trkpt_split"/></listitem>
+<listitem><para>Edit the trackpoint name</para></listitem>
+<listitem><para>Changing raw lat/long position and altitude</para></listitem>
+<listitem><para>Forward (go to the next trackpoint)</para></listitem>
+<listitem><para>Back (go to the previous trackpoint)</para></listitem>
+<listitem><para>Delete</para></listitem>
+<listitem><para>Insert. Inserts a point halfway to next trackpoint</para></listitem>
+<listitem><para>Split. <xref linkend="trkpt_split"/></para></listitem>
 </itemizedlist>
 </para>
 <para>
 Several fields are read only for reference purposes, values are shown if the trackpoint has such information:
 <itemizedlist>
-<listitem>Time.</listitem>
-<listitem>Speed and course.</listitem>
-<listitem>'Between' values: Speed, Time Difference and Distance Difference. When moving between trackpoints (via the Back and Forward buttons) these values are calculated.</listitem>
-<listitem>GPS precision factors.</listitem>
+<listitem><para>Time.</para></listitem>
+<listitem><para>Speed and course.</para></listitem>
+<listitem><para>'Between' values: Speed, Time Difference and Distance Difference. When moving between trackpoints (via the Back and Forward buttons) these values are calculated.</para></listitem>
+<listitem><para>GPS precision factors.</para></listitem>
 </itemizedlist>
 </para>
 <para>
@@ -1905,22 +1957,6 @@ For Linux you can override this with the setting in the <xref linkend="prefs_ext
 </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>
@@ -2714,7 +2750,11 @@ Accept: */*
             </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>switch-xy (optional)</term>
+              <listitem><para>Swap the X,Y values around in the URL parametrized ordering.</para></listitem>
             </varlistentry>
           </variablelist>
         </para>
@@ -2973,6 +3013,17 @@ Accept: */*
            <para>trkpt_selected_statusbar_format=KEATDN</para>
            <para>This string is in the Message Format Code</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>