]> git.street.me.uk Git - andy/viking.git/blobdiff - help/C/viking.xml
[DOC] Update help with text and images for multi-layer TrackWaypoint lists and statis...
[andy/viking.git] / help / C / viking.xml
index b774f18e7993b666e8d64dbff80e90ff09fba416..e0a016aad63328070397892a2f88b67e0b65c27f 100644 (file)
@@ -600,9 +600,11 @@ For instance the largest successful image generated on my (RN) Debian system is
 <para>
 Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Generate Directory of Images</guisubmenu></menuchoice> menu only.
 </para>
+<note>
 <para>
 This is only available in UTM mode.
 </para>
+</note>
 </section>
 
 </section> <!-- End File Types -->
@@ -745,9 +747,13 @@ Version1.1+: An individual track can be exported to a GPX file via the track men
 
 <section id="finish_track"><title>Finish Track or Route</title>
 <para>
-This is only available when a track or route is being created by the <xref linkend="track_create"/> or <xref linkend="route_create"/> tools.
 Selecting this option ends the creation of that individual track or route.
 </para>
+<note>
+<para>
+This is only available when a track or route is being created by the <xref linkend="track_create"/> or <xref linkend="route_create"/> tools.
+</para>
+</note>
 </section>
 
 <section><title>New</title>
@@ -874,6 +880,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>
@@ -884,6 +902,12 @@ 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>
 
@@ -930,9 +954,13 @@ The following colors are used in the elevation-distance graph:
 
 <section><title>Finish Track</title>
 <para>
-This is only available when a track is being created by the <xref linkend="track_create"/> tool.
 Selecting this option ends the creation of the individual track.
 </para>
+<note>
+<para>
+This is only available when a track is being created by the <xref linkend="track_create"/> tool.
+</para>
+</note>
 </section>
 
 <section><title>Goto</title>
@@ -965,9 +993,11 @@ threshold time away. This way, if you somehow end up with lots of small
 segments (say, caused by turning the GPS on and off) you can merge them
 easily into one track.
 </para>
+<note>
 <para>
 This is not available on routes as they have no timestamps.
 </para>
+</note>
 </section>
 
 <section><title>Merge With Other Tracks</title>
@@ -998,9 +1028,11 @@ time interval between successive trackpoints is larger than some
 threshold. This is useful when processing raw NMEA GPS data, especially
 taken over a long time.
 </para>
+<note>
 <para>
 This is not available on routes as they have no timestamps.
 </para>
+</note>
 </section>
 
 <section><title>Split By Number of Points</title>
@@ -1014,19 +1046,60 @@ This can be useful with devices which may have limits on the number of points it
 <para>
 Splits track segments into new tracks.
 </para>
+<note>
 <para>
 This is not available on routes as they do not have route segments.
 </para>
+</note>
+</section>
+
+<section id='trkpt_split' xreflabel="Split at Trackpoint"><title>Split at Trackpoint</title>
+<para>
+Splits the track at the currently selected trackpoint.
+</para>
+<para>
+The current track will finish at this trackpoint.
+A new track will start from a copy of this trackpoint.
+</para>
+<note>
+<para>
+This is only enabled when a trackpoint is selected.
+</para>
+</note>
+</section>
 </section>
 
-<section><title>Split at Trackpoint</title>
+<section><title>Insert Points</title>
+<note>
 <para>
-Splits the track at the currently selected trackpoint. This is only enabled when a trackpoint is selected.
+These options are only enabled when a trackpoint is selected.
+</para>
+</note>
+<section><title>Insert Point Before Selected Point</title>
+<para>
+Inserts a track point halfway between the previous track point and the current track point.
+All track point properties are interpolated between the two points.
+</para>
+</section>
+<section><title>Insert Point After Selected Point</title>
+<para>
+Inserts a track point halfway between the current track point and the next track point.
+All track point properties are interpolated between the two points.
 </para>
 </section>
 </section>
 
 <section><title>Delete Points</title>
+<section><title>Delete Selected Point</title>
+<para>
+Deletes the currently selected track point.
+</para>
+<note>
+<para>
+This is only enabled when a trackpoint is selected.
+</para>
+</note>
+</section>
 <section><title>Delete Points With the Same Position</title>
 <para>
 Deletes subsequent points that have the same position (but have different timestamps).
@@ -1036,18 +1109,71 @@ Deletes subsequent points that have the same position (but have different timest
 <para>
 Deletes subsequent points that have the same time stamp (but may have different positions).
 </para>
+<note>
 <para>
 This is not available on routes as they have no timestamps.
 </para>
+</note>
 </section>
 
 </section>
 
+<section><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 :)
+</para>
 <section><title>Apply DEM data</title>
 <para>
 If any DEM data is loaded, this will apply the DEM data to give the track elevation data.
