</para>
</listitem>
<listitem>
-<para>Preparing tracks, routes and waypoints for trips using maps from services such as OpenStreetMap (OSM) and/or Terrasever.
+<para>Preparing tracks, routes and waypoints for trips using maps from services such as OpenStreetMap (OSM).
The data is only needed to be uploaded to your GPS before you leave.
The maps together with your tracks, routes and waypoints can also be printed and used during the trip.
</para>
</listitem>
<listitem>
<para>
-Downloading and storing OpenStreetMap and/or Terraserver maps on your hard drive and looking at them later.
+Downloading and storing OpenStreetMap and/or other map types on your hard drive and looking at them later.
</para>
</listitem>
<listitem>
</figure>
</section>
-<section><title>Projections</title>
+<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:
<itemizedlist>
</para>
</section>
-<section><title>Map Cache</title>
+<section id="mapcache" xreflabel="Map Cache"><title>Map Cache</title>
<para>
&appname; stores downloaded map tiles to disk for a couple of reasons:
</para>
This can be useful if you contribute to OpenStreetMap and wish to see your modifications (of course give time for the server to have processed your changes - see <ulink url="http://help.openstreetmap.org/questions/102/i-have-made-edits-but-they-dont-show-up-on-the-map">I have made edits but they don't show up on the map</ulink>)
</para>
</note>
+
+<para>
+The layout of the cache on disk itself can be controlled via a per Map Layer property.
+<itemizedlist>
+<listitem><para>Viking - Legacy default in a private cache layout scheme</para></listitem>
+<listitem><para>OSM - Newer available default (1.6+)</para>
+<para>
+This is to increase the compatibility between &appname; and similar applications that cache tiles on disk so that the tiles can be shared.
+</para>
+</listitem>
+</itemizedlist>
+
+</para>
</section>
<section id="shortcut_keys" xreflabel="Shortcut Keys"><title>Shortcut Keys</title>
<section id="Maps" xreflabel="Maps"><title>Maps Layer</title>
<para>
-This layer provides a single map resource, you may have multiple map layers but only top one (if enabled) will be visible.
-You will need an open internet connection when you are downloading maps, 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.
+This layer provides a single map resource, you may have multiple map layers but only top one (if enabled) will be visible (subject to the Alpha compositing property).
</para>
<para>
-Some maps are continually improving over time (e.g. OpenStreetMap) and so in order to not to have to (re)download the data all the time &appname; employs a timeout method - <emphasis>Tile Age</emphasis> to determine whether to access the server. However a forced refresh for the current view can be made via the <guilabel>Reload All Onscreen Maps</guilabel> option.
+Some maps are continually improving over time (e.g. OpenStreetMap) thus &appname; employs a caching mechanism to avoid redownloading data (see <xref linkend="mapcache"/>).
+However a forced refresh for the current view can be made via the <guilabel>Reload All Onscreen Maps</guilabel> option or <keycap>Ctrl+F5</keycap>.
</para>
+<formalpara><title>Online Map Tile Providers</title>
<para>
+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>
</itemizedlist>
<para>
-&appname; can be configured to handle additional maps. See <xref linkend="extend_viking"/> for further detail.
+&appname; can be configured to handle additional online map resources. See <xref linkend="extend_viking"/> for further detail.
+</para>
+
+<formalpara><title>Offline Map Tilesets</title>
+<para>
+Some map types supported are for on disk tile formats:
+</para>
+</formalpara>
+<itemizedlist>
+<listitem>
+ <para>On Disk OSM Tile Format</para>
+ <para>This is equivalent to any map set with <emphasis>OSM</emphasis> Cache Layput.</para>
+</listitem>
+<listitem><para><ulink url="https://github.com/mapbox/mbtiles-spec">MBTiles File</ulink></para></listitem>
+<listitem><para><ulink url="http://wiki.openstreetmap.org/wiki/Meta_tiles">OSM Metatiles</ulink></para></listitem>
+</itemizedlist>
+<para>
+Of course you need to have acquired or generated these tilesets yourself.
+</para>
+
+<section><title>Map Layer Properties</title>
+<para>
+Configurable properties:
</para>
+<itemizedlist>
+<listitem>
+ <para>Map Type. The kind of map this layer displays.</para>
+ <note><para>Map types are dependent on the current <xref linkend="projection"/> mode.</para></note>
+</listitem>
+<listitem><para>Maps Directory. Not applicable for MBTiles Map type since it is a single file.</para></listitem>
+<listitem><para>Cache Layout. Viking or OSM. See <xref linkend="mapcache"/>. Only applies to maps from online tile providers.</para></listitem>
+<listitem><para>Map File. Ony applicable for MBTiles Map type since it is a single file.</para></listitem>
+<listitem>
+ <para>Alpha. Control the Alpha value for transparency effect using a value between 0 and 255 with the default being 255 for a fully solid image.</para>
+ <para>Zero is fully transparent. A value of around 160 can be useful for blending views of multiple map layers (when applied to the upper most map layer).</para>
+</listitem>
+<listitem><para>Autodownload Maps. This can be useful to turn off when you are not online to avoid pointless download requests or may be keep a map in a 'historical' state.
+e.g. perhaps in case a current map rendering is broken.</para></listitem>
+<listitem><para>Autodownload Only Gets Missing Maps. Using this option avoids attempting to update already acquired tiles.
+This can be useful if you want to restrict the network usage, without having to resort to manual control. Only applies when <emphasis>Autodownload Maps</emphasis> is on.</para></listitem>
+<listitem><para>Zoom Level. Determines the method of displaying map tiles for the current zoom level.
+<emphasis>Viking Zoom Level</emphasis> uses the best matching level, otherwise setting a fixed value will always use map tiles of the specified value regardless of the actual zoom level.</para></listitem>
+</itemizedlist>
+</section><!-- Map Prop END -->
+
<section><title>Layer Operations</title>
<section><title>Download Missing Onscreen Maps</title>
<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-->
<term>url</term>
<listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for Z, X and Y (in that order) (eg. "/%d/%d/%d.png")</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term>zoom-min (optional)</term>
+ <listitem><para>The minimum zoom value supported by the tile server. The Default is 0 if not specified.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-max (optional)</term>
+ <listitem>
+ <para>The maximum zoom value supported by the tile server. The Default is 18 if not specified.</para>
+ <para>See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lat-min (optional)</term>
+ <listitem><para>The minimum latitude value in degrees supported by the tile server. The Default is -90 degrees if not specified.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lat-max (optional)</term>
+ <listitem><para>The maximum latitude value in degrees supported by the tile server. The Default is 90 degrees if not specified.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lon-min (optional)</term>
+ <listitem><para>The minimum longitude value in degrees supported by the tile server. The Default is -180 degrees if not specified.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lon-max (optional)</term>
+ <listitem><para>The maximum longitude value in degrees supported by the tile server. The Default is 180 degrees if not specified.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>file-extension (optional)</term>
+ <listitem>
+ <para>The file extension of the files on disk. The default is <emphasis>.png</emphasis></para>
+ <para>If the tile source URL ends in something other than .png, then this parameter will need to match it.</para>
+ <para>This can also be useful in reading a tileset from other software which may name tiles in an alternative form,
+ e.g. for Mobile Atlas creator it names them <emphasis>.png.tile</emphasis></para>
+ <note><para>The file types actually usable are those supported by GDK Pixbuf Library, which includes at least PNG and JPEG.</para></note>
+ <note><para>Remember to include the beginning <emphasis>'.'</emphasis> when specifying this parameter.</para></note>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>use-direct-file-access (optional)</term>
+ <listitem>
+ <para>Only use files on disk. The default is <emphasis>FALSE</emphasis></para>
+ <para>This can also be useful for tilesets already on disk as it will avoid attempting to download any tiles.</para>
+ <para>Thus with this type the <emphasis>hostname</emphasis> and <emphasis>url</emphasis> parameters are not necessary and are ignored.</para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term>switch-xy (optional)</term>
- <listitem><para>Swap the X,Y values around in the URL parametrized ordering.</para></listitem>
+ <listitem>
+ <para>Swap the X,Y values around in the URL parametrized ordering.</para>
+ <para>The default is false.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>check-file-server-time (optional)</term>
+ <listitem>
+ <para>Sends the timestamp of the tile to the server, so the server can decide whether it should send a new tile or not.</para>
+ <para>The default is false.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>use-etag (optional)</term>
+ <listitem>
+ <para>Use and compare the <ulink url="http://en.wikipedia.org/wiki/HTTP_ETag">ETag</ulink> value in determining whether to download a newer tile. The default is false.</para>
+ <para>The ETag value is stored in a separate file in the same directory as the tile to enable checking the value across multiple runs of the program.</para>
+ </listitem>
</varlistentry>
</variablelist>
</para>
- <para>The <classname>VikTmsMapSource</classname> allows to declare any TMS service. It supports the following properties:
+ <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>
- <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
+ <term>id</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>label</term>
- <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
+ <term>label</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>hostname</term>
- <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
+ <term>hostname</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>url</term>
- <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 3 "%d" fields for X, Y and Z (zoom level) (eg. "/%d/%d/%d.png")</para></listitem>
+ <term>url</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>check-file-server-time (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-min (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-max (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lat-min (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lat-max (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lon-min (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <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:
+ <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>
- <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
+ <term>id</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>label</term>
- <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
+ <term>label</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>hostname</term>
- <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
+ <term>hostname</term><listitem><para></para></listitem>
</varlistentry>
<varlistentry>
- <term>url</term>
- <listitem><para>the parametrized address of the tile, in the spirit of C printf format, with 4 "%s" fields for bounding box coordinates (eg. "/coord=%s,%s,%s,%s")</para></listitem>
+ <term>url</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>check-file-server-time (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-min (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>zoom-max (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lat-min (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lat-max (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>lon-min (optional)</term><listitem><para></para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <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>
</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