| Before |  |
|---|---|
| After |  |
| With new scale |  |
hideChildrenOverview
+ hideChildrenOverview
label.pageSize to
the desired number.The view types dictate how the child notes are represented.
-By default, the notes will be displayed in a grid, however there are also - some other view types available.
+The view types dictate how the child notes are represented. By default, + the notes will be displayed in a grid, however there are also some other + view types available.
Generally the view type can only be changed in a Collections note from the This is a clone of a note. Go to its primary location.
\ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Calendar View.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Calendar View.html similarity index 100% rename from apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Calendar View.html rename to apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Calendar View.html diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Calendar View_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Calendar View_image.png similarity index 100% rename from apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Calendar View_image.png rename to apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Calendar View_image.png diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Geo Map View.clone.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Geo Map View.clone.html deleted file mode 100644 index b4d153e64..000000000 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Geo Map View.clone.html +++ /dev/null @@ -1 +0,0 @@ -This is a clone of a note. Go to its primary location.
\ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Geo Map View.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Geo Map View.html similarity index 100% rename from apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Geo Map View.html rename to apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Geo Map View.html diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Geo Map View_image.jpg b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Geo Map View_image.jpg similarity index 100% rename from apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Geo Map View_image.jpg rename to apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Geo Map View_image.jpg diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Geo Map View_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Geo Map View_image.png similarity index 100% rename from apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Geo Map View_image.png rename to apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Geo Map View_image.png diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Grid View.clone.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Grid View.clone.html deleted file mode 100644 index c00abb546..000000000 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Grid View.clone.html +++ /dev/null @@ -1 +0,0 @@ -This is a clone of a note. Go to its primary location.
\ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Grid View.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Grid View.html similarity index 100% rename from apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Grid View.html rename to apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Grid View.html diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Grid View_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Grid View_image.png similarity index 100% rename from apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Grid View_image.png rename to apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Grid View_image.png diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/List View.clone.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/List View.clone.html deleted file mode 100644 index 21dae316b..000000000 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/List View.clone.html +++ /dev/null @@ -1 +0,0 @@ -This is a clone of a note. Go to its primary location.
\ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/List View.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/List View.html similarity index 100% rename from apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/List View.html rename to apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/List View.html diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/List View_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/List View_image.png similarity index 100% rename from apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/List View_image.png rename to apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/List View_image.png diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Table View.clone.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Table View.clone.html deleted file mode 100644 index 31f21928f..000000000 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Table View.clone.html +++ /dev/null @@ -1 +0,0 @@ -This is a clone of a note. Go to its primary location.
\ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Table View.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Table View.html similarity index 100% rename from apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Table View.html rename to apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Table View.html diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Table View_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Table View_image.png similarity index 100% rename from apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List/Table View_image.png rename to apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections/Table View_image.png diff --git a/docs/Developer Guide/!!!meta.json b/docs/Developer Guide/!!!meta.json index 26c20d962..0b94c1dd6 100644 --- a/docs/Developer Guide/!!!meta.json +++ b/docs/Developer Guide/!!!meta.json @@ -1,6 +1,6 @@ { "formatVersion": 2, - "appVersion": "0.97.0", + "appVersion": "0.97.1", "files": [ { "isClone": false, diff --git a/docs/Developer Guide/Developer Guide/Development and architecture/Database/attachments.md b/docs/Developer Guide/Developer Guide/Development and architecture/Database/attachments.md index 274233e4f..4312832dd 100644 --- a/docs/Developer Guide/Developer Guide/Development and architecture/Database/attachments.md +++ b/docs/Developer Guide/Developer Guide/Development and architecture/Database/attachments.md @@ -1,2 +1,16 @@ # attachments -| Column Name | Data Type | Nullity | Default value | Description |
|---|---|---|---|---|
attachmentId | Text | Non-null | Unique ID (e.g. qhC1vzU4nwSE) | |
ownerId | Text | Non-null | The unique ID of a row in notes. | |
role | Text | Non-null | The role of the attachment: image for images that are attached to a note, file for uploaded files. | |
mime | Text | Non-null | The MIME type of the attachment (e.g. image/png) | |
title | Text | Non-null | The title of the attachment. | |
isProtected | Integer | Non-null | 0 | 1 if the entity is protected, 0 otherwise. |
position | Integer | Non-null | 0 | Not sure where the position is relevant for attachments (saw it with values of 10 and 0). |
blobId | Text | Nullable | null | The corresponding blobId from the blobs table. |
dateModified | Text | Non-null | Localized modification date (e.g. 2023-11-08 18:43:44.204+0200) | |
utcDateModified | Text | Non-null | Modification date in UTC format (e.g. 2023-11-08 16:43:44.204Z) | |
utcDateScheduledForErasure | Text | Nullable | null | |
isDeleted | Integer | Non-null | 1 if the entity is deleted, 0 otherwise. | |
deleteId | Text | Nullable | null |
| Column Name | Data Type | Nullity | Default value | Description |
|---|---|---|---|---|
attributeId | Text | Non-null | Unique Id of the attribute (e.g. qhC1vzU4nwSE), can also have a special unique ID for Special notes (e.g. _lbToday_liconClass). | |
noteId | Text | Non-null | The ID of the note this atttribute belongs to | |
type | Text | Non-null | The type of attribute (label or relation). | |
name | Text | Non-null | The name/key of the attribute. | |
value | Text | Non-null | "" |
|
position | Integer | Non-null | 0 | The position of the attribute compared to the other attributes. Some predefined attributes such as originalFileName have a value of 1000. |
utcDateModified | Text | Non-null | Modification date in UTC format (e.g. 2023-11-08 16:43:44.204Z) | |
isDeleted | Integer | Non-null | 1 if the entity is deleted, 0 otherwise. | |
deleteId | Text | Nullable | null | |
isInheritable | Integer | Nullable | 0 |
| Column Name | Data Type | Nullity | Default value | Description |
|---|---|---|---|---|
attributeId | Text | Non-null | Unique Id of the attribute (e.g. qhC1vzU4nwSE), can also have a special unique ID for Special notes (e.g. _lbToday_liconClass). | |
noteId | Text | Non-null | The ID of the note this atttribute belongs to | |
type | Text | Non-null | The type of attribute (label or relation). | |
name | Text | Non-null | The name/key of the attribute. | |
value | Text | Non-null | "" |
|
position | Integer | Non-null | 0 | The position of the attribute compared to the other attributes. Some predefined attributes such as originalFileName have a value of 1000. |
utcDateModified | Text | Non-null | Modification date in UTC format (e.g. 2023-11-08 16:43:44.204Z) | |
isDeleted | Integer | Non-null | 1 if the entity is deleted, 0 otherwise. | |
deleteId | Text | Nullable | null | |
isInheritable | Integer | Nullable | 0 |
| Column Name | Data Type | Nullity | Default value | Description |
|---|---|---|---|---|
blobId | Text | Non-null | The unique ID of the blob (e.g. XXbfAJXqWrYnSXcelLFA).Important: this ID is actually a hash of the content, see | |
content | Text | Nullable | null | The content of the blob, can be either:
|
dateModified | Text | Non-null | Creation date with timezone offset (e.g. 2023-11-08 18:43:44.204+0200) | |
utcDateModified | Text | Non-null | Creation date in UTC format (e.g. 2023-11-08 16:43:44.204Z).Blobs cannot be modified, so this timestamp specifies when the blob was created. |
| Column Name | Data Type | Nullity | Default value | Description |
|---|---|---|---|---|
blobId | Text | Non-null | The unique ID of the blob (e.g. XXbfAJXqWrYnSXcelLFA).Important: this ID is actually a hash of the content, see | |
content | Text | Nullable | null | The content of the blob, can be either:
|
dateModified | Text | Non-null | Creation date with timezone offset (e.g. 2023-11-08 18:43:44.204+0200) | |
utcDateModified | Text | Non-null | Creation date in UTC format (e.g. 2023-11-08 16:43:44.204Z).Blobs cannot be modified, so this timestamp specifies when the blob was created. |
| Column Name | Data Type | Nullity | Default value | Description |
|---|---|---|---|---|
branchId | Text | Non-null | The ID of the branch, in the form of a_b where a is the parentNoteId and b is the noteId. | |
noteId | Text | Non-null | The ID of the note. | |
parentNoteId | Text | Non-null | The ID of the parent note the note belongs to. | |
notePosition | Integer | Non-null | The position of the branch within the same level of hierarchy, the value is usually a multiple of 10. | |
prefix | Text | Nullable | The branch prefix if any, or NULL otherwise. | |
isExpanded | Integer | Non-null | 0 | Whether the branch should appear expanded (its children shown) to the user. |
isDeleted | Integer | Non-null | 0 | 1 if the entity is deleted, 0 otherwise. |
deleteId | Text | Nullable | null | |
utcDateModified | Text | Non-null | Modification date in UTC format (e.g. 2023-11-08 16:43:44.204Z) |
| Column Name | Data Type | Nullity | Default value | Description |
|---|---|---|---|---|
id | Integer | Non-null | A sequential numeric index of the entity change. | |
entityName | Text | Non-null | The type of entity being changed (attributes, branches, note_reordering, etc.) | |
entityId | Text | Non-null | The ID of the entity being changed. | |
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. Examples: | |
instanceId | Text | Nullable (*) | The ID of the instance 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) |
| Column Name | Data Type | Nullity | Default value | Description |
|---|---|---|---|---|
etapiTokenId | Text | Non-null | A unique ID of the token (e.g. aHmLr5BywvfJ). | |
name | Text | Non-null | The name of the token, as is set by the user. | |
tokenHash | Text | Non-null | The token itself. | |
utcDateCreated | Text | Non-null | Creation date in UTC format (e.g. 2023-11-08 16:43:44.204Z) | |
utcDateModified | Text | Non-null | Modification date in UTC format (e.g. 2023-11-08 16:43:44.204Z) | |
isDeleted | Integer | Non-null | 0 | 1 if the entity is deleted, 0 otherwise. |
| Column Name | Data Type | Nullity | Default value | Description |
|---|---|---|---|---|
noteId | Text | Non-null | The unique ID of the note (e.g. 2LJrKqIhr0Pe). | |
title | Text | Non-null | "note" | The title of the note, as defined by the user. |
isProtected | Integer | Non-null | 0 | 1 if the entity is protected, 0 otherwise. |
type | Text | Non-null | "text" | The type of note (i.e. text, file, code, relationMap, mermaid, canvas). |
mime | Text | Non-null | "text/html" | The MIME type of the note (e.g. text/html).. Note that it can be an empty string in some circumstances, but not null. |
isDeleted | Integer | Nullable | 0 | 1 if the entity is deleted, 0 otherwise. |
deleteId | Text | Non-null | null | |
dateCreated | Text | Non-null | Localized creation date (e.g. 2023-11-08 18:43:44.204+0200) | |
dateModified | Text | Non-null | Localized modification date (e.g. 2023-11-08 18:43:44.204+0200) | |
utcDateCreated | Text | Non-null | Creation date in UTC format (e.g. 2023-11-08 16:43:44.204Z) | |
utcDateModified | Text | Non-null | Modification date in UTC format (e.g. 2023-11-08 16:43:44.204Z) | |
blobId | Text | Nullable | null | The corresponding ID from blobs. Although it can theoretically be NULL, haven't found any such note yet. |
| Column Name | Data Type | Nullity | Default value | Description |
|---|---|---|---|---|
name | Text | Non-null | The name of option (e.g. maxContentWidth) | |
value | Text | Non-null | The value of the option. | |
isSynced | Integer | Non-null | 0 | 0 if the option is not synchronized and thus can differ between clients, 1 if the option is synchronized. |
utcDateModified | Text | Non-null | Modification date in UTC format (e.g. 2023-11-08 16:43:44.204Z) |
| Column Name | Data Type | Nullity | Default value | Description |
|---|---|---|---|---|
noteId | Text | Non-null | Unique ID of the note (e.g. yRRTLlqTbGoZ). | |
notePath | Text | Non-null | The path (IDs) to the note from root to the note itself, separated by slashes. | |
utcDateCreated | Text | Non-null | Creation date in UTC format (e.g. 2023-11-08 16:43:44.204Z) |
| Column Name | Data Type | Nullity | Default value | Description |
|---|---|---|---|---|
revisionId | TextText | Non-null | Unique ID of the revision (e.g. 0GjgUqnEudI8). | |
noteId | Text | Non-null | ID of the note this revision belongs to. | |
type | Text | Non-null | "" | The type of note (i.e. text, file, code, relationMap, mermaid, canvas). |
mime | Text | Non-null | "" | The MIME type of the note (e.g. text/html). |
title | Text | Non-null | The title of the note, as defined by the user. | |
isProtected | Integer | Non-null | 0 | 1 if the entity is protected, 0 otherwise. |
blobId | Text | Nullable | null | The corresponding ID from blobs. Although it can theoretically be NULL, haven't found any such note yet. |
utcDateLastEdited | Text | Non-null | Not sure how it differs from modification date. | |
utcDateCreated | Text | Non-null | Creation date in UTC format (e.g. 2023-11-08 16:43:44.204Z) | |
utcDateModified | Text | Non-null | Modification date in UTC format (e.g. 2023-11-08 16:43:44.204Z) | |
dateLastEdited | Text | Non-null | Not sure how it differs from modification date. | |
dateCreated | Text | Non-null | Localized creatino date (e.g. 2023-08-12 15:10:04.045+0300) |
| Name | Resolution | Description |
|---|---|---|
icon-black.svg | 53x40 | Used by the global menu button when not hovered. |
icon-color.svg | 53x40 | Used by the global menu when hovered. |
icon-grey.svg | 53x40 | Used by the dark theme, in place of icon-black.svg. |
| Name | Resolution | Description |
|---|---|---|
ios/apple-touch-icon.png | 180x180 | Used as apple-touch-icon, but only in login.ejs and set_password.ejs for some reason. |
mac/icon.icns | 512x512 | Provided as --icon to electron-packager for mac-arm64 and mac-x64 builds. |
png/128x128.png | 128x128 | Used in linux-x64 build, to provide an icon.png. |
png/256x256-dev.png | 256x256 | Used by the Electron window icon, if in dev mode. |
png/256x256.png | Used by the Electron window icon, if not in dev mode. | |
win/icon.ico |
|
|
win/setup-banner.gif | 640x480 | Used by the Squirrel Windows installer during the installation process. Has only one frame. |
| Name | Resolution | Description |
|---|---|---|
ios/apple-touch-icon.png | 180x180 | Used as apple-touch-icon, but only in login.ejs and set_password.ejs for some reason. |
mac/icon.icns | 512x512 | Provided as --icon to electron-packager for mac-arm64 and mac-x64 builds. |
png/128x128.png | 128x128 | Used in linux-x64 build, to provide an icon.png. |
png/256x256-dev.png | 256x256 | Used by the Electron window icon, if in dev mode. |
png/256x256.png | Used by the Electron window icon, if not in dev mode. | |
win/icon.ico |
|
|
win/setup-banner.gif | 640x480 | Used by the Squirrel Windows installer during the installation process. Has only one frame. |
| Before | |
|---|---|
| After | |
| With new scale | |
| 0.9 |  |
|---|---|
| 0.85 |  |
| 0.8 |  |
| 0.75 |  |
The electron.icns from the resulting build | The icon source | ||
|---|---|---|---|
|
| Name | Resolution | Description |
|---|---|---|
icon-black.png | 36x36 | Does not appear to be used. |
icon-color.png | 36x36 | Used only by some tests in test-etapi. |
icon-grey.png | 36x36 | Does not appear to be used. |
icon.svg | 210x297 | Does not appear to be used. |
| 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/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. |
| Note Type | type value | Corresponding MIME type | Content of the note's blob | Relevant attributes | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Text | text | The HTML of the note. | |||||||||||||||||||||||||||||||||||||
| Relation Map | relationMap | application/json | A JSON describing the note: | None | |||||||||||||||||||||||||||||||||||
| Mermaid Diagram | mermaid | text/mermaid or text/plain | The plain text content of the Mermaid diagram. | None | |||||||||||||||||||||||||||||||||||
| Book | book | text/html or blank. | An empty blob. |
both options are shown to the user via the “Book Properties” ribbon widget. | |||||||||||||||||||||||||||||||||||
| Web View | webView | blank | An empty blob. | #webViewSrc pointing to an URL to render. | |||||||||||||||||||||||||||||||||||
| Code | code | Depends on the language (e.g. text/plain, text/x-markdown, text/x-c++src). | The plain text content. |
| 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 | |
| Linux | x86_64 | Desktop / Electron app | ./bin/build-linux-x64.sh |
| Server | ./bin/build-server.sh | ||
| Windows | x86_64 | Desktop / Electron app | ./bin/build-win-x64.sh |
| Desktop client | Server | |||
|---|---|---|---|---|
|
| Dependency | Name in library_loader | Things to check for a basic sanity check | Protected by unit tests | |
|---|---|---|---|---|
better-sqlite3 | See bettersqlite binaries. | |||
jsdom |
| Protected by typings, should catch any potential changes in API. | Yes | |
async-mutex |
| |||
axios |
| |||
sax |
| |||
|
| |||
ejs |
| |||
dayjs |
| |||
semver |
| |||
https-proxy-agent | ??? | |||
sax |
| |||
ini |
| |||
jsplumb | RELATION_MAP |
| ||
jquery.mark.es6 | MARKJS |
| ||
knockout.js |
| |||
normalize.min.css |
| |||
wheel-zoom.min.js | WHEEL_ZOOM |
| ||
fancytree |
| |||
bootstrap |
| |||
electron-debug |
| |||
electron-dl | ||||
eslint | ||||
marked |
| Yes | ||
force-graph |
|
| Dependency | Name in library_loader | Things to check for a basic sanity check | Protected by unit tests | |
|---|---|---|---|---|
better-sqlite3 | See bettersqlite binaries. | |||
jsdom |
| Protected by typings, should catch any potential changes in API. | Yes | |
async-mutex |
| |||
axios |
| |||
sax |
| |||
|
| |||
ejs |
| |||
dayjs |
| |||
semver |
| |||
https-proxy-agent | ??? | |||
sax |
| |||
ini |
| |||
jsplumb | RELATION_MAP |
| ||
jquery.mark.es6 | MARKJS |
| ||
knockout.js |
| |||
normalize.min.css |
| |||
wheel-zoom.min.js | WHEEL_ZOOM |
| ||
fancytree |
| |||
bootstrap |
| |||
electron-debug |
| |||
electron-dl | ||||
eslint | ||||
marked |
| Yes | ||
force-graph |
|
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 | ||
| 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.6.0 | 3.45.3 | v30 | |
| 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 |
better-sqlite3 versionChange log | SQLite version Change log | Compatibility with upstream Trilium |
|---|---|---|
| 8.4.0 | <3.43.0 | Compatible, same version. |
| 8.6.0 | 3.43.0 | |
| 8.7.0 | 3.43.1 | |
| 9.0.0 | 3.43.2 | |
| 9.1.0 + 9.1.1 | 3.44.0 | |
| 9.2.0 + 9.2.1 + 9.2.2 | 3.44.2 | |
| 9.3.0 | 3.45.0 | |
| 9.4.0, 9.4.1, 9.4.2, 9.4.3, 9.4.4, 9.4.5 | 3.45.1 | |
| 9.5.0 | 3.45.2 | |
| 9.6.0 / 10.0.0 | 3.45.3 | |
| 10.1.0 / 11.0.0 / 11.1.1 / 11.1.2 / 11.2.0 / 11.2.1 | 3.46.0 | |
| 11.3.0 | 3.46.1 |
| 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. |
| trilium-ckeditor5 | 43.2.0 | |
ckeditor5-math | See ckeditor5-math. | |
To run the server-side tests: To view the code coverage for the server: Afterwards, a friendly HTML report can be found in | To run the client-side tests: To view the code coverage for the client: Afterwards, a friendly HTML report can be found in |
To run the server-side tests: To view the code coverage for the server: Afterwards, a friendly HTML report can be found in | To run the client-side tests: To view the code coverage for the client: Afterwards, a friendly HTML report can be found in |
| Library | Old version | New version |
|---|---|---|
axios | 1.6.7 | 1.7.2 |
excalidraw | 0.17.3 | 0.17.6 |
katex | 0.16.9 | 0.16.11 |
mermaid | 10.9.0 | 10.9.1 |
react, react-dom | 18.2.0 | 18.3.1 |
| Library | Old version | New version |
|---|---|---|
sanitize-url | 6.0.4 | 7.1.0 |
archiver | 7.0.0 | 7.0.1 |
marked | 12.0.0 | 13.0.2 |
sanitize-html | 1.6.7 | 1.7.2 |
turndown | 7.1.2 | 7.2.0 |
yauzl | 3.1.2 | 3.1.3 |
express | 4.18.3 | 4.19.2 |
express-rate-limit | 7.2.0 | 7.3.1 |
jsdom | 24.0.0 | 24.1.0 |
ws | 8.16.0 | 8.18.0 |
ejs | 3.1.9 | 3.1.10 |
dayjs | 1.11.10 | 1.11.12 |
semver | 7.6.0 | 7.6.3 |
async-mutex | 0.4.1 | 0.5.0 |
https-proxy-agent | 7.0.4 | 7.0.5 |
sax | 1.3.0 | 1.4.1 |
ini | 3.0.1 | 4.1.3 |
debounce | 1.2.1 | 2.1.0 |
| Label | Description |
|---|---|
disableVersioning | Disables automatic creation of Note Revisions for a particular note. Useful for e.g. large, but unimportant notes - e.g. large JS libraries used for scripting. |
versioningLimit | Limits the maximum number of Note Revisions for a particular note, overriding the global settings. |
calendarRoot | Marks the note which should be used as root for Day Notes. Only one should be marked as such. |
archived | Hides notes from default search results and dialogs. Archived notes can optionally be hidden in the Note Tree. |
excludeFromExport | Excludes this note and its children when exporting. |
run, runOnInstance, runAtHour | See Events. |
disableInclusion | Scripts with this label won't be included into parent script execution. |
sorted | Keeps child notes sorted by title alphabetically. When given a value, it will sort by the value of another label instead. If one of the child notes doesn't have the specified label, the title will be used for them instead. |
sortDirection | If
|
sortFoldersFirst | If sorted is applied, folders (notes with children) will be sorted as a group at the top, and the rest will be sorted. |
top | If sorted is applied to the parent note, keeps given note on top in its parent. |
hidePromotedAttributes | Hide Promoted Attributes on this note. Generally useful when defining inherited attributes, but the parent note doesn't need them. |
readOnly | Marks a note to be always be read-only, if it's a supported note (text, code, mermaid). |
autoReadOnlyDisabled | Disables automatic read-only mode for the given note. |
appCss | Marks CSS notes which are loaded into the Trilium application and can thus be used to modify Trilium's looks. See Custom app-wide CSS for more info. |
appTheme | Marks CSS notes which are full Trilium themes and are thus available in Trilium options. See Theme development for more information. |
appThemeBase | Set to next, next-light, or next-dark to use the corresponding TriliumNext theme (auto, light or dark) as the base for a custom theme, instead of the legacy one. See Customize the Next theme for more information. |
cssClass | Value of this label is then added as CSS class to the node representing given note in the Note Tree. This can be useful for advanced theming. Can be used in template notes. |
iconClass | value of this label is added as a CSS class to the icon on the tree which can help visually distinguish the notes in the tree. Example might be bx bx-home - icons are taken from boxicons. Can be used in template notes. |
pageSize | Specifies the number of items per page in Note List. |
customRequestHandler | See Custom Request Handler. |
customResourceProvider | See Custom Resource Providers. |
widget | Marks this note as a custom widget which will be added to the Trilium component tree. See Custom Widgets for more information. |
searchHome | New search notes will be created as children of this note (see Saved Search). |
workspace and related attributes | See Workspaces. |
inbox | default inbox location for new notes - when you create a note using new note button in the sidebar, notes will be created as child notes in the note marked as with #inbox label. |
sqlConsoleHome | Default location of SQL Console notes |
bookmarked | Indicates this note is a bookmark. |
bookmarkFolder | Note with this label will appear in bookmarks as folder (allowing access to its children). See Bookmarks for more information. |
share* | See the attribute reference in Sharing. |
displayRelations, hideRelations | Comma delimited names of relations which should be displayed/hidden in a Relation Map (both the note type and the Note Map (Link map, Tree map) general functionality). |
titleTemplate | Default title of notes created as children of this note. This value is evaluated as a JavaScript string and thus can be enriched with dynamic content via the injected Examples:
See Default Note Title for more info. |
template | This note will appear in the selection of available template when creating new note. See Templates for more information. |
toc | Controls the display of the Table of contents for a given note. #toc or #toc=show to always display the table of contents, #toc=false to always hide it. |
color | defines color of the note in note tree, links etc. Use any valid CSS color value like 'red' or #a13d5f |
keyboardShortcut | Defines a keyboard shortcut which will immediately jump to this note. Example: 'ctrl+alt+e'. Requires frontend reload for the change to take effect. |
keepCurrentHoisting | Opening this link won't change hoisting even if the note is not displayable in the current hoisted subtree. |
executeButton | Title of the button which will execute the current code note |
executeDescription | Longer description of the current code note displayed together with the execute button |
excludeFromNoteMap | Notes with this label will be hidden from the Note Map. |
newNotesOnTop | New notes will be created at the top of the parent note, not on the bottom. |
hideHighlightWidget | Hides the Highlights list widget |
hideChildrenOverview | Hides the Note List for that particular note. |
printLandscape | When exporting to PDF, changes the orientation of the page to landscape instead of portrait. |
printPageSize | When exporting to PDF, changes the size of the page. Supported values: A0, A1, A2, A3, A4, A5, A6, Legal, Letter, Tabloid, Ledger. |
geolocation | Indicates the latitude and longitude of a note, to be displayed in a Geo Map. |
calendar:* | Defines specific options for the Calendar View. |
viewType | Sets the view of child notes (e.g. grid or list). See Note List for more information. |
| Label | Description |
|---|---|
disableVersioning | Disables automatic creation of Note Revisions for a particular note. Useful for e.g. large, but unimportant notes - e.g. large JS libraries used for scripting. |
versioningLimit | Limits the maximum number of Note Revisions for a particular note, overriding the global settings. |
calendarRoot | Marks the note which should be used as root for Day Notes. Only one should be marked as such. |
archived | Hides notes from default search results and dialogs. Archived notes can optionally be hidden in the Note Tree. |
excludeFromExport | Excludes this note and its children when exporting. |
run, runOnInstance, runAtHour | See Events. |
disableInclusion | Scripts with this label won't be included into parent script execution. |
sorted | Keeps child notes sorted by title alphabetically. When given a value, it will sort by the value of another label instead. If one of the child notes doesn't have the specified label, the title will be used for them instead. |
sortDirection | If
|
sortFoldersFirst | If sorted is applied, folders (notes with children) will be sorted as a group at the top, and the rest will be sorted. |
top | If sorted is applied to the parent note, keeps given note on top in its parent. |
hidePromotedAttributes | Hide Promoted Attributes on this note. Generally useful when defining inherited attributes, but the parent note doesn't need them. |
readOnly | Marks a note to be always be read-only, if it's a supported note (text, code, mermaid). |
autoReadOnlyDisabled | Disables automatic read-only mode for the given note. |
appCss | Marks CSS notes which are loaded into the Trilium application and can thus be used to modify Trilium's looks. See Custom app-wide CSS for more info. |
appTheme | Marks CSS notes which are full Trilium themes and are thus available in Trilium options. See Theme development for more information. |
appThemeBase | Set to next, next-light, or next-dark to use the corresponding TriliumNext theme (auto, light or dark) as the base for a custom theme, instead of the legacy one. See Customize the Next theme for more information. |
cssClass | Value of this label is then added as CSS class to the node representing given note in the Note Tree. This can be useful for advanced theming. Can be used in template notes. |
iconClass | value of this label is added as a CSS class to the icon on the tree which can help visually distinguish the notes in the tree. Example might be bx bx-home - icons are taken from boxicons. Can be used in template notes. |
pageSize | Specifies the number of items per page in Note List. |
customRequestHandler | See Custom Request Handler. |
customResourceProvider | See Custom Resource Providers. |
widget | Marks this note as a custom widget which will be added to the Trilium component tree. See Custom Widgets for more information. |
searchHome | New search notes will be created as children of this note (see Saved Search). |
workspace and related attributes | See Workspaces. |
inbox | default inbox location for new notes - when you create a note using new note button in the sidebar, notes will be created as child notes in the note marked as with #inbox label. |
sqlConsoleHome | Default location of SQL Console notes |
bookmarked | Indicates this note is a bookmark. |
bookmarkFolder | Note with this label will appear in bookmarks as folder (allowing access to its children). See Bookmarks for more information. |
share* | See the attribute reference in Sharing. |
displayRelations, hideRelations | Comma delimited names of relations which should be displayed/hidden in a Relation Map (both the note type and the Note Map (Link map, Tree map) general functionality). |
titleTemplate | Default title of notes created as children of this note. This value is evaluated as a JavaScript string and thus can be enriched with dynamic content via the injected Examples:
See Default Note Title for more info. |
template | This note will appear in the selection of available template when creating new note. See Templates for more information. |
toc | Controls the display of the Table of contents for a given note. #toc or #toc=show to always display the table of contents, #toc=false to always hide it. |
color | defines color of the note in note tree, links etc. Use any valid CSS color value like 'red' or #a13d5f |
keyboardShortcut | Defines a keyboard shortcut which will immediately jump to this note. Example: 'ctrl+alt+e'. Requires frontend reload for the change to take effect. |
keepCurrentHoisting | Opening this link won't change hoisting even if the note is not displayable in the current hoisted subtree. |
executeButton | Title of the button which will execute the current code note |
executeDescription | Longer description of the current code note displayed together with the execute button |
excludeFromNoteMap | Notes with this label will be hidden from the Note Map. |
newNotesOnTop | New notes will be created at the top of the parent note, not on the bottom. |
hideHighlightWidget | Hides the Highlights list widget |
hideChildrenOverview | Hides the Note List for that particular note. |
printLandscape | When exporting to PDF, changes the orientation of the page to landscape instead of portrait. |
printPageSize | When exporting to PDF, changes the size of the page. Supported values: A0, A1, A2, A3, A4, A5, A6, Legal, Letter, Tabloid, Ledger. |
geolocation | Indicates the latitude and longitude of a note, to be displayed in a Geo Map. |
calendar:* | Defines specific options for the Calendar View. |
viewType | Sets the view of child notes (e.g. grid or list). See Note List for more information. |
| Label | Description |
|---|---|
runOn* | See Events |
template | note's attributes will be inherited even without a parent-child relationship, note's content and subtree will be added to instance notes if empty. See documentation for details. |
inherit | note's attributes will be inherited even without a parent-child relationship. See Templates for a similar concept. See Attribute Inheritance in the documentation. |
renderNote | notes of type Render Note will be rendered using a code note (HTML or script) and it is necessary to point using this relation to which note should be rendered |
widget_relation | target of this relation will be executed and rendered as a widget in the sidebar |
shareCss | CSS note which will be injected into the share page. CSS note must be in the shared sub-tree as well. Consider using share_hidden_from_tree and share_omit_default_css as well. |
shareJs | JavaScript note which will be injected into the share page. JS note must be in the shared sub-tree as well. Consider using share_hidden_from_tree. |
shareTemplate | Embedded JavaScript note that will be used as the template for displaying the shared note. Falls back to the default template. Consider using share_hidden_from_tree. |
shareFavicon | Favicon note to be set in the shared page. Typically you want to set it to share root and make it inheritable. Favicon note must be in the shared sub-tree as well. Consider using share_hidden_from_tree. |
| CORS Header | Corresponding option in config.ini | Corresponding option in environment variables in the Network section |
|---|---|---|
Access-Control-Allow-Origin | TRILIUM_NETWORK_CORS_ALLOW_ORIGIN | corsAllowOrigin |
Access-Control-Allow-Methods | TRILIUM_NETWORK_CORS_ALLOW_METHODS | corsAllowMethods |
Access-Control-Allow-Headers | TRILIUM_NETWORK_CORS_ALLOW_HEADERS | corsAllowHeaders |
| Note | Description |
|---|---|
| Note Map | This note is actually opened when the Note Map feature that is accessed from the Launch Bar. It is possible to create any child notes in it without any additional meaning. For example, it can be used to store a list of note maps which can be linked to from other notes or bookmarked. |
| SQL Console History | When SQL queries or commands are executed in the SQL Console, they are stored here, grouped by month. Only the query is stored and not the results. This section can be accessed without going to the hidden tree by simply going to the Global menu and selecting Advanced → Open SQL Console History. Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process. |
| Search History | Whenever a search is executed from the full Search, the query will be stored here, grouped by month. Only the search parameters are stored and not the results themselves. This section can be accessed without going to the hidden tree by simply going to the Global menu and selecting Advanced → Open Search History. Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process. |
| Bulk Action | This section is used for Bulk Actions. The last configuration for bulk actions will be stored as part of this note, each action in its own Notes can be added as children of this tree, but there won't be any benefit in doing so. |
| Backend Log | This note corresponds to the backend log feature (see Error logs). This item can be accessed without going to the hidden try by going to the Global menu and selecting Advanced → Show backend log. |
| User Hidden | This section can be used by scripts to create their own notes that should not be directly visible to the user. The note can be identified by scripts by its unique ID: _userHidden |
| Launch Bar Templates | This section contains the templates for the creation of launchers in the Launch Bar. It is not possible to create child notes here. Theoretically some of the notes here can be customized, but there's not much benefit to be had in doing so. |
| Shared Notes | This tree lists all of the notes that are shared publicly. It can be useful to track down which notes are shared regardless of their position in the note tree. This section can be accessed without going to the hidden tree simply by going to the Global menu and selecting Show Shared Notes Subtree. Sub-notes cannot be created here. |
| Launch Bar | The tree contains both available and displayed items of the Launch Bar. This section can be accessed without going to the hidden tree by:
Sub-notes cannot be created here. |
| Options | This section stores the list of Options. This section can be accessed without going to the hidden tree by:
|
| Mobile Launch Bar | This is very similar to the Launch Bar, but is dedicated for the mobile UI only. Accessing it outside the Launch Bar is the same as the Launch Bar, but needs to be done so from the mobile interface. |
| User Guide | This is where the note structure for the User Guide is actually stored. Only the metadata is stored, as the help itself is present as actual files in the application directory. |
| Note | Description |
|---|---|
| Note Map | This note is actually opened when the Note Map feature that is accessed from the Launch Bar. It is possible to create any child notes in it without any additional meaning. For example, it can be used to store a list of note maps which can be linked to from other notes or bookmarked. |
| SQL Console History | When SQL queries or commands are executed in the SQL Console, they are stored here, grouped by month. Only the query is stored and not the results. This section can be accessed without going to the hidden tree by simply going to the Global menu and selecting Advanced → Open SQL Console History. Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process. |
| Search History | Whenever a search is executed from the full Search, the query will be stored here, grouped by month. Only the search parameters are stored and not the results themselves. This section can be accessed without going to the hidden tree by simply going to the Global menu and selecting Advanced → Open Search History. Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process. |
| Bulk Action | This section is used for Bulk Actions. The last configuration for bulk actions will be stored as part of this note, each action in its own Notes can be added as children of this tree, but there won't be any benefit in doing so. |
| Backend Log | This note corresponds to the backend log feature (see Error logs). This item can be accessed without going to the hidden try by going to the Global menu and selecting Advanced → Show backend log. |
| User Hidden | This section can be used by scripts to create their own notes that should not be directly visible to the user. The note can be identified by scripts by its unique ID: _userHidden |
| Launch Bar Templates | This section contains the templates for the creation of launchers in the Launch Bar. It is not possible to create child notes here. Theoretically some of the notes here can be customized, but there's not much benefit to be had in doing so. |
| Shared Notes | This tree lists all of the notes that are shared publicly. It can be useful to track down which notes are shared regardless of their position in the note tree. This section can be accessed without going to the hidden tree simply by going to the Global menu and selecting Show Shared Notes Subtree. Sub-notes cannot be created here. |
| Launch Bar | The tree contains both available and displayed items of the Launch Bar. This section can be accessed without going to the hidden tree by:
Sub-notes cannot be created here. |
| Options | This section stores the list of Options. This section can be accessed without going to the hidden tree by:
|
| Mobile Launch Bar | This is very similar to the Launch Bar, but is dedicated for the mobile UI only. Accessing it outside the Launch Bar is the same as the Launch Bar, but needs to be done so from the mobile interface. |
| User Guide | This is where the note structure for the User Guide is actually stored. Only the metadata is stored, as the help itself is present as actual files in the application directory. |
| Supported features | Limitations | |
|---|---|---|
| Text |
|
|
| Code |
|
|
| Saved Search | Not supported. | |
| Relation Map | Not supported. | |
| Note Map | Not supported. | |
| Render Note | Not supported. | |
| Collections |
|
|
| Mermaid Diagrams |
|
|
| Canvas |
|
|
| Web View | Not supported. | |
| Mind Map | The diagram is displayed as a vector image. |
|
| Geo Map View | Not supported. | |
| File | Basic interaction (downloading the file). |
|
| Supported features | Limitations | |
|---|---|---|
| Text |
|
|
| Code |
|
|
| Saved Search | Not supported. | |
| Relation Map | Not supported. | |
| Note Map | Not supported. | |
| Render Note | Not supported. | |
| Collections |
|
|
| Mermaid Diagrams |
|
|
| Canvas |
|
|
| Web View | Not supported. | |
| Mind Map | The diagram is displayed as a vector image. |
|
| Geo Map View | Not supported. | |
| File | Basic interaction (downloading the file). |
|
| Attribute | Description |
|---|---|
shareHiddenFromTree | this note is hidden from left navigation tree, but still accessible with its URL |
shareExternalLink | note will act as a link to an external website in the share tree |
shareAlias | define an alias using which the note will be available under https://your_trilium_host/share/[your_alias] |
shareOmitDefaultCss | default share page CSS will be omitted. Use when you make extensive styling changes. |
shareRoot | marks note which is served on /share root. |
shareDescription | define text to be added to the HTML meta tag for description |
shareRaw | Note will be served in its raw format, without HTML wrapper. See also Serving directly the content of a note for an alternative method without setting an attribute. |
shareDisallowRobotIndexing | Indicates to web crawlers that the page should not be indexed of this note by:
|
shareCredentials | require credentials to access this shared note. Value is expected to be in format username:password. Don't forget to make this inheritable to apply to child-notes/images. |
shareIndex | Note with this label will list all roots of shared notes. |
| Attribute | Description |
|---|---|
shareHiddenFromTree | this note is hidden from left navigation tree, but still accessible with its URL |
shareExternalLink | note will act as a link to an external website in the share tree |
shareAlias | define an alias using which the note will be available under https://your_trilium_host/share/[your_alias] |
shareOmitDefaultCss | default share page CSS will be omitted. Use when you make extensive styling changes. |
shareRoot | marks note which is served on /share root. |
shareDescription | define text to be added to the HTML meta tag for description |
shareRaw | Note will be served in its raw format, without HTML wrapper. See also Serving directly the content of a note for an alternative method without setting an attribute. |
shareDisallowRobotIndexing | Indicates to web crawlers that the page should not be indexed of this note by:
|
shareCredentials | require credentials to access this shared note. Value is expected to be in format username:password. Don't forget to make this inheritable to apply to child-notes/images. |
shareIndex | Note with this label will list all roots of shared notes. |
| A note displayed as a web page (HTML) | A note displayed as a raw format |
|---|---|
 |  |
| Label | Description |
|---|---|
workspace | Marks this note as a workspace, button to enter the workspace is controlled by this |
workspaceIconClass | defines box icon CSS class which will be used in tab when hoisted to this note |
workspaceTabBackgroundColor | CSS color used in the note tab when hoisted to this note, use any CSS color format, e.g. "lightblue" or "#ddd". See https://www.w3schools.com/cssref/css_colors.asp. |
workspaceCalendarRoot | Marking a note with this label will define a new per-workspace calendar for Day Notes. If there's no such note, the global calendar will be used. |
workspaceTemplate | This note will appear in the selection of available template when creating new note, but only when hoisted into a workspace containing this template |
workspaceSearchHome | new search notes will be created as children of this note when hoisted to some ancestor of this workspace note |
workspaceInbox | default inbox location for new notes when hoisted to some ancestor of this workspace note |
| 1 |  | The Calendar View works only for Collection note types. To create a new note, right click on the note tree on the left and select Insert note after, or Insert child note and then select Collection. |
| 2 |  | Once created, the “View type” of the Collection needs changed to “Calendar”, by selecting the “Collection Properties” tab in the ribbon. |
| Name | Description |
|---|---|
#calendar:hideWeekends | When present (regardless of value), it will hide Saturday and Sundays from the calendar. |
#calendar:weekNumbers | When present (regardless of value), it will show the number of the week on the calendar. |
#calendar:view | Which view to display in the calendar:
Any other value will be dismissed and the default view (month) will be used instead. The value of this label is automatically updated when changing the view using the UI buttons. |
~child:template | Defines the template for newly created notes in the calendar (via dragging or clicking). |
| Name | Description |
|---|---|
#startDate | The date the event starts, which will display it in the calendar. The format is YYYY-MM-DD (year, month and day separated by a minus sign). |
#endDate | Similar to startDate, mentions the end date if the event spans across multiple days. The date is inclusive, so the end day is also considered. The attribute can be missing for single-day events. |
#startTime | The time the event starts at. If this value is missing, then the event is considered a full-day event. The format is HH:MM (hours in 24-hour format and minutes). |
#endTime | Similar to startTime, it mentions the time at which the event ends (in relation with endDate if present, or startDate). |
#color | Displays the event with a specified color (named such as red, gray or hex such as #FF0000). This will also change the color of the note in other places such as the note tree. |
#calendar:color | Similar to #color, but applies the color only for the event in the calendar and not for other places such as the note tree. |
#iconClass | If present, the icon of the note will be displayed to the left of the event title. |
#calendar:title | Changes the title of an event to point to an attribute of the note other than the title, can either a label or a relation (without the # or ~ symbol). See Use-cases for more information. |
#calendar:displayedAttributes | Allows displaying the value of one or more attributes in the calendar like this:  #weight="70" #Mood="Good" #calendar:displayedAttributes="weight,Mood" It can also be used with relations, case in which it will display the title of the target note: ~assignee=@My assignee #calendar:displayedAttributes="assignee" |
#calendar:startDate | Allows using a different label to represent the start date, other than startDate (e.g. expiryDate). The label name must not be prefixed with #. If the label is not defined for a note, the default will be used instead. |
#calendar:endDate | Similar to #calendar:startDate, allows changing the attribute which is being used to read the end date. |
#calendar:startTime | Similar to #calendar:startDate, allows changing the attribute which is being used to read the start time. |
#calendar:endTime | Similar to #calendar:startDate, allows changing the attribute which is being used to read the end time. |
-
-### Using a different attribute as event title
-
-By default, events are displayed on the calendar by their note title. However, it is possible to configure a different attribute to be displayed instead.
-
-To do so, assign `#calendar:title` to the child note (not the calendar/Collection note), with the value being `name` where `name` can be any label (make not to add the `#` prefix). The attribute can also come through inheritance such as a template attribute. If the note does not have the requested label, the title of the note will be used instead.
-
- |
 |
|  |
|  |
| 1 |  | Right click on any note on the note tree and select Insert child note → Geo Map (beta). |
| 2 |  | By default the map will be empty and will show the entire world. |
| 1 | To create a marker, first navigate to the desired point on the map. Then press the  button in the Floating buttons (top-right) area. If the button is not visible, make sure the button section is visible by pressing the chevron button (  ) in the top-right of the map. | |
| 2 |  | Once pressed, the map will enter in the insert mode, as illustrated by the notification. Simply click the point on the map where to place the marker, or the Escape key to cancel. |
| 3 |  | Enter the name of the marker/note to be created. |
| 4 |  | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. |
-
-This value can be added manually if needed. The value of the attribute is made up of the latitude and longitude separated by a comma.
-
-## Repositioning markers
-
-It's possible to reposition existing markers by simply drag and dropping them to the new destination.
-
-As soon as the mouse is released, the new position is saved.
-
-If moved by mistake, there is currently no way to undo the change. If the mouse was not yet released, it's possible to force a refresh of the page (Ctrl+R ) to cancel it.
-
-## Interaction with the markers
-
-* Hovering over a marker will display a Note Tooltip with the content of the note it belongs to.
- * Clicking on the note title in the tooltip will navigate to the note in the current view.
-* Middle-clicking the marker will open the note in a new tab.
-* Right-clicking the marker will open a contextual menu (as described below).
-* If the map is in read-only mode, clicking on a marker will open a Quick edit popup for the corresponding note.
-
-## Contextual menu
-
-It's possible to press the right mouse button to display a contextual menu.
-
-1. If right-clicking an empty section of the map (not on a marker), it allows to:
- 1. Displays the latitude and longitude. Clicking this option will copy them to the clipboard.
- 2. Open the location using an external application (if the operating system supports it).
- 3. Adding a new marker at that location.
-2. If right-clicking on a marker, it allows to:
- 1. Displays the latitude and longitude. Clicking this option will copy them to the clipboard.
- 2. Open the location using an external application (if the operating system supports it).
- 3. Open the note in a new tab, split or window.
- 4. Remove the marker from the map, which will remove the `#geolocation` attribute of the note. To add it back again, the coordinates have to be manually added back in.
-
-## Icon and color of the markers
-
-
| 1 |  | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up. Simply click on the first item displaying the coordinates and they will be copied to clipboard. Then paste the value inside the text box into the #geolocation attribute of a child note of the map (don't forget to surround the value with a " character). |
| 2 |  | In Trilium, create a child note under the map. |
| 3 |  | And then go to Owned Attributes and type #geolocation=", then paste from the clipboard as-is and then add the ending " character. Press Enter to confirm and the map should now be updated to contain the new note. |
| 1 |  | Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item. |
| 2 |  | The address will be visible in the top-left of the screen, in the place of the search bar. Select the coordinates and copy them into the clipboard. |
| 3 |  | Simply paste the value inside the text box into the #geolocation attribute of a child note of the map and then it should be displayed on the map. |
| 1 |  | To add a track, simply drag & drop a .gpx file inside the geo map in the note tree. |
| 2 |  | In order for the file to be recognized as a GPS track, it needs to show up as application/gpx+xml in the File type field. |
| 3 |  | When going back to the map, the track should now be visible. The start and end points of the track are indicated by the two blue markers. |
| Note Type | Description |
|---|---|
| Text | The default note type, which allows for rich text formatting, images, admonitions and right-to-left support. |
| Code | Uses a mono-space font and can be used to store larger chunks of code or plain text than a text note, and has better syntax highlighting. |
| Saved Search | Stores the information about a search (the search text, criteria, etc.) for later use. Can be used for quick filtering of a large amount of notes, for example. The search can easily be triggered. |
| Relation Map | Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree. |
| Note Map | Displays the relationships between the notes, whether via relations or their hierarchical structure. |
| Render Note | Used in Scripting, it displays the HTML content of another note. This allows displaying any kind of content, provided there is a script behind it to generate it. |
| Collections | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar. Generally useful for easy reading of short notes. |
| Mermaid Diagrams | Displays diagrams such as bar charts, flow charts, state diagrams, etc. Requires a bit of technical knowledge since the diagrams are written in a specialized format. |
| Canvas | Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind excalidraw.com. |
| Web View | Displays the content of an external web page, similar to a browser. |
| Mind Map | Easy for brainstorming ideas, by placing them in a hierarchical layout. |
| Geo Map View | Displays the children of the note as a geographical map, one use-case would be to plan vacations. It even has basic support for tracks. Notes can also be created from it. |
| File | Represents an uploaded file such as PDFs, images, video or audio files. |
| Name | Description |
|---|---|
#calendar:hideWeekends | When present (regardless of value), it will hide Saturday and Sundays from the calendar. |
#calendar:weekNumbers | When present (regardless of value), it will show the number of the week on the calendar. |
#calendar:view | Which view to display in the calendar:
Any other value will be dismissed and the default view (month) will be used instead. The value of this label is automatically updated when changing the view using the UI buttons. |
~child:template | Defines the template for newly created notes in the calendar (via dragging or clicking). |
+
+### Using a different attribute as event title
+
+By default, events are displayed on the calendar by their note title. However, it is possible to configure a different attribute to be displayed instead.
+
+To do so, assign `#calendar:title` to the child note (not the calendar/Collection note), with the value being `name` where `name` can be any label (make not to add the `#` prefix). The attribute can also come through inheritance such as a template attribute. If the note does not have the requested label, the title of the note will be used instead.
+
+ |
|
| |
| |
| Once pressed, the map will enter in the insert mode, as illustrated by the notification. | Enter the name of the marker/note to be created. |
+| 4 | | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. |
+
+### Adding a new note using the contextual menu
+
+1. Right click anywhere on the map, where to place the newly created marker (and corresponding note).
+2. Select _Add a marker at this location_.
+3. Enter the name of the newly created note.
+4. The map should be updated with the new marker.
+
+### Adding an existing note on note from the note tree
+
+1. Select the desired note in the Note Tree.
+2. Hold the mouse on the note and drag it to the map to the desired location.
+3. The map should be updated with the new marker.
+
+This works for:
+
+* Notes that are not part of the geo map, case in which a [clone](../../Basic%20Concepts%20and%20Features/Notes/Cloning%20Notes.md) will be created.
+* Notes that are a child of the geo map but not yet positioned on the map.
+* Notes that are a child of the geo map and also positioned, case in which the marker will be relocated to the new position.
+
+## How the location of the markers is stored
+
+The location of a marker is stored in the `#geolocation` attribute of the child notes:
+
+
+
+This value can be added manually if needed. The value of the attribute is made up of the latitude and longitude separated by a comma.
+
+## Repositioning markers
+
+It's possible to reposition existing markers by simply drag and dropping them to the new destination.
+
+As soon as the mouse is released, the new position is saved.
+
+If moved by mistake, there is currently no way to undo the change. If the mouse was not yet released, it's possible to force a refresh of the page (Ctrl+R ) to cancel it.
+
+## Interaction with the markers
+
+* Hovering over a marker will display a Note Tooltip with the content of the note it belongs to.
+ * Clicking on the note title in the tooltip will navigate to the note in the current view.
+* Middle-clicking the marker will open the note in a new tab.
+* Right-clicking the marker will open a contextual menu (as described below).
+* If the map is in read-only mode, clicking on a marker will open a Quick edit popup for the corresponding note.
+
+## Contextual menu
+
+It's possible to press the right mouse button to display a contextual menu.
+
+1. If right-clicking an empty section of the map (not on a marker), it allows to:
+ 1. Displays the latitude and longitude. Clicking this option will copy them to the clipboard.
+ 2. Open the location using an external application (if the operating system supports it).
+ 3. Adding a new marker at that location.
+2. If right-clicking on a marker, it allows to:
+ 1. Displays the latitude and longitude. Clicking this option will copy them to the clipboard.
+ 2. Open the location using an external application (if the operating system supports it).
+ 3. Open the note in a new tab, split or window.
+ 4. Remove the marker from the map, which will remove the `#geolocation` attribute of the note. To add it back again, the coordinates have to be manually added back in.
+
+## Icon and color of the markers
+
+ | Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item. |
+| 2 | | The address will be visible in the top-left of the screen, in the place of the search bar. | Simply paste the value inside the text box into the `#geolocation` attribute of a child note of the map and then it should be displayed on the map. |
+
+## Adding GPS tracks (.gpx)
+
+Trilium has basic support for displaying GPS tracks on the geo map.
+
+| | | |
+| --- | --- | --- |
+| 1 | 
| Dedicated article | Feature |
|---|---|
| General formatting |
|
| Lists |
|
| Block quotes & admonitions |
|
| Tables |
|
| Developer-specific formatting |
|
| Footnotes |
|
| Images |
|
| Links |
|
| Include Note |
|
| Insert buttons |
|
| Other features |
|
| Premium features |
| Dedicated article | Feature |
|---|---|
| General formatting |
|
| Lists |
|
| Block quotes & admonitions |
|
| Tables |
|
| Developer-specific formatting |
|
| Footnotes |
|
| Images |
|
| Links |
|
| Include Note |
|
| Insert buttons |
|
| Other features |
|
| Premium features |
| Icon | Option | Preview | Description |
|---|---|---|---|
 | Inline |  | As the name suggests, the name can be put inside a paragraph and moved around similarly as if it was a block of text. Use drag & drop or cut-paste to move it around. |
 | Centered image |  | The image will be displayed as a block and centered, not allowing text in either the left or right of it. |
 | Wrap text |  | The image will be displayed to the left or the right of the text. |
 | Block align |  | Similarly to Centered image, the image will be displayed as a block and aligned either to the left or to the right, but not allowing text to flow on either of its sides. |
| Action | PC | Mac |
|---|---|---|
| Bring up inline formatting toolbar (arrow keys ←,→ to navigate, Enter to apply) | Alt+F10 | ⌥+F10 |
| Bring up block formatting toolbar | Alt+F10 | ⌥+F10 |
| Create external link | Ctrl+K | ⌘+K |
| Create internal (note) link | Ctrl+L | ⌘+L |
| Inserts current date and time at caret position | Alt+T | ⌥+T |
| Increase paragraph indentation | Tab | ⇥ |
| Decrease paragraph indentation | Shift + Tab | ⇧ + ⇥ |
| Mark selected text as keyboard shortcut | Ctrl + Alt + K | ⌘+ ⌥+ K |
| Insert Math Equations | Ctrl + M | ⌘+ M |
| Move blocks (lists, paragraphs, etc.) up | Ctrl+↑ | ⌘+↑ |
| Alt+↑ | ⌥+↑ | |
| Move blocks (lists, paragraphs, etc.) down | Ctrl+↑ | ⌘+↑ |
| Alt+↓ | ⌥+↓ |
| Action | PC | Mac |
|---|---|---|
| Insert a hard break (a new paragraph) | Enter | |
Insert a soft break (a <br> element) | Shift+Enter | ⇧Enter |
| Copy selected content | Ctrl+C | ⌘C |
| Paste content | Ctrl+V | ⌘V |
| Paste content as plain text | Ctrl+Shift+V | ⌘⇧V |
| Undo | Ctrl+Z | ⌘Z |
| Redo | Ctrl+Y, Ctrl+Shift+Z | ⌘Y, ⌘⇧Z |
| Bold text | Ctrl+B | ⌘B |
| Change text case | Shift+F3 | ⇧F3 (may require Fn) |
| Create link | Ctrl+K | ⌘K |
| Move out of a link | ←←, →→ | |
| Move out of an inline code style | ←←, →→ | |
| Select all | Ctrl+A | ⌘A |
| Find in the document | Ctrl+F | ⌘F |
| Copy text formatting | Ctrl+Shift+C | ⌘⇧C |
| Paste text formatting | Ctrl+Shift+V | ⌘⇧V |
| Italic text | Ctrl+I | ⌘I |
| Strikethrough text | Ctrl+Shift+X | ⌘⇧X |
| Underline text | Ctrl+U | ⌘U |
| Revert autoformatting action | Backspace |
| Action | PC | Mac |
|---|---|---|
| Insert a new paragraph directly after a widget | Enter | |
| Insert a new paragraph directly before a widget | Shift+Enter | ⇧Enter |
| Move the caret to allow typing directly before a widget | ↑, ← | |
| Move the caret to allow typing directly after a widget | ↓, → | |
| After entering a nested editable, move the selection to the closest ancestor widget. For example: move from an image caption to the whole image widget. | Tab then Esc |
| Action | PC | Mac |
|---|---|---|
| Increase list item indent | ⇥ | |
| Decrease list item indent | Shift+⇥ | ⇧⇥ |
| Action | PC | Mac |
|---|---|---|
| Move the selection to the next cell | ⇥ | |
| Move the selection to the previous cell | Shift+⇥ | ⇧⇥ |
| Insert a new table row (when in the last cell of a table) | ⇥ | |
| Navigate through the table | ↑, →, ↓, ← |
| Action | PC | Mac |
|---|---|---|
| Close contextual balloons, dropdowns, and dialogs | Esc | |
| Open the accessibility help dialog | Alt+0 | ⌥0 |
| Move focus between form fields (inputs, buttons, etc.) | ⇥, Shift+⇥ | ⇥, ⇧⇥ |
| Move focus to the toolbar, navigate between toolbars | Alt+F10 | ⌥F10 (may require Fn) |
| Navigate through the toolbar or menu bar | ↑, →, ↓, ← | |
| Navigate to the next focusable field or an element outside the editor | Tab, Shift+Tab | |
| Execute the currently focused button. Executing buttons that interact with the editor content moves the focus back to the content. | Enter, Space | |
| Move focus in and out of an active dialog window | Ctrl+F6 | ⌘F6 (may require Fn) |
| 1 |  | First, create a list. |
|---|---|---|
| 2 |  | Press Enter to create a new list item. |
| 3 |  | Press Backspace to get rid of the bullet point. Notice the cursor position. |
| 4 |  | At this point, insert any desired block-level item such as a code block. |
| 5 |  | To continue with a new bullet point, press Enter until the cursor moves to a new blank position. |
| 6 |  | Press Enter once more to create the new bullet. |
| At this point, insert any desired block-level item such as a code block. |
+| 5 | | To continue with a new bullet point, press Enter until the cursor moves to a new blank position. |
+| 6 | | Press Enter once more to create the new bullet. |
The same principle applies to all three list types (bullet, numbered and to-do).
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Scripting/Events.md b/docs/User Guide/User Guide/Scripting/Events.md
index 06638c558..6dbeeeba6 100644
--- a/docs/User Guide/User Guide/Scripting/Events.md
+++ b/docs/User Guide/User Guide/Scripting/Events.md
@@ -5,10 +5,22 @@
Global events are attached to the script note via label. Simply create e.g. "run" label with some of these values and script note will be executed once the event occurs.
-| Label | Description |
|---|---|
run | Defines on which events script should run. Possible values are:
|
runOnInstance | Specifies that the script should only run on a particular Trilium instance. |
runAtHour | On which hour should this run. Should be used together with #run=hourly. Can be defined multiple times for more runs during the day. |
| Label | Description |
|---|---|
run | Defines on which events script should run. Possible values are:
|
runOnInstance | Specifies that the script should only run on a particular Trilium instance. |
runAtHour | On which hour should this run. Should be used together with #run=hourly. Can be defined multiple times for more runs during the day. |
| Relation | Description |
|---|---|
runOnNoteCreation | executes when note is created on backend. Use this relation if you want to run the script for all notes created under a specific subtree. In that case, create it on the subtree root note and make it inheritable. A new note created within the subtree (any depth) will trigger the script. |
runOnChildNoteCreation | executes when new note is created under the note where this relation is defined |
runOnNoteTitleChange | executes when note title is changed (includes note creation as well) |
runOnNoteContentChange | executes when note content is changed (includes note creation as well). |
runOnNoteChange | executes when note is changed (includes note creation as well). Does not include content changes |
runOnNoteDeletion | executes when note is being deleted |
runOnBranchCreation | executes when a branch is created. Branch is a link between parent note and child note and is created e.g. when cloning or moving note. |
runOnBranchChange | executes when a branch is updated. (since v0.62) |
runOnBranchDeletion | executes when a branch is deleted. Branch is a link between parent note and child note and is deleted e.g. when moving note (old branch/link is deleted). |
runOnAttributeCreation | executes when new attribute is created for the note which defines this relation |
runOnAttributeChange | executes when the attribute is changed of a note which defines this relation. This is triggered also when the attribute is deleted |