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

docs(views/table): update documentation

Browse source
This commit is contained in:
Elian Doran 2025-07-19 09:47:10 +03:00
parent ba5ef93c1a
commit 56553078ef
No known key found for this signature in database
3 changed files with 245 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

191
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Table View.html generated vendored
View file

@ -5,79 +5,176 @@
<p>The table view displays information in a grid, where the rows are individual
notes and the columns are&nbsp;<a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>.
In addition, values are editable.</p>
<h2>How it works</h2>
<p>The tabular structure is represented as such:</p>
<ul>
<li data-list-item-id="e2f9c74f491f19544cc8bd91d4f0e2b7b">Each child note is a row in the table.</li>
<li data-list-item-id="e088e11b32fc5e97177413ef35dccf3b1">If child rows also have children, they will be displayed under an expander
(nested notes).</li>
<li data-list-item-id="e3e02ff50b40091e780be35dd4a141fec">Each column is a <a href="#root/_help_OFXdgB2nNk1F">promoted attribute</a> that
is defined on the Collection note.
<ul>
<li data-list-item-id="ed84d0aaca22ddfa667e0e5e2b8a2b571">Actually, both promoted and unpromoted attributes are supported, but it's
a requirement to use a label/relation definition.</li>
<li data-list-item-id="ec2c84efcd7687c2cbb0fa46b5b04e035">The promoted attributes are usually defined as inheritable in order to
show up in the child notes, but it's not a requirement.</li>
</ul>
</li>
<li data-list-item-id="e32b3ee6aa63a43bbba2a8127f7573f9e">If there are multiple attribute definitions with the same <code>name</code>,
only one will be displayed.</li>
</ul>
<p>There are also a few predefined columns:</p>
<ul>
<li data-list-item-id="e75fca7a0d17de2b1e99a5d1ae717f1a7">The current item number, identified by the <code>#</code> symbol.
<ul>
<li data-list-item-id="e2f1150a9bdc8e95c23f4453a00d0947b">This simply counts the note and is affected by sorting.</li>
</ul>
</li>
<li data-list-item-id="e6cf914471a03a8a06f8aee385da0f21d"><a class="reference-link" href="#root/_help_m1lbrzyKDaRB">Note ID</a>,
representing the unique ID used internally by Trilium</li>
<li data-list-item-id="ea8ddddd631b9fb155528ef4757672587">The title of the note.</li>
</ul>
<h2>Interaction</h2>
<h3>Creating a new table</h3>
<p>Right click the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;and
select <em>Insert child note</em> and look for the <em>Table item</em>.</p>
<h3>Adding columns</h3>
<p>Each column is a <a href="#root/_help_OFXdgB2nNk1F">promoted attribute</a> that
is defined on the Collection note. Ideally, the promoted attributes need
to be inheritable in order to show up in the child notes.</p>
<p>To create a new column, simply press <em>Add new column</em> at the bottom
of the table.</p>
<p>There are also a few predefined columns:</p>
<p>Each column is a <a href="#root/_help_OFXdgB2nNk1F">promoted or unpromoted attribute</a> that
is defined on the Collection note.</p>
<p>To create a new column, either:</p>
<ul>
<li>The current item number, identified by the <code>#</code> symbol. This simply
counts the note and is affected by sorting.</li>
<li><a class="reference-link" href="#root/_help_m1lbrzyKDaRB">Note ID</a>,
representing the unique ID used internally by Trilium</li>
<li>The title of the note.</li>
<li data-list-item-id="e3bb3951707ab03fccab11c9b83d8f7a1">Press <em>Add new column</em> at the bottom of the table.</li>
<li data-list-item-id="e59ac48e5d7f2f1119d27db5b01eb0635">Right click on an existing column and select Add column to the left/right.</li>
<li
data-list-item-id="e681ba5bf3901016423216783a17f13f8">Right click on the empty space of the column header and select <em>New column</em>.</li>
</ul>
<h3>Adding new rows</h3>
<p>Each row is actually a note that is a child of the Collection note.</p>
<p>To create a new note, press <em>Add new row</em> at the bottom of the table.
By default it will try to edit the title of the newly created note.</p>
<p>Alternatively, the note can be created from the<a class="reference-link"
<p>To create a new note, either:</p>
<ul>
<li data-list-item-id="e5b398750eec8daa1284942454b1da03f">Press <em>Add new row</em> at the bottom of the table.</li>
<li data-list-item-id="ed1fafca8d339a070b31ed86735757ad7">Right click on an existing row and select <em>Insert row above, Insert child note</em> or <em>Insert row below</em>.</li>
</ul>
<p>By default it will try to edit the title of the newly created note.</p>
<p>Alternatively, the note can be created from the&nbsp;<a class="reference-link"
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;or <a href="#root/_help_CdNpE2pqjmI6">scripting</a>.</p>
<h3>Context menu</h3>
<p>There are multiple menus:</p>
<ul>
<li data-list-item-id="ec7554ef5c121bbbe605c6a960207ce15">Right clicking on a column, allows:
<ul>
<li data-list-item-id="ef38b337e0b988758a61114627bb60c4c">Sorting by the selected column and resetting the sort.</li>
<li data-list-item-id="ecf9fc40517000ac6fd34ca1179145a11">Hiding the selected column or adjusting the visibility of every column.</li>
<li
data-list-item-id="ee7af88842f7f7191fa4f928929bb5e09">Adding new columns to the left or the right of the column.</li>
<li data-list-item-id="e4f04719c833b3048900a7fc4edad3aa1">Editing the current column.</li>
<li data-list-item-id="e648918725f9db40574f254ae7e973098">Deleting the current column.</li>
</ul>
</li>
<li data-list-item-id="e17dcbc050ffe71df0177061ea6083077">Right clicking on the space to the right of the columns, allows:
<ul>
<li data-list-item-id="e7245250ae9974578ac22f0804b9359f3">Adjusting the visibility of every column.</li>
<li data-list-item-id="ea854723a7e177b2fab226f2f47e74300">Adding new columns.</li>
</ul>
</li>
<li data-list-item-id="e1432be94738a66d9b1b6aeb09a939541">Right clicking on a row, allows:
<ul>
<li data-list-item-id="ea2b4133e43708b251b3a513edb37446a">Opening the corresponding note of the row in a new tab, split, window
or quick editing it.</li>
<li data-list-item-id="e0b1aecd8bf3fbb9810fc0ad43a8eecdc">Inserting rows above, below or as a child note.</li>
<li data-list-item-id="e9dc521aef229564b75d983e134646dda">Deleting the row.</li>
</ul>
</li>
</ul>
<h3>Editing data</h3>
<p>Simply click on a cell within a row to change its value. The change will
not only reflect in the table, but also as an attribute of the corresponding
note.</p>
<ul>
<li>The editing will respect the type of the promoted attribute, by presenting
<li data-list-item-id="ec968ed99278fdb8197fd621c69e7f6cc">The editing will respect the type of the promoted attribute, by presenting
a normal text box, a number selector or a date selector for example.</li>
<li>It also possible to change the title of a note.</li>
<li>Editing relations is also possible, by using the note autocomplete.</li>
<li
data-list-item-id="ecef0e73fd2da5ac88fe23ba83e725c1e">It also possible to change the title of a note.</li>
<li data-list-item-id="ef7b78a619db0596c6dfbeeb8c4ccb8e2">Editing relations is also possible
<ul>
<li data-list-item-id="eae5e595b5850aba8949d5bfb8e5c7da2">Simply click on a relation and it will become editable. Enter the text
to look for a note and click on it.</li>
<li data-list-item-id="e288ea9202d96e940abbbdc2ea33086b4">To remove a relation, remove the title of the note from the text box and
press Enter.</li>
</ul>
</li>
</ul>
<h3>Editing columns</h3>
<p>It is possible to edit a column by right clicking it and selecting <em>Edit column. </em>This
will basically change the label/relation definition at the collection level.</p>
<p>If the <em>Name</em> field of a column is changed, this will trigger a batch
operation in which the corresponding label/relation will be renamed in
all the children.</p>
<h2>Working with the data</h2>
<h3>Sorting</h3>
<p>It is possible to sort the data by the values of a column:</p>
<h3>Sorting by column</h3>
<p>By default, the order of the notes matches the order in the&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_oPVyFC7WL2Lp">Note Tree</a>.
However, it is possible to sort the data by the values of a column:</p>
<ul>
<li>To do so, simply click on a column.</li>
<li>To switch between ascending or descending sort, simply click again on
<li data-list-item-id="e1e0145471fc5258ad92621a89ac2c718">To do so, simply click on a column.</li>
<li data-list-item-id="e821bd86e23576f9eaa14c0db4fb91b83">To switch between ascending or descending sort, simply click again on
the same column. The arrow next to the column will indicate the direction
of the sort.</li>
<li data-list-item-id="ef51898adc5db8930da95259860497bea">To disable sorting and fall back to the original order, right click any
column on the header and select <em>Clear sorting.</em>
</li>
</ul>
<h3>Reordering and hiding columns</h3>
<ul>
<li>Columns can be reordered by dragging the header of the columns.</li>
<li>Columns can be hidden or shown by right clicking on a column and clicking
<li data-list-item-id="ea338c99f7b7e97886b988db91b3dd8d1">Columns can be reordered by dragging the header of the columns.</li>
<li
data-list-item-id="e383f93282db3299145a4371452636ce6">Columns can be hidden or shown by right clicking on a column and clicking
the item corresponding to the column.</li>
</ul>
<h3>Reordering rows</h3>
<p>Notes can be dragged around to change their order. This will also change
the order of the note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</p>
<p>Currently, it's possible to reorder notes even if sorting is used, but
the result might be inconsistent.</p>
<h2>Limitations</h2>
<p>The table functionality is still in its early stages, as such it faces
quite a few important limitations:</p>
<ol>
<li>As mentioned previously, the columns of the table are defined as&nbsp;
<a
class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>.
<ol>
<li>But only the promoted attributes that are defined at the level of the
Collection note are actually taken into consideration.</li>
<li>There are plans to recursively look for columns across the sub-hierarchy.</li>
</ol>
<p>Notes can be dragged around to change their order. To do so, move the
mouse over the three vertical dots near the number row and drag the mouse
to the desired position.</p>
<p>This will also change the order of the note in the&nbsp;<a class="reference-link"
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</p>
<p>Reordering does have some limitations:</p>
<ul>
<li data-list-item-id="ee5f38e1c946944bf94b2efe364c5b744">If the parent note has <code>#sorted</code>, reordering will be disabled.</li>
<li
data-list-item-id="e0efec2f2857fcddbf66080bd4451e61d">If using nested tables, then reordering will also be disabled.</li>
<li
data-list-item-id="e23e93f53c136142acb82818be192764c">Currently, it's possible to reorder notes even if column sorting is used,
but the result might be inconsistent.</li>
</ul>
<h3>Nested trees</h3>
<p>If the child notes of the collection also have their own child notes,
then they will be displayed in a hierarchy.</p>
<p>Next to the title of each element there will be a button to expand or
collapse. By default, all items are expanded.</p>
<p>Since nesting is not always desirable, it is possible to limit the nesting
to a certain number of levels or even disable it completely. To do so,
either:</p>
<ul>
<li data-list-item-id="e4b19a78e59f20a154e4c3ee997705226">Go to <em>Collection Properties</em> in the&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_BlN9DFI679QC">Ribbon</a>&nbsp;and
look for the <em>Max nesting depth</em> section.
<ul>
<li data-list-item-id="ef74f1b3782dfc806487a991c0355e0bb">To disable nesting, type 0 and press Enter.</li>
<li data-list-item-id="e73d79dbe86cced5465bc7d3df3477d90">To limit to a certain depth, type in the desired number (e.g. 2 to only
display children and sub-children).</li>
<li data-list-item-id="ec208d87bccb6c4dc7bc69dfce7bcf43b">To re-enable unlimited nesting, remove the number and press Enter.</li>
</ul>
</li>
<li>Hierarchy is not yet supported, so the table will only show the items
that are direct children of the <em>Collection</em> note.</li>
<li>Multiple labels and relations are not supported. If a&nbsp;<a class="reference-link"
href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;is defined
with a <em>Multi value</em> specificity, they will be ignored.</li>
</ol>
<li data-list-item-id="e51ebf8e9b9d8a2a85714d1d0efb676a6">Manually set <code>maxNestingDepth</code> to the desired value.</li>
</ul>
<p>Limitations:</p>
<ul>
<li data-list-item-id="ec2c723dc60844af4b399f78b7ee5790c">While in this mode, it's not possible to reorder notes.</li>
</ul>
<h2>Limitations</h2>
<p>Multi-value labels and relations are not supported. If a&nbsp;<a class="reference-link"
href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;is defined
with a <em>Multi value</em> specificity, they will be ignored.</p>
<h2>Use in search</h2>
<p>The table view can be used in a&nbsp;<a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>&nbsp;by
adding the <code>#viewType=table</code> attribute.</p>
@ -86,8 +183,8 @@
of the&nbsp;<a class="reference-link" href="#root/_help_eIg8jdvaoNNd">Search</a>.</p>
<p>However, there are also some limitations:</p>
<ul>
<li>It's not possible to reorder notes.</li>
<li>It's not possible to add a new row.</li>
<li data-list-item-id="e2f9d55f137f7700d85e0a4d2d22a1f59">It's not possible to reorder notes.</li>
<li data-list-item-id="e2c278adf505c58a9d11c87d1a6238f4c">It's not possible to add a new row.</li>
</ul>
<p>Columns are supported, by being defined as&nbsp;<a class="reference-link"
href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;to the&nbsp;

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

