]> git.street.me.uk Git - andy/viking.git/blobdiff - help/C/viking.xml
[QA] Minor document correction.
[andy/viking.git] / help / C / viking.xml
index d95b9d0cbd24d976d31912803657c5346cecafc3..f30713eb752a276dcc8af709f19c19a9dc39cd2a 100644 (file)
@@ -325,7 +325,7 @@ This is to increase the compatibility between &appname; and similar applications
 &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>
@@ -362,12 +362,33 @@ Then there are shortcuts specific to &appname; to switch projection modes, zoom
 <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>
-<listitem><note><para>These work irrespective of the <xref linkend="tools"/> mode selected</para></note></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>
 <para>
 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.
@@ -1808,31 +1829,7 @@ 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>
-
-</section><!-- End GeoRef -->
+<xi:include href="georef_layer.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
 <section id="Coordinate" xreflabel="Coordinate"><title>Coordinate Layer</title>
 <para>
@@ -2078,7 +2075,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>
@@ -2278,6 +2275,10 @@ 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_osm" xreflabel="OpenStreetMap Traces Preferences"><title>OpenStreetMap Traces</title>
@@ -2890,7 +2891,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>
@@ -3270,9 +3271,21 @@ 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>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>
@@ -3307,6 +3320,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>
@@ -3323,6 +3345,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>
@@ -3345,8 +3368,16 @@ Accept: */*
           </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 -->