Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-30 09:56:36 +01:00
Code Issues Packages Projects Releases Activity

docs(guide): document new features for geomap

Browse Source
This commit is contained in:
Elian Doran
2025-07-24 23:39:25 +03:00
parent 051fe67176
commit 7055f77c91
21 changed files with 2386 additions and 2398 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Labels.html generated vendored
View File

@@ -52,8 +52,7 @@
are multiple labels with the same prefix, consult the specific page linked
in the description of that label for more information.</p>
</aside>
<figure class="table" style="width:100%;">
<table class="ck-table-resized">
<table class="ck-table-resized">
<colgroup>
<col style="width:33.82%;">
<col style="width:66.18%;">
@@ -381,5 +380,4 @@
href="#root/_help_0ESUbbAxVnoK">Note List</a>&nbsp;for more information.</td>
</tr>
</tbody>
</table>
</figure>
</table>

8
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Relations.html generated vendored
View File

@@ -61,12 +61,7 @@ class="admonition tip">
there are multiple relations with the same prefix, consult the specific
page linked in the description of that relation for more information.</p>
</aside>
<figure class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:33.95%;">
<col style="width:66.05%;">
</colgroup>
<table>
<thead>
<tr>
<th>Label</th>
@@ -136,4 +131,3 @@ class="admonition tip">
</tr>
</tbody>
</table>
</figure>

17
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or environment variables)/Cross-Origin Resource Sharing .html generated vendored
View File

@@ -3,13 +3,7 @@
<p>However, it is possible to manually configure <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS">Cross-Origin Resource Sharing (CORS)</a> since
Trilium v0.93.0 using environment variables or <code>config.ini</code>,
as follows:</p>
<figure class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:26.93%;">
<col style="width:32.46%;">
<col style="width:40.61%;">
</colgroup>
<table>
<thead>
<tr>
<th>CORS Header</th>
@@ -24,14 +18,16 @@
</td>
<td><code>TRILIUM_NETWORK_CORS_ALLOW_ORIGIN</code>
</td>
<td><code>corsAllowOrigin</code>&nbsp;</td>
<td><code>corsAllowOrigin</code>
</td>
</tr>
<tr>
<td><code>Access-Control-Allow-Methods</code>
</td>
<td><code>TRILIUM_NETWORK_CORS_ALLOW_METHODS</code>
</td>
<td><code>corsAllowMethods</code>&nbsp;</td>
<td><code>corsAllowMethods</code>
</td>
</tr>
<tr>
<td><code>Access-Control-Allow-Headers</code>
@@ -42,5 +38,4 @@
</td>
</tr>
</tbody>
</table>
</figure>
</table>

6
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Hidden Notes.html generated vendored
View File

@@ -22,9 +22,8 @@
select <em>Advanced</em> → <em>Show Hidden Subtree</em>.</p>
<h2>Contents of the hidden note tree</h2>
<p>Here is a brief summary of all the notes within the hidden tree:</p>
<figure
class="table" style="width:100%;">
<table class="ck-table-resized">
<table
class="ck-table-resized">
<colgroup>
<col style="width:19.93%;">
<col style="width:80.07%;">
@@ -179,4 +178,3 @@ class="table" style="width:100%;">
</tr>
</tbody>
</table>
</figure>

4
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html generated vendored
View File

