docs(help): document quick edit

This commit is contained in:
Elian Doran
2025-07-11 18:27:55 +03:00
parent 4fc2b0fa5e
commit e2f6d9e0d6
36 changed files with 602 additions and 237 deletions

View File

@@ -16,7 +16,7 @@ Trilium allows you to share selected notes as **publicly accessible** read-only
### By note type
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:19.92%;"><col style="width:41.66%;"><col style="width:38.42%;"></colgroup><thead><tr><th>&nbsp;</th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class="reference-link" href="../Note%20Types/Text.md">Text</a></th><td><ul><li>Table of contents.</li><li>Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).</li><li>Rendering for math equations.</li></ul></td><td><ul><li>Including notes is not supported.</li><li>Inline Mermaid diagrams are not rendered.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Code.md">Code</a></th><td><ul><li>Basic support (displaying the contents of the note in a monospace font).</li></ul></td><td><ul><li>No syntax highlight.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Saved%20Search.md">Saved Search</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Relation%20Map.md">Relation Map</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Note%20Map.md">Note Map</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Render%20Note.md">Render Note</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Book.md">Book</a></th><td><ul><li>The child notes are displayed in a fixed format.&nbsp;</li></ul></td><td><ul><li>More advanced view types such as the calendar view are not supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Canvas.md">Canvas</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Web%20View.md">Web View</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mind%20Map.md">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List/Geo%20Map%20View.md">Geo Map</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/File.md">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li>No further interaction supported.</li></ul></td></tr></tbody></table></figure>
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:19.92%;"><col style="width:41.66%;"><col style="width:38.42%;"></colgroup><thead><tr><th>&nbsp;</th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class="reference-link" href="../Note%20Types/Text.md">Text</a></th><td><ul><li>Table of contents.</li><li>Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).</li><li>Rendering for math equations.</li></ul></td><td><ul><li>Including notes is not supported.</li><li>Inline Mermaid diagrams are not rendered.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Code.md">Code</a></th><td><ul><li>Basic support (displaying the contents of the note in a monospace font).</li></ul></td><td><ul><li>No syntax highlight.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Saved%20Search.md">Saved Search</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Relation%20Map.md">Relation Map</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Note%20Map.md">Note Map</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Render%20Note.md">Render Note</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Collections.md">Book</a></th><td><ul><li>The child notes are displayed in a fixed format.&nbsp;</li></ul></td><td><ul><li>More advanced view types such as the calendar view are not supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Canvas.md">Canvas</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Web%20View.md">Web View</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mind%20Map.md">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List/Geo%20Map%20View.md">Geo Map</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/File.md">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li>No further interaction supported.</li></ul></td></tr></tbody></table></figure>
While the sharing feature is powerful, it has some limitations:

View File

@@ -0,0 +1,2 @@
# Quick edit
This is a clone of a note. Go to its [primary location](../UI%20Elements/Quick%20edit.md).

View File

@@ -11,7 +11,7 @@ When a note has one or more child notes, they will be listed at the end of the n
By default, the notes will be displayed in a grid, however there are also some other view types available.
> [!TIP]
> Generally the view type can only be changed in a <a class="reference-link" href="../../Note%20Types/Book.md">Book</a> note from the <a class="reference-link" href="../UI%20Elements/Ribbon.md">Ribbon</a>, but it can also be changed manually on any type of note using the `#viewType` attribute.
> Generally the view type can only be changed in a <a class="reference-link" href="../../Note%20Types/Collections.md">Book</a> note from the <a class="reference-link" href="../UI%20Elements/Ribbon.md">Ribbon</a>, but it can also be changed manually on any type of note using the `#viewType` attribute.
### Grid view

View File

@@ -28,7 +28,9 @@ Unlike other Book view types, the Calendar view also allows some kind of interac
* Hovering the mouse over an event will display information about the note.
![](7_Calendar%20View_image.png)
* Left clicking the event will go to that note. Middle clicking will open the note in a new tab and right click will offer more options including opening the note in a new split or window.
* Left clicking the event will open a <a class="reference-link" href="../../UI%20Elements/Quick%20edit.md">Quick edit</a> to edit the note in a popup while allowing easy return to the calendar by just dismissing the popup.
* Middle clicking will open the note in a new tab.
* Right click will offer more options including opening the note in a new split or window.
* Drag and drop an event on the calendar to move it to another day.
* The length of an event can be changed by placing the mouse to the right edge of the event and dragging the mouse around.

View File

