diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Active content.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Active content.html
index f45db3c93d..cc2294d9ef 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Active content.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Active content.html
@@ -5,116 +5,109 @@
Active content problem of safety, especially when this active content
comes from a third-party such as if it is downloaded from a website and
then imported into Trilium.
-
When importing .zip
- archives into Trilium, safe mode is active by default which will
- try to prevent untrusted code from executing. For example, a custom widget needs
- the #widgetlabel in
- order to function; safe import works by renaming that label to #disabled:widget.
+
When importing .zip archives into Trilium, safe mode is
+ active by default which will try to prevent untrusted code from executing.
+ For example, a custom widget needs the
+ #widgetlabel in order to function;
+ safe import works by renaming that label to #disabled:widget.
Safe mode
Sometimes active content can cause issues with the UI or the server, preventing
- it from functioning properly. Safe mode allows
+ it from functioning properly. Safe mode allows
starting Trilium in such a way that active content is not loaded by default
at start-up, allowing the user to fix the problematic scripts or widgets.
Types of active content
These are the types of active content in Trilium, along with a few examples
of what untrusted content of that type could cause:
Can run custom code on the server of Trilium (Node.js environment), with
- full access to the notes and the database.
-
Has access to all the unencrypted notes, but with full access to the database
- it can completely destroy the data. It also has access to execute other
- applications or alter the files and folders on the server).
Renders custom content inside a note, such as a dashboard or a new editor
- that is not officially supported by Trilium.
-
Can affect the UI similar to front-end scripts or custom widgets since
- the scripts are not completely encapsulated, or they can act similar to
- a web view where they can collect data entered by the user.
Can alter the layout and style of the UI using CSS, applied regardless
- of theme.
-
Generally less problematic than the rest of active content, but a badly
- written CSS can affect the layout of the application, requiring the use
- of Safe mode to
- be able to use the application.
Generally are more contained and less prone to cause issues, but they
- can cause performance issues (for example if the icon pack has millions
- of icons in it).
Can run custom code on the server of Trilium (Node.js environment), with
+ full access to the notes and the database.
+
Has access to all the unencrypted notes, but with full access to the database
+ it can completely destroy the data. It also has access to execute other
+ applications or alter the files and folders on the server).
Renders custom content inside a note, such as a dashboard or a new editor
+ that is not officially supported by Trilium.
+
Can affect the UI similar to front-end scripts or custom widgets since
+ the scripts are not completely encapsulated, or they can act similar to
+ a web view where they can collect data entered by the user.
Can alter the layout and style of the UI using CSS, applied regardless
+ of theme.
+
Generally less problematic than the rest of active content, but a badly
+ written CSS can affect the layout of the application, requiring the use
+ of Safe mode to
+ be able to use the application.
Generally are more contained and less prone to cause issues, but they
+ can cause performance issues (for example if the icon pack has millions
+ of icons in it).
Starting with v0.102.0, on the New Layout a
badge will be displayed near the note title, indicating that an active
content is detected. Clicking the badge will reveal a menu with various
options related to that content type, for example to open the documentation
@@ -122,5 +115,4 @@ style="width:100%;">
For some active content types, such as backend scripts with custom triggering
conditions a toggle button will appear. This makes it possible to easily
disable scripts or widgets, but also to re-enable them if an import was
- made with safe mode active.
-
\ No newline at end of file
+ made with safe mode active.
\ No newline at end of file
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 cfee0ce25f..e86e58f98a 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
@@ -1,9 +1,8 @@
Creating a new geo map
-
-
-
-
-
-
-
-
-
-
-
1
-
-
-
-
-
-
Right click on any note on the note tree and select Insert child note → Geo Map (beta).
-
-
-
2
-
-
-
-
-
-
By default the map will be empty and will show the entire world.
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
1
+
+
+
+
+
+
Right click on any note on the note tree and select Insert child note → Geo Map (beta).
+
+
+
2
+
+
+
+
+
+
By default the map will be empty and will show the entire world.
+
+
+
+
Repositioning the map
Click and drag the map in order to move across the map.
@@ -55,59 +55,60 @@
restored when visiting again the note.
Adding a marker using the map
Adding a new note using the plus button
-
-
-
-
-
-
-
-
-
-
-
1
-
To create a marker, first navigate to the desired point on the map. Then
- press the
- button in the Floating buttons (top-right)
- area.
-
- If the button is not visible, make sure the button section is visible
- by pressing the chevron button (
- ) in the top-right of the map.
-
-
-
-
2
-
-
-
-
Once pressed, the map will enter in the insert mode, as illustrated by
- the notification.
-
- Simply click the point on the map where to place the marker, or the Escape
- key to cancel.
-
-
-
3
-
-
-
-
Enter the name of the marker/note to be created.
-
-
-
4
-
-
-
-
Once confirmed, the marker will show up on the map and it will also be
- displayed as a child note of the map.
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
1
+
To create a marker, first navigate to the desired point on the map. Then
+ press the
+ button in the Floating buttons (top-right)
+ area.
+
+ If the button is not visible, make sure the button section is visible
+ by pressing the chevron button (
+ ) in the top-right of the map.
+
+
+
+
2
+
+
+
+
Once pressed, the map will enter in the insert mode, as illustrated by
+ the notification.
+
+ Simply click the point on the map where to place the marker, or the Escape
+ key to cancel.
+
+
+
3
+
+
+
+
Enter the name of the marker/note to be created.
+
+
+
4
+
+
+
+
Once confirmed, the marker will show up on the map and it will also be
+ displayed as a child note of the map.
+
+
+
+
Adding a new note using the contextual menu
Right click anywhere on the map, where to place the newly created marker
@@ -120,15 +121,18 @@
Adding an existing note on note from the note tree
The value of the attribute is made up of the latitude and longitude separated
by a comma.
Adding from Google Maps
-
-
-
-
-
-
-
-
-
-
-
1
-
-
-
-
-
-
Go to Google Maps on the web and look for a desired location, right click
- on it and a context menu will show up.
-
- Simply click on the first item displaying the coordinates and they will
- be copied to clipboard.
-
- Then paste the value inside the text box into the #geolocation attribute
- of a child note of the map (don't forget to surround the value with a
- "character).
-
-
-
2
-
-
-
-
-
-
In Trilium, create a child note under the map.
-
-
-
3
-
-
-
-
-
-
And then go to Owned Attributes and type #geolocation=",
- then paste from the clipboard as-is and then add the ending " character.
- Press Enter to confirm and the map should now be updated to contain the
- new note.
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
1
+
+
+
+
+
+
Go to Google Maps on the web and look for a desired location, right click
+ on it and a context menu will show up.
+
+ Simply click on the first item displaying the coordinates and they will
+ be copied to clipboard.
+
+ Then paste the value inside the text box into the #geolocation attribute
+ of a child note of the map (don't forget to surround the value with a
+ "character).
+
+
+
2
+
+
+
+
+
+
In Trilium, create a child note under the map.
+
+
+
3
+
+
+
+
+
+
And then go to Owned Attributes and type #geolocation=",
+ then paste from the clipboard as-is and then add the ending " character.
+ Press Enter to confirm and the map should now be updated to contain the
+ new note.
+
+
+
+
Adding from OpenStreetMap
Similarly to the Google Maps approach:
-
-
-
-
-
-
-
-
-
-
-
1
-
-
-
-
Go to any location on openstreetmap.org and right click to bring up the
- context menu. Select the “Show address” item.
-
-
-
2
-
-
-
-
The address will be visible in the top-left of the screen, in the place
- of the search bar.
-
- Select the coordinates and copy them into the clipboard.
-
-
-
3
-
-
-
-
Simply paste the value inside the text box into the #geolocation attribute
- of a child note of the map and then it should be displayed on the map.
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
1
+
+
+
+
Go to any location on openstreetmap.org and right click to bring up the
+ context menu. Select the “Show address” item.
+
+
+
2
+
+
+
+
The address will be visible in the top-left of the screen, in the place
+ of the search bar.
+
+ Select the coordinates and copy them into the clipboard.
+
+
+
3
+
+
+
+
Simply paste the value inside the text box into the #geolocation attribute
+ of a child note of the map and then it should be displayed on the map.
+
+
+
+
Adding GPS tracks (.gpx)
Trilium has basic support for displaying GPS tracks on the geo map.
-
-
-
-
-
-
-
-
-
-
-
1
-
-
-
-
-
-
To add a track, simply drag & drop a .gpx file inside the geo map
- in the note tree.
-
-
-
2
-
-
-
-
-
-
In order for the file to be recognized as a GPS track, it needs to show
- up as application/gpx+xml in the File type field.
-
-
-
3
-
-
-
-
-
-
When going back to the map, the track should now be visible.
-
- The start and end points of the track are indicated by the two blue markers.
-
-
-
-
-
Read-only mode
-
When a map is in read-only all editing features will be disabled such
- as:
Editing from the contextual menu (removing locations or adding new items).
+
+
To enable read-only mode simply press the Lock icon from the
+ Floating buttons. To disable it, press the button again.
+
Configuration
+
Map Style
+
The styling of the map can be adjusted in the Collection Properties (above
+ the map, by pressing on the Gear icon) or manually via the #map:style attribute.
+
The geo map comes with two different types of styles:
+
+
Raster styles
+
+
For these styles the map is represented as a grid of images at different
+ zoom levels. This is the traditional way OpenStreetMap used to work.
+
Zoom is slightly restricted.
+
Currently, the only raster theme is the original OpenStreetMap style.
-
-
Vector styles
-
-
Vector styles are not represented as images, but as geometrical shapes.
- This makes the rendering much smoother, especially when zooming and looking
- at the building edges, for example.
-
The map can be zoomed in much further.
-
These come both in a light and a dark version.
-
The vector styles come from VersaTiles,
- a free and open-source project providing map tiles based on OpenStreetMap.
-
-
-
-
-
Scale
-
Activating this option via the Ribbon or
- manually via #map:scale will display an indicator
- in the bottom-left of the scale of the map.
-
Troubleshooting
-
-
-
-
-
Grid-like artifacts on the map
-
This occurs if the application is not at 100% zoom which causes the pixels
- of the map to not render correctly due to fractional scaling. The only
- possible solution is to set the UI zoom at 100% (default keyboard shortcut
- is Ctrl+0).
\ No newline at end of file
+
+
Vector styles
+
+
Vector styles are not represented as images, but as geometrical shapes.
+ This makes the rendering much smoother, especially when zooming and looking
+ at the building edges, for example.
+
The map can be zoomed in much further.
+
These come both in a light and a dark version.
+
The vector styles come from VersaTiles,
+ a free and open-source project providing map tiles based on OpenStreetMap.
+
+
+
+
Custom map style / tiles
+
Starting with v0.102.0 it is possible to use custom tile sets, but only
+ in raster format.
Custom vector map support is planned, but not yet implemented.
+
Other options
+
The following options can be configured either via the Collection properties
+ pane above the map, by clicking on the settings (Gear icon). Alternatively,
+ each of these options also have a corresponding label that
+ can be set manually.
+
+
+
Scale, which illustrates the scale of the map in kilometers and miles
+ in the bottom-left of the map.
+
+
+
The name of the markers is displayed by default underneath the pin on
+ the map. Since v0.102.0, it is possible to hide these labels which increases
+ the performance and decreases clutter when there are many markers on the
+ map.
+
+
+
Troubleshooting
+
+
+
+
Grid-like artifacts on the map
+
This occurs if the application is not at 100% zoom which causes the pixels
+ of the map to not render correctly due to fractional scaling. The only
+ possible solution is to set the UI zoom at 100% (default keyboard shortcut
+ is Ctrl+0).
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html
index 1bac949e3e..7e6b8cddbe 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html
@@ -2,7 +2,7 @@
Render Note is a special case of front-end scripting which
allows rendering custom content inside a note. This makes it possible to
create custom dashboards, or to use a custom note editor.
The content can either be a vanilla HTML, or Preact JSX.
@@ -13,13 +13,11 @@
HTML language for the legacy/vanilla method, with what needs to be displayed
(for example <p>Hello world.</p>).
Unlike front-end scripts which
- run on the client / browser-side, back-end scripts run directly on the
- Node.js environment of the Trilium server.
+
Unlike front-end scripts which run on the
+ client / browser-side, back-end scripts run directly on the Node.js environment
+ of the Trilium server.
Back-end scripts can be used both on a Server Installation (where
- it will run on the device the server is running on), or on the
- Desktop Installation (where it will run on the PC).
+ href="#root/_help_WOcw2SLH6tbX">Server Installation (where it will run
+ on the device the server is running on), or on the Desktop Installation (where it will
+ run on the PC).
Advantages of backend scripts
The benefit of backend scripts is that they can be pretty powerful, for
example to have access to the underlying system, for example it can read
@@ -14,7 +14,7 @@
access to the notes since the information about them is already loaded
in memory. Whereas on the client, notes have to be manually loaded first.
Create a new Code note
and select the language JS backend.
Running backend scripts
Backend scripts can be either run manually (via the Execute button on
@@ -22,8 +22,8 @@
In addition, scripts can be run automatically when the server starts up,
on a fixed time interval or when a certain event occurs (such as an attribute
being modified). For more information, see the dedicated Events page.
+ href="#root/_help_GPERMystNGTB">Events page.
Script API
Trilium exposes a set of APIs that can be directly consumed by scripts,
under the api object. For a reference of
- this API, see Backend API.
\ No newline at end of file
+ this API, see Backend API.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Backend scripts/Events.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Backend scripts/Events.html
index 3e54232a5d..de4beda67f 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Backend scripts/Events.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Backend scripts/Events.html
@@ -5,139 +5,137 @@
Global events are attached to the script note via label. Simply create
e.g. "run" label with some of these values and script note will be executed
once the event occurs.
-
-
-
-
-
Label
-
Description
-
-
-
-
-
run
-
-
-
Defines on which events script should run. Possible values are:
-
-
backendStartup - when Trilium backend starts
- up
-
hourly - run once an hour. You can use
- additional label runAtHour to specify at
- which hour, on the back-end.
-
daily - run once a day, on the back-end
-
-
-
-
-
runOnInstance
-
-
Specifies that the script should only run on a particular Trilium instance.
-
-
-
runAtHour
-
-
On which hour should this run. Should be used together with #run=hourly.
- Can be defined multiple times for more runs during the day.
-
-
-
-
+
+
+
+
Label
+
Description
+
+
+
+
+
run
+
+
+
Defines on which events script should run. Possible values are:
+
+
backendStartup - when Trilium backend starts
+ up
+
hourly - run once an hour. You can use
+ additional label runAtHour to specify at
+ which hour, on the back-end.
+
daily - run once a day, on the back-end
+
+
+
+
+
runOnInstance
+
+
Specifies that the script should only run on a particular Trilium instance.
+
+
+
runAtHour
+
+
On which hour should this run. Should be used together with #run=hourly.
+ Can be defined multiple times for more runs during the day.
+
+
+
+
Entity events
Other events are bound to some entity, these are defined as relations -
meaning that script is triggered only if note has this script attached
to it through relations (or it can inherit it).
-
-
-
-
-
Relation
-
Trigger condition
-
Origin entity (see below)
-
-
-
-
-
runOnNoteCreation
-
-
executes when note is created on backend. Use this relation if you want
- to run the script for all notes created under a specific subtree. In that
- case, create it on the subtree root note and make it inheritable. A new
- note created within the subtree (any depth) will trigger the script.
-
The BNote that got created.
-
-
-
runOnChildNoteCreation
-
-
executes when new note is created under the note where this relation is
- defined
-
The BNote of the child that got created.
-
-
-
runOnNoteTitleChange
-
-
executes when note title is changed (includes note creation as well)
-
The BNote of the note whose title got changed.
-
-
-
runOnNoteContentChange
-
-
executes when note content is changed (includes note creation as well).
-
The BNote of the note whose content got
- changed.
-
-
-
runOnNoteChange
-
-
executes when note is changed (includes note creation as well). Does not
- include content changes
-
The BNote of the note that got changed.
-
-
-
runOnNoteDeletion
-
-
executes when note is being deleted
-
The BNote of the note that got (soft) deleted.
-
-
-
runOnBranchCreation
-
-
executes when a branch is created. Branch is a link between parent note
- and child note and is created e.g. when cloning or moving note.
-
The BBranch that got created.
-
-
-
runOnBranchChange
-
-
executes when a branch is updated. (since v0.62)
-
The BBranch that got changed.
-
-
-
runOnBranchDeletion
-
-
executes when a branch is deleted. Branch is a link between parent note
- and child note and is deleted e.g. when moving note (old branch/link is
- deleted).
-
The BBranch that got (soft) deleted.
-
-
-
runOnAttributeCreation
-
-
executes when new attribute is created for the note which defines this
- relation
-
The BAttribute that got created.
-
-
-
runOnAttributeChange
-
-
executes when the attribute is changed of a note which defines this relation.
- This is triggered also when the attribute is deleted
-
The BAttribute that got changed.
-
-
-
-
+
+
+
+
Relation
+
Trigger condition
+
Origin entity (see below)
+
+
+
+
+
runOnNoteCreation
+
+
executes when note is created on backend. Use this relation if you want
+ to run the script for all notes created under a specific subtree. In that
+ case, create it on the subtree root note and make it inheritable. A new
+ note created within the subtree (any depth) will trigger the script.
+
The BNote that got created.
+
+
+
runOnChildNoteCreation
+
+
executes when new note is created under the note where this relation is
+ defined
+
The BNote of the child that got created.
+
+
+
runOnNoteTitleChange
+
+
executes when note title is changed (includes note creation as well)
+
The BNote of the note whose title got changed.
+
+
+
runOnNoteContentChange
+
+
executes when note content is changed (includes note creation as well).
+
The BNote of the note whose content got
+ changed.
+
+
+
runOnNoteChange
+
+
executes when note is changed (includes note creation as well). Does not
+ include content changes
+
The BNote of the note that got changed.
+
+
+
runOnNoteDeletion
+
+
executes when note is being deleted
+
The BNote of the note that got (soft) deleted.
+
+
+
runOnBranchCreation
+
+
executes when a branch is created. Branch is a link between parent note
+ and child note and is created e.g. when cloning or moving note.
+
The BBranch that got created.
+
+
+
runOnBranchChange
+
+
executes when a branch is updated. (since v0.62)
+
The BBranch that got changed.
+
+
+
runOnBranchDeletion
+
+
executes when a branch is deleted. Branch is a link between parent note
+ and child note and is deleted e.g. when moving note (old branch/link is
+ deleted).
+
The BBranch that got (soft) deleted.
+
+
+
runOnAttributeCreation
+
+
executes when new attribute is created for the note which defines this
+ relation
+
The BAttribute that got created.
+
+
+
runOnAttributeChange
+
+
executes when the attribute is changed of a note which defines this relation.
+ This is triggered also when the attribute is deleted
+
The BAttribute that got changed.
+
+
+
+
Origin entity
When a script is run by an event such as the ones described above,
Front-end scripts are custom JavaScript notes that are run on the client
(browser environment)
There are four flavors of front-end scripts:
-
-
-
-
-
-
-
-
-
Regular scripts
-
These are run with the current app and note context. These can be run
- either manually or automatically on start-up.
Scripts don't have any special requirements. They can be run manually
using the Execute button on the code note or they can be run automatically;
- to do so, set the runlabel to
+ to do so, set the runlabel to
either:
frontendStartup - when Trilium frontend
@@ -55,23 +54,23 @@ style="width:100%;">
they can run automatically on a hourly or daily basis, but also on events
such as when a note is created or an attribute is modified. See the server-side
Events for more information.
+ class="reference-link" href="#root/_help_GPERMystNGTB">Events for more information.
Widgets
Widgets require a certain format in order for Trilium to be able to integrate
them into the UI.
The front-end API of Trilium is available to all scripts running in the
front-end context as global variable api.
- For a reference of the API, see Frontend API.
Let's start by creating a widget that shows a message near the content
@@ -62,81 +61,79 @@ export default defineWidget({
should appear underneath the content area.
Widget location (parent widget)
A widget can be placed in one of the following sections of the applications:
-
-
-
-
-
-
-
-
-
-
-
Value for parentWidget
-
-
Description
-
Sample widget
-
Special requirements
-
-
-
-
-
left-pane
-
-
Appears within the same pane that holds the Note Tree.
-
Same as above, with only a different parentWidget.
-
None.
-
-
-
center-pane
-
-
In the content area. If a split is open, the widget will span all of the
- splits.
-
See example above.
-
None.
-
-
-
note-detail-pane
-
-
-
In the content area, inside the note detail area. If a split is open,
- the widget will be contained inside the split.
The widget must export a class and not an
- instance of the class (e.g. no new) because
- it needs to be multiplied for each note, so that splits work correctly.
-
Since the class is exported instead of an
- instance, the parentWidget getter must be
- static, otherwise the widget is ignored.
The widget must export a class and not an
+ instance of the class (e.g. no new) because
+ it needs to be multiplied for each note, so that splits work correctly.
+
Since the class is exported instead of an
+ instance, the parentWidget getter must be
+ static, otherwise the widget is ignored.
Although not mandatory, it's best to use a RightPanelWidget instead
+ of a BasicWidget or a NoteContextAwareWidget.
+
+
+
+
-
To position the widget somewhere else, just change the value passed to
get parentWidget()for legacy widgets or the parent field
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics/Launch Bar Widgets.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics/Launch Bar Widgets.html
index c2b91ba4ed..acf5a50e35 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics/Launch Bar Widgets.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics/Launch Bar Widgets.html
@@ -20,16 +20,11 @@
Don't set #widget, as that attribute is
reserved for Custom Widgets.
If the button is not visible, make sure the button section is visible by pressing the chevron button () in the top-right of the map. | |
-| 2 | | Once pressed, the map will enter in the insert mode, as illustrated by the notification.
Simply click the point on the map where to place the marker, or the Escape key to cancel. |
+| 1 | To create a marker, first navigate to the desired point on the map. Then press the  button in the [Floating buttons](../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) (top-right) area.
If the button is not visible, make sure the button section is visible by pressing the chevron button () in the top-right of the map. | |
+| 2 | | Once pressed, the map will enter in the insert mode, as illustrated by the notification.
Simply click the point on the map where to place the marker, or the Escape key to cancel. |
| 3 | | Enter the name of the marker/note to be created. |
| 4 | | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. |
@@ -109,7 +109,7 @@ The value of the attribute is made up of the latitude and longitude separated by
| | | |
| --- | --- | --- |
-| 1 | | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up.
Simply click on the first item displaying the coordinates and they will be copied to clipboard.
Then paste the value inside the text box into the `#geolocation` attribute of a child note of the map (don't forget to surround the value with a `"` character). |
+| 1 | | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up.
Simply click on the first item displaying the coordinates and they will be copied to clipboard.
Then paste the value inside the text box into the `#geolocation` attribute of a child note of the map (don't forget to surround the value with a `"` character). |
| 2 | | In Trilium, create a child note under the map. |
| 3 | | And then go to Owned Attributes and type `#geolocation="`, then paste from the clipboard as-is and then add the ending `"` character. Press Enter to confirm and the map should now be updated to contain the new note. |
@@ -120,7 +120,7 @@ Similarly to the Google Maps approach:
| | | |
| --- | --- | --- |
| 1 | | Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item. |
-| 2 | | The address will be visible in the top-left of the screen, in the place of the search bar.
Select the coordinates and copy them into the clipboard. |
+| 2 | | The address will be visible in the top-left of the screen, in the place of the search bar.
Select the coordinates and copy them into the clipboard. |
| 3 | | Simply paste the value inside the text box into the `#geolocation` attribute of a child note of the map and then it should be displayed on the map. |
## Adding GPS tracks (.gpx)
@@ -131,7 +131,7 @@ Trilium has basic support for displaying GPS tracks on the geo map.
| --- | --- | --- |
| 1 | | To add a track, simply drag & drop a .gpx file inside the geo map in the note tree. |
| 2 | | In order for the file to be recognized as a GPS track, it needs to show up as `application/gpx+xml` in the _File type_ field. |
-| 3 | | When going back to the map, the track should now be visible.
The start and end points of the track are indicated by the two blue markers. |
+| 3 | | When going back to the map, the track should now be visible.
The start and end points of the track are indicated by the two blue markers. |
> [!NOTE]
> The starting point of the track will be displayed as a marker, with the name of the note underneath. The start marker will also respect the icon and the `color` of the note. The end marker is displayed with a distinct icon.
@@ -152,7 +152,7 @@ To enable read-only mode simply press the _Lock_ icon from the Ribbon or manually via the `#map:style` attribute.
+The styling of the map can be adjusted in the _Collection Properties_ (above the map, by pressing on the Gear icon) or manually via the `#map:style` attribute.
The geo map comes with two different types of styles:
@@ -166,12 +166,23 @@ The geo map comes with two different types of styles:
* These come both in a light and a dark version.
* The vector styles come from [VersaTiles](https://versatiles.org/), a free and open-source project providing map tiles based on OpenStreetMap.
+### Custom map style / tiles
+
+Starting with v0.102.0 it is possible to use custom tile sets, but only in raster format.
+
+To do so, manually set the `#map:style` [label](../Advanced%20Usage/Attributes/Labels.md) to the URL of the tile set. For example, to use Esri.NatGeoWorldMap, set the value to [`https://server.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer/tile/{z}/{y}/{x}`.](https://server.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer/tile/{z}/{y}/{x}.)
+
> [!NOTE]
-> Currently it is not possible to use a custom map style.
+> For a list of tile sets, see the [Leaflet Providers preview](https://leaflet-extras.github.io/leaflet-providers/preview/) page. Select a desired tile set and just copy the URL from the _Plain JavaScript_ example.
-### Scale
+Custom vector map support is planned, but not yet implemented.
-Activating this option via the Ribbon or manually via `#map:scale` will display an indicator in the bottom-left of the scale of the map.
+### Other options
+
+The following options can be configured either via the Collection properties pane above the map, by clicking on the settings (Gear icon). Alternatively, each of these options also have a corresponding [label](../Advanced%20Usage/Attributes/Labels.md) that can be set manually.
+
+* Scale, which illustrates the scale of the map in kilometers and miles in the bottom-left of the map.
+* The name of the markers is displayed by default underneath the pin on the map. Since v0.102.0, it is possible to hide these labels which increases the performance and decreases clutter when there are many markers on the map.
## Troubleshooting
- 
- 
button in the Floating buttons (top-right)
- area.
- 
) in the top-right of the map.
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-
+There are multiple types of documentation for Trilium:
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index 817f450e42..f9136647f9 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -6459,6 +6459,97 @@
"type": "text",
"mime": "text/html",
"attributes": [
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "mHbBMPDPkVV5",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "MgibgPcfeuGz",
+ "isInheritable": false,
+ "position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "HI6GBBIduIgv",
+ "isInheritable": false,
+ "position": 30
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "64ZTlUPgEPtW",
+ "isInheritable": false,
+ "position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "yIhgI5H7A2Sm",
+ "isInheritable": false,
+ "position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "RnaPdbciOfeq",
+ "isInheritable": false,
+ "position": 60
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "SPirpZypehBG",
+ "isInheritable": false,
+ "position": 70
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "1vHRoWCEjj0L",
+ "isInheritable": false,
+ "position": 80
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "HcABDtFCkbFN",
+ "isInheritable": false,
+ "position": 90
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "AlhDUqhENtH7",
+ "isInheritable": false,
+ "position": 100
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "pKK96zzmvBGf",
+ "isInheritable": false,
+ "position": 110
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "gOKqSJgXLcIj",
+ "isInheritable": false,
+ "position": 120
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "IjZS7iK5EXtb",
+ "isInheritable": false,
+ "position": 130
+ },
{
"type": "label",
"name": "iconClass",
@@ -6472,97 +6563,6 @@
"value": "active-content",
"isInheritable": false,
"position": 40
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "MgibgPcfeuGz",
- "isInheritable": false,
- "position": 50
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "1vHRoWCEjj0L",
- "isInheritable": false,
- "position": 70
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "yIhgI5H7A2Sm",
- "isInheritable": false,
- "position": 100
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "HcABDtFCkbFN",
- "isInheritable": false,
- "position": 110
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "RnaPdbciOfeq",
- "isInheritable": false,
- "position": 120
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "SPirpZypehBG",
- "isInheritable": false,
- "position": 130
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "mHbBMPDPkVV5",
- "isInheritable": false,
- "position": 150
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "AlhDUqhENtH7",
- "isInheritable": false,
- "position": 160
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "pKK96zzmvBGf",
- "isInheritable": false,
- "position": 170
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "gOKqSJgXLcIj",
- "isInheritable": false,
- "position": 180
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "64ZTlUPgEPtW",
- "isInheritable": false,
- "position": 190
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "HI6GBBIduIgv",
- "isInheritable": false,
- "position": 200
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "IjZS7iK5EXtb",
- "isInheritable": false,
- "position": 210
}
],
"format": "markdown",
@@ -9943,7 +9943,7 @@
{
"type": "relation",
"name": "internalLink",
- "value": "CdNpE2pqjmI6",
+ "value": "yIhgI5H7A2Sm",
"isInheritable": false,
"position": 10
},
@@ -9971,31 +9971,38 @@
{
"type": "relation",
"name": "internalLink",
- "value": "XpOYSgsLkTJy",
+ "value": "CdNpE2pqjmI6",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
- "value": "A9Oc6YKKc65v",
+ "value": "XpOYSgsLkTJy",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
- "value": "R7abl2fc6Mxi",
+ "value": "A9Oc6YKKc65v",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
- "value": "6tZeKvSHEUiB",
+ "value": "R7abl2fc6Mxi",
"isInheritable": false,
"position": 80
},
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "6tZeKvSHEUiB",
+ "isInheritable": false,
+ "position": 90
+ },
{
"type": "label",
"name": "iconClass",
@@ -10009,13 +10016,6 @@
"value": "render-note",
"isInheritable": false,
"position": 70
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "yIhgI5H7A2Sm",
- "isInheritable": false,
- "position": 90
}
],
"format": "markdown",
@@ -11175,20 +11175,6 @@
"type": "text",
"mime": "text/html",
"attributes": [
- {
- "type": "relation",
- "name": "internalLink",
- "value": "zEY4DaJG4YT5",
- "isInheritable": false,
- "position": 10
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "OFXdgB2nNk1F",
- "isInheritable": false,
- "position": 20
- },
{
"type": "relation",
"name": "internalLink",
@@ -11238,13 +11224,6 @@
"isInheritable": false,
"position": 90
},
- {
- "type": "relation",
- "name": "internalLink",
- "value": "BlN9DFI679QC",
- "isInheritable": false,
- "position": 100
- },
{
"type": "label",
"name": "iconClass",
@@ -11258,6 +11237,13 @@
"value": "geomap",
"isInheritable": false,
"position": 90
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "HI6GBBIduIgv",
+ "isInheritable": false,
+ "position": 110
}
],
"format": "markdown",
@@ -16248,10 +16234,94 @@
{
"type": "relation",
"name": "internalLink",
- "value": "SynTBQiBsdYJ",
+ "value": "MgibgPcfeuGz",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "oPVyFC7WL2Lp",
+ "isInheritable": false,
+ "position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "RnaPdbciOfeq",
"isInheritable": false,
"position": 30
},
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "4Gn3psZKsfSm",
+ "isInheritable": false,
+ "position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "xYmIYSP6wE3F",
+ "isInheritable": false,
+ "position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "HcABDtFCkbFN",
+ "isInheritable": false,
+ "position": 60
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "SPirpZypehBG",
+ "isInheritable": false,
+ "position": 70
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "HI6GBBIduIgv",
+ "isInheritable": false,
+ "position": 80
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "GPERMystNGTB",
+ "isInheritable": false,
+ "position": 90
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "GhurYZjh8e1V",
+ "isInheritable": false,
+ "position": 100
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "M8IppdwVHSjG",
+ "isInheritable": false,
+ "position": 110
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "Q2z6av6JZVWm",
+ "isInheritable": false,
+ "position": 120
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "SynTBQiBsdYJ",
+ "isInheritable": false,
+ "position": 130
+ },
{
"type": "label",
"name": "shareAlias",
@@ -16265,90 +16335,6 @@
"value": "bx bx-window",
"isInheritable": false,
"position": 40
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "Q2z6av6JZVWm",
- "isInheritable": false,
- "position": 50
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "GhurYZjh8e1V",
- "isInheritable": false,
- "position": 60
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "M8IppdwVHSjG",
- "isInheritable": false,
- "position": 70
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "MgibgPcfeuGz",
- "isInheritable": false,
- "position": 80
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "SPirpZypehBG",
- "isInheritable": false,
- "position": 90
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "RnaPdbciOfeq",
- "isInheritable": false,
- "position": 100
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "oPVyFC7WL2Lp",
- "isInheritable": false,
- "position": 110
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "4Gn3psZKsfSm",
- "isInheritable": false,
- "position": 120
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "xYmIYSP6wE3F",
- "isInheritable": false,
- "position": 130
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "HcABDtFCkbFN",
- "isInheritable": false,
- "position": 140
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "HI6GBBIduIgv",
- "isInheritable": false,
- "position": 150
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "GPERMystNGTB",
- "isInheritable": false,
- "position": 160
}
],
"format": "markdown",
@@ -16980,6 +16966,13 @@
"isInheritable": false,
"position": 60
},
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "s8alTXmpFR61",
+ "isInheritable": false,
+ "position": 70
+ },
{
"type": "label",
"name": "iconClass",
@@ -16993,13 +16986,6 @@
"value": "launch-bar-widgets",
"isInheritable": false,
"position": 40
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "s8alTXmpFR61",
- "isInheritable": false,
- "position": 70
}
],
"format": "markdown",
@@ -17444,6 +17430,48 @@
"type": "text",
"mime": "text/html",
"attributes": [
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "yIhgI5H7A2Sm",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "WOcw2SLH6tbX",
+ "isInheritable": false,
+ "position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "poXkQfguuA0U",
+ "isInheritable": false,
+ "position": 30
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "6f9hih2hXXZk",
+ "isInheritable": false,
+ "position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "GPERMystNGTB",
+ "isInheritable": false,
+ "position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "MEtfsqa5VwNi",
+ "isInheritable": false,
+ "position": 60
+ },
{
"type": "label",
"name": "shareAlias",
@@ -17457,48 +17485,6 @@
"value": "bx bx-server",
"isInheritable": false,
"position": 40
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "yIhgI5H7A2Sm",
- "isInheritable": false,
- "position": 50
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "WOcw2SLH6tbX",
- "isInheritable": false,
- "position": 60
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "poXkQfguuA0U",
- "isInheritable": false,
- "position": 70
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "MEtfsqa5VwNi",
- "isInheritable": false,
- "position": 80
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "6f9hih2hXXZk",
- "isInheritable": false,
- "position": 90
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "GPERMystNGTB",
- "isInheritable": false,
- "position": 100
}
],
"format": "markdown",
diff --git a/docs/User Guide/User Guide.md b/docs/User Guide/User Guide.md
index d02f4ecc38..ce5357b26e 100644
--- a/docs/User Guide/User Guide.md
+++ b/docs/User Guide/User Guide.md
@@ -15,7 +15,7 @@ Trilium is an open-source solution for note-taking and organizing a personal kno
*