@@ -19,7 +19,6 @@ class="image">
<li>Displaying the date of the last update of the note.</li>
</ul>
<h3>By note type</h3>
<figure class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:19.92%;">
@@ -166,7 +165,6 @@ class="image">
</tr>
</tbody>
</table>
</figure>
<p>While the sharing feature is powerful, it has some limitations:</p>
<ul>
<li><strong>Code Notes</strong>: No syntax highlighting.</li>
@@ -269,7 +267,6 @@ for (const attr of parentNote.attributes) {
this with the <code>#shareIndex</code> label, which will display a list of
all shared notes.</p>
<h2>Attribute reference</h2>
<figure class="table">
<table>
<thead>
<tr>
@@ -345,7 +342,6 @@ for (const attr of parentNote.attributes) {
</tr>
</tbody>
</table>
</figure>
<h2>Credits</h2>
<p>Since v0.95.0, a new theme was introduced (and enabled by default) which

6
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the content o.html generated vendored
View File

@@ -1,8 +1,7 @@
<p>When accessing a shared note, Trilium will render it as a web page. Sometimes
it's desirable to serve the content directly so that it can be used in
a script or downloaded by the user.</p>
<figure class="table">
<table>
<table>
<thead>
<tr>
<th>A note displayed as a web page (HTML)</th>
@@ -22,8 +21,7 @@
</td>
</tr>
</tbody>
</table>
</figure>
</table>
<h2>By adding an attribute to the note</h2>
<p>Simply add the <code>#shareRaw</code> attribute and the note will always

6
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Workspaces.html generated vendored
View File

@@ -23,8 +23,7 @@
</li>
</ul>
<h3>Configuration</h3>
<figure class="table">
<table>
<table>
<thead>
<tr>
<th>Label</th>
@@ -76,5 +75,4 @@
this workspace note</td>
</tr>
</tbody>
</table>
</figure>
</table>

4
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List.html generated vendored
View File

@@ -6,10 +6,10 @@
of the note for easy navigation.</p>
<h2>Configuration</h2>
<ul>
<li data-list-item-id="eb5063d3ae8e7f0da6afcdd9c3250c426">To hide the note list for a particular note, simply apply the <code>hideChildrenOverview</code>
<li>To hide the note list for a particular note, simply apply the <code>hideChildrenOverview</code>
<a
href="#root/_help_zEY4DaJG4YT5">label</a>.</li>
<li data-list-item-id="e50e31d45fae6051c1ff7fab14387aff7">For some view types, such as Grid view, only a subset of notes will be
<li>For some view types, such as Grid view, only a subset of notes will be
displayed and pagination can be used to navigate through all of them for
performance reasons. To adjust the number of notes per page, set <code>pageSize</code> to
the desired number.</li>

6
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes/Theme Gallery.html generated vendored
View File

@@ -2,8 +2,7 @@
<h2>Legacy Themes</h2>
<p>These themes may or may not be compatible with the latest versions of
TriliumNext and are based on the original/legacy theme.</p>
<figure class="table">
<table>
<table>
<thead>
<tr>
<th>Theme</th>
@@ -118,8 +117,7 @@
</td>
</tr>
</tbody>
</table>
</figure>
</table>
<aside class="admonition tip">
<p>If you would like to add your theme to this gallery, write a new post
in <a href="https://github.com/TriliumNext/Notes/discussions/categories/show-and-tell">👐 Show and tell</a>.</p>

20
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types.html generated vendored
View File

@@ -31,13 +31,7 @@
used to edit the <a href="#root/_help_4FahAwuGTAwC">source of a note</a>.</p>
<h2>Supported note types</h2>
<p>The following note types are supported by Trilium:</p>
<figure class="table"
style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:29.42%;">
<col style="width:70.58%;">
</colgroup>
<table>
<thead>
<tr>
<th>Note Type</th>
@@ -86,11 +80,10 @@ style="width:100%;">
<tr>
<td><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>
</td>
<td>
<p>Displays the children of the note either as a grid, a list, or for a more
specialized case: a calendar.</p>
<p>Generally useful for easy reading of short notes.</p>
</td>
<td>Displays the children of the note either as a grid, a list, or for a more
specialized case: a calendar.
<br>
<br>Generally useful for easy reading of short notes.</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a>
@@ -128,5 +121,4 @@ style="width:100%;">
<td>Represents an uploaded file such as PDFs, images, video or audio files.</td>
</tr>
</tbody>
</table>
</figure>
</table>

92
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Calendar View.html generated vendored
View File

@@ -18,13 +18,12 @@
kind of interaction, such as moving events around as well as creating new
ones.</p>
<h2>Creating a calendar</h2>
<figure class="table">
<table>
<table>
<thead>
<tr>
<th>&nbsp;</th>
<th>&nbsp;</th>
<th>&nbsp;</th>
<th></th>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
@@ -46,8 +45,7 @@
by selecting the “Collection Properties” tab in the ribbon.</td>
</tr>
</tbody>
</table>
</figure>
</table>
<h2>Creating a new event/note</h2>
<ul>
@@ -94,9 +92,7 @@
</ul>
<h2>Configuring the calendar using attributes</h2>
<p>The following attributes can be added to the Collection type:</p>
<figure
class="table">
<table>
<table>
<thead>
<tr>
<th>Name</th>
@@ -140,15 +136,12 @@ class="table">
or clicking).</td>
</tr>
</tbody>
</table>
</figure>
<p>In addition, the first day of the week can be either Sunday or Monday
</table>
<p>In addition, the first day of the week can be either Sunday or Monday
and can be adjusted from the application settings.</p>
<h2>Configuring the calendar events using attributes</h2>
<p>For each note of the calendar, the following attributes can be used:</p>
<figure
class="table">
<table>
<h2>Configuring the calendar events using attributes</h2>
<p>For each note of the calendar, the following attributes can be used:</p>
<table>
<thead>
<tr>
<th>Name</th>
@@ -252,35 +245,34 @@ class="table">
which is being used to read the end time.</td>
</tr>
</tbody>
</table>
</figure>
</table>
<h2>How the calendar works</h2>
<p>
<p>
<img src="11_Calendar View_image.png">
</p>
<p>The calendar displays all the child notes of the Collection that have
</p>
<p>The calendar displays all the child notes of the Collection that have
a <code>#startDate</code>. An <code>#endDate</code> can optionally be added.</p>
<p>If editing the start date and end date from the note itself is desirable,
<p>If editing the start date and end date from the note itself is desirable,
the following attributes can be added to the Collection note:</p><pre><code class="language-text-x-trilium-auto">#viewType=calendar #label:startDate(inheritable)="promoted,alias=Start Date,single,date"
#label:endDate(inheritable)="promoted,alias=End Date,single,date"
#hidePromotedAttributes </code></pre>
<p>This will result in:</p>
<p>
<p>This will result in:</p>
<p>
<img src="10_Calendar View_image.png">
</p>
<p>When not used in a Journal, the calendar is recursive. That is, it will
</p>
<p>When not used in a Journal, the calendar is recursive. That is, it will
look for events not just in its child notes but also in the children of
these child notes.</p>
<h2>Use-cases</h2>
<h3>Using with the Journal / calendar</h3>
<p>It is possible to integrate the calendar view into the Journal with day
<h2>Use-cases</h2>
<h3>Using with the Journal / calendar</h3>
<p>It is possible to integrate the calendar view into the Journal with day
notes. In order to do so change the note type of the Journal note (calendar
root) to Collection and then select the Calendar View.</p>
<p>Based on the <code>#calendarRoot</code> (or <code>#workspaceCalendarRoot</code>)
<p>Based on the <code>#calendarRoot</code> (or <code>#workspaceCalendarRoot</code>)
attribute, the calendar will know that it's in a calendar and apply the
following:</p>
<ul>
<ul>
<li>The calendar events are now rendered based on their <code>dateNote</code> attribute
rather than <code>startDate</code>.</li>
<li>Interactive editing such as dragging over an empty era or resizing an
@@ -290,21 +282,19 @@ class="table">
<li>Direct children of a day note will be displayed on the calendar despite
not having a <code>dateNote</code> attribute. Children of the child notes
will not be displayed.</li>
</ul>
<img src="8_Calendar View_image.png" width="1217" height="724">
</ul>
<img src="8_Calendar View_image.png" width="1217" height="724">
<h3>Using a different attribute as event title</h3>
<p>By default, events are displayed on the calendar by their note title.
<p>By default, events are displayed on the calendar by their note title.
However, it is possible to configure a different attribute to be displayed
instead.</p>
<p>To do so, assign <code>#calendar:title</code> to the child note (not the
<p>To do so, assign <code>#calendar:title</code> to the child note (not the
calendar/Collection note), with the value being <code>name</code> where <code>name</code> can
be any label (make not to add the <code>#</code> prefix). The attribute can
also come through inheritance such as a template attribute. If the note
does not have the requested label, the title of the note will be used instead.</p>
<figure
class="table" style="width:100%;">
<table>
<table>
<thead>
<tr>
<th>&nbsp;</th>
@@ -324,18 +314,15 @@ class="table">
</td>
</tr>
</tbody>
</table>
</figure>
</table>
<h3>Using a relation attribute as event title</h3>
<p>Similarly to using an attribute, use <code>#calendar:title</code> and set
<p>Similarly to using an attribute, use <code>#calendar:title</code> and set
it to <code>name</code> where <code>name</code> is the name of the relation
to use.</p>
<p>Moreover, if there are more relations of the same name, they will be displayed
<p>Moreover, if there are more relations of the same name, they will be displayed
as multiple events coming from the same note.</p>
<figure class="table"
style="width:100%;">
<table>
<table>
<thead>
<tr>
<th>&nbsp;</th>
@@ -351,15 +338,13 @@ class="table">
</td>
</tr>
</tbody>
</table>
</figure>
<p>Note that it's even possible to have a <code>#calendar:title</code> on the
</table>
<p>Note that it's even possible to have a <code>#calendar:title</code> on the
target note (e.g. “John Smith”) which will try to render an attribute of
it. Note that it's not possible to use a relation here as well for safety
reasons (an accidental recursion &nbsp;of attributes could cause the application
to loop infinitely).</p>
<figure class="table" style="width:100%;">
<table>
<table>
<thead>
<tr>
<th>&nbsp;</th>
@@ -378,5 +363,4 @@ class="table">
</td>
</tr>
</tbody>
</table>
</figure>
</table>

149
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Geo Map View.html generated vendored
View File

@@ -45,11 +45,10 @@
</tbody>
</table>
</figure>
<h2>Repositioning the map</h2>
<ul>
<li>Click and drag the map in order to move across the map.</li>
<li>Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons
<li data-list-item-id="eae523b73dba005f71d5f01802606f2e3">Click and drag the map in order to move across the map.</li>
<li data-list-item-id="e0c1c00d4d2bc4457e552677e7f4a5548">Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons
on the top-left to adjust the zoom.</li>
</ul>
<p>The position on the map and the zoom are saved inside the map note and
@@ -71,7 +70,7 @@
<td>To create a marker, first navigate to the desired point on the map. Then
press the
<img src="10_Geo Map View_image.png">button in the&nbsp;<a href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>&nbsp;(top-right)
area.&nbsp;
area.&nbsp;&nbsp;
<br>
<br>If the button is not visible, make sure the button section is visible
by pressing the chevron button (
@@ -85,7 +84,7 @@
width="1730" height="416">
</td>
<td>Once pressed, the map will enter in the insert mode, as illustrated by
the notification.&nbsp;&nbsp;&nbsp;&nbsp;
the notification.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br>
<br>Simply click the point on the map where to place the marker, or the Escape
key to cancel.</td>
@@ -110,34 +109,37 @@
</tbody>
</table>
</figure>
<h3>Adding a new note using the contextual menu</h3>
<ol>
<li>Right click anywhere on the map, where to place the newly created marker
<li data-list-item-id="e28f1a2fee5b0ecc42bfe35b472bf6e9d">Right click anywhere on the map, where to place the newly created marker
(and corresponding note).</li>
<li>Select <em>Add a marker at this location</em>.</li>
<li>Enter the name of the newly created note.</li>
<li>The map should be updated with the new marker.</li>
<li data-list-item-id="e12f1d02eab30eff35d80d30881242432">Select <em>Add a marker at this location</em>.</li>
<li data-list-item-id="e81f2c0a3e9385c326b222e95bbfb3fcf">Enter the name of the newly created note.</li>
<li data-list-item-id="e1965e61f563e3e73a88cba0c0a9882ea">The map should be updated with the new marker.</li>
</ol>
<h3>Adding an existing note on note from the note tree</h3>
<ol>
<li>Select the desired note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li>Hold the mouse on the note and drag it to the map to the desired location.</li>
<li>The map should be updated with the new marker.</li>
<li data-list-item-id="eec9c431281172d5e8459f6bdacd38b9f">Select the desired note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li
data-list-item-id="ef5e95092daa5b6e5f6f09301a4a6f775">Hold the mouse on the note and drag it to the map to the desired location.</li>
<li
data-list-item-id="e5bec34d97bab10d0171a3bf086887066">The map should be updated with the new marker.</li>
</ol>
<p>This works for:</p>
<ul>
<li>Notes that are not part of the geo map, case in which a <a href="#root/_help_IakOLONlIfGI">clone</a> will
<li data-list-item-id="e711a557c1554195062d8d3757b22a3af">Notes that are not part of the geo map, case in which a <a href="#root/_help_IakOLONlIfGI">clone</a> will
be created.</li>
<li>Notes that are a child of the geo map but not yet positioned on the map.</li>
<li>Notes that are a child of the geo map and also positioned, case in which
<li data-list-item-id="e4ea55f941135a2cccc00bf5238ff17f3">Notes that are a child of the geo map but not yet positioned on the map.</li>
<li
data-list-item-id="ebb44a6eb75da8c01f66967bacba6c44b">Notes that are a child of the geo map and also positioned, case in which
the marker will be relocated to the new position.</li>
</ul>
<h2>How the location of the markers is stored</h2>
<p>The location of a marker is stored in the <code>#geolocation</code> attribute
of the child notes:</p>
<img src="18_Geo Map View_image.png" width="1288"
height="278">
<p>
<img src="18_Geo Map View_image.png" width="1288" height="278">
</p>
<p>This value can be added manually if needed. The value of the attribute
is made up of the latitude and longitude separated by a comma.</p>
<h2>Repositioning markers</h2>
@@ -149,16 +151,17 @@ height="278">
page (<kbd>Ctrl</kbd>+<kbd>R</kbd> ) to cancel it.</p>
<h2>Interaction with the markers</h2>
<ul>
<li>Hovering over a marker will display a&nbsp;<a class="reference-link" href="#root/_help_lgKX7r3aL30x">Note Tooltip</a>&nbsp;with
<li data-list-item-id="e2c684ec660b82d51e613eb2259503f24">Hovering over a marker will display a&nbsp;<a class="reference-link" href="#root/_help_lgKX7r3aL30x">Note Tooltip</a>&nbsp;with
the content of the note it belongs to.
<ul>
<li>Clicking on the note title in the tooltip will navigate to the note in
<li data-list-item-id="e7d2862e8cc2f9c0abfc7a787c2d592e5">Clicking on the note title in the tooltip will navigate to the note in
the current view.</li>
</ul>
</li>
<li>Middle-clicking the marker will open the note in a new tab.</li>
<li>Right-clicking the marker will open a contextual menu (as described below).</li>
<li>If the map is in read-only mode, clicking on a marker will open a&nbsp;
<li data-list-item-id="e128abb7b7e86bab6a078bbcc036cf18e">Middle-clicking the marker will open the note in a new tab.</li>
<li data-list-item-id="e4ab8d71d03964d1d6f78176b8c52ba55">Right-clicking the marker will open a contextual menu (as described below).</li>
<li
data-list-item-id="e7b9935143dde811ab1a815390b74dc6c">If the map is in read-only mode, clicking on a marker will open a&nbsp;
<a
class="reference-link" href="#root/_help_ZjLYv08Rp3qC">Quick edit</a>&nbsp;popup for the corresponding note.</li>
</ul>
@@ -166,24 +169,24 @@ height="278">
<p>It's possible to press the right mouse button to display a contextual
menu.</p>
<ol>
<li>If right-clicking an empty section of the map (not on a marker), it allows
<li data-list-item-id="e3d9089e1842a44c6c4350e2302ae4c44">If right-clicking an empty section of the map (not on a marker), it allows
to:
<ol>
<li>Displays the latitude and longitude. Clicking this option will copy them
<li data-list-item-id="ed2632173c9e684258ad6695f90c34b52">Displays the latitude and longitude. Clicking this option will copy them
to the clipboard.</li>
<li>Open the location using an external application (if the operating system
<li data-list-item-id="e5c8b63fcebf2d89ca789ca2412cb45f6">Open the location using an external application (if the operating system
supports it).</li>
<li>Adding a new marker at that location.</li>
<li data-list-item-id="ee3db8aec5bce0c696fd9110599b35356">Adding a new marker at that location.</li>
</ol>
</li>
<li>If right-clicking on a marker, it allows to:
<li data-list-item-id="ea9dce579893bc84079ea809e943a60da">If right-clicking on a marker, it allows to:
<ol>
<li>Displays the latitude and longitude. Clicking this option will copy them
<li data-list-item-id="ecf1bd157850305904f6aa173667c8d7e">Displays the latitude and longitude. Clicking this option will copy them
to the clipboard.</li>
<li>Open the location using an external application (if the operating system
<li data-list-item-id="ead7e348313cfad21d3555d997c349f3e">Open the location using an external application (if the operating system
supports it).</li>
<li>Open the note in a new tab, split or window.</li>
<li>Remove the marker from the map, which will remove the <code>#geolocation</code> attribute
<li data-list-item-id="e9d0282d185ea5672a81722ece761050f">Open the note in a new tab, split or window.</li>
<li data-list-item-id="ed589d9e12ebb69788430f3fda290cc6a">Remove the marker from the map, which will remove the <code>#geolocation</code> attribute
of the note. To add it back again, the coordinates have to be manually
added back in.</li>
</ol>
@@ -203,13 +206,8 @@ height="278">
<p>The value of the attribute is made up of the latitude and longitude separated
by a comma.</p>
<h3>Adding from Google Maps</h3>
<figure class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:2.77%;">
<col style="width:33.24%;">
<col style="width:63.99%;">
</colgroup>
<figure class="table">
<table>
<thead>
<tr>
<th>&nbsp;</th>
@@ -227,10 +225,10 @@ height="278">
</figure>
</td>
<td>Go to Google Maps on the web and look for a desired location, right click
on it and a context menu will show up.&nbsp;&nbsp;&nbsp;&nbsp;
on it and a context menu will show up.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br>
<br>Simply click on the first item displaying the coordinates and they will
be copied to clipboard.&nbsp;&nbsp;&nbsp;&nbsp;
be copied to clipboard.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br>
<br>Then paste the value inside the text box into the <code>#geolocation</code> attribute
of a child note of the map (don't forget to surround the value with a <code>"</code> character).</td>
@@ -261,16 +259,10 @@ height="278">
</tbody>
</table>
</figure>
<h3>Adding from OpenStreetMap</h3>
<p>Similarly to the Google Maps approach:</p>
<figure class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:2.77%;">
<col style="width:33.42%;">
<col style="width:63.81%;">
</colgroup>
<figure class="table">
<table>
<thead>
<tr>
<th>&nbsp;</th>
@@ -295,7 +287,7 @@ height="278">
width="696" height="480">
</td>
<td>The address will be visible in the top-left of the screen, in the place
of the search bar.&nbsp;&nbsp;&nbsp;&nbsp;
of the search bar.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br>
<br>Select the coordinates and copy them into the clipboard.</td>
</tr>
@@ -311,17 +303,11 @@ height="278">
</tbody>
</table>
</figure>
<h2>Adding GPS tracks (.gpx)</h2>
<p>Trilium has basic support for displaying GPS tracks on the geo map.</p>
<figure
class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:2.77%;">
<col style="width:30.22%;">
<col style="width:67.01%;">
</colgroup>
class="table">
<table>
<thead>
<tr>
<th>&nbsp;</th>
@@ -360,7 +346,7 @@ class="table" style="width:100%;">
height="530">
</figure>
</td>
<td>When going back to the map, the track should now be visible.&nbsp;&nbsp;&nbsp;&nbsp;
<td>When going back to the map, the track should now be visible.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br>
<br>The start and end points of the track are indicated by the two blue markers.</td>
</tr>
@@ -379,20 +365,55 @@ class="table" style="width:100%;">
<p>When a map is in read-only all editing features will be disabled such
as:</p>
<ul>
<li>The add button in the&nbsp;<a class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>.</li>
<li>Dragging markers.</li>
<li>Editing from the contextual menu (removing locations or adding new items).</li>
<li data-list-item-id="e259bf29df58132f4068a0123b405560b">The add button in the&nbsp;<a class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>.</li>
<li
data-list-item-id="e476b0dc0202a017bcae0696997253965">Dragging markers.</li>
<li data-list-item-id="e617fa22b5a9f273586c20a6aec6f3661">Editing from the contextual menu (removing locations or adding new items).</li>
</ul>
<p>To enable read-only mode simply press the <em>Lock</em> icon from the&nbsp;
<a
class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>. To disable it, press the button again.</p>
<h2>Configuration</h2>
<h3>Map Style</h3>
<p>The styling of the map can be adjusted in the <em>Collection Properties</em> tab
in the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_BlN9DFI679QC">Ribbon</a>&nbsp;or
manually via the <code>#map:style</code> attribute.</p>
<p>The geo map comes with two different types of styles:</p>
<ul>
<li data-list-item-id="e9906c5e3a729a3640f5e287feab31b72">Raster styles
<ul>
<li data-list-item-id="e97f71804efddd3853b507512ea4a40af">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.</li>
<li
data-list-item-id="e00813cf013a220a699bb6b23567db695">Zoom is slightly restricted.</li>
<li data-list-item-id="ef1855c52e9c051a5cb6f4fff26d5f618">Currently, the only raster theme is the original OpenStreetMap style.</li>
</ul>
</li>
<li data-list-item-id="e725de962ba0d3f2e76ee990288862433">Vector styles
<ul>
<li data-list-item-id="ed3092e999b7bf7123c8b7b0bbc30277a">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.</li>
<li data-list-item-id="eefa12c0b39d004da202f5ec1ab03fc9d">The map can be zoomed in much further.</li>
<li data-list-item-id="e5c257789123aa1c9b934bcfdbef60931">These come both in a light and a dark version.</li>
<li data-list-item-id="e6669e513e76501556470599f09c43f4a">The vector styles come from <a href="https://versatiles.org/">VersaTiles</a>,
a free and open-source project providing map tiles based on OpenStreetMap.</li>
</ul>
</li>
</ul>
<aside class="admonition note">
<p>Currently it is not possible to use a custom map style.</p>
</aside>
<h3>Scale</h3>
<p>Activating this option via the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_BlN9DFI679QC">Ribbon</a>&nbsp;or
manually via <code>#map:scale</code> will display an indicator in the bottom-left
of the scale of the map.</p>
<h2>Troubleshooting</h2>
<figure class="image image-style-align-right image_resized" style="width:34.06%;">
<img style="aspect-ratio:678/499;" src="13_Geo Map View_image.png" width="678"
height="499">
</figure>
<h3>Grid-like artifacts on the map</h3>
<h3>Grid-like artifacts on the map</h3>
<p>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

17
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html generated vendored
View File

@@ -18,9 +18,7 @@
<p>Fore more information see&nbsp;<a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>.</p>
<h2>Features and formatting</h2>
<p>Here's a list of various features supported by text notes:</p>
<figure
class="table">
<table>
<table>
<thead>
<tr>
<th>Dedicated article</th>
@@ -165,23 +163,22 @@ class="table">
</td>
</tr>
</tbody>
</table>
</figure>
</table>
<h2>Read-Only vs. Editing Mode</h2>
<p>Text notes are usually opened in edit mode. However, they may open in
<p>Text notes are usually opened in edit mode. However, they may open in
read-only mode if the note is too big or the note is explicitly marked
as read-only. For more information, see&nbsp;<a class="reference-link"
href="#root/_help_CoFPLs3dRlXc">Read-Only Notes</a>.</p>
<h2>Keyboard shortcuts</h2>
<p>There are numerous keyboard shortcuts to format the text without having
<h2>Keyboard shortcuts</h2>
<p>There are numerous keyboard shortcuts to format the text without having
to use the mouse. For a reference of all the key combinations, see&nbsp;
<a
class="reference-link" href="#root/_help_A9Oc6YKKc65v">Keyboard Shortcuts</a>. In addition, see&nbsp;<a class="reference-link"
href="#root/_help_QrtTYPmdd1qq">Markdown-like formatting</a>&nbsp;as an
alternative to the keyboard shortcuts.</p>
<h2>Technical details</h2>
<p>For the text editing functionality, Trilium uses a commercial product
<h2>Technical details</h2>
<p>For the text editing functionality, Trilium uses a commercial product
(with an open-source base) called&nbsp;<a class="reference-link" href="#root/_help_MI26XDLSAlCD">CKEditor</a>.
This brings the benefit of having a powerful WYSIWYG (What You See Is What
You Get) editor.</p>

19
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images.html generated vendored
View File

@@ -24,9 +24,7 @@
</p>
<h3>Alignment</h3>
<p>The first set of options configure the alignment are, in order:</p>
<figure
class="table">
<table>
<table>
<thead>
<tr>
<th>Icon</th>
@@ -82,25 +80,24 @@ class="table">
text to flow on either of its sides.</td>
</tr>
</tbody>
</table>
</figure>
</table>
<h2>Compression</h2>
<p>Since Trilium isn't really meant to be primary storage for image data,
<p>Since Trilium isn't really meant to be primary storage for image data,
it attempts to compress and resize (with pretty aggressive settings) uploaded
images before storing them to the database. You may then notice some quality
degradation. Basic quality settings is available in&nbsp;<a class="reference-link"
href="#root/_help_4TIF1oA4VQRO">Options</a>&nbsp;→ Other.</p>
<p>If you want to save images in their original resolution, it is recommended
<p>If you want to save images in their original resolution, it is recommended
to save them as attachment to note (look for the contextual menu in&nbsp;
<a
class="reference-link" href="#root/_help_8YBEPzcpUgxw">Note buttons</a>&nbsp;→ <em>Import files</em>).</p>
<h2>Aligning images side-by-side</h2>
<p>There are generally two ways to display images side by side:</p>
<ul>
<h2>Aligning images side-by-side</h2>
<p>There are generally two ways to display images side by side:</p>
<ul>
<li>If they are roughly the same size, simply make the two images in-line,
according to the alignment section above. The images can be dragged &amp;
dropped onto the same line.</li>
<li>If they are on different size, create a <a href="#root/_help_NdowYOC1GFKS">table</a> with
invisible borders.</li>
</ul>
</ul>

82
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Keyboard shortcuts.html generated vendored
View File

@@ -1,6 +1,5 @@
<h2>Trilium-specific shortcuts</h2>
<figure class="table">
<table>
<table>
<thead>
<tr>
<th>Action</th>
@@ -42,8 +41,10 @@
</tr>
<tr>
<td>Inserts current date and time at caret position</td>
<td><kbd>Alt</kbd>+<kbd>T</kbd>&nbsp;</td>
<td><kbd>⌥</kbd>+<kbd>T</kbd>&nbsp;</td>
<td><kbd>Alt</kbd>+<kbd>T</kbd>
</td>
<td><kbd>⌥</kbd>+<kbd>T</kbd>
</td>
</tr>
<tr>
<td>Increase paragraph indentation</td>
@@ -77,14 +78,17 @@
</tr>
<tr>
<td>Move blocks (lists, paragraphs, etc.) up</td>
<td><kbd>Ctrl</kbd>+<kbd>↑</kbd>&nbsp;</td>
<td><kbd>⌘</kbd>+<kbd>↑</kbd>&nbsp;</td>
<td><kbd>Ctrl</kbd>+<kbd>↑</kbd>
</td>
<td><kbd>⌘</kbd>+<kbd>↑</kbd>
</td>
</tr>
<tr>
<td><kbd>Alt</kbd>+<kbd>↑</kbd>
</td>
<td><kbd>⌥</kbd>+<kbd>↑</kbd>
</td>
<td></td>
</tr>
<tr>
<td>Move blocks (lists, paragraphs, etc.) down</td>
@@ -98,10 +102,10 @@
</td>
<td><kbd>⌥</kbd>+<kbd>↓</kbd>
</td>
<td></td>
</tr>
</tbody>
</table>
</figure>
</table>
<h2>Common shortcuts</h2>
<aside class="admonition tip">
@@ -113,8 +117,7 @@
(due to using a different configuration).</p>
</aside>
<h3>Content editing</h3>
<figure class="table">
<table>
<table>
<thead>
<tr>
<th>Action</th>
@@ -127,7 +130,7 @@
<td>Insert a hard break (a new paragraph)</td>
<td><kbd>Enter</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>Insert a soft break (a <code>&lt;br&gt;</code> element)</td>
@@ -195,13 +198,13 @@
<td>Move out of a link</td>
<td><kbd>←←</kbd>, <kbd>→→</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>Move out of an inline code style</td>
<td><kbd>←←</kbd>, <kbd>→→</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>Select all</td>
@@ -256,16 +259,14 @@
<td>Revert autoformatting action</td>
<td><kbd>Backspace</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
</tbody>
</table>
</figure>
</table>
<h3>Interacting with blocks</h3>
<p>Blocks are images, tables, blockquotes, annotations.</p>
<figure class="table">
<table>
<table>
<thead>
<tr>
<th>Action</th>
@@ -278,7 +279,7 @@
<td>Insert a new paragraph directly after a widget</td>
<td><kbd>Enter</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>Insert a new paragraph directly before a widget</td>
@@ -291,27 +292,25 @@
<td>Move the caret to allow typing directly before a widget</td>
<td><kbd>↑</kbd>, <kbd>←</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>Move the caret to allow typing directly after a widget</td>
<td><kbd>↓</kbd>, <kbd>→</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>After entering a nested editable, move the selection to the closest ancestor
widget. For example: move from an image caption to the whole image widget.</td>
<td><kbd>Tab</kbd> then <kbd>Esc</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
</tbody>
</table>
</figure>
</table>
<p>Specifically for lists:</p>
<figure class="table">
<table>
<table>
<thead>
<tr>
<th>Action</th>
@@ -324,7 +323,7 @@
<td>Increase list item indent</td>
<td><kbd>⇥</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>Decrease list item indent</td>
@@ -334,11 +333,9 @@
</td>
</tr>
</tbody>
</table>
</figure>
</table>
<p>In tables:</p>
<figure class="table">
<table>
<table>
<thead>
<tr>
<th>Action</th>
@@ -351,7 +348,7 @@
<td>Move the selection to the next cell</td>
<td><kbd>⇥</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>Move the selection to the previous cell</td>
@@ -364,21 +361,19 @@
<td>Insert a new table row (when in the last cell of a table)</td>
<td><kbd>⇥</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>Navigate through the table</td>
<td><kbd>↑</kbd>, <kbd>→</kbd>, <kbd>↓</kbd>, <kbd>←</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
</tbody>
</table>
</figure>
</table>
<h3>General UI shortcuts</h3>
<figure class="table">
<table>
<table>
<thead>
<tr>
<th>Action</th>
@@ -391,7 +386,7 @@
<td>Close contextual balloons, dropdowns, and dialogs</td>
<td><kbd>Esc</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>Open the accessibility help dialog</td>
@@ -417,20 +412,20 @@
<td>Navigate through the toolbar or menu bar</td>
<td><kbd>↑</kbd>, <kbd>→</kbd>, <kbd>↓</kbd>, <kbd>←</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>Navigate to the next focusable field or an element outside the editor</td>
<td><kbd>Tab</kbd>, <kbd>Shift</kbd>+<kbd>Tab</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>Execute the currently focused button. Executing buttons that interact
with the editor content moves the focus back to the content.</td>
<td><kbd>Enter</kbd>, <kbd>Space</kbd>
</td>
<td>&nbsp;</td>
<td></td>
</tr>
<tr>
<td>Move focus in and out of an active dialog window</td>
@@ -439,5 +434,4 @@
<td><kbd>⌘F6</kbd> (may require <kbd>Fn</kbd>)</td>
</tr>
</tbody>
</table>
</figure>
</table>

30
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists.html generated vendored
View File

@@ -37,37 +37,38 @@
<h2>Headings, code blocks within lists</h2>
<p>It possible to add content-level blocks such as headings, code blocks,
tables within lists, as follows:</p>
<figure class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:4.79%;">
<col style="width:57.19%;">
<col style="width:38.02%;">
</colgroup>
<table>
<thead>
<tr>
<th></th>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<th>1</th>
<td>1</td>
<td>
<img src="6_Lists_image.png">
</td>
<td>First, create a list.</td>
</tr>
<tr>
<th>2</th>
<td>2</td>
<td>
<img src="4_Lists_image.png">
</td>
<td>Press Enter to create a new list item.</td>
</tr>
<tr>
<th>3</th>
<td>3</td>
<td>
<img src="5_Lists_image.png">
</td>
<td>Press Backspace to get rid of the bullet point. Notice the cursor position.</td>
</tr>
<tr>
<th>4</th>
<td>4</td>
<td>
<img class="image_resized" style="aspect-ratio:676/112;width:98.29%;"
src="1_Lists_image.png" width="676" height="112">
@@ -75,7 +76,7 @@
<td>At this point, insert any desired block-level item such as a code block.</td>
</tr>
<tr>
<th>5</th>
<td>5</td>
<td>
<img class="image_resized" style="aspect-ratio:675/129;width:94.22%;"
src="Lists_image.png" width="675" height="129">
@@ -84,7 +85,7 @@
to a new blank position.</td>
</tr>
<tr>
<th>6</th>
<td>6</td>
<td>
<img class="image_resized" style="aspect-ratio:675/129;width:100%;" src="3_Lists_image.png"
width="675" height="129">
@@ -92,7 +93,6 @@
<td>Press Enter once more to create the new bullet.</td>
</tr>
</tbody>
</table>
</figure>
</table>
<p>The same principle applies to all three list types (bullet, numbered and
to-do).</p>

12
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Events.html generated vendored
View File

@@ -5,8 +5,7 @@
<p>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.</p>
<figure class="table">
<table>
<table>
<thead>
<tr>
<th>Label</th>
@@ -44,15 +43,13 @@
Can be defined multiple times for more runs during the day.</td>
</tr>
</tbody>
</table>
</figure>
</table>
<h2>Entity events</h2>
<p>Other events are bound to some entity, these are defined as <a href="#root/_help_zEY4DaJG4YT5">relations</a> -
meaning that script is triggered only if note has this script attached
to it through relations (or it can inherit it).</p>
<figure class="table">
<table>
<table>
<thead>
<tr>
<th>Relation</th>
@@ -126,5 +123,4 @@
This is triggered also when the attribute is deleted</td>
</tr>
</tbody>
</table>
</figure>
</table>

93
docs/User Guide/!!!meta.json vendored
View File

@@ -37,105 +37,105 @@
{
"type": "relation",
"name": "internalLink",
"value": "2FvYrpmOXm29",
"value": "ZjLYv08Rp3qC",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "ZjLYv08Rp3qC",
"value": "R9pX4DGra2Vt",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "R9pX4DGra2Vt",
"value": "LMAv4Uy3Wk6J",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "LMAv4Uy3Wk6J",
"value": "NRnIZmSMc5sj",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "NRnIZmSMc5sj",
"value": "rC3pL2aptaRE",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "rC3pL2aptaRE",
"value": "GTwFsgaA0lCt",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "xWbu3jpNWapp",
"value": "2FvYrpmOXm29",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "81SGnPGMk7Xc",
"value": "iPIMuisry3hd",
"isInheritable": false,
"position": 80
},
{
"type": "relation",
"name": "internalLink",
"value": "GTwFsgaA0lCt",
"value": "ZlN4nump6EbW",
"isInheritable": false,
"position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "iPIMuisry3hd",
"value": "pwc194wlRzcH",
"isInheritable": false,
"position": 100
},
{
"type": "relation",
"name": "internalLink",
"value": "ZlN4nump6EbW",
"value": "7DAiwaf8Z7Rz",
"isInheritable": false,
"position": 110
},
{
"type": "relation",
"name": "internalLink",
"value": "pwc194wlRzcH",
"value": "veGu4faJErEM",
"isInheritable": false,
"position": 120
},
{
"type": "relation",
"name": "internalLink",
"value": "7DAiwaf8Z7Rz",
"value": "xWbu3jpNWapp",
"isInheritable": false,
"position": 130
},
{
"type": "relation",
"name": "internalLink",
"value": "veGu4faJErEM",
"value": "AgjCISero73a",
"isInheritable": false,
"position": 140
},
{
"type": "relation",
"name": "internalLink",
"value": "AgjCISero73a",
"value": "81SGnPGMk7Xc",
"isInheritable": false,
"position": 150
},
@@ -2727,49 +2727,49 @@
{
"type": "relation",
"name": "internalLink",
"value": "81SGnPGMk7Xc",
"value": "Cq5X6iKQop6R",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "xWbu3jpNWapp",
"value": "hrZ1D00cLbal",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "2FvYrpmOXm29",
"value": "iPIMuisry3hd",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "Cq5X6iKQop6R",
"value": "GTwFsgaA0lCt",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "hrZ1D00cLbal",
"value": "81SGnPGMk7Xc",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "iPIMuisry3hd",
"value": "xWbu3jpNWapp",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "GTwFsgaA0lCt",
"value": "2FvYrpmOXm29",
"isInheritable": false,
"position": 80
},
@@ -3442,49 +3442,49 @@
{
"type": "relation",
"name": "internalLink",
"value": "81SGnPGMk7Xc",
"value": "iPIMuisry3hd",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "iPIMuisry3hd",
"value": "6f9hih2hXXZk",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "6f9hih2hXXZk",
"value": "4TIF1oA4VQRO",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "4TIF1oA4VQRO",
"value": "BlN9DFI679QC",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "BlN9DFI679QC",
"value": "XpOYSgsLkTJy",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "XpOYSgsLkTJy",
"value": "s1aBHPd79XYj",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "s1aBHPd79XYj",
"value": "81SGnPGMk7Xc",
"isInheritable": false,
"position": 80
},
@@ -8072,49 +8072,49 @@
{
"type": "relation",
"name": "internalLink",
"value": "0ESUbbAxVnoK",
"value": "KSZ04uQ2D1St",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "IakOLONlIfGI",
"value": "0ESUbbAxVnoK",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "ZjLYv08Rp3qC",
"value": "XpOYSgsLkTJy",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "KSZ04uQ2D1St",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "XpOYSgsLkTJy",
"value": "IakOLONlIfGI",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"value": "lgKX7r3aL30x",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "lgKX7r3aL30x",
"value": "ZjLYv08Rp3qC",
"isInheritable": false,
"position": 70
},
@@ -8124,6 +8124,13 @@
"value": "bx bx-map-alt",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "BlN9DFI679QC",
"isInheritable": false,
"position": 80
}
],
"format": "markdown",
@@ -8310,21 +8317,21 @@
{
"type": "relation",
"name": "internalLink",
"value": "0ESUbbAxVnoK",
"value": "6f9hih2hXXZk",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "iPIMuisry3hd",
"value": "0ESUbbAxVnoK",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "6f9hih2hXXZk",
"value": "iPIMuisry3hd",
"isInheritable": false,
"position": 30
},
@@ -8440,28 +8447,28 @@
{
"type": "relation",
"name": "internalLink",
"value": "eIg8jdvaoNNd",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"value": "BlN9DFI679QC",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "CdNpE2pqjmI6",
"value": "eIg8jdvaoNNd",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "BlN9DFI679QC",
"value": "CdNpE2pqjmI6",
"isInheritable": false,
"position": 60
},

2
docs/User Guide/User Guide/Note Types.md vendored
View File

@@ -33,7 +33,7 @@ The following note types are supported by Trilium:
| <a class="reference-link" href="Note%20Types/Relation%20Map.md">Relation Map</a> | Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree. |
| <a class="reference-link" href="Note%20Types/Note%20Map.md">Note Map</a> | Displays the relationships between the notes, whether via relations or their hierarchical structure. |
| <a class="reference-link" href="Note%20Types/Render%20Note.md">Render Note</a> | Used in <a class="reference-link" href="Scripting.md">Scripting</a>, it displays the HTML content of another note. This allows displaying any kind of content, provided there is a script behind it to generate it. |
| <a class="reference-link" href="Note%20Types/Collections.md">Collections</a> | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar.<br><br>Generally useful for easy reading of short notes. |
| <a class="reference-link" href="Note%20Types/Collections.md">Collections</a> | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar. <br> <br>Generally useful for easy reading of short notes. |
| <a class="reference-link" href="Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a> | Displays diagrams such as bar charts, flow charts, state diagrams, etc. Requires a bit of technical knowledge since the diagrams are written in a specialized format. |
| <a class="reference-link" href="Note%20Types/Canvas.md">Canvas</a> | Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind [excalidraw.com](https://excalidraw.com). |
| <a class="reference-link" href="Note%20Types/Web%20View.md">Web View</a> | Displays the content of an external web page, similar to a browser. |

35
docs/User Guide/User Guide/Note Types/Collections/Geo Map View.md vendored
View File

@@ -26,8 +26,8 @@ The position on the map and the zoom are saved inside the map note and restored
| | | |
| --- | --- | --- |
| 1 | To create a marker, first navigate to the desired point on the map. Then press the ![](10_Geo%20Map%20View_image.png) button in the [Floating buttons](../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) (top-right) area.  <br> <br>If the button is not visible, make sure the button section is visible by pressing the chevron button (![](17_Geo%20Map%20View_image.png)) in the top-right of the map. | |
| 2 | <img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="2_Geo Map View_image.png" width="1730" height="416"> | Once pressed, the map will enter in the insert mode, as illustrated by the notification.     <br> <br>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 ![](10_Geo%20Map%20View_image.png) button in the [Floating buttons](../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) (top-right) area.   <br> <br>If the button is not visible, make sure the button section is visible by pressing the chevron button (![](17_Geo%20Map%20View_image.png)) in the top-right of the map. | |
| 2 | <img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="2_Geo Map View_image.png" width="1730" height="416"> | Once pressed, the map will enter in the insert mode, as illustrated by the notification.      <br> <br>Simply click the point on the map where to place the marker, or the Escape key to cancel. |
| 3 | <img class="image_resized" style="aspect-ratio:1586/404;width:100%;" src="7_Geo Map View_image.png" width="1586" height="404"> | Enter the name of the marker/note to be created. |
| 4 | <img class="image_resized" style="aspect-ratio:1696/608;width:100%;" src="16_Geo Map View_image.png" width="1696" height="608"> | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. |
@@ -106,7 +106,7 @@ The value of the attribute is made up of the latitude and longitude separated by
| | | |
| --- | --- | --- |
| 1 | <figure class="image image-style-align-center image_resized" style="width:56.84%;"><img style="aspect-ratio:732/918;" src="12_Geo Map View_image.png" width="732" height="918"></figure> | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up.     <br> <br>Simply click on the first item displaying the coordinates and they will be copied to clipboard.     <br> <br>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 | <figure class="image image-style-align-center image_resized" style="width:56.84%;"><img style="aspect-ratio:732/918;" src="12_Geo Map View_image.png" width="732" height="918"></figure> | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up.      <br> <br>Simply click on the first item displaying the coordinates and they will be copied to clipboard.      <br> <br>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 | <figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:518/84;" src="4_Geo Map View_image.png" width="518" height="84"></figure> | In Trilium, create a child note under the map. |
| 3 | <figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:1074/276;" src="11_Geo Map View_image.png" width="1074" height="276"></figure> | 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. |
@@ -117,7 +117,7 @@ Similarly to the Google Maps approach:
| | | |
| --- | --- | --- |
| 1 | <img class="image_resized" style="aspect-ratio:562/454;width:100%;" src="1_Geo Map View_image.png" width="562" height="454"> | Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item. |
| 2 | <img class="image_resized" style="aspect-ratio:696/480;width:100%;" src="Geo Map View_image.png" width="696" height="480"> | The address will be visible in the top-left of the screen, in the place of the search bar.     <br> <br>Select the coordinates and copy them into the clipboard. |
| 2 | <img class="image_resized" style="aspect-ratio:696/480;width:100%;" src="Geo Map View_image.png" width="696" height="480"> | The address will be visible in the top-left of the screen, in the place of the search bar.      <br> <br>Select the coordinates and copy them into the clipboard. |
| 3 | <img class="image_resized" style="aspect-ratio:640/276;width:100%;" src="5_Geo Map View_image.png" width="640" height="276"> | 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)
@@ -128,7 +128,7 @@ Trilium has basic support for displaying GPS tracks on the geo map.
| --- | --- | --- |
| 1 | <figure class="image image-style-align-center"><img style="aspect-ratio:226/74;" src="3_Geo Map View_image.png" width="226" height="74"></figure> | To add a track, simply drag & drop a .gpx file inside the geo map in the note tree. |
| 2 | <figure class="image image-style-align-center"><img style="aspect-ratio:322/222;" src="14_Geo Map View_image.png" width="322" height="222"></figure> | 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 | <figure class="image image-style-align-center"><img style="aspect-ratio:620/530;" src="6_Geo Map View_image.png" width="620" height="530"></figure> | When going back to the map, the track should now be visible.     <br> <br>The start and end points of the track are indicated by the two blue markers. |
| 3 | <figure class="image image-style-align-center"><img style="aspect-ratio:620/530;" src="6_Geo Map View_image.png" width="620" height="530"></figure> | When going back to the map, the track should now be visible.      <br> <br>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.
@@ -145,6 +145,31 @@ When a map is in read-only all editing features will be disabled such as:
To enable read-only mode simply press the _Lock_ icon from the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a>. To disable it, press the button again.
## Configuration
### Map Style
The styling of the map can be adjusted in the _Collection Properties_ tab in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> 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](https://versatiles.org/), a free and open-source project providing map tiles based on OpenStreetMap.
> [!NOTE]
> Currently it is not possible to use a custom map style.
### Scale
Activating this option via the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> or manually via `#map:scale` will display an indicator in the bottom-left of the scale of the map.
## Troubleshooting
<figure class="image image-style-align-right image_resized" style="width:34.06%;"><img style="aspect-ratio:678/499;" src="13_Geo Map View_image.png" width="678" height="499"></figure>

4
docs/User Guide/User Guide/Note Types/Text/Keyboard shortcuts.md vendored
View File

@@ -13,9 +13,9 @@
| Mark selected text as [keyboard shortcut](Developer-specific%20formatting.md) | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>K</kbd> | <kbd>⌘</kbd>\+ <kbd>⌥</kbd>\+ <kbd>K</kbd> |
| Insert <a class="reference-link" href="Math%20Equations.md">Math Equations</a> | <kbd>Ctrl</kbd> + <kbd>M</kbd> | <kbd>⌘</kbd>\+ <kbd>M</kbd> |
| Move blocks (lists, paragraphs, etc.) up | <kbd>Ctrl</kbd>+<kbd>↑</kbd> | <kbd>⌘</kbd>+<kbd>↑</kbd> |
| <kbd>Alt</kbd>+<kbd>↑</kbd> | <kbd>⌥</kbd>+<kbd>↑</kbd> |
| <kbd>Alt</kbd>+<kbd>↑</kbd> | <kbd>⌥</kbd>+<kbd>↑</kbd> | |
| Move blocks (lists, paragraphs, etc.) down | <kbd>Ctrl</kbd>+<kbd>↑</kbd> | <kbd>⌘</kbd>+<kbd>↑</kbd> |
| <kbd>Alt</kbd>+<kbd>↓</kbd> | <kbd>⌥</kbd>+<kbd>↓</kbd> |
| <kbd>Alt</kbd>+<kbd>↓</kbd> | <kbd>⌥</kbd>+<kbd>↓</kbd> | |
## Common shortcuts