@@ -60,10 +60,11 @@ If moved by mistake, there is currently no way to undo the change. If the mouse
## Interaction with the markers
* Hovering over a marker will display the content of the note it belongs to.
* Hovering over a marker will display a <a class="reference-link" href="../../UI%20Elements/Note%20Tooltip.md">Note Tooltip</a> with the content of the note it belongs to.
* Clicking on the note title in the tooltip will navigate to the note in the current view.
* Middle-clicking the marker will open the note in a new tab.
* Right-clicking the marker will open a contextual menu allowing:
* Right-clicking the marker will open a contextual menu (as described below).
* If the map is in read-only mode, clicking on a marker will open a <a class="reference-link" href="../../UI%20Elements/Quick%20edit.md">Quick edit</a> popup for the corresponding note.
## Contextual menu

View File

@@ -0,0 +1,33 @@
# Quick edit
<figure class="image image-style-align-right image_resized" style="width:53.13%;"><img style="aspect-ratio:895/694;" src="Quick edit_image.png" width="895" height="694"></figure>
_Quick edit_ provides an alternative to the standard tab-based navigation and editing.
Instead of clicking on a note which switches the <a class="reference-link" href="Note%20Tree.md">Note Tree</a> to the newly selected note, or navigating between two different <a class="reference-link" href="Tabs.md">Tabs</a>, the _Quick edit_ feature opens as a popup window that can be easily dismissed.
This feature is also well integrated with <a class="reference-link" href="../../Note%20Types/Collections.md">Collections</a> such as the calendar view, which makes it easy to edit entries without having to go back and forth between the child note and the calendar.
## Feature highlights
* All note types are supported, including <a class="reference-link" href="../../Note%20Types/Collections.md">Collections</a>.
* Note that the <a class="reference-link" href="../Notes/Note%20List.md">Note List</a> will not be displayed, except for notes of type <a class="reference-link" href="../../Note%20Types/Collections.md">Collections</a>.
* For <a class="reference-link" href="../../Note%20Types/Text.md">Text</a> notes, depending on user preference, both the floating and classic editors are supported. See <a class="reference-link" href="../../Note%20Types/Text/Formatting%20toolbar.md">Formatting toolbar</a>.
* The title and the note and the icon are editable, just like a normal tab.
* The <a class="reference-link" href="../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> are also displayed.
* This integrates well with <a class="reference-link" href="../../Note%20Types/Collections.md">Collections</a> where there are predefined attributes such as the _Start date_ and _End date_, allowing for easy editing.
## Accessing the quick edit
* From the <a class="reference-link" href="Note%20Tree.md">Note Tree</a>:
* Right click on a note and select _Quick edit_.
* or, press <kbd>Ctrl</kbd>+<kbd>Right click</kbd> on a note.
* On <a class="reference-link" href="../../Note%20Types/Text/Links/Internal%20(reference)%20links.md">Internal (reference) links</a>:
* Right click and select _Quick edit_.
* or, press <kbd>Ctrl</kbd>+<kbd>Right click</kbd> on the link.
* On a <a class="reference-link" href="Note%20Tooltip.md">Note Tooltip</a>, press the quick edit icon.
* In <a class="reference-link" href="../../Note%20Types/Collections.md">Collections</a>:
* For <a class="reference-link" href="../Notes/Note%20List/Calendar%20View.md">Calendar View</a>:
* Clicking on an event will open that event for quick editing.
* If the calendar is for the <a class="reference-link" href="../../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.md">Day Notes</a> root, clicking on the day number will open the popup for that day note.
* For <a class="reference-link" href="../Notes/Note%20List/Geo%20Map%20View.md">Geo Map View</a>:
* Clicking on a marker will open that marker, but only if the map is in read-only mode.

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

View File

