</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.
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>
<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>
<section id="prefs_osm" xreflabel="OpenStreetMap Traces Preferences"><title>OpenStreetMap Traces</title>
</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-->
<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>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>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>
</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"/>
projects / andy / viking.git / blobdiff