Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-04 20:36:13 +01:00
Code Issues Packages Projects Releases Activity

docs(guide): board view

Browse Source
This commit is contained in:
Elian Doran
2025-07-25 17:55:13 +03:00
parent e851701a9e
commit 06672e439e
19 changed files with 631 additions and 441 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Developer Guide/Developer Guide/Development and architecture/Database/entity_changes.md vendored
View File

@@ -7,7 +7,7 @@
| `hash` | Text | Nullable (\*) | | TODO: Describe how the hash is calculated |
| `isErased` | Integer (1 or 0) | Nullable (\*) | | TODO: What does this do? |
| `changeId` | Text | Nullable (\*) | | TODO: What does this do? |
| `componentId` | Text | Nullable (\*) | | The ID of the UI component that caused this change.<br><br>Examples: `date-note`, `F-PoZMI0vc`, `NA` (catch all) |
| `componentId` | Text | Nullable (\*) | | The ID of the UI component that caused this change. <br> <br>Examples: `date-note`, `F-PoZMI0vc`, `NA` (catch all) |
| `instanceId` | Text | Nullable (\*) | | The ID of the [instance](#root/pOsGYCXsbNQG/tC7s2alapj8V/Gzjqa934BdH4/c5xB8m4g2IY6) that created this change. |
| `isSynced` | Integer (1 or 0) | Non-null | | TODO: What does this do? |
| `utcDateChanged` | Text | Non-null | | Date of the entity change in UTC format (e.g. `2023-11-08 16:43:44.204Z`) |

2
docs/Developer Guide/Developer Guide/Development and architecture/Icons/Icons on Mac/Adaptive icon.md vendored
View File

@@ -1,6 +1,6 @@
# Adaptive icon
| | |
| --- | --- |
| --- | --- |
| Before | <figure class="image"><img src="1_Adaptive icon_image.png"></figure> |
| After | <figure class="image"><img src="6_Adaptive icon_image.png"></figure> |
| With new scale | <figure class="image"><img src="4_Adaptive icon_image.png"></figure> |

12
docs/Developer Guide/Developer Guide/Development and architecture/Icons/Removed icons.md vendored
View File

@@ -17,11 +17,11 @@ These are stored in `images`:
| Name | Resolution | Description |
| --- | --- | --- |
| `png/16x16-bw.png` | 16x16 | Do not appear to be used. |
| `png/16x16.png` |
| `png/24x24.png` | 24x24 |
| `png/32x32.png` | 32x32 |
| `png/48x48.png` | 48x48 |
| `png/64x64.png` | 64x64 |
| `png/96x96.png` | 96x96 |
| `png/16x16.png` | | |
| `png/24x24.png` | 24x24 | |
| `png/32x32.png` | 32x32 | |
| `png/48x48.png` | 48x48 | |
| `png/64x64.png` | 64x64 | |
| `png/96x96.png` | 96x96 | |
| `png/512x512.png` | 512x512 | Does not appear to be used. |
| `win/setup-banner.xcf` | | GIMP source for `win/setup-banner.gif`. Provided only for future editing. |

4
docs/Developer Guide/Developer Guide/Old documentation/Build deliveries locally.md vendored
View File

@@ -4,9 +4,9 @@ In the project root:
| Platform | Architecture | Application | Build command |
| --- | --- | --- | --- |
| macOS | x86\_64 | Desktop / Electron app | `./bin/build-mac-x64.sh` |
| ARM 64 | Desktop / Electron app | `./bin/build-mac-arm64.sh` |
| ARM 64 | Desktop / Electron app | `./bin/build-mac-arm64.sh` | |
| Linux | x86\_64 | Desktop / Electron app | `./bin/build-linux-x64.sh` |
| Server | `./bin/build-server.sh` |
| Server | `./bin/build-server.sh` | | |
| Windows | x86\_64 | Desktop / Electron app | `./bin/build-win-x64.sh` |
Under NixOS the following `nix-shell` is needed:

46
docs/Developer Guide/Developer Guide/Old documentation/Project maintenance/Updating dependencies/Node.js, Electron and `better-.md vendored
View File

@@ -6,31 +6,31 @@
Trilium Next started with version [8.4.0](https://github.com/WiseLibs/better-sqlite3/releases/tag/v8.4.0) for `better-sqlite3`
| | | | |
| --- | --- | --- | --- |
| --- | --- | --- | --- |
| `better-sqlite3` version | SQLite version | Node.js prebuilds | Electron.js prebuilds |
| 8.4.0 | <3.43.0 | v20 | ??? |
| 8.5.0 | v20 | v25 |
| 8.5.1 | | v26 |
| 8.5.2 | v20 (macOS + arm64) |
| 8.6.0 | 3.43.0 | |
| 8.7.0 | 3.43.1 | |
| 8.5.0 | v20 | v25 | |
| 8.5.1 | | v26 | |
| 8.5.2 | v20 (macOS + arm64) | | |
| 8.6.0 | 3.43.0 | | |
| 8.7.0 | 3.43.1 | | |
| 9.0.0 | 3.43.2 | | v27 |
| 9.1.0 | 3.44.0 | |
| 9.1.1 | macOS + Alpine |
| 9.2.0 | 3.44.2 | |
| 9.2.1 / 9.2.2 | | v28 |
| 9.3.0 | 3.45.0 | |
| 9.4.0 | 3.45.1 | |
| 9.4.1 | Windows arm, arm64 |
| 9.4.2 | | <v29 |
| 9.4.3 | | <v29 |
| 9.4.4 | | v29 |
| 9.4.5 | Better prebuilds |
| 9.5.0 | 3.45.2 | |
| 9.1.0 | 3.44.0 | | |
| 9.1.1 | macOS + Alpine | | |
| 9.2.0 | 3.44.2 | | |
| 9.2.1 / 9.2.2 | | v28 | |
| 9.3.0 | 3.45.0 | | |
| 9.4.0 | 3.45.1 | | |
| 9.4.1 | Windows arm, arm64 | | |
| 9.4.2 | | <v29 | |
| 9.4.3 | | <v29 | |
| 9.4.4 | | v29 | |
| 9.4.5 | Better prebuilds | | |
| 9.5.0 | 3.45.2 | | |
| 9.6.0 | 3.45.3 | | v30 |
| 10.0.0 | v22 |
| 10.1.0 | 3.46.0 | |
| 11.0.0 | \>21 |
| 10.0.0 | v22 | | |
| 10.1.0 | 3.46.0 | | |
| 11.0.0 | \>21 | | |
| 11.1.0 (prerelease) | | | v31 |
| 11.1.1 | | |
| 11.1.2 | | |
| 11.1.1 | | | |
| 11.1.2 | | | |

2
docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Differences from upstream.md vendored
View File

@@ -6,7 +6,7 @@
| Affected file | Affected method | Changed in | Reason for change |
| --- | --- | --- | --- |
| `packages/ckeditor5-mention/src/mentionui.ts` | `createRegExp()` | `6db05043be24bacf9bd51ea46408232b01a1b232` (added back) | Allows triggering the autocomplete for labels and attributes in the attribute editor. |
| `init()` | `55a63a1934efb9a520fcc2d69f3ce55ac22aca39` | Allows dismissing @-mention permanently after pressing ESC, otherwise it would automatically show up as soon as a space was entered. |
| `init()` | `55a63a1934efb9a520fcc2d69f3ce55ac22aca39` | Allows dismissing @-mention permanently after pressing ESC, otherwise it would automatically show up as soon as a space was entered. | |
## Checking the old repo

2
docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Versions and external plugins.md vendored
View File

@@ -2,7 +2,7 @@
## External plugins
| | | |
| --- | --- | --- |
| --- | --- | --- |
| trilium-ckeditor5 | 43.2.0 | |
| `ckeditor5-math` | | See <a class="reference-link" href="../ckeditor5-math.md">ckeditor5-math</a>. |
| | | |

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

@@ -7907,6 +7907,13 @@
"value": "bx bx-book",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "CtBQqbwXDx1w",
"isInheritable": false,
"position": 120
}
],
"format": "markdown",
@@ -8118,19 +8125,19 @@
"isInheritable": false,
"position": 70
},
{
"type": "label",
"name": "iconClass",
"value": "bx bx-map-alt",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "BlN9DFI679QC",
"isInheritable": false,
"position": 80
},
{
"type": "label",
"name": "iconClass",
"value": "bx bx-map-alt",
"isInheritable": false,
"position": 10
}
],
"format": "markdown",
@@ -8499,6 +8506,50 @@
"dataFileName": "Table View_image.png"
}
]
},
{
"isClone": false,
"noteId": "CtBQqbwXDx1w",
"notePath": [
"pOsGYCXsbNQG",
"KSZ04uQ2D1St",
"GTwFsgaA0lCt",
"CtBQqbwXDx1w"
],
"title": "Board View",
"notePosition": 60,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-columns",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "2FvYrpmOXm29",
"isInheritable": false,
"position": 20
}
],
"format": "markdown",
"dataFileName": "Board View.md",
"attachments": [
{
"attachmentId": "usSSa0WI6dDK",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Board View_image.png"
}
]
}
]
},

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

@@ -11,6 +11,7 @@ More specialized collections were introduced, such as the:
* <a class="reference-link" href="Collections/Calendar%20View.md">Calendar View</a> which 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.
* <a class="reference-link" href="Collections/Geo%20Map%20View.md">Geo Map View</a> which 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.
* <a class="reference-link" href="Collections/Table%20View.md">Table View</a> displays each note as a row in a table, with <a class="reference-link" href="../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> being shown as well. This makes it easy to visualize attributes of notes, as well as making them easily editable.
* <a class="reference-link" href="Collections/Board%20View.md">Board View</a> (Kanban) displays notes in columns, grouped by the value of a label.
For a quick presentation of all the supported view types, see the child notes of this help page, including screenshots.

52
docs/User Guide/User Guide/Note Types/Collections/Board View.md vendored Normal file
View File

@@ -0,0 +1,52 @@
# Board View
<figure class="image"><img style="aspect-ratio:918/248;" src="Board View_image.png" width="918" height="248"></figure>
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.
## How it works
When first creating a collection of _Board_ type, a few subnotes will be created, each having a `#status` label set. The board then groups each note by the value of the status attribute.
Notes are displayed recursively, so even the child notes of the child notes will be displayed. However, unlike the <a class="reference-link" href="Table%20View.md">Table View</a>, the notes are not displayed in a hierarchy.
## Interaction with columns
* 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. Press Enter to confirm.
* 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.
* 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.
## Interaction with notes
* Create a new note in any column by pressing _New item_
* Enter the name of the note and press _Enter_.
* Doing so will create a new note. The new note will have an attribute (`status` label by default) set to the name of the column.
* 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 tree.
* 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.
* 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.
* 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.
## Configuration
### Grouping by another attribute
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).
> [!NOTE]
> It's currently not possible to set a relation as the grouping criteria. There are plans to add support for it.
## Interaction
## Limitations
* It is not possible yet to use group by a relation, only by label.

BIN
docs/User Guide/User Guide/Note Types/Collections/Board View_image.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

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

@@ -131,7 +131,8 @@ Limitations:
## Limitations
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.
* 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.
* There is no support to filter the rows by a certain criteria. Consider using the table view in search for that use case.
## Use in search