zadam/trilium
1
1
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-02 03:24:53 +08:00
Code Issues Projects Releases Packages Wiki Activity

docs(guide): creating collections & adding a description

Browse source
This commit is contained in:
Elian Doran 2025-07-25 18:06:40 +03:00
parent 06672e439e
commit ca1403ffea
No known key found for this signature in database
3 changed files with 60 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections.html generated vendored
View file

@ -36,12 +36,39 @@
<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 in saved search</h2>
<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"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;and
look for the <em>Collections</em> entry and select the desired type.</p>
<h3>Adding a description to a collection</h3>
<p>To add a text before the collection, for example to describe it:</p>
<ol>
<li data-list-item-id="e7eaebf201ba06033f72b0c556aa7bfb9">Create a new collection.</li>
<li data-list-item-id="ecf21cdac7d4b10dbf7015fa4811cae6a">In the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_BlN9DFI679QC">Ribbon</a>,
go to <em>Basic Properties</em> and change the note type from <em>Collection</em> to <em>Text</em>.</li>
</ol>
<p>Now the text will be displayed above while still maintaining the collection
view.</p>
<h3>Using saved search</h3>
<p>Since collections are based on the&nbsp;<a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a>&nbsp;mechanism,
it's possible to apply the same configuration to&nbsp;<a class="reference-link"
href="#root/_help_m523cpzocqaD">Saved Search</a>&nbsp;to do advanced querying
and presenting the result in an adequate matter such as a calendar, a table
or even a map.</p>
<h3>Creating a collection from scratch</h3>
<p>By default, collections come with a default configuration and sometimes
even sample notes. To create a collection completely from scratch:</p>
<ol>
<li data-list-item-id="ec1bab7b7f39744ea42e187c10b7d7216">Create a new note of type <em>Text</em> (or any type).</li>
<li data-list-item-id="edcd0acc96fef97ba37695cd69c19a1b6">In the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_BlN9DFI679QC">Ribbon</a>,
go to <em>Basic Properties</em> and select <em>Collection</em> as the note
type.</li>
<li data-list-item-id="e48769aec6e389d541c275f59220f032e">Still in the ribbon, go to <em>Collection Properties</em> and select the
desired view type.</li>
<li data-list-item-id="e5d79e0729f8daaae2c32cce773898464">Consult the help page of the corresponding view type in order to understand
how to configure them.</li>
</ol>
<h2>Under the hood</h2>
<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

7
docs/User Guide/!!!meta.json vendored
View file

@ -7914,6 +7914,13 @@
"value": "CtBQqbwXDx1w",
"isInheritable": false,
"position": 120
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 130
}
],
"format": "markdown",

26
docs/User Guide/User Guide/Note Types/Collections.md vendored
View file

@ -19,10 +19,34 @@ For a quick presentation of all the supported view types, see the child notes of
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 in saved search
## 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.
### Adding a description to a collection
To add a text before the collection, for example to describe it:
1. Create a new collection.
2. In the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>, go to _Basic Properties_ and change the note type from _Collection_ to _Text_.
Now the text will be displayed above while still maintaining the collection view.
### Using saved search
Since collections are based on the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a> mechanism, it's possible to apply the same configuration to <a class="reference-link" href="Saved%20Search.md">Saved Search</a> to do advanced querying and presenting the result in an adequate matter such as a calendar, a table or even a map.
### Creating a collection from scratch
By default, collections come with a default configuration and sometimes even sample notes. To create a collection completely from scratch:
1. Create a new note of type _Text_ (or any type).
2. In the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>, go to _Basic Properties_ and select _Collection_ as the note 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.
## 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.