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

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1 @@
<p>This is a clone of a note. Go to its <a href="../UI%20Elements/Quick%20edit.html">primary location</a>.</p>

View File

@@ -47,7 +47,6 @@
</tbody>
</table>
</figure>
<h2>Creating a new event/note</h2>
<ul>
<li>Clicking on a day will create a new child note and assign it to that particular
@@ -71,9 +70,15 @@
<br>
<img src="7_Calendar View_image.png">
</li>
<li>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.</li>
<li>Left clicking the event will open a&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_ZjLYv08Rp3qC">Quick edit</a>&nbsp;to
edit the note in a popup while allowing easy return to the calendar by
just dismissing the popup.
<ul>
<li>Middle clicking will open the note in a new tab.</li>
<li>Right click will offer more options including opening the note in a new
split or window.</li>
</ul>
</li>
<li>Drag and drop an event on the calendar to move it to another day.</li>
<li>The length of an event can be changed by placing the mouse to the right
edge of the event and dragging the mouse around.</li>
@@ -239,8 +244,7 @@ class="table">
</tbody>
</table>
</figure>
<h2>How the calendar works</h2>
<h2>How the calendar works</h2>
<p>
<img src="11_Calendar View_image.png">
</p>
@@ -276,9 +280,10 @@ class="table">
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">
<h3>Using a different attribute as event title</h3>
<p>
<img src="8_Calendar View_image.png" width="1217" height="724">
</p>
<h3>Using a different attribute as event title</h3>
<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>
@@ -311,8 +316,7 @@ class="table">
</tbody>
</table>
</figure>
<h3>Using a relation attribute as event title</h3>
<h3>Using a relation attribute as event title</h3>
<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>

View File

@@ -1,8 +1,8 @@
<aside class="admonition important">
<p>Starting with Trilium v0.97.0, the geo map has been converted from a standalone
<a
href="#root/pOsGYCXsbNQG/_help_KSZ04uQ2D1St">note type</a>to a type of view for the&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/BFs8mudNFgCS/_help_0ESUbbAxVnoK">Note List</a>.&nbsp;</p>
href="#root/_help_KSZ04uQ2D1St">note type</a>to a type of view for the&nbsp;<a class="reference-link"
href="#root/_help_0ESUbbAxVnoK">Note List</a>.&nbsp;</p>
</aside>
<figure class="image image-style-align-center">
<img style="aspect-ratio:892/675;" src="9_Geo Map View_image.png" width="892"
@@ -119,13 +119,13 @@
</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/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<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>
</ol>
<p>This works for:</p>
<ul>
<li>Notes that are not part of the geo map, case in which a <a href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/BFs8mudNFgCS/_help_IakOLONlIfGI">clone</a> will
<li>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
@@ -148,19 +148,18 @@
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 the content of the note it belongs
to.
<li>Hovering over a marker will display a&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_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
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 allowing:
<ul>
<li>&nbsp;</li>
</ul>
</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;
<a
class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_ZjLYv08Rp3qC">Quick edit</a>&nbsp;popup for the corresponding note.</li>
</ul>
<h2>Contextual menu</h2>
<p>It's possible to press the right mouse button to display a contextual
@@ -377,13 +376,13 @@ 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/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_XpOYSgsLkTJy">Floating buttons</a>.</li>
<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>
</ul>
<p>To enable read-only mode simply press the <em>Lock</em> icon from the&nbsp;
<a
class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_XpOYSgsLkTJy">Floating buttons</a>. To disable it, press the button again.</p>
class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>. To disable it, press the button again.</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"

View File

@@ -54,7 +54,7 @@
hide the Mermaid source code and display the diagram preview in full-size.
In this case, the read-only mode can be easily toggled on or off via a
dedicated button in the&nbsp;<a class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>&nbsp;area.</li>
<li><a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/BFs8mudNFgCS/0ESUbbAxVnoK/_help_81SGnPGMk7Xc">Geo Map View</a>&nbsp;will
<li><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map View</a>&nbsp;will
disallow all interaction that would otherwise change the map (dragging
notes, adding new items).</li>
</ul>

View File

