Add OSM Metatiles as a Map Type so one can read metatiles directly from disk.

[andy/viking.git] / help / C / viking.xml

diff --git a/help/C/viking.xml b/help/C/viking.xml
index fda9aad110c14900202f3121fac2fcd543262196..b918ea94d67e689d8ba39112e4c912b67de99e64 100644 (file)
--- a/help/C/viking.xml
+++ b/help/C/viking.xml
@@ -334,8 +334,17 @@ Other function keys control turn on/off visibility of various elements:
 </itemizedlist>
 <para>
 Standard shortcuts are provided for normal GUI operations: such as creating new files, opening, saving and exitting.
 </itemizedlist>
 <para>
 Standard shortcuts are provided for normal GUI operations: such as creating new files, opening, saving and exitting.

-Then there are shortcuts specific to &appname; to switch projection modes, zoom in/out, create layers and switch the active tool mode.
-For these combinations see the menu entry themselves.
+Then there are shortcuts specific to &appname; to switch projection modes, zoom in/out, create layers,switch the active tool mode and move the map:
+<itemizedlist>
+<listitem><para><keycap>Ctrl+Up</keycap> Pan the viewport North</para></listitem>
+<listitem><para><keycap>Ctrl+Right</keycap> Pan the viewport East</para></listitem>
+<listitem><para><keycap>Ctrl+Down</keycap> Pan the viewport South</para></listitem>
+<listitem><para><keycap>Ctrl+Left</keycap> Pan the viewport West</para></listitem>
+<listitem><para><keycap>Ctrl+Keypad+</keycap> Zoom In</para></listitem>
+<listitem><para><keycap>Ctrl+Keypad-</keycap> Zoom Out</para></listitem>
+<listitem><note><para>These work irrespective of the <xref linkend="tools"/> mode selected</para></note></listitem>
+</itemizedlist>
+For other combinations see the menu entry themselves.

 </para>
 </section>
 
 </para>
 </section>
 


@@ -2781,7 +2790,7 @@ Accept: */*
       <para>You can find more examples in the documentation part of the distribution.</para>
       <section>
         <title>Map Source</title>
       <para>You can find more examples in the documentation part of the distribution.</para>
       <section>
         <title>Map Source</title>

-        <para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename> for <trademark>UNIX</trademark> like systems and <filename>C:\Documents and Settings\<replaceable>username</replaceable>\.viking\maps.xml</filename> on <trademark>Windows XP</trademark>.</para>
+        <para>It is possible to add new map's sources. The file is <filename>~/.viking/maps.xml</filename> for <trademark>UNIX</trademark> like systems, <filename>C:\Documents and Settings\<replaceable>username</replaceable>\.viking\maps.xml</filename> on <trademark>Windows XP</trademark> or <filename>C:\Users\<replaceable>username</replaceable>\.viking\maps.xml</filename> on <trademark>Windows 7</trademark> onwards.</para>

         <para>An example of the file is in the distribution <filename>doc/examples/maps.xml</filename>. Further examples and values are online in the <ulink url="http://sourceforge.net/apps/mediawiki/viking/index.php?title=Maps">Maps Wiki</ulink></para>
 
         <para>The <classname>VikSlippyMapSource</classname> allows to declare any map's source working like OpenStreetMap. It supports the following properties:
         <para>An example of the file is in the distribution <filename>doc/examples/maps.xml</filename>. Further examples and values are online in the <ulink url="http://sourceforge.net/apps/mediawiki/viking/index.php?title=Maps">Maps Wiki</ulink></para>
 
         <para>The <classname>VikSlippyMapSource</classname> allows to declare any map's source working like OpenStreetMap. It supports the following properties:


@@ -2790,6 +2799,10 @@ Accept: */*
               <term>id</term>
               <listitem><para>this is an integer and should be unique as it used to identify the map source</para></listitem>
             </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>name</term>
+              <listitem><para>a string (should be unique) that is used for the OSM style cache directory name when the Map Cache directory is the default (<filename>~/.viking-maps</filename>)</para></listitem>
+            </varlistentry>

             <varlistentry>
               <term>label</term>
               <listitem><para>the text displayed in the map's source selection dialog</para></listitem>
             <varlistentry>
               <term>label</term>
               <listitem><para>the text displayed in the map's source selection dialog</para></listitem>


