();
useEffect(() => {
link.createLink(stringifiedNotePath, {
@@ -30,7 +32,7 @@ export default function NoteLink({ className, notePath, showNotePath, showNoteIc
showNoteIcon,
viewScope
}).then(setJqueryEl);
- }, [ stringifiedNotePath, showNotePath, title, viewScope ]);
+ }, [ stringifiedNotePath, showNotePath, title, viewScope, noteTitle ]);
useEffect(() => {
if (!ref.current || !jqueryEl) return;
@@ -38,6 +40,16 @@ export default function NoteLink({ className, notePath, showNotePath, showNoteIc
highlightSearch(ref.current);
}, [ jqueryEl, highlightedTokens ]);
+ useTriliumEvent("entitiesReloaded", ({ loadResults }) => {
+ // React to note title changes, but only if the title is not overwritten.
+ if (!title && noteId) {
+ const entityRow = loadResults.getEntityRow("notes", noteId);
+ if (entityRow) {
+ setNoteTitle(entityRow.title);
+ }
+ }
+ });
+
if (style) {
jqueryEl?.css(style);
}
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html
index d46a3e51c..3825c8af8 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html
@@ -5,14 +5,14 @@
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
+ 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
+ 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
+ Promoted attributes are attributes which
- are considered important and thus are "promoted" onto the main note UI.
- See example below:
-
-
-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:
+
+ 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:
+
+ Go to a note.
+ Go to Owned Attributes in the Ribbon .
+ Press the + button.
+ 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:
#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 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.
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png
index ecb5f2d6d..148f98b8a 100644
Binary files a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_promot.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_promot.png
deleted file mode 100644
index cca868320..000000000
Binary files a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_promot.png and /dev/null differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/1_Kanban Board_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/1_Kanban Board_image.png
new file mode 100644
index 000000000..1ccb0a3cc
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/1_Kanban Board_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/2_Kanban Board_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/2_Kanban Board_image.png
new file mode 100644
index 000000000..be4b027d2
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/2_Kanban Board_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html
index 23245ddd1..58f9014d1 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html
@@ -1,8 +1,11 @@
- Starting with Trilium v0.97.0, the geo map has been converted from a standalone
+
Attributes
note type to a type of view for the Note List .
+ class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted AttributesAttributes Starting
+ with Trilium v0.97.0, the geo map has been converted from a standalone
+ note type to a type of view for the Note List .
Creating a new geo map
-
-
-
-
-
-
-
- 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
+
+
+
+
+ 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.
+
+
+
+
Repositioning the map
- Click and drag the map in order to move across the map.
- Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons
+ Click and drag the map in order to move across the map.
+ Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons
on the top-left to adjust the zoom.
The position on the map and the zoom are saved inside the map note and
restored when visiting again the note.
Adding a marker using the map
Adding a new note using the plus button
-
-
-
-
-
-
-
- 1
- To create a marker, first navigate to the desired point on the map. Then
- press the
- Floating buttons (top-right)
- area.
-
-
-
- 2
-
-
- Once pressed, the map will enter in the insert mode, as illustrated by
- the notification.
-
-
-
- 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.
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+ 1
+ To create a marker, first navigate to the desired point on the map. Then
+ press the
+ Floating buttons (top-right)
+ area.
+
+
+
+
+ 2
+
+
+ Once pressed, the map will enter in the insert mode, as illustrated by
+ the notification.
+
+
+
+ 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.
+
+
+
+
Adding a new note using the contextual menu
- Right click anywhere on the map, where to place the newly created marker
+ Right click anywhere on the map, where to place the newly created marker
(and corresponding note).
- Select Add a marker at this location .
- Enter the name of the newly created note.
- The map should be updated with the new marker.
+ Select Add a marker at this location .
+ Enter the name of the neNote Tree wly
+ created note.
+ The map should be updated with the new marker.
Adding an existing note on note from the note tree
- Select the desired note in the Note Tree .
- Hold the mouse on the note and drag it to the map to the desired location.
- The map should be updated with the new marker.
+ Select the desired note in the Note Tree .
+ Hold the mouse on the note and drag it to the map to the desired location.
+ 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 will
+ Notes that are not part of the geo map, case in which a clone 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
+ 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.
@@ -136,8 +145,10 @@
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
@@ -149,16 +160,17 @@ width="1288" height="278">
page (Ctrl +R ) to cancel it.
Interaction with the markers
- Hovering over a marker will display a Note Tooltip with
+ 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
+ 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
+ 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.
@@ -166,24 +178,24 @@ width="1288" height="278">
It's possible to press the right mouse button to display a contextual
menu.
- If right-clicking an empty section of the map (not on a marker), it allows
+ If right-clicking an empty section of the map (not on a marker), it allows
to:
- Displays the latitude and longitude. Clicking this option will copy them
+ Displays the latitude and longitude. Clicking this option will copy them
to the clipboard.
- Open the location using an external application (if the operating system
+ Open the location using an external application (if the operating system
supports it).
- Adding a new marker at that location.
+ Adding a new marker at that location.
- If right-clicking on a marker, it allows to:
+ If right-clicking on a marker, it allows to:
- Displays the latitude and longitude. Clicking this option will copy them
+ Displays the latitude and longitude. Clicking this option will copy them
to the clipboard.
- Open the location using an external application (if the operating system
+ Open the location using an external application (if the operating system
supports it).
- Open the note in a new tab, split or window.
- Remove the marker from the map, which will remove the #geolocation attribute
+ Open the note in a new tab, split or window.
+ 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.
@@ -203,209 +215,215 @@ width="1288" height="278">
The value of the attribute is made up of the latitude and longitude separated
by a comma.
Adding from Google Maps
-
-
-
-
-
-
-
- 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.
- #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 Google Maps on the web and look for a desired location, right click
+ on it and a context menu will show up.
+ #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.
+
+
+
+
Adding from OpenStreetMap
Similarly to the Google Maps approach:
-
-
-
-
-
-
-
- 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.
-
-
-
- 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
+
+
+ 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.
+
+
+
+ 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.
+
+
+
+
Adding GPS tracks (.gpx)
Trilium has basic support for displaying GPS tracks on the geo 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 starting point of the track will be displayed as a marker, with the
- name of the note underneath. The start marker will also respect the icon
- and the color of the note. The end marker is displayed with
- a distinct icon.
- If the GPX contains waypoints, they will also be displayed. If they have
- a name, it is displayed when hovering over it with the mouse.
-
-Read-only mode
-When a map is in read-only all editing features will be disabled such
- as:
-
- The add button in the Floating buttons .
- Dragging markers.
- Editing from the contextual menu (removing locations or adding new items).
-
-To enable read-only mode simply press the Lock icon from the
- Floating buttons . To disable it, press the button again.
-Configuration
-Map Style
-The styling of the map can be adjusted in the Collection Properties tab
- in the Ribbon or
- manually via the #map:style attribute.
-The geo map comes with two different types of styles:
-
- Raster styles
-
- For these styles the map is represented as a grid of images at different
- zoom levels. This is the traditional way OpenStreetMap used to work.
- Zoom is slightly restricted.
- Currently, the only raster theme is the original OpenStreetMap style.
+
+
+
+
+
+
+
+
+
+
+
+ 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 starting point of the track will be displayed as a marker, with the
+ name of the note underneath. The start marker will also respect the icon
+ and the color of the note. The end marker is displayed with
+ a distinct icon.
+ If the GPX contains waypoints, they will also be displayed. If they have
+ a name, it is displayed when hovering over it with the mouse.
+
+ Read-only mode
+ When a map is in read-only all editing features will be disabled such
+ as:
+
+ The add button in the Floating buttons .
+ Dragging markers.
+ Editing from the contextual menu (removing locations or adding new items).
+
+ To enable read-only mode simply press the Lock icon from the
+ Floating buttons . To disable it, press the button again.
+ Configuration
+ Map Style
+ The styling of the map can be adjusted in the Collection Properties tab
+ in the Ribbon or
+ manually via the #map:style attribute.
+ The geo map comes with two different types of styles:
+
+ Raster styles
+
+ For these styles the map is represented as a grid of images at different
+ zoom levels. This is the traditional way OpenStreetMap used to work.
+ Zoom is slightly restricted.
+ Currently, the only raster theme is the original OpenStreetMap style.
-
- Vector styles
-
- Vector styles are not represented as images, but as geometrical shapes.
- This makes the rendering much smoother, especially when zooming and looking
- at the building edges, for example.
- The map can be zoomed in much further.
- These come both in a light and a dark version.
- The vector styles come from VersaTiles ,
- a free and open-source project providing map tiles based on OpenStreetMap.
-
-
-
-
-Scale
-Activating this option via the Ribbon or
- manually via #map:scale will display an indicator in the bottom-left
- of the scale of the map.
-Troubleshooting
-
-
-
-Grid-like artifacts on the map
-This occurs if the application is not at 100% zoom which causes the pixels
- of the map to not render correctly due to fractional scaling. The only
- possible solution is to set the UI zoom at 100% (default keyboard shortcut
- is Ctrl +0 ).
\ No newline at end of file
+
+ Vector styles
+
+ Vector styles are not represented as images, but as geometrical shapes.
+ This makes the rendering much smoother, especially when zooming and looking
+ at the building edges, for example.
+ The map can be zoomed in much further.
+ These come both in a light and a dark version.
+ The vector styles come from VersaTiles ,
+ a free and open-source project providing map tiles based on OpenStreetMap.
+
+
+
+
+ Scale
+ Activating this option via the Ribbon or
+ manually via #map:scale will display an indicator in the bottom-left
+ of the scale of the map.
+ Troubleshooting
+
+
+ Grid-like artifacts on the map
+ This occurs if the application is not at 100% zoom which causes the pixels
+ of the map to not render correctly due to fractional scaling. The only
+ possible solution is to set the UI zoom at 100% (default keyboard shortcut
+ is Ctrl +0 ).
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board.html
index e4a92ba49..30dc5340c 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board.html
@@ -1,5 +1,5 @@
-
The Board view presents sub-notes in columns for a Kanban-like experience.
@@ -15,83 +15,168 @@
Interaction
Working with columns
- Create a new column by pressing Add Column near the last column.
+ Create a new column by pressing Add Column near the last column.
- Once pressed, a text box will be displayed to set the name of the column.
+ Once pressed, a text box will be displayed to set the name of the column.
Press Enter to confirm, or Escape to dismiss.
- To reorder a column, simply hold the mouse over the title and drag it
+ To reorder a column, simply hold the mouse over the title and drag it
to the desired position.
- To delete a column, right click on its title and select Delete column .
- To rename a column, click on the note title.
+ To delete a column, right click on its title and select Delete column .
+ To rename a column, click on the note title.
- Press Enter to confirm.
- Upon renaming a column, the corresponding status attribute of all its
+ Press Enter to confirm.
+ Upon renaming a column, the corresponding status attribute of all its
notes will be changed in bulk.
-
- If there are many columns, use the mouse wheel to scroll.
+
+ If there are many columns, use the mouse wheel to scroll.
Working with notes
- Create a new note in any column by pressing New item
+ Create a new note in any column by pressing New item
- Enter the name of the note and press Enter or click away. To
+ Enter the name of the note and press Enter or click away. To
dismiss the creation of a new note, simply press Escape or leave
the name empty.
- Once created, the new note will have an attribute (status label
+ Once created, the new note will have an attribute (status label
by default) set to the name of the column.
- To open the note, simply click on it.
- To change the title of the note directly from the board, hover the mouse
+ To open the note, simply click on it.
+ To change the title of the note directly from the board, hover the mouse
over its card and press the edit button on the right.
- To change the state of a note, simply drag a note from one column to the
+ To change the state of a note, simply drag a note from one column to the
other to change its state.
- The order of the notes in each column corresponds to their position in
+ The order of the notes in each column corresponds to their position in
the tree.
- It's possible to reorder notes simply by dragging them to the desired
+ It's possible to reorder notes simply by dragging them to the desired
position within the same columns.
- It's also possible to drag notes across columns, at the desired position.
+ It's also possible to drag notes across columns, at the desired position.
- For more options, right click on a note to display a context menu with
+ For more options, right click on a note to display a context menu with
the following options:
- Open the note in a new tab/split/window or quick edit.
- Move the note to any column.
- Insert a new note above/below the current one.
- Archive/unarchive the current note.
- Delete the current note.
+ Open the note in a new tab/split/window or quick edit.
+ Move the note to any column.
+ Insert a new note above/below the current one.
+ Archive/unarchive the current note.
+ Delete the current note.
- If there are many notes within the column, move the mouse over the column
+ If there are many notes within the column, move the mouse over the column
and use the mouse wheel to scroll.
-Keyboard interaction
+Working with the note tree
+It's also possible to add items on the board using the Note Tree .
+
+ Select the desired note in the Note Tree .
+ Hold the mouse on the note and drag it to the to the desired column.
+
+This works for:
+
+ Notes that are not children of the board, case in which a clone will
+ be created.
+ Notes that are children of the board, but not yet assigned on the board.
+ Notes that are children of the board, case in which they will be moved
+ to the new column.
+
+Keyboard interaction
The board view has mild support for keyboard-based navigation:
- Use Tab and Shift +Tab to navigate between
+ Use Tab and Shift +Tab to navigate between
column titles, notes and the “New item” button for each of the columns,
in sequential order.
- To rename a column or a note, press F2 while it is focused.
- To open a specific note or create a new item, press Enter while
+ To rename a column or a note, press F2 while it is focused.
+ To open a specific note or create a new item, press Enter while
it is focused.
- To dismiss a rename of a note or a column, press Escape .
+ To dismiss a rename of a note or a column, press Escape .
Configuration
-Grouping by another attribute
+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
- the value being the attribute to use (without # attribute prefix).
-
- It's currently not possible to set a relation as the grouping criteria.
- There are plans to add support for it.
-
- Limitations
-
- It is not possible yet to use group by a relation, only by label.
-
\ No newline at end of file
+ the value being the attribute to use (with or without # attribute
+ prefix).
+Grouping by relations
+
+
+A more advanced use-case is grouping by Relations .
+During this mode:
+
+ The columns represent the target notes of a relation.
+ When creating a new column, a note is selected instead of a column name.
+ The column icon will match the target note.
+ Moving notes between columns will change its relation.
+ Renaming an existing column will change the target note of all the notes
+ in that column.
+
+Using relations instead of labels has some benefits:
+
+ The status/grouping of the notes is visible outside the Kanban board,
+ for example on the Note Map .
+ Columns can have icons.
+ Renaming columns is less intensive since it simply involves changing the
+ note title of the target note instead of having to do a bulk rename.
+
+To do so:
+
+ First, create a Kanban board from scratch and not a template:
+ Assign #viewType=board #hidePromotedAttributes to emulate the
+ default template.
+ Set #board:groupBy to the name of a relation to group by, including the ~ prefix (e.g. ~status).
+
+ Optionally, use Promoted Attributes for
+ easy status change within the note:
#relation:status(inheritable)="promoted,alias=Status,single"
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board_image.png
index be4b027d2..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/Developer Guide/!!!meta.json b/docs/Developer Guide/!!!meta.json
index 5d95a894c..cdf47264f 100644
--- a/docs/Developer Guide/!!!meta.json
+++ b/docs/Developer Guide/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.99.4",
+ "appVersion": "0.99.5",
"files": [
{
"isClone": false,
@@ -110,6 +110,13 @@
"type": "text",
"mime": "text/html",
"attributes": [
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "4nwtTJyjNDKd",
+ "isInheritable": false,
+ "position": 10
+ },
{
"type": "label",
"name": "iconClass",
@@ -117,13 +124,6 @@
"isInheritable": false,
"position": 20
},
- {
- "type": "relation",
- "name": "internalLink",
- "value": "4nwtTJyjNDKd",
- "isInheritable": false,
- "position": 30
- },
{
"type": "label",
"name": "shareAlias",
@@ -1263,10 +1263,17 @@
{
"type": "relation",
"name": "internalLink",
- "value": "zdQzavvHDl1k",
+ "value": "ccIoz7nqgDRK",
"isInheritable": false,
"position": 10
},
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "zdQzavvHDl1k",
+ "isInheritable": false,
+ "position": 20
+ },
{
"type": "label",
"name": "iconClass",
@@ -1280,13 +1287,6 @@
"value": "releasing",
"isInheritable": false,
"position": 40
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "ccIoz7nqgDRK",
- "isInheritable": false,
- "position": 50
}
],
"format": "markdown",
diff --git a/docs/Developer Guide/Developer Guide/Documentation.md b/docs/Developer Guide/Developer Guide/Documentation.md
index 63cfdc33e..5f9f17e5f 100644
--- a/docs/Developer Guide/Developer Guide/Documentation.md
+++ b/docs/Developer Guide/Developer Guide/Documentation.md
@@ -1,5 +1,5 @@
# Documentation
-There are multiple types of documentation for Trilium:F1 .
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
diff --git a/docs/Release Notes/!!!meta.json b/docs/Release Notes/!!!meta.json
index c2c0b02ba..a2210f04e 100644
--- a/docs/Release Notes/!!!meta.json
+++ b/docs/Release Notes/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.99.4",
+ "appVersion": "0.99.5",
"files": [
{
"isClone": false,
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index bb262ac18..f859cd689 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.99.4",
+ "appVersion": "0.99.5",
"files": [
{
"isClone": false,
@@ -9884,18 +9884,69 @@
"value": "kanban-board",
"isInheritable": false,
"position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "Cq5X6iKQop6R",
+ "isInheritable": false,
+ "position": 30
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "OFXdgB2nNk1F",
+ "isInheritable": false,
+ "position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "bdUJEHsAPYQR",
+ "isInheritable": false,
+ "position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "oPVyFC7WL2Lp",
+ "isInheritable": false,
+ "position": 60
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "IakOLONlIfGI",
+ "isInheritable": false,
+ "position": 70
}
],
"format": "markdown",
"dataFileName": "Kanban Board.md",
"attachments": [
{
- "attachmentId": "usSSa0WI6dDK",
+ "attachmentId": "3ze7RpkjIWdW",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Kanban Board_image.png"
+ },
+ {
+ "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"
}
]
},
@@ -9983,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",
@@ -11206,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",
@@ -11670,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:
+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.
+
+| | |
+| --- | --- |
+| 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
new file mode 100644
index 000000000..1ccb0a3cc
Binary files /dev/null and b/docs/User Guide/User Guide/Collections/1_Kanban Board_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/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 7cd6cc34a..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 .
+> Attributes Promoted Attributes Attributes 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 .
Note Tree wly created note.
4. The map should be updated with the new marker.
### Adding an existing note on note from the note tree
@@ -109,7 +109,7 @@ The value of the attribute is made up of the latitude and longitude separated by
| | | |
| --- | --- | --- |
-| 1 | Note Tree .
+
+1. Select the desired note in the Note Tree .
+2. Hold the mouse on the note and drag it to the to the desired column.
+
+This works for:
+
+* Notes that are not children of the board, case in which a [clone](../Basic%20Concepts%20and%20Features/Notes/Cloning%20Notes.md) will be created.
+* Notes that are children of the board, but not yet assigned on the board.
+* Notes that are children of the board, case in which they will be moved to the new column.
+
+### Keyboard interaction
The board view has mild support for keyboard-based navigation:
@@ -52,13 +65,60 @@ The board view has mild support for keyboard-based navigation:
## Configuration
-### Grouping by another attribute
+### Displaying custom attributes
-By default, the label used to group the notes is `#status`. It is possible to use a different label if needed by defining a label named `#board:groupBy` with the value being the attribute to use (without `#` attribute prefix).
+Promoted Attributes ). The easiest way to add these is:
-* It is not possible yet to use group by a relation, only by label.
\ No newline at end of file
+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
+
+Note Map .
+* Columns can have icons.
+* Renaming columns is less intensive since it simply involves changing the note title of the target note instead of having to do a bulk rename.
+
+To do so:
+
+1. First, create a Kanban board from scratch and not a template:
+2. Assign `#viewType=board #hidePromotedAttributes` to emulate the default template.
+3. Set `#board:groupBy` to the name of a relation to group by, **including the** `**~**` **prefix** (e.g. `~status`).
+4. Optionally, use Promoted Attributes for easy status change within the note:
+
+ ```
+ #relation:status(inheritable)="promoted,alias=Status,single"
+ ```
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Collections/Kanban Board_image.png b/docs/User Guide/User Guide/Collections/Kanban Board_image.png
index be4b027d2..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
+
-
+
+ 
+ 
- 
- 
button in the Floating buttons (top-right)
- area.
- 
) in the top-right of the map.
- 
- 
-