]> git.street.me.uk Git - andy/viking.git/blobdiff - help/C/viking.xml
Use a common way to create temporary GPX files.
[andy/viking.git] / help / C / viking.xml
index c041934becb0c7033ed74258784fe0012b6f7afc..6929b25c32ca6c7da03669e2a98d99d4da20701b 100644 (file)
@@ -3,9 +3,9 @@
 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   <!ENTITY appname          "Viking">
   <!ENTITY app "<application>Viking</application>">
-  <!ENTITY appversion   "1.4">
-  <!ENTITY manrevision  "1.4">
-  <!ENTITY date "February 2013">
+  <!ENTITY appversion   "1.5">
+  <!ENTITY manrevision  "1.5">
+  <!ENTITY date "October 2013">
 ]>
 <!--
       (Do not remove this comment block.)
@@ -421,10 +421,11 @@ This opens a file chooser dialog to select one (or more) files of the supported
 <listitem><para>Viking</para></listitem>
 <listitem><para>GPX</para></listitem>
 <listitem><para>KML</para></listitem>
+<listitem><para>JPG</para></listitem>
 </itemizedlist>
 </para>
 <para>
-GPX and KML files will be loaded into the existing &appname; view. A <emphasis>Viking</emphasis> file will be given a new window if the current window is already assigned.
+GPX, KML and JPG files will be loaded into the existing &appname; view. A <emphasis>Viking</emphasis> file will be given a new window if the current window is already assigned.
 </para>
 <tip>
 <para>
@@ -468,7 +469,7 @@ GPX and KML files may also be appended, but this is exactly the same as the norm
 Available on the <menuchoice><guimenu>File</guimenu><guisubmenu>Acquire</guisubmenu></menuchoice> menu and from the <xref linkend="TrackWaypoint"/> layer menu.
 </para>
 <para>
-If used from the <guimenu>File</guimenu> menu and a TrackWaypoint layer is not currently selected, these methods place the results in a new TrackWaypoint layer. When a TrackWaypoint layer is selected, then using the <menuchoice><guimenu>File</guimenu><guisubmenu>Acquire</guisubmenu></menuchoice> will put the results into the selected TrackWaypoint layer.
+If used from the <guimenu>File</guimenu> menu these methods place the results in a new TrackWaypoint layer.
 </para>
 <para>
 If used from the <xref linkend="TrackWaypoint"/> layer menu these methods place the results in that TrackWaypoint layer.
@@ -557,6 +558,22 @@ This gets a route from given directions.
 </para>
 </section>
 
+<section>
+<title>From URL</title>
+<para>
+<menuchoice><guimenu>File</guimenu><guimenuitem>Acquire</guimenuitem><guimenuitem>From URL</guimenuitem></menuchoice>
+</para>
+<para>
+This gets a file from the entered URL.
+File formats that can be opened are those supported by GPSBabel.
+</para>
+<note>
+<para>
+You need to select the type of the file that is going to be returned, since there is no automatic detection of the file kind.
+</para>
+</note>
+</section>
+
 </section> <!-- End Acquire -->
 
 <section><title>Print</title>
@@ -738,7 +755,7 @@ You are probably better off expanding the waypoint list and directly start typin
 
 <section><title>Export Layer</title>
 <para>
-The layer (all tracks, routes and waypoints) can be exported to a file GPX, GPSPoint, GPSMapper or Google's KML format.
+The layer (all tracks, routes and waypoints) can be exported to a file GPX, GPSPoint, GPSMapper, Google's KML format or any other format supported by GPSbabel.
 </para>
 <para>
 Version1.1+: An individual track can be exported to a GPX file via the track menu.
@@ -1145,7 +1162,7 @@ This is not available on routes as they have no timestamps.
 
 </section>
 
-<section><title>Transform</title>
+<section id="transform" xreflabel="Transform"><title>Transform</title>
 <para>
 These options alter the data of trackpoints of a track but not add or remove trackpoints.
 And don't seem to fit any other category :)
@@ -1179,11 +1196,11 @@ If this is a Route then it will convert it to a Track.
 <para>
 If this is Track then convert it to a Route.
 </para>
-<para>
 <note>
+<para>
 Converting from a Track to a Route may involve a loss of information, in particular timestamp values (hence you are required to confirm this operation before it happens).
-</note>
 </para>
+</note>
 </section>
 <section>
 <title>Anonymize Times</title>
@@ -1194,11 +1211,11 @@ Timestamp information of a track can be shifted to be all offset from 1901-01-01
 Thus the timestamps themselves will no longer reveal exactly when a track was taken.
 However the relative difference between the timestamps is kept thus one is still able to calculate some properties such as speeds along the track.
 </para>
-<para>
 <note>
+<para>
 This is not available for routes, as they have no timestamps.
-</note>
 </para>
+</note>
 </section>
 </section>
 
@@ -1326,6 +1343,13 @@ In this circumstance creation of waypoint options are disabled and only the opti
 </para>
 </section>
 
