The Board view presents sub-notes in columns for a Kanban-like experience.
@@ -15,83 +15,115 @@
Interaction
Working with columns
-
Create a new column by pressing Add Column near the last column.
+
Create a new column by pressing Add Column near the last column.
-
Once pressed, a text box will be displayed to set the name of the column.
+
Once pressed, a text box will be displayed to set the name of the column.
Press Enter to confirm, or Escape to dismiss.
-
To reorder a column, simply hold the mouse over the title and drag it
+
To reorder a column, simply hold the mouse over the title and drag it
to the desired position.
-
To delete a column, right click on its title and select Delete column.
-
To rename a column, click on the note title.
+
To delete a column, right click on its title and select Delete column.
+
To rename a column, click on the note title.
-
Press Enter to confirm.
-
Upon renaming a column, the corresponding status attribute of all its
+
Press Enter to confirm.
+
Upon renaming a column, the corresponding status attribute of all its
notes will be changed in bulk.
-
-
If there are many columns, use the mouse wheel to scroll.
+
+
If there are many columns, use the mouse wheel to scroll.
Working with notes
-
Create a new note in any column by pressing New item
+
Create a new note in any column by pressing New item
-
Enter the name of the note and press Enter or click away. To
+
Enter the name of the note and press Enter or click away. To
dismiss the creation of a new note, simply press Escape or leave
the name empty.
-
Once created, the new note will have an attribute (status label
+
Once created, the new note will have an attribute (status label
by default) set to the name of the column.
-
To open the note, simply click on it.
-
To change the title of the note directly from the board, hover the mouse
+
To open the note, simply click on it.
+
To change the title of the note directly from the board, hover the mouse
over its card and press the edit button on the right.
-
To change the state of a note, simply drag a note from one column to the
+
To change the state of a note, simply drag a note from one column to the
other to change its state.
-
The order of the notes in each column corresponds to their position in
+
The order of the notes in each column corresponds to their position in
the tree.
-
It's possible to reorder notes simply by dragging them to the desired
+
It's possible to reorder notes simply by dragging them to the desired
position within the same columns.
-
It's also possible to drag notes across columns, at the desired position.
+
It's also possible to drag notes across columns, at the desired position.
-
For more options, right click on a note to display a context menu with
+
For more options, right click on a note to display a context menu with
the following options:
-
Open the note in a new tab/split/window or quick edit.
-
Move the note to any column.
-
Insert a new note above/below the current one.
-
Archive/unarchive the current note.
-
Delete the current note.
+
Open the note in a new tab/split/window or quick edit.
+
Move the note to any column.
+
Insert a new note above/below the current one.
+
Archive/unarchive the current note.
+
Delete the current note.
-
If there are many notes within the column, move the mouse over the column
+
If there are many notes within the column, move the mouse over the column
and use the mouse wheel to scroll.
-
Keyboard interaction
+
Keyboard interaction
The board view has mild support for keyboard-based navigation:
-
Use Tab and Shift+Tab to navigate between
+
Use Tab and Shift+Tab to navigate between
column titles, notes and the “New item” button for each of the columns,
in sequential order.
-
To rename a column or a note, press F2 while it is focused.
-
To open a specific note or create a new item, press Enter while
+
To rename a column or a note, press F2 while it is focused.
+
To open a specific note or create a new item, press Enter while
it is focused.
-
To dismiss a rename of a note or a column, press Escape.
+
To dismiss a rename of a note or a column, press Escape.
Configuration
-
Grouping by another attribute
+
Grouping by another label
By default, the label used to group the notes is #status.
It is possible to use a different label if needed by defining a label named #board:groupBy with
- the value being the attribute to use (without # attribute prefix).
-
-
Limitations
-
-
It is not possible yet to use group by a relation, only by label.
-
\ No newline at end of file
+ the value being the attribute to use (with or without # attribute
+ prefix).
+
Grouping by relations
+
+
+
+
A more advanced use-case is grouping by Relations.
+
During this mode:
+
+
The columns represent the target notes of a relation.
+
When creating a new column, a note is selected instead of a column name.
+
The column icon will match the target note.
+
Moving notes between columns will change its relation.
+
Renaming an existing column will change the target note of all the notes
+ in that column.
+
+
Using relations instead of labels has some benefits:
+
+
The status/grouping of the notes is visible outside the Kanban board,
+ for example on the Note Map.
+
Columns can have icons.
+
Renaming columns is less intensive since it simply involves changing the
+ note title of the target note instead of having to do a bulk rename.
+
+
To do so:
+
+
First, create a Kanban board from scratch and not a template:
+
Assign #viewType=board #hidePromotedAttributes to emulate the
+ default template.
+
Set #board:groupBy to the name of a relation to group by, including the ~ prefix (e.g. ~status).
+
+
Optionally, use Promoted Attributes for
+ easy status change within the note:
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board_image.png
index be4b027d2..1ccb0a3cc 100644
Binary files a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board_image.png and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board_image.png differ
diff --git a/docs/Developer Guide/!!!meta.json b/docs/Developer Guide/!!!meta.json
index 5d95a894c..cdf47264f 100644
--- a/docs/Developer Guide/!!!meta.json
+++ b/docs/Developer Guide/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.99.4",
+ "appVersion": "0.99.5",
"files": [
{
"isClone": false,
@@ -110,6 +110,13 @@
"type": "text",
"mime": "text/html",
"attributes": [
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "4nwtTJyjNDKd",
+ "isInheritable": false,
+ "position": 10
+ },
{
"type": "label",
"name": "iconClass",
@@ -117,13 +124,6 @@
"isInheritable": false,
"position": 20
},
- {
- "type": "relation",
- "name": "internalLink",
- "value": "4nwtTJyjNDKd",
- "isInheritable": false,
- "position": 30
- },
{
"type": "label",
"name": "shareAlias",
@@ -1263,10 +1263,17 @@
{
"type": "relation",
"name": "internalLink",
- "value": "zdQzavvHDl1k",
+ "value": "ccIoz7nqgDRK",
"isInheritable": false,
"position": 10
},
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "zdQzavvHDl1k",
+ "isInheritable": false,
+ "position": 20
+ },
{
"type": "label",
"name": "iconClass",
@@ -1280,13 +1287,6 @@
"value": "releasing",
"isInheritable": false,
"position": 40
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "ccIoz7nqgDRK",
- "isInheritable": false,
- "position": 50
}
],
"format": "markdown",
diff --git a/docs/Developer Guide/Developer Guide/Documentation.md b/docs/Developer Guide/Developer Guide/Documentation.md
index 63cfdc33e..5f9f17e5f 100644
--- a/docs/Developer Guide/Developer Guide/Documentation.md
+++ b/docs/Developer Guide/Developer Guide/Documentation.md
@@ -1,5 +1,5 @@
# Documentation
-There are multiple types of documentation for Trilium:
+There are multiple types of documentation for Trilium:
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
diff --git a/docs/Release Notes/!!!meta.json b/docs/Release Notes/!!!meta.json
index c2c0b02ba..a2210f04e 100644
--- a/docs/Release Notes/!!!meta.json
+++ b/docs/Release Notes/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.99.4",
+ "appVersion": "0.99.5",
"files": [
{
"isClone": false,
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index bb262ac18..de161c37d 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.99.4",
+ "appVersion": "0.99.5",
"files": [
{
"isClone": false,
@@ -9884,18 +9884,47 @@
"value": "kanban-board",
"isInheritable": false,
"position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "Cq5X6iKQop6R",
+ "isInheritable": false,
+ "position": 30
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "OFXdgB2nNk1F",
+ "isInheritable": false,
+ "position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "bdUJEHsAPYQR",
+ "isInheritable": false,
+ "position": 50
}
],
"format": "markdown",
"dataFileName": "Kanban Board.md",
"attachments": [
{
- "attachmentId": "usSSa0WI6dDK",
+ "attachmentId": "IrIeh59VGjHq",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Kanban Board_image.png"
+ },
+ {
+ "attachmentId": "usSSa0WI6dDK",
+ "title": "image.png",
+ "role": "image",
+ "mime": "image/png",
+ "position": 10,
+ "dataFileName": "1_Kanban Board_image.png"
}
]
},
diff --git a/docs/User Guide/User Guide/Collections/1_Kanban Board_image.png b/docs/User Guide/User Guide/Collections/1_Kanban Board_image.png
new file mode 100644
index 000000000..be4b027d2
Binary files /dev/null and b/docs/User Guide/User Guide/Collections/1_Kanban Board_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/Kanban Board.md b/docs/User Guide/User Guide/Collections/Kanban Board.md
index e4efcdc26..c9b022537 100644
--- a/docs/User Guide/User Guide/Collections/Kanban Board.md
+++ b/docs/User Guide/User Guide/Collections/Kanban Board.md
@@ -1,5 +1,5 @@
# Kanban Board
-
+
The Board view presents sub-notes in columns for a Kanban-like experience. Each column represents a possible value for a status label, which can be adjusted.
@@ -41,7 +41,7 @@ Notes are displayed recursively, so even the child notes of the child notes will
* Delete the current note.
* If there are many notes within the column, move the mouse over the column and use the mouse wheel to scroll.
-## Keyboard interaction
+### Keyboard interaction
The board view has mild support for keyboard-based navigation:
@@ -52,13 +52,37 @@ The board view has mild support for keyboard-based navigation:
## Configuration
-### Grouping by another attribute
+### Grouping by another label
-By default, the label used to group the notes is `#status`. It is possible to use a different label if needed by defining a label named `#board:groupBy` with the value being the attribute to use (without `#` attribute prefix).
+By default, the label used to group the notes is `#status`. It is possible to use a different label if needed by defining a label named `#board:groupBy` with the value being the attribute to use (with or without `#` attribute prefix).
-> [!NOTE]
-> It's currently not possible to set a relation as the grouping criteria. There are plans to add support for it.
+### Grouping by relations
-## Limitations
+
-* It is not possible yet to use group by a relation, only by label.
\ No newline at end of file
+A more advanced use-case is grouping by [Relations](../Advanced%20Usage/Attributes/Relations.md).
+
+During this mode:
+
+* The columns represent the _target notes_ of a relation.
+* When creating a new column, a note is selected instead of a column name.
+* The column icon will match the target note.
+* Moving notes between columns will change its relation.
+* Renaming an existing column will change the target note of all the notes in that column.
+
+Using relations instead of labels has some benefits:
+
+* The status/grouping of the notes is visible outside the Kanban board, for example on the Note Map.
+* Columns can have icons.
+* Renaming columns is less intensive since it simply involves changing the note title of the target note instead of having to do a bulk rename.
+
+To do so:
+
+1. First, create a Kanban board from scratch and not a template:
+2. Assign `#viewType=board #hidePromotedAttributes` to emulate the default template.
+3. Set `#board:groupBy` to the name of a relation to group by, **including the** `**~**` **prefix** (e.g. `~status`).
+4. Optionally, use Promoted Attributes for easy status change within the note:
+
+ ```
+ #relation:status(inheritable)="promoted,alias=Status,single"
+ ```
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Collections/Kanban Board_image.png b/docs/User Guide/User Guide/Collections/Kanban Board_image.png
index be4b027d2..1ccb0a3cc 100644
Binary files a/docs/User Guide/User Guide/Collections/Kanban Board_image.png and b/docs/User Guide/User Guide/Collections/Kanban Board_image.png differ
+There are multiple types of documentation for Trilium:
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
diff --git a/docs/Release Notes/!!!meta.json b/docs/Release Notes/!!!meta.json
index c2c0b02ba..a2210f04e 100644
--- a/docs/Release Notes/!!!meta.json
+++ b/docs/Release Notes/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.99.4",
+ "appVersion": "0.99.5",
"files": [
{
"isClone": false,
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index bb262ac18..de161c37d 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.99.4",
+ "appVersion": "0.99.5",
"files": [
{
"isClone": false,
@@ -9884,18 +9884,47 @@
"value": "kanban-board",
"isInheritable": false,
"position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "Cq5X6iKQop6R",
+ "isInheritable": false,
+ "position": 30
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "OFXdgB2nNk1F",
+ "isInheritable": false,
+ "position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "bdUJEHsAPYQR",
+ "isInheritable": false,
+ "position": 50
}
],
"format": "markdown",
"dataFileName": "Kanban Board.md",
"attachments": [
{
- "attachmentId": "usSSa0WI6dDK",
+ "attachmentId": "IrIeh59VGjHq",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Kanban Board_image.png"
+ },
+ {
+ "attachmentId": "usSSa0WI6dDK",
+ "title": "image.png",
+ "role": "image",
+ "mime": "image/png",
+ "position": 10,
+ "dataFileName": "1_Kanban Board_image.png"
}
]
},
diff --git a/docs/User Guide/User Guide/Collections/1_Kanban Board_image.png b/docs/User Guide/User Guide/Collections/1_Kanban Board_image.png
new file mode 100644
index 000000000..be4b027d2
Binary files /dev/null and b/docs/User Guide/User Guide/Collections/1_Kanban Board_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/Kanban Board.md b/docs/User Guide/User Guide/Collections/Kanban Board.md
index e4efcdc26..c9b022537 100644
--- a/docs/User Guide/User Guide/Collections/Kanban Board.md
+++ b/docs/User Guide/User Guide/Collections/Kanban Board.md
@@ -1,5 +1,5 @@
# Kanban Board
-