gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-31 19:49:01 +01:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

docs(user): minor improvements to the collection main page

Browse Source
This commit is contained in:
Elian Doran 2025-10-30 08:18:13 +02:00
parent 6e20d4b5dd
commit faf030ab3a
No known key found for this signature in database
3 changed files with 52 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections.html generated vendored
View File

@ -16,7 +16,7 @@
</figure> </figure>
</td> </td>
<td style="width:65%;"> <td style="width:65%;">
<p><a class="reference-link" href="#root/_help_xWbu3jpNWapp">Calendar View</a> <p><a class="reference-link" href="#root/_help_xWbu3jpNWapp">Calendar</a>
<br>which displays a week, month or year calendar with the notes being shown <br>which displays a week, month or year calendar with the notes being shown
as events. New events can be added easily by dragging across the calendar.</p> as events. New events can be added easily by dragging across the calendar.</p>
<p>&nbsp;</p> <p>&nbsp;</p>
@ -29,7 +29,7 @@
width="1643" height="647"> width="1643" height="647">
</figure> </figure>
</td> </td>
<td><a class="reference-link" href="#root/_help_2FvYrpmOXm29">Table View</a> <td><a class="reference-link" href="#root/_help_2FvYrpmOXm29">Table</a>
<br>displays each note as a row in a table, with&nbsp;<a class="reference-link" <br>displays each note as a row in a table, with&nbsp;<a class="reference-link"
href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;being shown as well. href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;being shown as well.
This makes it easy to visualize attributes of notes, as well as making This makes it easy to visualize attributes of notes, as well as making
@ -42,8 +42,9 @@
width="1174" height="850"> width="1174" height="850">
</figure> </figure>
</td> </td>
<td><a class="reference-link" href="#root/_help_CtBQqbwXDx1w">Board View</a> <td><a class="reference-link" href="#root/_help_CtBQqbwXDx1w">Kanban Board</a>
<br>displays notes in columns, grouped by the value of a label.</td> <br>displays notes in columns, grouped by the value of a label. Items and
columns can easily be created or dragged around to change their status.</td>
</tr> </tr>
<tr> <tr>
<td> <td>
@ -52,7 +53,7 @@
width="844" height="639"> width="844" height="639">
</figure> </figure>
</td> </td>
<td><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map View</a> <td><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map</a>
<br>which displays a geographical map in which the notes are represented as <br>which displays a geographical map in which the notes are represented as
markers/pins on the map. New events can be easily added by pointing on markers/pins on the map. New events can be easily added by pointing on
the map.</td> the map.</td>
@ -66,7 +67,7 @@
</figure> </figure>
</td> </td>
<td> <td>
<p><a class="reference-link" href="#root/pOsGYCXsbNQG/GTwFsgaA0lCt/_help_zP3PMqaG71Ct">Presentation View</a> <p><a class="reference-link" href="#root/pOsGYCXsbNQG/GTwFsgaA0lCt/_help_zP3PMqaG71Ct">Presentation</a>
<br>which shows each note as a slide and can be presented full-screen with <br>which shows each note as a slide and can be presented full-screen with
smooth transitions or exported to PDF for sharing.</p> smooth transitions or exported to PDF for sharing.</p>
<p>&nbsp;</p> <p>&nbsp;</p>
@ -89,15 +90,22 @@
but it displays the notes one under the other with the content being expandable/collapsible, but it displays the notes one under the other with the content being expandable/collapsible,
but also works recursively.</li> but also works recursively.</li>
</ul> </ul>
<h2>Configuration</h2> <h2>Creating a new collection</h2>
<p>To adjust the view type, see the dedicated <em>Collections</em> tab in the&nbsp;
<a
class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>.</p>
<h2>Use cases</h2>
<h3>Creating a new collection</h3>
<p>To create a new collections, right click in the&nbsp;<a class="reference-link" <p>To create a new collections, right click in the&nbsp;<a class="reference-link"
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;and look for the <em>Collections</em> entry href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;and look for the <em>Collections</em> entry
and select the desired type.</p> and select the desired type.</p>
<h2>Configuration</h2>
<p>To change the configuration of a collection or even switch to a different
collection (e.g. from Kanban Board to a Calendar), see the dedicated <em>Collections</em> tab
in the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>.</p>
<h2>Archived notes</h2>
<p>By default, <a href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/BFs8mudNFgCS/_help_MKmLg5x6xkor">archived notes</a> will
not be shown in collections. This behaviour can be changed by going to <em>Collection Properties</em> in
the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;and
checking <em>Show archived notes</em>.</p>
<p>Archived notes will be generally indicated by being greyed out as opposed
to the normal ones.</p>
<h2>Advanced use cases</h2>
<h3>Adding a description to a collection</h3> <h3>Adding a description to a collection</h3>
<p>To add a text before the collection, for example to describe it:</p> <p>To add a text before the collection, for example to describe it:</p>
<ol> <ol>
@ -134,13 +142,6 @@
<li data-list-item-id="e67306995e90c31a1bb6fbdfff63dc83f">Consult the help page of the corresponding view type in order to understand <li data-list-item-id="e67306995e90c31a1bb6fbdfff63dc83f">Consult the help page of the corresponding view type in order to understand
how to configure them.</li> how to configure them.</li>
</ol> </ol>
<h2>Archived notes</h2>
<p>By default, archived notes will not be shown in collections. This behaviour
can be changed by going to <em>Collection Properties</em> in the&nbsp;
<a
class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;and checking <em>Show archived notes</em>.</p>
<p>Archived notes will be generally indicated by being greyed out as opposed
to the normal ones.</p>
<h2>Under the hood</h2> <h2>Under the hood</h2>
<p>Collections by themselves are simply notes with no content that rely on <p>Collections by themselves are simply notes with no content that rely on
the&nbsp;<a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a>&nbsp;mechanism the&nbsp;<a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a>&nbsp;mechanism

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

