Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-31 18:36:30 +01:00
Code Issues Packages Projects Releases Activity

docs(guide): document table functionality

Browse Source
This commit is contained in:
Elian Doran
2025-07-04 23:03:50 +03:00
parent 4b86fedce1
commit b3f56851b8
11 changed files with 270 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json generated vendored
View File

File diff suppressed because one or more lines are too long

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

@@ -0,0 +1,98 @@
<figure class="image">
<img style="aspect-ratio:1050/259;" src="Table_image.png" width="1050"
height="259">
</figure>
<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/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>.
In addition, values are editable.</p>
<h2>Interaction</h2>
<h3>Creating a new table</h3>
<p>Right click the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_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/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">promoted attribute</a> that
is defined on the Book 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>
<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/pOsGYCXsbNQG/tC7s2alapj8V/_help_m1lbrzyKDaRB">Note ID</a>,
representing the unique ID used internally by Trilium</li>
<li>The title of the note.</li>
</ul>
<h3>Adding new rows</h3>
<p>Each row is actually a note that is a child of the book 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"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;or
<a
href="#root/pOsGYCXsbNQG/_help_CdNpE2pqjmI6">scripting</a>.</p>
<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
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>
</ul>
<h2>Working with the data</h2>
<h3>Sorting</h3>
<p>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
the same column. The arrow next to the column will indicate the direction
of the sort.</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
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/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_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/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>.
<ol>
<li>But only the promoted attributes that are defined at the level of the
Book note are actually taken into consideration.</li>
<li>There are plans to recursively look for columns across the sub-hierarchy.</li>
</ol>
</li>
<li>Hierarchy is not yet supported, so the table will only show the items
that are direct children of the <em>Book</em> note.</li>
<li>Multiple labels and relations are not supported. If a&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;is
defined with a <em>Multi value</em> specificity, they will be ignored.</li>
</ol>
<h2>Use in search</h2>
<p>The table view can be used in a&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_m523cpzocqaD">Saved Search</a>&nbsp;by
adding the <code>#viewType=table</code> attribute.</p>
<p>Unlike when used in a book, saved searches are not limited to the sub-hierarchy
of a note and allows for advanced queries thanks to the power of the&nbsp;
<a
class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/wArbEsdSae6g/_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>
</ul>
<p>Columns are supported, by being defined as&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;to
the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_m523cpzocqaD">Saved Search</a>&nbsp;note.</p>
<p>Editing is also supported.</p>

BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Table_image.png generated vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 34 KiB

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

@@ -7,3 +7,6 @@
<p>Once created, the note map will display the relations between notes. Only
the notes that are part of the parent of the note map will be displayed
(including their children).</p>
<p>The labels <code>mapIncludeRelation</code> and <code>mapExcludeRelation</code>,
if set, filter the note map to include only the specified relations or
to exclude the specified relations, respectively.</p>

2
docs/Developer Guide/!!!meta.json vendored
View File

@@ -1,6 +1,6 @@
{
"formatVersion": 2,
"appVersion": "0.95.0",
"appVersion": "0.96.0",
"files": [
{
"isClone": false,

2
docs/Release Notes/!!!meta.json vendored
View File

@@ -1,6 +1,6 @@
{
"formatVersion": 2,
"appVersion": "0.95.0",
"appVersion": "0.96.0",
"files": [
{
"isClone": false,

1
docs/Release Notes/Release Notes/v0.96.0.md vendored
View File

@@ -1,5 +1,4 @@
# v0.96.0
> [!NOTE]
> The Docker image has been relocated to `triliumnext/trilium`. Please update your configuration accordingly.

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

@@ -1,6 +1,6 @@
{
"formatVersion": 2,
"appVersion": "0.95.0",
"appVersion": "0.96.0",
"files": [
{
"isClone": false,
@@ -3420,6 +3420,86 @@
"dataFileName": "11_Calendar View_image.png"
}
]
},
{
"isClone": false,
"noteId": "2FvYrpmOXm29",
"notePath": [
"pOsGYCXsbNQG",
"gh7bpGYxajRS",
"BFs8mudNFgCS",
"0ESUbbAxVnoK",
"2FvYrpmOXm29"
],
"title": "Table",
"notePosition": 20,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-table",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "OFXdgB2nNk1F",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "m1lbrzyKDaRB",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "CdNpE2pqjmI6",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "m523cpzocqaD",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "eIg8jdvaoNNd",
"isInheritable": false,
"position": 70
}
],
"format": "markdown",
"dataFileName": "Table.md",
"attachments": [
{
"attachmentId": "vJYUG9fLQ2Pd",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Table_image.png"
}
]
}
]
}

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

@@ -0,0 +1,83 @@
# Table
<figure class="image"><img style="aspect-ratio:1050/259;" src="Table_image.png" width="1050" height="259"></figure>
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.
## Interaction
### Creating a new table
Right click the <a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a> and select _Insert child note_ and look for the _Table item_.
### Adding columns
Each column is a [promoted attribute](../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md) that is defined on the Book note. Ideally, the promoted attributes need to be inheritable in order to show up in the child notes.
To create a new column, simply press _Add new column_ at the bottom of the table.
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.
### Adding new rows
Each row is actually a note that is a child of the book 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.
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).
### Editing data
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.
* 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.
## Working with the data
### Sorting
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.
### Reordering and hiding columns
* Columns can be reordered by dragging the header of the columns.
* Columns can be hidden or shown by right clicking on a column and clicking the item corresponding to the 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>.
Currently, it's possible to reorder notes even if sorting is used, but the result might be inconsistent.
## 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 Book 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 _Book_ 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.
## Use in search
The table view can be used in a <a class="reference-link" href="../../../Note%20Types/Saved%20Search.md">Saved Search</a> by adding the `#viewType=table` attribute.
Unlike when used in a book, saved searches are not limited to the sub-hierarchy of a note and allows for advanced queries thanks to the power of the <a class="reference-link" href="../../Navigation/Search.md">Search</a>.
However, there are also some limitations:
* It's not possible to reorder notes.
* It's not possible to add a new row.
Columns are supported, by being defined as <a class="reference-link" href="../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> to the <a class="reference-link" href="../../../Note%20Types/Saved%20Search.md">Saved Search</a> note.
Editing is also supported.

BIN
docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Table_image.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 34 KiB