+Two ways of applying DEM data are offered:
+<orderedlist>
+<listitem><para>Keep. Retains the existing elevation data of trackpoints and only those missing an elevation value are set.</para></listitem>
+<listitem><para>Overwrite. Elevation data are set on all trackpoints even if they already elevation values.</para></listitem>
+</orderedlist>
+</para>
+</section>
+<section><title>Smooth Missing Elevation data</title>
+<para>
+In various locations across the world, there are missing DEM values (AKA DEM Holes) from the SRTM data.
+This is particularly noticeable in mountainous areas.
+Two ways of applying elevation data to trackpoints that do not have elevation values are offered:
+<orderedlist>
+<listitem><para>Interpolated. Missing elevation data is interpolated between the previous and next known values.</para></listitem>
+<listitem><para>Flat. Elevation data is filled in from the last previously known value.</para></listitem>
+</orderedlist>
+</para>
+</section>
+<section>
+<title>Convert to Track or Route</title>
+<para>
+If this is a Route then it will convert it to a Track.
+</para>
+<para>
+If this is Track then convert it to a Route.
+</para>
+<para>
+<note>
+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>
+</section>
+<section>
+<title>Anonymize Times</title>
+<para>
+Timestamp information of a track can be shifted to be all offset from 1901-01-01.
+</para>
+<para>
+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>
+This is not available for routes, as they have no timestamps.
+</note>
 </para>
 </section>
+</section>
 
 <section><title>Export Track as GPX</title>
 <para>
@@ -1087,9 +1213,35 @@ Same as the layer <link linkend="osm_upload">Upload to OSM</link> command, but o
 <para>
 This selects the track to be used in the <link linkend="filter_with_track">Filter With <emphasis>Trackname</emphasis></link> feature.
 </para>
+<note>
 <para>
 This is not available on routes.
 </para>
+</note>
+</section>
+
+<section><title>Edit Trackpoint</title>
+<para>
+This opens the Trackpoint edit dialog. See <xref linkend="Trackpoint_edit"/>.
+</para>
+<note>
+<para>
+This is only enabled when a trackpoint is selected.
+</para>
+</note>
+</section>
+
+<section><title>Refine Route...</title>
+<para>
+This function allows to request a Routing Engine in order to refine a given route.
+By "refining" we mean computing all real intermediates points between some given major points.
+This could be useful to compute a trip giving only the wished important steps.
+</para>
+<note>
+<para>
+This is only available on routes.
+</para>
+</note>
 </section>
 
 <section><title>View Google Directions</title>
@@ -1116,6 +1268,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>
 
@@ -1306,6 +1459,30 @@ This requests map tiles only if the maps are older than the Tile Age preference.
 Force a refresh of all visible map tiles.
 </para>
 </section>
+
+<section><title>Download Maps in Zoom Levels</title>
+<para>
+This opens a dialog to enable requesting the download of maps for the region in the viewport over a specified number of zoom levels.
+The download method type can be specified to help limit the number of requests.
+</para>
+<warning>
+<para>
+There are some inbuilt limits to prevent downloading large amounts of map tiles.
+</para>
+<para>
+Please respect the usage policy of the tile set provider.
+Such as <ulink url="http://wiki.openstreetmap.org/wiki/Tile_usage_policy"><citetitle>OSM Tile Usage Policy</citetitle></ulink>.
+</para>
+</warning>
+<para>
+<figure>
+<title>Maps Download Dialog: Example</title>
+<screenshot>
+  <graphic format="PNG" fileref="figures/Maps_download_region_dialog.png"/>
+</screenshot>
+</figure>
+</para>
+</section>
 </section>
 
 
@@ -1334,9 +1511,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>
@@ -1344,6 +1523,97 @@ 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>
+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!
+<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. Open the properties dialog on the 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>
+This was invoked on a TrackWaypoint layer and shows all waypoints from that single layer. It has been sorted by the symbols.
+<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><!-- End Agg -->
 
 <section id="GeoRef" xreflabel="GeoRef"><title>GeoRef Layer</title>
@@ -1533,10 +1803,39 @@ Left click near a trackpoint (in screen pixel terms) to bring up the Track Point
 Whilst the edit dialog is already open, left click again and drag enables moving of the trackpoint.
 If <keycap>Ctrl</keycap> is held at the same time, it will jump the new trackpoint position to a nearby existing trackpoint.
 </para>
+<section id="Trackpoint_edit" xreflabel="Edit Trackpoint Dialog"><title>Edit Trackpoint Dialog</title>
 <para>
