]> git.street.me.uk Git - andy/viking.git/blobdiff - doc/viking.xml
Add a new webtool datasource to allow acquiring data from URLs that return a file.
[andy/viking.git] / doc / viking.xml
index 94051b83faa6aeb47e68215c7d11297c66874497..d3bdd5cb15d0d0940b913aef25be24b58d909653 100644 (file)
@@ -30,7 +30,10 @@ and docbook-xsl in your Build-Depends control field.
   <!ENTITY dhfirstname "<firstname>Ralf</firstname>">
   <!ENTITY dhsurname   "<surname>Meyer</surname>">
   <!-- Please adjust the date whenever revising the manpage. -->
-  <!ENTITY dhdate      "<date>2008-05-02</date>">
+  <!ENTITY dhdate      "<date>2013-04-08</date>">
+  <!-- Would be nice if the version could auto-update. -->
+  <!ENTITY dhsource      "Viking">
+  <!ENTITY dhversion     "1.4.1">
   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
        allowed: see man(7), man(1). -->
   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
@@ -44,6 +47,9 @@ and docbook-xsl in your Build-Depends control field.
   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
 ]>
 
+<reference>
+<title>&dhsource; &dhversion;</title>
+
 <refentry xmlns:xi="http://www.w3.org/2001/XInclude">
   <refentryinfo>
     <address>
@@ -57,12 +63,17 @@ and docbook-xsl in your Build-Depends control field.
       <year>2010</year>
       <holder>Guilhem Bonnefille</holder>
     </copyright>
+    <copyright>
+      <year>2012</year>
+      <holder>Rob Norris</holder>
+    </copyright>
     &dhdate;
   </refentryinfo>
   <refmeta>
     &dhucpackage;
-
     &dhsection;
+    <refmiscinfo CLASS="source">&dhsource;</refmiscinfo>
+    <refmiscinfo CLASS="version">&dhversion;</refmiscinfo>
   </refmeta>
   <refnamediv>
     <refname>&dhpackage;</refname>
@@ -101,22 +112,19 @@ and docbook-xsl in your Build-Depends control field.
     <title>DESCRIPTION</title>
 
     <para>
-  Viking is a free/open source program to manage GPS data. You can 
-  import and plot tracks and waypoints, show OpenStreetMap (OSM) maps and/or 
-  Terraserver maps under it, add coordinate lines, make new tracks 
-  and waypoints, hide different things, etc. It is written in C 
-  with the GTK+ 2 toolkit, available for Linux, other POSIX 
-  operating systems, and Windows, and is licensed under the GNU GPL. 
+      Viking is a program to manage GPS data.
     </para>
     <para>  
-  Homepage: <ulink type="http" url="http://viking.sf.net">http://viking.sf.net</ulink>
+      You can import and plot tracks, routes and waypoints, show OpenStreetMap (OSM) maps and/or
+      Terraserver maps under it, add coordinate lines, make new tracks, routes and waypoints, hide different things, etc.
+      It is written in C with the GTK+ 2 toolkit, available for Linux, other POSIX operating systems and Windows.
     </para>
-
-    <para>This manual page was written for the &debian; distribution
-      because the original program does not have a manual page.
+    <para>  
+      Homepage: <ulink type="http" url="http://viking.sf.net">http://viking.sf.net</ulink>
+    </para>
+    <para>  
+      Viking is licensed under the GNU GPL.
     </para>
-
-    <para><command>&dhpackage;</command> is a program to manage GPS data</para>
 
   </refsect1>
   <refsect1>
@@ -283,12 +291,23 @@ and docbook-xsl in your Build-Depends control field.
         <title>External tools</title>
         <para>It is possible to add new external tools. The file is <filename>~/.viking/external_tools.xml</filename>.</para>
         <para>An example of the file in the distribution <filename>doc/examples/external_tools.xml</filename>.</para>
-        <para>Currently, there is a single object class available: VikWebtoolCenter. Such feature allows to declare any Webtool using a logic based on center coordinates and zoom level value.</para>
+        <para>The VikWebtoolCenter allows to declare any Webtool using a logic based on center coordinates and zoom level value.</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>
+              <listitem><para>the parametrized URL to open, in the spirit of C printf format, with 2 "%s" and a "%d" fields for X, Y and Z (zoom level) (eg. "http://hostname/?lat=%s&amp;lon=%s&amp;zoom=%d")</para></listitem>
+            </varlistentry>
+          </variablelist>
+        </para>
+        <para>The VikWebtoolBounds allows to declare any Webtool using a logic based on bounds coordinates.</para>
         <para>The related properties are:
           <variablelist>
             <varlistentry>
-              <term>id</term>
-              <listitem><para>this is an integer and should be unique as it used to identify the tool</para></listitem>
             </varlistentry>
             <varlistentry>
               <term>label</term>
@@ -296,7 +315,7 @@ and docbook-xsl in your Build-Depends control field.
             </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. "http://hostname/%d/%d/%d.png")</para></listitem>
+              <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>
@@ -334,6 +353,12 @@ and docbook-xsl in your Build-Depends control field.
           <para>Preferences for &dhpackage;.</para>
         </listitem>
       </varlistentry>
+      <varlistentry>
+        <term><filename>~/.viking/viking_layer_defaults.ini</filename></term>
+        <listitem>
+          <para>Layer default values for &dhpackage;.</para>
+        </listitem>
+      </varlistentry>
       <varlistentry>
         <term><filename>~/.viking/cookies.txt</filename></term>
         <listitem>
@@ -348,11 +373,40 @@ and docbook-xsl in your Build-Depends control field.
       </varlistentry>
     </variablelist>
 
+       <para>Extension files (<filename>maps.xml</filename>,
+       <filename>goto_tools.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>
+
+  </refsect1>
+  <refsect1>
+    <title>ENVIRONMENT</title>
+
+    <variablelist>
+      <varlistentry>
+        <term><envar>XDG_DATA_HOME</envar></term>
+        <listitem>
+          <para>Optional directory to look for extension files
+          (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>,
+          <filename>external_tools.xml</filename>).</para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><envar>XDG_DATA_DIRS</envar></term>
+        <listitem>
+          <para>Path used to change the directories scanned for extension files
+          (<filename>maps.xml</filename>, <filename>goto_tools.xml</filename>,
+          <filename>external_tools.xml</filename>).</para>
+       </listitem>
+      </varlistentry>
+    </variablelist>
+
   </refsect1>
   <refsect1>
     <title>AUTHOR</title>
 
-    <para>This manual page was written by &dhusername; &dhemail; for
+    <para>This manual page was originally written by &dhusername; &dhemail; for
       the &debian; system (but may be used by others).  Permission is
       granted to copy, distribute and/or modify this document under
       the terms of the &gnu; General Public License, Version 2 any 
@@ -365,4 +419,4 @@ and docbook-xsl in your Build-Depends control field.
 
   </refsect1>
 </refentry>
-
+</reference>