@ -9086,13 +9086,6 @@
"isInheritable": false, "isInheritable": false,
"position": 90 "position": 90
}, },
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 100
},
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
@ -9183,6 +9176,20 @@
"value": "zP3PMqaG71Ct", "value": "zP3PMqaG71Ct",
"isInheritable": false, "isInheritable": false,
"position": 220 "position": 220
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 230
},
{
"type": "relation",
"name": "internalLink",
"value": "MKmLg5x6xkor",
"isInheritable": false,
"position": 240
} }
], ],
"format": "markdown", "format": "markdown",

36
docs/User Guide/User Guide/Collections.md vendored
View File

@ -5,11 +5,11 @@ Collections are a unique type of notes that don't have a content, but instead di
| | | | | |
| --- | --- | | --- | --- |
| <figure class="image"><img style="aspect-ratio:1651/810;" src="Collections_collection_ca.webp" width="1651" height="810"></figure> | <a class="reference-link" href="Collections/Calendar.md">Calendar View</a> <br>which displays a week, month or year calendar with the notes being shown as events. New events can be added easily by dragging across the calendar. | | <figure class="image"><img style="aspect-ratio:1651/810;" src="Collections_collection_ca.webp" width="1651" height="810"></figure> | <a class="reference-link" href="Collections/Calendar.md">Calendar</a> <br>which displays a week, month or year calendar with the notes being shown as events. New events can be added easily by dragging across the calendar. |
| <figure class="image"><img style="aspect-ratio:1643/647;" src="Collections_collection_ta.webp" width="1643" height="647"></figure> | <a class="reference-link" href="Collections/Table.md">Table View</a> <br>displays each note as a row in a table, with <a class="reference-link" href="Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> being shown as well. This makes it easy to visualize attributes of notes, as well as making them easily editable. | | <figure class="image"><img style="aspect-ratio:1643/647;" src="Collections_collection_ta.webp" width="1643" height="647"></figure> | <a class="reference-link" href="Collections/Table.md">Table</a> <br>displays each note as a row in a table, with <a class="reference-link" href="Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> being shown as well. This makes it easy to visualize attributes of notes, as well as making them easily editable. |
| <figure class="image"><img style="aspect-ratio:1174/850;" src="Collections_collection_bo.webp" width="1174" height="850"></figure> | <a class="reference-link" href="Collections/Kanban%20Board.md">Board View</a> <br>displays notes in columns, grouped by the value of a label. | | <figure class="image"><img style="aspect-ratio:1174/850;" src="Collections_collection_bo.webp" width="1174" height="850"></figure> | <a class="reference-link" href="Collections/Kanban%20Board.md">Kanban Board</a> <br>displays notes in columns, grouped by the value of a label. Items and columns can easily be created or dragged around to change their status. |
| <figure class="image"><img style="aspect-ratio:844/639;" src="Collections_collection_ge.webp" width="844" height="639"></figure> | <a class="reference-link" href="Collections/Geo%20Map.md">Geo Map View</a> <br>which displays a geographical map in which the notes are represented as markers/pins on the map. New events can be easily added by pointing on the map. | | <figure class="image"><img style="aspect-ratio:844/639;" src="Collections_collection_ge.webp" width="844" height="639"></figure> | <a class="reference-link" href="Collections/Geo%20Map.md">Geo Map</a> <br>which displays a geographical map in which the notes are represented as markers/pins on the map. New events can be easily added by pointing on the map. |
| <figure class="image"><img style="aspect-ratio:1120/763;" src="Collections_collection_pr.webp" width="1120" height="763"></figure> | <a class="reference-link" href="Collections/Presentation.md">Presentation View</a> <br>which shows each note as a slide and can be presented full-screen with smooth transitions or exported to PDF for sharing. | | <figure class="image"><img style="aspect-ratio:1120/763;" src="Collections_collection_pr.webp" width="1120" height="763"></figure> | <a class="reference-link" href="Collections/Presentation.md">Presentation</a> <br>which shows each note as a slide and can be presented full-screen with smooth transitions or exported to PDF for sharing. |
## Classic collections ## Classic collections
@ -18,16 +18,22 @@ Classic collections are read-only mode and compiles the contents of all child no
* <a class="reference-link" href="Collections/Grid%20View.md">Grid View</a> which is the default presentation method for child notes (see <a class="reference-link" href="Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a>), where the notes are displayed as tiles with their title and content being visible. * <a class="reference-link" href="Collections/Grid%20View.md">Grid View</a> which is the default presentation method for child notes (see <a class="reference-link" href="Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a>), where the notes are displayed as tiles with their title and content being visible.
* <a class="reference-link" href="Collections/List%20View.md">List View</a> is similar to <a class="reference-link" href="Collections/Grid%20View.md">Grid View</a>, but it displays the notes one under the other with the content being expandable/collapsible, but also works recursively. * <a class="reference-link" href="Collections/List%20View.md">List View</a> is similar to <a class="reference-link" href="Collections/Grid%20View.md">Grid View</a>, but it displays the notes one under the other with the content being expandable/collapsible, but also works recursively.
## Configuration ## Creating a new collection
To adjust the view type, see the dedicated _Collections_ tab in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>.
## Use cases
### Creating a new collection
To create a new collections, right click in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a> and look for the _Collections_ entry and select the desired type. To create a new collections, right click in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a> and look for the _Collections_ entry and select the desired type.
## Configuration
To change the configuration of a collection or even switch to a different collection (e.g. from Kanban Board to a Calendar), see the dedicated _Collections_ tab in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>.
## Archived notes
By default, [archived notes](Basic%20Concepts%20and%20Features/Notes/Archived%20Notes.md) will not be shown in collections. This behaviour can be changed by going to _Collection Properties_ in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> and checking _Show archived notes_.
Archived notes will be generally indicated by being greyed out as opposed to the normal ones.
## Advanced use cases
### Adding a description to a collection ### Adding a description to a collection
To add a text before the collection, for example to describe it: To add a text before the collection, for example to describe it:
@ -55,12 +61,6 @@ By default, collections come with a default configuration and sometimes even sam
3. Still in the ribbon, go to _Collection Properties_ and select the desired view type. 3. Still in the ribbon, go to _Collection Properties_ and select the desired view type.
4. Consult the help page of the corresponding view type in order to understand how to configure them. 4. Consult the help page of the corresponding view type in order to understand how to configure them.
## Archived notes
By default, archived notes will not be shown in collections. This behaviour can be changed by going to _Collection Properties_ in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> and checking _Show archived notes_.
Archived notes will be generally indicated by being greyed out as opposed to the normal ones.
## Under the hood ## Under the hood
Collections by themselves are simply notes with no content that rely on the <a class="reference-link" href="Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a> mechanism (the one that lists the children notes at the bottom of a note) to display information. Collections by themselves are simply notes with no content that rely on the <a class="reference-link" href="Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a> mechanism (the one that lists the children notes at the bottom of a note) to display information.