]> git.street.me.uk Git - andy/viking.git/commitdiff
Add documentation for generic TMS map source
authorGuilhem Bonnefille <guilhem.bonnefille@gmail.com>
Tue, 30 Nov 2010 15:56:45 +0000 (16:56 +0100)
committerGuilhem Bonnefille <guilhem.bonnefille@gmail.com>
Tue, 30 Nov 2010 15:56:45 +0000 (16:56 +0100)
Support for TMS and WMS-C were two long living patches on my own repo.
I don't know how, but it seems that I lost part of the documentation
when applying these patches on master.

doc/viking.xml
help/C/viking.xml

index f4777614a83dd12884f6f80b29950df5e8cc484c..51389284a85944d1a4a9a2a4346343f0a4936859 100644 (file)
@@ -44,7 +44,7 @@ and docbook-xsl in your Build-Depends control field.
   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
 ]>
 
-<refentry>
+<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
   <refentryinfo>
     <address>
       &dhemail;
@@ -201,6 +201,26 @@ and docbook-xsl in your Build-Depends control field.
             </varlistentry>
           </variablelist>
         </para>
+        <para>The VikTmsMapSource allows to declare any TMS service. It supports the following properties:
+          <variablelist>
+            <varlistentry>
+              <term>id</term>
+              <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>label</term>
+              <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>hostname</term>
+              <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>url</term>
+              <listitem><para>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")</para></listitem>
+            </varlistentry>
+          </variablelist>
+        </para>
         <para>The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties:
           <variablelist>
             <varlistentry>
index dc9a31b3dbcbc38b63e60fae22800ea885c43911..c8f696014f0abafb3afbcc2aeb22ee3b319ef746 100644 (file)
@@ -980,6 +980,26 @@ to write the waypoints to this file.
             </varlistentry>
           </variablelist>
         </para>
+        <para>The VikTmsMapSource allows to declare any TMS service. It supports the following properties:
+          <variablelist>
+            <varlistentry>
+              <term>id</term>
+              <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>label</term>
+              <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>hostname</term>
+              <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>url</term>
+              <listitem><para>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")</para></listitem>
+            </varlistentry>
+          </variablelist>
+        </para>
         <para>The VikWmscMapSource allows to declare any WMS or WMS-C service. It supports the following properties:
           <variablelist>
             <varlistentry>