+<section><title>Transform</title>
+<para>
+Offers a subset of the track <xref linkend="transform"/> utilities.
+Currently only setting the altitude from DEM data methods are available.
+</para>
+</section>
+
 <section><title>Visit Webpage</title>
 <para>
 If the waypoint's comment (or description) starts with <literal>http:</literal> then this option is available and allows launching a web browser to go to the webpage.
@@ -1456,19 +1480,16 @@ You will need an open internet connection when you are downloading maps, but onc
 Some maps are continually improving over time (e.g. OpenStreetMap) and so in order to not to have to (re)download the data all the time &appname; employs a timeout method - <emphasis>Tile Age</emphasis> to determine whether to access the server. However a forced refresh for the current view can be made via the <guilabel>Reload All Onscreen Maps</guilabel> option.
 </para>
 <para>
-Inbuilt maps include various <ulink url="http://en.wikipedia.org/wiki/TerraServer-USA">Terraserver</ulink> (Primarily USA coverage) and <ulink url="http://openstreetmap.org/">OpenStreetMap (OSM)</ulink> ones and more:
+Inbuilt maps include various <ulink url="http://openstreetmap.org/">OpenStreetMap (OSM)</ulink> ones and more:
 </para>
 <itemizedlist>
 <listitem><para>Bing Bird's Eye (Aerial) Maps (&appname; Version1.2+)</para></listitem>
-<listitem><para>Terraserver Topos</para></listitem>
-<listitem><para>Terraserver Aerials</para></listitem>
-<listitem><para>Terraserver Urban Areas</para></listitem>
 <listitem><para>OpenStreetMap (Mapquest) - This is the default (&appname; Version1.3+)</para></listitem>
 <listitem><para>OpenStreetMap (Mapnik)</para></listitem>
 <listitem><para>OpenStreetMap (Cycle)</para></listitem>
 <listitem><para>OpenStreetMap (Transport) (&appname; Version1.3+)</para></listitem>
+<listitem><para>OpenStreetMap (Humanitarian) (&appname; Version1.5+)</para></listitem>
 <listitem><para>NASA BlueMarble</para></listitem>
-<listitem><para>SpotMap (&appname; Version1.1+)</para></listitem>
 </itemizedlist>
 
 <para>
@@ -1583,8 +1604,12 @@ This table may be invoked from a variety of different layer levels and will then
 <para>
 <figure>
 <title>Track List Dialog: Example</title>
+<blockquote>
+<para>
 This is showing all tracks and routes (although there are no actual routes here!) in multiple TrackWaypoint layers, that has been sorted by height.
 Note that routes will not have timestamps or speeds, but may have elevations and should have some distance!
+</para>
+</blockquote>
 <screenshot>
   <graphic format="PNG" fileref="figures/LayersTracksList.png"/>
 </screenshot>
@@ -1618,7 +1643,11 @@ This table may be invoked from a variety of different layer levels and will then
 <para>
 <figure>
 <title>Waypoint List Dialog: Example</title>
+<blockquote>
+<para>
 This was invoked on a TrackWaypoint layer and shows all waypoints from that single layer. It has been sorted by the symbols.
+</para>
+</blockquote>
 <screenshot>
   <graphic format="PNG" fileref="figures/WaypointsList.png"/>
 </screenshot>
@@ -1648,6 +1677,14 @@ This offers a quick way to set all the visibilities of each item within the cont
 </para>
 </section>
 
+<section id="search_date" xreflabel="Search by Date"><title>Search by Date</title>
+<para>
+This opens calendar dialog to select a date to search by within this Aggregate layer.
+The first item that is found on that date will be selected.
+Tracks are searched first in preference over waypoints.
+</para>
+</section>
+
 </section><!-- End Agg -->
 
 <section id="GeoRef" xreflabel="GeoRef"><title>GeoRef Layer</title>
@@ -1723,6 +1760,11 @@ This is the default tool.
 <para>
 This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+P</keycap>
 </para>
+<para>
+Double clicking the left mouse button will zoom the map in.
+<keycap>Shift</keycap> + double clicking the left mouse button will zoom the map out.
+Double clicking the right mouse button will also zoom the map out.
+</para>
 </section>
 
 <section><title>Zoom</title>
@@ -1741,6 +1783,12 @@ This mode can also be entered by the keyboard shortcut <keycap>Ctrl+Shift+Z</key
 <para>
 <keycap>Shift</keycap> (and hold) + left mouse button: Draws a bounding box area on which to zoom in. The zoom action is performed when the left mouse button is released.
 </para>
+<para>
+<keycap>Shift</keycap> + left click button: Jump Zoom In by up to factor of 3 standard zooms.
+</para>
+<para>
+<keycap>Shift</keycap> + right click button: Jump Zoom Out by up to factor of 3 standard zooms.
+</para>
 </section>
 
 <section><title>Ruler</title>
