mirror of
https://github.com/zadam/trilium.git
synced 2025-11-02 03:16:11 +01:00
chore(docs): bring back figure sizes
This commit is contained in:
Elian Doran
@@ -1715,6 +1715,13 @@
|
||||
"value": "bx bx-cog",
|
||||
"isInheritable": false,
|
||||
"position": 10
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "_options",
|
||||
"isInheritable": false,
|
||||
"position": 60
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Jump to Note
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:991/403;" src="Jump to Note_image.png" width="991" height="403"></figure>
|
||||
|
||||
The _Jump to Note_ function allows easy navigation between notes by searching for their title. In addition to that, it can also trigger a full search or create notes.
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Quick search
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:659/256;" src="Quick search_image.png" width="659" height="256"></figure>
|
||||
|
||||
The _Quick search_ function does a full-text search (that is, it searches through the content of notes and not just the title of a note) and displays the result in an easy-to-access manner.
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ By default, the notes will be displayed in a grid, however there are also some o
|
||||
|
||||
### Grid view
|
||||
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:1025/655;" src="1_Note List_image.png" width="1025" height="655"></figure>
|
||||
|
||||
This view presents the child notes in a grid format, allowing for a more visual navigation experience.
|
||||
|
||||
@@ -23,12 +23,12 @@ This is the default view type.
|
||||
|
||||
### List view
|
||||
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:1013/526;" src="Note List_image.png" width="1013" height="526"></figure>
|
||||
|
||||
In the list view mode, each note is displayed in a single row with only the title and the icon of the note being visible by the default. By pressing the expand button it's possible to view the content of the note, as well as the children of the note (recursively).
|
||||
|
||||
### Calendar view
|
||||
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:1090/598;" src="2_Note List_image.png" width="1090" height="598"></figure>
|
||||
|
||||
In the calendar view, child notes are represented as events, with a start date and optionally an end date. The view also has interaction support such as moving or creating new events. See <a class="reference-link" href="Note%20List/Calendar%20View.md">Calendar View</a> for more information.
|
||||
@@ -1,5 +1,5 @@
|
||||
# Calendar View
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:767/606;" src="4_Calendar View_image.png" width="767" height="606"></figure>
|
||||
|
||||
The Calendar view of Book notes will display each child note in a calendar that has a start date and optionally an end date, as an event.
|
||||
|
||||
@@ -14,10 +14,7 @@ Unlike other Book view types, the Calendar view also allows some kind of interac
|
||||
|
||||
## Creating a calendar
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 1 |  | The Calendar View works only for Book note types. To create a new note, right click on the note tree on the left and select Insert note after, or Insert child note and then select _Book_. |
|
||||
| 2 |  | Once created, the “View type” of the Book needs changed to “Calendar”, by selecting the “Book Properties” tab in the ribbon. |
|
||||
<figure class="table"><table><thead><tr><th> </th><th> </th><th> </th></tr></thead><tbody><tr><td>1</td><td><img src="2_Calendar View_image.png"></td><td>The Calendar View works only for Book note types. To create a new note, right click on the note tree on the left and select Insert note after, or Insert child note and then select <em>Book</em>.</td></tr><tr><td>2</td><td><img src="3_Calendar View_image.png"></td><td>Once created, the “View type” of the Book needs changed to “Calendar”, by selecting the “Book Properties” tab in the ribbon.</td></tr></tbody></table></figure>
|
||||
|
||||
## Creating a new event/note
|
||||
|
||||
@@ -39,7 +36,7 @@ Unlike other Book view types, the Calendar view also allows some kind of interac
|
||||
|
||||
The following attributes can be added to the book type:
|
||||
|
||||
<table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><code>#calendar:hideWeekends</code></td><td>When present (regardless of value), it will hide Saturday and Sundays from the calendar.</td></tr><tr><td><code>#calendar:weekNumbers</code></td><td>When present (regardless of value), it will show the number of the week on the calendar.</td></tr><tr><td><code>#calendar:view</code></td><td><p>Which view to display in the calendar:</p><ul><li><code>timeGridWeek</code> for the <em>week</em> view;</li><li><code>dayGridMonth</code> for the <em>month</em> view;</li><li><code>multiMonthYear</code> for the <em>year</em> view;</li><li><code>listMonth</code> for the <em>list</em> view.</li></ul><p>Any other value will be dismissed and the default view (month) will be used instead.</p><p>The value of this label is automatically updated when changing the view using the UI buttons.</p></td></tr><tr><td><code>~child:template</code></td><td>Defines the template for newly created notes in the calendar (via dragging or clicking).</td></tr></tbody></table>
|
||||
<figure class="table"><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><code>#calendar:hideWeekends</code></td><td>When present (regardless of value), it will hide Saturday and Sundays from the calendar.</td></tr><tr><td><code>#calendar:weekNumbers</code></td><td>When present (regardless of value), it will show the number of the week on the calendar.</td></tr><tr><td><code>#calendar:view</code></td><td><p>Which view to display in the calendar:</p><ul><li><code>timeGridWeek</code> for the <em>week</em> view;</li><li><code>dayGridMonth</code> for the <em>month</em> view;</li><li><code>multiMonthYear</code> for the <em>year</em> view;</li><li><code>listMonth</code> for the <em>list</em> view.</li></ul><p>Any other value will be dismissed and the default view (month) will be used instead.</p><p>The value of this label is automatically updated when changing the view using the UI buttons.</p></td></tr><tr><td><code>~child:template</code></td><td>Defines the template for newly created notes in the calendar (via dragging or clicking).</td></tr></tbody></table></figure>
|
||||
|
||||
In addition, the first day of the week can be either Sunday or Monday and can be adjusted from the application settings.
|
||||
|
||||
@@ -47,21 +44,7 @@ In addition, the first day of the week can be either Sunday or Monday and can be
|
||||
|
||||
For each note of the calendar, the following attributes can be used:
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| `#startDate` | The date the event starts, which will display it in the calendar. The format is `YYYY-MM-DD` (year, month and day separated by a minus sign). |
|
||||
| `#endDate` | Similar to `startDate`, mentions the end date if the event spans across multiple days. The date is inclusive, so the end day is also considered. The attribute can be missing for single-day events. |
|
||||
| `#startTime` | The time the event starts at. If this value is missing, then the event is considered a full-day event. The format is `HH:MM` (hours in 24-hour format and minutes). |
|
||||
| `#endTime` | Similar to `startTime`, it mentions the time at which the event ends (in relation with `endDate` if present, or `startDate`). |
|
||||
| `#color` | Displays the event with a specified color (named such as `red`, `gray` or hex such as `#FF0000`). This will also change the color of the note in other places such as the note tree. |
|
||||
| `#calendar:color` | Similar to `#color`, but applies the color only for the event in the calendar and not for other places such as the note tree. |
|
||||
| `#iconClass` | If present, the icon of the note will be displayed to the left of the event title. |
|
||||
| `#calendar:title` | Changes the title of an event to point to an attribute of the note other than the title, can either a label or a relation (without the `#` or `~` symbol). See _Use-cases_ for more information. |
|
||||
| `#calendar:displayedAttributes` | Allows displaying the value of one or more attributes in the calendar like this: <br> <br> <br> <br>`#weight="70" #Mood="Good" #calendar:displayedAttributes="weight,Mood"` <br> <br>It can also be used with relations, case in which it will display the title of the target note: <br> <br>`~assignee=@My assignee #calendar:displayedAttributes="assignee"` |
|
||||
| `#calendar:startDate` | Allows using a different label to represent the start date, other than `startDate` (e.g. `expiryDate`). The label name **must not be** prefixed with `#`. If the label is not defined for a note, the default will be used instead. |
|
||||
| `#calendar:endDate` | Similar to `#calendar:startDate`, allows changing the attribute which is being used to read the end date. |
|
||||
| `#calendar:startTime` | Similar to `#calendar:startDate`, allows changing the attribute which is being used to read the start time. |
|
||||
| `#calendar:endTime` | Similar to `#calendar:startDate`, allows changing the attribute which is being used to read the end time. |
|
||||
<figure class="table"><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><code>#startDate</code></td><td>The date the event starts, which will display it in the calendar. The format is <code>YYYY-MM-DD</code> (year, month and day separated by a minus sign).</td></tr><tr><td><code>#endDate</code></td><td>Similar to <code>startDate</code>, mentions the end date if the event spans across multiple days. The date is inclusive, so the end day is also considered. The attribute can be missing for single-day events.</td></tr><tr><td><code>#startTime</code></td><td>The time the event starts at. If this value is missing, then the event is considered a full-day event. The format is <code>HH:MM</code> (hours in 24-hour format and minutes).</td></tr><tr><td><code>#endTime</code></td><td>Similar to <code>startTime</code>, it mentions the time at which the event ends (in relation with <code>endDate</code> if present, or <code>startDate</code>).</td></tr><tr><td><code>#color</code></td><td>Displays the event with a specified color (named such as <code>red</code>, <code>gray</code> or hex such as <code>#FF0000</code>). This will also change the color of the note in other places such as the note tree.</td></tr><tr><td><code>#calendar:color</code></td><td>Similar to <code>#color</code>, but applies the color only for the event in the calendar and not for other places such as the note tree.</td></tr><tr><td><code>#iconClass</code></td><td>If present, the icon of the note will be displayed to the left of the event title.</td></tr><tr><td><code>#calendar:title</code></td><td>Changes the title of an event to point to an attribute of the note other than the title, can either a label or a relation (without the <code>#</code> or <code>~</code> symbol). See <em>Use-cases</em> for more information.</td></tr><tr><td><code>#calendar:displayedAttributes</code></td><td>Allows displaying the value of one or more attributes in the calendar like this: <br><br><img src="9_Calendar View_image.png"> <br><br><code>#weight="70" #Mood="Good" #calendar:displayedAttributes="weight,Mood"</code> <br><br>It can also be used with relations, case in which it will display the title of the target note: <br><br><code>~assignee=@My assignee #calendar:displayedAttributes="assignee"</code></td></tr><tr><td><code>#calendar:startDate</code></td><td>Allows using a different label to represent the start date, other than <code>startDate</code> (e.g. <code>expiryDate</code>). The label name <strong>must not be</strong> prefixed with <code>#</code>. If the label is not defined for a note, the default will be used instead.</td></tr><tr><td><code>#calendar:endDate</code></td><td>Similar to <code>#calendar:startDate</code>, allows changing the attribute which is being used to read the end date.</td></tr><tr><td><code>#calendar:startTime</code></td><td>Similar to <code>#calendar:startDate</code>, allows changing the attribute which is being used to read the start time.</td></tr><tr><td><code>#calendar:endTime</code></td><td>Similar to <code>#calendar:startDate</code>, allows changing the attribute which is being used to read the end time.</td></tr></tbody></table></figure>
|
||||
|
||||
## How the calendar works
|
||||
|
||||
@@ -96,7 +79,7 @@ Based on the `#calendarRoot` (or `#workspaceCalendarRoot`) attribute, the calend
|
||||
* Clicking on the empty space on a date will automatically open that day's note or create it if it does not exist.
|
||||
* Direct children of a day note will be displayed on the calendar despite not having a `dateNote` attribute. Children of the child notes will not be displayed.
|
||||
|
||||
|
||||
<img src="8_Calendar View_image.png" width="1217" height="724">
|
||||
|
||||
### Using a different attribute as event title
|
||||
|
||||
@@ -104,7 +87,7 @@ By default, events are displayed on the calendar by their note title. However, i
|
||||
|
||||
To do so, assign `#calendar:title` to the child note (not the calendar/book note), with the value being `name` where `name` can be any label (make not to add the `#` 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.
|
||||
|
||||
<table><thead><tr><th> </th><th> </th></tr></thead><tbody><tr><td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-11 #endDate=2025-02-13 #name="My vacation" #calendar:title="name"</code></pre></td><td><img src="5_Calendar View_image.png"></td></tr></tbody></table>
|
||||
<figure class="table" style="width:100%;"><table><thead><tr><th> </th><th> </th></tr></thead><tbody><tr><td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-11 #endDate=2025-02-13 #name="My vacation" #calendar:title="name"</code></pre></td><td><p> </p><figure class="image image-style-align-center"><img style="aspect-ratio:445/124;" src="5_Calendar View_image.png" width="445" height="124"></figure></td></tr></tbody></table></figure>
|
||||
|
||||
### Using a relation attribute as event title
|
||||
|
||||
@@ -112,12 +95,8 @@ Similarly to using an attribute, use `#calendar:title` and set it to `name` wher
|
||||
|
||||
Moreover, if there are more relations of the same name, they will be displayed as multiple events coming from the same note.
|
||||
|
||||
| | |
|
||||
| --- | --- |
|
||||
| `#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"` |  |
|
||||
<figure class="table" style="width:100%;"><table><thead><tr><th> </th><th> </th></tr></thead><tbody><tr><td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"</code></pre></td><td><img src="6_Calendar View_image.png" width="294" height="151"></td></tr></tbody></table></figure>
|
||||
|
||||
Note that it's even possible to have a `#calendar:title` 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 of attributes could cause the application to loop infinitely).
|
||||
|
||||
| | |
|
||||
| --- | --- |
|
||||
| `#calendar:title="shortName" #shortName="John S."` |  |
|
||||
<figure class="table" style="width:100%;"><table><thead><tr><th> </th><th> </th></tr></thead><tbody><tr><td><pre><code class="language-text-x-trilium-auto">#calendar:title="shortName" #shortName="John S."</code></pre></td><td><figure class="image image-style-align-center"><img style="aspect-ratio:296/150;" src="1_Calendar View_image.png" width="296" height="150"></figure></td></tr></tbody></table></figure>
|
||||
@@ -1,5 +1,5 @@
|
||||
# Floating buttons
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:893/144;" src="Floating buttons_image.png" width="893" height="144"></figure>
|
||||
|
||||
Depending on the current note, a panel will appear near the top-right of the note, right underneath the <a class="reference-link" href="Ribbon.md">Ribbon</a>. These buttons offer additional interaction that is specific to that particular note.
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Options
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:1189/709;" src="Options_image.png" width="1189" height="709"></figure>
|
||||
|
||||
The Options section allows the configuration of the TriliumNext client and server.
|
||||
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
# Split View
|
||||
In Trilium, is possible to work with two or more notes side-by-side.
|
||||
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:1398/1015;" src="Split View_2_Split View_im.png" width="1398" height="1015"></figure>
|
||||
|
||||
## **Interactions**
|
||||
|
||||
* Press the <img src="Split View_Split View_imag.png" width="16" height="16"> button to the right of a note's title to open a new split to the right of it.
|
||||
* Press the  button to the right of a note's title to open a new split to the right of it.
|
||||
* It is possible to have as many splits as desired, simply press again the button.
|
||||
* Only horizontal splits are possible, vertical or drag & dropping is not supported.
|
||||
* When at least one split is open, press the  button next to it to close it.
|
||||
* Use the <img src="Split View_4_Split View_im.png" width="7" height="10"> or the <img src="Split View_1_Split View_im.png" width="7" height="10"> button to move around the splits.
|
||||
* Use the  or the  button to move around the splits.
|
||||
* Each [tab](Tabs.md) has its own split view configuration (e.g. one tab can have two notes in a split view, whereas the others are one-note views).
|
||||
* The tab will indicate only the title of the main note (the first one in the list).
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Tabs
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:1119/43;" src="2_Tabs_image.png" width="1119" height="43"></figure>
|
||||
|
||||
In Trilium, tabs allow easy switching between notes.
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ To create a new note of a different type, head to the <a class="reference-link"
|
||||
* _Insert note after_, to put the new note underneath the one selected.
|
||||
* _Insert child note_, to insert the note as a child of the selected note.
|
||||
|
||||
<img src="Note Types_image.png" width="613" height="529">
|
||||
|
||||
|
||||
## Creating a new note of a different type via add link or new tab
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ Since we set the script to be run on start-up, all we need to do is to [refresh
|
||||
|
||||
## Understanding how the script works
|
||||
|
||||
<table class="ck-table-resized"><colgroup><col style="width:50%;"><col style="width:50%;"></colgroup><tbody><tr><td><pre><code class="language-application-javascript-env-frontend">api.addButtonToToolbar({
|
||||
<table class="ck-table-resized"><colgroup><col><col></colgroup><tbody><tr><td><pre><code class="language-application-javascript-env-frontend">api.addButtonToToolbar({
|
||||
title: "New task",
|
||||
icon: "task",
|
||||
shortcut: "alt+n",
|
||||
|
||||
@@ -12,7 +12,7 @@ Since these files come from an external source, it is not possible to create a _
|
||||
|
||||
### PDFs
|
||||
|
||||
<img src="File_image.png" width="933" height="666">
|
||||
<figure class="image image-style-align-center image_resized" style="width:50%;"><img style="aspect-ratio:933/666;" src="File_image.png" width="933" height="666"></figure>
|
||||
|
||||
PDFs can be browsed directly from Trilium.
|
||||
|
||||
@@ -29,7 +29,7 @@ Interaction:
|
||||
|
||||
### Images
|
||||
|
||||
<img src="4_File_image.png" width="879" height="766">
|
||||
<figure class="image image-style-align-center image_resized" style="width:50%;"><img style="aspect-ratio:879/766;" src="4_File_image.png" width="879" height="766"></figure>
|
||||
|
||||
Interaction:
|
||||
|
||||
@@ -37,7 +37,7 @@ Interaction:
|
||||
|
||||
### Videos
|
||||
|
||||
<img src="1_File_image.png" width="854" height="700">
|
||||
<figure class="image image-style-align-center image_resized" style="width:50%;"><img style="aspect-ratio:854/700;" src="1_File_image.png" width="854" height="700"></figure>
|
||||
|
||||
Video files can be added in as well. The file is streamed directly, so when accessing the note from a server it doesn't have to download the entire video to start playing it.
|
||||
|
||||
@@ -46,7 +46,7 @@ Video files can be added in as well. The file is streamed directly, so when acce
|
||||
|
||||
### Audio
|
||||
|
||||
<img src="3_File_image.png" width="850" height="243">
|
||||
<figure class="image image_resized image-style-align-center" style="width:50%;"><img style="aspect-ratio:850/243;" src="3_File_image.png" width="850" height="243"></figure>
|
||||
|
||||
Adding a supported audio file will reveal a basic audio player that can be used to play it.
|
||||
|
||||
@@ -59,7 +59,7 @@ Interactions:
|
||||
|
||||
### Text files
|
||||
|
||||
<img src="2_File_image.png" width="926" height="347">
|
||||
<figure class="image image-style-align-center image_resized" style="width:50%;"><img style="aspect-ratio:926/347;" src="2_File_image.png" width="926" height="347"></figure>
|
||||
|
||||
Files that are identified as containing text will show a preview of their content. One common use case for this type of file is to embed text files whose content is not necessarily of interest to the user, such as third-party libraries or generated content, that can then be downloaded if needed.
|
||||
|
||||
@@ -69,7 +69,7 @@ Since one of the use cases for having files instead of notes is to display large
|
||||
|
||||
### Unknown file types
|
||||
|
||||
<img src="5_File_image.png" width="532" height="240">
|
||||
<figure class="image image_resized image-style-align-center" style="width:50%;"><img style="aspect-ratio:532/240;" src="5_File_image.png" width="532" height="240"></figure>
|
||||
|
||||
If the file could not be identified as any of the supported file types from above, it will be treated as an unknown file. In this case, all the default interactions will be available such as downloading or opening the file externally, but there will be no preview of the content.
|
||||
|
||||
@@ -84,6 +84,9 @@ If the file could not be identified as any of the supported file types from abov
|
||||
|
||||
## Relation with other notes
|
||||
|
||||
* Files are also displayed in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a> based on their type:<img src="6_File_image.png" width="853" height="315">
|
||||
* Files are also displayed in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a> based on their type:
|
||||
|
||||
<img class="image_resized" style="aspect-ratio:853/315;width:50%;" src="6_File_image.png" width="853" height="315">
|
||||
|
||||
* Non-image files can be embedded into text notes as read-only widgets via the <a class="reference-link" href="Text/Include%20Note.md">Include Note</a> functionality.
|
||||
* Image files can be embedded into text notes like normal images via <a class="reference-link" href="Text/Images/Image%20references.md">Image references</a>.
|
||||
@@ -1,14 +1,11 @@
|
||||
# Geo Map
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:892/675;" src="10_Geo Map_image.png" width="892" height="675"></figure>
|
||||
|
||||
This note type displays the children notes on a geographical map, based on an attribute. It is also possible to add new notes at a specific location using the built-in interface.
|
||||
|
||||
## 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. |
|
||||
<figure class="table"><table><thead><tr><th> </th><th> </th><th> </th></tr></thead><tbody><tr><td>1</td><td><figure class="image image_resized image-style-align-center" style="width:51.25%;"><img style="aspect-ratio:1256/1044;" src="7_Geo Map_image.png" width="1256" height="1044"></figure></td><td>Right click on any note on the note tree and select <em>Insert child note</em> → <em>Geo Map (beta)</em>.</td></tr><tr><td>2</td><td><figure class="image image_resized image-style-align-center" style="width:53.44%;"><img style="aspect-ratio:1720/1396;" src="9_Geo Map_image.png" width="1720" height="1396"></figure></td><td>By default the map will be empty and will show the entire world.</td></tr></tbody></table></figure>
|
||||
|
||||
## Repositioning the map
|
||||
|
||||
@@ -19,18 +16,13 @@ The position on the map and the zoom are saved inside the map note and restored
|
||||
|
||||
## Adding a marker using the map
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 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. <br> <br>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. <br> <br>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. |
|
||||
<figure class="table"><table><thead><tr><th> </th><th> </th><th> </th></tr></thead><tbody><tr><td>1</td><td>To create a marker, first navigate to the desired point on the map. Then press the <img src="11_Geo Map_image.png"> button in the <a href="../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a> (top-right) area. <br><br>If the button is not visible, make sure the button section is visible by pressing the chevron button (<img src="17_Geo Map_image.png">) in the top-right of the map.</td><td> </td></tr><tr><td>2</td><td><img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="2_Geo Map_image.png" width="1730" height="416"></td><td>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.</td></tr><tr><td>3</td><td><img class="image_resized" style="aspect-ratio:1586/404;width:100%;" src="8_Geo Map_image.png" width="1586" height="404"></td><td>Enter the name of the marker/note to be created.</td></tr><tr><td>4</td><td><img class="image_resized" style="aspect-ratio:1696/608;width:100%;" src="16_Geo Map_image.png" width="1696" height="608"></td><td>Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map.</td></tr></tbody></table></figure>
|
||||
|
||||
## How the location of the markers is stored
|
||||
|
||||
The location of a marker is stored in the `#geolocation` attribute of the child notes:
|
||||
|
||||
|
||||
<img src="18_Geo Map_image.png" width="1288" height="278">
|
||||
|
||||
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.
|
||||
|
||||
@@ -54,7 +46,7 @@ If moved by mistake, there is currently no way to undo the change. If the mouse
|
||||
|
||||
## Icon and color of the markers
|
||||
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:523/295;" src="Geo Map_image.jpg" alt="image" width="523" height="295"></figure>
|
||||
|
||||
The markers will have the same icon as the note.
|
||||
|
||||
@@ -68,35 +60,23 @@ The value of the attribute is made up of the latitude and longitude separated by
|
||||
|
||||
### 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. <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 |  | 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. |
|
||||
<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><thead><tr><th> </th><th> </th><th> </th></tr></thead><tbody><tr><td>1</td><td><figure class="image image_resized image-style-align-center" style="width:56.84%;"><img style="aspect-ratio:732/918;" src="13_Geo Map_image.png" width="732" height="918"></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. <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 <code>#geolocation</code> attribute of a child note of the map (don't forget to surround the value with a <code>"</code> character).</td></tr><tr><td>2</td><td><figure class="image image_resized image-style-align-center" style="width:100%;"><img style="aspect-ratio:518/84;" src="4_Geo Map_image.png" width="518" height="84"></figure></td><td>In Trilium, create a child note under the map.</td></tr><tr><td>3</td><td><figure class="image image_resized image-style-align-center" style="width:100%;"><img style="aspect-ratio:1074/276;" src="12_Geo Map_image.png" width="1074" height="276"></figure></td><td>And then go to Owned Attributes and type <code>#geolocation="</code>, then paste from the clipboard as-is and then add the ending <code>"</code> character. Press Enter to confirm and the map should now be updated to contain the new note.</td></tr></tbody></table></figure>
|
||||
|
||||
### 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. <br> <br>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. |
|
||||
<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><thead><tr><th> </th><th> </th><th> </th></tr></thead><tbody><tr><td>1</td><td><img class="image_resized" style="aspect-ratio:562/454;width:100%;" src="1_Geo Map_image.png" width="562" height="454"></td><td>Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item.</td></tr><tr><td>2</td><td><img class="image_resized" style="aspect-ratio:696/480;width:100%;" src="Geo Map_image.png" 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. <br><br>Select the coordinates and copy them into the clipboard.</td></tr><tr><td>3</td><td><img class="image_resized" style="aspect-ratio:640/276;width:100%;" src="5_Geo Map_image.png" width="640" height="276"></td><td>Simply paste the value inside the text box into the <code>#geolocation</code> attribute of a child note of the map and then it should be displayed on the map.</td></tr></tbody></table></figure>
|
||||
|
||||
## 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. <br> <br>The start and end points of the track are indicated by the two blue markers. |
|
||||
<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><thead><tr><th> </th><th> </th><th> </th></tr></thead><tbody><tr><td>1</td><td><figure class="image image-style-align-center"><img style="aspect-ratio:226/74;" src="3_Geo Map_image.png" width="226" height="74"></figure></td><td>To add a track, simply drag & drop a .gpx file inside the geo map in the note tree.</td></tr><tr><td>2</td><td><figure class="image image-style-align-center"><img style="aspect-ratio:322/222;" src="15_Geo Map_image.png" width="322" height="222"></figure></td><td>In order for the file to be recognized as a GPS track, it needs to show up as <code>application/gpx+xml</code> in the <em>File type</em> field.</td></tr><tr><td>3</td><td><figure class="image image-style-align-center"><img style="aspect-ratio:620/530;" src="6_Geo Map_image.png" width="620" height="530"></figure></td><td>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.</td></tr></tbody></table></figure>
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
<figure class="image image-style-align-right image_resized" style="width:34.06%;"><img style="aspect-ratio:678/499;" src="14_Geo Map_image.png" width="678" height="499"></figure>
|
||||
|
||||
### Grid-like artifacts on the map
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Mermaid Diagrams
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:886/663;" src="2_Mermaid Diagrams_image.png" width="886" height="663"></figure>
|
||||
|
||||
Trilium supports Mermaid, which adds support for various diagrams such as flowchart, sequence diagram, class diagram, state diagram, pie charts, etc., all using a text description of the chart instead of manually drawing the diagram.
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Mind Map
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:892/675;" src="Mind Map_image.png" width="892" height="675"></figure>
|
||||
|
||||
The mindmap allows for easy jotting down of ideas and storing them in a hierarchical fashion.
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Note Map
|
||||
|
||||
<figure class="image image-style-align-center image_resized" style="width:50%;"><img style="aspect-ratio:856/763;" src="Note Map_image.png" width="856" height="763"></figure>
|
||||
|
||||
A Note map is a note type which displays a standalone version of the feature of the same name: [Note Map (Link map, Tree map)](../Advanced%20Usage/Note%20Map%20\(Link%20map%2C%20Tree%20map\).md).
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Image references
|
||||
<img src="Image references_image.png" width="880" height="553">
|
||||
<figure class="image image-style-align-right image_resized" style="width:50.47%;"><img style="aspect-ratio:880/553;" src="Image references_image.png" width="880" height="553"></figure>
|
||||
|
||||
Image references are an easy way to embed the preview of another note type into a <a class="reference-link" href="../../Text.md">Text</a> note.
|
||||
|
||||
@@ -11,7 +11,7 @@ Image references are an easy way to embed the preview of another note type into
|
||||
|
||||
## Steps
|
||||
|
||||
1. Go to one of the supported notes (listed above) and look for the <img src="1_Image references_image.png" width="18" height="18"> button in the <a class="reference-link" href="../../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a> area.
|
||||
1. Go to one of the supported notes (listed above) and look for the  button in the <a class="reference-link" href="../../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a> area.
|
||||
2. Go to a <a class="reference-link" href="../../Text.md">Text</a> note and use the Paste function to insert the reference to that note.
|
||||
|
||||
## Interaction
|
||||
|
||||
@@ -3,4 +3,4 @@ Text notes can "include" another note as a read-only widget. This can be useful
|
||||
|
||||
## Including a note
|
||||
|
||||
In the <a class="reference-link" href="Formatting%20toolbar.md">Formatting toolbar</a>, look for the <img src="Include Note_image.png" width="16" height="16"> button. There is also a keyboard shortcut defined for it but it is not allocated by default.
|
||||
In the <a class="reference-link" href="Formatting%20toolbar.md">Formatting toolbar</a>, look for the  button. There is also a keyboard shortcut defined for it but it is not allocated by default.
|
||||
Reference in New Issue
Block a user