Merge branch 'develop' into deps_express5

Author: pano9000

docs/User Guide/!!!meta.json

@@ -15,7 +15,7 @@ New tasks are created in the TODO note which has `~child:template` [relation](..
 
 ### Attributes
 
-Task template defines several [promoted attributes](../Attributes/Promoted%20Attributes.md) - todoDate, doneDate, tags, location. Importantly it also defines `~runOnAttributeChange` relation - [event](../../Note%20Types/Code/Events.md) handler which is run on attribute change. This [script](../../Scripting.md) handles when e.g. we fill out the doneDate attribute - meaning the task is done and should be moved to "Done" note and removed from TODO, locations and tags.
+Task template defines several [promoted attributes](../Attributes/Promoted%20Attributes.md) - todoDate, doneDate, tags, location. Importantly it also defines `~runOnAttributeChange` relation - [event](../../Scripting/Events.md) handler which is run on attribute change. This [script](../../Scripting.md) handles when e.g. we fill out the doneDate attribute - meaning the task is done and should be moved to "Done" note and removed from TODO, locations and tags.
 
 ### New task button
 

docs/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.md

@@ -1,7 +1,7 @@
 # Weight Tracker
 ![](Weight%20Tracker_image.png)
 
-The `Weight Tracker` is a [Script API](../../Note%20Types/Code/Script%20API.md) showcase present in the [demo notes](../Database.md).
+The `Weight Tracker` is a [Script API](../../Scripting/Script%20API.md) showcase present in the [demo notes](../Database.md).
 
 By adding `weight` as a [promoted attribute](../Attributes/Promoted%20Attributes.md) in the [template](../Templates.md) from which [day notes](Day%20Notes.md) are created, you can aggregate the data and plot weight change over time.
 

docs/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.md

@@ -1,77 +1,28 @@
 # Attributes
+<figure class="image"><img style="aspect-ratio:1071/146;" src="Attributes_image.png" width="1071" height="146"></figure>
+
 In Trilium, attributes are key-value pairs assigned to notes, providing additional metadata or functionality. There are two primary types of attributes:
 
-1.  **Labels**: Simple key-value text records
-2.  **Relations**: Named links to other notes
+1.  <a class="reference-link" href="Attributes/Labels.md">Labels</a> can be used for a variety of purposes, such as storing metadata or configuring the behaviour of notes. Labels are also searchable, enhancing note retrieval.
+    
+    For more information, including predefined labels, see <a class="reference-link" href="Attributes/Labels.md">Labels</a>.
+    
+2.  <a class="reference-link" href="Attributes/Relations.md">Relations</a> define connections between notes, similar to links. These can be used for metadata and scripting purposes.
+    
+    For more information, including a list of predefined relations, see <a class="reference-link" href="Attributes/Relations.md">Relations</a>.
+    
 
 These attributes play a crucial role in organizing, categorising, and enhancing the functionality of notes.
 
-![](Attributes_image.png)
-
-## Labels
-
-Labels in Trilium can be used for a variety of purposes:
-
-*   **Metadata**: Assign labels with optional values for categorization, such as `#year=1999`, `#genre="sci-fi"`, or `#author="Neal Stephenson"`
-*   **Configuration**: Labels can configure advanced features or settings
-*   **Scripts and Plugins**: Used to tag notes with special metadata, such as the "weight" attribute in the <a class="reference-link" href="Advanced%20Showcases/Weight%20Tracker.md">Weight Tracker</a>.
-
-Labels are also searchable, enhancing note retrieval.
-
-### Common Labels for Advanced Configuration
-
-*   `disableVersioning`: Disables automatic versioning, ideal for large, unimportant notes like script libraries
-*   `versioningLimit`: Used to limit the number of revisions for a single note
-*   `calendarRoot`: Marks the note as the root for [day notes](Advanced%20Showcases/Day%20Notes.md). Only one note should carry this label
-*   `archived`: Hides notes from default search results and dialogs
-*   `excludeFromExport`: Excludes notes and their subtrees from export operations
-*   `run`: Specifies events to trigger scripts (e.g., `frontendStartup`, `hourly`)
-*   `runAtHour`: Defines specific hours for scripts to run, used with `#run=hourly`
-*   `disableInclusion`: Prevents a script from being included in parent script executions
-*   `sorted`: Automatically sorts child notes alphabetically by title
-*   `top`: Keeps the note at the top of its parent's list, useful with `sorted`
-*   `hidePromotedAttributes`: Hides certain attributes in the note's display
-*   `readOnly`: Sets the note to read-only mode, applicable to text and code notes
-*   `autoReadOnlyDisabled`: Disables automatic read-only mode for large notes
-*   `appCss`: Marks CSS notes used to modify Trilium’s appearance
-*   `appTheme`: Marks full CSS themes available in Trilium's options
-*   `cssClass`: Adds a CSS class to the note's representation in the tree
-*   `iconClass`: Adds a CSS class to the note's icon, useful for distinguishing notes visually. See <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20Icons.md">Note Icons</a>.
-*   `pageSize`: Specifies the number of items per page in note listings
-*   `customRequestHandler` **and** `customResourceProvider`: Refer to <a class="reference-link" href="Custom%20Request%20Handler.md">Custom Request Handler</a>
-*   `widget`: Marks a note as a custom widget, added to Trilium's component tree
-*   `workspace` **and related attributes**: See <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Workspace.md">Workspace</a> for more details
-*   `searchHome`: Specifies the parent for new search notes
-*   `inbox`: Designates a default location for new notes created via the sidebar
-*   `sqlConsoleHome`: Default location for SQL console notes
-*   `bookmarked` **and** `bookmarkFolder`: See <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Bookmarks.md">Bookmarks</a>
-*   `share:[…]`: See <a class="reference-link" href="Sharing.md">Sharing</a>
-*   `keyboardShortcut`: Assigns a keyboard shortcut to open the note
-*   `displayRelations` **and** `hideRelations`: Manages the display of note relations
-*   `titleTemplate`: See <a class="reference-link" href="Default%20Note%20Title.md">Default Note Title</a>
-*   `template`: Makes the note available as a template
-*   `toc`: Controls the visibility of the table of contents
-*   `color`: Defines the color of the note in the tree and links
-*   `hideChildrenOverview`: Hides child notes in the parent note's editor
-*   `viewType`: Sets the view of child notes (grid or list)
-
-## Relations
-
-Relations define connections between notes, similar to links.
-
-### Uses
-
-*   **Metadata Relationships**: For example, linking a book note to an author note
-*   **Scripting**: Attaching scripts to events or conditions related to the note
+## Viewing the list of attributes
 
-### Common Relations
+Both the labels and relations for the current note are displayed in the _Owned Attributes_ section of the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>, 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.
 
-*   **Event-based Relations**: Such as `runOnNoteCreation` or `runOnNoteChange`, which trigger scripts on specific actions
-*   **Other Relations**: Include `template`, `renderNote`, `widget`, and sharing-related relations
+In the list of attributes, labels are prefixed with the `#` character whereas relations are prefixed with the `~` character.
 
 ## Multiplicity
 
-Attributes in Trilium can be "multivalued", meaning multiple attributes with the same name can coexist.
+Attributes in Trilium can be "multi-valued", meaning multiple attributes with the same name can co-exist.
 
 ## Attribute Definitions and Promoted Attributes
 

docs/User Guide/User Guide/Advanced Usage/Attributes.md

@@ -1,25 +1,38 @@
 # Attribute Inheritance
-## 1\. Standard Inheritance
+Inheritance refers to the process of having a [label](Labels.md) or a [relation](Relations.md) shared across multiple notes, generally in parent-child relations (or anywhere if using templates).
+
+## Standard Inheritance
 
 In Trilium, attributes can be automatically inherited by child notes if they have the `isInheritable` flag set to `true`. This means the attribute (a key-value pair) is applied to the note and all its descendants.
 
-### Example Use Case
+To make an attribute inheritable, simply use the visual editor for <a class="reference-link" href="Labels.md">Labels</a> or <a class="reference-link" href="Relations.md">Relations</a>. Alternatively, the attribute can be manually defined where `#myLabel=value` becomes `#myLabel(inheritable)=value` when inheritable.
+
+As an example, the `archived` label can be set to be inheritable, allowing you to hide a whole subtree of notes from searches and other dialogs by applying this label at the top level.
 
-The `archived` label can be set to be inheritable, allowing you to hide a whole subtree of notes from searches and other dialogs by applying this label at the top level.
+Standard inheritance forces all the notes that are children (and sub-children) of a note to have that particular label or relation. If there is a need to have some notes not inherit one of the labels, then _copying inheritance_ or _template inheritance_ needs to be used instead.
 
-## 2\. Copying Inheritance
+## Copying Inheritance
 
 Copying inheritance differs from standard inheritance by using a `child:` prefix in the attribute name. This prefix causes new child notes to automatically receive specific attributes from the parent note. These attributes are independent of the parent and will persist even if the note is moved elsewhere.
 
-### How to Use
+If a parent note has the label `#child:exampleAttribute`, all newly created child notes (one level deep) will inherit the `#exampleAttribute` label. This can be useful for setting default properties for notes in a specific section.
+
+Similarly, for relations use `~child:myRelation`.
+
+Due to the way it's designed, copying inheritance cannot be used to cascade infinitely within a hierarchy. For that use case, consider using either standard inheritance or templates.
+
+### Chained inheritance
+
+It is possible to define labels across multiple levels of depth. For example, `#child:child:child:foo` applied to a root note would create:
 
-*   **Syntax:** `#child:attributeName`
-*   **Chained Inheritance:** You can chain this inheritance, such as `#child:child:attributeName`, where each child down the hierarchy receives the appropriate attribute.
+*   `#child:child:foo` on the first-level children.
+*   `#child:foo` on the second-level children.
+*   `#foo` on the third-level children.
 
-### Example
+Similarly, use `~child:child:child:foo` if dealing with relations.
 
-If a parent note has the label `#child:exampleAttribute`, all newly created child notes will inherit the `#exampleAttribute` label. This can be useful for setting default properties for notes in a specific section.
+Do note that same as simple copying inheritance, the changes will not apply retroactively to existing notes in the hierarchy, it will only apply to the newly created notes.
 
-## 3\. Template Inheritance
+## Template Inheritance
 
-Attributes can also be inherited from [templates](../Templates.md). When a new note is created using a template, it inherits the attributes defined in that template. This is particularly useful for maintaining consistency across notes that follow a similar structure or function.
+Attributes can also be inherited from <a class="reference-link" href="../Templates.md">Templates</a>. When a new note is created using a template, it inherits the attributes defined in that template. This is particularly useful for maintaining consistency across notes that follow a similar structure or function.