X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/f5ae8c7ee03d96ba3649057b61fc327c53f68713..e5ee3c87f81421addce043e47e3ed4f823b87ed3:/help/C/viking.xml diff --git a/help/C/viking.xml b/help/C/viking.xml index 36642eea..2fab04f9 100644 --- a/help/C/viking.xml +++ b/help/C/viking.xml @@ -1,11 +1,11 @@ - Viking"> - - - + + + ]> @@ -610,6 +704,7 @@ Layers supported by &appname; are: + For each layer there are a few standard options: @@ -726,8 +821,30 @@ You are probably better off expanding the waypoint list and directly start typin
Export Layer -The layer (all tracks, routes and waypoints) can be exported to a file GPX, GPSPoint, GPSMapper or Google's KML format. - +The layer (all tracks, routes and waypoints) can be exported to following file formats: + + + + GPX + + + GPSPoint + + + GPSMapper + + + Google's KML + + + Any GPSBabel File Formats + + + GeoJSON. Via the program togeojson + This option will not be available if the program is not detected on your system. + See here for the installation method. + + Version1.1+: An individual track can be exported to a GPX file via the track menu. @@ -735,9 +852,13 @@ Version1.1+: An individual track can be exported to a GPX file via the track men
Finish Track or Route -This is only available when a track or route is being created by the or tools. Selecting this option ends the creation of that individual track or route. + + +This is only available when a track or route is being created by the or tools. + +
New @@ -832,6 +953,15 @@ The password is transferred unencrypted in ever This opens dialog to request the number of points each track will be simplified using GPSBabel. The result is put into a new layer. The simplification method removes points considered to be in a 'near straight line', thus reducing the number of points and attempting to keep the most important turning points.
+
Compress Tracks + +Enables compression of tracks and routes via GPSBabel's Crosstrack simplify method. +It opens a dialog to request the Error factor value which is the maximum allowable error that may be introduced by removing a single point. +It is expressed a distance in units as specified by the distance option. +Thus a higher value will remove more points. +The result is put into a new layer. + +
Remove Duplicate Waypoints Remove Duplicate Waypoints - fairly self explainatory, with the results created in a new layer. @@ -864,6 +994,18 @@ See Geotagging for further detail.
+
List Tracks or Routes + +Opens a new dialog with the list. As described in the Aggregrate layer + +
+ +
List Waypoints + +Opens a new dialog with the list. As described in the Aggregrate layer + +
+
Track and Route Sublayer Options @@ -874,24 +1016,57 @@ See Geotagging for further detail. View All Tracks or Routes. Same as the layer View All Tracks or View All Routes Delete All Tracks or Routes. Same as the layer Delete All Tracks or Delete All Routes Delete Tracks or Routes from Selection. Same as the layer Delete Tracks from Selection or Delete Routes from Selection +List Tracks or Routes. Opens a new dialog with the list. As described in the Aggregrate layer + +Also gives other options for handling multiple items: + +Sort. Gives the ability to sort the items in the treeview alphabetically +Visibility. Offers options to quickly control the visibility of all items within the sublayer, as per
-
Track and Route Properties +
Track and Route Properties + +This shows several tabs for properties and useful statistics about a track or a route, including elevation-distance and speed-time graphs (if data is available). +Moving the mouse pointer over the graph displays values related to that point along the track. +You can click on these graphs to jump to the point in the track. +You can reverse it, delete duplicates, split at marked position or split a track from its component segments (discontinuous breaks in a track) into separate tracks. + +
Track and Route Properties Tab + +
+Properties Tab: Example + + + +
+ +
+
Track and Route Statistics Tab + +
+Statistics Tab: Example + + + +
+ +
+
Track Elevation Graph -Show many useful statistics about a track or a route, including a -elevation-distance graph and a speed-time graph (if data is available). -You can click these graphs to jump to the point in the track. You can -also reverse it, delete duplicates, and split a track from its -component segments (discontinuous breaks in a track) into separate -tracks. +
+Elevation Distance Tab: Example + + + +
 The following colors are used in the elevation-distance graph: -'Main' colour - this is dependent on your Desktop theme - often blue by default +Main colour - this is dependent on your Desktop theme - often blue by default elevation data in graph @@ -913,16 +1088,20 @@ The following colors are used in the elevation-distance graph: - +
