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

docs(user): update documentation on search in collections

Browse Source
This commit is contained in:
Elian Doran 2025-10-20 18:16:28 +03:00
parent b224267e3b
commit 29682cef49
No known key found for this signature in database
4 changed files with 113 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.html generated vendored
View File

@ -4,6 +4,7 @@
<figcaption>Screenshot of the note contextual menu indicating the “Export as PDF” <figcaption>Screenshot of the note contextual menu indicating the “Export as PDF”
option.</figcaption> option.</figcaption>
</figure> </figure>
<h2>Printing</h2> <h2>Printing</h2>
<p>This feature allows printing of notes. It works on both the desktop client, <p>This feature allows printing of notes. It works on both the desktop client,
but also on the web.</p> but also on the web.</p>
@ -28,7 +29,7 @@ class="admonition note">
on the on the
<img src="1_Printing & Exporting as PD.png" width="29" height="31">button, select Export note → This note and all of its descendants → HTML <img src="1_Printing & Exporting as PD.png" width="29" height="31">button, select Export note → This note and all of its descendants → HTML
in ZIP archive). Make sure not to accidentally leak any personal information.</p> in ZIP archive). Make sure not to accidentally leak any personal information.</p>
<p>Consider adjusting font sizes and using <a href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_CohkqWQC1iBv">page breaks</a> to <p>Consider adjusting font sizes and using <a href="#root/_help_CohkqWQC1iBv">page breaks</a> to
work around the layout.</p> work around the layout.</p>
<h2>Exporting as PDF</h2> <h2>Exporting as PDF</h2>
<p>On the desktop application of Trilium it is possible to export a note <p>On the desktop application of Trilium it is possible to export a note
@ -49,12 +50,12 @@ class="admonition note">
<h3>Customizing exporting as PDF</h3> <h3>Customizing exporting as PDF</h3>
<p>When exporting to PDF, there are no customizable settings such as page <p>When exporting to PDF, there are no customizable settings such as page
orientation, size. However, there are a few&nbsp;<a class="reference-link" orientation, size. However, there are a few&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_zEY4DaJG4YT5">Attributes</a>&nbsp;to href="#root/_help_zEY4DaJG4YT5">Attributes</a>&nbsp;to adjust some of the
adjust some of the settings:</p> settings:</p>
<ul> <ul>
<li data-list-item-id="e76a765fe309058890d4f4d3e63bca578">To print in landscape mode instead of portrait (useful for big diagrams <li>To print in landscape mode instead of portrait (useful for big diagrams
or slides), add <code>#printLandscape</code>.</li> or slides), add <code>#printLandscape</code>.</li>
<li data-list-item-id="e78123a3a12954d7c9f520f4e75ed375d">By default, the resulting PDF will be in Letter format. It is possible <li>By default, the resulting PDF will be in Letter format. It is possible
to adjust it to another page size via the <code>#printPageSize</code> attribute, to adjust it to another page size via the <code>#printPageSize</code> attribute,
with one of the following values: <code>A0</code>, <code>A1</code>, <code>A2</code>, <code>A3</code>, <code>A4</code>, <code>A5</code>, <code>A6</code>, <code>Legal</code>, <code>Letter</code>, <code>Tabloid</code>, <code>Ledger</code>.</li> with one of the following values: <code>A0</code>, <code>A1</code>, <code>A2</code>, <code>A3</code>, <code>A4</code>, <code>A5</code>, <code>A6</code>, <code>Legal</code>, <code>Letter</code>, <code>Tabloid</code>, <code>Ledger</code>.</li>
</ul> </ul>
@ -68,34 +69,34 @@ class="admonition note">
href="#root/_help_4TIF1oA4VQRO">Options</a>&nbsp;and assigning a key combination href="#root/_help_4TIF1oA4VQRO">Options</a>&nbsp;and assigning a key combination
for:</p> for:</p>
<ul> <ul>
<li class="ck-list-marker-italic" data-list-item-id="e52b4441f2a3af7773585b19c8f796c8d"><em>Print Active Note</em> <li><em>Print Active Note</em>
</li> </li>
<li class="ck-list-marker-italic" data-list-item-id="e40e1f6f480c7857100f64c2f63e062fb"><em>Export Active Note as PDF</em> <li><em>Export Active Note as PDF</em>
</li> </li>
</ul> </ul>
<h2>Constraints &amp; limitations</h2> <h2>Constraints &amp; limitations</h2>
<p>Not all&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/_help_KSZ04uQ2D1St">Note Types</a>&nbsp;are <p>Not all&nbsp;<a class="reference-link" href="#root/_help_KSZ04uQ2D1St">Note Types</a>&nbsp;are
supported when printing, in which case the <em>Print</em> and <em>Export as PDF</em> options supported when printing, in which case the <em>Print</em> and <em>Export as PDF</em> options
will be disabled.</p> will be disabled.</p>
<ul> <ul>
<li data-list-item-id="e448a833da1bb1643181c72779382d1b6">For&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_6f9hih2hXXZk">Code</a>&nbsp;notes: <li>For&nbsp;<a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;notes:
<ul> <ul>
<li data-list-item-id="e6b699104a21930de7c2618123d0d5750">Line numbers are not printed.</li> <li>Line numbers are not printed.</li>
<li data-list-item-id="e342cba939534f0989c9620520c7b87a3">Syntax highlighting is enabled, however a default theme (Visual Studio) <li>Syntax highlighting is enabled, however a default theme (Visual Studio)
is enforced.</li> is enforced.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="ea23948a21d6ad2a01d70dfbdfa9bd62f">For&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_GTwFsgaA0lCt">Collections</a>: <li>For&nbsp;<a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>:
<ul> <ul>
<li data-list-item-id="e387ee52424d8b78fd61c3a1e0d395d3e">Only&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/GTwFsgaA0lCt/_help_zP3PMqaG71Ct">Presentation View</a>&nbsp;is <li>Only&nbsp;<a class="reference-link" href="#root/_help_zP3PMqaG71Ct">Presentation View</a>&nbsp;is
currently supported.</li> currently supported.</li>
<li data-list-item-id="e94fa0cced6a7668c96cf7513557f2906">We plan to add support for all the collection types at some point.</li> <li>We plan to add support for all the collection types at some point.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="e8b17c931e05f9d579767536088a108da">Using&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/pKK96zzmvBGf/_help_AlhDUqhENtH7">Custom app-wide CSS</a>&nbsp;for <li>Using&nbsp;<a class="reference-link" href="#root/_help_AlhDUqhENtH7">Custom app-wide CSS</a>&nbsp;for
printing is not longer supported, due to a more stable but isolated mechanism. printing is not longer supported, due to a more stable but isolated mechanism.
<ul> <ul>
<li data-list-item-id="eae91219e277cc2366d86d47291ed9cec">We plan to introduce a new mechanism specifically for a print CSS.</li> <li>We plan to introduce a new mechanism specifically for a print CSS.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -108,4 +109,4 @@ class="admonition note">
<p>Accessing the print note in a web browser allows for easy debugging to <p>Accessing the print note in a web browser allows for easy debugging to
understand why a particular note doesn't render well. The mechanism for understand why a particular note doesn't render well. The mechanism for
rendering is similar to the one used in&nbsp;<a class="reference-link" rendering is similar to the one used in&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/BFs8mudNFgCS/_help_0ESUbbAxVnoK">Note List</a>.</p> href="#root/_help_0ESUbbAxVnoK">Note List</a>.</p>

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

@ -4,28 +4,30 @@
child notes into one continuous view. This makes it ideal for reading extensive child notes into one continuous view. This makes it ideal for reading extensive
information broken into smaller, manageable segments.</p> information broken into smaller, manageable segments.</p>
<ul> <ul>
<li><a class="reference-link" href="#root/_help_8QqnMzx393bx">Grid View</a>&nbsp;which <li data-list-item-id="e43cd5203be3a89cff2aa8ceb3ca62b84"><a class="reference-link" href="#root/_help_8QqnMzx393bx">Grid View</a>&nbsp;which
is the default presentation method for child notes (see&nbsp;<a class="reference-link" is the default presentation method for child notes (see&nbsp;<a class="reference-link"
href="#root/_help_0ESUbbAxVnoK">Note List</a>), where the notes are displayed href="#root/_help_0ESUbbAxVnoK">Note List</a>), where the notes are displayed
as tiles with their title and content being visible.</li> as tiles with their title and content being visible.</li>
<li><a class="reference-link" href="#root/_help_mULW0Q3VojwY">List View</a>&nbsp;is <li data-list-item-id="e8a1944c0c300ec0e5566276ab78ab481"><a class="reference-link" href="#root/_help_mULW0Q3VojwY">List View</a>&nbsp;is
similar to&nbsp;<a class="reference-link" href="#root/_help_8QqnMzx393bx">Grid View</a>, similar to&nbsp;<a class="reference-link" href="#root/_help_8QqnMzx393bx">Grid View</a>,
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>
<p>More specialized collections were introduced, such as the:</p> <p>More specialized collections were introduced, such as the:</p>
<ul> <ul>
<li><a class="reference-link" href="#root/_help_xWbu3jpNWapp">Calendar View</a>&nbsp;which <li data-list-item-id="e391040c6f8f6d683e77dd8b91155faf8"><a class="reference-link" href="#root/_help_xWbu3jpNWapp">Calendar View</a>&nbsp;which
displays a week, month or year calendar with the notes being shown as events. 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.</li> New events can be added easily by dragging across the calendar.</li>
<li><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map View</a>&nbsp;which <li
data-list-item-id="e81b950279f4564360b8998573086eeb2"><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map View</a>&nbsp;which
displays a geographical map in which the notes are represented as markers/pins 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.</li> on the map. New events can be easily added by pointing on the map.</li>
<li><a class="reference-link" href="#root/_help_2FvYrpmOXm29">Table View</a>&nbsp;displays <li
data-list-item-id="e889775ae8dc3f0c2fc51a86f9a75239c"><a class="reference-link" href="#root/_help_2FvYrpmOXm29">Table View</a>&nbsp;displays
each note as a row in a table, with&nbsp;<a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;being 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. This makes it easy to visualize attributes of notes, as shown as well. This makes it easy to visualize attributes of notes, as
well as making them easily editable.</li> well as making them easily editable.</li>
<li><a class="reference-link" href="#root/_help_CtBQqbwXDx1w">Board View</a>&nbsp;(Kanban) <li data-list-item-id="e971c7ef8f4d30119638933042d983745"><a class="reference-link" href="#root/_help_CtBQqbwXDx1w">Board View</a>&nbsp;(Kanban)
displays notes in columns, grouped by the value of a label.</li> displays notes in columns, grouped by the value of a label.</li>
</ul> </ul>
<p>For a quick presentation of all the supported view types, see the child <p>For a quick presentation of all the supported view types, see the child
@ -42,49 +44,58 @@
<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>
<li>Create a new collection.</li> <li data-list-item-id="e37baa04a3c9707bb5047695c99677742">Create a new collection.</li>
<li>In the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>, <li data-list-item-id="e07e2627d54230a1d2aebca5d8676cfef">In the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>,
go to <em>Basic Properties</em> and change the note type from <em>Collection</em> to <em>Text</em>.</li> go to <em>Basic Properties</em> and change the note type from <em>Collection</em> to <em>Text</em>.</li>
</ol> </ol>
<p>Now the text will be displayed above while still maintaining the collection <p>Now the text will be displayed above while still maintaining the collection
view.</p> view.</p>
<h3>Using saved search</h3> <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, <p>Collections, by default, only display the child notes. However, it is
it's possible to apply the same configuration to&nbsp;<a class="reference-link" possible to use the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/wArbEsdSae6g/_help_eIg8jdvaoNNd">Search</a>&nbsp;functionality
href="#root/_help_m523cpzocqaD">Saved Search</a>&nbsp;to do advanced querying to display notes all across the tree, with advanced querying functionality.</p>
and presenting the result in an adequate matter such as a calendar, a table <p>To do so, simply start a&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/wArbEsdSae6g/_help_eIg8jdvaoNNd">Search</a>&nbsp;and
or even a map.</p> go to the <em>Collection Properties</em> tab in the&nbsp;<a class="reference-link"
<h3>Creating a collection from scratch</h3> href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_BlN9DFI679QC">Ribbon</a>&nbsp;and
<p>By default, collections come with a default configuration and sometimes select a desired type of collection. To keep the search-based collection,
use a&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_m523cpzocqaD">Saved Search</a>.</p>
<aside
class="admonition important">
<p>While in search, none of the collections will not display the child notes
of the search results. The reason is that the search might hit a note multiple
times, causing an exponential rise in the number of results.</p>
</aside>
<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> even sample notes. To create a collection completely from scratch:</p>
<ol> <ol>
<li>Create a new note of type <em>Text</em> (or any type).</li> <li data-list-item-id="eb60e8b061b0c7f5b991a1727c422c754">Create a new note of type <em>Text</em> (or any type).</li>
<li>In the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>, <li data-list-item-id="ef92adf795f76377d72653f69f5928bda">In the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>,
go to <em>Basic Properties</em> and select <em>Collection</em> as the note go to <em>Basic Properties</em> and select <em>Collection</em> as the note
type.</li> type.</li>
<li>Still in the ribbon, go to <em>Collection Properties</em> and select the <li data-list-item-id="eea4322a308b85751aac73e476eb46cb5">Still in the ribbon, go to <em>Collection Properties</em> and select the
desired view type.</li> desired view type.</li>
<li>Consult the help page of the corresponding view type in order to understand <li data-list-item-id="e0d2ab82221d6a9e3b4f116f0c9cae200">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> <h2>Archived notes</h2>
<p>By default, archived notes will not be shown in collections. This behaviour <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; can be changed by going to <em>Collection Properties</em> in the&nbsp;
<a <a
class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;and checking <em>Show archived notes</em>.</p> 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 <p>Archived notes will be generally indicated by being greyed out as opposed
to the normal ones.</p> 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
(the one that lists the children notes at the bottom of a note) to display (the one that lists the children notes at the bottom of a note) to display
information.</p> information.</p>
<p>By default, new collections use predefined&nbsp;<a class="reference-link" <p>By default, new collections use predefined&nbsp;<a class="reference-link"
href="#root/_help_KC1HB96bqqHX">Templates</a>&nbsp;that are stored safely href="#root/_help_KC1HB96bqqHX">Templates</a>&nbsp;that are stored safely
in the&nbsp;<a class="reference-link" href="#root/_help_2mUhVmZK8RF3">Hidden Notes</a>&nbsp;to in the&nbsp;<a class="reference-link" href="#root/_help_2mUhVmZK8RF3">Hidden Notes</a>&nbsp;to
define some basic configuration such as the type of view, but also some&nbsp; define some basic configuration such as the type of view, but also some&nbsp;
<a <a
class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;to make editing easier.</p> class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;to make editing easier.</p>
<p>Collections don't store their configuration (e.g. the position on the <p>Collections don't store their configuration (e.g. the position on the
map, the hidden columns in a table) in the content of the note itself, map, the hidden columns in a table) in the content of the note itself,
but as attachments.</p> but as attachments.</p>

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