@ -3739,13 +3739,6 @@
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "m1lbrzyKDaRB",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
@ -3780,6 +3773,20 @@
"value": "bx bx-table",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "m1lbrzyKDaRB",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "BlN9DFI679QC",
"isInheritable": false,
"position": 80
}
],
"format": "markdown",

108
docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Table View.md vendored
View file

@ -3,6 +3,24 @@
The table view displays information in a grid, where the rows are individual notes and the columns are <a class="reference-link" href="../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a>. In addition, values are editable.
## How it works
The tabular structure is represented as such:
* Each child note is a row in the table.
* If child rows also have children, they will be displayed under an expander (nested notes).
* Each column is a [promoted attribute](../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md) that is defined on the Collection note.
* Actually, both promoted and unpromoted attributes are supported, but it's a requirement to use a label/relation definition.
* The promoted attributes are usually defined as inheritable in order to show up in the child notes, but it's not a requirement.
* If there are multiple attribute definitions with the same `name`, only one will be displayed.
There are also a few predefined columns:
* The current item number, identified by the `#` symbol.
* This simply counts the note and is affected by sorting.
* <a class="reference-link" href="../../../Advanced%20Usage/Note%20ID.md">Note ID</a>, representing the unique ID used internally by Trilium
* The title of the note.
## Interaction
### Creating a new table
@ -11,23 +29,44 @@ Right click the <a class="reference-link" href="../../UI%20Elements/Note%20Tree
### Adding columns
Each column is a [promoted attribute](../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md) that is defined on the Collection note. Ideally, the promoted attributes need to be inheritable in order to show up in the child notes.
Each column is a [promoted or unpromoted attribute](../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md) that is defined on the Collection note.
To create a new column, simply press _Add new column_ at the bottom of the table.
To create a new column, either:
There are also a few predefined columns:
* The current item number, identified by the `#` symbol. This simply counts the note and is affected by sorting.
* <a class="reference-link" href="../../../Advanced%20Usage/Note%20ID.md">Note ID</a>, representing the unique ID used internally by Trilium
* The title of the note.
* Press _Add new column_ at the bottom of the table.
* Right click on an existing column and select Add column to the left/right.
* Right click on the empty space of the column header and select _New column_.
### Adding new rows
Each row is actually a note that is a child of the Collection note.
To create a new note, press _Add new row_ at the bottom of the table. By default it will try to edit the title of the newly created note.
To create a new note, either:
Alternatively, the note can be created from the<a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a> or [scripting](../../../Scripting.md).
* Press _Add new row_ at the bottom of the table.
* Right click on an existing row and select _Insert row above, Insert child note_ or _Insert row below_.
By default it will try to edit the title of the newly created note.
Alternatively, the note can be created from the <a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a> or [scripting](../../../Scripting.md).
### Context menu
There are multiple menus:
* Right clicking on a column, allows:
* Sorting by the selected column and resetting the sort.
* Hiding the selected column or adjusting the visibility of every column.
* Adding new columns to the left or the right of the column.
* Editing the current column.
* Deleting the current column.
* Right clicking on the space to the right of the columns, allows:
* Adjusting the visibility of every column.
* Adding new columns.
* Right clicking on a row, allows:
* Opening the corresponding note of the row in a new tab, split, window or quick editing it.
* Inserting rows above, below or as a child note.
* Deleting the row.
### Editing data
@ -35,16 +74,25 @@ Simply click on a cell within a row to change its value. The change will not onl
* The editing will respect the type of the promoted attribute, by presenting a normal text box, a number selector or a date selector for example.
* It also possible to change the title of a note.
* Editing relations is also possible, by using the note autocomplete.
* Editing relations is also possible
* Simply click on a relation and it will become editable. Enter the text to look for a note and click on it.
* To remove a relation, remove the title of the note from the text box and press Enter.
### Editing columns
It is possible to edit a column by right clicking it and selecting _Edit column._ This will basically change the label/relation definition at the collection level.
If the _Name_ field of a column is changed, this will trigger a batch operation in which the corresponding label/relation will be renamed in all the children.
## Working with the data
### Sorting
### Sorting by column
It is possible to sort the data by the values of a column:
By default, the order of the notes matches the order in the <a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a>. However, it is possible to sort the data by the values of a column:
* To do so, simply click on a column.
* To switch between ascending or descending sort, simply click again on the same column. The arrow next to the column will indicate the direction of the sort.
* To disable sorting and fall back to the original order, right click any column on the header and select _Clear sorting._
### Reordering and hiding columns
@ -53,19 +101,37 @@ It is possible to sort the data by the values of a column:
### Reordering rows
Notes can be dragged around to change their order. This will also change the order of the note in the <a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a>.
Notes can be dragged around to change their order. To do so, move the mouse over the three vertical dots near the number row and drag the mouse to the desired position.
Currently, it's possible to reorder notes even if sorting is used, but the result might be inconsistent.
This will also change the order of the note in the <a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a>.
Reordering does have some limitations:
* If the parent note has `#sorted`, reordering will be disabled.
* If using nested tables, then reordering will also be disabled.
* Currently, it's possible to reorder notes even if column sorting is used, but the result might be inconsistent.
### Nested trees
If the child notes of the collection also have their own child notes, then they will be displayed in a hierarchy.
Next to the title of each element there will be a button to expand or collapse. By default, all items are expanded.
Since nesting is not always desirable, it is possible to limit the nesting to a certain number of levels or even disable it completely. To do so, either:
* Go to _Collection Properties_ in the <a class="reference-link" href="../../UI%20Elements/Ribbon.md">Ribbon</a> and look for the _Max nesting depth_ section.
* To disable nesting, type 0 and press Enter.
* To limit to a certain depth, type in the desired number (e.g. 2 to only display children and sub-children).
* To re-enable unlimited nesting, remove the number and press Enter.
* Manually set `maxNestingDepth` to the desired value.
Limitations:
* While in this mode, it's not possible to reorder notes.
## Limitations
The table functionality is still in its early stages, as such it faces quite a few important limitations:
1. As mentioned previously, the columns of the table are defined as <a class="reference-link" href="../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a>.
1. But only the promoted attributes that are defined at the level of the Collection note are actually taken into consideration.
2. There are plans to recursively look for columns across the sub-hierarchy.
2. Hierarchy is not yet supported, so the table will only show the items that are direct children of the _Collection_ note.
3. Multiple labels and relations are not supported. If a <a class="reference-link" href="../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> is defined with a _Multi value_ specificity, they will be ignored.
Multi-value labels and relations are not supported. If a <a class="reference-link" href="../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> is defined with a _Multi value_ specificity, they will be ignored.
## Use in search