In Trilium, attributes are key-value pairs assigned to notes, providing
additional metadata or functionality. There are two primary types of attributes:
-
+
Labels can
be used for a variety of purposes, such as storing metadata or configuring
the behavior of notes. Labels are also searchable, enhancing note retrieval.
For more information, including predefined labels, see Labels.
-
+
Relations define
connections between notes, similar to links. These can be used for metadata
and scripting purposes.
@@ -23,6 +23,30 @@
These attributes play a crucial role in organizing, categorizing, and
enhancing the functionality of notes.
+
Types of attributes
+
Conceptually there are two types of attributes (applying to both labels
+ and relations):
+
+
System attributes
+ As the name suggest, these attributes have a special meaning since they
+ are interpreted by Trilium. For example the color attribute
+ will change the color of the note as displayed in the Note Tree and
+ links, and iconClass will change the icon of a note.
+
+
User-defined attributes
+ These are free-form labels or relations that can be used by the user.
+ They can be used purely for categorization purposes (especially if combined
+ with Search),
+ or they can be given meaning through the use of Scripting.
+
+
In practice, Trilium makes no direct distinction of whether an attribute
+ is a system one or a user-defined one. A label or relation is considered
+ a system attribute if it matches one of the built-in names (e.g. like the
+ aforementioned iconClass). Keep this in mind when creating
+ Promoted Attributes in
+ order not to accidentally alter a system attribute (unless intended).
Viewing the list of attributes
Both the labels and relations for the current note are displayed in the Owned Attributes section
of the Ribbon,
@@ -31,13 +55,15 @@
only be viewed.
In the list of attributes, labels are prefixed with the # character
whereas relations are prefixed with the ~ character.
+
Attribute Definitions and Promoted Attributes
+
Promoted Attributes create
+ a form-like editing experience for attributes, which makes it easy to enhancing
+ the organization and management of attributes
Multiplicity
Attributes in Trilium can be "multi-valued", meaning multiple attributes
- with the same name can co-exist.
-
Attribute Definitions and Promoted Attributes
-
Special labels create "label/attribute" definitions, enhancing the organization
- and management of attributes. For more details, see Promoted Attributes.
+ with the same name can co-exist. This can be combined with Promoted Attributes to
+ easily add them.
Attribute Inheritance
Trilium supports attribute inheritance, allowing child notes to inherit
attributes from their parents. For more information, see
+
+
You can see the note having kind of form with several fields. Each of
- these is just regular attribute, the only difference is that they appear
- on the note itself.
+ are displayed prominently in the UI which allow them to be easily viewed
+ and edited.
+
One way of seeing promoted attributes is as a kind of form with several
+ fields. Each field is just regular attribute, the only difference is that
+ they appear on the note itself.
Attributes can be pretty useful since they allow for querying and script
automation etc. but they are also inconveniently hidden. This allows you
to select few of the important ones and push them to the front of the user.
-
Now, how do we make attribute to appear on the UI?
Attribute definition
-
Attribute is always name-value pair where both name and value are strings.
-
Attribute definition specifies how should this value be interpreted
- - is it just string, or is it a date? Should we allow multiple values or
- note? And importantly, should we promote the attribute or not?
-
-
-
-
You can notice tag attribute definition. These "definition" attributes
- define how the "value" attributes should behave.
+
In order to have promoted attributes, there needs to be a way to define
+ them.
+
+
+
+
Technically, attributes are only name-value pairs where both name and
+ value are strings.
+
The Attribute definition specifies how should this value be interpreted:
Select either Add new label definition or Add new relation definition.
+
Select the name which will be name of the label or relation that will
+ be created when the promoted attribute is edited.
+
Ensure Promoted is checked in order to display it at the top of
+ notes.
+
Optionally, choose an Alias which will be displayed next to the
+ promoted attribute instead of the attribute name. Generally it's best to
+ choose a “user-friendly” name since it can contain spaces and other characters
+ which are not supported as attribute names.
+
Check Inheritable to apply it to this note and all its descendants.
+ To keep it only for the current note, un-check it.
+
Press “Save & Close” to apply the changes.
+
+
How attribute definitions actually work
+
When a new promoted attribute definition is created, it creates a corresponding
+ label prefixed with either label or relation, depending
+ on the definition type:
The only purpose of the attribute definition is to set up a template.
+ If the attribute was marked as promoted, then it's also displayed to the
+ user for easy editing.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Notice how the promoted attribute definition only creates a “Due date”
+ box above the text content.
+
+
+
+
+
+
+
+
Once a value is set by the user, a new label (or relation, depending on
+ the type) is created. The name of the attribute matches one set when creating
+ the promoted attribute.
+
+
+
+
So there's one attribute for value and one for definition. But notice
- how definition attribute is Inheritable,
- meaning that it's also applied to all descendant note. So in a way, this
- definition is used for the whole subtree while "value" attributes are applied
- only for this note.
+ how an definition attribute can be made Inheritable,
+ meaning that it's also applied to all descendant notes. In this case, the
+ definition used for the whole sub-tree while "value" attributes are for
+ each not individually.
+
Using system attributes
+
It's possible to create promoted attributes out of system attributes,
+ to be able to easily alter them.
+
Here are a few practical examples:
+
+
Collections already
+ make use of this practice, for example:
+
+
Calendars add “Start Date”, “End Date”, “Start Time” and “End Time” as
+ promoted attributes. These map to system attributes such as startDate which
+ are then interpreted by the calendar view.
+
Presentation adds
+ a “Background” promoted attribute for each of the slide to easily be able
+ to customize.
+
+
+
The Trilium documentation (which is edited in Trilium) uses a promoted
+ attribute to be able to easily edit the #shareAlias (see
+ Sharing) in order to form clean URLs.
+
If you always edit a particular system attribute such as #color,
+ simply create a promoted attribute for it to make it easier.
+
Inverse relation
Some relations always occur in pairs - my favorite example is on the family.
If you have a note representing husband and note representing wife, then
@@ -33,7 +120,7 @@
This is bidirectional relationship - meaning that if a relation is pointing
from husband to wife then there should be always another relation pointing
from wife to husband.
-
Another example is with parent - child relationship. Again these always
+
Another example is with parent-child relationship. Again these always
occur in pairs, but in this case it's not exact same relation - the one
going from parent to child might be called isParentOf and the
other one going from child to parent might be called isChildOf.
The Board view presents sub-notes in columns for a Kanban-like experience.
@@ -101,6 +101,42 @@
To dismiss a rename of a note or a column, press Escape.
Configuration
+
Displaying custom attributes
+
+
+
+
Note attributes can be displayed on the board to enhance it with custom
+ information such as adding a Due date for your tasks.
+
This feature works exclusively via attribute definitions (Promoted Attributes). The easiest
+ way to add these is:
+
+
Go to board note.
+
In the ribbon select Owned Attributes → plus button → Add new label/relation definition.
+
Configure the attribute as desired.
+
Check Inheritable to make it applicable to child notes automatically.
+
+
After creating the attribute, click on a note and fill in the promoted
+ attributes which should then reflect inside the board.
+
Of note:
+
+
Both promoted and non-promoted attribute definitions are supported. The
+ only difference is that non-promoted attributes don't have an “Alias” for
+ assigning a custom name.
+
Both “Single value” and “Multi value” attributes are supported. In case
+ of multi-value, a badge is displayed for every instance of the attribute.
+
All label types are supported, including dates, booleans and URLs.
+
Relation attributes are also supported as well, showing a link with the
+ target note title and icon.
+
Currently, it's not possible to adjust which promoted attributes are displayed,
+ since all promoted attributes will be displayed (except the board:groupBy one).
+ There are plans to improve upon this being able to hide promoted attributes
+ individually.
+
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
@@ -108,7 +144,7 @@
prefix).
Grouping by relations
-
A more advanced use-case is grouping by Relations.
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 1ccb0a3cc..d2160e6b2 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/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index 20905d931..f859cd689 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -9925,7 +9925,7 @@
"dataFileName": "Kanban Board.md",
"attachments": [
{
- "attachmentId": "IrIeh59VGjHq",
+ "attachmentId": "3ze7RpkjIWdW",
"title": "image.png",
"role": "image",
"mime": "image/png",
@@ -9933,12 +9933,20 @@
"dataFileName": "Kanban Board_image.png"
},
{
- "attachmentId": "usSSa0WI6dDK",
+ "attachmentId": "IrIeh59VGjHq",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "1_Kanban Board_image.png"
+ },
+ {
+ "attachmentId": "usSSa0WI6dDK",
+ "title": "image.png",
+ "role": "image",
+ "mime": "image/png",
+ "position": 10,
+ "dataFileName": "2_Kanban Board_image.png"
}
]
},
@@ -10026,6 +10034,20 @@
"value": "geomap",
"isInheritable": false,
"position": 90
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "zEY4DaJG4YT5",
+ "isInheritable": false,
+ "position": 100
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "OFXdgB2nNk1F",
+ "isInheritable": false,
+ "position": 110
}
],
"format": "markdown",
@@ -11249,6 +11271,27 @@
"value": "bx bx-list-check",
"isInheritable": false,
"position": 110
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "oPVyFC7WL2Lp",
+ "isInheritable": false,
+ "position": 120
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "eIg8jdvaoNNd",
+ "isInheritable": false,
+ "position": 130
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "CdNpE2pqjmI6",
+ "isInheritable": false,
+ "position": 140
}
],
"format": "markdown",
@@ -11713,27 +11756,71 @@
"name": "iconClass",
"value": "bx bx-table",
"isInheritable": false,
- "position": 40
+ "position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "BlN9DFI679QC",
+ "isInheritable": false,
+ "position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "GTwFsgaA0lCt",
+ "isInheritable": false,
+ "position": 60
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "zP3PMqaG71Ct",
+ "isInheritable": false,
+ "position": 70
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "R9pX4DGra2Vt",
+ "isInheritable": false,
+ "position": 80
}
],
"format": "markdown",
"dataFileName": "Promoted Attributes.md",
"attachments": [
{
- "attachmentId": "4EcBRWF9iCk2",
+ "attachmentId": "8ue55DaAJ82K",
"title": "image.png",
"role": "image",
- "mime": "image/jpg",
+ "mime": "image/png",
"position": 10,
"dataFileName": "Promoted Attributes_image.png"
},
{
- "attachmentId": "Txf5Jdm2vqt2",
- "title": "promoted-attributes.png",
+ "attachmentId": "bLMPNRtMAaKo",
+ "title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "Promoted Attributes_promot.png"
+ "dataFileName": "1_Promoted Attributes_image.png"
+ },
+ {
+ "attachmentId": "FbNQB8xcY0Nu",
+ "title": "image.png",
+ "role": "image",
+ "mime": "image/png",
+ "position": 10,
+ "dataFileName": "2_Promoted Attributes_image.png"
+ },
+ {
+ "attachmentId": "yBIe1DyxuL2e",
+ "title": "image.png",
+ "role": "image",
+ "mime": "image/png",
+ "position": 10,
+ "dataFileName": "3_Promoted Attributes_image.png"
}
]
}
diff --git a/docs/User Guide/User Guide/Advanced Usage/Attributes.md b/docs/User Guide/User Guide/Advanced Usage/Attributes.md
index 89d397e33..22ca0c33f 100644
--- a/docs/User Guide/User Guide/Advanced Usage/Attributes.md
+++ b/docs/User Guide/User Guide/Advanced Usage/Attributes.md
@@ -12,19 +12,30 @@ In Trilium, attributes are key-value pairs assigned to notes, providing addition
These attributes play a crucial role in organizing, categorizing, and enhancing the functionality of notes.
+## Types of attributes
+
+Conceptually there are two types of attributes (applying to both labels and relations):
+
+1. **System attributes**
+ As the name suggest, these attributes have a special meaning since they are interpreted by Trilium. For example the `color` attribute will change the color of the note as displayed in the Note Tree and links, and `iconClass` will change the icon of a note.
+2. **User-defined attributes**
+ These are free-form labels or relations that can be used by the user. They can be used purely for categorization purposes (especially if combined with Search), or they can be given meaning through the use of Scripting.
+
+In practice, Trilium makes no direct distinction of whether an attribute is a system one or a user-defined one. A label or relation is considered a system attribute if it matches one of the built-in names (e.g. like the aforementioned `iconClass`). Keep this in mind when creating Promoted Attributes in order not to accidentally alter a system attribute (unless intended).
+
## Viewing the list of attributes
Both the labels and relations for the current note are displayed in the _Owned Attributes_ section of the Ribbon, where they can be viewed and edited. Inherited attributes are displayed in the _Inherited Attributes_ section of the ribbon, where they can only be viewed.
In the list of attributes, labels are prefixed with the `#` character whereas relations are prefixed with the `~` character.
-## Multiplicity
-
-Attributes in Trilium can be "multi-valued", meaning multiple attributes with the same name can co-exist.
-
## Attribute Definitions and Promoted Attributes
-Special labels create "label/attribute" definitions, enhancing the organization and management of attributes. For more details, see Promoted Attributes.
+Promoted Attributes create a form-like editing experience for attributes, which makes it easy to enhancing the organization and management of attributes
+
+## Multiplicity
+
+Attributes in Trilium can be "multi-valued", meaning multiple attributes with the same name can co-exist. This can be combined with Promoted Attributes to easily add them.
## Attribute Inheritance
diff --git a/docs/User Guide/User Guide/Advanced Usage/Attributes/1_Promoted Attributes_image.png b/docs/User Guide/User Guide/Advanced Usage/Attributes/1_Promoted Attributes_image.png
new file mode 100644
index 000000000..64863ded0
Binary files /dev/null and b/docs/User Guide/User Guide/Advanced Usage/Attributes/1_Promoted Attributes_image.png differ
diff --git a/docs/User Guide/User Guide/Advanced Usage/Attributes/2_Promoted Attributes_image.png b/docs/User Guide/User Guide/Advanced Usage/Attributes/2_Promoted Attributes_image.png
new file mode 100644
index 000000000..c7510ca73
Binary files /dev/null and b/docs/User Guide/User Guide/Advanced Usage/Attributes/2_Promoted Attributes_image.png differ
diff --git a/docs/User Guide/User Guide/Advanced Usage/Attributes/3_Promoted Attributes_image.png b/docs/User Guide/User Guide/Advanced Usage/Attributes/3_Promoted Attributes_image.png
new file mode 100644
index 000000000..f71526395
Binary files /dev/null and b/docs/User Guide/User Guide/Advanced Usage/Attributes/3_Promoted Attributes_image.png differ
diff --git a/docs/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.md b/docs/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.md
index dab0a8086..4a1794556 100644
--- a/docs/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.md
+++ b/docs/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.md
@@ -1,31 +1,74 @@
# Promoted Attributes
-Promoted attributes are [attributes](../Attributes.md) which are considered important and thus are "promoted" onto the main note UI. See example below:
+
-
+Promoted attributes are [attributes](../Attributes.md) which are displayed prominently in the UI which allow them to be easily viewed and edited.
-You can see the note having kind of form with several fields. Each of these is just regular attribute, the only difference is that they appear on the note itself.
+One way of seeing promoted attributes is as a kind of form with several fields. Each field is just regular attribute, the only difference is that they appear on the note itself.
Attributes can be pretty useful since they allow for querying and script automation etc. but they are also inconveniently hidden. This allows you to select few of the important ones and push them to the front of the user.
-Now, how do we make attribute to appear on the UI?
-
## Attribute definition
-Attribute is always name-value pair where both name and value are strings.
+In order to have promoted attributes, there needs to be a way to define them.
-_Attribute definition_ specifies how should this value be interpreted - is it just string, or is it a date? Should we allow multiple values or note? And importantly, should we _promote_ the attribute or not?
+
-
+Technically, attributes are only name-value pairs where both name and value are strings.
-You can notice tag attribute definition. These "definition" attributes define how the "value" attributes should behave.
+The _Attribute definition_ specifies how should this value be interpreted:
-So there's one attribute for value and one for definition. But notice how definition attribute is [Inheritable](Attribute%20Inheritance.md), meaning that it's also applied to all descendant note. So in a way, this definition is used for the whole subtree while "value" attributes are applied only for this note.
+* Is it just string, or is it a date?
+* Should we allow multiple values or note?
+* Should we _promote_ the attribute or not?
+
+## Creating a new promoted attribute definition
+
+To create a new promoted attribute:
+
+1. Go to a note.
+2. Go to _Owned Attributes_ in the Ribbon.
+3. Press the + button.
+4. Select either _Add new label definition_ or _Add new relation definition_.
+5. Select the name which will be name of the label or relation that will be created when the promoted attribute is edited.
+6. Ensure _Promoted_ is checked in order to display it at the top of notes.
+7. Optionally, choose an _Alias_ which will be displayed next to the promoted attribute instead of the attribute name. Generally it's best to choose a “user-friendly” name since it can contain spaces and other characters which are not supported as attribute names.
+8. Check _Inheritable_ to apply it to this note and all its descendants. To keep it only for the current note, un-check it.
+9. Press “Save & Close” to apply the changes.
+
+## How attribute definitions actually work
+
+When a new promoted attribute definition is created, it creates a corresponding label prefixed with either `label` or `relation`, depending on the definition type:
+
+```
+#label:myColor(inheritable)="promoted,alias=Color,multi,color"
+```
+
+The only purpose of the attribute definition is to set up a template. If the attribute was marked as promoted, then it's also displayed to the user for easy editing.
+
+| | |
+| --- | --- |
+| | Notice how the promoted attribute definition only creates a “Due date” box above the text content. |
+| | Once a value is set by the user, a new label (or relation, depending on the type) is created. The name of the attribute matches one set when creating the promoted attribute. |
+
+So there's one attribute for value and one for definition. But notice how an definition attribute can be made [Inheritable](Attribute%20Inheritance.md), meaning that it's also applied to all descendant notes. In this case, the definition used for the whole sub-tree while "value" attributes are for each not individually.
+
+## Using system attributes
+
+It's possible to create promoted attributes out of system attributes, to be able to easily alter them.
+
+Here are a few practical examples:
+
+* Collections already make use of this practice, for example:
+ * Calendars add “Start Date”, “End Date”, “Start Time” and “End Time” as promoted attributes. These map to system attributes such as `startDate` which are then interpreted by the calendar view.
+ * Presentation adds a “Background” promoted attribute for each of the slide to easily be able to customize.
+* The Trilium documentation (which is edited in Trilium) uses a promoted attribute to be able to easily edit the `#shareAlias` (see Sharing) in order to form clean URLs.
+* If you always edit a particular system attribute such as `#color`, simply create a promoted attribute for it to make it easier.
### Inverse relation
Some relations always occur in pairs - my favorite example is on the family. If you have a note representing husband and note representing wife, then there might be a relation between those two of `isPartnerOf`. This is bidirectional relationship - meaning that if a relation is pointing from husband to wife then there should be always another relation pointing from wife to husband.
-Another example is with parent - child relationship. Again these always occur in pairs, but in this case it's not exact same relation - the one going from parent to child might be called `isParentOf` and the other one going from child to parent might be called `isChildOf`.
+Another example is with parent-child relationship. Again these always occur in pairs, but in this case it's not exact same relation - the one going from parent to child might be called `isParentOf` and the other one going from child to parent might be called `isChildOf`.
Relation definition allows you to specify such "inverse relation" - for the relation you just define you specify which is the inverse relation. Note that in the second example we should have two relation definitions - one for `isParentOf` which defines `isChildOf` as inverse relation and then second relation definition for `isChildOf` which defines `isParentOf` as inverse relation.
diff --git a/docs/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png b/docs/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png
index ecb5f2d6d..148f98b8a 100644
Binary files a/docs/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png and b/docs/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png differ
diff --git a/docs/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_promot.png b/docs/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_promot.png
deleted file mode 100644
index cca868320..000000000
Binary files a/docs/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_promot.png and /dev/null differ
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
index be4b027d2..1ccb0a3cc 100644
Binary files a/docs/User Guide/User Guide/Collections/1_Kanban Board_image.png and b/docs/User Guide/User Guide/Collections/1_Kanban Board_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/2_Kanban Board_image.png b/docs/User Guide/User Guide/Collections/2_Kanban Board_image.png
new file mode 100644
index 000000000..be4b027d2
Binary files /dev/null and b/docs/User Guide/User Guide/Collections/2_Kanban Board_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/Geo Map.md b/docs/User Guide/User Guide/Collections/Geo Map.md
index 03d4a2d31..bc9432666 100644
--- a/docs/User Guide/User Guide/Collections/Geo Map.md
+++ b/docs/User Guide/User Guide/Collections/Geo Map.md
@@ -1,6 +1,6 @@
# Geo Map
> [!IMPORTANT]
-> Starting with Trilium v0.97.0, the geo map has been converted from a standalone [note type](../Note%20Types.md) to a type of view for the Note List.
+> AttributesPromoted AttributesAttributesStarting with Trilium v0.97.0, the geo map has been converted from a standalone [note type](../Note%20Types.md) to a type of view for the Note List.
diff --git a/docs/User Guide/User Guide/Collections/Kanban Board.md b/docs/User Guide/User Guide/Collections/Kanban Board.md
index 9317ac933..dce70cef7 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.
@@ -65,13 +65,36 @@ The board view has mild support for keyboard-based navigation:
## Configuration
+### Displaying custom attributes
+
+
+
+Note attributes can be displayed on the board to enhance it with custom information such as adding a Due date for your tasks.
+
+This feature works exclusively via attribute definitions (Promoted Attributes). The easiest way to add these is:
+
+1. Go to board note.
+2. In the ribbon select _Owned Attributes_ → plus button → _Add new label/relation definition_.
+3. Configure the attribute as desired.
+4. Check _Inheritable_ to make it applicable to child notes automatically.
+
+After creating the attribute, click on a note and fill in the promoted attributes which should then reflect inside the board.
+
+Of note:
+
+* Both promoted and non-promoted attribute definitions are supported. The only difference is that non-promoted attributes don't have an “Alias” for assigning a custom name.
+* Both “Single value” and “Multi value” attributes are supported. In case of multi-value, a badge is displayed for every instance of the attribute.
+* All label types are supported, including dates, booleans and URLs.
+* Relation attributes are also supported as well, showing a link with the target note title and icon.
+* Currently, it's not possible to adjust which promoted attributes are displayed, since all promoted attributes will be displayed (except the `board:groupBy` one). There are plans to improve upon this being able to hide promoted attributes individually.
+
### 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 (with or without `#` attribute prefix).
### Grouping by relations
-
+
A more advanced use-case is grouping by [Relations](../Advanced%20Usage/Attributes/Relations.md).
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 1ccb0a3cc..d2160e6b2 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
+
-
+
+ 
+ 
- 
+