333 lines
13 KiB
HTML
333 lines
13 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<title>Features — FitTrackee 0.5.2
|
||
documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Installation" href="installation.html" />
|
||
<link rel="prev" title="FitTrackee" href="index.html" />
|
||
<meta charset='utf-8'>
|
||
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
|
||
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
|
||
<meta name="apple-mobile-web-app-capable" content="yes">
|
||
<script type="text/javascript" src="_static/js/jquery-1.12.4.min.js "></script>
|
||
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
|
||
<script type="text/javascript" src="_static/bootstrap-3.4.1/js/bootstrap.min.js "></script>
|
||
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>
|
||
|
||
</head><body>
|
||
|
||
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
|
||
<div class="container">
|
||
<div class="navbar-header">
|
||
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
|
||
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
</button>
|
||
<a class="navbar-brand" href="index.html">
|
||
FitTrackee</a>
|
||
<span class="navbar-text navbar-version pull-left"><b>0.5.2
|
||
</b></span>
|
||
</div>
|
||
|
||
<div class="collapse navbar-collapse nav-collapse">
|
||
<ul class="nav navbar-nav">
|
||
|
||
<li><a href="https://github.com/SamR1/FitTrackee">GitHub</a></li>
|
||
|
||
|
||
<li class="dropdown globaltoc-container">
|
||
<a role="button"
|
||
id="dLabelGlobalToc"
|
||
data-toggle="dropdown"
|
||
data-target="#"
|
||
href="index.html">Docs <b class="caret"></b></a>
|
||
<ul class="dropdown-menu globaltoc"
|
||
role="menu"
|
||
aria-labelledby="dLabelGlobalToc"><ul class="current">
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Features</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="api/index.html">API documentation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting/index.html">Troubleshooting</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change log</a></li>
|
||
</ul>
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="dropdown">
|
||
<a role="button"
|
||
id="dLabelLocalToc"
|
||
data-toggle="dropdown"
|
||
data-target="#"
|
||
href="#">Page <b class="caret"></b></a>
|
||
<ul class="dropdown-menu localtoc"
|
||
role="menu"
|
||
aria-labelledby="dLabelLocalToc"><ul>
|
||
<li><a class="reference internal" href="#">Features</a><ul>
|
||
<li><a class="reference internal" href="#list">List</a><ul>
|
||
<li><a class="reference internal" href="#administration">Administration</a></li>
|
||
<li><a class="reference internal" href="#account-preferences">Account & preferences</a></li>
|
||
<li><a class="reference internal" href="#workouts">Workouts</a></li>
|
||
<li><a class="reference internal" href="#translations">Translations</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#dashboard">Dashboard</a></li>
|
||
<li><a class="reference internal" href="#workout-detail">Workout detail</a></li>
|
||
<li><a class="reference internal" href="#workouts-list">Workouts list</a></li>
|
||
<li><a class="reference internal" href="#statistics">Statistics</a></li>
|
||
<li><a class="reference internal" href="#id1">Administration</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
<li>
|
||
<a href="index.html" title="Previous Chapter: FitTrackee"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« FitTrackee</span>
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="installation.html" title="Next Chapter: Installation"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Installation »</span>
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
<li class="hidden-sm">
|
||
<div id="sourcelink">
|
||
<a href="_sources/features.rst.txt"
|
||
rel="nofollow">Source</a>
|
||
</div></li>
|
||
|
||
</ul>
|
||
|
||
|
||
|
||
<form class="navbar-form navbar-right" action="search.html" method="get">
|
||
<div class="form-group">
|
||
<input type="text" name="q" class="form-control" placeholder="Search" />
|
||
</div>
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="container">
|
||
<div class="row">
|
||
<div class="body col-md-12 content" role="main">
|
||
|
||
<section id="features">
|
||
<h1>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h1>
|
||
<section id="list">
|
||
<h2>List<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h2>
|
||
<section id="administration">
|
||
<h3>Administration<a class="headerlink" href="#administration" title="Permalink to this headline">¶</a></h3>
|
||
<p>(<em>new in 0.3.0</em>)</p>
|
||
<ul>
|
||
<li><p><strong>Application</strong></p>
|
||
<p>The following parameters can be set:</p>
|
||
<ul class="simple">
|
||
<li><p>active users limit. If 0, registration is enabled (no limit defined)</p></li>
|
||
<li><p>maximum size of uploaded files</p></li>
|
||
<li><p>maximum size of zip archive</p></li>
|
||
<li><p>maximum number of files in the zip archive. If an archive contains more files, only the configured number of files is processed, without raising errors.</p></li>
|
||
</ul>
|
||
<div class="admonition warning">
|
||
<p class="admonition-title">Warning</p>
|
||
<p>Updating server configuration may be necessary to handle large files (like <a class="reference external" href="https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size">nginx</a> for instance).</p>
|
||
</div>
|
||
</li>
|
||
<li><p><strong>Users</strong></p>
|
||
<ul class="simple">
|
||
<li><p>display users list and details</p></li>
|
||
<li><p>edit a user to add/remove administration rights</p></li>
|
||
<li><p>delete a user</p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><strong>Sports</strong></p>
|
||
<ul class="simple">
|
||
<li><p>enable or disable a sport (a sport can be disabled even if workout with this sport exists)</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section id="account-preferences">
|
||
<h3>Account & preferences<a class="headerlink" href="#account-preferences" title="Permalink to this headline">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><p>A user can create, update and deleted his account</p></li>
|
||
<li><p>A user can set language, timezone and first day of week.</p></li>
|
||
<li><p>A user can reset his password (<em>new in 0.3.0</em>)</p></li>
|
||
<li><p>A user can choose between metric system and imperial system for distance, elevation and speed display (<em>new in 0.5.0</em>)</p></li>
|
||
<li><dl class="simple">
|
||
<dt>A user can set sport preferences (<em>new in 0.5.0</em>):</dt><dd><ul>
|
||
<li><p>change sport color (used for sport image and charts)</p></li>
|
||
<li><p>can override stopped speed threshold (for next uploaded gpx files)</p></li>
|
||
<li><p>disable/enable a sport.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<div class="line-block">
|
||
<div class="line">If a sport is disabled by an administrator, it can not be enabled by a user. In this case, it will only appear in preferences if it has user’s workouts and the user can only change sport color.</div>
|
||
<div class="line">A disabled sport (by admin or user) will not appear in dropdown when <strong>adding a workout</strong>.</div>
|
||
<div class="line">A workout with a disabled sport will still be displayed in the application.</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section id="workouts">
|
||
<h3>Workouts<a class="headerlink" href="#workouts" title="Permalink to this headline">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><dl class="simple">
|
||
<dt>11 sports are supported:</dt><dd><ul>
|
||
<li><p>Cycling (Sport)</p></li>
|
||
<li><p>Cycling (Transport)</p></li>
|
||
<li><p>Hiking</p></li>
|
||
<li><p>Mountain Biking</p></li>
|
||
<li><p>Mountain Biking (Electric) (<strong>new in 0.5.0</strong>)</p></li>
|
||
<li><p>Rowing (<strong>new in 0.5.0</strong>)</p></li>
|
||
<li><p>Running</p></li>
|
||
<li><p>Skiing (Alpine) (<strong>new in 0.5.0</strong>)</p></li>
|
||
<li><p>Skiing (Cross Country) (<strong>new in 0.5.0</strong>)</p></li>
|
||
<li><p>Snowshoes (<strong>new in 0.5.2</strong>)</p></li>
|
||
<li><p>Trail (<strong>new in 0.5.0</strong>)</p></li>
|
||
<li><p>Walking</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
<li><dl class="simple">
|
||
<dt>(<em>new in 0.5.0</em>) Stopped speed threshold used by <a class="reference external" href="https://github.com/tkrajina/gpxpy">gpxpy</a> is not the default one for the following sports (0.1 km/h instead of 1 km/h):</dt><dd><ul>
|
||
<li><p>Hiking</p></li>
|
||
<li><p>Skiing (Cross Country)</p></li>
|
||
<li><p>Snowshoes</p></li>
|
||
<li><p>Trail</p></li>
|
||
<li><p>Walking</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>It can be overridden in user preferences.</p>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p>Dashboard with month calendar displaying workouts and record. The week can start on Sunday or Monday (which can be changed in the user preferences). The calendar displays up to 100 workouts.</p></li>
|
||
<li><p>Workout creation by uploading a gpx file (related data are stored in database with metric system). A workout can even be created without gpx (the user must enter date, time, duration and distance).</p></li>
|
||
<li><p>A workout with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed.</p></li>
|
||
<li><p>Workout gpx file can be downloaded (<strong>new in 0.5.1</strong>)</p></li>
|
||
<li><p>Workout edition and deletion. User can add a note.</p></li>
|
||
<li><dl class="simple">
|
||
<dt>User statistics, by time period (week, month, year) and sport:</dt><dd><ul>
|
||
<li><p>total distance</p></li>
|
||
<li><p>total duration</p></li>
|
||
<li><p>total workouts</p></li>
|
||
<li><p>total ascent (<strong>new in 0.5.0</strong>)</p></li>
|
||
<li><p>total descent (<strong>new in 0.5.0</strong>)</p></li>
|
||
<li><p>average speed (<strong>new in 0.5.1</strong>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
<li><dl class="simple">
|
||
<dt>User records by sports:</dt><dd><ul>
|
||
<li><p>average speed</p></li>
|
||
<li><p>farest distance</p></li>
|
||
<li><p>longest duration</p></li>
|
||
<li><p>maximum speed</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
<li><p>Workouts list and filter. Only sports with workouts are displayed in sport dropdown.</p></li>
|
||
</ul>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>For now, only the owner of the workout can see it.</p>
|
||
</div>
|
||
</section>
|
||
<section id="translations">
|
||
<h3>Translations<a class="headerlink" href="#translations" title="Permalink to this headline">¶</a></h3>
|
||
<p>FitTrackee is available in English and French (which can be saved in the user preferences).</p>
|
||
</section>
|
||
</section>
|
||
<section id="dashboard">
|
||
<h2>Dashboard<a class="headerlink" href="#dashboard" title="Permalink to this headline">¶</a></h2>
|
||
<figure class="align-default">
|
||
<img alt="FitTrackee Dashboard" src="_images/fittrackee_screenshot-01.png" />
|
||
</figure>
|
||
</section>
|
||
<section id="workout-detail">
|
||
<h2>Workout detail<a class="headerlink" href="#workout-detail" title="Permalink to this headline">¶</a></h2>
|
||
<figure class="align-default">
|
||
<img alt="FitTrackee Workout" src="_images/fittrackee_screenshot-02.png" />
|
||
</figure>
|
||
</section>
|
||
<section id="workouts-list">
|
||
<h2>Workouts list<a class="headerlink" href="#workouts-list" title="Permalink to this headline">¶</a></h2>
|
||
<figure class="align-default">
|
||
<img alt="FitTrackee Workouts" src="_images/fittrackee_screenshot-03.png" />
|
||
</figure>
|
||
</section>
|
||
<section id="statistics">
|
||
<h2>Statistics<a class="headerlink" href="#statistics" title="Permalink to this headline">¶</a></h2>
|
||
<figure class="align-default">
|
||
<img alt="FitTrackee Statistics" src="_images/fittrackee_screenshot-04.png" />
|
||
</figure>
|
||
</section>
|
||
<section id="id1">
|
||
<h2>Administration<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||
<figure class="align-default">
|
||
<img alt="FitTrackee Administration" src="_images/fittrackee_screenshot-05.png" />
|
||
</figure>
|
||
<figure class="align-default">
|
||
<img alt="FitTrackee Sports Administration" src="_images/fittrackee_screenshot-06.png" />
|
||
</figure>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<footer class="footer">
|
||
<div class="container">
|
||
<p class="pull-right">
|
||
<a href="#">Back to top</a>
|
||
|
||
</p>
|
||
<p>
|
||
© Copyright 2018 - 2021, SamR1.<br/>
|
||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.1.<br/>
|
||
</p>
|
||
</div>
|
||
</footer>
|
||
</body>
|
||
</html> |