X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/a77c32c837b9c9bb433e28aab0f4f030e895cdca..44d6bd848a2837d9c8d2a6097a8ee16d282e8596:/help/C/viking.xml?ds=inline diff --git a/help/C/viking.xml b/help/C/viking.xml index 0c314fc9..423ee6c4 100644 --- a/help/C/viking.xml +++ b/help/C/viking.xml @@ -1,11 +1,11 @@ - Viking"> - - - + + + ]>
Print @@ -638,6 +704,7 @@ Layers supported by &appname; are: + For each layer there are a few standard options: @@ -754,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. @@ -864,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. @@ -922,7 +1020,7 @@ 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 +Sort. Gives the ability to sort the items in the treeview alphabetically or by date. Visibility. Offers options to quickly control the visibility of all items within the sublayer, as per
@@ -1216,6 +1314,20 @@ This is not available for routes, as they have no timestamps.
+
+Interpolate Times + +Trackpoint timestamps between the first and last points are calculated such that track is travelled at equal speed. +This is mostly useful when tracks don't have timestamps and you wish to recreate your trip (e.g. you've forgotten to turn on your GPS or the batteries have run out) +Thus edit the first and last trackpoints to set the approximate times of your trip and then use this to give approximate times along the track. +When used on tracks with timestamps this will overwrite the existing timestamps. + + + +This is not available for routes, as they have no timestamps. + + +
Export Track as GPX @@ -1313,6 +1425,11 @@ The record of the Google route is stored in the track's comment, so if the comme 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 +Also gives other options for handling multiple items: + +Sort. Gives the ability to sort the items in the treeview alphabetically or by date. +Visibility. Offers options to quickly control the visibility of all items within the sublayer, as per +
Waypoint Properties @@ -1472,31 +1589,74 @@ 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 @@ -1585,14 +1745,20 @@ Add a new layer of the selected type. The list within the treeview can be sorted. -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. + + +Generally it is not useful to sort the Top most layer. Sort is mainly intended for Aggregate groups of TrackWaypoint layers. + +
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. +You can also rearrange the columns via dragging the column header to the new location. This table may be invoked from a variety of different layer levels and will then list only the relevant tracks (and/or routes). @@ -1625,14 +1791,21 @@ Each entry in the track list can be selected and on mouse right click offers the 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. +Copy Data. Copy the data fields as text. + +If multiple entries are selected the only right click option is Copy Data. +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). +
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. +You can also rearrange the columns via dragging the column header to the new location. This table may be invoked from a variety of different layer levels and will then list only the relevant waypoints. @@ -1664,8 +1837,14 @@ Each entry in the list can be selected and on mouse right click offers these opt 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. +Copy Data. Copy the data fields as text. + +If multiple entries are selected the only right click option is Copy Data. +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). +
Visibility Options @@ -1689,31 +1868,9 @@ Tracks are searched first in preference over waypoints.
-
GeoRef Layer - -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. - -
Layer Operations -
Zoom to Fit Map - -Automatically set a zoom level to see the entire map coverage. - -
- -
Goto Map Center - -Center the viewport on this map. - - -
-
Export to World File - -Opens a file save dialog to save the scale and position information as a World File. - -
-
+ -
+
Coordinate Layer @@ -1762,6 +1919,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 @@ -1780,6 +1942,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 @@ -1851,6 +2019,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 @@ -1921,25 +2114,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. @@ -2084,12 +2261,18 @@ This feature is called Webtools. It is also known as Extern 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. @@ -2106,6 +2289,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. @@ -2119,6 +2312,35 @@ 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 +
+
+ +
Advanced +
Save File Reference Mode + + 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. + +
+
Ask for Name before Track Creation +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. +
+
Show Tooltip during Track Creation +A setting to control whether the tooltip with the cumulative track or route distance is shown when creating tracks and routes. +
+
The number of recent files + + The number of recent files shown in the FileOpen Recent File menu. + A value of -1 means all files. The new value applies to New Windows only (or on application restart). + +
OpenStreetMap Traces @@ -2132,6 +2354,40 @@ 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. +
+
Threads + + 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. + +
+
+
Routing
Routing engine You can select the routing engine used by default, ie by features that do not propose a live selection, like . @@ -2164,6 +2420,28 @@ Your OSM password will be stored in plain text.
+
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 + + + +
+
+
+
@@ -2709,9 +2987,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: @@ -2720,6 +2998,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 @@ -2730,47 +3012,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) @@ -2912,7 +3295,7 @@ Accept: */* url - the parametrized URL to open in the spirit of C printf format, with up to 7 "%s" values. e.g. http://hostname/getfile?lat=%s&lon=%s + the parametrized URL to open in the spirit of C printf format, with up to 9 "%s" values. e.g. http://hostname/getfile?lat=%s&lon=%s The order and meaning of these parameters is given by the url_format_code below @@ -2927,6 +3310,9 @@ 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 + P = selected Point's latitude + N = selected poiNt's longitude + 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 @@ -2938,6 +3324,20 @@ Accept: */* 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. + +
@@ -2957,6 +3357,10 @@ Accept: */* 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. + + layers_create_trw_auto_default=false + Create new TrackWaypoint layers without showing the layer properties dialog first. + maps_max_tiles=1000 @@ -2969,12 +3373,30 @@ Accept: */* 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 @@ -2989,6 +3411,29 @@ Accept: */* 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. +
@@ -3005,12 +3450,14 @@ Accept: */* 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 @@ -3026,21 +3473,23 @@ Accept: */*
+
+
+ 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. - -
+ + + + +