From: Rob Norris <rw_norris@hotmail.com>
Date: Thu, 16 Oct 2014 18:38:50 +0000 (+0100)
Subject: [DOC] Recommended programs
X-Git-Url: https://git.street.me.uk/andy/viking.git/commitdiff_plain/f2e987afcf34cad6df54dfb1e07b98c8eadaceb7?hp=686482262a96fb24591114e8eacb1d1c4ce10ac9

[DOC] Recommended programs
---

diff --git a/help/C/recommends.xml b/help/C/recommends.xml
new file mode 100644
index 00000000..5b16d6d6
--- /dev/null
+++ b/help/C/recommends.xml
@@ -0,0 +1,46 @@
+<?xml version="1.0"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
+   [<!ENTITY appname          "Viking">]
+>
+
+<section id="recommeds">
+<title>Recommended Programs</title>
+
+<formalpara><title>gpsbabel</title>
+<para>&appname; uses <ulink url="http://gpsbabel.org/">GPSBabel</ulink> for several important functions, such as:</para>
+</formalpara>
+<itemizedlist>
+<listitem><para>Importing Files from many formats (including KML)</para></listitem>
+<listitem><para>Exporting Files to various formats</para></listitem>
+<listitem><para>Transfer Data to/from GPS Devices via serial connections</para></listitem>
+<listitem><para>Using Google Directions for routes</para></listitem>
+</itemizedlist>
+<para>Thus these will not be available if the program can not be found.</para>
+<para>For <trademark>Unix</trademark> like systems this will search the system path to find the program, as it is typically installed via the System's package manager.</para>
+<para>
+	From &appname; 1.6 onwards GPSBabel is not deployed automatically on <trademark>Windows</trademark> systems,
+	as it is made an optional install component (using the official GPSBabel installation program).
+	If GPSBabel is not installed in a typical <trademark>Windows</trademark> location that &appname; can find,
+	then the GPSBabel preference can be set to specify the exact location. See <xref linkend="prefs_external"/>.
+</para>
+<para>&appname; will need to be restarted to use the new GPSBabel location preference.</para>
+
+<formalpara><title>unbuffer</title>
+<para>&appname; uses unbuffer command to optimize conversion calls.</para>
+</formalpara>
+<para>This mainly applies to <trademark>Unix</trademark> like systems when invoking GPSBabel commands.</para>
+
+<formalpara><title>gpsd (not available for <trademark>Windows</trademark>)</title>
+<para>&appname; can use <ulink url="http://www.catb.org/gpsd/">gpsd</ulink> to get the current location.</para>
+</formalpara>
+
+<formalpara><title>togpx</title>
+<para>&appname; will use <ulink url="https://github.com/tyrasd/togpx">togpx</ulink> to open GeoJSON files if the program is available on the system.</para>
+</formalpara>
+
+<formalpara><title>togeojson</title>
+<para>&appname; will use <ulink url="https://github.com/mapbox/togeojson">togeojson</ulink> to export to GeoJSON files if the program is available on the system.</para>
+</formalpara>
+
+</section>
diff --git a/help/C/viking.xml b/help/C/viking.xml
index c3ce7ac2..3c6c7930 100644
--- a/help/C/viking.xml
+++ b/help/C/viking.xml
@@ -2267,6 +2267,10 @@ Generally if you have a system with lots of memory it's recommended to increase
 <listitem><para>Some other user defined program</para></listitem>
 </itemizedlist>
 </section>
+<section><title>GPSBabel</title>
+<para>This allows setting the specific location of GPSBabel.</para>
+<para>&appname; will need to be restarted for this setting to take effect.</para>
+</section>
 </section>
 
 <section id="prefs_osm" xreflabel="OpenStreetMap Traces Preferences"><title>OpenStreetMap Traces</title>
@@ -3317,17 +3321,7 @@ Accept: */*
 </section>
 <!-- End of Extending Viking -->
 
-<section><title>Dependencies</title>
-<formalpara><title>gpsbabel</title>
-<para>&appname; uses <ulink url="http://gpsbabel.org/">GPSBabel</ulink> to convert data.</para>
-</formalpara>
-<formalpara><title>unbuffer (optional)</title>
-<para>&appname; uses unbuffer command to optimize conversion calls.</para>
-</formalpara>
-<formalpara><title>gpsd (optional - but not <trademark>Windows</trademark>)</title>
-<para>&appname; can use <ulink url="http://www.catb.org/gpsd/">gpsd</ulink> to get the current location.</para>
-</formalpara>
-</section>
+<xi:include href="recommends.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
 <xi:include href="commandline.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
diff --git a/help/Makefile.am b/help/Makefile.am
index f6c1cfd9..a84bf035 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -14,7 +14,8 @@ dist-hook: get-icons doc-dist-hook
 DOC_MODULE = viking
 DOC_ENTITIES = legal.xml \
     attribution.xml \
-    commandline.xml
+    commandline.xml \
+    recommends.xml
 DOC_INCLUDES =
 DOC_FIGURES = \
     figures/addtr_18.png \