datasources.xml file should be packaged

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

diff --git a/help/C/viking.xml b/help/C/viking.xml
index 29e865356731ed666d9e58430bfef2e4deb7f129..423ee6c47656d6cda86144329d5dc9af9be6638c 100644 (file)
--- a/help/C/viking.xml
+++ b/help/C/viking.xml
@@ -3,9 +3,9 @@
 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   <!ENTITY appname          "Viking">
   <!ENTITY app "<application>Viking</application>">
 "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">
+  <!ENTITY manrevision  "1.6">
+  <!ENTITY date "March 2015">

 ]>
 <!--
       (Do not remove this comment block.)
 ]>
 <!--
       (Do not remove this comment block.)


@@ -704,6 +704,7 @@ Layers supported by &appname; are:
 <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="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:
 </itemizedlist>
 <para>
 For each layer there are a few standard options:


@@ -1019,7 +1020,7 @@ Opens a new dialog with the list. As described in the Aggregrate layer <xref lin
 </itemizedlist>
 <para>Also gives other options for handling multiple items:</para>
 <itemizedlist>
 </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>
 <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>


@@ -1313,6 +1314,20 @@ This is not available for routes, as they have no timestamps.
 </para>
 </note>
 </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>
 </section>
 
 <section><title>Export Track as GPX</title>


@@ -1410,6 +1425,11 @@ The record of the Google route is stored in the track's comment, so if the comme
 <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>
 <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>
 
 <section><title>Waypoint Properties</title>


@@ -1725,14 +1745,20 @@ Add a new layer of the selected type.
 The list within the treeview can be sorted.
 </para>
 <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.
+Alphabetical and Date sorts are available.

 </para>
 </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.
 </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).
 </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).


@@ -1765,14 +1791,21 @@ Each entry in the track list can be selected and on mouse right click offers the
 <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>
 <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>
 </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.
 </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.
 </para>
 <para>
 This table may be invoked from a variety of different layer levels and will then list only the relevant waypoints.


@@ -1804,8 +1837,14 @@ Each entry in the list can be selected and on mouse right click offers these opt
 <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>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>
 </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>
 
 <section id="vis_options" xreflabel="Visibility Options"><title>Visibility Options</title>


@@ -1831,6 +1870,8 @@ Tracks are searched first in preference over waypoints.
 
 <xi:include href="georef_layer.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
 
 <xi:include href="georef_layer.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 

+<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>
 This layer is allows drawing of grid lines on the viewport.
 <section id="Coordinate" xreflabel="Coordinate"><title>Coordinate Layer</title>
 <para>
 This layer is allows drawing of grid lines on the viewport.


@@ -2281,6 +2322,27 @@ Generally if you have a system with lots of memory it's recommended to increase
 </section>
 </section>
 
 </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><title>OSM Username + Password</title>
 <para>Store your OSM details here, so that you don't need to enter it in every time in the <xref linkend="osm_upload"/> procedure.</para>
 <section id="prefs_osm" xreflabel="OpenStreetMap Traces Preferences"><title>OpenStreetMap Traces</title>
 <section><title>OSM Username + Password</title>
 <para>Store your OSM details here, so that you don't need to enter it in every time in the <xref linkend="osm_upload"/> procedure.</para>


@@ -2292,6 +2354,40 @@ Your OSM password will be stored in plain text.
 </section>
 </section>
 
 </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 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>


@@ -3199,7 +3295,7 @@ Accept: */*
             <varlistentry>
               <term>url</term>
               <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&amp;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&amp;lon=%s</literal></para>

                 <para>The order and meaning of these parameters is given by the url_format_code below</para>
               </listitem>
             </varlistentry>
                 <para>The order and meaning of these parameters is given by the url_format_code below</para>
               </listitem>
             </varlistentry>


@@ -3214,6 +3310,8 @@ Accept: */*
                 <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>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>
                 <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>


@@ -3259,6 +3357,10 @@ Accept: */*
         <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>
         <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>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_max_tiles=1000</para>
          </listitem>


@@ -3280,9 +3382,15 @@ Accept: */*
          <listitem>
            <para>maps_scale_smaller_zoom_first=true</para>
          </listitem>
          <listitem>
            <para>maps_scale_smaller_zoom_first=true</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=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_menubar=true</para>
          </listitem>