Support Waypoint timestamps in .vik files.

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

diff --git a/doc/viking.xml b/doc/viking.xml
index d3bdd5cb15d0d0940b913aef25be24b58d909653..0f7689e71454f81b4b708b0a649701b4d79d4649 100644 (file)
--- a/doc/viking.xml
+++ b/doc/viking.xml
@@ -64,7 +64,7 @@ and docbook-xsl in your Build-Depends control field.
       <holder>Guilhem Bonnefille</holder>
     </copyright>
     <copyright>
       <holder>Guilhem Bonnefille</holder>
     </copyright>
     <copyright>

-      <year>2012</year>
+      <year>2013</year>

       <holder>Rob Norris</holder>
     </copyright>
     &dhdate;
       <holder>Rob Norris</holder>
     </copyright>
     &dhdate;


@@ -308,14 +308,57 @@ and docbook-xsl in your Build-Depends control field.
         <para>The related properties are:
           <variablelist>
             <varlistentry>
         <para>The related properties are:
           <variablelist>
             <varlistentry>

+              <term>label</term>
+              <listitem><para>the text displayed in the menu entry</para></listitem>

             </varlistentry>
             </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 left, right, bottom and top (eg. "http://hostname:8111/load_and_zoom?left=%s&amp;right=%s&amp;bottom=%s&amp;top=%s")</para></listitem>
+            </varlistentry>
+          </variablelist>
+        </para>
+      </formalpara>
+
+      <formalpara>
+        <title>Remote File Datasources</title>
+        <para>It is possible to add web references expected to return a file which can then be opened directly or converted via GPSBabel.</para>
+        <para>The file is <filename>~/.viking/datasources.xml</filename>.</para>
+        <para>An example of the file is in the source distribution <filename>doc/examples/datasources.xml</filename>.</para>
+        <para>The VikWebtoolDatasource allows to declare any URL using logic based on coordinates.</para>
+        <para>The related properties are:
+          <variablelist>

             <varlistentry>
               <term>label</term>
               <listitem><para>the text displayed in the menu entry</para></listitem>
             </varlistentry>
             <varlistentry>
               <term>url</term>
             <varlistentry>
               <term>label</term>
               <listitem><para>the text displayed in the menu entry</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 left, right, bottom and top (eg. "http://hostname:8111/load_and_zoom?left=%s&amp;right=%s&amp;bottom=%s&amp;top=%s")</para></listitem>
+              <listitem>
+                <para>the parametrized URL to open in the spirit of C printf format, with up to 7 "%s" values. e.g. <literal>http://hostname/getfile?lat=%s&amp;lon=%s</literal></para>
+                <para>The order and meaning of these parameters is given by the url_format_code below</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>url_format_code</term>
+              <listitem>
+                <para>A string describing the parametrized URL substitution parameters, each character represents how to translate each term.</para>
+                <para>B = Bottom of the current view i.e. minimum latitude</para>
+                <para>L = Left of the current view i.e. minimum longitude</para>
+                <para>T = Top of the current view i.e. maximum latitude</para>
+                <para>R = Right of the current view i.e. maximum longitude</para>
+                <para>A = center lAtitude of the current view</para>
+                <para>O = center lOngitude of the current view</para>
+                <para>Z = OSM Zoom value of the current view. See <ulink url="http://wiki.openstreetmap.org/wiki/Zoom_levels">Zoom Levels</ulink></para>
+                <para>Thus for the url example above then the format code should be <emphasis>AO</emphasis></para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>file_type</term>
+              <listitem>
+                <para>This value is passed on for the -i parameter in interfacing with GPSBabel.</para>
+                <para>If it is not defined then the returned file is interpreted internally as a GPX file.</para>
+                <para>Possible values such as 'kml', 'mapsource' etc.. can be used. See <ulink url="http://www.gpsbabel.org/capabilities.html">GPSBabel File Formats</ulink> for the full list.</para>
+              </listitem>

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


@@ -347,6 +390,13 @@ and docbook-xsl in your Build-Depends control field.
           <para>See previous section for details.</para>
        </listitem>
       </varlistentry>
           <para>See previous section for details.</para>
        </listitem>
       </varlistentry>

+      <varlistentry>
+        <term><filename>~/.viking/datasources.xml</filename></term>
+        <listitem>
+          <para>File containing definition of remote file datasources.</para>
+          <para>See previous section for details.</para>
+       </listitem>
+      </varlistentry>

       <varlistentry>
         <term><filename>~/.viking/viking.prefs</filename></term>
         <listitem>
       <varlistentry>
         <term><filename>~/.viking/viking.prefs</filename></term>
         <listitem>


@@ -359,6 +409,14 @@ and docbook-xsl in your Build-Depends control field.
           <para>Layer default values for &dhpackage;.</para>
         </listitem>
       </varlistentry>
           <para>Layer default values for &dhpackage;.</para>
         </listitem>
       </varlistentry>

+      <varlistentry>
+        <term><filename>~/.viking/viking.ini</filename></term>
+        <listitem>
+          <para>Values for &dhpackage; automatically saved between sessions.</para>
+          <para>Not generally intended to be manually edited.</para>
+         <para>However some finer control of default internal values can be set.</para>
+        </listitem>
+      </varlistentry>

       <varlistentry>
         <term><filename>~/.viking/cookies.txt</filename></term>
         <listitem>
       <varlistentry>
         <term><filename>~/.viking/cookies.txt</filename></term>
         <listitem>


@@ -375,6 +433,7 @@ and docbook-xsl in your Build-Depends control field.
 
        <para>Extension files (<filename>maps.xml</filename>,
        <filename>goto_tools.xml</filename>,
 
        <para>Extension files (<filename>maps.xml</filename>,
        <filename>goto_tools.xml</filename>,

+       <filename>datasources.xml</filename>,

        <filename>external_tools.xml</filename>)
        are also searched in <filename>/etc/viking</filename> and
        <filename>/usr/share/viking</filename> directories (or related in your system).</para>
        <filename>external_tools.xml</filename>)
        are also searched in <filename>/etc/viking</filename> and
        <filename>/usr/share/viking</filename> directories (or related in your system).</para>