mirror of
https://github.com/zadam/trilium.git
synced 2025-11-28 19:44:24 +01:00
docs(user): document expanding/collapsing in list collection
This commit is contained in:
Elian Doran
parent
dc572c3815
commit
e4fae2d660
@ -15,54 +15,52 @@
|
||||
between the child note and the calendar.</p>
|
||||
<h2>Feature highlights</h2>
|
||||
<ul>
|
||||
<li data-list-item-id="e7518c6e639543e819dc69a61b7252458">All note types are supported, including <a class="reference-link"
|
||||
<li>All note types are supported, including <a class="reference-link"
|
||||
href="#root/_help_GTwFsgaA0lCt">Collections</a>.</li>
|
||||
<li data-list-item-id="e07d1c09e805da052d353cc5335568b15">Note that the <a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a> will
|
||||
<li>Note that the <a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a> will
|
||||
not be displayed, except for notes of type <a class="reference-link"
|
||||
href="#root/_help_GTwFsgaA0lCt">Collections</a>.</li>
|
||||
<li data-list-item-id="ef512b68c0951ae19965019449fd534fd">For <a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a> notes,
|
||||
<li>For <a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a> notes,
|
||||
depending on user preference, both the floating and classic editors are
|
||||
supported. See <a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>.</li>
|
||||
<li
|
||||
data-list-item-id="e5ff2b9a03ae44e626678f4c75e5b0433">The title and the note and the icon are editable, just like a normal tab.</li>
|
||||
<li
|
||||
data-list-item-id="e133aaf441d86628debd83bf6600c912b">The <a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a> are
|
||||
also displayed.
|
||||
<ul>
|
||||
<li data-list-item-id="e828766d6d8fa4c20390a45fe7d7d0f4f">This integrates well with <a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a> where
|
||||
there are predefined attributes such as the <em>Start date</em> and <em>End date</em>,
|
||||
allowing for easy editing.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>The title and the note and the icon are editable, just like a normal tab.</li>
|
||||
<li>The <a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a> are
|
||||
also displayed.
|
||||
<ul>
|
||||
<li>This integrates well with <a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a> 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 data-list-item-id="e0d35f751805c8b376b866d0637528710">From the <a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>:
|
||||
<li>From the <a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>:
|
||||
<ul>
|
||||
<li data-list-item-id="e404e51f44947e114221aa5e2fa975b35">Right click on a note and select <em>Quick edit</em>.</li>
|
||||
<li data-list-item-id="e2d1dcf10a0591303e35050ad076e195e">or, press <kbd>Ctrl</kbd>+<kbd>Right click</kbd> on a note.</li>
|
||||
<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 data-list-item-id="eeb8fc7bd156734ee5419bcafa69aa198">On <a class="reference-link" href="#root/_help_hrZ1D00cLbal">Internal (reference) links</a>:
|
||||
<li>On <a class="reference-link" href="#root/_help_hrZ1D00cLbal">Internal (reference) links</a>:
|
||||
<ul>
|
||||
<li data-list-item-id="e81f7dddc5e83f43a972f99690fe304da">Right click and select <em>Quick edit</em>.</li>
|
||||
<li data-list-item-id="ec723cc5f364a0fb658c1e23692db6cdc">or, press <kbd>Ctrl</kbd>+<kbd>Right click</kbd> on the link.</li>
|
||||
<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 data-list-item-id="e94fabbd406b6ed26de435e83eb8f70a9">On a <a class="reference-link" href="#root/_help_lgKX7r3aL30x">Note Tooltip</a>,
|
||||
<li>On a <a class="reference-link" href="#root/_help_lgKX7r3aL30x">Note Tooltip</a>,
|
||||
press the quick edit icon.</li>
|
||||
<li data-list-item-id="ea70b7255363988467c64cc55820f5b63">In <a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>:
|
||||
<li>In <a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>:
|
||||
<ul>
|
||||
<li data-list-item-id="e56233286c914fabc7595eee12297e703">For <a class="reference-link" href="#root/_help_xWbu3jpNWapp">Calendar</a>:
|
||||
<li>For <a class="reference-link" href="#root/_help_xWbu3jpNWapp">Calendar</a>:
|
||||
<ul>
|
||||
<li data-list-item-id="e3d26da71006e651e927b49a30d81ec60">Clicking on an event will open that event for quick editing.</li>
|
||||
<li data-list-item-id="e7909cf828b7b0a29714ff3d63122638e">If the calendar is for the <a class="reference-link" href="#root/_help_l0tKav7yLHGF">Day Notes</a> root,
|
||||
<li>Clicking on an event will open that event for quick editing.</li>
|
||||
<li>If the calendar is for the <a class="reference-link" href="#root/_help_l0tKav7yLHGF">Day Notes</a> root,
|
||||
clicking on the day number will open the popup for that day note.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e88455d70816f2ae7bf3d98b88840160a">For <a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map</a>:
|
||||
<li>For <a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map</a>:
|
||||
<ul>
|
||||
<li data-list-item-id="ecb3a9cf40136a5d8c5d4e77dceacfa8d">Clicking on a marker will open that marker, but only if the map is in
|
||||
<li>Clicking on a marker will open that marker, but only if the map is in
|
||||
read-only mode.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -71,14 +69,14 @@
|
||||
</ul>
|
||||
<h2>Handling of read-only notes</h2>
|
||||
<p>The Quick edit feature has a unique behavior for <a class="reference-link"
|
||||
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/BFs8mudNFgCS/_help_CoFPLs3dRlXc">Read-Only Notes</a>: </p>
|
||||
href="#root/_help_CoFPLs3dRlXc">Read-Only Notes</a>: </p>
|
||||
<ul>
|
||||
<li data-list-item-id="e510a64522b36499b2f24e89f094b38c4">If the note is read-only due to performance reasons (auto read-only),
|
||||
<li>If the note is read-only due to performance reasons (auto read-only),
|
||||
then the note is made editable for quick editing.</li>
|
||||
<li data-list-item-id="e1d4ab7a9cad3802d3210f6df2ca65fcb">If the note has been manually set to read-only, then the note is read-only
|
||||
<li>If the note has been manually set to read-only, then the note is read-only
|
||||
to prevent accidental change.
|
||||
<ul>
|
||||
<li data-list-item-id="e2706236c214a1240efa6e97aef52bdf5">In this case, the note can still be edited by on-screen instructions.</li>
|
||||
<li>In this case, the note can still be edited by on-screen instructions.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
33
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/List View.html
generated
vendored
33
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/List View.html
generated
vendored
@ -12,9 +12,9 @@
|
||||
as a single continuous document.</p>
|
||||
<h2>Interaction</h2>
|
||||
<ul>
|
||||
<li>Each note can be expanded or collapsed by clicking on the arrow to the
|
||||
<li data-list-item-id="e8a9709d9f325dab560cb24289d5ab231">Each note can be expanded or collapsed by clicking on the arrow to the
|
||||
left of the title.</li>
|
||||
<li>In the <a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>,
|
||||
<li data-list-item-id="e38647a2388fb38e1c6de17b617db9e76">In the <a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>,
|
||||
in the <em>Collection</em> tab there are options to expand and to collapse
|
||||
all notes easily.</li>
|
||||
</ul>
|
||||
@ -25,8 +25,31 @@
|
||||
<p>If exported to PDF within the desktop application, there is additional
|
||||
functionality:</p>
|
||||
<ul>
|
||||
<li>The table of contents of the PDF will reflect the structure of the notes.</li>
|
||||
<li>Reference and inline links to other notes within the same hierarchy will
|
||||
<li data-list-item-id="e06095ff0a3876a29bdc11f1a2f18dfdc">The table of contents of the PDF will reflect the structure of the notes.</li>
|
||||
<li
|
||||
data-list-item-id="e656526a5aa019d58af324ae5c3d39216">Reference and inline links to other notes within the same hierarchy will
|
||||
be functional (will jump to the corresponding page). If a link refers to
|
||||
a note that is not in the printed hierarchy, it will be unlinked.</li>
|
||||
</ul>
|
||||
</ul>
|
||||
<h2>Expanding and collapsing multiple notes at once</h2>
|
||||
<p>Apart from individually expanding or collapsing notes, it's also possible
|
||||
to expand or collapse them all at once. To do so, go to the <em>Collection Properties</em> tab
|
||||
in the <a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_BlN9DFI679QC">Ribbon</a> and
|
||||
look for the corresponding button.</p>
|
||||
<p>By default, the <em>Expand</em> button will only expand the direct children
|
||||
(first level) of the collection. Starting with v0.100.0, it's possible
|
||||
to expand multiple levels of notes using the arrow button next to the button.</p>
|
||||
<p>Manually expanded notes will reset if the application/tab is closed and
|
||||
then the collection is visited again. Automatically expanded notes, using
|
||||
the ribbon configuration will persist.</p>
|
||||
<aside class="admonition tip">
|
||||
<p>By design, the UI provides only a handful of levels of depth for expanding
|
||||
notes (direct children, 2-5, all levels). It's also possible to specify
|
||||
any desired depth by manually setting the <a href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_HI6GBBIduIgv">corresponding label</a>.
|
||||
For example: <code>#expanded=100</code> to expand up to 100 levels of depth.</p>
|
||||
</aside>
|
||||
<aside class="admonition note">
|
||||
<p>From a performance standpoint, the List collection is efficient since
|
||||
it does not load child notes unless the notes are actually expanded. Expanding
|
||||
the list for a significantly large hierarchy can cause slow-downs.</p>
|
||||
</aside>
|
||||
@ -1,5 +1,5 @@
|
||||
# Documentation
|
||||
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/y4NVNSy5SB5V/Documentation_image.png" width="205" height="162">
|
||||
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/VUKpkCok5Zh4/Documentation_image.png" width="205" height="162">
|
||||
|
||||
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>.
|
||||
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
|
||||
|
||||
189
docs/User Guide/!!!meta.json
vendored
189
docs/User Guide/!!!meta.json
vendored
@ -4872,6 +4872,97 @@
|
||||
"type": "text",
|
||||
"mime": "text/html",
|
||||
"attributes": [
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "oPVyFC7WL2Lp",
|
||||
"isInheritable": false,
|
||||
"position": 10
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "3seOhtN8uLIY",
|
||||
"isInheritable": false,
|
||||
"position": 20
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "GTwFsgaA0lCt",
|
||||
"isInheritable": false,
|
||||
"position": 30
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "0ESUbbAxVnoK",
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "iPIMuisry3hd",
|
||||
"isInheritable": false,
|
||||
"position": 50
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "nRhnJkTT8cPs",
|
||||
"isInheritable": false,
|
||||
"position": 60
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "OFXdgB2nNk1F",
|
||||
"isInheritable": false,
|
||||
"position": 70
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "hrZ1D00cLbal",
|
||||
"isInheritable": false,
|
||||
"position": 80
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "lgKX7r3aL30x",
|
||||
"isInheritable": false,
|
||||
"position": 90
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "xWbu3jpNWapp",
|
||||
"isInheritable": false,
|
||||
"position": 100
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "l0tKav7yLHGF",
|
||||
"isInheritable": false,
|
||||
"position": 110
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "81SGnPGMk7Xc",
|
||||
"isInheritable": false,
|
||||
"position": 120
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "CoFPLs3dRlXc",
|
||||
"isInheritable": false,
|
||||
"position": 130
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
"name": "iconClass",
|
||||
@ -4885,97 +4976,6 @@
|
||||
"value": "quick-edit",
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "oPVyFC7WL2Lp",
|
||||
"isInheritable": false,
|
||||
"position": 50
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "3seOhtN8uLIY",
|
||||
"isInheritable": false,
|
||||
"position": 60
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "GTwFsgaA0lCt",
|
||||
"isInheritable": false,
|
||||
"position": 70
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "0ESUbbAxVnoK",
|
||||
"isInheritable": false,
|
||||
"position": 80
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "iPIMuisry3hd",
|
||||
"isInheritable": false,
|
||||
"position": 90
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "nRhnJkTT8cPs",
|
||||
"isInheritable": false,
|
||||
"position": 100
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "OFXdgB2nNk1F",
|
||||
"isInheritable": false,
|
||||
"position": 110
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "hrZ1D00cLbal",
|
||||
"isInheritable": false,
|
||||
"position": 120
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "lgKX7r3aL30x",
|
||||
"isInheritable": false,
|
||||
"position": 130
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "xWbu3jpNWapp",
|
||||
"isInheritable": false,
|
||||
"position": 140
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "l0tKav7yLHGF",
|
||||
"isInheritable": false,
|
||||
"position": 150
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "81SGnPGMk7Xc",
|
||||
"isInheritable": false,
|
||||
"position": 160
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "CoFPLs3dRlXc",
|
||||
"isInheritable": false,
|
||||
"position": 170
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
@ -10589,6 +10589,13 @@
|
||||
"value": "list",
|
||||
"isInheritable": false,
|
||||
"position": 30
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "HI6GBBIduIgv",
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
|
||||
@ -19,4 +19,18 @@ A printed list collection will print all the notes in the collection, in the rig
|
||||
If exported to PDF within the desktop application, there is additional functionality:
|
||||
|
||||
* The table of contents of the PDF will reflect the structure of the notes.
|
||||
* Reference and inline links to other notes within the same hierarchy will be functional (will jump to the corresponding page). If a link refers to a note that is not in the printed hierarchy, it will be unlinked.
|
||||
* Reference and inline links to other notes within the same hierarchy will be functional (will jump to the corresponding page). If a link refers to a note that is not in the printed hierarchy, it will be unlinked.
|
||||
|
||||
## Expanding and collapsing multiple notes at once
|
||||
|
||||
Apart from individually expanding or collapsing notes, it's also possible to expand or collapse them all at once. To do so, go to the _Collection Properties_ tab in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> and look for the corresponding button.
|
||||
|
||||
By default, the _Expand_ button will only expand the direct children (first level) of the collection. Starting with v0.100.0, it's possible to expand multiple levels of notes using the arrow button next to the button.
|
||||
|
||||
Manually expanded notes will reset if the application/tab is closed and then the collection is visited again. Automatically expanded notes, using the ribbon configuration will persist.
|
||||
|
||||
> [!TIP]
|
||||
> By design, the UI provides only a handful of levels of depth for expanding notes (direct children, 2-5, all levels). It's also possible to specify any desired depth by manually setting the [corresponding label](../Advanced%20Usage/Attributes/Labels.md). For example: `#expanded=100` to expand up to 100 levels of depth.
|
||||
|
||||
> [!NOTE]
|
||||
> From a performance standpoint, the List collection is efficient since it does not load child notes unless the notes are actually expanded. Expanding the list for a significantly large hierarchy can cause slow-downs.
|
||||
Loading…
x
Reference in New Issue
Block a user