</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>
-
'Layers' is concept one may know from powerful graphics editors such as <application>Photoshop</application> or <application>GIMP</application>.
+
<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.
This can be useful for analysis and general handling of various sets of data.
</para>
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)
In theory a route is path you are planning to follow and a track of where you have actually been. The GPX specification splits these into two separate catergories, although tracks contain everything route may have.
</para>
<para>
-Q. When planning a 'route' what difference does it make if it's a route or a track?
+Q. When planning a <emphasis>route</emphasis> what difference does it make if it's a route or a track?
</para>
<para>
A. One difference is in how a GPS device navigates following the route or track.
</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.
<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From Wikipedia Waypoints</guimenuitem></menuchoice>
</para>
<para>
-This gets 'interesting' points from Wikipedia for the specified view: either within the extent of layer bounds or within the current viewport boundary.
+This gets <emphasis>interesting</emphasis> points from Wikipedia for the specified view: either within the extent of layer bounds or within the current viewport boundary.
+</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>
<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>
</para>
<variablelist>
<varlistentry>
-<term>'Main' colour - this is dependent on your Desktop theme - often blue by default</term>
+<term><emphasis>Main</emphasis> colour - this is dependent on your Desktop theme - often blue by default</term>
<listitem><para>elevation data in graph</para></listitem>
</varlistentry>
<varlistentry>
<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><title>Visit Webpage</title>
<para>
-If the waypoint's comment (or description) starts with 'http:' then this option is available and allows launching a web browser to go to the webpage.
+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.
</para>
</section>
You will need an open internet connection when you are downloading maps, but once downloaded they are available from the hard disk cache. When map are avaliable from the disk cache it is much faster and can be used offline.
</para>
<para>
-Some maps are continually improving over time (e.g. OpenStreetMap) and so in order to not to have to (re)download the data all the time &appname; employs a timeout method - 'Tile Age' to determine whether to access the server. However a forced refresh for the current view can be made via the <guilabel>Reload All Onscreen Maps</guilabel> option.
+Some maps are continually improving over time (e.g. OpenStreetMap) and so in order to not to have to (re)download the data all the time &appname; employs a timeout method - <emphasis>Tile Age</emphasis> to determine whether to access the server. However a forced refresh for the current view can be made via the <guilabel>Reload All Onscreen Maps</guilabel> option.
</para>
<para>
Inbuilt maps include various <ulink url="http://en.wikipedia.org/wiki/TerraServer-USA">Terraserver</ulink> (Primarily USA coverage) and <ulink url="http://openstreetmap.org/">OpenStreetMap (OSM)</ulink> ones and more:
</para>
<para>
The ruler is used to measure the bearing and distance between two points: Click on first point and then move the mouse point around - the values will be continually updated.
-A second click will 'freeze' the ruler at that point.
+A second click will <emphasis>freeze</emphasis> the ruler at that point.
</para>
<para>
This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+U</keycap>
</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>An option exists to control the icon (symbol) size used for waypoints
</para>
</section>
-<section><title>'Home' Default Location: Latitude and Longitude</title>
-<para>You can set the 'Home' location directly by inputting the latitude and longitude in decimal degrees.
+<section><title><emphasis>Home</emphasis> Default Location: Latitude and Longitude</title>
+<para>You can set the <emphasis>Home</emphasis> location directly by inputting the latitude and longitude in decimal degrees.
</para>
</section>
<section><title>Tile's age</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>
<section><title>From 1st startup to GPS track (including offline maps)</title>
<para>
The first you'll see is an empty map, because &appname; in its default configuration will download maps only on demand.
-Before fetching unneeded data, one can position to a location of interest, e.g. Stuttgart: <menuchoice><guimenu>View</guimenu><guimenuitem>Go to Location</guimenuitem></menuchoice>, enter 'Stuttgart'.
+Before fetching unneeded data, one can position to a location of interest, e.g. Stuttgart: <menuchoice><guimenu>View</guimenu><guimenuitem>Go to Location</guimenuitem></menuchoice>, enter <userinput>Stuttgart</userinput>.
</para>
<section><title>Fetching the maps</title>
<para>
<guimenuitem>OSM traces...</guimenuitem>
</menuchoice>.
Each request can get up to 5,000 points.
-The dialog box allows setting which group of 5,000 points to get. These groups are known as 'Page Numbers' which start at 0.
+The dialog box allows setting which group of 5,000 points to get. These groups are known as <emphasis>Page Numbers</emphasis> which start at 0.
Increasing the page number parameter allows one to request the subsequent sets of point groups.
</para>
</formalpara>
<para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename> for <trademark>UNIX</trademark> like systems and <filename>C:\Documents and Settings\<replaceable>username</replaceable>\.viking\maps.xml</filename> on <trademark>Windows XP</trademark>.</para>
<para>An example of the file is in the distribution <filename>doc/examples/maps.xml</filename>. Further examples and values are online in the <ulink url="http://sourceforge.net/apps/mediawiki/viking/index.php?title=Maps">Maps Wiki</ulink></para>
- <para>The VikSlippyMapSource allows to declare any map's source working like OpenStreetMap. It supports the following properties:
+ <para>The <classname>VikSlippyMapSource</classname> allows to declare any map's source working like OpenStreetMap. It supports the following properties:
<variablelist>
<varlistentry>
<term>id</term>
</varlistentry>
</variablelist>
</para>
- <para>The VikTmsMapSource allows to declare any TMS service. It supports the following properties:
+ <para>The <classname>VikTmsMapSource</classname> allows to declare any TMS service. It supports the following properties:
<variablelist>
<varlistentry>
<term>id</term>
</varlistentry>
</variablelist>
</para>
- <para>The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties:
+ <para>The <classname>VikWmscMapSource</classname> allows to declare any WMS or WMS-C service. It supports the following properties:
<variablelist>
<varlistentry>
<term>id</term>
<title>Go-to search engines</title>
<para>It is possible to add new new search engines for the "Go-To" feature. The file is <filename>~/.viking/goto_tools.xml</filename>.</para>
<para>An example of the file in the distribution <filename>doc/examples/goto_tools.xml</filename>.</para>
- <para>Currently, there is a single object class available: VikGotoXmlTool. Such feature allows to declare any search engine using a XML format as result.</para>
+ <para>Currently, there is a single object class available: <classname>VikGotoXmlTool</classname>. Such feature allows to declare any search engine using a XML format as result.</para>
<para>The related properties are:
<variablelist>
<varlistentry>
<title>External tools</title>
<para>It is possible to add new external tools. The file is <filename>~/.viking/external_tools.xml</filename>.</para>
<para>An example of the file in the distribution <filename>doc/examples/external_tools.xml</filename>.</para>
- <para>The VikWebtoolCenter allows to declare any Webtool using a logic based on center coordinates and zoom level value.</para>
+ <para>The <classname>VikWebtoolCenter</classname> allows to declare any Webtool using a logic based on center coordinates and zoom level value.</para>
<para>The related properties are:
<variablelist>
<varlistentry>
</varlistentry>
</variablelist>
</para>
- <para>The VikWebtoolBounds allows to declare any Webtool using a logic based on bounds coordinates.</para>
+ <para>The <classname>VikWebtoolBounds</classname> allows to declare any Webtool using a logic based on bounds coordinates.</para>
<para>The related properties are:
<variablelist>
<varlistentry>
</para>
</section>
+ <section>
+ <title>Routing engine</title>
+ <para>It is possible to declare new routing engines. The file is <filename>~/.viking/routing.xml</filename>.</para>
+ <para>An example of the file in the distribution <filename>doc/examples/routing.xml</filename>.</para>
+ <para>The <classname>VikRoutingWebEngine</classname> allows to declare a routing engine available via HTTP.</para>
+ <para>The related properties are:
+ <variablelist>
+ <varlistentry>
+ <term>id</term>
+ <listitem><para>a string, should be unique as it used to identify the routing engine</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>label</term>
+ <listitem><para>the text displayed in the menu entry</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>url-base</term>
+ <listitem><para>the base URL of the web service (eg. "http://hostname/service?")</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>url-start-ll</term>
+ <listitem><para>the part of the URL setting the starting point location, parametrized in the spirit of C printf format, with 2 "%s" for coordinates (eg. "&start=%s,%s")</para></listitem>
+ </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. "&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>an URL to serve as referer for the HTTP request (eg. "http://hostname/")</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>follow-location</term>
+ <listitem><para>the max depth of recursive redirections</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
+
<section>
<title>Remote File Datasources</title>
<para>It is possible to add web references expected to return a file which can then be opened directly or converted via GPSBabel.</para>
<para>The file is <filename>~/.viking/datasources.xml</filename>.</para>
<para>An example of the file is in the source distribution <filename>doc/examples/datasources.xml</filename>.</para>
- <para>The VikWebtoolDatasource allows to declare any URL using logic based on coordinates.</para>
+ <para>The <classname>VikWebtoolDatasource</classname> allows to declare any URL using logic based on coordinates.</para>
<para>The related properties are:
<variablelist>
<varlistentry>
<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>The <envar>XDG_DATA_HOME</envar> environment variable is also used (if set) to look for these extension files.</para>
</section>
+
+ <section>
+ <title>Miscellaneous Settings</title>
+ <para>Various individual values are automatically saved between &app; sessions in the <filename>~/.viking/viking.ini</filename> file.</para>
+ <para>This file is not intended to be manually edited, but since it is a plain text file it can be changed if desired.</para>
+ <para>Some values in this file are <emphasis>read only</emphasis>, in the sense that there is no way to set it other than by manually entering in the keys and values (the key will not exist in the file otherwise). This allows some fine tuning of &app; behaviours, without resorting to recompiling the code. However is it not expected that these values should need to be changed for a normal user, hence no GUI options for these have been provided.</para>
+ <para>Here is the list of the <emphasis>read only</emphasis> keys and their default values.</para>
+ <orderedlist>
+ <listitem>
+ <para>maps_max_tiles=1000</para>
+ </listitem>
+ <listitem>
+ <para>maps_min_shrinkfactor=0.0312499</para>
+ </listitem>
+ <listitem>
+ <para>maps_max_shrinkfactor=8.0000001</para>
+ </listitem>
+ <listitem>
+ <para>maps_real_min_shrinkfactor=0.0039062499</para>
+ </listitem>
+ <listitem>
+ <para>background_max_threads=10</para>
+ </listitem>
+ <listitem>
+ <para>window_menubar=true</para>
+ </listitem>
+ <listitem>
+ <para>version_check_period_days=14</para>
+ </listitem>
+ <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=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>
<!-- End of Extending Viking -->
projects / andy / viking.git / blobdiff