@@ -0,0 +1,70 @@
<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>
<p><em>Quick edit </em>provides an alternative to the standard tab-based
navigation and editing.</p>
<p>Instead of clicking on a note which switches the&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;to
the newly selected note, or navigating between two different&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_3seOhtN8uLIY">Tabs</a>,
the <em>Quick edit</em> feature opens as a popup window that can be easily
dismissed.</p>
<p>This feature is also well integrated with&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_GTwFsgaA0lCt">Collections</a>&nbsp;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.</p>
<h2>Feature highlights</h2>
<ul>
<li>All note types are supported, including&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_GTwFsgaA0lCt">Collections</a>.</li>
<li>Note that the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/BFs8mudNFgCS/_help_0ESUbbAxVnoK">Note List</a>&nbsp;will
not be displayed, except for notes of type&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_GTwFsgaA0lCt">Collections</a>.</li>
<li>For&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iPIMuisry3hd">Text</a>&nbsp;notes,
depending on user preference, both the floating and classic editors are
supported. See&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_nRhnJkTT8cPs">Formatting toolbar</a>.</li>
<li>The title and the note and the icon are editable, just like a normal tab.</li>
<li>The&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;are
also displayed.
<ul>
<li>This integrates well with&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_GTwFsgaA0lCt">Collections</a>&nbsp;where
there are predefined attributes such as the <em>Start date</em> and <em>End date</em>,
allowing for easy editing.</li>
</ul>
</li>
</ul>
<h2>Accessing the quick edit</h2>
<ul>
<li>&nbsp;From the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_oPVyFC7WL2Lp">Note Tree</a>:
<ul>
<li>Right click on a note and select <em>Quick edit</em>.</li>
<li>or, press <kbd>Ctrl</kbd>+<kbd>Right click</kbd> on a note.</li>
</ul>
</li>
<li>On&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/QEAPj01N5f7w/_help_hrZ1D00cLbal">Internal (reference) links</a>:
<ul>
<li>Right click and select <em>Quick edit</em>.</li>
<li>or, press <kbd>Ctrl</kbd>+<kbd>Right click</kbd> on the link.</li>
</ul>
</li>
<li>On a&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_lgKX7r3aL30x">Note Tooltip</a>,
press the quick edit icon.</li>
<li>In&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_GTwFsgaA0lCt">Collections</a>:
<ul>
<li>For&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/BFs8mudNFgCS/0ESUbbAxVnoK/_help_xWbu3jpNWapp">Calendar View</a>:
<ul>
<li>Clicking on an event will open that event for quick editing.</li>
<li>If the calendar is for the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/5668rwcirq1t/_help_l0tKav7yLHGF">Day Notes</a>&nbsp;root,
clicking on the day number will open the popup for that day note.</li>
</ul>
</li>
<li>For&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/BFs8mudNFgCS/0ESUbbAxVnoK/_help_81SGnPGMk7Xc">Geo Map View</a>:
<ul>
<li>Clicking on a marker will open that marker, but only if the map is in
read-only mode.</li>
</ul>
</li>
</ul>
</li>
</ul>

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

View File

@@ -3,7 +3,7 @@
book-like reading experience. This format is particularly useful for viewing
multiple smaller notes in a cohesive, continuous manner.</p>
<p>
<img src="Book_image.png">
<img src="Collections_image.png">
</p>
<p>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

View File

@@ -1,75 +1,9 @@
<h2>External links</h2>
<p>An external link is a standard web link targeting for example a website.
For example, <a href="https://en.wikipedia.org/wiki/South_China_Sea">https://en.wikipedia.org/wiki/South_China_Sea</a> is
an external link to a Wikipedia page.</p>
<p>To create a link without a custom text:</p>
<p>There are two types of links:</p>
<ul>
<li>Press
<img src="2_Links_image.png" width="15" height="16">in the&nbsp;<a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>:
<ul>
<li>A popup will appear, type or paste the URL in the box.</li>
<li>Press <kbd>Enter</kbd> or the check mark icon to confirm.</li>
</ul>
</li>
<li>Alternatively, press <kbd>Ctrl</kbd>+<kbd>K</kbd> to trigger the aforementioned
popup.</li>
<li>A simpler way is to paste the raw link and press space to turn it automatically
into a link.</li>
</ul>
<p>To create a link with a custom text:</p>
<ul>
<li>First, type and select the text which will be turned into a link.</li>
<li>Follow the previous steps to open the link interface (via the formatting
toolbar, or <kbd>Ctrl</kbd>+<kbd>K</kbd>).</li>
<li>Alternatively, simply paste (<kbd>Ctrl</kbd>+<kbd>V</kbd>) over the selected
text to turn it into a link.</li>
</ul>
<p>Once a link is inserted:</p>
<ul>
<li>The text inside the link can be changed if needed but the link itself
will remain.</li>
<li>To modify the link, click on the link to display the popup and press the
<img
src="Links_image.png" width="18" height="18"> <em>Edit link</em> button.</li>
<li>To remove a link, click on it and press the
<img src="3_Links_image.png"
width="18" height="18"> <em>Unlink</em> button.</li>
</ul>
<p>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".</p>
<h2>Internal links to notes</h2>
<p>Unlike external notes, internal links (links to other notes) can be created
at the current position by :</p>
<ol>
<li>Pressing <kbd>Ctrl</kbd> + <kbd>L</kbd> or the
<img src="1_Links_image.png"
width="20" height="17">button from the&nbsp;<a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>.</li>
<li>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 <em>Create and link child note</em>.</li>
</ol>
<p>There are two link types, adjustable when creating the link to the note:</p>
<ol>
<li><em>link title mirrors the note's current title</em>
<ol>
<li>This is sometimes also called "reference link".</li>
<li>Title of such links cannot be changed, instead it is always mirroring
the title of linked note.</li>
<li>The icon of the note is also displayed.</li>
<li>The link title will automatically update if the title of the note is changed.</li>
</ol>
</li>
<li><em>link title can be changed arbitrarily</em>
<ol>
<li>This is the traditional hyperlink, where the text of the link can be different
to the note title.</li>
</ol>
</li>
</ol>
<p>Once an internal link is created:</p>
<ul>
<li>You can follow the note link by double clicking it.</li>
<li>Alternatively if you only wish to quickly preview the content, you can
hover over the link and will see read only preview.</li>
<li><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/QEAPj01N5f7w/_help_3IDVtesTQ8ds">External links</a>,
for standard hyperlinks to websites or other resources.</li>
<li><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/QEAPj01N5f7w/_help_hrZ1D00cLbal">Internal (reference) links</a>&nbsp;for
links to other notes within Trilium.</li>
</ul>
<h2>Pasting links</h2>
<ul>

