]> git.street.me.uk Git - andy/viking.git/blobdiff - help/C/viking.xml
White space fixes.
[andy/viking.git] / help / C / viking.xml
index c30dea8ddfd6f7315aff9a8face1f8d931ca11ff..9842127332af639d563c838b9168ecb32e506e24 100644 (file)
@@ -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="MapnikRendering"/></para></listitem>
 </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>
-<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>
@@ -1410,6 +1411,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>
+<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>
@@ -1725,8 +1731,13 @@ Add a new layer of the selected type.
 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>
@@ -1829,31 +1840,9 @@ Tracks are searched first in preference over waypoints.
 
 </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>
@@ -2099,7 +2088,7 @@ For Linux you can override this with the setting in the <xref linkend="prefs_ext
 
 </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>
@@ -2299,6 +2288,31 @@ Generally if you have a system with lots of memory it's recommended to increase
 <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>
@@ -2312,6 +2326,40 @@ Your OSM password will be stored in plain text.
 </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>
@@ -2911,7 +2959,7 @@ Accept: */*
 </programlisting>
 </para>
       <para>You can find more examples in the documentation part of the distribution.</para>
-      <section>
+      <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, <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>
@@ -3291,9 +3339,24 @@ Accept: */*
          <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>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>
@@ -3328,6 +3391,15 @@ Accept: */*
              If within this range it will skip over this location and move on to the next saved history location.
            </para>
          </listitem>
+         <listitem>
+           <para>external_diary_program=rednotebook</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=stellarium</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.
+                 Further note due to this <ulink url="https://bugs.launchpad.net/stellarium/+bug/1410529">Bug</ulink> in Stellarium means this does not actually work. You will need to reference a shortcut, rather than the executable directly.</para>
+         </listitem>
        </orderedlist>
 
        <section>
@@ -3344,6 +3416,7 @@ Accept: */*
               <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>