X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/29c93cc57d2f7715c58b4e577440bc580a47bd8a..a2d207d7200a11313bd98202a5be081bc92c70dc:/doc/viking.xml
diff --git a/doc/viking.xml b/doc/viking.xml
index caa48569..0f7689e7 100644
--- a/doc/viking.xml
+++ b/doc/viking.xml
@@ -30,10 +30,10 @@ and docbook-xsl in your Build-Depends control field.
Ralf">
Meyer">
- 2012-11-24">
+ 2013-04-08">
-
+
1">
@@ -64,7 +64,7 @@ and docbook-xsl in your Build-Depends control field.
Guilhem Bonnefille
- 2012
+ 2013
Rob Norris
&dhdate;
@@ -294,10 +294,6 @@ and docbook-xsl in your Build-Depends control field.
The VikWebtoolCenter allows to declare any Webtool using a logic based on center coordinates and zoom level value.
The related properties are:
-
- id
- this is an integer and should be unique as it used to identify the tool
-
label
the text displayed in the menu entry
@@ -312,16 +308,57 @@ and docbook-xsl in your Build-Depends control field.
The related properties are:
- id
- this is an integer and should be unique as it used to identify the tool
+ label
+ the text displayed in the menu entry
+
+
+ url
+ the parametrized address of the tile, in the spirit of C printf format, with 4 "%s" fields for left, right, bottom and top (eg. "http://hostname:8111/load_and_zoom?left=%s&right=%s&bottom=%s&top=%s")
+
+
+
+
+
+ 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.
+ The file is ~/.viking/datasources.xml.
+ An example of the file is in the source distribution doc/examples/datasources.xml.
+ The VikWebtoolDatasource allows to declare any URL using logic based on coordinates.
+ The related properties are:
+
label
the text displayed in the menu entry
url
- the parametrized address of the tile, in the spirit of C printf format, with 4 "%s" fields for left, right, bottom and top (eg. "http://hostname:8111/load_and_zoom?left=%s&right=%s&bottom=%s&top=%s")
+
+ 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 order and meaning of these parameters is given by the url_format_code below
+
+
+
+ url_format_code
+
+ A string describing the parametrized URL substitution parameters, each character represents how to translate each term.
+ B = Bottom of the current view i.e. minimum latitude
+ L = Left of the current view i.e. minimum longitude
+ T = Top of the current view i.e. maximum latitude
+ R = Right of the current view i.e. maximum longitude
+ 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
+ Thus for the url example above then the format code should be AO
+
+
+
+ file_type
+
+ 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.
+
@@ -353,12 +390,33 @@ and docbook-xsl in your Build-Depends control field.
See previous section for details.
+
+ ~/.viking/datasources.xml
+
+ File containing definition of remote file datasources.
+ See previous section for details.
+
+
~/.viking/viking.prefs
Preferences for &dhpackage;.
+
+ ~/.viking/viking_layer_defaults.ini
+
+ Layer default values for &dhpackage;.
+
+
+
+ ~/.viking/viking.ini
+
+ Values for &dhpackage; automatically saved between sessions.
+ Not generally intended to be manually edited.
+ However some finer control of default internal values can be set.
+
+
~/.viking/cookies.txt
@@ -375,6 +433,7 @@ and docbook-xsl in your Build-Depends control field.
Extension files (maps.xml,
goto_tools.xml,
+ datasources.xml,
external_tools.xml)
are also searched in /etc/viking and
/usr/share/viking directories (or related in your system).