Trilium offers advanced functionality through Scripts and +
Trilium offers advanced functionality through Scripts and Promoted Attributes. To illustrate these features, we've prepared - several showcases available in the demo notes:
+ href="#root/_help_OFXdgB2nNk1F">Promoted Attributes. To illustrate these features, we've prepared + several showcases available in the demo notes:-
-
- Relation Map +
- Relation Map -
- Day Notes +
- Day Notes -
- Weight Tracker +
- Weight Tracker -
- Task Manager +
- Task Manager
It's important to note that these examples are not natively supported diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.html index f9b3cbf2e..935e6d0d7 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.html @@ -27,7 +27,7 @@
This pattern works well also because of Cloning Notes functionality +
This pattern works well also because of Cloning Notes functionality - note can appear in multiple places in the note tree, so besides appearing under day note, it can also be categorized into other notes.
Demo
@@ -38,11 +38,11 @@ - there's a note for the whole year 2017, under it, you have "12 - December" which then contains "18 - Monday". This is our "day note" which contains some text in its content and also has some child notes (some of them are - from Task manager). -You can also notice how this day note has promoted attribute "weight" - where you can track your daily weight. This data is then used in Weight tracker.
+ from Task manager). +You can also notice how this day note has promoted attribute "weight" + where you can track your daily weight. This data is then used in Weight tracker.
Templates
-Trilium provides template functionality, +
Trilium provides template functionality, and it could be used together with day notes.
You can define one of the following relations on the root of the journal
(identified by #calendarRoot label):
Task Manager
Task Manager is a promoted attributes and +
Task Manager is a promoted attributes and scriptsshowcase present in the demo notes.
+ href="#root/_help_CdNpE2pqjmI6">scriptsshowcase present in the demo notes.Demo
@@ -24,23 +24,22 @@
doneDate attribute). Outstanding tasks are further categorized by location
and arbitrary tags - whenever you change tag attribute in the task note,
this task is then automatically moved to appropriate location.
Task Manager also integrates with day notes - - notes are cloned into - day note to both todoDate note and doneDate note (with prefix of +
Task Manager also integrates with day notes - + notes are cloned into day note to + both todoDate note and doneDate note (with prefix of either "TODO" or "DONE").
Implementation
New tasks are created in the TODO note which has ~child:template
relation(see attribute inheritance)
+ href="#root/_help_zEY4DaJG4YT5">relation(see attribute inheritance)
pointing to the task template.
Attributes
-Task template defines several promoted attributes - +
Task template defines several promoted attributes -
todoDate, doneDate, tags, location. Importantly it also defines ~runOnAttributeChange relation
- - event handler which is run on
- attribute change. This script 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
There's also "button" note which contains simple script which adds a button to create new note (task) in the TODO note.
api.addButtonToToolbar({
@@ -64,7 +63,7 @@
CSS
In the demo screenshot above you may notice that TODO tasks are in red
color and DONE tasks are green.
- This is done by having this CSS code note which
+
This is done by having this CSS code note which
defines extra CSS classes:
span.fancytree-node.todo .fancytree-title {
color: red !important;
}
@@ -72,9 +71,9 @@
span.fancytree-node.done .fancytree-title {
color: green !important;
}
- This code note has #appCss
+
This code note has #appCss
labelwhich is recognized by Trilium on startup and loaded as CSS into
+ href="#root/_help_zEY4DaJG4YT5">labelwhich is recognized by Trilium on startup and loaded as CSS into
the application.
Second part of this functionality is based in event handler described
above which assigns #cssClass label to the task to either "done"
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html
index 77557868b..2093984ba 100644
--- a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html
@@ -16,19 +16,19 @@
- The Weight Tracker is a Script API showcase
- present in the demo notes.
- By adding weight as a promoted attribute in
- the template from which day notes are
+
The Weight Tracker is a Script API showcase
+ present in the demo notes.
+ By adding weight as a promoted attribute in
+ the template from which day notes are
created, you can aggregate the data and plot weight change over time.
Implementation
The Weight Tracker note in the screenshot above is of the type Render Note.
That type of note doesn't have any useful content itself. Instead it is
- a placeholder where a script can render
+ a placeholder where a script can render
its output.
- Scripts for Render Notes are defined in a relation called ~renderNote.
+
Scripts for Render Notes are defined in a relation called ~renderNote.
In this example, it's the Weight Tracker's child Implementation.
- The Implementation consists of two code notes that
+ The Implementation consists of two code notes that
contain some HTML and JavaScript respectively, which load all the notes
with a weight attribute and display their values in a chart.
To actually render the chart, we're using a third party library called
@@ -36,7 +36,7 @@
href="https://www.chartjs.org/">chart.jswhich is imported as an attachment, since it's not built into
Trilium.
Code
- Here's the content of the script which is placed in a code note of
+
Here's the content of the script which is placed in a code note of
type JS Frontend:
async function getChartData() {
const days = await api.runOnBackend(async () => {
const notes = api.getNotesWithLabel('weight');
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 a52792cbb..21f01f1f2 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
@@ -21,26 +21,26 @@
additional metadata or functionality. There are two primary types of attributes:
-
-
Labels can
+
Labels 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.
+ href="#root/_help_HI6GBBIduIgv">Labels.
-
-
Relations define
+
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.
+ class="reference-link" href="#root/_help_Cq5X6iKQop6R">Relations.
These attributes play a crucial role in organizing, categorising, and
enhancing the functionality of notes.
Viewing the list of attributes
Both the labels and relations for the current note are displayed in the Owned Attributes section
- of the Ribbon,
+ 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.
@@ -52,11 +52,11 @@
Attribute Definitions and Promoted Attributes
Special labels create "label/attribute" definitions, enhancing the organization
and management of attributes. For more details, see Promoted Attributes.
+ href="#root/_help_OFXdgB2nNk1F">Promoted Attributes.
Attribute Inheritance
Trilium supports attribute inheritance, allowing child notes to inherit
attributes from their parents. For more information, see Attribute Inheritance.
+ href="#root/_help_bwZpz2ajCEwO">Attribute Inheritance.