X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/0d71f23268fac4677bbaa275f30e27e21255f237..44d6bd848a2837d9c8d2a6097a8ee16d282e8596:/help/C/viking.xml?ds=sidebyside diff --git a/help/C/viking.xml b/help/C/viking.xml index 8c53fde4..423ee6c4 100644 --- a/help/C/viking.xml +++ b/help/C/viking.xml @@ -3,9 +3,9 @@ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ Viking"> - - - + + + ]> +
Layer Operations
Download Missing Onscreen Maps @@ -1629,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). @@ -1669,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. @@ -1708,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 @@ -1733,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 @@ -2003,7 +2116,7 @@ For Linux you can override this with the setting in the Georef Map Layer Tools You must have a Map Layer selected to use these tools. @@ -2176,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. @@ -2189,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 @@ -2202,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 . @@ -2234,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 + + + +
+
+
+ @@ -2779,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: @@ -2790,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 @@ -2802,49 +3014,146 @@ Accept: */* url 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. + + 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) @@ -2986,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 @@ -3001,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 @@ -3012,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. + +
@@ -3031,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 @@ -3043,9 +3373,24 @@ 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 @@ -3080,6 +3425,15 @@ Accept: */* 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. +
@@ -3096,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 @@ -3117,22 +3473,22 @@ 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. - -
+ + +