X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/f41c804a5210c37b0c950eb6ad6ae8addf08fd27..99f0d7dfeb78fda657342719efcc0d8b5963bf1e:/help/C/viking.xml diff --git a/help/C/viking.xml b/help/C/viking.xml index 088a2256..b918ea94 100644 --- a/help/C/viking.xml +++ b/help/C/viking.xml @@ -2790,7 +2790,7 @@ 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: @@ -2799,6 +2799,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 @@ -2811,49 +2815,86 @@ 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 + + + + 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. + + 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 label - the text displayed in the map's source selection dialog hostname - the server's hostname (eg. "tile.openstreetmap.org") 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") + + + check-file-server-time (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 label - the text displayed in the map's source selection dialog hostname - the server's hostname (eg. "tile.openstreetmap.org") 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") + + + check-file-server-time (optional)