mirror of https://github.com/TriliumNext/Notes
feat(docs): reorganize scripting notes and finalize attribute reference
Elian Doran
parent
cdf9fa5b4a
commit
72f0bc32df
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 9.0 KiB After Width: | Height: | Size: 9.0 KiB |
@ -1,29 +0,0 @@
|
|||||||
# Events
|
|
||||||
[Script](../../Scripting.md) notes can be triggered by events. Note that these are backend events and thus relation need to point to the "JS backend" code note.
|
|
||||||
|
|
||||||
## Global events
|
|
||||||
|
|
||||||
Global events are attached to the script note via label. Simply create e.g. "run" label with some of these values and script note will be executed once the event occurs.
|
|
||||||
|
|
||||||
* `run`
|
|
||||||
* `frontendStartup` - executes on frontend upon startup
|
|
||||||
* `mobileStartup` - executes on mobile frontend upon startup
|
|
||||||
* `backendStartup` - executes on backend upon startup
|
|
||||||
* `hourly` - executes once an hour on backend
|
|
||||||
* `daily` - executes once a day on backend
|
|
||||||
|
|
||||||
## Entity events
|
|
||||||
|
|
||||||
Other events are bound to some entity, these are defined as [relations](../../Advanced%20Usage/Attributes.md) - meaning that script is triggered only if note has this script attached to it through relations (or it can inherit it).
|
|
||||||
|
|
||||||
* `runOnNoteCreation` - executes when note is created on backend
|
|
||||||
* `runOnNoteTitleChange` - executes when note title is changed (includes note creation as well)
|
|
||||||
* `runOnNoteContentChange` - executes when note content is changed (includes note creation as well).
|
|
||||||
* `runOnNoteChange` - executes when note is changed (includes note creation as well)
|
|
||||||
* `runOnNoteDeletion` - executes when note is being deleted
|
|
||||||
* `runOnBranchCreation` - executes when a branch is created. Branch is a link between parent note and child note and is created e.g. when cloning or moving note.
|
|
||||||
* `runOnBranchChange` (since v0.62) - executes when a branch is changed - either expanded status or prefix are changed.
|
|
||||||
* `runOnBranchDeletion` - executes when a branch is delete. Branch is a link between parent note and child note and is deleted e.g. when moving note (old branch/link is deleted).
|
|
||||||
* `runOnChildNoteCreation` - executes when new note is created under _this_ note
|
|
||||||
* `runOnAttributeCreation` - executes when new attribute is created under _this_ note
|
|
||||||
* `runOnAttributeChange` - executes when attribute is changed under _this_ note
|
|
||||||
|
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
@ -0,0 +1,14 @@
|
|||||||
|
# Events
|
||||||
|
[Script](../Scripting.md) notes can be triggered by events. Note that these are backend events and thus relation need to point to the "JS backend" code note.
|
||||||
|
|
||||||
|
## Global events
|
||||||
|
|
||||||
|
Global events are attached to the script note via label. Simply create e.g. "run" label with some of these values and script note will be executed once the event occurs.
|
||||||
|
|
||||||
|
<figure class="table"><table><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>run</code></td><td><p>Defines on which events script should run. Possible values are:</p><ul><li><code>frontendStartup</code> - when Trilium frontend starts up (or is refreshed), but not on mobile.</li><li><code>mobileStartup</code> - when Trilium frontend starts up (or is refreshed), on mobile.</li><li><code>backendStartup</code> - when Trilium backend starts up</li><li><code>hourly</code> - run once an hour. You can use additional label <code>runAtHour</code> to specify at which hour, on the back-end.</li><li><code>daily</code> - run once a day, on the back-end</li></ul></td></tr><tr><td><code>runOnInstance</code></td><td>Specifies that the script should only run on a particular <a class="reference-link" href="../Advanced%20Usage/Configuration%20(config.ini%20or%20environment%20variables)/Trilium%20instance.md">Trilium instance</a>.</td></tr><tr><td><code>runAtHour</code></td><td>On which hour should this run. Should be used together with <code>#run=hourly</code>. Can be defined multiple times for more runs during the day.</td></tr></tbody></table></figure>
|
||||||
|
|
||||||
|
## Entity events
|
||||||
|
|
||||||
|
Other events are bound to some entity, these are defined as [relations](../Advanced%20Usage/Attributes.md) - meaning that script is triggered only if note has this script attached to it through relations (or it can inherit it).
|
||||||
|
|
||||||
|
<figure class="table"><table><thead><tr><th>Relation</th><th>Description</th></tr></thead><tbody><tr><td><code>runOnNoteCreation</code></td><td>executes when note is created on backend. Use this relation if you want to run the script for all notes created under a specific subtree. In that case, create it on the subtree root note and make it inheritable. A new note created within the subtree (any depth) will trigger the script.</td></tr><tr><td><code>runOnChildNoteCreation</code></td><td>executes when new note is created under the note where this relation is defined</td></tr><tr><td><code>runOnNoteTitleChange</code></td><td>executes when note title is changed (includes note creation as well)</td></tr><tr><td><code>runOnNoteContentChange</code></td><td>executes when note content is changed (includes note creation as well).</td></tr><tr><td><code>runOnNoteChange</code></td><td>executes when note is changed (includes note creation as well). Does not include content changes</td></tr><tr><td><code>runOnNoteDeletion</code></td><td>executes when note is being deleted</td></tr><tr><td><code>runOnBranchCreation</code></td><td>executes when a branch is created. Branch is a link between parent note and child note and is created e.g. when cloning or moving note.</td></tr><tr><td><code>runOnBranchChange</code></td><td>executes when a branch is updated. (since v0.62)</td></tr><tr><td><code>runOnBranchDeletion</code></td><td>executes when a branch is deleted. Branch is a link between parent note and child note and is deleted e.g. when moving note (old branch/link is deleted).</td></tr><tr><td><code>runOnAttributeCreation</code></td><td>executes when new attribute is created for the note which defines this relation</td></tr><tr><td><code>runOnAttributeChange</code></td><td>executes when the attribute is changed of a note which defines this relation. This is triggered also when the attribute is deleted</td></tr></tbody></table></figure>
|
||||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,37 @@
|
|||||||
|
<html>
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<link rel="stylesheet" href="../../../style.css">
|
||||||
|
<base target="_parent">
|
||||||
|
<title data-trilium-title>Trilium instance</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div class="content">
|
||||||
|
<h1 data-trilium-h1>Trilium instance</h1>
|
||||||
|
|
||||||
|
<div class="ck-content">
|
||||||
|
<p>A Trilium instance represents a server. If <a class="reference-link"
|
||||||
|
href="../../Installation%20%26%20Setup/Synchronization.html">Synchronization</a> is
|
||||||
|
set up, since multiple servers are involved (the one from the desktop client
|
||||||
|
and the one the synchronisation is set up with), sometimes it can be useful
|
||||||
|
to distinguish the instance you are running on.</p>
|
||||||
|
<h2>Setting the instance name</h2>
|
||||||
|
<p>To set up a name for the instance, modify the <code>config.ini</code>:</p><pre><code class="language-text-x-trilium-auto">[General]
|
||||||
|
instanceName=Hello</code></pre>
|
||||||
|
<h2>Distinguishing the instance on back-end</h2>
|
||||||
|
<p>Use <code>api.getInstanceName()</code> to obtain the instance name of the
|
||||||
|
current server, as specified in the config file or in environment variables.</p>
|
||||||
|
<h2>Limiting script runs based on instance</h2>
|
||||||
|
<p>For a script that is run periodically or on a certain event, it's possible
|
||||||
|
to limit it to certain instances without having to change the code. Just
|
||||||
|
add <code>runOnInstance</code> and set as the value the instance name where
|
||||||
|
the script should run. To run on multiple named instances, simply add the
|
||||||
|
label multiple times.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
@ -1,62 +0,0 @@
|
|||||||
<html>
|
|
||||||
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<link rel="stylesheet" href="../../../style.css">
|
|
||||||
<base target="_parent">
|
|
||||||
<title data-trilium-title>Workspace</title>
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
<div class="content">
|
|
||||||
<h1 data-trilium-h1>Workspace</h1>
|
|
||||||
|
|
||||||
<div class="ck-content">
|
|
||||||
<p>Workspace is a concept built up on top of <a href="Note%20Hoisting.html">note hoisting</a>.
|
|
||||||
It is based on the idea that a user has several distinct spheres of interest.
|
|
||||||
An example might be "Personal" and "Work", these two spheres are quite
|
|
||||||
distinct and don't interact together. When I focus on Work, I don't really
|
|
||||||
care about personal notes.</p>
|
|
||||||
<p>So far workspace consists of these features:</p>
|
|
||||||
<ul>
|
|
||||||
<li>
|
|
||||||
<p><a href="Note%20Hoisting.html">note hoisting</a> - you can "zoom" into
|
|
||||||
a workspace subtree to focus only on the relevant notes</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>easy entering of workspace: </p>
|
|
||||||
<p>
|
|
||||||
<img src="1_Workspace_image.png">
|
|
||||||
</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>visual identification of workspace in tabs:
|
|
||||||
<br>
|
|
||||||
<img src="Workspace_image.png">
|
|
||||||
</p>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<h3>How to use workspaces</h3>
|
|
||||||
<p>Let's say you have identified the workspaces and their subtrees. Define
|
|
||||||
on the root of this subtree following labels:</p>
|
|
||||||
<ul>
|
|
||||||
<li><code>#workspace</code> - Marks this note as a workspace, button to enter
|
|
||||||
the workspace is controlled by this</li>
|
|
||||||
<li><code>#workspaceIconClass</code> - controls the box icon to be displayed
|
|
||||||
in the tree and tabs, example <code>bx bx-home</code>. See <a href="https://boxicons.com/">https://boxicons.com/</a>
|
|
||||||
</li>
|
|
||||||
<li><code>#workspaceTabBackgroundColor</code> - Background color of the tab,
|
|
||||||
use any CSS color format, e.g. "lightblue" or "#ddd". See <a href="https://www.w3schools.com/cssref/css_colors.asp">https://www.w3schools.com/cssref/css_colors.asp</a>.</li>
|
|
||||||
<li><code>#workspaceCalendarRoot</code> - marking a note with this label will
|
|
||||||
define a new per-workspace calendar. If there's no such note, the global
|
|
||||||
calendar will be used.</li>
|
|
||||||
<li><code>#workspaceTemplate</code> - This note will appear in the selection
|
|
||||||
of available templates when creating a new note, but only when you are
|
|
||||||
currently hoisted into a workspace containing this template.</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
|
|
||||||
</html>
|
|
||||||
@ -0,0 +1,96 @@
|
|||||||
|
<html>
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<link rel="stylesheet" href="../../../style.css">
|
||||||
|
<base target="_parent">
|
||||||
|
<title data-trilium-title>Workspaces</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div class="content">
|
||||||
|
<h1 data-trilium-h1>Workspaces</h1>
|
||||||
|
|
||||||
|
<div class="ck-content">
|
||||||
|
<p>Workspace is a concept built up on top of <a href="Note%20Hoisting.html">note hoisting</a>.
|
||||||
|
It is based on the idea that a user has several distinct spheres of interest.
|
||||||
|
An example might be "Personal" and "Work", these two spheres are quite
|
||||||
|
distinct and don't interact together. When I focus on Work, I don't really
|
||||||
|
care about personal notes.</p>
|
||||||
|
<p>So far workspace consists of these features:</p>
|
||||||
|
<ul>
|
||||||
|
<li><a href="Note%20Hoisting.html">note hoisting</a> - you can "zoom" into
|
||||||
|
a workspace subtree to focus only on the relevant notes</li>
|
||||||
|
<li>
|
||||||
|
<p>easy entering of workspace: </p>
|
||||||
|
<p>
|
||||||
|
<img src="1_Workspaces_image.png">
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
<li>visual identification of workspace in tabs:
|
||||||
|
<br>
|
||||||
|
<img src="Workspaces_image.png">
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h3>Configuration</h3>
|
||||||
|
<figure class="table">
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Label</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><code>workspace</code>
|
||||||
|
</td>
|
||||||
|
<td>Marks this note as a workspace, button to enter the workspace is controlled
|
||||||
|
by this</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>workspaceIconClass</code>
|
||||||
|
</td>
|
||||||
|
<td>defines box icon CSS class which will be used in tab when hoisted to this
|
||||||
|
note</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>workspaceTabBackgroundColor</code>
|
||||||
|
</td>
|
||||||
|
<td>CSS color used in the note tab when hoisted to this note, use any CSS
|
||||||
|
color format, e.g. "lightblue" or "#ddd". See <a href="https://www.w3schools.com/cssref/css_colors.asp">https://www.w3schools.com/cssref/css_colors.asp</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>workspaceCalendarRoot</code>
|
||||||
|
</td>
|
||||||
|
<td>Marking a note with this label will define a new per-workspace calendar
|
||||||
|
for <a class="reference-link" href="../../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.html">Day Notes</a>.
|
||||||
|
If there's no such note, the global calendar will be used.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>workspaceTemplate</code>
|
||||||
|
</td>
|
||||||
|
<td>This note will appear in the selection of available template when creating
|
||||||
|
new note, but only when hoisted into a workspace containing this template</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>workspaceSearchHome</code>
|
||||||
|
</td>
|
||||||
|
<td>new search notes will be created as children of this note when hoisted
|
||||||
|
to some ancestor of this workspace note</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>workspaceInbox</code>
|
||||||
|
</td>
|
||||||
|
<td>default inbox location for new notes when hoisted to some ancestor of
|
||||||
|
this workspace note</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</figure>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
|
Before Width: | Height: | Size: 9.0 KiB After Width: | Height: | Size: 9.0 KiB |
@ -1,66 +0,0 @@
|
|||||||
<html>
|
|
||||||
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<link rel="stylesheet" href="../../../style.css">
|
|
||||||
<base target="_parent">
|
|
||||||
<title data-trilium-title>Events</title>
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
<div class="content">
|
|
||||||
<h1 data-trilium-h1>Events</h1>
|
|
||||||
|
|
||||||
<div class="ck-content">
|
|
||||||
<p><a href="../../Scripting.html">Script</a> notes can be triggered by events.
|
|
||||||
Note that these are backend events and thus relation need to point to the
|
|
||||||
"JS backend" code note.</p>
|
|
||||||
<h2>Global events</h2>
|
|
||||||
<p>Global events are attached to the script note via label. Simply create
|
|
||||||
e.g. "run" label with some of these values and script note will be executed
|
|
||||||
once the event occurs.</p>
|
|
||||||
<ul>
|
|
||||||
<li><code>run</code>
|
|
||||||
<ul>
|
|
||||||
<li><code>frontendStartup</code> - executes on frontend upon startup</li>
|
|
||||||
<li><code>mobileStartup</code> - executes on mobile frontend upon startup</li>
|
|
||||||
<li><code>backendStartup</code> - executes on backend upon startup</li>
|
|
||||||
<li><code>hourly</code> - executes once an hour on backend</li>
|
|
||||||
<li><code>daily</code> - executes once a day on backend</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<h2>Entity events</h2>
|
|
||||||
<p>Other events are bound to some entity, these are defined as <a href="../../Advanced%20Usage/Attributes.html">relations</a> -
|
|
||||||
meaning that script is triggered only if note has this script attached
|
|
||||||
to it through relations (or it can inherit it).</p>
|
|
||||||
<ul>
|
|
||||||
<li><code>runOnNoteCreation</code> - executes when note is created on backend</li>
|
|
||||||
<li><code>runOnNoteTitleChange</code> - executes when note title is changed
|
|
||||||
(includes note creation as well)</li>
|
|
||||||
<li><code>runOnNoteContentChange</code> - executes when note content is changed
|
|
||||||
(includes note creation as well).</li>
|
|
||||||
<li><code>runOnNoteChange</code> - executes when note is changed (includes
|
|
||||||
note creation as well)</li>
|
|
||||||
<li><code>runOnNoteDeletion</code> - executes when note is being deleted</li>
|
|
||||||
<li><code>runOnBranchCreation</code> - executes when a branch is created. Branch
|
|
||||||
is a link between parent note and child note and is created e.g. when cloning
|
|
||||||
or moving note.</li>
|
|
||||||
<li><code>runOnBranchChange</code> (since v0.62) - executes when a branch is
|
|
||||||
changed - either expanded status or prefix are changed.</li>
|
|
||||||
<li><code>runOnBranchDeletion</code> - executes when a branch is delete. Branch
|
|
||||||
is a link between parent note and child note and is deleted e.g. when moving
|
|
||||||
note (old branch/link is deleted).</li>
|
|
||||||
<li><code>runOnChildNoteCreation</code> - executes when new note is created
|
|
||||||
under <em>this</em> note</li>
|
|
||||||
<li><code>runOnAttributeCreation</code> - executes when new attribute is created
|
|
||||||
under <em>this</em> note</li>
|
|
||||||
<li><code>runOnAttributeChange</code> - executes when attribute is changed
|
|
||||||
under <em>this</em> note</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
|
|
||||||
</html>
|
|
||||||
|
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
@ -0,0 +1,149 @@
|
|||||||
|
<html>
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<link rel="stylesheet" href="../../style.css">
|
||||||
|
<base target="_parent">
|
||||||
|
<title data-trilium-title>Events</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div class="content">
|
||||||
|
<h1 data-trilium-h1>Events</h1>
|
||||||
|
|
||||||
|
<div class="ck-content">
|
||||||
|
<p><a href="../Scripting.html">Script</a> notes can be triggered by events.
|
||||||
|
Note that these are backend events and thus relation need to point to the
|
||||||
|
"JS backend" code note.</p>
|
||||||
|
<h2>Global events</h2>
|
||||||
|
<p>Global events are attached to the script note via label. Simply create
|
||||||
|
e.g. "run" label with some of these values and script note will be executed
|
||||||
|
once the event occurs.</p>
|
||||||
|
<figure class="table">
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Label</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><code>run</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>Defines on which events script should run. Possible values are:</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>frontendStartup</code> - when Trilium frontend starts up (or is refreshed),
|
||||||
|
but not on mobile.</li>
|
||||||
|
<li><code>mobileStartup</code> - when Trilium frontend starts up (or is refreshed),
|
||||||
|
on mobile.</li>
|
||||||
|
<li><code>backendStartup</code> - when Trilium backend starts up</li>
|
||||||
|
<li><code>hourly</code> - run once an hour. You can use additional label <code>runAtHour</code> to
|
||||||
|
specify at which hour, on the back-end.</li>
|
||||||
|
<li><code>daily</code> - run once a day, on the back-end</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>runOnInstance</code>
|
||||||
|
</td>
|
||||||
|
<td>Specifies that the script should only run on a particular <a class="reference-link"
|
||||||
|
href="../Advanced%20Usage/Configuration%20(config.ini%20or%20environment%20variables)/Trilium%20instance.html">Trilium instance</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>runAtHour</code>
|
||||||
|
</td>
|
||||||
|
<td>On which hour should this run. Should be used together with <code>#run=hourly</code>.
|
||||||
|
Can be defined multiple times for more runs during the day.</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</figure>
|
||||||
|
<h2>Entity events</h2>
|
||||||
|
<p>Other events are bound to some entity, these are defined as <a href="../Advanced%20Usage/Attributes.html">relations</a> -
|
||||||
|
meaning that script is triggered only if note has this script attached
|
||||||
|
to it through relations (or it can inherit it).</p>
|
||||||
|
<figure class="table">
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Relation</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><code>runOnNoteCreation</code>
|
||||||
|
</td>
|
||||||
|
<td>executes when note is created on backend. Use this relation if you want
|
||||||
|
to run the script for all notes created under a specific subtree. In that
|
||||||
|
case, create it on the subtree root note and make it inheritable. A new
|
||||||
|
note created within the subtree (any depth) will trigger the script.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>runOnChildNoteCreation</code>
|
||||||
|
</td>
|
||||||
|
<td>executes when new note is created under the note where this relation is
|
||||||
|
defined</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>runOnNoteTitleChange</code>
|
||||||
|
</td>
|
||||||
|
<td>executes when note title is changed (includes note creation as well)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>runOnNoteContentChange</code>
|
||||||
|
</td>
|
||||||
|
<td>executes when note content is changed (includes note creation as well).</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>runOnNoteChange</code>
|
||||||
|
</td>
|
||||||
|
<td>executes when note is changed (includes note creation as well). Does not
|
||||||
|
include content changes</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>runOnNoteDeletion</code>
|
||||||
|
</td>
|
||||||
|
<td>executes when note is being deleted</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>runOnBranchCreation</code>
|
||||||
|
</td>
|
||||||
|
<td>executes when a branch is created. Branch is a link between parent note
|
||||||
|
and child note and is created e.g. when cloning or moving note.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>runOnBranchChange</code>
|
||||||
|
</td>
|
||||||
|
<td>executes when a branch is updated. (since v0.62)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>runOnBranchDeletion</code>
|
||||||
|
</td>
|
||||||
|
<td>executes when a branch is deleted. Branch is a link between parent note
|
||||||
|
and child note and is deleted e.g. when moving note (old branch/link is
|
||||||
|
deleted).</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>runOnAttributeCreation</code>
|
||||||
|
</td>
|
||||||
|
<td>executes when new attribute is created for the note which defines this
|
||||||
|
relation</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>runOnAttributeChange</code>
|
||||||
|
</td>
|
||||||
|
<td>executes when the attribute is changed of a note which defines this relation.
|
||||||
|
This is triggered also when the attribute is deleted</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</figure>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
@ -0,0 +1,19 @@
|
|||||||
|
<html>
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<link rel="stylesheet" href="../../../style.css">
|
||||||
|
<base target="_parent">
|
||||||
|
<title data-trilium-title>Backend API</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div class="content">
|
||||||
|
<h1 data-trilium-h1>Backend API</h1>
|
||||||
|
|
||||||
|
<div class="ck-content"></div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
@ -0,0 +1,19 @@
|
|||||||
|
<html>
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<link rel="stylesheet" href="../../../../style.css">
|
||||||
|
<base target="_parent">
|
||||||
|
<title data-trilium-title>FNote</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div class="content">
|
||||||
|
<h1 data-trilium-h1>FNote</h1>
|
||||||
|
|
||||||
|
<div class="ck-content"></div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
Loading…
Reference in New Issue