<?xml version="1.0"?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY appname "Viking">
<!ENTITY app "<application>Viking</application>">
- <!ENTITY appversion "1.5">
- <!ENTITY manrevision "1.5">
- <!ENTITY date "October 2013">
+ <!ENTITY appversion "1.6.1">
+ <!ENTITY manrevision "1.6.1">
+ <!ENTITY date "November 2015">
]>
<!--
(Do not remove this comment block.)
</para>
</listitem>
<listitem>
-<para>Preparing tracks, routes and waypoints for trips using maps from services such as OpenStreetMap (OSM) and/or Terrasever.
+<para>Preparing tracks, routes and waypoints for trips using maps from services such as OpenStreetMap (OSM).
The data is only needed to be uploaded to your GPS before you leave.
The maps together with your tracks, routes and waypoints can also be printed and used during the trip.
</para>
</listitem>
<listitem>
<para>
-Making maps with coordinate lines.
+Making maps with using <ulink url="http://mapnik.org/">Mapnik</ulink>.
+Not on <trademark>Windows</trademark> at the moment.
</para>
</listitem>
<listitem>
</listitem>
<listitem>
<para>
-Downloading and storing OpenStreetMap and/or Terraserver maps on your hard drive and looking at them later.
+Downloading and storing OpenStreetMap and/or other map types on your hard drive and looking at them later.
</para>
</listitem>
<listitem>
</listitem>
<listitem>
<para>
-Import track, route and waypoint files of various types via <application>GPSBabel</application>
+Import
and export track, route and waypoint files of various types via <application>GPSBabel</application>
</para>
</listitem>
<listitem>
</figure>
</section>
-<section><title>Projections</title>
+<section id="toolbar" xreflabel="Toolbar"><title>Toolbar</title>
+<para>The toolbar is an area for buttons that perform common actions.</para>
+<para>Some actions are modal, so the appropriate layer needs selected before these toolbar buttons are enabled. See <xref linkend="tools"/> more detail.</para>
+<para>The display of the toolbar is influenced by the <xref linkend="prefs_toolbar"/></para>
+<para>Right clicking on the toolbar and selecting <menuchoice><guimenu>Customize</guimenu></menuchoice> allows jumping to the <xref linkend="prefs_toolbar_customize"/> directly.</para>
+</section>
+
+<section id="projection" xreflabel="Projection"><title>Projections</title>
<para>
&appname; supports differents projections:
<itemizedlist>
</para>
</section>
-<section><title>Map Cache</title>
+<section id="mapcache" xreflabel="Map Cache"><title>Map Cache</title>
<para>
&appname; stores downloaded map tiles to disk for a couple of reasons:
</para>
This can be useful if you contribute to OpenStreetMap and wish to see your modifications (of course give time for the server to have processed your changes - see <ulink url="http://help.openstreetmap.org/questions/102/i-have-made-edits-but-they-dont-show-up-on-the-map">I have made edits but they don't show up on the map</ulink>)
</para>
</note>
+
+<para>
+The layout of the cache on disk itself can be controlled via a per Map Layer property.
+<itemizedlist>
+<listitem><para>Viking - Legacy default in a private cache layout scheme</para></listitem>
+<listitem><para>OSM - Newer available default (1.6+)</para>
+<para>
+This is to increase the compatibility between &appname; and similar applications that cache tiles on disk so that the tiles can be shared.
+</para>
+</listitem>
+</itemizedlist>
+
+</para>
</section>
<section id="shortcut_keys" xreflabel="Shortcut Keys"><title>Shortcut Keys</title>
&appname; has several shortcut keys or key combinations for commands as listed in the main window along side the command.
</para>
<para>
-Some function keys follow standard GUI behaviour:
+By default some function keys follow standard GUI behaviour:
</para>
<itemizedlist>
<listitem><para><keycap>F1</keycap> Help (view this manual)</para></listitem>
</itemizedlist>
<para>
Standard shortcuts are provided for normal GUI operations: such as creating new files, opening, saving and exitting.
-Then there are shortcuts specific to &appname; to switch projection modes, zoom in/out, create layers and switch the active tool mode.
-For these combinations see the menu entry themselves.
+Then there are shortcuts specific to &appname; to switch projection modes, zoom in/out, create layers,switch the active tool mode and move the map:
+<itemizedlist>
+<listitem><para><keycap>Ctrl+Up</keycap> Pan the viewport North</para></listitem>
+<listitem><para><keycap>Ctrl+Right</keycap> Pan the viewport East</para></listitem>
+<listitem><para><keycap>Ctrl+Down</keycap> Pan the viewport South</para></listitem>
+<listitem><para><keycap>Ctrl+Left</keycap> Pan the viewport West</para></listitem>
+<listitem><para><keycap>Ctrl+Keypad+</keycap> Zoom In</para></listitem>
+<listitem><para><keycap>Ctrl+Keypad-</keycap> Zoom Out</para></listitem>
+</itemizedlist>
+<important><para>These work irrespective of the <xref linkend="tools"/> mode selected</para></important>
+For other combinations see the menu entry themselves.
+</para>
+</section>
+
+<section>
+<title>Keyboard Configuration</title>
+<para>Keyboard configuration is supported by the standard GTK+ way of changing shortcuts for menu entries.</para>
+<para>Hover over the menu option with the mouse pointer and press the keyboard shortcut you want to bind it to.</para>
+<para>To delete a keyboard assignment, press <keycap>Backspace</keycap> whilst over the menu entry.</para>
+<note>
+<para>
+ If the keyboard shortcut is already in use you will not receive any notification that new action replaces the old action.
+ This is probably why most distributions have this facility disabled by default.
+ Thus you will need to enable <emphasis>Editable menu accelerators</emphasis> for your system.
+ Check the Desktop Menu and Toolbar Control or other User Interface preferences for this setting.
+</para>
+</note>
+<note>
+<para>
+ For Windows systems this can be done by adding the line <emphasis>gtk-can-change-accels=1</emphasis> to <filename>%USERPROFILE%\.gtkrc-2.0</filename> (create the file if it does not exist).
</para>
+</note>
+<para>From &app; 1.6+ the keyboard configuration is automatically loaded and saved between sessions in the <xref linkend="config_keys"/></para>
</section>
<section><title>Tracks vs Routes</title>
</tip>
</section>
+<section><title>Open Recent File</title>
+<para>
+Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Open Recent File</guisubmenu></menuchoice> menu only.
+</para>
+<para>
+The most recently opened files are available for opening again.
+The number of files remembered is controlled by a value in the <xref linkend="prefs_advanced"/>.
+</para>
+<para>
+Note that files imported via the Acquire mechanism are not available in this list.
+</para>
+</section>
+
<section><title>Save</title>
<para>
Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Save</guisubmenu></menuchoice> menu and on the toolbar <guibutton>Save</guibutton>.
</para>
</section>
-<section><title>Append</title>
+<section><title>Append File</title>
<para>
-Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Append</guisubmenu></menuchoice> menu only.
+Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Append File...</guisubmenu></menuchoice> menu only.
</para>
<para>
Selecting a <emphasis>Viking</emphasis> file from this method will join the file contents to the current window (instead of creating a new one).
</para>
</section>
+<section><title>Properties</title>
+<para>
+Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Properties</guisubmenu></menuchoice> menu only.
+</para>
+<para>
+Displays some simple properties about the loaded Viking project file (if any), such as full filename including the path, the filesize and the date/time of the file.
+</para>
+</section>
+
+<section><title>Export All</title>
+<para>
+Located on the <menuchoice><guimenu>File</guimenu><guisubmenu>Export All</guisubmenu></menuchoice> menu only.
+Choose either the <menuchoice><guimenu>GPX</guimenu></menuchoice> or <menuchoice><guimenu>KML</guimenu></menuchoice> option.</para>
+<para>
+This allows converting every <xref linkend="TrackWaypoint"/> layer from the existing project into files of the type choosen.
+You will be prompted for a directory into which a new file for each layer will be saved.
+</para>
+<para>
+The KML option uses <application>GPSBabel</application> and so will not be available if <application>GPSBabel</application> can not be detected.
+</para>
+<para>
+Note that some data properties are not supported by the target export file type. Such as item visibility or track colours.
+</para>
+</section>
+
<section id="acquire" xreflabel="acquire"><title>Acquire</title>
<para>
Available on the <menuchoice><guimenu>File</guimenu><guisubmenu>Acquire</guisubmenu></menuchoice> menu and from the <xref linkend="TrackWaypoint"/> layer menu.
</para>
<para>
-If used from the <guimenu>File</guimenu> menu and a TrackWaypoint layer is not currently selected, these methods place the results in a new TrackWaypoint layer. When a TrackWaypoint layer is selected, then using the <menuchoice><guimenu>File</guimenu><guisubmenu>Acquire</guisubmenu></menuchoice> will put the results into the selected TrackWaypoint layer.
+If used from the <guimenu>File</guimenu> menu these methods place the results in a new TrackWaypoint layer.
</para>
<para>
If used from the <xref linkend="TrackWaypoint"/> layer menu these methods place the results in that TrackWaypoint layer.
</note>
</section>
+<section>
+<title>Import GeoJSON File</title>
+<para>
+<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>Import GeoJSON File</guimenuitem></menuchoice>
+</para>
+<para>
+This uses the program <ulink url="https://github.com/tyrasd/togpx">togpx</ulink> to load .geojson files.
+If the program is not detected on your system, then this option will not be available.
+See <ulink url="https://www.npmjs.org/package/togpx">here</ulink> for the installation method.
+</para>
+<para>
+The current version (1.4.4) of GPSBabel does not support the <ulink url="http://geojson.org/">GeoJSON</ulink> file format.
+</para>
+</section>
+
</section> <!-- End Acquire -->
<section><title>Print</title>
</note>
</section>
+<section><title>KMZ Map File Overview</title>
+<para>
+A <ulink url="https://developers.google.com/kml/documentation/kmzarchives">KMZ file</ulink> is a compressed version of a KML file and associated supporting files.
+</para>
+<para>
+A <ulink url="https://garminbasecamp.wikispaces.com/Custom+Maps">KMZ Map file</ulink> is a KMZ file with an image overlay often for use as a Custom Map on Garmin GPSr devices.
+</para>
+<para>
+&appname; only supports basic properties in KMZ Map files, primarily intended for use with Garmin GPSr devices although KMZ exports are known to be work with Google Earth.
+</para>
+</section>
+
+<section><title>Import KMZ Map File</title>
+<para>
+Located on the <menuchoice><guimenu>File</guimenu></menuchoice> menu only.
+</para>
+<para>
+Enables loading of a selected KMZ map file.
+This generates a new <xref linkend="GeoRef"/> map layer using the overlay image contained within the KMZ file.
+</para>
+</section>
+
+<section><title>Generate KMZ Map File</title>
+<para>
+Located on the <menuchoice><guimenu>File</guimenu></menuchoice> menu only.
+</para>
+<para>
+Enables exporting the current viewport as a KMZ map file.
+The area and zoom level covered by the KMZ map can be adjusted before saving.
+</para>
+<para>
+Note that Garmin GPSr devices have limits in using images if they are too large (e.g. over 3Mb big) in KMZ files.
+&appname; does not enforce any limits on the KMZ files it generates.
+</para>
+</section>
+
</section> <!-- End File Types -->
<section><title>Layers</title>
<listitem><para><xref linkend="Coordinate"/></para></listitem>
<listitem><para><xref linkend="Maps"/></para></listitem>
<listitem><para><xref linkend="GeoRef"/></para></listitem>
+<listitem><para><xref linkend="MapnikRendering"/></para></listitem>
</itemizedlist>
<para>
For each layer there are a few standard options:
<section><title>Export Layer</title>
<para>
-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.
+The layer (all tracks, routes and waypoints) can be exported to following file formats:
</para>
+<orderedlist>
+ <listitem>
+ <para>GPX</para>
+ </listitem>
+ <listitem>
+ <para>GPSPoint</para>
+ </listitem>
+ <listitem>
+ <para>GPSMapper</para>
+ </listitem>
+ <listitem>
+ <para>Google's KML</para>
+ </listitem>
+ <listitem>
+ <para>Any GPSBabel <ulink url="http://www.gpsbabel.org/capabilities.html">File Formats</ulink></para>
+ </listitem>
+ <listitem>
+ <para>GeoJSON. Via the program <ulink url="https://github.com/mapbox/togeojson">togeojson</ulink></para>
+ <para>This option will not be available if the program is not detected on your system.
+ See <ulink url="https://www.npmjs.org/package/togeojson">here</ulink> for the installation method.</para>
+ </listitem>
+</orderedlist>
<para>
Version1.1+: An individual track can be exported to a GPX file via the track menu.
</para>
This opens dialog to request the number of points each track will be simplified using <application>GPSBabel</application>. The result is put into a new layer. The simplification method removes points considered to be in a 'near straight line', thus reducing the number of points and attempting to keep the most important turning points.
</para>
</section>
+<section><title>Compress Tracks</title>
+<para>
+Enables compression of tracks and routes via <application>GPSBabel</application>'s <emphasis>Crosstrack</emphasis> simplify method.
+It opens a dialog to request the Error factor value which is the maximum allowable error that may be introduced by removing a single point.
+It is expressed a distance in units as specified by the <xref linkend="prefs"/> distance option.
+Thus a higher value will remove more points.
+The result is put into a new layer.
+</para>
+</section>
<section><title>Remove Duplicate Waypoints</title>
<para>
Remove Duplicate Waypoints - fairly self explainatory, with the results created in a new layer.
</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>Sort. Gives the ability to sort the items in the treeview alphabetically or by date.</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>
</para>
</note>
</section>
+<section>
+<title>Interpolate Times</title>
+<para>
+Trackpoint timestamps between the first and last points are calculated such that track is travelled at equal speed.
+This is mostly useful when tracks don't have timestamps and you wish to recreate your trip (e.g. you've forgotten to turn on your GPS or the batteries have run out)
+Thus edit the first and last trackpoints to set the approximate times of your trip and then use this to give approximate times along the track.
+When used on tracks with timestamps this will overwrite the existing timestamps.
+</para>
+<note>
+<para>
+This is not available for routes, as they have no timestamps.
+</para>
+</note>
+</section>
</section>
<section><title>Export Track as GPX</title>
<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>
+<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 or by date.</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>Waypoint Properties</title>
<section id="Maps" xreflabel="Maps"><title>Maps Layer</title>
<para>
-This layer provides a single map resource, you may have multiple map layers but only top one (if enabled) will be visible.
-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.
+This layer provides a single map resource, you may have multiple map layers but only top one (if enabled) will be visible (subject to the Alpha compositing property).
</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 - <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.
+Some maps are continually improving over time (e.g. OpenStreetMap) thus &appname; employs a caching mechanism to avoid redownloading data (see <xref linkend="mapcache"/>).
+However a forced refresh for the current view can be made via the <guilabel>Reload All Onscreen Maps</guilabel> option or <keycap>Ctrl+F5</keycap>.
</para>
+<formalpara><title>Online Map Tile Providers</title>
<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:
+You will need an open internet connection when you are downloading maps these following map types, 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.
+Inbuilt maps include various <ulink url="http://openstreetmap.org/">OpenStreetMap (OSM)</ulink> ones and more:
</para>
+</formalpara>
<itemizedlist>
-<listitem><para>Bing Bird's Eye (Aerial) Maps (&appname; Version1.2+)</para></listitem>
-<listitem><para>Terraserver Topos</para></listitem>
-<listitem><para>Terraserver Aerials</para></listitem>
-<listitem><para>Terraserver Urban Areas</para></listitem>
-<listitem><para>OpenStreetMap (Mapquest) - This is the default (&appname; Version1.3+)</para></listitem>
+<listitem><para>Bing Aerial Maps (&appname; Version1.2+)</para></listitem>
+<listitem><para>Mapbox Outdoors - This is the default (&appname; Version1.7+)</para></listitem>
<listitem><para>OpenStreetMap (Mapnik)</para></listitem>
<listitem><para>OpenStreetMap (Cycle)</para></listitem>
<listitem><para>OpenStreetMap (Transport) (&appname; Version1.3+)</para></listitem>
+<listitem><para>OpenStreetMap (Humanitarian) (&appname; Version1.5+)</para></listitem>
<listitem><para>NASA BlueMarble</para></listitem>
</itemizedlist>
<para>
-&appname; can be configured to handle additional maps. See <xref linkend="extend_viking"/> for further detail.
+&appname; can be configured to handle additional online map resources. See <xref linkend="extend_viking"/> for further detail.
+</para>
+
+<formalpara><title>Offline Map Tilesets</title>
+<para>
+Some map types supported are for on disk tile formats:
+</para>
+</formalpara>
+<itemizedlist>
+<listitem>
+ <para>On Disk OSM Tile Format</para>
+ <para>This is equivalent to any map set with <emphasis>OSM</emphasis> Cache Layput.</para>
+</listitem>
+<listitem><para><ulink url="https://github.com/mapbox/mbtiles-spec">MBTiles File</ulink></para></listitem>
+<listitem><para><ulink url="http://wiki.openstreetmap.org/wiki/Meta_tiles">OSM Metatiles</ulink></para></listitem>
+</itemizedlist>
+<para>
+Of course you need to have acquired or generated these tilesets yourself.
+</para>
+
+<section><title>Map Layer Properties</title>
+<para>
+Configurable properties:
</para>
+<itemizedlist>
+<listitem>
+ <para>Map Type. The kind of map this layer displays.</para>
+ <note><para>Map types are dependent on the current <xref linkend="projection"/> mode.</para></note>
+</listitem>
+<listitem><para>Maps Directory. Not applicable for MBTiles Map type since it is a single file.</para></listitem>
+<listitem><para>Cache Layout. Viking or OSM. See <xref linkend="mapcache"/>. Only applies to maps from online tile providers.</para></listitem>
+<listitem><para>Map File. Ony applicable for MBTiles Map type since it is a single file.</para></listitem>
+<listitem>
+ <para>Alpha. Control the Alpha value for transparency effect using a value between 0 and 255 with the default being 255 for a fully solid image.</para>
+ <para>Zero is fully transparent. A value of around 160 can be useful for blending views of multiple map layers (when applied to the upper most map layer).</para>
+</listitem>
+<listitem><para>Autodownload Maps. This can be useful to turn off when you are not online to avoid pointless download requests or may be keep a map in a 'historical' state.
+e.g. perhaps in case a current map rendering is broken.</para></listitem>
+<listitem><para>Autodownload Only Gets Missing Maps. Using this option avoids attempting to update already acquired tiles.
+This can be useful if you want to restrict the network usage, without having to resort to manual control. Only applies when <emphasis>Autodownload Maps</emphasis> is on.</para></listitem>
+<listitem><para>Zoom Level. Determines the method of displaying map tiles for the current zoom level.
+<emphasis>Viking Zoom Level</emphasis> uses the best matching level, otherwise setting a fixed value will always use map tiles of the specified value regardless of the actual zoom level.</para></listitem>
+</itemizedlist>
+</section><!-- Map Prop END -->
+
<section><title>Layer Operations</title>
<section><title>Download Missing Onscreen Maps</title>
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.
+Alphabetical and Date sorts are available.
+</para>
+<note>
+<para>
+Generally it is not useful to sort the Top most layer. Sort is mainly intended for Aggregate groups of TrackWaypoint layers.
</para>
+</note>
</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.
+You can also rearrange the columns via dragging the column header to the new location.
</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>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>
+<listitem><para>Copy Data. Copy the data fields as text.</para></listitem>
</itemizedlist>
</para>
+<para>
+If multiple entries are selected the only right click option is <emphasis>Copy Data</emphasis>.
+This copies the individual data fields as plain text separated by tab characters, ideal for pasting into other applications in particular spreadsheet programs.
+Note that the order of the fields copied is the default column ordering (irrespective to how they may have been rearranged).
+</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.
+You can also rearrange the columns via dragging the column header to the new location.
</para>
<para>
This table may be invoked from a variety of different layer levels and will then list only the relevant waypoints.
<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>
+<listitem><para>Copy Data. Copy the data fields as text.</para></listitem>
</itemizedlist>
</para>
+<para>
+If multiple entries are selected the only right click option is <emphasis>Copy Data</emphasis>.
+This copies the individual data fields as plain text separated by tab characters, ideal for pasting into other applications in particular spreadsheet programs.
+Note that the order of the fields copied is the default column ordering (irrespective to how they may have been rearranged).
+</para>
</section>
<section id="vis_options" xreflabel="Visibility Options"><title>Visibility Options</title>
</section><!-- End Agg -->
-<section id="GeoRef" xreflabel="GeoRef"><title>GeoRef Layer</title>
-<para>
-This layer allows one to use any image as a map. You will need to tell it how to align the map to a position in the world and the scale of map.
-</para>
-<section><title>Layer Operations</title>
-<section><title>Zoom to Fit Map</title>
-<para>
-Automatically set a zoom level to see the entire map coverage.
-</para>
-</section>
-
-<section><title>Goto Map Center</title>
-<para>
-Center the viewport on this map.
-</para>
-
-</section>
-<section><title>Export to World File</title>
-<para>
-Opens a file save dialog to save the scale and position information as a <ulink url="http://en.wikipedia.org/wiki/World_file">World File</ulink>.
-</para>
-</section>
-</section>
+<xi:include href="georef_layer.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section><!-- End GeoRef -->
+<xi:include href="mapnik_rendering_layer.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<section id="Coordinate" xreflabel="Coordinate"><title>Coordinate Layer</title>
<para>
</section>
-<section><title>Georef Map Layer Tools</title>
+<section id="georef_tools"><title>Georef Map Layer Tools</title>
<para>
You must have a <xref linkend="GeoRef"/> Map Layer selected to use these tools.
</para>
<para>You can set the <emphasis>Home</emphasis> location directly by inputting the latitude and longitude in decimal degrees.
</para>
</section>
+<section><title>Time Display</title>
+<para>This controls the reference timezone that times are shown in.</para>
+<para><emphasis>Locale</emphasis> is the current user's system preference. This was how all times were shown up to version 1.5.</para>
+<para><emphasis>World</emphasis> will attempt to determine the timezone at an object's position.</para>
+<para><emphasis>UTC</emphasis> enforces this standard timezone.</para>
+</section>
<section><title>Tile's age</title>
<para>This age is used to decided wether or not a new request to tile server must be done.
</para>
<para>Changing this value, you will increase or decrese the network load.</para>
</section>
-<section><title>Default maplayer directory</title>
+<section><title>Default map layer directory</title>
<para>This property sets the default directory of the tiles cache.
This value is used when you create a new map layer.
</para>
<section><title>KML Export Units</title>
<para>Allows setting the units used when saved as the KML file type, such as Metric or Statue units</para>
</section>
+<section><title>GPX Track Order</title>
+<para>
+ Other software may display tracks in a particular order (often the order saved into the file).
+ This allows you to control the order they are saved when exporting to a GPX file.
+</para>
+</section>
+<section><title>GPX Waypoint Symbols</title>
+<para>Some GPS devices require waypoint symbols to be in a particular case.</para>
+<para>E.g. On a Garmin Oregon 450 they must be in <emphasis>Title Case</emphasis> to be recognized.</para>
+</section>
<section><title>Image Viewer (Not Windows)</title>
<para>Allows setting the program used to view images associated with Waypoints.</para>
<para>By default this is set to <application>xdg-open</application> which should open the system's default image viewer, however this can be overridden with this setting.</para>
<listitem><para>Some other user defined program</para></listitem>
</itemizedlist>
</section>
+<section><title>GPSBabel</title>
+<para>This allows setting the specific location of GPSBabel.</para>
+<para>&appname; will need to be restarted for this setting to take effect.</para>
+</section>
+<section><title>Auto Read World Files</title>
+<para>If this is on, when a new image is selected for the GeoRef layer then the associated world file will be read to find the scale and positional properties.</para>
+<para>The associated file is based on filename patterns; e.g. if the image is <filename>filename.jpg</filename> - then the world file may be <filename>filename.jpgw</filename> or <filename>filename.jgw</filename></para>
+</section>
+</section>
+
+<section id="prefs_advanced" xreflabel="Advanced Preferences"><title>Advanced</title>
+<section><title>Save File Reference Mode</title>
+<para>
+ Files referenced within project files can be saved with either absolute or relative paths.
+ Using relative paths can be useful when copying the project file and the associated files between different systems.
+</para>
+</section>
+<section><title>Ask for Name before Track Creation</title>
+<para>A setting to control whether an automatic name is used when creating a new track or route, or whether you are asked to enter a name.</para>
+</section>
+<section><title>Show Tooltip during Track Creation</title>
+<para>A setting to control whether the tooltip with the cumulative track or route distance is shown when creating tracks and routes.</para>
+</section>
+<section><title>The number of recent files</title>
+<para>
+ The number of recent files shown in the <menuchoice><guimenu>File</guimenu><guisubmenu>Open Recent File</guisubmenu></menuchoice> menu.
+ A value of -1 means all files. The new value applies to New Windows only (or on application restart).
+</para>
+</section>
</section>
<section id="prefs_osm" xreflabel="OpenStreetMap Traces Preferences"><title>OpenStreetMap Traces</title>
</section>
</section>
+<section id="prefs_mapnik" xreflabel="Mapnik Preferences"><title>Mapnik</title>
+<note>
+<para>If any changes to these settings are made, you will need to restart &appname; to make them be applied.
+</para>
+</note>
+<section><title>Plugins Directory</title>
+<para>The location of Mapnik plugins. An attempt is made to automatically determine the initial value,
+ however if this is wrong or Mapnik is upgraded then the directory can be set here.</para>
+</section>
+<section><title>Fonts Directory</title>
+<para>
+The location of fonts for use with Mapnik. Normally it is best to simply use the System's font directory.
+</para>
+</section>
+<section><title>Recurse Fonts Directory</title>
+<para>Load fonts in any sub-directories of the main font directory.</para>
+</section>
+<section><title>Rerender Timeout</title>
+<para>The time in hours before any tile is rerendered.</para>
+<para>This is useful in case the underlying source data for the tiles changes (e.g. OSM data is continually evovling).
+ &appname; normally has no way of knowing when the data has changed, so this simple timeout method is provided to maintain consistency of the tile images.</para>
+</section>
+<section><title>CartoCSS</title>
+<para>This allows setting the specific location of the <emphasis>carto</emphasis> executable.</para>
+</section>
+<section><title>Threads</title>
+<para>
+ The number of threads to use for Mapnik rendering tasks.
+ By default the value is set to the 1 in case of any multi-threading rendering code chain crashes.
+ Otherwise trying setting the value to the number of the CPUs of the system minus one (so as not to overload the system), in order to minimise the overall rendering times.
+</para>
+</section>
+</section>
+
<section id="prefs_routing" xreflabel="Routing Preferences"><title>Routing</title>
<section><title>Routing engine</title>
<para>You can select the routing engine used by default, ie by features that do not propose a live selection, like <xref linkend="route_finder"/>.</para>
</section>
</section>
+<section id="prefs_toolbar" xreflabel="Toolbar Preferences"><title>Toolbar</title>
+<section><title>Append to Menu</title>
+<para>Allows setting the toolbar on the same vertical space as the menu, thus increasing vertical space for the map.</para>
+</section>
+<section><title>Icon Size</title>
+<para>Allows configuration of the icon size, including overiding the system's default preference to the setting desired just for &appname;</para>
+</section>
+<section><title>Icon Style</title>
+<para>Allows configuration of the icon style, including overiding the system's default preference to the setting desired just for &appname;</para>
+</section>
+<section id="prefs_toolbar_customize" xreflabel="Customize Toolbar"><title>Customize</title>
+<para>Opens the Customize Toolbar dialog.</para>
+<para>From this dialog the items in the toolbar can be added, removed and reordered. Reordering of items is performed by drag and drop.</para>
+<figure>
+<title>Customize Toolbar dialog</title>
+<screenshot>
+ <graphic format="PNG" fileref="figures/customize_toolbar_dialog.png"/>
+</screenshot>
+</figure>
+</section>
+</section>
+
</section>
<!-- HOWTOS-->
</programlisting>
</para>
<para>You can find more examples in the documentation part of the distribution.</para>
- <section>
+ <para>
+ It is also possible to override the internal defaults e.g. to update any parameters should they change over time,
+ by adding the values into your configuration file.
+ When you define object group that already exists (and for Maps this means by a repeated Id key, but you may have to examine the source code to work out what the relevant Id values are) then you need to define all the other keys as well, otherwise they will be reset to the defaults.
+ </para>
+ <section id="map_source" xreflabel="Map Source Extensions">
<title>Map Source</title>
- <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>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename> for <trademark>UNIX</trademark> like systems, <filename>C:\Documents and Settings\<replaceable>username</replaceable>\.viking\maps.xml</filename> on <trademark>Windows XP</trademark> or <filename>C:\Users\<replaceable>username</replaceable>\.viking\maps.xml</filename> on <trademark>Windows 7</trademark> onwards.</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 <classname>VikSlippyMapSource</classname> allows to declare any map's source working like OpenStreetMap. It supports the following properties:
<term>id</term>
<listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term>name</term>
+ <listitem><para>a string (should be unique) that is used for the OSM style cache directory name when the Map Cache directory is the default (<filename>~/.viking-maps</filename>)</para></listitem>
+ </varlistentry>
<varlistentry>
<term>label</term>
<listitem><para>the text displayed in the map's source selection dialog</para></listitem>
</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 Z, X and Y (in that order) (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>
+ <note>
+ <para>The full parametrized address can just be put in the URL field and the hostname field doesn't need specifying.</para>
+ <para>e.g. "https://tile.openstreetmap.org/%d/%d/%d.png"</para>
+ </note>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-min (optional)</term>
+ <listitem><para>The minimum zoom value supported by the tile server. The Default is 0 if not specified.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-max (optional)</term>
+ <listitem>
+ <para>The maximum zoom value supported by the tile server. The Default is 18 if not specified.</para>
+ <para>See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lat-min (optional)</term>
+ <listitem><para>The minimum latitude value in degrees supported by the tile server. The Default is -90 degrees if not specified.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lat-max (optional)</term>
+ <listitem><para>The maximum latitude value in degrees supported by the tile server. The Default is 90 degrees if not specified.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lon-min (optional)</term>
+ <listitem><para>The minimum longitude value in degrees supported by the tile server. The Default is -180 degrees if not specified.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lon-max (optional)</term>
+ <listitem><para>The maximum longitude value in degrees supported by the tile server. The Default is 180 degrees if not specified.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>file-extension (optional)</term>
+ <listitem>
+ <para>The file extension of the files on disk. The default is <emphasis>.png</emphasis></para>
+ <para>If the tile source URL ends in something other than .png, then this parameter will need to match it.</para>
+ <para>This can also be useful in reading a tileset from other software which may name tiles in an alternative form,
+ e.g. for Mobile Atlas creator it names them <emphasis>.png.tile</emphasis></para>
+ <note><para>The file types actually usable are those supported by GDK Pixbuf Library, which includes at least PNG and JPEG.</para></note>
+ <note><para>Remember to include the beginning <emphasis>'.'</emphasis> when specifying this parameter.</para></note>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>use-direct-file-access (optional)</term>
+ <listitem>
+ <para>Only use files on disk. The default is <emphasis>FALSE</emphasis></para>
+ <para>This can also be useful for tilesets already on disk as it will avoid attempting to download any tiles.</para>
+ <para>Thus with this type the <emphasis>hostname</emphasis> and <emphasis>url</emphasis> parameters are not necessary and are ignored.</para>
+ </listitem>
</varlistentry>
<varlistentry>
<term>switch-xy (optional)</term>
- <listitem><para>Swap the X,Y values around in the URL parametrized ordering.</para></listitem>
+ <listitem>
+ <para>Swap the X,Y values around in the URL parametrized ordering.</para>
+ <para>The default is false.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>check-file-server-time (optional)</term>
+ <listitem>
+ <para>Sends the timestamp of the tile to the server, so the server can decide whether it should send a new tile or not.</para>
+ <para>The default is false.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>use-etag (optional)</term>
+ <listitem>
+ <para>Use and compare the <ulink url="http://en.wikipedia.org/wiki/HTTP_ETag">ETag</ulink> value in determining whether to download a newer tile. The default is false.</para>
+ <para>The ETag value is stored in a separate file in the same directory as the tile to enable checking the value across multiple runs of the program.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>tilesize-x (optional)</term>
+ <listitem><para>The tile x size. The default is 256 pixels if not specified.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>tilesize-y (optional)</term>
+ <listitem><para>The tile y size. The default is 256 pixels if not specified.</para></listitem>
</varlistentry>
</variablelist>
</para>
- <para>The <classname>VikTmsMapSource</classname> 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 (as per VikSlippyMapSource above):
<variablelist>
<varlistentry>
- <term>id</term>
- <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
+ <term>id</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>label</term>
- <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
+ <term>label</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>hostname</term>
- <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
+ <term>hostname</term><listitem><para></para></listitem>
</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>
+ <term>url</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>check-file-server-time (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-min (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-max (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lat-min (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lat-max (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lon-min (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lon-max (optional)</term><listitem><para></para></listitem>
</varlistentry>
</variablelist>
</para>
- <para>The <classname>VikWmscMapSource</classname> 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 (as per VikSlippyMapSource above):
<variablelist>
<varlistentry>
- <term>id</term>
- <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
+ <term>id</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>label</term>
- <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
+ <term>label</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>hostname</term>
- <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
+ <term>hostname</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>url</term>
- <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 4 "%s" fields for bounding box coordinates (eg. "/coord=%s,%s,%s,%s")</para></listitem>
+ <term>url</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>check-file-server-time (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-min (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-max (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lat-min (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lat-max (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lon-min (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lon-max (optional)</term><listitem><para></para></listitem>
</varlistentry>
</variablelist>
</para>
<term>label</term>
<listitem><para>the text displayed in the menu entry</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term>format</term>
+ <listitem>
+ <para>The <application>GPSBabel</application> format code to interpret the service response. By default a GPX response is expected and processed internally. However if the service returns different format then <application>GPSBabel</application> is used to transform the text into something that &appname; can understand. Only formats that <application>GPSBabel</application> supports can be used: e.g. 'gpx', 'kml', 'gtrnctr' (for Garmin Training Center .tcx files), etc...</para>
+ <para>Use <command>gpsbabel --help</command> on the command line to find out the supported file types and their codes to process them.</para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term>url-base</term>
<listitem><para>the base URL of the web service (eg. "http://hostname/service?")</para></listitem>
<varlistentry>
<term>url</term>
<listitem>
- <para>the parametrized URL to open in the spirit of C printf format, with up to 7 "%s" values. e.g. <literal>http://hostname/getfile?lat=%s&lon=%s</literal></para>
+ <para>the parametrized URL to open in the spirit of C printf format, with up to 9 "%s" values. e.g. <literal>http://hostname/getfile?lat=%s&lon=%s</literal></para>
<para>The order and meaning of these parameters is given by the url_format_code below</para>
</listitem>
</varlistentry>
<para>A = center lAtitude of the current view</para>
<para>O = center lOngitude of the current view</para>
<para>Z = OSM Zoom value of the current view. See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para>
+ <para>P = selected Point's latitude</para>
+ <para>N = selected poiNt's longitude</para>
+ <para>S = A user specified input string requested from the user via a dialog box</para>
<para>Thus for the url example above then the format code should be <emphasis>AO</emphasis></para>
</listitem>
</varlistentry>
<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>
+ <varlistentry>
+ <term>babel_filter_args</term>
+ <listitem>
+ <para>This value is passed on for the filter arguments interfacing with GPSBabel.</para>
+ <para>E.g. "-x nuketypes,routes" can be used to filter all routes from the results.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>input_label</term>
+ <listitem>
+ <para>This value is used when requesting input from the user.</para>
+ <para>It is the label of the text input box.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</section>
<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>
+ <itemizedlist>
+ <listitem>
+ <para>gpx_tidy_points=true</para>
+ <para>ATM Only attempts to remove a suspicious first point of a GPX track
+ (as opposed to any points within a track).</para>
+ </listitem>
+ <listitem>
+ <para>gpx_tidy_points_max_speed=340</para>
+ <para>Over this speed (in metres per second) for the first pair of points - the first point is removed.</para>
+ </listitem>
+ <listitem>
+ <para>layers_create_trw_auto_default=false</para>
+ <para>Create new TrackWaypoint layers without showing the layer properties dialog first.</para>
+ </listitem>
<listitem>
<para>maps_max_tiles=1000</para>
</listitem>
<listitem>
<para>maps_real_min_shrinkfactor=0.0039062499</para>
</listitem>
+ <listitem>
+ <para>maps_scale_inc_down=4</para>
+ </listitem>
+ <listitem>
+ <para>maps_scale_inc_up=2</para>
+ </listitem>
+ <listitem>
+ <para>maps_scale_smaller_zoom_first=true</para>
+ </listitem>
+ <listitem>
+ <para>srtm_http_base_url=https://dds.cr.usgs.gov/srtm/version2_1/SRTM3</para>
+ <para>Allows using an alternative service for acquiring DEM SRTM files.
+ Note that the layout on the server needs to be split into Continent directories.</para>
+ </listitem>
+ <listitem>
+ <para>mapnik_buffer_size=128 (in pixels)</para>
+ </listitem>
<listitem>
<para>background_max_threads=10</para>
</listitem>
+ <listitem>
+ <para>background_max_threads_local=<emphasis>Number of CPUs</emphasis></para>
+ </listitem>
<listitem>
<para>window_menubar=true</para>
</listitem>
+ <listitem>
+ <para>window_copy_centre_full_format=false</para>
+ </listitem>
<listitem>
<para>version_check_period_days=14</para>
</listitem>
<para>trkpt_selected_statusbar_format=KEATDN</para>
<para>This string is in the Message Format Code</para>
</listitem>
+ <listitem>
+ <para>utils_nearest_tz_factor=1.0</para>
+ </listitem>
<listitem>
<para>viewport_history_size=20</para>
</listitem>
If within this range it will skip over this location and move on to the next saved history location.
</para>
</listitem>
- </orderedlist>
+ <listitem>
+ <para>external_diary_program=<ulink url="http://rednotebook.sourceforge.net/">rednotebook</ulink></para>
+ <para>Or in Windows it uses <filename>C:/Progra~1/Rednotebook/rednotebook.exe</filename> - This string value must use Unix separators and not have spaces.</para>
+ </listitem>
+ <listitem>
+ <para>external_astro_program=<ulink url="http://stellarium.org/">stellarium</ulink></para>
+ <para>Or in Windows use <filename>C:/Progra~1/Stellarium/stellarium.exe</filename> - This string value must use Unix separators and not have spaces.
+ Needs to be version 0.15.0 or greater (otherwise due to this <ulink url="https://bugs.launchpad.net/stellarium/+bug/1410529">Bug</ulink> means this does not actually work.</para>
+ </listitem>
+ <listitem>
+ <para>bfilter_simplify=100</para>
+ </listitem>
+ <listitem>
+ <para>bfilter_compress=0.001</para>
+ </listitem>
+ <listitem>
+ <para>list_date_format=%Y-%m-%d %H:%M</para>
+ <para>A <ulink url="http://pubs.opengroup.org/onlinepubs/007908799/xsh/strftime.html">date format description</ulink> as passed on to strftime().
+ Note that when displayed in tables sorting by this column simply uses the text value, rather than the underlying date/time value.
+ </para>
+ </listitem>
+ </itemizedlist>
<section>
<title>Message Format Code</title>
<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>B = Vertical Speed (Climb)</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>F = Distance of the trackpoint from the finish (end) 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>
</variablelist>
</para>
</section>
+
</section>
+ <section id="config_keys" xreflabel="Keyboard Shortcuts File">
+ <title>Keyboard Shortcuts (Accelerator) Settings</title>
+ <para>This is held in the file <filename>~/.viking/keys.rc</filename></para>
+ <para>It is in the standard GTK Accelerator map format. Values are automatically read in and saved between &app; sessions.</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>
+ </section>
+
</section>
<!-- End of Extending Viking -->
-<section><title>Dependencies</title>
-<formalpara><title>gpsbabel</title>
-<para>&appname; uses <ulink url="http://gpsbabel.org/">GPSBabel</ulink> to convert data.</para>
-</formalpara>
-<formalpara><title>unbuffer (optional)</title>
-<para>&appname; uses unbuffer command to optimize conversion calls.</para>
-</formalpara>
-<formalpara><title>gpsd (optional - but not <trademark>Windows</trademark>)</title>
-<para>&appname; can use <ulink url="http://www.catb.org/gpsd/">gpsd</ulink> to get the current location.</para>
-</formalpara>
-</section>
+<xi:include href="recommends.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+<xi:include href="commandline.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+<xi:include href="attribution.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</article>
projects / andy / viking.git / blobdiff