Track and Route Operations
Finish Track -This is only available when a track is being created by the tool. Selecting this option ends the creation of the individual track. + + +This is only available when a track is being created by the tool. + +
Goto @@ -955,9 +1134,11 @@ threshold time away. This way, if you somehow end up with lots of small segments (say, caused by turning the GPS on and off) you can merge them easily into one track. + This is not available on routes as they have no timestamps. +
Merge With Other Tracks @@ -988,9 +1169,11 @@ time interval between successive trackpoints is larger than some threshold. This is useful when processing raw NMEA GPS data, especially taken over a long time. + This is not available on routes as they have no timestamps. +
Split By Number of Points @@ -1004,19 +1187,60 @@ This can be useful with devices which may have limits on the number of points it Splits track segments into new tracks. + This is not available on routes as they do not have route segments. + +
+ +
Split at Trackpoint + +Splits the track at the currently selected trackpoint. + + +The current track will finish at this trackpoint. +A new track will start from a copy of this trackpoint. + + + +This is only enabled when a trackpoint is selected. + + +
-
Split at Trackpoint +
Insert Points + + +These options are only enabled when a trackpoint is selected. + + +
Insert Point Before Selected Point + +Inserts a track point halfway between the previous track point and the current track point. +All track point properties are interpolated between the two points. + +
+
Insert Point After Selected Point -Splits the track at the currently selected trackpoint. This is only enabled when a trackpoint is selected. +Inserts a track point halfway between the current track point and the next track point. +All track point properties are interpolated between the two points.
Delete Points +
Delete Selected Point + +Deletes the currently selected track point. + + + +This is only enabled when a trackpoint is selected. + + +
Delete Points With the Same Position Deletes subsequent points that have the same position (but have different timestamps). @@ -1026,17 +1250,70 @@ Deletes subsequent points that have the same position (but have different timest Deletes subsequent points that have the same time stamp (but may have different positions). + This is not available on routes as they have no timestamps. +
+
Transform + +These options alter the data of trackpoints of a track but not add or remove trackpoints. +And don't seem to fit any other category :) +
Apply DEM data If any DEM data is loaded, this will apply the DEM data to give the track elevation data. +Two ways of applying DEM data are offered: + +Keep. Retains the existing elevation data of trackpoints and only those missing an elevation value are set. +Overwrite. Elevation data are set on all trackpoints even if they already elevation values. + + +
+
Smooth Missing Elevation data + +In various locations across the world, there are missing DEM values (AKA DEM Holes) from the SRTM data. +This is particularly noticeable in mountainous areas. +Two ways of applying elevation data to trackpoints that do not have elevation values are offered: + +Interpolated. Missing elevation data is interpolated between the previous and next known values. +Flat. Elevation data is filled in from the last previously known value. + + +
+
+Convert to Track or Route + +If this is a Route then it will convert it to a Track. + + +If this is Track then convert it to a Route. + + + +Converting from a Track to a Route may involve a loss of information, in particular timestamp values (hence you are required to confirm this operation before it happens). + + +
+
+Anonymize Times + +Timestamp information of a track can be shifted to be all offset from 1901-01-01. + + +Thus the timestamps themselves will no longer reveal exactly when a track was taken. +However the relative difference between the timestamps is kept thus one is still able to calculate some properties such as speeds along the track. + + + +This is not available for routes, as they have no timestamps. + +
Export Track as GPX @@ -1077,9 +1354,35 @@ Same as the layer Upload to OSM command, but o This selects the track to be used in the Filter With Trackname feature. + This is not available on routes. + +
+ +
Edit Trackpoint + +This opens the Trackpoint edit dialog. See . + + + +This is only enabled when a trackpoint is selected. + + +
+ +
Refine Route... + +This function allows to request a Routing Engine in order to refine a given route. +By "refining" we mean computing all real intermediates points between some given major points. +This could be useful to compute a trip giving only the wished important steps. + + + +This is only available on routes. + +
View Google Directions @@ -1106,6 +1409,7 @@ The record of the Google route is stored in the track's comment, so if the comme Goto Waypoint. Same as the layer Goto Waypoint Delete All Waypoints. Same as the layer Delete All Waypoints Delete Waypoints from Selection. Same as the layer Delete Waypoints from Selection +List Waypoints. Opens a new dialog with the list. As described in the Aggregrate layer
@@ -1129,9 +1433,23 @@ This centers the viewport on the selected waypoint.
+
Geotag Images... + +This opens the Geotag Dialog to allow Geotagging multiple images to the position of this waypoint. +In this circumstance creation of waypoint options are disabled and only the options related to writing the EXIF information are available. + +
+ +
Transform + +Offers a subset of the track utilities. +Currently only setting the altitude from DEM data methods are available. + +
+
Visit Webpage -If the waypoint's comment (or description) starts with 'http:' then this option is available and allows launching a web browser to go to the webpage. +If the waypoint's comment (or description) starts with http: then this option is available and allows launching a web browser to go to the webpage.
@@ -1151,10 +1469,10 @@ Same as the layer New Waypoint.
Version1.3+: Geotag Images -This dialog allows geotagging images (normally taken with a digital camera) via interpolation against a specific track or all tracks in the TrackWaypoint layer - depending on how it is invoked. +This dialog allows geotagging images (normally taken with a digital camera) against a specific waypoint or via interpolation against a specific track or all tracks in the TrackWaypoint layer - depending on how it is invoked. -Images need to have an EXIF DATE_TIME_ORIGINAL (nearly always set by a camera). This timestamp is then used to find the location when the image(s) was taken by searching through the track(s) to find the nearest time - interpolating between points if necessary to set the location. +When geotagging against tracks, images need to have an EXIF DATE_TIME_ORIGINAL (nearly always set by a camera). This timestamp is then used to find the location when the image(s) was taken by searching through the track(s) to find the nearest time - interpolating between points if necessary to set the location. @@ -1252,32 +1570,75 @@ Using many DEMs is CPU/memory intensive. Depending on your computer's capability
Maps Layer -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). -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 - 'Tile Age' to determine whether to access the server. However a forced refresh for the current view can be made via the Reload All Onscreen Maps option. +Some maps are continually improving over time (e.g. OpenStreetMap) thus &appname; employs a caching mechanism to avoid redownloading data (see ). +However a forced refresh for the current view can be made via the Reload All Onscreen Maps option or Ctrl+F5. +Online Map Tile Providers -Inbuilt maps include various Terraserver (Primarily USA coverage) and OpenStreetMap (OSM) ones and more: +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 OpenStreetMap (OSM) ones and more: + Bing Bird's Eye (Aerial) Maps (&appname; Version1.2+) -Terraserver Topos -Terraserver Aerials -Terraserver Urban Areas OpenStreetMap (Mapquest) - This is the default (&appname; Version1.3+) OpenStreetMap (Mapnik) OpenStreetMap (Cycle) OpenStreetMap (Transport) (&appname; Version1.3+) +OpenStreetMap (Humanitarian) (&appname; Version1.5+) NASA BlueMarble -SpotMap (&appname; Version1.1+) -&appname; can be configured to handle additional maps. See for further detail. +&appname; can be configured to handle additional online map resources. See for further detail. +Offline Map Tilesets + +Some map types supported are for on disk tile formats: + + + + + On Disk OSM Tile Format + This is equivalent to any map set with OSM Cache Layput. + +MBTiles File +OSM Metatiles + + +Of course you need to have acquired or generated these tilesets yourself. + + +
Map Layer Properties + +Configurable properties: + + + + Map Type. The kind of map this layer displays. + Map types are dependent on the current mode. + +Maps Directory. Not applicable for MBTiles Map type since it is a single file. +Cache Layout. Viking or OSM. See . Only applies to maps from online tile providers. +Map File. Ony applicable for MBTiles Map type since it is a single file. + + 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. + 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). + +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. +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 Autodownload Maps is on. +Zoom Level. Determines the method of displaying map tiles for the current zoom level. +Viking Zoom Level 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. + +
+ +
Layer Operations
Download Missing Onscreen Maps @@ -1296,6 +1657,30 @@ This requests map tiles only if the maps are older than the Tile Age preference. Force a refresh of all visible map tiles.
+ +
Download Maps in Zoom Levels + +This opens a dialog to enable requesting the download of maps for the region in the viewport over a specified number of zoom levels. +The download method type can be specified to help limit the number of requests. + + + +There are some inbuilt limits to prevent downloading large amounts of map tiles. + + +Please respect the usage policy of the tile set provider. +Such as OSM Tile Usage Policy. + + + +
+Maps Download Dialog: Example + + + +
+ +
@@ -1324,9 +1709,11 @@ Here are some suggestions: Thus one can have a list of all your tracks, but groups can be shown or not using the relevant layers visibility checkbox. +
Layer Operations -This layer only has one operation: New Layer +The following are available on Aggregate Layers: +
New Layer @@ -1334,33 +1721,118 @@ Add a new layer of the selected type.
-
- -
GeoRef Layer +
Sort -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. +The list within the treeview can be sorted. -
Layer Operations -
Zoom to Fit Map -Automatically set a zoom level to see the entire map coverage. +Currently alphabetical (A to Z or Z to A) sorts are available, since only the name can be seen in the treeview.
-
Goto Map Center +
Track List + +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. + + +This table may be invoked from a variety of different layer levels and will then list only the relevant tracks (and/or routes). + +Aggregate Layer: Lists Tracks and Routes and the TrackWaypoint Layer they are in +TrackWaypoint Layer: Lists Tracks and Routes +TrackWaypoint Track sublayer: Lists Tracks only +TrackWaypoint Route sublayer: Lists Routes only + + + +
+Track List Dialog: Example +
-Center the viewport on this map. +This is showing all tracks and routes (although there are no actual routes here!) in multiple TrackWaypoint layers, that has been sorted by height. +Note that routes will not have timestamps or speeds, but may have elevations and should have some distance! +
+ + + +
+ + +Hovering the mouse over an entry will show a tooltip of the comment or description if it is available. + + +Each entry in the track list can be selected and on mouse right click offers these options: + +View. Move the viewport to the area of the item and highlight it. +Statistics. Opens the Properties dialog on the tab. Note this will close the track list dialog. + + +
+
Waypoint List + +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. + + +This table may be invoked from a variety of different layer levels and will then list only the relevant waypoints. + +Aggregate Layer: Lists Waypoints and the TrackWaypoint Layer they are in +TrackWaypoint Layer: : Lists Waypoints +TrackWaypoint Waypoint sublayer: Lists Waypoints + + + +
+Waypoint List Dialog: Example +
+ +This was invoked on a TrackWaypoint layer and shows all waypoints from that single layer. It has been sorted by the symbols. + +
+ + + +
+ + +Hovering the mouse over an entry will show a tooltip of the description if it is available. + + +Each entry in the list can be selected and on mouse right click offers these options: + +View. Move the viewport to the area of the item and highlight it. +Properties. This will open the properties dialog. Note this will close the waypoint list dialog. +Show Picture. If enabled, this will open the associated image in an external Image Viewer program. + +
-
Export to World File + +
Visibility Options -Opens a file save dialog to save the scale and position information as a World File. +This offers a quick way to set all the visibilities of each item within the containing layer, rather than having to change each one individually. + +Show All. Ensures all items are set to be visible. +Hide All. Ensures all items are set to be invisible. This is useful for then turning on single items afterwards so the display is not cluttered. +Toggle. Inverts the visibility status of each item. +
+ +
Search by Date + +This opens calendar dialog to select a date to search by within this Aggregate layer. +The first item that is found on that date will be selected. +Tracks are searched first in preference over waypoints. +
-
+
+ + + +
Coordinate Layer @@ -1409,6 +1881,11 @@ This is the default tool. This mode can also be entered by the keyboard shortcut Ctrl+Shift+P + +Double clicking the left mouse button will zoom the map in. +Shift + double clicking the left mouse button will zoom the map out. +Double clicking the right mouse button will also zoom the map out. +
Zoom @@ -1427,6 +1904,12 @@ This mode can also be entered by the keyboard shortcut Ctrl+Shift+Z Shift (and hold) + left mouse button: Draws a bounding box area on which to zoom in. The zoom action is performed when the left mouse button is released. + +Shift + left click button: Jump Zoom In by up to factor of 3 standard zooms. + + +Shift + right click button: Jump Zoom Out by up to factor of 3 standard zooms. +
Ruler @@ -1435,7 +1918,7 @@ This mode is entered by clicking on the toolbar icon: The ruler is used to measure the bearing and distance between two points: Click on first point and then move the mouse point around - the values will be continually updated. -A second click will 'freeze' the ruler at that point. +A second click will freeze the ruler at that point. This mode can also be entered by the keyboard shortcut Ctrl+Shift+U @@ -1498,6 +1981,31 @@ This operates in exactly the same way as the Create One must finish the current route to be able to create another route. + +One can switch between the Create Route and Route Finder tools while editing routes. + +
+ +
Create Route Using the Route Finder + +Enable this tool by clicking on the toolbar icon: + + +Requires an internet connection. +Left click to create a new trackpoint. +If it's the initial trackpoint you will be asked to enter a name for the route, otherwise the default routing engine will be queried to find a route to the new trackpoint. +Right click or Backspace: remove the last added route. + + +Escape: to finish route creation. +Finishing the track is also available via the right click and track menus. + + +One must finish the current route to be able to create another route. + + +One can switch between the Create Route and Route Finder tools while editing routes. +
Edit Waypoint @@ -1523,10 +2031,39 @@ Left click near a trackpoint (in screen pixel terms) to bring up the Track Point Whilst the edit dialog is already open, left click again and drag enables moving of the trackpoint. If Ctrl is held at the same time, it will jump the new trackpoint position to a nearby existing trackpoint. +
Edit Trackpoint Dialog + +Editing options in the Trackpoint Edit dialog include: + +Edit the trackpoint name +Changing raw lat/long position and altitude +Forward (go to the next trackpoint) +Back (go to the previous trackpoint) +Delete +Insert. Inserts a point halfway to next trackpoint +Split. + + + +Several fields are read only for reference purposes, values are shown if the trackpoint has such information: + +Time. +Speed and course. +'Between' values: Speed, Time Difference and Distance Difference. When moving between trackpoints (via the Back and Forward buttons) these values are calculated. +GPS precision factors. + + -Options in the Track Point Edit dialog include: change position, go to next, go to previous, delete, insert (halfway to next trackpoint) and splitting the track. +
+Trackpoint Edit Dialog: Example + + + +
+One must have been going downhill here to get a reasonable speed by bicycle!
+
Show Picture @@ -1539,25 +2076,9 @@ For Linux you can override this with the setting in the Route Finder - -Enable this tool by clicking on the toolbar icon: - -Creates a track using default routing engine between two points. -Requires an internet connection. Click one point, then click another to -create a track. - - -Right-click: undo last routing (only track removed - not any waypoints) - - -Ctrl: continue previous track - -
-
-
Georef Map Layer Tools +
Georef Map Layer Tools You must have a Map Layer selected to use these tools. @@ -1581,7 +2102,7 @@ Drag to move the georeferenced map.
-
Map Download +
Map Download You must have a Layer selected to use this. @@ -1604,7 +2125,7 @@ The possible methods to redownload one or more tiles are: Map Tile Information -By right clicking on viewport you can see the tile properties of the that location for the current map layer and current zoom level. +By right clicking on viewport and selecting Show Tile Information you can see the tile properties of this location for the current map layer and current zoom level. This includes the remote source URL for the tile and the cached version on the local filesystem with timestamp details. @@ -1629,6 +2150,21 @@ Enable this tool by clicking on the toolbar icon: Click to download and import a DEM file. +DEM File Information + +By right clicking on viewport and selecting Show DEM File Infomation you can see the file properties of the DEM file for this location. +This includes the remote source URL for the file and the cached version on the local filesystem with timestamp details. + + + +
+DEM File Info Dialog: Example + + + +
+This is for block 51N, 003W - covering Bristol in the UK. +
Webtools @@ -1683,16 +2219,22 @@ This feature is called Webtools. It is also known as Extern An option exists to control the icon (symbol) size used for waypoints
-
'Home' Default Location: Latitude and Longitude -You can set the 'Home' location directly by inputting the latitude and longitude in decimal degrees. +
<emphasis>Home</emphasis> Default Location: Latitude and Longitude +You can set the Home location directly by inputting the latitude and longitude in decimal degrees.
+
Time Display +This controls the reference timezone that times are shown in. +Locale is the current user's system preference. This was how all times were shown up to version 1.5. +World will attempt to determine the timezone at an object's position. +UTC enforces this standard timezone. +
Tile's age This age is used to decided wether or not a new request to tile server must be done. Changing this value, you will increase or decrese the network load.
-
Default maplayer directory +
Default map layer directory This property sets the default directory of the tiles cache. This value is used when you create a new map layer. @@ -1709,6 +2251,16 @@ Generally if you have a system with lots of memory it's recommended to increase
KML Export Units Allows setting the units used when saved as the KML file type, such as Metric or Statue units
+
GPX Track Order + + 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. + +
+
GPX Waypoint Symbols +Some GPS devices require waypoint symbols to be in a particular case. +E.g. On a Garmin Oregon 450 they must be in Title Case to be recognized. +
Image Viewer (Not Windows) Allows setting the program used to view images associated with Waypoints. By default this is set to xdg-open which should open the system's default image viewer, however this can be overridden with this setting. @@ -1722,6 +2274,14 @@ Generally if you have a system with lots of memory it's recommended to increase Some other user defined program
+
GPSBabel +This allows setting the specific location of GPSBabel. +&appname; will need to be restarted for this setting to take effect. +
+
Auto Read World Files +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. +The associated file is based on filename patterns; e.g. if the image is filename.jpg - then the world file may be filename.jpgw or filename.jgw +
OpenStreetMap Traces @@ -1735,19 +2295,99 @@ Your OSM password will be stored in plain text.
+
Mapnik + +If any changes to these settings are made, you will need to restart &appname; to make them be applied. + + +
Plugins Directory +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. +
+
Fonts Directory + +The location of fonts for use with Mapnik. Normally it is best to simply use the System's font directory. + +
+
Recurse Fonts Directory +Load fonts in any sub-directories of the main font directory. +
+
Rerender Timeout +The time in hours before any tile is rerendered. +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. +
+
CartoCSS +This allows setting the specific location of the carto executable. +
+
+
Routing
Routing engine You can select the routing engine used by default, ie by features that do not propose a live selection, like .
+
Startup +Naturally since these preferences effect the startup, the values will not be used until &appname; is restarted. +
Restore Window Setup +When this is enabled, the main window size and layout (such as whether the statusbar or layers panel are shown) is restored to the values from last use. +
+
Default Map Layer +When this is enabled, a map layer is automatically added whenever &appname; is opened and a &appname; file is not to be loaded. +The map layer used is defined by the map layer's default values. +
+
Startup Method +Enables selection of how the startup position should be determined. + +Home Location (default) - Position as set by the Set the Default Location +Last Location - Uses the last position viewed on the viewport +Specified File - Load the file as specified below +Auto Location - Use the web service hostip.info to attempt to determine your location via IP lookup + +
+
Startup File +Loads this specified file when the Startup method is set to Specified File +
+
Check For New Version +Periodically (no more than once every 14 days), check to see if there is a new version of &appname; available. +
+
+ +
Toolbar +
Append to Menu +Allows setting the toolbar on the same vertical space as the menu, thus increasing vertical space for the map. +
+
Icon Size +Allows configuration of the icon size, including overiding the system's default preference to the setting desired just for &appname; +
+
Icon Style +Allows configuration of the icon style, including overiding the system's default preference to the setting desired just for &appname; +
+
Customize +Opens the Customize Toolbar dialog. +From this dialog the items in the toolbar can be added, removed and reordered. Reordering of items is performed by drag and drop. +
+Customize Toolbar dialog + + + +
+
+
+
Howto's
Getting Started -To quickly get started using &appname;, follow these instructions. +&appname; from version 1.5 has several features to ease the start up process. +On the very first run, you will be asked if you want to enable these features which make use of an Internet connection. +If you select no or you have upgraded from an earlier version you can choose to enable any of the startup options via the . + + +Some other general use cases for using &appname;, are as follows:
Go to an area of interest @@ -1870,7 +2510,7 @@ Your tracks will now be drawn over the map.
From 1st startup to GPS track (including offline maps) The first you'll see is an empty map, because &appname; in its default configuration will download maps only on demand. -Before fetching unneeded data, one can position to a location of interest, e.g. Stuttgart: ViewGo to Location, enter 'Stuttgart'. +Before fetching unneeded data, one can position to a location of interest, e.g. Stuttgart: ViewGo to Location, enter Stuttgart.
Fetching the maps @@ -2062,7 +2702,7 @@ This feature can be really useful for checking existing data before uploading ne OSM traces... . Each request can get up to 5,000 points. -The dialog box allows setting which group of 5,000 points to get. These groups are known as 'Page Numbers' which start at 0. +The dialog box allows setting which group of 5,000 points to get. These groups are known as Page Numbers which start at 0. Increasing the page number parameter allows one to request the subsequent sets of point groups. @@ -2281,9 +2921,9 @@ Accept: */* You can find more examples in the documentation part of the distribution. -
+
Map Source - It is possible to add new map's sources. The file is ~/.viking/maps.xml for UNIX like systems and C:\Documents and Settings\username\.viking\maps.xml on Windows XP. + It is possible to add new map's sources. The file is ~/.viking/maps.xml for UNIX like systems, C:\Documents and Settings\username\.viking\maps.xml on Windows XP or C:\Users\username\.viking\maps.xml on Windows 7 onwards. An example of the file is in the distribution doc/examples/maps.xml. Further examples and values are online in the Maps Wiki The VikSlippyMapSource allows to declare any map's source working like OpenStreetMap. It supports the following properties: @@ -2292,6 +2932,10 @@ Accept: */* id this is an integer and should be unique as it used to identify the map source + + name + a string (should be unique) that is used for the OSM style cache directory name when the Map Cache directory is the default (~/.viking-maps) + label the text displayed in the map's source selection dialog @@ -2302,47 +2946,148 @@ Accept: */* url - 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") + 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") + + + zoom-min (optional) + The minimum zoom value supported by the tile server. The Default is 0 if not specified. + + + zoom-max (optional) + + The maximum zoom value supported by the tile server. The Default is 18 if not specified. + See Zoom Levels + + + + lat-min (optional) + The minimum latitude value in degrees supported by the tile server. The Default is -90 degrees if not specified. + + + lat-max (optional) + The maximum latitude value in degrees supported by the tile server. The Default is 90 degrees if not specified. + + + lon-min (optional) + The minimum longitude value in degrees supported by the tile server. The Default is -180 degrees if not specified. + + + lon-max (optional) + The maximum longitude value in degrees supported by the tile server. The Default is 180 degrees if not specified. + + + file-extension (optional) + + The file extension of the files on disk. The default is .png + If the tile source URL ends in something other than .png, then this parameter will need to match it. + 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 .png.tile + The file types actually usable are those supported by GDK Pixbuf Library, which includes at least PNG and JPEG. + Remember to include the beginning '.' when specifying this parameter. + + + + use-direct-file-access (optional) + + Only use files on disk. The default is FALSE + This can also be useful for tilesets already on disk as it will avoid attempting to download any tiles. + Thus with this type the hostname and url parameters are not necessary and are ignored. + + + + switch-xy (optional) + + Swap the X,Y values around in the URL parametrized ordering. + The default is false. + + + + check-file-server-time (optional) + + Sends the timestamp of the tile to the server, so the server can decide whether it should send a new tile or not. + The default is false. + + + + use-etag (optional) + + Use and compare the ETag value in determining whether to download a newer tile. The default is false. + 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. + - The VikTmsMapSource allows to declare any TMS service. It supports the following properties: + The VikTmsMapSource allows to declare any TMS service. It supports the following properties (as per VikSlippyMapSource above): - id - this is an integer and should be unique as it used to identify the map source + id - label - the text displayed in the map's source selection dialog + label - hostname - the server's hostname (eg. "tile.openstreetmap.org") + hostname - url - 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") + url + + + check-file-server-time (optional) + + + zoom-min (optional) + + + zoom-max (optional) + + + lat-min (optional) + + + lat-max (optional) + + + lon-min (optional) + + + lon-max (optional) - The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties: + The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties (as per VikSlippyMapSource above): - id - this is an integer and should be unique as it used to identify the map source + id - label - the text displayed in the map's source selection dialog + label - hostname - the server's hostname (eg. "tile.openstreetmap.org") + hostname - url - 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") + url + + + check-file-server-time (optional) + + + zoom-min (optional) + + + zoom-max (optional) + + + lat-min (optional) + + + lat-max (optional) + + + lon-min (optional) + + + lon-max (optional) @@ -2416,6 +3161,59 @@ Accept: */*
+
+ Routing engine + It is possible to declare new routing engines. The file is ~/.viking/routing.xml. + An example of the file in the distribution doc/examples/routing.xml. + The VikRoutingWebEngine allows to declare a routing engine available via HTTP. + The related properties are: + + + id + a string, should be unique as it used to identify the routing engine + + + label + the text displayed in the menu entry + + + url-base + the base URL of the web service (eg. "http://hostname/service?") + + + url-start-ll + the part of the URL setting the starting point location, parametrized in the spirit of C printf format, with 2 "%s" for coordinates (eg. "&start=%s,%s") + + + url-stop-ll + the part of the URL setting the end point location, parametrized in the spirit of C printf format, with 2 "%s" for coordinates (eg. "&stop=%s,%s") + + + url-via-ll + the part of the URL setting via point location, parametrized in the spirit of C printf format, with 2 "%s" for coordinates (eg. "&via=%s,%s") + + + url-start-dir + the part of the URL setting the starting point location for direction based routing, parametrized in the spirit of C printf format, with one "%s" for direction (eg. "&start=%s") + (Optional) + + + url-stop-dir + the part of the URL setting the end point location for direction based routing, parametrized in the spirit of C printf format, with one "%s" for direction (eg. "&start=%s") + (Optional) + + + referer + an URL to serve as referer for the HTTP request (eg. "http://hostname/") + + + follow-location + the max depth of recursive redirections + + + +
+
Remote File Datasources It is possible to add web references expected to return a file which can then be opened directly or converted via GPSBabel. @@ -2446,6 +3244,7 @@ Accept: */* A = center lAtitude of the current view O = center lOngitude of the current view Z = OSM Zoom value of the current view. See Zoom Levels + S = A user specified input string requested from the user via a dialog box Thus for the url example above then the format code should be AO @@ -2454,7 +3253,21 @@ Accept: */* This value is passed on for the -i parameter in interfacing with GPSBabel. If it is not defined then the returned file is interpreted internally as a GPX file. - Possible values such as 'kml', 'mapsource' etc.. can be used. See GPSBabel File Formats for the full list. + Possible values such as 'kml', 'mapsource' etc.. can be used. See GPSBabel File Formats for the full list. + + + + babel_filter_args + + This value is passed on for the filter arguments interfacing with GPSBabel. + E.g. "-x nuketypes,routes" can be used to filter all routes from the results. + + + + input_label + + This value is used when requesting input from the user. + It is the label of the text input box. @@ -2468,19 +3281,143 @@ Accept: */* The XDG_DATA_HOME environment variable is also used (if set) to look for these extension files.
+ +
+ Miscellaneous Settings + Various individual values are automatically saved between &app; sessions in the ~/.viking/viking.ini file. + This file is not intended to be manually edited, but since it is a plain text file it can be changed if desired. + Some values in this file are read only, 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. + Here is the list of the read only keys and their default values. + + + maps_max_tiles=1000 + + + maps_min_shrinkfactor=0.0312499 + + + maps_max_shrinkfactor=8.0000001 + + + maps_real_min_shrinkfactor=0.0039062499 + + + maps_scale_inc_down=4 + + + maps_scale_inc_up=2 + + + maps_scale_smaller_zoom_first=true + + + mapnik_buffer_size=128 (in pixels) + + + background_max_threads=10 + + + background_max_threads_local=Number of CPUs + + + window_menubar=true + + + window_copy_centre_full_format=false + + + version_check_period_days=14 + + + trackwaypoint_start_end_distance_diff=100.0 + + + gps_statusbar_format=GSA + This string is in the Message Format Code + + + trkpt_selected_statusbar_format=KEATDN + This string is in the Message Format Code + + + utils_nearest_tz_factor=1.0 + + + viewport_history_size=20 + + + viewport_history_diff_dist=500 + In metres. + + Go Back or Go Forward requests over this range from the last history location will move back to that position. + If within this range it will skip over this location and move on to the next saved history location. + + + + external_diary_program=rednotebook + Or in Windows it uses C:/Progra~1/Rednotebook/rednotebook.exe - This string value must use Unix separators and not have spaces. + + + external_astro_program=stellarium + Or in Windows use C:/Progra~1/Stellarium/stellarium.exe - This string value must use Unix separators and not have spaces. + Further note due to this Bug in Stellarium means this does not actually work. You will need to reference a shortcut, rather than the executable directly. + + + +
+ Message Format Code + Currently for ease of implementation the message format code is a string of characters. + Each character represents what should be inserted in relation to a Trackpoint. + One day it might evolve into something more user friendly with a frontend to control it, perhaps allowing arbitary text too. However for now at least some control is offered :) + + + + Character Code + + G = Some text to display at the start of the message - GPSD + K = Some text to display at the start of the message - Trkpt + A = Altitude of a Trackpoint + S = Speed of a Trackpoint + B = Vertical Speed (Climb) + C = Course of a Trackpoint + L = Location of a Trackpoint + T = Time of a Trackpoint + M = Time diff of a Trackpoint from the previous trackpoint + X = Number of satellites used in the trackpoint fix + D = Distance of the trackpoint from the start of a track (following along the track) + F = Distance of the trackpoint from the finish (end) of a track (following along the track) + P = Distance difference of the trackpoint from the previous trackpoint + N = Name of track to which the trackpoint belongs + E = Name of the trackpoint + + + + Output Notes + + If the output has * after it, then the value has been calculated via interpolation (such as speed when the Trackpoint does not contain a speed value). + If the output has ** after it, then difficulties were encountered in trying to work the value so probably a default of 0 will be shown. + + + + +
+ +
+ +
+ Keyboard Shortcuts (Accelerator) Settings + This is held in the file ~/.viking/keys.rc + It is in the standard GTK Accelerator map format. Values are automatically read in and saved between &app; sessions. + This file is not intended to be manually edited, but since it is a plain text file it can be changed if desired. +
+
-
Dependencies -gpsbabel -&appname; uses GPSBabel to convert data. - -unbuffer (optional) -&appname; uses unbuffer command to optimize conversion calls. - -gpsd (optional - but not <trademark>Windows</trademark>) -&appname; can use gpsd to get the current location. - -
+ + + + +