finish tools docs

This commit is contained in:
vcoppe
2024-07-10 15:09:52 +02:00
parent cb4abedc16
commit 7daf26aa5f
17 changed files with 133 additions and 37 deletions

View File

@@ -9,6 +9,10 @@ title: Clean
# <SquareDashedMousePointer size="24" class="inline-block" style="margin-bottom: 5px" /> { title }
When the clean tool is selected, dragging the map will create a rectangle selection.
Depending on the options selected in the dialog shown below, clicking the delete button will remove GPS points and/or [points of interest](../gpx) located either inside or outside the selection.
<div class="flex flex-row justify-center">
<Clean class="text-foreground p-3 border rounded-md shadow-lg" />
</div>

View File

@@ -5,10 +5,20 @@ title: Extract
<script>
import { Ungroup } from 'lucide-svelte';
import Extract from '$lib/components/toolbar/tools/Extract.svelte';
import DocsNote from '$lib/components/docs/DocsNote.svelte';
</script>
# <Ungroup size="24" class="inline-block" style="margin-bottom: 5px" /> { title }
This tool allows you to extract [tracks (or segments)](../gpx) from files (or tracks) containing multiple of them.
<div class="flex flex-row justify-center">
<Extract class="text-foreground p-3 border rounded-md shadow-lg" />
</div>
</div>
Applying the tool to a file containing multiple tracks will create a new file for each of the tracks it contains.
Similarly, applying the tool to a track containing multiple segments will create (in the same file) a new track for each of the segments it contains.
<DocsNote>
When extracting the tracks of a file containing [points of interest](../gpx), the tool will automatically assign each point of interest to the track it is closest to.
</DocsNote>

View File

@@ -9,6 +9,12 @@ title: Merge
# <Group size="24" class="inline-block" style="margin-bottom: 5px" /> { title }
To use this tool, you need to [select](../files-and-stats) multiple files, [tracks or segments](../gpx).
- If your goal is to create a single continuous trace from your selection, use the **Connect the traces** option and validate.
- The second option can be used to create or manage files with multiple [tracks or segments](../gpx).
Merging files (or tracks) will result in a single file (or track) containing all tracks (or segments) from the selection.
<div class="flex flex-row justify-center">
<Merge class="text-foreground p-3 border rounded-md shadow-lg" />
</div>
</div>

View File

@@ -5,10 +5,20 @@ title: Minify
<script>
import { Filter } from 'lucide-svelte';
import Reduce from '$lib/components/toolbar/tools/Reduce.svelte';
import DocsNote from '$lib/components/docs/DocsNote.svelte';
</script>
# <Filter size="24" class="inline-block" style="margin-bottom: 5px" /> { title }
This tool can be used to reduce the number of GPS points of a trace, which can be useful to reduce its size.
You can play with the slider to adjust the tolerance of the simplification algorithm, and see the number of points that will be kept as well as the simplified trace on the map.
<div class="flex flex-row justify-center">
<Reduce class="text-foreground p-3 border rounded-md shadow-lg" />
</div>
</div>
<DocsNote>
The tolerance value represents the maximum distance allowed between the original trace and the simplified trace.
You can read more about the algorithm used <a href="https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm" target="_blank">here</a>.
</DocsNote>

View File

@@ -9,11 +9,11 @@ title: Points of interest
# <MapPin size="24" class="inline-block" style="margin-bottom: 5px" /> { title }
[Points of interest](../gpx) can be added to GPX files to mark locations of interest on the map.
[Points of interest](../gpx) can be added to GPX files to mark locations of interest on the map and show them on your GPS device.
### Creating a point of interest
To create a point of interest, fill in the form as shown below.
To create a point of interest, fill in the form shown below.
You can choose the location of the point of interest either by clicking on the map or by entering the coordinates manually.
Validate the form when you are done.
@@ -23,5 +23,5 @@ Validate the form when you are done.
### Editing a point of interest
You can also use the above form to edit an existing point of interest after selecting it on the map.
The above form can also be used to edit an existing point of interest after selecting it on the map.
If you only need to move the point of interest, you can drag it to the desired location.

View File

@@ -5,10 +5,28 @@ title: Crop and split
<script>
import { ScissorsIcon } from 'lucide-svelte';
import Scissors from '$lib/components/toolbar/tools/Scissors.svelte';
import splitScreenshot from '$lib/assets/img/docs/tools/split.png?enhanced';
import DocsImage from '$lib/components/docs/DocsImage.svelte';
</script>
# <ScissorsIcon size="24" class="inline-block" style="margin-bottom: 5px" /> { title }
## Crop
Using the slider, you can define the part of the selected trace that you want to keep.
The start and end markers on the map and the [statistics and elevation profile](../files-and-stats) are updated in real time to reflect the selection.
Alternatively, you can drag a selection rectangle directly on the elevation profile.
Validate the selection when you are satisfied with the result.
<div class="flex flex-row justify-center">
<Scissors class="text-foreground p-3 border rounded-md shadow-lg" />
</div>
</div>
## Split
To split the selected trace into two parts, you can hover over the trace on the map.
Scissors will appear at the cursor position, and you can click to split the trace at that point.
You can choose to split the trace into two GPX files, or to keep the split parts in the same file as [tracks or segments](../gpx).
<DocsImage src={splitScreenshot} alt="Hovering over the selected trace turns your cursor into scissors." />

View File

@@ -5,10 +5,21 @@ title: Time
<script>
import { CalendarClock } from 'lucide-svelte';
import Time from '$lib/components/toolbar/tools/Time.svelte';
import DocsNote from '$lib/components/docs/DocsNote.svelte';
</script>
# <CalendarClock size="24" class="inline-block" style="margin-bottom: 5px" /> { title }
This tool allows you to change or add timestamps to a trace.
You simply need to use the form shown below, and validate it when you are done.
<div class="flex flex-row justify-center">
<Time class="text-foreground p-3 border rounded-md shadow-lg" />
</div>
</div>
When you edit the speed, the moving time is adapted accordingly in the form, and vice versa.
Similarly, when you edit the start time, the end time is updated to keep the same total duration, and vice versa.
<DocsNote>
When using this tool with existing timestamps, changing the time or speed will simply shift, stretch or compress them accordingly.
</DocsNote>