View File

@@ -0,0 +1,38 @@
<p>An external link is a standard web link targeting for example a website.
For example, <a href="https://en.wikipedia.org/wiki/South_China_Sea">https://en.wikipedia.org/wiki/South_China_Sea</a> is
an external link to a Wikipedia page.</p>
<p>To create a link without a custom text:</p>
<ul>
<li>Press
<img src="1_External links_image.png" width="15" height="16">in the&nbsp;<a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>:
<ul>
<li>A popup will appear, type or paste the URL in the box.</li>
<li>Press <kbd>Enter</kbd> or the check mark icon to confirm.</li>
</ul>
</li>
<li>Alternatively, press <kbd>Ctrl</kbd>+<kbd>K</kbd> to trigger the aforementioned
popup.</li>
<li>A simpler way is to paste the raw link and press space to turn it automatically
into a link.</li>
</ul>
<p>To create a link with a custom text:</p>
<ul>
<li>First, type and select the text which will be turned into a link.</li>
<li>Follow the previous steps to open the link interface (via the formatting
toolbar, or <kbd>Ctrl</kbd>+<kbd>K</kbd>).</li>
<li>Alternatively, simply paste (<kbd>Ctrl</kbd>+<kbd>V</kbd>) over the selected
text to turn it into a link.</li>
</ul>
<p>Once a link is inserted:</p>
<ul>
<li>The text inside the link can be changed if needed but the link itself
will remain.</li>
<li>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"> <em>Edit link</em> button.</li>
<li>To remove a link, click on it and press the
<img src="2_External links_image.png"
width="18" height="18"> <em>Unlink</em> button.</li>
</ul>
<p>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".</p>

View File

@@ -0,0 +1,33 @@
<p>Unlike external notes, internal links (links to other notes) can be created
at the current position by :</p>
<ol>
<li>Pressing <kbd>Ctrl</kbd> + <kbd>L</kbd> or the
<img src="Internal (reference) links.png"
width="20" height="17">button from the&nbsp;<a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>.</li>
<li>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 <em>Create and link child note</em>.</li>
</ol>
<p>There are two link types, adjustable when creating the link to the note:</p>
<ol>
<li><em>link title mirrors the note's current title</em>
<ol>
<li>This is sometimes also called "reference link".</li>
<li>Title of such links cannot be changed, instead it is always mirroring
the title of linked note.</li>
<li>The icon of the note is also displayed.</li>
<li>The link title will automatically update if the title of the note is changed.</li>
</ol>
</li>
<li><em>link title can be changed arbitrarily</em>
<ol>
<li>This is the traditional hyperlink, where the text of the link can be different
to the note title.</li>
</ol>
</li>
</ol>
<p>Once an internal link is created:</p>
<ul>
<li>You can follow the note link by double clicking it.</li>
<li>Alternatively if you only wish to quickly preview the content, you can
hover over the link and will see read only preview.</li>
</ul>