From ec5025d7fde1ac36a5cd2130feea0ec806ef9fc2 Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Mon, 7 Apr 2025 12:30:37 +0300 Subject: [PATCH] feat(docs): clarify attribute use cases --- docs/User Guide/!!!meta.json | 14 +++++------ .../User Guide/Advanced Usage/Attributes.md | 15 ++---------- .../Advanced Usage/Attributes/Labels.md | 6 +++++ .../Advanced Usage/Attributes/Relations.md | 5 ++++ .../app/doc_notes/en/User Guide/!!!meta.json | 14 +++++------ .../User Guide/Advanced Usage/Attributes.html | 24 ++++--------------- .../Advanced Usage/Attributes/Labels.html | 9 +++++++ .../Advanced Usage/Attributes/Relations.html | 7 ++++++ 8 files changed, 48 insertions(+), 46 deletions(-) diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index 58bdb0538..3fbecedd7 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -6694,13 +6694,6 @@ "type": "text", "mime": "text/markdown", "attributes": [ - { - "type": "relation", - "name": "internalLink", - "value": "R7abl2fc6Mxi", - "isInheritable": false, - "position": 10 - }, { "type": "relation", "name": "internalLink", @@ -6990,6 +6983,13 @@ "value": "xWbu3jpNWapp", "isInheritable": false, "position": 320 + }, + { + "type": "relation", + "name": "internalLink", + "value": "R7abl2fc6Mxi", + "isInheritable": false, + "position": 330 } ], "format": "markdown", diff --git a/docs/User Guide/User Guide/Advanced Usage/Attributes.md b/docs/User Guide/User Guide/Advanced Usage/Attributes.md index 18b556bd1..a5feed5ef 100644 --- a/docs/User Guide/User Guide/Advanced Usage/Attributes.md +++ b/docs/User Guide/User Guide/Advanced Usage/Attributes.md @@ -10,24 +10,13 @@ These attributes play a crucial role in organizing, categorising, and enhancing ## 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 Weight Tracker. - -Labels are also searchable, enhancing note retrieval. +Labels in Trilium 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 Labels. ## 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 +Relations 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 Relations. diff --git a/docs/User Guide/User Guide/Advanced Usage/Attributes/Labels.md b/docs/User Guide/User Guide/Advanced Usage/Attributes/Labels.md index e34003a54..4e6cc3190 100644 --- a/docs/User Guide/User Guide/Advanced Usage/Attributes/Labels.md +++ b/docs/User Guide/User Guide/Advanced Usage/Attributes/Labels.md @@ -1,6 +1,12 @@ # Labels A label is an [attribute](../Attributes.md) of a note which has a name and optionally a value.  +## Common use cases + +* **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 (see reference below). +* **Scripts and Plugins**: Used to tag notes with special metadata, such as the "weight" attribute in the Weight Tracker. + ## Creating a label using the visual editor 1. Go to the _Owned Attributes_ section in the Ribbon. diff --git a/docs/User Guide/User Guide/Advanced Usage/Attributes/Relations.md b/docs/User Guide/User Guide/Advanced Usage/Attributes/Relations.md index 754351a78..f12117494 100644 --- a/docs/User Guide/User Guide/Advanced Usage/Attributes/Relations.md +++ b/docs/User Guide/User Guide/Advanced Usage/Attributes/Relations.md @@ -1,6 +1,11 @@ # Relations A relation is similar to a [label](Labels.md), but instead of having a text value it refers to another note. +## Common use cases + +* **Metadata Relationships**: For example, linking a book note to an author note. +* **Scripting**: Attaching scripts to events or conditions related to the note. + ## Creating a relation using the visual editor 1. Go to the _Owned Attributes_ section in the Ribbon. diff --git a/src/public/app/doc_notes/en/User Guide/!!!meta.json b/src/public/app/doc_notes/en/User Guide/!!!meta.json index 3e8fc5011..c8946fbaa 100644 --- a/src/public/app/doc_notes/en/User Guide/!!!meta.json +++ b/src/public/app/doc_notes/en/User Guide/!!!meta.json @@ -6694,13 +6694,6 @@ "type": "text", "mime": "text/markdown", "attributes": [ - { - "type": "relation", - "name": "internalLink", - "value": "R7abl2fc6Mxi", - "isInheritable": false, - "position": 10 - }, { "type": "relation", "name": "internalLink", @@ -6990,6 +6983,13 @@ "value": "xWbu3jpNWapp", "isInheritable": false, "position": 320 + }, + { + "type": "relation", + "name": "internalLink", + "value": "R7abl2fc6Mxi", + "isInheritable": false, + "position": 330 } ], "format": "html", diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html index 4e579189d..e823fa2cb 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html @@ -28,28 +28,14 @@ height="146">

Labels

-

Labels in Trilium can be used for a variety of purposes:

- -

Labels are also searchable, enhancing note retrieval.

+

Labels in Trilium 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 Labels.

Relations

-

Relations define connections between notes, similar to links.

-

Uses:

- +

Relations 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  Relations.

diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Labels.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Labels.html index c644d9513..be71de0a4 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Labels.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Labels.html @@ -15,6 +15,15 @@

A label is an attribute of a note which has a name and optionally a value. 

+

Common use cases

+

Creating a label using the visual editor

  1. Go to the Owned Attributes section in the 

    A relation is similar to a label, but instead of having a text value it refers to another note.

    +

    Common use cases

    +
      +
    • Metadata Relationships: For example, linking a book note + to an author note.
      • +
    • Scripting: Attaching scripts to events or conditions + related to the note.
      • +

    Creating a relation using the visual editor

    1. Go to the Owned Attributes section in the