@@ -1812,6 +1860,31 @@ This operates in exactly the same way as the <link linkend="track_create">Create
 <para>
 One must finish the current route to be able to create another route.
 </para>
+<para>
+One can switch between the <link linkend="route_create">Create Route</link> and <link linkend="route_finder">Route Finder</link> tools while editing routes.
+</para>
+</section>
+
+<section id="route_finder" xreflabel="Route Finder"><title>Create Route Using the Route Finder</title>
+<para>
+Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/route_finder_18.png"/></guiicon>
+</para>
+<para>
+Requires an internet connection.
+Left click to create a new trackpoint.
+If it's the initial trackpoint you will be asked to enter a name for the route, otherwise the default routing engine will be queried to find a route to the new trackpoint.
+Right click or <keycap>Backspace</keycap>: remove the last added route.
+</para>
+<para>
+<keycap>Escape</keycap>: to finish route creation.
+Finishing the track is also available via the right click <xref linkend="TrackWaypoint"/> and track menus.
+</para>
+<para>
+One must finish the current route to be able to create another route.
+</para>
+<para>
+One can switch between the <link linkend="route_create">Create Route</link> and <link linkend="route_finder">Route Finder</link> tools while editing routes.
+</para>
 </section>
 
 <section><title>Edit Waypoint</title>
@@ -1841,22 +1914,22 @@ If <keycap>Ctrl</keycap> is held at the same time, it will jump the new trackpoi
 <para>
 Editing options in the Trackpoint Edit dialog include:
 <itemizedlist>
-<listitem>Edit the trackpoint name</listitem>
-<listitem>Changing raw lat/long position and altitude</listitem>
-<listitem>Forward (go to the next trackpoint)</listitem>
-<listitem>Back (go to the previous trackpoint)</listitem>
-<listitem>Delete</listitem>
-<listitem>Insert. Inserts a point halfway to next trackpoint</listitem>
-<listitem>Split. <xref linkend="trkpt_split"/></listitem>
+<listitem><para>Edit the trackpoint name</para></listitem>
+<listitem><para>Changing raw lat/long position and altitude</para></listitem>
+<listitem><para>Forward (go to the next trackpoint)</para></listitem>
+<listitem><para>Back (go to the previous trackpoint)</para></listitem>
+<listitem><para>Delete</para></listitem>
+<listitem><para>Insert. Inserts a point halfway to next trackpoint</para></listitem>
+<listitem><para>Split. <xref linkend="trkpt_split"/></para></listitem>
 </itemizedlist>
 </para>
 <para>
 Several fields are read only for reference purposes, values are shown if the trackpoint has such information:
 <itemizedlist>
-<listitem>Time.</listitem>
-<listitem>Speed and course.</listitem>
-<listitem>'Between' values: Speed, Time Difference and Distance Difference. When moving between trackpoints (via the Back and Forward buttons) these values are calculated.</listitem>
-<listitem>GPS precision factors.</listitem>
+<listitem><para>Time.</para></listitem>
+<listitem><para>Speed and course.</para></listitem>
+<listitem><para>'Between' values: Speed, Time Difference and Distance Difference. When moving between trackpoints (via the Back and Forward buttons) these values are calculated.</para></listitem>
+<listitem><para>GPS precision factors.</para></listitem>
 </itemizedlist>
 </para>
 <para>
@@ -1882,22 +1955,6 @@ For Linux you can override this with the setting in the <xref linkend="prefs_ext
 </para>
 </section>
 
-<section id="route_finder" xreflabel="Route Finder"><title>Route Finder</title>
-<para>
-Enable this tool by clicking on the toolbar icon: <guiicon><inlinegraphic fileref="figures/route_finder_18.png"/></guiicon>
-</para>
-<para>Creates a track using default routing engine between two points.
-Requires an internet connection. Click one point, then click another to
-create a track.
-</para>
-<para>
-Right-click: undo last routing (only track removed - not any waypoints)
-</para>
-<para>
-<keycap>Ctrl</keycap>: continue previous track
-</para>
-</section>
-
 </section>
 
 <section><title>Georef Map Layer Tools</title>
@@ -2691,7 +2748,11 @@ Accept: */*
             </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>
+              <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>switch-xy (optional)</term>
+              <listitem><para>Swap the X,Y values around in the URL parametrized ordering.</para></listitem>
             </varlistentry>
           </variablelist>
         </para>
@@ -2950,6 +3011,17 @@ Accept: */*
            <para>trkpt_selected_statusbar_format=KEATDN</para>
            <para>This string is in the Message Format Code</para>
          </listitem>
+         <listitem>
+           <para>viewport_history_size=20</para>
+         </listitem>
+         <listitem>
+           <para>viewport_history_diff_dist=500</para>
+           <para>In metres.</para>
+           <para>
+             Go Back or Go Forward requests over this range from the last history location will move back to that position.
+             If within this range it will skip over this location and move on to the next saved history location.
+           </para>
+         </listitem>
        </orderedlist>
 
        <section>