Merge branch 'i18n-launchpad'

[andy/viking.git] / doc / viking.xml

diff --git a/doc/viking.xml b/doc/viking.xml
index f510d7e47d9ff5545a62d466e6bb49ce5bf067c5..94051b83faa6aeb47e68215c7d11297c66874497 100644 (file)
--- a/doc/viking.xml
+++ b/doc/viking.xml
@@ -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;
@@ -181,8 +181,7 @@ and docbook-xsl in your Build-Depends control field.
         <title>Map Source</title>
         <para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename>.</para>
         <para>An example of the file in the distribution <filename>doc/examples/maps.xml</filename>.</para>
-        <para>Currently, there is a single object class available: VikSlippyMapSource. Such feature allows to declare any map's source working like OpenStreetMap.</para>
-        <para>The related properties are:
+        <para>The VikSlippyMapSource allows to declare any map's source working like OpenStreetMap. It supports the following properties:
           <variablelist>
             <varlistentry>
               <term>id</term>
@@ -202,6 +201,46 @@ 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>
+              <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 4 "%s" fields for bounding box coordinates (eg. "/coord=%s,%s,%s,%s")</para></listitem>
+            </varlistentry>
+          </variablelist>
+        </para>
       </formalpara>
 
       <formalpara>
@@ -310,11 +349,6 @@ and docbook-xsl in your Build-Depends control field.
     </variablelist>
 
   </refsect1>
-  <refsect1>
-    <title>SEE ALSO</title>
-
-    <para>viking-remote (1).</para>
-  </refsect1>
   <refsect1>
     <title>AUTHOR</title>