mirror of
https://github.com/tumic0/GPXSee.git
synced 2024-11-24 03:35:53 +01:00
Added documentation section
This commit is contained in:
parent
8668bc243e
commit
04f736727b
@ -104,7 +104,7 @@ h1.logo a span {
|
||||
#slider {
|
||||
position:relative;
|
||||
width:980px;
|
||||
height:350px;
|
||||
/*height:350px;*/
|
||||
background-color:#000;
|
||||
margin-top:10px;
|
||||
}
|
||||
|
||||
178
doc.html
Normal file
178
doc.html
Normal file
@ -0,0 +1,178 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>GPXSee - Documentation</title>
|
||||
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="icon" type="image/png" href="css/images/favicon.png"/>
|
||||
<link rel="stylesheet" href="css/style.css" type="text/css" media="all" />
|
||||
<!--[if IE 6]><link rel="stylesheet" href="css/ie6.css" type="text/css" media="all" /><![endif]-->
|
||||
<!-- Global site tag (gtag.js) - Google Analytics -->
|
||||
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-110140219-1"></script>
|
||||
<script>
|
||||
window.dataLayer = window.dataLayer || [];
|
||||
function gtag(){dataLayer.push(arguments);}
|
||||
gtag('js', new Date());
|
||||
|
||||
gtag('config', 'UA-110140219-1');
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<!-- START PAGE SOURCE -->
|
||||
<div class="shell">
|
||||
<div class="shell-b">
|
||||
<div id="header">
|
||||
<img src="css/images/gpxsee.png" alt="" class="logo"/><h1 class="logo"><a href="http://www.gpxsee.org">GPXSee</a></h1>
|
||||
<div id="navigation">
|
||||
<ul>
|
||||
<li><a href="index.html">Home</a></li>
|
||||
<li><a href="gallery.html">Screenshots</a></li>
|
||||
<li><a href="doc.html" class="active">Documentation</a></li>
|
||||
<li><a href="index.html#download">Download</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="cl"> </div>
|
||||
</div>
|
||||
|
||||
<div id="slider">
|
||||
<br/>
|
||||
</div>
|
||||
|
||||
<div id="main">
|
||||
<div id="content">
|
||||
|
||||
<h2 id="data">Data files</h2>
|
||||
<p>GPXSee opens GPX, TCX, FIT, KML, IGC, NMEA and
|
||||
<a href="http://www.poi-factory.com/garmin-csv-file-format">Garmin CSV</a>
|
||||
files, however not all format features are supported for all formats.
|
||||
Generally, GPXSee supports three kinds of data objects:</p>
|
||||
|
||||
<ul>
|
||||
<li>Tracks</li>
|
||||
<li>Routes</li>
|
||||
<li>Waypoints</li>
|
||||
</ul>
|
||||
|
||||
<p>Naturally, if a format supports only a subset of the objects, GPXSee also
|
||||
supports only this subset. Some formats - especially KML - have support for
|
||||
a plenty of other data objects like surfaces or even 3D structures. Those are
|
||||
not supported by GPXSee.</p>
|
||||
|
||||
<p>In addition to GPS data, data from the following sensors is supported
|
||||
by GPXSee:</p>
|
||||
|
||||
<ul>
|
||||
<li>Heart rate</li>
|
||||
<li>Cadence</li>
|
||||
<li>Power</li>
|
||||
<li>Temperature</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2 id="maps">Maps</h2>
|
||||
<p>Two kinds of maps are supported by GPXSee - online maps and offline maps.
|
||||
You may either load them "ad hoc" from the GUI or they can be loaded
|
||||
automatically at program startup from the following directory:</p>
|
||||
|
||||
<table class="config-files">
|
||||
<tr>
|
||||
<td class="os">Windows:</td>
|
||||
<td class="file">C:\Program Files\GPXSee\maps</td>
|
||||
</tr><tr>
|
||||
<td class="os">Linux:</td>
|
||||
<td class="file">/usr/share/gpxsee/maps</td>
|
||||
</tr><tr>
|
||||
<td class="os">OS X:</td>
|
||||
<td class="file">/Applications/GPXSee.app/Contents/Resources/maps</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>User specific map directories that - when present - override the global map
|
||||
directory are also supported. The paths are as follows:</p>
|
||||
|
||||
<table class="config-files">
|
||||
<tr>
|
||||
<td class="os">Windows:</td>
|
||||
<td class="file">%HOMEPATH%\GPXSee\maps</td>
|
||||
</tr><tr>
|
||||
<td class="os">OS X, Linux:</td>
|
||||
<td class="file">$HOME/.gpxsee/maps</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>The map directory is recursively searched when loading the maps, so it
|
||||
may contain an arbitrary directory structure.</p>
|
||||
|
||||
<h3 id="online">Online maps</h3>
|
||||
<p>GPXSee supports most tile server based online maps out there, but the
|
||||
<a href="https://github.com/tumic0/GPXSee/tree/master/pkg/maps">list
|
||||
of maps</a> distributed with the official packages is limited to those
|
||||
that are "freely distributable". You may however easily extend (or change)
|
||||
the default map list with your own map sources definitions.</p>
|
||||
|
||||
<p>The mapsource definition file format is based on XML and is quiet simple.
|
||||
The root <i>map</i> element contains two mandatory elements - <i>name</i>
|
||||
and <i>url</i>, and two optional elements - <i>zoom</i> and <i>bounds</i>.
|
||||
The tile X and Y coordinates are replaced with <code>$x</code> and
|
||||
<code>$y</code> in the URL and the zoom level is replaced with
|
||||
<code>$z</code>. An example map source definition file could look like:</p>
|
||||
|
||||
<pre>
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<map>
|
||||
<name>Czech Republic</name>
|
||||
<url>http://tile.server.cz/map/$z/$x/$y.png</url>
|
||||
<zoom min="2" max="15"/>
|
||||
<bounds left="12.3" bottom="48.6" right="18.9" top="51.2"/>
|
||||
</map>
|
||||
</pre>
|
||||
|
||||
<p>The bounds are WGS84 latitude/longitude values in degrees. If omitted, the
|
||||
default zoom range is <0, 19> and the default bounds are
|
||||
<-85.0511, 85.0511> and <-180, 180>.</p>
|
||||
|
||||
<h3 id="offline">Offline maps</h3>
|
||||
<p>OziExplorer maps, TrekBuddy maps/atlases and GeoTIFF images are supported by
|
||||
GPXSee. Supported map projections are Web Mercator, Transverse Mercator, UTM,
|
||||
Lambert Conformal Conic, Albers Equal Area, Lambert Azimuthal Equal Area and
|
||||
Latitude/Longitude (2D geographic). For list of supported datums and PCSs see
|
||||
the <code>ellipsoids.csv</code>, <code>GCS.csv</code> and <code>PCS.csv</code>
|
||||
configuration files (can be modified or overridden by user files like the map
|
||||
directory).</p>
|
||||
|
||||
<p>You may easily create offline atlases from online map services by using
|
||||
<a href="http://mobac.sourceforge.net/">Mobile Atlas Creator (MOBAC)</a>.</p>
|
||||
|
||||
|
||||
<h2 id="poi">POI files</h2>
|
||||
<p>All of the supported formats with waypoints capability - GPX, KML, TCX, NMEA
|
||||
and Garmin CSV - can be loaded either as data files or as POI files. When a file
|
||||
is opened as a POI file, only waypoints reasonable near the tracks/waypoints of
|
||||
the loaded data files are displayed.</p>
|
||||
|
||||
<p>To make GPXSee load a POI file automatically on startup, add the file to the
|
||||
<code>POI</code> directory in one of the configuration paths.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="sidebar">
|
||||
<h4><a href="#data">Data files</a></h4>
|
||||
<h4><a href="#maps">Maps</a></h4>
|
||||
<h5><a href="#online">Online maps</a></h5>
|
||||
<h5><a href="#offline">Offline maps</a></h5>
|
||||
<h4><a href="#poi">POI files</a></h4>
|
||||
</div>
|
||||
<div class="cl"> </div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="shell">
|
||||
<p class="lf">Copyright © 2017 Martin Tůma - All Rights Reserved</p>
|
||||
<p class="rf">Design by <a href="http://www.websitecsstemplates.com/" target="_blank">WebsiteCSSTemplates</a></p>
|
||||
<div style="clear:both;"></div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- END PAGE SOURCE -->
|
||||
</body>
|
||||
</html>
|
||||
@ -27,7 +27,7 @@
|
||||
<ul>
|
||||
<li><a href="index.html">Home</a></li>
|
||||
<li><a href="gallery.html" class="active">Screenshots</a></li>
|
||||
<li><a href="index.html#maps">Maps</a></li>
|
||||
<li><a href="doc.html">Documentation</a></li>
|
||||
<li><a href="index.html#download">Download</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
94
index.html
94
index.html
@ -30,7 +30,7 @@
|
||||
<ul>
|
||||
<li><a href="index.html" class="active">Home</a></li>
|
||||
<li><a href="gallery.html">Screenshots</a></li>
|
||||
<li><a href="index.html#maps">Maps</a></li>
|
||||
<li><a href="doc.html">Documentation</a></li>
|
||||
<li><a href="index.html#download">Download</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@ -86,7 +86,7 @@
|
||||
<h3>Key features</h3>
|
||||
<ul>
|
||||
<li>User-definable online maps.</li>
|
||||
<li>Offline maps (OziExplorer maps and TrekBuddy maps/atlases).</li>
|
||||
<li>Offline maps (OziExplorer maps, TrekBuddy maps/atlases, GeoTIFF images).</li>
|
||||
<li>Elevation, speed, heart rate, cadence, power and temperature graphs.</li>
|
||||
<li>Support for multiple tracks in one view.</li>
|
||||
<li>Support for POI files.</li>
|
||||
@ -97,88 +97,32 @@
|
||||
<li><b>Free software</b> (GPLv3 open-source license).</li>
|
||||
</ul>
|
||||
|
||||
<a name="maps"></a>
|
||||
<h2>Maps</h2>
|
||||
<p>GPXSee is designed as a small (no dependencies except of Qt), fast
|
||||
and uncomplicated GPS data/map viewer, not a full featured GIS software.
|
||||
However, the spectrum of supported data files/map sources is relatively
|
||||
rich, see the <i>Documentation</i> section for details.</p>
|
||||
|
||||
<h3>Online maps</h3>
|
||||
<p>GPXSee supports most tile server based online maps out there, but the
|
||||
<a href="https://github.com/tumic0/GPXSee/blob/master/pkg/maps.txt">list
|
||||
of maps</a> distributed with the official packages is limited to those
|
||||
that are "freely distributable". You may however easily change the default
|
||||
map list with your own list either by editing the global map list file:</p>
|
||||
|
||||
<table class="config-files">
|
||||
<tr>
|
||||
<td class="os">Windows:</td>
|
||||
<td class="file">C:\Program Files\GPXSee\maps.txt</td>
|
||||
</tr><tr>
|
||||
<td class="os">Linux:</td>
|
||||
<td class="file">/usr/share/gpxsee/maps.txt</td>
|
||||
</tr><tr>
|
||||
<td class="os">OS X:</td>
|
||||
<td class="file">/Applications/GPXSee.app/Contents/Resources/maps.txt</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>or by overriding it with a user map list file:</p>
|
||||
|
||||
<table class="config-files">
|
||||
<tr>
|
||||
<td class="os">Windows:</td>
|
||||
<td class="file">%HOMEPATH%\GPXSee\maps.txt</td>
|
||||
</tr><tr>
|
||||
<td class="os">OS X, Linux:</td>
|
||||
<td class="file">$HOME/.gpxsee/maps.txt</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>The file format is one map entry per line, consisting of the map name,
|
||||
tiles URL and an optional maximal zoom level delimited by a TAB character.
|
||||
The tile X and Y coordinates are replaced with <code>$x</code> and
|
||||
<code>$y</code> in the URL and the zoom level is replaced with
|
||||
<code>$z</code>. An example map file could look like:</p>
|
||||
|
||||
<pre>
|
||||
Map1 http://tile.server.com/map/$z/$x/$y.png 15
|
||||
Map2 http://mapserver.org/map/$z-$x-$y
|
||||
</pre>
|
||||
|
||||
<h3>Offline maps</h3>
|
||||
<p>OziExplorer maps and TrekBuddy maps/atlases are supported by GPXSee. You may
|
||||
easily create offline atlases from online map services by using
|
||||
<a href="http://mobac.sourceforge.net/">Mobile Atlas Creator (MOBAC)</a>.</p>
|
||||
|
||||
<p>Offline maps are loaded on program startup from the <code>maps</code>
|
||||
directory in the same locations as the <code>maps.txt</code> file. The expected
|
||||
structure is one map/atlas in a separate subdirectory. Supported map formats are
|
||||
OziExplorer maps and TrekBuddy maps/atlases (tared and non-tared).
|
||||
Supported map projections are Web Mercator, Transverse Mercator, UTM,
|
||||
Lambert Conformal Conic, Albers Equal Area, Lambert Azimuthal Equal Area and
|
||||
Latitude/Longitude. For list of supported datums see the <code>datums.csv</code>
|
||||
and <code>ellipsoids.csv</code> configuration files (can be modified or
|
||||
overridden by user files like the map list/map dir).</p>
|
||||
|
||||
<h2>POI files</h2>
|
||||
<p>All of the supported formats with waypoints capability - GPX, KML, TCX, NMEA
|
||||
and <a href="http://www.poi-factory.com/garmin-csv-file-format">Garmin CSV</a>
|
||||
- can be loaded either as data files or as POI files. When a file is opened as
|
||||
a POI file, only waypoints reasonable near the tracks/waypoints of the loaded
|
||||
data files are displayed.</p>
|
||||
|
||||
<p>To make GPXSee load a POI file automatically on startup, add the file to the
|
||||
<code>POI</code> directory in one of the configuration paths.</p>
|
||||
|
||||
<h2>Download</h2>
|
||||
<a name="download"></a>
|
||||
<h2 id="download">Download</h2>
|
||||
<p>Additionally to the source codes, GPXSee is available as a Windows
|
||||
installer and an OS X dmg from the project's Sourceforge page and in
|
||||
form of various Linux packages from the project's openSUSE Build Service
|
||||
page. Some linux distributions (e.g. openSUSE or Fedora) also provide
|
||||
GPXSee in their official repositories.</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://sourceforge.net/projects/gpxsee/files/Source/">Sources</a></li>
|
||||
<li><a href="https://github.com/tumic0/GPXSee">Sources</a></li>
|
||||
<li><a href="https://sourceforge.net/projects/gpxsee/files/Windows/">Windows installer</a></li>
|
||||
<li><a href="https://sourceforge.net/projects/gpxsee/files/Mac%20OS%20X/">Mac OS X bundle</a></li>
|
||||
<li><a href="https://software.opensuse.org/download.html?project=home%3Atumic%3AGPXSee&package=gpxsee">
|
||||
Linux repos/packages</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="bugreports">Reporting bugs</h2>
|
||||
<p>If you have found some bug in GPXSee, please report it using the
|
||||
<a href="https://github.com/tumic0/GPXSee/issues">GitHub issue tracker</a>.
|
||||
Bugs that are not reported can not be fixed! If you are missing some
|
||||
feature in GPXSee, you may also use the tracker to request it.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="sidebar">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user