@@ -25,4 +25,4 @@ It is possible to change the type of a note after it has been created via the _B
The following note types are supported by Trilium:
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:29.42%;"><col style="width:70.58%;"></colgroup><thead><tr><th>Note Type</th><th>Description</th></tr></thead><tbody><tr><td><a class="reference-link" href="Note%20Types/Text.md">Text</a></td><td>The default note type, which allows for rich text formatting, images, admonitions and right-to-left support.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Code.md">Code</a></td><td>Uses a mono-space font and can be used to store larger chunks of code or plain text than a text note, and has better syntax highlighting.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Saved%20Search.md">Saved Search</a></td><td>Stores the information about a search (the search text, criteria, etc.) for later use. Can be used for quick filtering of a large amount of notes, for example. The search can easily be triggered.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Relation%20Map.md">Relation Map</a></td><td>Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Note%20Map.md">Note Map</a></td><td>Displays the relationships between the notes, whether via relations or their hierarchical structure.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Render%20Note.md">Render Note</a></td><td>Used in&nbsp;<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.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Book.md">Book</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></tr><tr><td><a class="reference-link" href="Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a></td><td>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.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Canvas.md">Canvas</a></td><td>Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind <a href="https://excalidraw.com">excalidraw.com</a>.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Web%20View.md">Web View</a></td><td>Displays the content of an external web page, similar to a browser.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Mind%20Map.md">Mind Map</a></td><td>Easy for brainstorming ideas, by placing them in a hierarchical layout.</td></tr><tr><td><a class="reference-link" href="Basic%20Concepts%20and%20Features/Notes/Note%20List/Geo%20Map%20View.md">Geo Map</a></td><td>Displays the children of the note as a geographical map, one use-case would be to plan vacations. It even has basic support for tracks. Notes can also be created from it.</td></tr><tr><td><a class="reference-link" href="Note%20Types/File.md">File</a></td><td>Represents an uploaded file such as PDFs, images, video or audio files.</td></tr></tbody></table></figure>
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:29.42%;"><col style="width:70.58%;"></colgroup><thead><tr><th>Note Type</th><th>Description</th></tr></thead><tbody><tr><td><a class="reference-link" href="Note%20Types/Text.md">Text</a></td><td>The default note type, which allows for rich text formatting, images, admonitions and right-to-left support.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Code.md">Code</a></td><td>Uses a mono-space font and can be used to store larger chunks of code or plain text than a text note, and has better syntax highlighting.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Saved%20Search.md">Saved Search</a></td><td>Stores the information about a search (the search text, criteria, etc.) for later use. Can be used for quick filtering of a large amount of notes, for example. The search can easily be triggered.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Relation%20Map.md">Relation Map</a></td><td>Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Note%20Map.md">Note Map</a></td><td>Displays the relationships between the notes, whether via relations or their hierarchical structure.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Render%20Note.md">Render Note</a></td><td>Used in&nbsp;<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.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Collections.md">Book</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></tr><tr><td><a class="reference-link" href="Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a></td><td>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.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Canvas.md">Canvas</a></td><td>Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind <a href="https://excalidraw.com">excalidraw.com</a>.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Web%20View.md">Web View</a></td><td>Displays the content of an external web page, similar to a browser.</td></tr><tr><td><a class="reference-link" href="Note%20Types/Mind%20Map.md">Mind Map</a></td><td>Easy for brainstorming ideas, by placing them in a hierarchical layout.</td></tr><tr><td><a class="reference-link" href="Basic%20Concepts%20and%20Features/Notes/Note%20List/Geo%20Map%20View.md">Geo Map</a></td><td>Displays the children of the note as a geographical map, one use-case would be to plan vacations. It even has basic support for tracks. Notes can also be created from it.</td></tr><tr><td><a class="reference-link" href="Note%20Types/File.md">File</a></td><td>Represents an uploaded file such as PDFs, images, video or audio files.</td></tr></tbody></table></figure>

View File

@@ -1,7 +1,7 @@
# Book
# Collections
A **Book Note** in Trilium is a special type of [note](../Basic%20Concepts%20and%20Features/Notes.md) designed to display the contents of its child notes sequentially, creating a linear, book-like reading experience. This format is particularly useful for viewing multiple smaller notes in a cohesive, continuous manner.
![](Book_image.png)
![](Collections_image.png)
In the example above, the "node.js" note on the left panel contains several child notes. The right panel displays the content of these child notes as a single continuous document.

View File

Before

Width:  |  Height:  |  Size: 112 KiB

After

Width:  |  Height:  |  Size: 112 KiB

View File

