[DOC] Update help with text and images for multi-layer TrackWaypoint lists and statis...

[andy/viking.git] / help / C / viking.xml

diff --git a/help/C/viking.xml b/help/C/viking.xml
index 9870f8ef4824c6c76e9405043de73facbdc23174..e0a016aad63328070397892a2f88b67e0b65c27f 100644 (file)
--- a/help/C/viking.xml
+++ b/help/C/viking.xml
@@ -880,6 +880,18 @@ See <link linkend="geotagging">Geotagging</link> for further detail.
 </para>
 </section>
 
 </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>
 </section><!-- End TRW Layer Options -->
 
 <section><title>Track and Route Sublayer Options</title>


@@ -890,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>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>
 
 </itemizedlist>
 </section>
 


@@ -1250,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>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>
 
 </itemizedlist>
 </section>
 


@@ -1492,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>
 
 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>
 <para>

-This layer only has one operation: <guilabel>New Layer</guilabel>
+The following are available on Aggregate Layers:

 </para>
 </para>

+</section>

 
 <section><title>New Layer</title>
 <para>
 
 <section><title>New Layer</title>
 <para>


@@ -1502,6 +1523,97 @@ Add a new layer of the selected type.
 </para>
 </section>
 
 </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>
 </section><!-- End Agg -->
 
 <section id="GeoRef" xreflabel="GeoRef"><title>GeoRef Layer</title>