]> git.street.me.uk Git - andy/viking.git/blobdiff - help/C/viking.xml
Enable double clicking as an optional way to control zooming in pan mode.
[andy/viking.git] / help / C / viking.xml
index e0a016aad63328070397892a2f88b67e0b65c27f..1baf61b12d6e80df546569d52260faabd4b506ff 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.)
@@ -557,6 +557,22 @@ This gets a route from given directions.
 </para>
 </section>
 
+<section>
+<title>From URL</title>
+<para>
+<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From URL</guimenuitem></menuchoice>
+</para>
+<para>
+This gets a file from the entered URL.
+File formats that can be opened are those supported by GPSBabel.
+</para>
+<note>
+<para>
+You need to select the type of the file that is going to be returned, since there is no automatic detection of the file kind.
+</para>
+</note>
+</section>
+
 </section> <!-- End Acquire -->
 
 <section><title>Print</title>
@@ -738,7 +754,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.
@@ -911,14 +927,41 @@ Opens a new dialog with the list. As described in the Aggregrate layer <xref lin
 </itemizedlist>
 </section>
 
-<section><title>Track and Route Properties</title>
+<section xreflabel="Track and Route Properties"><title>Track and Route Properties</title>
 <para>
-Show many useful statistics about a track or a route, including a
-elevation-distance graph and a speed-time graph (if data is available).
-You can click these graphs to jump to the point in the track. You can
-also reverse it, delete duplicates, and split a track from its
-component segments (discontinuous breaks in a track) into separate
-tracks.
+This shows several tabs for properties and useful statistics about a track or a route, including elevation-distance and speed-time graphs (if data is available).
+Moving the mouse pointer over the graph displays values related to that point along the track.
+You can click on these graphs to jump to the point in the track.
+You can reverse it, delete duplicates, split at marked position or split a track from its component segments (discontinuous breaks in a track) into separate tracks.
+</para>
+<section id='track_properties' xreflabel="Track and Route Properties"><title>Track and Route Properties Tab</title>
+<para>
+<figure>
+<title>Properties Tab: Example</title>
+<screenshot>
+  <graphic format="PNG" fileref="figures/Track_properties.png"/>
+</screenshot>
+</figure>
+</para>
+</section>
+<section id='track_statistics' xreflabel="Track and Route Statistics"><title>Track and Route Statistics Tab</title>
+<para>
+<figure>
+<title>Statistics Tab: Example</title>
+<screenshot>
+  <graphic format="PNG" fileref="figures/Track_statistics.png"/>
+</screenshot>
+</figure>
+</para>
+</section>
+<section id='track_elev_graphs' xreflabel="Track Elevation Graph"><title>Track Elevation Graph</title>
+<para>
+<figure>
+<title>Elevation Distance Tab: Example</title>
+<screenshot>
+  <graphic format="PNG" fileref="figures/Track_elevation_graph.png"/>
+</screenshot>
+</figure>
 </para>
 <para>
 The following colors are used in the elevation-distance graph:
@@ -947,7 +990,7 @@ The following colors are used in the elevation-distance graph:
 </listitem>
 </varlistentry>
 </variablelist>
-
+</section>
 </section>
 
 <section><title>Track and Route Operations</title>
@@ -1118,7 +1161,7 @@ This is not available on routes as they have no timestamps.
 
 </section>
 
-<section><title>Transform</title>
+<section id="transform" xreflabel="Transform"><title>Transform</title>
 <para>
 These options alter the data of trackpoints of a track but not add or remove trackpoints.
 And don't seem to fit any other category :)
@@ -1152,11 +1195,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>
@@ -1167,11 +1210,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>
 
@@ -1292,6 +1335,20 @@ This centers the viewport on the selected waypoint.
 </para>
 </section>
 
+<section><title>Geotag Images...</title>
+<para>
+This opens the <link linkend="geotagging">Geotag Dialog</link> to allow Geotagging multiple images to the position of this waypoint.
+In this circumstance creation of waypoint options are disabled and only the options related to writing the EXIF information are available.
+</para>
+</section>
+
+<section><title>Transform</title>
+<para>
+Offers a subset of the track <xref linkend="transform"/> utilities.
+Currently only setting the altitude from DEM data methods are available.
+</para>
+</section>
+
 <section><title>Visit Webpage</title>
 <para>
 If the waypoint's comment (or description) starts with <literal>http:</literal> then this option is available and allows launching a web browser to go to the webpage.
@@ -1314,10 +1371,10 @@ Same as the layer <link linkend="new_wp">New Waypoint</link>.
 
 <section id="geotagging" xreflabel="Geotagging"><title>Version1.3+: Geotag Images</title>
 <para>
-This dialog allows geotagging images (normally taken with a digital camera) via interpolation against a specific track or all tracks in the TrackWaypoint layer - depending on how it is invoked.
+This dialog allows geotagging images (normally taken with a digital camera) against a specific waypoint or via interpolation against a specific track or all tracks in the TrackWaypoint layer - depending on how it is invoked.
 </para>
 <para>
-Images need to have an EXIF DATE_TIME_ORIGINAL (nearly always set by a camera). This timestamp is then used to find the location when the image(s) was taken by searching through the track(s) to find the nearest time - interpolating between points if necessary to set the location.
+When geotagging against tracks, images need to have an EXIF DATE_TIME_ORIGINAL (nearly always set by a camera). This timestamp is then used to find the location when the image(s) was taken by searching through the track(s) to find the nearest time - interpolating between points if necessary to set the location.
 </para>
 <note>
 <para>
@@ -1549,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>
@@ -1563,7 +1624,7 @@ Hovering the mouse over an entry will show a tooltip of the comment or descripti
 Each entry in the track list can be selected and on mouse right click offers these options:
 <itemizedlist>
 <listitem><para>View. Move the viewport to the area of the item and highlight it.</para></listitem>
-<listitem><para>Statistics. Open the properties dialog on the Statistics tab. Note this will close the track list dialog.</para></listitem>
+<listitem><para>Statistics. Opens the Properties dialog on the <xref linkend="track_statistics"/> tab. Note this will close the track list dialog.</para></listitem>
 </itemizedlist>
 </para>
 </section>
@@ -1584,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>
@@ -1614,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>
@@ -1689,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>
@@ -1807,22 +1885,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>
@@ -2657,7 +2735,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>
@@ -2916,6 +2998,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>