</section>
<section><title>General Concepts</title>
-<section id="gc_layers" xreftitle="Layers"><title>Layers</title>
+<section id="gc_layers" xreflabel="Layers"><title>Layers</title>
<para>
<emphasis>Layers</emphasis> is concept one may know from powerful graphics editors such as <application>Photoshop</application> or <application>GIMP</application>.
Instead of putting all the data on the same level, it is stacked (i.e. layered) with different data over one another.
By controlling this value one can see data below it in the layer heirarchy for interesting effects.
</para>
</section>
-<section id="gc_layers_panel" xreftitle="Layers Panel"><title>Layers Panel</title>
+<section id="gc_layers_panel" xreflabel="Layers Panel"><title>Layers Panel</title>
<para>
The panel on the left is called the <emphasis role="bold">layers panel</emphasis>.
It determines which layers and sublayers (such as tracks and waypoints)
</para>
</note>
<para>
-By default &appname; opens a default blank window centered on the home location.
+By default &appname; opens a default blank window centered on the home location. This behaviour can be changed by the <xref linkend="prefs_startup"/>.
Each window contains menus, a toolbar, a viewport, layers panel and a statusbar.
Each section (apart from the viewport) can be hidden using the <xref linkend="shortcut_keys"/> or from the
<menuchoice><guimenu>View</guimenu><guisubmenu>Show</guisubmenu></menuchoice> choices.
</para>
</section>
+<section>
+<title>From Routing</title>
+<para>
+<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From Directions</guimenuitem></menuchoice>
+</para>
+<para>
+This gets a route from given directions.
+</para>
+</section>
+
</section> <!-- End Acquire -->
<section><title>Print</title>
<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 -->
<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>
<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>
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>
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>
<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><title>Split at Trackpoint</title>
<para>
-Splits the track at the currently selected trackpoint. This is only enabled when a trackpoint is selected.
+Splits the track at the currently selected trackpoint.
</para>
+<note>
+<para>
+This is only enabled when a trackpoint is selected.
+</para>
+</note>
</section>
</section>
<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>
<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>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>
</section>
</section>
-<section id="map_tool_dl" xreftitle="Map Download"><title>Map Download</title>
+<section id="map_tool_dl" xreflabel="Map Download"><title>Map Download</title>
<para>
You must have a <xref linkend="Maps"/> Layer selected to use this.
</para>
</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>
<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>
</section>
</section>
+<section id="prefs_startup" xreflabel="Startup Preferences"><title>Startup</title>
+<para>Naturally since these preferences effect the startup, the values will not be used until &appname; is restarted.</para>
+<section><title>Restore Window Setup</title>
+<para>When this is enabled, the main window size and layout (such as whether the statusbar or layers panel are shown) is restored to the values from last use.</para>
+</section>
+<section><title>Default Map Layer</title>
+<para>When this is enabled, a map layer is automatically added whenever &appname; is opened and a &appname; file is not to be loaded.</para>
+<para>The map layer used is defined by the map layer's default values.</para>
+</section>
+<section><title>Startup Method</title>
+<para>Enables selection of how the startup position should be determined.</para>
+<itemizedlist>
+<listitem><para>Home Location (default) - Position as set by the <guilabel>Set the Default Location</guilabel></para></listitem>
+<listitem><para>Last Location - Uses the last position viewed on the viewport</para></listitem>
+<listitem><para>Specified File - Load the file as specified below</para></listitem>
+<listitem><para>Auto Location - Use the web service <ulink url="http://www.hostip.info">hostip.info</ulink> to attempt to determine your location via IP lookup</para></listitem>
+</itemizedlist>
+</section>
+<section><title>Startup File</title>
+<para>Loads this specified file when the Startup method is set to <guilabel>Specified File</guilabel></para>
+</section>
+<section><title>Check For New Version</title>
+<para>Periodically (no more than once every 14 days), check to see if there is a new version of &appname; available.</para>
+</section>
+</section>
+
</section>
<!-- HOWTOS-->
<section><title>Howto's</title>
<section id="howto_start"><title>Getting Started</title>
<para>
-To quickly get started using &appname;, follow these instructions.
+&appname; from version 1.5 has several features to ease the start up process.
+On the very first run, you will be asked if you want to enable these features which make use of an Internet connection.
+If you select no or you have upgraded from an earlier version you can choose to enable any of the startup options via the <xref linkend="prefs_startup"/>.
+</para>
+<para>
+Some other general use cases for using &appname;, are as follows:
</para>
<section><title>Go to an area of interest</title>
<para>
</varlistentry>
<varlistentry>
<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. "&start=%s,%s")</para></listitem>
+ <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. "&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. "&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. "&start=%s")</para>
+ <para>(Optional)</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>url-stop-dir</term>
+ <listitem><para>the part of the URL setting the end point location for direction based routing, parametrized in the spirit of C printf format, with one "%s" for direction (eg. "&start=%s")</para>
+ <para>(Optional)</para></listitem>
</varlistentry>
<varlistentry>
<term>referer</term>
<listitem>
<para>This value is passed on for the -i parameter in interfacing with GPSBabel.</para>
<para>If it is not defined then the returned file is interpreted internally as a GPX file.</para>
- <para>Possible values such as 'kml', 'mapsource' etc.. can be used. See <ulink ref="http://www.gpsbabel.org/capabilities.html">GPSBabel File Formats</ulink> for the full list.</para>
+ <para>Possible values such as 'kml', 'mapsource' etc.. can be used. See <ulink url="http://www.gpsbabel.org/capabilities.html">GPSBabel File Formats</ulink> for the full list.</para>
</listitem>
</varlistentry>
</variablelist>
<para>version_check_period_days=14</para>
</listitem>
<listitem>
- <para>trackwaypoint_alphabetized=true</para>
+ <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=KATDN</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>
+ </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>
projects / andy / viking.git / blobdiff