</figure>
</section>
+<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:
&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>
<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.
<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>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>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>
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>OpenStreetMap (Mapquest) - This is the default (&appname; Version1.3+)</para></listitem>
<listitem><para>OpenStreetMap (Humanitarian) (&appname; Version1.5+)</para></listitem>
<listitem><para>NASA BlueMarble</para></listitem>
</itemizedlist>
-</formalpara>
<para>
&appname; can be configured to handle additional online map resources. See <xref linkend="extend_viking"/> for further detail.
<para>
Some map types supported are for on disk tile formats:
</para>
+</formalpara>
<itemizedlist>
<listitem>
<para>On Disk OSM Tile Format</para>
<para>
Of course you need to have acquired or generated these tilesets yourself.
</para>
-</formalpara>
<section><title>Map Layer Properties</title>
<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>
+<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>
<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>
+ <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>
<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>
+ <term>id</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>label</term>
+ <term>label</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>hostname</term>
+ <term>hostname</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>url</term>
+ <term>url</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>check-file-server-time (optional)</term>
+ <term>check-file-server-time (optional)</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>zoom-min (optional)</term>
+ <term>zoom-min (optional)</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>zoom-max (optional)</term>
+ <term>zoom-max (optional)</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>lat-min (optional)</term>
+ <term>lat-min (optional)</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>lat-max (optional)</term>
+ <term>lat-max (optional)</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>lon-min (optional)</term>
+ <term>lon-min (optional)</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>lon-max (optional)</term>
+ <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 (as per VikSlippyMapSource above):
<variablelist>
<varlistentry>
- <term>id</term>
+ <term>id</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>label</term>
+ <term>label</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>hostname</term>
+ <term>hostname</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>url</term>
+ <term>url</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>check-file-server-time (optional)</term>
+ <term>check-file-server-time (optional)</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>zoom-min (optional)</term>
+ <term>zoom-min (optional)</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>zoom-max (optional)</term>
+ <term>zoom-max (optional)</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>lat-min (optional)</term>
+ <term>lat-min (optional)</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>lat-max (optional)</term>
+ <term>lat-max (optional)</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>lon-min (optional)</term>
+ <term>lon-min (optional)</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>lon-max (optional)</term>
+ <term>lon-max (optional)</term><listitem><para></para></listitem>
</varlistentry>
</variablelist>
</para>
<para>Some values in this file are <emphasis>read only</emphasis>, in the sense that there is no way to set it other than by manually entering in the keys and values (the key will not exist in the file otherwise). This allows some fine tuning of &app; behaviours, without resorting to recompiling the code. However is it not expected that these values should need to be changed for a normal user, hence no GUI options for these have been provided.</para>
<para>Here is the list of the <emphasis>read only</emphasis> keys and their default values.</para>
<orderedlist>
+ <listitem>
+ <para>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>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>
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>
<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>
</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"/>
projects / andy / viking.git / blobdiff