From 04f736727b4948f875ceb419049e98562085d0c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20T=C5=AFma?= Date: Mon, 5 Feb 2018 20:38:37 +0100 Subject: [PATCH] Added documentation section --- css/style.css | 2 +- doc.html | 178 ++++++++++++++++++++++++++++++++++++++++++++++++++ gallery.html | 2 +- index.html | 94 ++++++-------------------- 4 files changed, 199 insertions(+), 77 deletions(-) create mode 100644 doc.html diff --git a/css/style.css b/css/style.css index 3dd4042d..10260dcf 100644 --- a/css/style.css +++ b/css/style.css @@ -104,7 +104,7 @@ h1.logo a span { #slider { position:relative; width:980px; - height:350px; + /*height:350px;*/ background-color:#000; margin-top:10px; } diff --git a/doc.html b/doc.html new file mode 100644 index 00000000..25d06002 --- /dev/null +++ b/doc.html @@ -0,0 +1,178 @@ + + + +GPXSee - Documentation + + + + + + + + + + +
+
+ + +
+
+
+ +
+
+ +

Data files

+

GPXSee opens GPX, TCX, FIT, KML, IGC, NMEA and + Garmin CSV + files, however not all format features are supported for all formats. + Generally, GPXSee supports three kinds of data objects:

+ +
    +
  • Tracks
    • +
  • Routes
    • +
  • Waypoints
    • +
+ +

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.

+ +

In addition to GPS data, data from the following sensors is supported + by GPXSee:

+ +
    +
  • Heart rate
    • +
  • Cadence
    • +
  • Power
    • +
  • Temperature
    • +
+ + +

Maps

+

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:

+ + + + + + + + + + + + +
Windows:C:\Program Files\GPXSee\maps
Linux:/usr/share/gpxsee/maps
OS X:/Applications/GPXSee.app/Contents/Resources/maps
+ +

User specific map directories that - when present - override the global map + directory are also supported. The paths are as follows:

+ + + + + + + + + +
Windows:%HOMEPATH%\GPXSee\maps
OS X, Linux:$HOME/.gpxsee/maps
+ +

The map directory is recursively searched when loading the maps, so it + may contain an arbitrary directory structure.

+ +

Online maps

+

GPXSee supports most tile server based online maps out there, but the + list + of maps 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.

+ +

The mapsource definition file format is based on XML and is quiet simple. + The root map element contains two mandatory elements - name + and url, and two optional elements - zoom and bounds. + The tile X and Y coordinates are replaced with $x and + $y in the URL and the zoom level is replaced with + $z. An example map source definition file could look like:

+ +
+<?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>
+
+ +

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>.

+ +

Offline maps

+

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 ellipsoids.csv, GCS.csv and PCS.csv + configuration files (can be modified or overridden by user files like the map + directory).

+ +

You may easily create offline atlases from online map services by using + Mobile Atlas Creator (MOBAC).

+ + +

POI files

+

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.

+ +

To make GPXSee load a POI file automatically on startup, add the file to the + POI directory in one of the configuration paths.

+ +
+ + +
 
+ +
+
+
+
+
+

Copyright © 2017 Martin Tůma - All Rights Reserved

+

Design by WebsiteCSSTemplates

+
+
+
+ + + diff --git a/gallery.html b/gallery.html index 549b372a..97893575 100644 --- a/gallery.html +++ b/gallery.html @@ -27,7 +27,7 @@ diff --git a/index.html b/index.html index 139f77cf..6ebc5e22 100644 --- a/index.html +++ b/index.html @@ -30,7 +30,7 @@ @@ -86,7 +86,7 @@

Key features

- -

Maps

+

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 Documentation section for details.

-

Online maps

-

GPXSee supports most tile server based online maps out there, but the - list - of maps 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:

- - - - - - - - - - - - -
Windows:C:\Program Files\GPXSee\maps.txt
Linux:/usr/share/gpxsee/maps.txt
OS X:/Applications/GPXSee.app/Contents/Resources/maps.txt
- -

or by overriding it with a user map list file:

- - - - - - - - - -
Windows:%HOMEPATH%\GPXSee\maps.txt
OS X, Linux:$HOME/.gpxsee/maps.txt
- -

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 $x and - $y in the URL and the zoom level is replaced with - $z. An example map file could look like:

- -
-Map1	http://tile.server.com/map/$z/$x/$y.png	15
-Map2	http://mapserver.org/map/$z-$x-$y
-
- -

Offline maps

-

OziExplorer maps and TrekBuddy maps/atlases are supported by GPXSee. You may - easily create offline atlases from online map services by using - Mobile Atlas Creator (MOBAC).

- -

Offline maps are loaded on program startup from the maps - directory in the same locations as the maps.txt 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 datums.csv - and ellipsoids.csv configuration files (can be modified or - overridden by user files like the map list/map dir).

- -

POI files

-

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.

- -

To make GPXSee load a POI file automatically on startup, add the file to the - POI directory in one of the configuration paths.

- -

Download

- +

Download

+

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.

+

Reporting bugs

+

If you have found some bug in GPXSee, please report it using the + GitHub issue tracker. + 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.

+