]> git.street.me.uk Git - andy/viking.git/blobdiff - help/C/viking.xml
Enable JPG files as a primary supported type.
[andy/viking.git] / help / C / viking.xml
index 9870f8ef4824c6c76e9405043de73facbdc23174..a0597a6735417685b158eddf0c553bc19ae7bc02 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>
@@ -557,6 +558,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 +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.
@@ -880,6 +897,18 @@ See <link linkend="geotagging">Geotagging</link> for further detail.
 </para>
 </section>
 
+<section><title>List Tracks or Routes</title>
+<para>
+Opens a new dialog with the list. As described in the Aggregrate layer <xref linkend="track_list"/>
+</para>
+</section>
+
+<section><title>List Waypoints</title>
+<para>
+Opens a new dialog with the list. As described in the Aggregrate layer <xref linkend="waypoint_list"/>
+</para>
+</section>
+
 </section><!-- End TRW Layer Options -->
 
 <section><title>Track and Route Sublayer Options</title>
@@ -890,17 +919,50 @@ See <link linkend="geotagging">Geotagging</link> for further detail.
 <listitem><para>View All Tracks or Routes. Same as the layer <link linkend="track_view_all">View All Tracks</link> or <link linkend="route_view_all">View All Routes</link></para></listitem>
 <listitem><para>Delete All Tracks or Routes. Same as the layer <link linkend="delete_all_tracks">Delete All Tracks</link> or <link linkend="delete_all_routes">Delete All Routes</link></para></listitem>
 <listitem><para>Delete Tracks or Routes from Selection. Same as the layer <link linkend="delete_selection_tracks">Delete Tracks from Selection</link> or <link linkend="delete_selection_routes">Delete Routes from Selection</link></para></listitem>
+<listitem><para>List Tracks or Routes. Opens a new dialog with the list. As described in the Aggregrate layer <xref linkend="track_list"/></para></listitem>
+</itemizedlist>
+<para>Also gives other options for handling multiple items:</para>
+<itemizedlist>
+<listitem><para>Sort. Gives the ability to sort the items in the treeview alphabetically</para></listitem>
+<listitem><para>Visibility. Offers options to quickly control the visibility of all items within the sublayer, as per <xref linkend="vis_options"/></para></listitem>
 </itemizedlist>
 </section>
 
-<section><title>Track and Route Properties</title>
+<section xreflabel="Track and Route Properties"><title>Track and Route Properties</title>
+<para>
+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>
-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.
+<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:
@@ -929,7 +991,7 @@ The following colors are used in the elevation-distance graph:
 </listitem>
 </varlistentry>
 </variablelist>
-
+</section>
 </section>
 
 <section><title>Track and Route Operations</title>
@@ -1100,7 +1162,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 :)
@@ -1134,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>
@@ -1149,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>
 
@@ -1250,6 +1312,7 @@ The record of the Google route is stored in the track's comment, so if the comme
 <listitem><para>Goto Waypoint. Same as the layer <link linkend="wp_goto">Goto Waypoint</link></para></listitem>
 <listitem><para>Delete All Waypoints. Same as the layer <link linkend="delete_all_waypoints">Delete All Waypoints</link></para></listitem>
 <listitem><para>Delete Waypoints from Selection. Same as the layer <link linkend="delete_selection_waypoints">Delete Waypoints from Selection</link></para></listitem>
+<listitem><para>List Waypoints. Opens a new dialog with the list. As described in the Aggregrate layer <xref linkend="waypoint_list"/></para></listitem>
 </itemizedlist>
 </section>
 
@@ -1273,6 +1336,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.
@@ -1295,10 +1372,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>
@@ -1492,9 +1569,11 @@ Here are some suggestions:
 Thus one can have a list of all your tracks, but groups can be shown or not using the relevant layers visibility checkbox.
 </para>
 
+<section><title>Layer Operations</title>
 <para>
-This layer only has one operation: <guilabel>New Layer</guilabel>
+The following are available on Aggregate Layers:
 </para>
+</section>
 
 <section><title>New Layer</title>
 <para>
@@ -1502,6 +1581,113 @@ Add a new layer of the selected type.
 </para>
 </section>
 
+<section id="sort_items" xreflabel="Sort"><title>Sort</title>
+<para>
+The list within the treeview can be sorted.
+</para>
+<para>
+Currently alphabetical (A to Z or Z to A) sorts are available, since only the name can be seen in the treeview.
+</para>
+</section>
+
+<section id="track_list" xreflabel="Track List"><title>Track List</title>
+<para>
+Selecting this opens a dialog listing all the tracks in a table along side statistics such as track length and maximum speed.
+Each column header is clickable and will reorder the list according to that particular column.
+</para>
+<para>
+This table may be invoked from a variety of different layer levels and will then list only the relevant tracks (and/or routes).
+<itemizedlist>
+<listitem><para>Aggregate Layer: Lists Tracks and Routes and the TrackWaypoint Layer they are in</para></listitem>
+<listitem><para>TrackWaypoint Layer: Lists Tracks and Routes</para></listitem>
+<listitem><para>TrackWaypoint Track sublayer: Lists Tracks only</para></listitem>
+<listitem><para>TrackWaypoint Route sublayer: Lists Routes only</para></listitem>
+</itemizedlist>
+</para>
+<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>
+</figure>
+</para>
+<para>
+Hovering the mouse over an entry will show a tooltip of the comment or description if it is available.
+</para>
+<para>
+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. Opens the Properties dialog on the <xref linkend="track_statistics"/> tab. Note this will close the track list dialog.</para></listitem>
+</itemizedlist>
+</para>
+</section>
+
+<section id="waypoint_list" xreflabel="Waypoint List"><title>Waypoint List</title>
+<para>
+Selecting this opens a dialog listing all the waypoints to give a overview of the waypoint information.
+Each column header is clickable and will reorder the list according to that particular column.
+</para>
+<para>
+This table may be invoked from a variety of different layer levels and will then list only the relevant waypoints.
+<itemizedlist>
+<listitem><para>Aggregate Layer: Lists Waypoints and the TrackWaypoint Layer they are in</para></listitem>
+<listitem><para>TrackWaypoint Layer: : Lists Waypoints</para></listitem>
+<listitem><para>TrackWaypoint Waypoint sublayer: Lists Waypoints</para></listitem>
+</itemizedlist>
+</para>
+<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>
+</figure>
+</para>
+<para>
+Hovering the mouse over an entry will show a tooltip of the description if it is available.
+</para>
+<para>
+Each entry in the 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>Properties. This will open the properties dialog. Note this will close the waypoint list dialog.</para></listitem>
+<listitem><para>Show Picture. If enabled, this will open the associated image in an external Image Viewer program.</para></listitem>
+</itemizedlist>
+</para>
+</section>
+
+<section id="vis_options" xreflabel="Visibility Options"><title>Visibility Options</title>
+<para>
+This offers a quick way to set all the visibilities of each item within the containing layer, rather than having to change each one individually.
+<itemizedlist>
+<listitem><para>Show All. Ensures all items are set to be visible.</para></listitem>
+<listitem><para>Hide All. Ensures all items are set to be invisible. This is useful for then turning on single items afterwards so the display is not cluttered.</para></listitem>
+<listitem><para>Toggle. Inverts the visibility status of each item.</para></listitem>
+</itemizedlist>
+</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>
@@ -1577,6 +1763,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>
@@ -1595,6 +1786,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>
@@ -1695,22 +1892,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>
@@ -2545,7 +2742,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>
@@ -2804,6 +3005,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>