Skip to content

Build your personal knowledge base with Trilium Notes

docs(geomap): describe the locate button

Elian Doran8bc221b5595a
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html
index a0e634536f..6895982d85 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html
@@ -13,6 +13,7 @@
world.</li>
<li>Turn a place the map already shows into a marker by clicking it.</li>
<li>Display tracks on the map using <code spellcheck="false">.gpx</code> files.</li>
+ <li>Show your own location on the map and follow it as you move.</li>
<li>3D view of the map, which displays buildings when using a vector map.</li>
</ul>
<h2>System requirements</h2>
@@ -21,6 +22,10 @@
can render it in software if needed.</p>
<p>If the map could not be drawn because WebGL could not be initialized,
an error message will appear instead of the map (<em>This map can't be drawn because WebGL isn't available…</em>).</p>
+<p>The button that shows your location is offered only when Trilium is reached
+ over HTTPS, in the desktop application or in the mobile application. Browsers
+ refuse to share the location of a device with a page served over plain HTTP,
+ so on such a server the button does not appear.</p>
<h2>Interaction</h2>
<ul>
<li>At the top-left there is the search bar. It searches the notes already
@@ -37,6 +42,7 @@
<li>On desktop, alternatively use the scroll wheel to adjust the zoom.</li>
</ul>
</li>
+ <li>A button that shows your location on the map and follows it (see <em>Going to your location</em> below).</li>
<li>Full screen button which focuses the entire map onto the screen, while
still allowing for edits.</li>
</ul>
@@ -61,6 +67,27 @@
by a script or through <a class="reference-link" href="#root/_help_pgxEVkzLl1OP">ETAPI (REST API)</a>.
When you add markers yourself you have already moved the map to reach the
place you are marking, and that movement saves a position.</p>
+<h2>Going to your location</h2>
+<p>Press the <em>Show your location</em> button at the bottom-right of the map,
+ beside the zoom buttons. The first time, the browser or the operating system
+ asks whether Trilium may know where the device is. In the desktop application
+ the operating system's location settings decide.</p>
+<p>The map then moves to where the device is and marks it with a blue dot.
+ A lighter circle around the dot shows how accurate the position is: a phone
+ with GPS gives a dot on the street, while a computer located through its
+ network connection can give a circle that covers a neighbourhood. The map
+ follows the dot as it moves, and the button stays pressed while it does.</p>
+<p>Dragging the map stops it from following. The dot stays and keeps moving,
+ and pressing the button again brings the map back to it. Pressing the button
+ while the map is following turns the dot off.</p>
+<p>If the position cannot be found, a message says so and the button keeps
+ waiting for one; press it again to stop. If you refuse the permission, the
+ button is disabled until the map is opened again. To allow it after all,
+ change the permission for Trilium in the browser or in the system's location
+ settings.</p>
+<p>Your position is not stored in the note and is not sent anywhere. The map
+ does remember where you left it, as it does after any other movement, so
+ a map you have taken to your location opens there the next time.</p>
<h2>Searching the map</h2>
<p>The search bar at the top-left of the map searches in two places. It always
searches the notes that are already on the map. It can also search for
diff --git a/docs/User Guide/User Guide/Collections/Geo Map.md b/docs/User Guide/User Guide/Collections/Geo Map.md
index 58bed0d817..108b9c01ea 100644
--- a/docs/User Guide/User Guide/Collections/Geo Map.md
+++ b/docs/User Guide/User Guide/Collections/Geo Map.md
@@ -9,6 +9,7 @@ This note type displays the children notes on a geographical map, based on an at
* Search the notes already on the map, and look up places anywhere in the world.
* Turn a place the map already shows into a marker by clicking it.
* Display tracks on the map using `.gpx` files.
+* Show your own location on the map and follow it as you move.
* 3D view of the map, which displays buildings when using a vector map.
## System requirements
@@ -17,6 +18,8 @@ Starting with v0.105.0, the geomap uses MapLibre GL which requires WebGL v1 supp
If the map could not be drawn because WebGL could not be initialized, an error message will appear instead of the map (_This map can't be drawn because WebGL isn't available…_).
+The button that shows your location is offered only when Trilium is reached over HTTPS, in the desktop application or in the mobile application. Browsers refuse to share the location of a device with a page served over plain HTTP, so on such a server the button does not appear.
+
## Interaction
* At the top-left there is the search bar. It searches the notes already on the map, and it can also search for places online when you ask it to. While you move through the results of a search, a counter with previous and next buttons appears under it.
@@ -25,6 +28,7 @@ If the map could not be drawn because WebGL could not be initialized, an error m
* Zoom in/out
* On mobile these are hidden, use pinch to zoom instead.
* On desktop, alternatively use the scroll wheel to adjust the zoom.
+ * A button that shows your location on the map and follows it (see _Going to your location_ below).
* Full screen button which focuses the entire map onto the screen, while still allowing for edits.
## Creating a new geo map
@@ -44,6 +48,18 @@ A map that has no position saved yet is framed around the markers it contains wh
In practice this applies to maps whose markers were added externally, by a script or through <a class="reference-link" href="../Advanced%20Usage/ETAPI%20(REST%20API).md">ETAPI (REST API)</a>. When you add markers yourself you have already moved the map to reach the place you are marking, and that movement saves a position.
+## Going to your location
+
+Press the _Show your location_ button at the bottom-right of the map, beside the zoom buttons. The first time, the browser or the operating system asks whether Trilium may know where the device is. In the desktop application the operating system's location settings decide.
+
+The map then moves to where the device is and marks it with a blue dot. A lighter circle around the dot shows how accurate the position is: a phone with GPS gives a dot on the street, while a computer located through its network connection can give a circle that covers a neighbourhood. The map follows the dot as it moves, and the button stays pressed while it does.
+
+Dragging the map stops it from following. The dot stays and keeps moving, and pressing the button again brings the map back to it. Pressing the button while the map is following turns the dot off.
+
+If the position cannot be found, a message says so and the button keeps waiting for one; press it again to stop. If you refuse the permission, the button is disabled until the map is opened again. To allow it after all, change the permission for Trilium in the browser or in the system's location settings.
+
+Your position is not stored in the note and is not sent anywhere. The map does remember where you left it, as it does after any other movement, so a map you have taken to your location opens there the next time.
+
## Searching the map
The search bar at the top-left of the map searches in two places. It always searches the notes that are already on the map. It can also search for places online, but only when you ask it to.