@ -3489,21 +3489,14 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "wy8So3yZZlH9", "value": "0ESUbbAxVnoK",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "4TIF1oA4VQRO", "value": "wy8So3yZZlH9",
"isInheritable": false,
"position": 30
},
{
"type": "label",
"name": "iconClass",
"value": "bx bx-printer",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
@ -3517,7 +3510,7 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "0ESUbbAxVnoK", "value": "4TIF1oA4VQRO",
"isInheritable": false, "isInheritable": false,
"position": 50 "position": 50
}, },
@ -3538,23 +3531,30 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "AlhDUqhENtH7", "value": "GTwFsgaA0lCt",
"isInheritable": false, "isInheritable": false,
"position": 80 "position": 80
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "GTwFsgaA0lCt", "value": "zP3PMqaG71Ct",
"isInheritable": false, "isInheritable": false,
"position": 90 "position": 90
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "zP3PMqaG71Ct", "value": "AlhDUqhENtH7",
"isInheritable": false, "isInheritable": false,
"position": 100 "position": 100
},
{
"type": "label",
"name": "iconClass",
"value": "bx bx-printer",
"isInheritable": false,
"position": 30
} }
], ],
"format": "markdown", "format": "markdown",
@ -8119,13 +8119,6 @@
"isInheritable": false, "isInheritable": false,
"position": 100 "position": 100
}, },
{
"type": "relation",
"name": "internalLink",
"value": "m523cpzocqaD",
"isInheritable": false,
"position": 110
},
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
@ -8153,6 +8146,20 @@
"value": "bx bx-book", "value": "bx bx-book",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "eIg8jdvaoNNd",
"isInheritable": false,
"position": 140
},
{
"type": "relation",
"name": "internalLink",
"value": "m523cpzocqaD",
"isInheritable": false,
"position": 150
} }
], ],
"format": "markdown", "format": "markdown",

7
docs/User Guide/User Guide/Note Types/Collections.md vendored
View File

@ -36,7 +36,12 @@ Now the text will be displayed above while still maintaining the collection view
### Using saved search ### 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. Collections, by default, only display the child notes. However, it is possible to use the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Search.md">Search</a> functionality to display notes all across the tree, with advanced querying functionality.
To do so, simply start a <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Search.md">Search</a> and go to the _Collection Properties_ tab in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> and select a desired type of collection. To keep the search-based collection, use a <a class="reference-link" href="Saved%20Search.md">Saved Search</a>.
> [!IMPORTANT]
> While in search, none of the collections will not display the child notes of the search results. The reason is that the search might hit a note multiple times, causing an exponential rise in the number of results.
### Creating a collection from scratch ### Creating a collection from scratch