sascha
/
Notes
mirror of https://github.com/TriliumNext/Notes
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat(docs): clarify attribute use cases

pull/1650/head
Elian Doran 2025-04-07 12:30:37 +07:00
parent 190cff6f7e
commit ec5025d7fd
No known key found for this signature in database
8 changed files with 48 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/User Guide/!!!meta.json
Unescape Escape View File

@ -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",

15
docs/User Guide/User Guide/Advanced Usage/Attributes.md
Unescape Escape View File

@ -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 <a class="reference-link" href="Advanced%20Showcases/Weight%20Tracker.md">Weight Tracker</a>.
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 <a class="reference-link" href="Attributes/Labels.md">Labels</a>.
## 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 <a class="reference-link" href="Attributes/Relations.md">Relations</a>.

6
docs/User Guide/User Guide/Advanced Usage/Attributes/Labels.md
Unescape Escape View File

@ -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 <a class="reference-link" href="../Advanced%20Showcases/Weight%20Tracker.md">Weight Tracker</a>.
## Creating a label using the visual editor
1. Go to the _Owned Attributes_ section in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>.

5
docs/User Guide/User Guide/Advanced Usage/Attributes/Relations.md
Unescape Escape View File

@ -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 <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>.

14
src/public/app/doc_notes/en/User Guide/!!!meta.json generated
Unescape Escape View File

@ -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",

24
src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html generated
Unescape Escape View File

@ -28,28 +28,14 @@
height="146">
</figure>
<h2>Labels</h2>
<p>Labels in Trilium can be used for a variety of purposes:</p>
<ul>
<li><strong>Metadata</strong>: Assign labels with optional values for categorization,
such as <code>#year=1999</code>, <code>#genre="sci-fi"</code>, or <code>#author="Neal Stephenson"</code>
</li>
<li><strong>Configuration</strong>: Labels can configure advanced features
or settings</li>
<li><strong>Scripts and Plugins</strong>: Used to tag notes with special metadata,
such as the "weight" attribute in the&nbsp;<a class="reference-link" href="Advanced%20Showcases/Weight%20Tracker.html">Weight Tracker</a>.</li>
</ul>
<p>Labels are also searchable, enhancing note retrieval.</p>
<p>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.</p>
<p>For more information, including predefined labels, see&nbsp;<a class="reference-link"
href="Attributes/Labels.html">Labels</a>.</p>
<h2>Relations</h2>
<p>Relations define connections between notes, similar to links.</p>
<p>Uses:</p>
<ul>
<li><strong>Metadata Relationships</strong>: For example, linking a book note
to an author note</li>
<li><strong>Scripting</strong>: Attaching scripts to events or conditions
related to the note</li>
</ul>
<p>Relations define connections between notes, similar to links. These can
be used for metadata and scripting purposes.</p>
<p>For more information, including a list of predefined relations, see&nbsp;
<a
class="reference-link" href="Attributes/Relations.html">Relations</a>.</p>

9
src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Labels.html generated
Unescape Escape View File

@ -15,6 +15,15 @@
<div class="ck-content">
<p>A label is an <a href="../Attributes.html">attribute</a> of a note which
has a name and optionally a value.&nbsp;</p>
<h2>Common use cases</h2>
<ul>
<li><strong>Metadata</strong>: Assign labels with optional values for categorization,
such as <code>#year=1999</code>, <code>#genre="sci-fi"</code>, or <code>#author="Neal Stephenson"</code>.</li>
<li><strong>Configuration</strong>: Labels can configure advanced features
or settings (see reference below).</li>
<li><strong>Scripts and Plugins</strong>: Used to tag notes with special metadata,
such as the "weight" attribute in the&nbsp;<a class="reference-link" href="../Advanced%20Showcases/Weight%20Tracker.html">Weight Tracker</a>.</li>
</ul>
<h2>Creating a label using the visual editor</h2>
<ol>
<li>Go to the <em>Owned Attributes</em> section in the&nbsp;<a class="reference-link"

7
src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Relations.html generated
Unescape Escape View File

@ -15,6 +15,13 @@
<div class="ck-content">
<p>A relation is similar to a <a href="Labels.html">label</a>, but instead
of having a text value it refers to another note.</p>
<h2>Common use cases</h2>
<ul>
<li><strong>Metadata Relationships</strong>: For example, linking a book note
to an author note.</li>
<li><strong>Scripting</strong>: Attaching scripts to events or conditions
related to the note.</li>
</ul>
<h2>Creating a relation using the visual editor</h2>
<ol>
<li>Go to the <em>Owned Attributes</em> section in the&nbsp;<a class="reference-link"