@@ -2802,49 +2815,86 @@ Accept: */*
               <term>url</term>
               <listitem><para>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")</para></listitem>
             </varlistentry>
               <term>url</term>
               <listitem><para>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")</para></listitem>
             </varlistentry>

+            <varlistentry>
+              <term>zoom-min (optional)</term>
+              <listitem><para>The minimum zoom value supported by the tile server. The Default is 0 if not specified.</para></listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>zoom-max (optional)</term>
+              <listitem>
+                 <para>The maximum zoom value supported by the tile server. The Default is 18 if not specified.</para>
+                 <para>See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>file-extension (optional)</term>
+              <listitem>
+                <para>The file extension of the files on disk. The default is <emphasis>.png</emphasis></para>
+                <para>If the tile source URL ends in something other than .png, then this parameter will need to match it.</para>
+                <para>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 <emphasis>.png.tile</emphasis></para>
+                <note><para>The file types actually usable are those supported by GDK Pixbuf Library, which includes at least PNG and JPEG.</para></note>
+                <note><para>Remember to include the beginning <emphasis>'.'</emphasis> when specifying this parameter.</para></note>
+              </listitem>
+            </varlistentry>

             <varlistentry>
               <term>switch-xy (optional)</term>
             <varlistentry>
               <term>switch-xy (optional)</term>

-              <listitem><para>Swap the X,Y values around in the URL parametrized ordering.</para></listitem>
+              <listitem>
+                <para>Swap the X,Y values around in the URL parametrized ordering.</para>
+                <para>The default is false.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>check-file-server-time (optional)</term>
+              <listitem>
+                <para>Sends the timestamp of the tile to the server, so the server can decide whether it should send a new tile or not.</para>
+                <para>The default is false.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>use-etag (optional)</term>
+              <listitem>
+                <para>Use and compare the <ulink url="http://en.wikipedia.org/wiki/HTTP_ETag">ETag</ulink> value in determining whether to download a newer tile. The default is false.</para>
+                <para>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.</para>
+              </listitem>

             </varlistentry>
           </variablelist>
         </para>
             </varlistentry>
           </variablelist>
         </para>

-        <para>The <classname>VikTmsMapSource</classname> allows to declare any TMS service. It supports the following properties:
+        <para>The <classname>VikTmsMapSource</classname> allows to declare any TMS service. It supports the following properties (as per VikSlippyMapSource above):

           <variablelist>
             <varlistentry>
               <term>id</term>
           <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>
             </varlistentry>
             <varlistentry>
               <term>label</term>

-              <listitem><para>the text displayed in the map's source selection dialog</para></listitem>

             </varlistentry>
             <varlistentry>
               <term>hostname</term>
             </varlistentry>
             <varlistentry>
               <term>hostname</term>

-              <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>

             </varlistentry>
             <varlistentry>
               <term>url</term>
             </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>
+            <varlistentry>
+              <term>check-file-server-time (optional)</term>

             </varlistentry>
           </variablelist>
         </para>
             </varlistentry>
           </variablelist>
         </para>

-        <para>The <classname>VikWmscMapSource</classname> allows to declare any WMS or WMS-C service. It supports the following properties:
+        <para>The <classname>VikWmscMapSource</classname> allows to declare any WMS or WMS-C service. It supports the following properties  (as per VikSlippyMapSource above):

           <variablelist>
             <varlistentry>
               <term>id</term>
           <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>
             </varlistentry>
             <varlistentry>
               <term>label</term>

-              <listitem><para>the text displayed in the map's source selection dialog</para></listitem>

             </varlistentry>
             <varlistentry>
               <term>hostname</term>
             </varlistentry>
             <varlistentry>
               <term>hostname</term>

-              <listitem><para>the server's hostname (eg. "tile.openstreetmap.org")</para></listitem>

             </varlistentry>
             <varlistentry>
               <term>url</term>
             </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>
+            <varlistentry>
+              <term>check-file-server-time (optional)</term>

             </varlistentry>
           </variablelist>
         </para>
             </varlistentry>
           </variablelist>
         </para>