@@ -1,51 +1,8 @@
# Links
## External links
There are two types of links:
An external link is a standard web link targeting for example a website. For example, [https://en.wikipedia.org/wiki/South\_China\_Sea](https://en.wikipedia.org/wiki/South_China_Sea) is an external link to a Wikipedia page.
To create a link without a custom text:
* Press <img src="2_Links_image.png" width="15" height="16"> in the <a class="reference-link" href="Formatting%20toolbar.md">Formatting toolbar</a>:
* A popup will appear, type or paste the URL in the box.
* Press <kbd>Enter</kbd> or the check mark icon to confirm.
* Alternatively, press <kbd>Ctrl</kbd>+<kbd>K</kbd> to trigger the aforementioned popup.
* A simpler way is to paste the raw link and press space to turn it automatically into a link.
To create a link with a custom text:
* First, type and select the text which will be turned into a link.
* Follow the previous steps to open the link interface (via the formatting toolbar, or <kbd>Ctrl</kbd>+<kbd>K</kbd>).
* Alternatively, simply paste (<kbd>Ctrl</kbd>+<kbd>V</kbd>) over the selected text to turn it into a link.
Once a link is inserted:
* The text inside the link can be changed if needed but the link itself will remain.
* To modify the link, click on the link to display the popup and press the <img src="Links_image.png" width="18" height="18"> _Edit link_ button.
* To remove a link, click on it and press the <img src="3_Links_image.png" width="18" height="18"> _Unlink_ button.
You can follow external link by either double clicking (will open new tab/window) it or right clicking on them and choosing "Open in new tab".
## Internal links to notes
Unlike external notes, internal links (links to other notes) can be created at the current position by :
1. Pressing <kbd>Ctrl</kbd> + <kbd>L</kbd> or the <img src="1_Links_image.png" width="20" height="17"> button from the <a class="reference-link" href="Formatting%20toolbar.md">Formatting toolbar</a>.
2. Filling in the desired note to link. It's also possible to create notes from this dialog by typing a non-existing note title and selecting _Create and link child note_.
There are two link types, adjustable when creating the link to the note:
1. _link title mirrors the note's current title_
1. This is sometimes also called "reference link".
2. Title of such links cannot be changed, instead it is always mirroring the title of linked note.
3. The icon of the note is also displayed.
4. The link title will automatically update if the title of the note is changed.
2. _link title can be changed arbitrarily_
1. This is the traditional hyperlink, where the text of the link can be different to the note title.
Once an internal link is created:
* You can follow the note link by double clicking it.
* Alternatively if you only wish to quickly preview the content, you can hover over the link and will see read only preview.
* <a class="reference-link" href="Links/External%20links.md">External links</a>, for standard hyperlinks to websites or other resources.
* <a class="reference-link" href="Links/Internal%20(reference)%20links.md">Internal (reference) links</a> for links to other notes within Trilium.
## Pasting links

View File

Before

Width:  |  Height:  |  Size: 363 B

After

Width:  |  Height:  |  Size: 363 B

View File

Before

Width:  |  Height:  |  Size: 695 B

After

Width:  |  Height:  |  Size: 695 B

View File

@@ -0,0 +1,24 @@
# External links
An external link is a standard web link targeting for example a website. For example, [https://en.wikipedia.org/wiki/South\_China\_Sea](https://en.wikipedia.org/wiki/South_China_Sea) is an external link to a Wikipedia page.
To create a link without a custom text:
* Press <img src="1_External links_image.png" width="15" height="16"> in the <a class="reference-link" href="../Formatting%20toolbar.md">Formatting toolbar</a>:
* A popup will appear, type or paste the URL in the box.
* Press <kbd>Enter</kbd> or the check mark icon to confirm.
* Alternatively, press <kbd>Ctrl</kbd>+<kbd>K</kbd> to trigger the aforementioned popup.
* A simpler way is to paste the raw link and press space to turn it automatically into a link.
To create a link with a custom text:
* First, type and select the text which will be turned into a link.
* Follow the previous steps to open the link interface (via the formatting toolbar, or <kbd>Ctrl</kbd>+<kbd>K</kbd>).
* Alternatively, simply paste (<kbd>Ctrl</kbd>+<kbd>V</kbd>) over the selected text to turn it into a link.
Once a link is inserted:
* The text inside the link can be changed if needed but the link itself will remain.
* To modify the link, click on the link to display the popup and press the <img src="External links_image.png" width="18" height="18"> _Edit link_ button.
* To remove a link, click on it and press the <img src="2_External links_image.png" width="18" height="18"> _Unlink_ button.
You can follow external link by either double clicking (will open new tab/window) it or right clicking on them and choosing "Open in new tab".

View File

Before

Width:  |  Height:  |  Size: 594 B

After

Width:  |  Height:  |  Size: 594 B

View File

@@ -0,0 +1,20 @@
# Internal (reference) links
Unlike external notes, internal links (links to other notes) can be created at the current position by :
1. Pressing <kbd>Ctrl</kbd> + <kbd>L</kbd> or the <img src="Internal (reference) links.png" width="20" height="17"> button from the <a class="reference-link" href="../Formatting%20toolbar.md">Formatting toolbar</a>.
2. Filling in the desired note to link. It's also possible to create notes from this dialog by typing a non-existing note title and selecting _Create and link child note_.
There are two link types, adjustable when creating the link to the note:
1. _link title mirrors the note's current title_
1. This is sometimes also called "reference link".
2. Title of such links cannot be changed, instead it is always mirroring the title of linked note.
3. The icon of the note is also displayed.
4. The link title will automatically update if the title of the note is changed.
2. _link title can be changed arbitrarily_
1. This is the traditional hyperlink, where the text of the link can be different to the note title.
Once an internal link is created:
* You can follow the note link by double clicking it.
* Alternatively if you only wish to quickly preview the content, you can hover over the link and will see read only preview.

View File

Before

Width:  |  Height:  |  Size: 397 B

After

Width:  |  Height:  |  Size: 397 B