-Options in the Track Point Edit dialog include: change position, go to next, go to previous, delete, insert (halfway to next trackpoint) and splitting the track.
+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>
+</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>
+</itemizedlist>
+</para>
+<para>
+<figure>
+<title>Trackpoint Edit Dialog: Example</title>
+<screenshot>
+  <graphic format="PNG" fileref="figures/Trackpoint_edit_dialog.png"/>
+</screenshot>
+</figure>
+One must have been going downhill here to get a reasonable speed by bicycle!
 </para>
 </section>
+</section>
 
 <section><title>Show Picture</title>
 <para>
@@ -1614,7 +1913,7 @@ The possible methods to redownload one or more tiles are:
 </para>
 <formalpara><title>Map Tile Information</title>
 <para>
-By right clicking on viewport you can see the tile properties of the that location for the current map layer and current zoom level.
+By right clicking on viewport and selecting <guimenu>Show Tile Information</guimenu> you can see the tile properties of this location for the current map layer and current zoom level.
 This includes the remote source URL for the tile and the cached version on the local filesystem with timestamp details.
 </para>
 </formalpara>
@@ -1639,6 +1938,21 @@ Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic filere
 <para>
 Click to download and import a DEM file.
 </para>
+<formalpara><title>DEM File Information</title>
+<para>
+By right clicking on viewport and selecting <guimenu>Show DEM File Infomation</guimenu> you can see the file properties of the DEM file for this location.
+This includes the remote source URL for the file and the cached version on the local filesystem with timestamp details.
+</para>
+</formalpara>
+<para>
+<figure>
+<title>DEM File Info Dialog: Example</title>
+<screenshot>
+  <graphic format="PNG" fileref="figures/DEM_file_info_dialog.png"/>
+</screenshot>
+</figure>
+This is for block 51N, 003W - covering Bristol in the UK.
+</para>
 </section>
 
 <section><title>Webtools</title>
@@ -2484,6 +2798,10 @@ Accept: */*
               <term>url-stop-ll</term>
               <listitem><para>the part of the URL setting the end point location, parametrized in the spirit of C printf format, with 2 "%s" for coordinates (eg. "&amp;stop=%s,%s")</para></listitem>
             </varlistentry>
+            <varlistentry>
+              <term>url-via-ll</term>
+              <listitem><para>the part of the URL setting via point location, parametrized in the spirit of C printf format, with 2 "%s" for coordinates (eg. "&amp;via=%s,%s")</para></listitem>
+            </varlistentry>
             <varlistentry>
               <term>url-start-dir</term>
               <listitem><para>the part of the URL setting the starting point location for direction based routing, parametrized in the spirit of C printf format, with one "%s" for direction (eg. "&amp;start=%s")</para>
@@ -2590,7 +2908,51 @@ Accept: */*
          <listitem>
            <para>trackwaypoint_start_end_distance_diff=100.0</para>
          </listitem>
+         <listitem>
+           <para>gps_statusbar_format=GSA</para>
+           <para>This string is in the Message Format Code</para>
+         </listitem>
+         <listitem>
+           <para>trkpt_selected_statusbar_format=KEATDN</para>
+           <para>This string is in the Message Format Code</para>
+         </listitem>
        </orderedlist>
+
+       <section>
+          <title>Message Format Code</title>
+         <para>Currently for ease of implementation the message format code is a string of characters.</para>
+          <para>Each character represents what should be inserted in relation to a Trackpoint.</para>
+         <para>One day it might evolve into something more user friendly with a frontend to control it, perhaps allowing arbitary text too. However for now at least some control is offered :)</para>
+         <para>
+          <variablelist>
+            <varlistentry>
+              <term>Character Code</term>
+              <listitem>
+              <para>G = Some text to display at the start of the message - <emphasis>GPSD</emphasis></para>
+              <para>K = Some text to display at the start of the message - <emphasis>Trkpt</emphasis></para>
+              <para>A = Altitude of a Trackpoint</para>
+              <para>S = Speed of a Trackpoint</para>
+              <para>C = Course of a Trackpoint</para>
+              <para>L = Location of a Trackpoint</para>
+              <para>T = Time of a Trackpoint</para>
+              <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>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>
+             </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>Output Notes</term>
+              <listitem>
+             <para>If the output has <emphasis>*</emphasis> after it, then the value has been calculated via interpolation (such as speed when the Trackpoint does not contain a speed value).</para>
+             <para>If the output has <emphasis>**</emphasis> after it, then difficulties were encountered in trying to work the value so probably a default of 0 will be shown.</para>
+             </listitem>
+            </varlistentry>
+          </variablelist>
+         </para>
+       </section>
       </section>
 
 </section>