Merge remote-tracking branch 'origin/develop' into calendar

This commit is contained in:
Elian Doran
2025-04-10 21:25:42 +03:00
255 changed files with 7006 additions and 2387 deletions

2
src/express.d.ts vendored
View File

@@ -20,6 +20,8 @@ export declare module "express-serve-static-core" {
"trilium-component-id"?: string;
"trilium-local-now-datetime"?: string;
"trilium-hoisted-note-id"?: string;
"user-agent"?: string;
};
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -13,18 +13,18 @@
<h1 data-trilium-h1>Advanced Showcases</h1>
<div class="ck-content">
<p>Trilium offers advanced functionality through <a href="../Scripting.html">Scripts</a> and
<p>Trilium offers advanced functionality through <a href="#root/_help_CdNpE2pqjmI6">Scripts</a> and
<a
href="Attributes/Promoted%20Attributes.html">Promoted Attributes</a>. To illustrate these features, we've prepared
several showcases available in the <a href="Database.html">demo notes</a>:</p>
href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>. To illustrate these features, we've prepared
several showcases available in the <a href="#root/_help_wX4HbRucYSDD">demo notes</a>:</p>
<ul>
<li><a href="../Note%20Types/Relation%20Map.html">Relation Map</a>
<li><a href="#root/_help_iRwzGnHPzonm">Relation Map</a>
</li>
<li><a href="Advanced%20Showcases/Day%20Notes.html">Day Notes</a>
<li><a href="#root/_help_l0tKav7yLHGF">Day Notes</a>
</li>
<li><a href="Advanced%20Showcases/Weight%20Tracker.html">Weight Tracker</a>
<li><a href="#root/_help_R7abl2fc6Mxi">Weight Tracker</a>
</li>
<li><a href="Advanced%20Showcases/Task%20Manager.html">Task Manager</a>
<li><a href="#root/_help_xYjQUYhpbUEW">Task Manager</a>
</li>
</ul>
<p>It's important to note that these examples are not natively supported

View File

@@ -27,7 +27,7 @@
<p>
<img src="1_Day Notes_image.png">
</p>
<p>This pattern works well also because of <a href="../../Basic%20Concepts%20and%20Features/Notes/Cloning%20Notes.html">Cloning Notes</a> functionality
<p>This pattern works well also because of <a href="#root/_help_IakOLONlIfGI">Cloning Notes</a> 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.</p>
<h2>Demo</h2>
@@ -38,9 +38,9 @@
- there's a note for the whole year 2025, under it, you have "03 - March"
which then contains "09 - Monday". This is our "day note" which contains
some text in its content and also has some child notes (some of them are
from <a href="Task%20Manager.html">Task manager</a>).</p>
<p>You can also notice how this day note has <a href="../Attributes/Promoted%20Attributes.html">promoted attribute</a> "weight"
where you can track your daily weight. This data is then used in <a href="Weight%20Tracker.html">Weight tracker</a>.</p>
from <a href="#root/_help_xYjQUYhpbUEW">Task manager</a>).</p>
<p>You can also notice how this day note has <a href="#root/_help_OFXdgB2nNk1F">promoted attribute</a> "weight"
where you can track your daily weight. This data is then used in <a href="#root/_help_R7abl2fc6Mxi">Weight tracker</a>.</p>
<h2>Week Note and Quarter Note</h2>
<p>Week and quarter notes are disabled by default, since it might be too
much for some people. To enable them, you need to set <code>#enableWeekNotes</code> and <code>#enableQuarterNotes</code> attributes
@@ -49,7 +49,7 @@
you already have some week notes created, it will not automatically change
the existing week notes and might lead to some duplicates.</p>
<h2>Templates</h2>
<p>Trilium provides <a href="../Templates.html">template</a> functionality,
<p>Trilium provides <a href="#root/_help_KC1HB96bqqHX">template</a> functionality,
and it could be used together with day notes.</p>
<p>You can define one of the following relations on the root of the journal
(identified by <code>#calendarRoot</code> label):</p>

View File

@@ -13,9 +13,9 @@
<h1 data-trilium-h1>Task Manager</h1>
<div class="ck-content">
<p>Task Manager is a <a href="../Attributes/Promoted%20Attributes.html">promoted attributes</a> and
<p>Task Manager is a <a href="#root/_help_OFXdgB2nNk1F">promoted attributes</a> and
<a
href="../../Scripting.html">scripts</a>showcase present in the <a href="../Database.html">demo notes</a>.</p>
href="#root/_help_CdNpE2pqjmI6">scripts</a>showcase present in the <a href="#root/_help_wX4HbRucYSDD">demo notes</a>.</p>
<h2>Demo</h2>
<p>
<img src="Task Manager_task-manager.png">
@@ -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.</p>
<p>Task Manager also integrates with <a href="Day%20Notes.html">day notes</a> -
notes are <a href="../../Basic%20Concepts%20and%20Features/Notes/Cloning%20Notes.html">cloned</a> into
day note to both todoDate note and doneDate note (with <a href="../../Basic%20Concepts%20and%20Features/Navigation/Tree%20Concepts.html">prefix</a> of
<p>Task Manager also integrates with <a href="#root/_help_l0tKav7yLHGF">day notes</a> -
notes are <a href="#root/_help_IakOLONlIfGI">cloned</a> into day note to
both todoDate note and doneDate note (with <a href="#root/_help_kBrnXNG3Hplm">prefix</a> of
either "TODO" or "DONE").</p>
<h2>Implementation</h2>
<p>New tasks are created in the TODO note which has <code>~child:template</code>
<a
href="../Attributes.html">relation</a>(see <a href="../Attributes/Attribute%20Inheritance.html">attribute inheritance</a>)
href="#root/_help_zEY4DaJG4YT5">relation</a>(see <a href="#root/_help_bwZpz2ajCEwO">attribute inheritance</a>)
pointing to the task template.</p>
<h3>Attributes</h3>
<p>Task template defines several <a href="../Attributes/Promoted%20Attributes.html">promoted attributes</a> -
<p>Task template defines several <a href="#root/_help_OFXdgB2nNk1F">promoted attributes</a> -
todoDate, doneDate, tags, location. Importantly it also defines <code>~runOnAttributeChange</code> relation
- <a href="../../Note%20Types/Code/Events.html">event</a> handler which is
run on attribute change. This <a href="../../Scripting.html">script</a> 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.</p>
- <a href="#root/_help_GPERMystNGTB">event</a> handler which is run on attribute
change. This <a href="#root/_help_CdNpE2pqjmI6">script</a> 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.</p>
<h3>New task button</h3>
<p>There's also "button" note which contains simple script which adds a button
to create new note (task) in the TODO note.</p><pre><code class="language-text-x-trilium-auto">api.addButtonToToolbar({
@@ -64,7 +63,7 @@
<h3>CSS</h3>
<p>In the demo screenshot above you may notice that TODO tasks are in red
color and DONE tasks are green.</p>
<p>This is done by having this CSS <a href="../../Note%20Types/Code.html">code note</a> which
<p>This is done by having this CSS <a href="#root/_help_6f9hih2hXXZk">code note</a> which
defines extra CSS classes:</p><pre><code class="language-text-x-trilium-auto">span.fancytree-node.todo .fancytree-title {
color: red !important;
}
@@ -72,9 +71,9 @@
span.fancytree-node.done .fancytree-title {
color: green !important;
}</code></pre>
<p>This <a href="../../Note%20Types/Code.html">code note</a> has <code>#appCss</code>
<p>This <a href="#root/_help_6f9hih2hXXZk">code note</a> has <code>#appCss</code>
<a
href="../Attributes.html">label</a>which is recognized by Trilium on startup and loaded as CSS into
href="#root/_help_zEY4DaJG4YT5">label</a>which is recognized by Trilium on startup and loaded as CSS into
the application.</p>
<p>Second part of this functionality is based in event handler described
above which assigns <code>#cssClass</code> label to the task to either "done"

View File

@@ -16,19 +16,19 @@
<p>
<img src="Weight Tracker_image.png">
</p>
<p>The <code>Weight Tracker</code> is a <a href="../../Note%20Types/Code/Script%20API.html">Script API</a> showcase
present in the <a href="../Database.html">demo notes</a>.</p>
<p>By adding <code>weight</code> as a <a href="../Attributes/Promoted%20Attributes.html">promoted attribute</a> in
the <a href="../Templates.html">template</a> from which <a href="Day%20Notes.html">day notes</a> are
<p>The <code>Weight Tracker</code> is a <a href="#root/_help_GLks18SNjxmC">Script API</a> showcase
present in the <a href="#root/_help_wX4HbRucYSDD">demo notes</a>.</p>
<p>By adding <code>weight</code> as a <a href="#root/_help_OFXdgB2nNk1F">promoted attribute</a> in
the <a href="#root/_help_KC1HB96bqqHX">template</a> from which <a href="#root/_help_l0tKav7yLHGF">day notes</a> are
created, you can aggregate the data and plot weight change over time.</p>
<h2>Implementation</h2>
<p>The <code>Weight Tracker</code> note in the screenshot above is of the type <code>Render Note</code>.
That type of note doesn't have any useful content itself. Instead it is
a placeholder where a <a href="../../Scripting.html">script</a> can render
a placeholder where a <a href="#root/_help_CdNpE2pqjmI6">script</a> can render
its output.</p>
<p>Scripts for <code>Render Notes</code> are defined in a <a href="../Attributes.html">relation</a> called <code>~renderNote</code>.
<p>Scripts for <code>Render Notes</code> are defined in a <a href="#root/_help_zEY4DaJG4YT5">relation</a> called <code>~renderNote</code>.
In this example, it's the <code>Weight Tracker</code>'s child <code>Implementation</code>.
The Implementation consists of two <a href="../../Note%20Types/Code.html">code notes</a> that
The Implementation consists of two <a href="#root/_help_6f9hih2hXXZk">code notes</a> that
contain some HTML and JavaScript respectively, which load all the notes
with a <code>weight</code> attribute and display their values in a chart.</p>
<p>To actually render the chart, we're using a third party library called
@@ -36,7 +36,7 @@
href="https://www.chartjs.org/">chart.js</a>which is imported as an attachment, since it's not built into
Trilium.</p>
<h3>Code</h3>
<p>Here's the content of the script which is placed in a <a href="../../Note%20Types/Code.html">code note</a> of
<p>Here's the content of the script which is placed in a <a href="#root/_help_6f9hih2hXXZk">code note</a> of
type <code>JS Frontend</code>:</p><pre><code class="language-text-x-trilium-auto">async function getChartData() {
const days = await api.runOnBackend(async () =&gt; {
const notes = api.getNotesWithLabel('weight');

View File

@@ -13,122 +13,50 @@
<h1 data-trilium-h1>Attributes</h1>
<div class="ck-content">
<figure class="image">
<img style="aspect-ratio:1071/146;" src="Attributes_image.png" width="1071"
height="146">
</figure>
<p>In Trilium, attributes are key-value pairs assigned to notes, providing
additional metadata or functionality. There are two primary types of attributes:</p>
<ol>
<li><strong>Labels</strong>: Simple key-value text records</li>
<li><strong>Relations</strong>: Named links to other notes</li>
<li>
<p><a class="reference-link" href="#root/_help_HI6GBBIduIgv">Labels</a>&nbsp;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="#root/_help_HI6GBBIduIgv">Labels</a>.</p>
</li>
<li>
<p><a class="reference-link" href="#root/_help_Cq5X6iKQop6R">Relations</a>&nbsp;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="#root/_help_Cq5X6iKQop6R">Relations</a>.</p>
</li>
</ol>
<p>These attributes play a crucial role in organizing, categorising, and
enhancing the functionality of notes.</p>
<p>
<img src="Attributes_image.png">
</p>
<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>
<h3>Common Labels for Advanced Configuration</h3>
<ul>
<li><code>disableVersioning</code>: Disables automatic versioning, ideal for
large, unimportant notes like script libraries</li>
<li><code>versioningLimit</code>: Used to limit the number of revisions for
a single note</li>
<li><code>calendarRoot</code>: Marks the note as the root for <a href="Advanced%20Showcases/Day%20Notes.html">day notes</a>.
Only one note should carry this label</li>
<li><code>archived</code>: Hides notes from default search results and dialogs</li>
<li><code>excludeFromExport</code>: Excludes notes and their subtrees from
export operations</li>
<li><code>run</code>: Specifies events to trigger scripts (e.g., <code>frontendStartup</code>, <code>hourly</code>)</li>
<li><code>runAtHour</code>: Defines specific hours for scripts to run, used
with <code>#run=hourly</code>
</li>
<li><code>disableInclusion</code>: Prevents a script from being included in
parent script executions</li>
<li><code>sorted</code>: Automatically sorts child notes alphabetically by
title</li>
<li><code>top</code>: Keeps the note at the top of its parent's list, useful
with <code>sorted</code>
</li>
<li><code>hidePromotedAttributes</code>: Hides certain attributes in the note's
display</li>
<li><code>readOnly</code>: Sets the note to read-only mode, applicable to
text and code notes</li>
<li><code>autoReadOnlyDisabled</code>: Disables automatic read-only mode for
large notes</li>
<li><code>appCss</code>: Marks CSS notes used to modify Triliums appearance</li>
<li><code>appTheme</code>: Marks full CSS themes available in Trilium's options</li>
<li><code>cssClass</code>: Adds a CSS class to the note's representation in
the tree</li>
<li><code>iconClass</code>: Adds a CSS class to the note's icon, useful for
distinguishing notes visually. See&nbsp;<a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20Icons.html">Note Icons</a>.</li>
<li><code>pageSize</code>: Specifies the number of items per page in note
listings</li>
<li><code>customRequestHandler</code> <strong>and</strong> <code>customResourceProvider</code>:
Refer to&nbsp;<a class="reference-link" href="Custom%20Request%20Handler.html">Custom Request Handler</a>
</li>
<li><code>widget</code>: Marks a note as a custom widget, added to Trilium's
component tree</li>
<li><code>workspace</code> <strong>and related attributes</strong>: See&nbsp;
<a
class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Workspace.html">Workspace</a>&nbsp;for more details</li>
<li><code>searchHome</code>: Specifies the parent for new search notes</li>
<li><code>inbox</code>: Designates a default location for new notes created
via the sidebar</li>
<li><code>sqlConsoleHome</code>: Default location for SQL console notes</li>
<li><code>bookmarked</code> <strong>and</strong> <code>bookmarkFolder</code>:
See&nbsp;<a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Bookmarks.html">Bookmarks</a>
</li>
<li><code>share:[…]</code>: See&nbsp;<a class="reference-link" href="Sharing.html">Sharing</a>
</li>
<li><code>keyboardShortcut</code>: Assigns a keyboard shortcut to open the
note</li>
<li><code>displayRelations</code> <strong>and</strong> <code>hideRelations</code>:
Manages the display of note relations</li>
<li><code>titleTemplate</code>: See&nbsp;<a class="reference-link" href="Default%20Note%20Title.html">Default Note Title</a>
</li>
<li><code>template</code>: Makes the note available as a template</li>
<li><code>toc</code>: Controls the visibility of the table of contents</li>
<li><code>color</code>: Defines the color of the note in the tree and links</li>
<li><code>hideChildrenOverview</code>: Hides child notes in the parent note's
editor</li>
<li><code>viewType</code>: Sets the view of child notes (grid or list)</li>
</ul>
<h2>Relations</h2>
<p>Relations define connections between notes, similar to links.</p>
<h3>Uses</h3>
<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>
<h3>Common Relations</h3>
<ul>
<li><strong>Event-based Relations</strong>: Such as <code>runOnNoteCreation</code> or <code>runOnNoteChange</code>,
which trigger scripts on specific actions</li>
<li><strong>Other Relations</strong>: Include <code>template</code>, <code>renderNote</code>, <code>widget</code>,
and sharing-related relations</li>
</ul>
<h2>Viewing the list of attributes</h2>
<p>Both the labels and relations for the current note are displayed in the <em>Owned Attributes</em> section
of the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>,
where they can be viewed and edited. Inherited attributes are displayed
in the <em>Inherited Attributes</em> section of the ribbon, where they can
only be viewed.</p>
<p>In the list of attributes, labels are prefixed with the <code>#</code> character
whereas relations are prefixed with the <code>~</code> character.</p>
<h2>Multiplicity</h2>
<p>Attributes in Trilium can be "multivalued", meaning multiple attributes
with the same name can coexist.</p>
<p>Attributes in Trilium can be "multi-valued", meaning multiple attributes
with the same name can co-exist.</p>
<h2>Attribute Definitions and Promoted Attributes</h2>
<p>Special labels create "label/attribute" definitions, enhancing the organization
and management of attributes. For more details, see&nbsp;<a class="reference-link"
href="Attributes/Promoted%20Attributes.html">Promoted Attributes</a>.</p>
href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>.</p>
<h2>Attribute Inheritance</h2>
<p>Trilium supports attribute inheritance, allowing child notes to inherit
attributes from their parents. For more information, see&nbsp;<a class="reference-link"
href="Attributes/Attribute%20Inheritance.html">Attribute Inheritance</a>.</p>
href="#root/_help_bwZpz2ajCEwO">Attribute Inheritance</a>.</p>
</div>
</div>
</body>

View File

@@ -13,35 +13,53 @@
<h1 data-trilium-h1>Attribute Inheritance</h1>
<div class="ck-content">
<h2>1. Standard Inheritance</h2>
<p>Inheritance refers to the process of having a <a href="#root/_help_HI6GBBIduIgv">label</a> or
a <a href="#root/_help_Cq5X6iKQop6R">relation</a> shared across multiple
notes, generally in parent-child relations (or anywhere if using templates).</p>
<h2>Standard Inheritance</h2>
<p>In Trilium, attributes can be automatically inherited by child notes if
they have the <code>isInheritable</code> flag set to <code>true</code>. This
means the attribute (a key-value pair) is applied to the note and all its
descendants.</p>
<h3>Example Use Case</h3>
<p>The <code>archived</code> 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.</p>
<h2>2. Copying Inheritance</h2>
<p>To make an attribute inheritable, simply use the visual editor for&nbsp;
<a
class="reference-link" href="#root/_help_HI6GBBIduIgv">Labels</a>&nbsp;or&nbsp;<a class="reference-link" href="#root/_help_Cq5X6iKQop6R">Relations</a>.
Alternatively, the attribute can be manually defined where <code>#myLabel=value</code> becomes <code>#myLabel(inheritable)=value</code> when
inheritable.</p>
<p>As an example, the <code>archived</code> 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.</p>
<p>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 <em>copying inheritance</em> or <em>template inheritance</em> needs
to be used instead.</p>
<h2>Copying Inheritance</h2>
<p>Copying inheritance differs from standard inheritance by using a <code>child:</code> 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.</p>
<h3>How to Use</h3>
<ul>
<li><strong>Syntax:</strong> <code>#child:attributeName</code>
</li>
<li><strong>Chained Inheritance:</strong> You can chain this inheritance, such
as <code>#child:child:attributeName</code>, where each child down the hierarchy
receives the appropriate attribute.</li>
</ul>
<h3>Example</h3>
<p>If a parent note has the label <code>#child:exampleAttribute</code>, all
newly created child notes will inherit the <code>#exampleAttribute</code> label.
newly created child notes (one level deep) will inherit the <code>#exampleAttribute</code> label.
This can be useful for setting default properties for notes in a specific
section.</p>
<h2>3. Template Inheritance</h2>
<p>Attributes can also be inherited from <a href="../Templates.html">templates</a>.
<p>Similarly, for relations use <code>~child:myRelation</code>.</p>
<p>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.</p>
<h3>Chained inheritance</h3>
<p>It is possible to define labels across multiple levels of depth. For example, <code>#child:child:child:foo</code> applied
to a root note would create:</p>
<ul>
<li><code>#child:child:foo</code> on the first-level children.</li>
<li><code>#child:foo</code> on the second-level children.</li>
<li><code>#foo</code> on the third-level children.</li>
</ul>
<p>Similarly, use <code>~child:child:child:foo</code> if dealing with relations.</p>
<p>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.</p>
<h2>Template Inheritance</h2>
<p>Attributes can also be inherited from&nbsp;<a class="reference-link" href="#root/_help_KC1HB96bqqHX">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.</p>

View File

@@ -0,0 +1,405 @@
<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>Labels</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Labels</h1>
<div class="ck-content">
<p>A label is an <a href="#root/_help_zEY4DaJG4YT5">attribute</a> of a note
which has a name and optionally a value.</p>
<h2>Common use cases</h2>
<ul>
<li><strong>Metadata for personal use</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>. This can be combined with&nbsp;
<a
class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;to make their display more user-friendly.</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="#root/_help_R7abl2fc6Mxi">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"
href="#root/_help_BlN9DFI679QC">Ribbon</a>.</li>
<li>Press the + button (<em>Add new attribute</em>) to the right.</li>
<li>Select <em>Add new label</em> for the relation.</li>
</ol>
<aside class="admonition tip">
<p>If you prefer keyboard shortcuts, press <kbd>Alt</kbd>+<kbd>L</kbd> while
focused on a note or in the <em>Owned Attributes</em> section to display
the visual editor.</p>
</aside>
<p>While in the visual editor:</p>
<ul>
<li>Set the desired name</li>
<li>Optionally, set the value of the label. Labels can exist without a value.</li>
<li>Check <em>Inheritable</em> if the label should be inherited by the child
notes as well. See&nbsp;<a class="reference-link" href="#root/_help_bwZpz2ajCEwO">Attribute Inheritance</a>&nbsp;for
more information.</li>
</ul>
<h2>Creating a label manually</h2>
<p>In the <em>Owned Attributes</em> section in the&nbsp;<a class="reference-link"
href="#root/_help_BlN9DFI679QC">Ribbon</a>:</p>
<ul>
<li>To create a label called <code>myLabel</code> with no value, simply type <code>#myLabel</code>.</li>
<li>To create a label called <code>myLabel</code> with a value <code>value</code>,
simply type <code>#myLabel=value</code>.</li>
<li>If the value contains spaces, then the text must be quoted: <code>#myLabel="Hello world"</code>.</li>
<li>If the string contains quotes (regardless of whether it has spaces), then
the text must be quoted with apostrophes instead: <code>#myLabel='Hello "world"'</code>.</li>
<li>To create an inheritable label called <code>myLabel</code>, simply write <code>#myLabel(inheritable)</code> for
no value or <code>#myLabel(inheritable)=value</code> if there is a value.</li>
</ul>
<h2>Predefined labels</h2>
<p>This is a list of labels that Trilium natively supports.</p>
<aside class="admonition tip">
<p>Some labels presented here end with a <code>*</code>. That means that there
are multiple labels with the same prefix, consult the specific page linked
in the description of that label for more information.</p>
</aside>
<figure class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:33.82%;">
<col style="width:66.18%;">
</colgroup>
<thead>
<tr>
<th>Label</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>disableVersioning</code>
</td>
<td>Disables automatic creation of&nbsp;<a class="reference-link" href="#root/_help_vZWERwf8U3nx">Note Revisions</a>&nbsp;for
a particular note. Useful for e.g. large, but unimportant notes - e.g.
large JS libraries used for scripting.</td>
</tr>
<tr>
<td><code>versioningLimit</code>
</td>
<td>Limits the maximum number of&nbsp;<a class="reference-link" href="#root/_help_vZWERwf8U3nx">Note Revisions</a>&nbsp;for
a particular note, overriding the global settings.</td>
</tr>
<tr>
<td><code>calendarRoot</code>
</td>
<td>Marks the note which should be used as root for&nbsp;<a class="reference-link"
href="#root/_help_l0tKav7yLHGF">Day Notes</a>. Only one should be marked
as such.</td>
</tr>
<tr>
<td><code>archived</code>
</td>
<td>Hides notes from default search results and dialogs. Archived notes can
optionally be hidden in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</td>
</tr>
<tr>
<td><code>excludeFromExport</code>
</td>
<td>Excludes this note and its children when exporting.</td>
</tr>
<tr>
<td><code>run</code>, <code>runOnInstance</code>, <code>runAtHour</code>
</td>
<td>See&nbsp;<a class="reference-link" href="#root/_help_GPERMystNGTB">Events</a>.</td>
</tr>
<tr>
<td><code>disableInclusion</code>
</td>
<td>Scripts with this label won't be included into parent script execution.</td>
</tr>
<tr>
<td><code>sorted</code>
</td>
<td>
<p>Keeps child notes sorted by title alphabetically.</p>
<p>When given a value, it will sort by the value of another label instead.
If one of the child notes doesn't have the specified label, the title will
be used for them instead.</p>
</td>
</tr>
<tr>
<td><code>sortDirection</code>
</td>
<td>
<p>If <code>sorted</code> is applied, specifies the direction of the sort:</p>
<ul>
<li><code>ASC</code>, ascending (default)</li>
<li><code>DESC</code>, descending</li>
</ul>
</td>
</tr>
<tr>
<td><code>sortFoldersFirst</code>
</td>
<td>If <code>sorted</code> is applied, folders (notes with children) will be
sorted as a group at the top, and the rest will be sorted.</td>
</tr>
<tr>
<td><code>top</code>
</td>
<td>If <code>sorted</code> is applied to the parent note, keeps given note on
top in its parent.</td>
</tr>
<tr>
<td><code>hidePromotedAttributes</code>
</td>
<td>Hide&nbsp;<a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;on
this note. Generally useful when defining inherited attributes, but the
parent note doesn't need them.</td>
</tr>
<tr>
<td><code>readOnly</code>
</td>
<td>Marks a note to be always be <a href="#root/_help_CoFPLs3dRlXc">read-only</a>,
if it's a supported note (text, code, mermaid).</td>
</tr>
<tr>
<td><code>autoReadOnlyDisabled</code>
</td>
<td>Disables automatic <a href="#root/_help_CoFPLs3dRlXc">read-only mode</a> for
the given note.</td>
</tr>
<tr>
<td><code>appCss</code>
</td>
<td>Marks CSS notes which are loaded into the Trilium application and can
thus be used to modify Trilium's looks. See&nbsp;<a class="reference-link"
href="#root/_help_AlhDUqhENtH7">Custom app-wide CSS</a>&nbsp;for more info.</td>
</tr>
<tr>
<td><code>appTheme</code>
</td>
<td>Marks CSS notes which are full Trilium themes and are thus available in
Trilium options. See&nbsp;<a class="reference-link" href="#root/_help_pKK96zzmvBGf">Theme development</a>&nbsp;for
more information.</td>
</tr>
<tr>
<td><code>appThemeBase</code>
</td>
<td>Set to <code>next</code>, <code>next-light</code>, or <code>next-dark</code> to
use the corresponding TriliumNext theme (auto, light or dark) as the base
for a custom theme, instead of the legacy one. See&nbsp;<a class="reference-link"
href="#root/_help_WFGzWeUK6arS">Customize the Next theme</a>&nbsp;for more
information.</td>
</tr>
<tr>
<td><code>cssClass</code>
</td>
<td>Value of this label is then added as CSS class to the node representing
given note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.
This can be useful for advanced theming. Can be used in template notes.</td>
</tr>
<tr>
<td><code>iconClass</code>
</td>
<td>value of this label is added as a CSS class to the icon on the tree which
can help visually distinguish the notes in the tree. Example might be bx
bx-home - icons are taken from boxicons. Can be used in template notes.</td>
</tr>
<tr>
<td><code>pageSize</code>
</td>
<td>Specifies the number of items per page in&nbsp;<a class="reference-link"
href="#root/_help_0ESUbbAxVnoK">Note List</a>.</td>
</tr>
<tr>
<td><code>customRequestHandler</code>
</td>
<td>See&nbsp;<a class="reference-link" href="#root/_help_J5Ex1ZrMbyJ6">Custom Request Handler</a>.</td>
</tr>
<tr>
<td><code>customResourceProvider</code>
</td>
<td>See&nbsp;<a class="reference-link" href="#root/_help_d3fAXQ2diepH">Custom Resource Providers</a>.</td>
</tr>
<tr>
<td><code>widget</code>
</td>
<td>Marks this note as a custom widget which will be added to the Trilium
component tree. See&nbsp;<a class="reference-link" href="#root/_help_MgibgPcfeuGz">Custom Widgets</a>&nbsp;for
more information.</td>
</tr>
<tr>
<td><code>searchHome</code>
</td>
<td>New search notes will be created as children of this note (see&nbsp;
<a
class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>).</td>
</tr>
<tr>
<td><code>workspace</code> and related attributes</td>
<td>See&nbsp;<a class="reference-link" href="#root/_help_9sRHySam5fXb">Workspaces</a>.</td>
</tr>
<tr>
<td><code>inbox</code>
</td>
<td>default inbox location for new notes - when you create a note using <em>new note</em> button
in the sidebar, notes will be created as child notes in the note marked
as with <code>#inbox</code> label.</td>
</tr>
<tr>
<td><code>sqlConsoleHome</code>
</td>
<td>Default location of&nbsp;<a class="reference-link" href="#root/_hidden/_help/_help_tC7s2alapj8V/_help_wX4HbRucYSDD/_help_oyIAJ9PvvwHX/_help__help_YKWqdJhzi2VY">SQL Console</a>&nbsp;notes</td>
</tr>
<tr>
<td><code>bookmarked</code>
</td>
<td>Indicates this note is a <a href="#root/_help_u3YFHC9tQlpm">bookmark</a>.</td>
</tr>
<tr>
<td><code>bookmarkFolder</code>
</td>
<td>Note with this label will appear in bookmarks as folder (allowing access
to its children). See&nbsp;<a class="reference-link" href="#root/_help_u3YFHC9tQlpm">Bookmarks</a>&nbsp;for
more information.</td>
</tr>
<tr>
<td><code>share*</code>
</td>
<td>See the attribute reference in&nbsp;<a class="reference-link" href="#root/_help_R9pX4DGra2Vt">Sharing</a>.</td>
</tr>
<tr>
<td><code>displayRelations</code>, <code>hideRelations</code>
</td>
<td>Comma delimited names of relations which should be displayed/hidden in
a&nbsp;<a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a>&nbsp;(both
the note type and the&nbsp;<a class="reference-link" href="#root/_help_BCkXAVs63Ttv">Note Map (Link map, Tree map)</a>&nbsp;general
functionality).</td>
</tr>
<tr>
<td><code>titleTemplate</code>
</td>
<td>
<p>Default title of notes created as children of this note. This value is
evaluated as a JavaScript string and thus can be enriched with dynamic
content via the injected <code>now</code> and <code>parentNote</code> variables.</p>
<p>Examples:</p>
<ul>
<li><code>${parentNote.getLabel('authorName')}'s literary works</code>
</li>
<li><code>Log for ${now.format('YYYY-MM-DD HH:mm:ss')}</code>
</li>
<li>to mirror the parent's template.</li>
</ul>
<p>See&nbsp;<a class="reference-link" href="#root/_help_47ZrP6FNuoG8">Default Note Title</a>&nbsp;for
more info.</p>
</td>
</tr>
<tr>
<td><code>template</code>
</td>
<td>This note will appear in the selection of available template when creating
new note. See&nbsp;<a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>&nbsp;for
more information.</td>
</tr>
<tr>
<td><code>toc</code>
</td>
<td>Controls the display of the&nbsp;<a class="reference-link" href="#root/_help_BFvAtE74rbP6">Table of contents</a>&nbsp;for
a given note. <code>#toc</code> or <code>#toc=show</code> to always display
the table of contents, <code>#toc=false</code> to always hide it.</td>
</tr>
<tr>
<td><code>color</code>
</td>
<td>defines color of the note in note tree, links etc. Use any valid CSS color
value like 'red' or #a13d5f</td>
</tr>
<tr>
<td><code>keyboardShortcut</code>
</td>
<td>Defines a keyboard shortcut which will immediately jump to this note.
Example: 'ctrl+alt+e'. Requires frontend reload for the change to take
effect.</td>
</tr>
<tr>
<td><code>keepCurrentHoisting</code>
</td>
<td>Opening this link won't change hoisting even if the note is not displayable
in the current hoisted subtree.</td>
</tr>
<tr>
<td><code>executeButton</code>
</td>
<td>Title of the button which will execute the current code note</td>
</tr>
<tr>
<td><code>executeDescription</code>
</td>
<td>Longer description of the current code note displayed together with the
execute button</td>
</tr>
<tr>
<td><code>excludeFromNoteMap</code>
</td>
<td>Notes with this label will be hidden from the&nbsp;<a class="reference-link"
href="#root/_help_bdUJEHsAPYQR">Note Map</a>.</td>
</tr>
<tr>
<td><code>newNotesOnTop</code>
</td>
<td>New notes will be created at the top of the parent note, not on the bottom.</td>
</tr>
<tr>
<td><code>hideHighlightWidget</code>
</td>
<td>Hides the&nbsp;<a class="reference-link" href="#root/_help_AxshuNRegLAv">Highlights list</a>&nbsp;widget</td>
</tr>
<tr>
<td><code>hideChildrenOverview</code>
</td>
<td>Hides the&nbsp;<a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a>&nbsp;for
that particular note.</td>
</tr>
<tr>
<td><code>printLandscape</code>
</td>
<td>When exporting to PDF, changes the orientation of the page to landscape
instead of portrait.</td>
</tr>
<tr>
<td><code>printPageSize</code>
</td>
<td>When exporting to PDF, changes the size of the page. Supported values: <code>A0</code>, <code>A1</code>, <code>A2</code>, <code>A3</code>, <code>A4</code>, <code>A5</code>, <code>A6</code>, <code>Legal</code>, <code>Letter</code>, <code>Tabloid</code>, <code>Ledger</code>.</td>
</tr>
<tr>
<td><code>geolocation</code>
</td>
<td>Indicates the latitude and longitude of a note, to be displayed in a&nbsp;
<a
class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map</a>.</td>
</tr>
<tr>
<td><code>calendar:*</code>
</td>
<td>Defines specific options for the&nbsp;<a class="reference-link" href="#root/_help_xWbu3jpNWapp">Calendar View</a>.</td>
</tr>
<tr>
<td><code>viewType</code>
</td>
<td>Sets the view of child notes (e.g. grid or list). See&nbsp;<a class="reference-link"
href="#root/_help_0ESUbbAxVnoK">Note List</a>&nbsp;for more information.</td>
</tr>
</tbody>
</table>
</figure>
</div>
</div>
</body>
</html>

View File

@@ -13,7 +13,7 @@
<h1 data-trilium-h1>Promoted Attributes</h1>
<div class="ck-content">
<p>Promoted attributes are <a href="../Attributes.html">attributes</a> which
<p>Promoted attributes are <a href="#root/_help_zEY4DaJG4YT5">attributes</a> which
are considered important and thus are "promoted" onto the main note UI.
See example below:</p>
<p>
@@ -37,7 +37,7 @@
<p>You can notice tag attribute definition. These "definition" attributes
define how the "value" attributes should behave.</p>
<p>So there's one attribute for value and one for definition. But notice
how definition attribute is <a href="Attribute%20Inheritance.html">Inheritable</a>,
how definition attribute is <a href="#root/_help_bwZpz2ajCEwO">Inheritable</a>,
meaning that it's also applied to all descendant note. So in a way, this
definition is used for the whole subtree while "value" attributes are applied
only for this note.</p>

View File

@@ -0,0 +1,159 @@
<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>Relations</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Relations</h1>
<div class="ck-content">
<p>A relation is similar to a <a href="#root/_help_HI6GBBIduIgv">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 for personal use</strong>: For example,
linking a book note to an author note.
<br>This can be combined with&nbsp;<a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;to
make their display more user-friendly.</li>
<li><strong>Configuration</strong>: For configuring some notes such as&nbsp;
<a
class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a>, or configuring&nbsp;<a class="reference-link" href="#root/_help_R9pX4DGra2Vt">Sharing</a>&nbsp;or&nbsp;
<a
class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>&nbsp;(see the list below).</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"
href="#root/_help_BlN9DFI679QC">Ribbon</a>.</li>
<li>Press the + button (<em>Add new attribute</em>) to the right.</li>
<li>Select <em>Add new relation</em> for the relation.</li>
</ol>
<aside class="admonition tip">
<p>If you prefer keyboard shortcuts, press <kbd>Alt</kbd>+<kbd>L</kbd> while
focused on a note or in the <em>Owned Attributes</em> section to display
the visual editor.</p>
</aside>
<p>While in the visual editor:</p>
<ul>
<li>Set the desired name</li>
<li>Set the Target note (the note to point to). Unlike labels, relations cannot
exist with a target note.</li>
<li>Check <em>Inheritable</em> if the label should be inherited by the child
notes as well. See&nbsp;<a class="reference-link" href="#root/_help_bwZpz2ajCEwO">Attribute Inheritance</a>&nbsp;for
more information.</li>
</ul>
<h2>Creating a relation manually</h2>
<p>In the <em>Owned Attributes</em> section in the&nbsp;<a class="reference-link"
href="#root/_help_BlN9DFI679QC">Ribbon</a>:</p>
<ul>
<li>To create a relation called <code>myRelation</code>:
<ul>
<li>First type <code>~myRelation=@</code>.</li>
<li>After this, an autocompletion box should appear.</li>
<li>Type the title of the note to point to and press <kbd>Enter</kbd> to confirm
(or click the desired note).</li>
<li>Alternatively copy a note from the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;and
paste it after the <code>=</code> sign (without the <code>@</code>, in this
case).</li>
</ul>
</li>
<li>To create an inheritable relation, follow the same steps as previously
described but instead of <code>~myRelation</code> write <code>~myRelation(inheritable)</code>.</li>
</ul>
<h2>Predefined relations</h2>
<p>These relations are supported and used internally by Trilium.</p>
<aside
class="admonition tip">
<p>Some relations presented here end with a <code>*</code>. That means that
there are multiple relations with the same prefix, consult the specific
page linked in the description of that relation for more information.</p>
</aside>
<figure class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:33.95%;">
<col style="width:66.05%;">
</colgroup>
<thead>
<tr>
<th>Label</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>runOn*</code>
</td>
<td>See&nbsp;<a class="reference-link" href="#root/_help_GPERMystNGTB">Events</a>
</td>
</tr>
<tr>
<td><code>template</code>
</td>
<td>note's attributes will be inherited even without a parent-child relationship,
note's content and subtree will be added to instance notes if empty. See
documentation for details.</td>
</tr>
<tr>
<td><code>inherit</code>
</td>
<td>note's attributes will be inherited even without a parent-child relationship.
See&nbsp;<a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>&nbsp;for
a similar concept. See&nbsp;<a class="reference-link" href="#root/_help_bwZpz2ajCEwO">Attribute Inheritance</a>&nbsp;in
the documentation.</td>
</tr>
<tr>
<td><code>renderNote</code>
</td>
<td>notes of type&nbsp;<a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a>&nbsp;will
be rendered using a code note (HTML or script) and it is necessary to point
using this relation to which note should be rendered</td>
</tr>
<tr>
<td><code>widget_relation</code>
</td>
<td>target of this relation will be executed and rendered as a widget in the
sidebar</td>
</tr>
<tr>
<td><code>shareCss</code>
</td>
<td>CSS note which will be injected into the share page. CSS note must be
in the shared sub-tree as well. Consider using <code>share_hidden_from_tree</code> and <code>share_omit_default_css</code> as
well.</td>
</tr>
<tr>
<td><code>shareJs</code>
</td>
<td>JavaScript note which will be injected into the share page. JS note must
be in the shared sub-tree as well. Consider using <code>share_hidden_from_tree</code>.</td>
</tr>
<tr>
<td><code>shareTemplate</code>
</td>
<td>Embedded JavaScript note that will be used as the template for displaying
the shared note. Falls back to the default template. Consider using <code>share_hidden_from_tree</code>.</td>
</tr>
<tr>
<td><code>shareFavicon</code>
</td>
<td>Favicon note to be set in the shared page. Typically you want to set it
to share root and make it inheritable. Favicon note must be in the shared
sub-tree as well. Consider using <code>share_hidden_from_tree</code>.</td>
</tr>
</tbody>
</table>
</figure>
</div>
</div>
</body>
</html>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View File

@@ -0,0 +1,189 @@
<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>Bulk Actions</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Bulk Actions</h1>
<div class="ck-content">
<figure class="image">
<img style="aspect-ratio:1425/654;" src="Bulk Actions_image.png" width="1425"
height="654">
</figure>
<p>The <em>Bulk Actions</em> dialog makes it easy to apply changes to multiple
notes at once, ranging from simple actions such as adding or removing a
label to being executing custom scripts.</p>
<h2>Interaction</h2>
<ul>
<li>The first step is to select the notes in the&nbsp;<a class="reference-link"
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>. It's possible to apply bulk
actions to:
<ul>
<li>A single note (and potentially its child notes) simply by clicking on
it (with a left click or a right click).</li>
<li>Multiple notes. See&nbsp;<a class="reference-link" href="#root/_help_yTjUdsOi4CIE">Multiple selection</a>&nbsp;on
how to do so.</li>
</ul>
</li>
<li>Right click in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;and
select <em>Advanced</em><em>Apply bulk actions</em>.</li>
<li>By default, only the selected notes will be affected. To also include
all the descendants of the notes, check <em>Include descendants of the selected notes</em>.
The number of affected notes at the top of the dialog will update to reflect
the change.</li>
<li>Click on which action to apply from the <em>Available actions</em> section.
A detailed description of each is available in the next section.
<ul>
<li>For each action selected, the <em>Chosen actions</em> section will update
to reveal the entry. Each action will have its own configuration.</li>
<li>To remove an action, simply press the X button to the right of it.</li>
<li>It is possible to apply multiple actions of the same type, such as adding
multiple types.</li>
</ul>
</li>
<li>When all the actions are defined, press <em>Execute bulk actions</em> to
trigger all of them at once.</li>
<li>For convenience, the last bulk action configuration is saved for further
use and will be restored when entering the dialog again.</li>
</ul>
<h2>Actions</h2>
<h3>Labels</h3>
<p>These actions operate the&nbsp;<a class="reference-link" href="#root/_help_HI6GBBIduIgv">Labels</a>&nbsp;of
a note:</p>
<ul>
<li><strong>Add label</strong>
<ul>
<li>For each note, if it doesn't already have a <a href="#root/_help_HI6GBBIduIgv">label</a> of
the given name, it will create it. Keep the <em>New value</em> field empty
to create a label without a value, or complete it to assign a value.</li>
<li>If a note already has this label, its value will be updated.</li>
</ul>
</li>
<li><strong>Update label value</strong>
<ul>
<li>For each note, if it has a <a href="#root/_help_HI6GBBIduIgv">label</a> of
the given name, it will change its value to the specified one. Leave <em>New value</em> field
empty to create a label without a value.</li>
<li>Notes without the label will not be affected.</li>
</ul>
</li>
<li><em><strong>Rename label</strong></em>
<ul>
<li>For each note, if it has a <a href="#root/_help_HI6GBBIduIgv">label</a> of
the given name, it will be renamed/replaced with a label of the new name.
The value of the label (if present) will be kept intact.</li>
<li>Notes without the label will not be affected.</li>
</ul>
</li>
<li><strong>Delete label</strong>
<ul>
<li>For each note, if it has a label of a given name, it will be deleted (regardless
of whether it has a value or not).</li>
<li>Notes without the label will not be affected.</li>
</ul>
</li>
</ul>
<h3>Relations</h3>
<p>These actions operate the&nbsp;<a class="reference-link" href="#root/_help_Cq5X6iKQop6R">Relations</a>&nbsp;of
a note:</p>
<ul>
<li><strong>Add relation</strong>
<ul>
<li>For each note, it will create a relation pointing to the given note.</li>
<li>Notes without this relation will not be affected.</li>
</ul>
</li>
<li><strong>Update relation target</strong>
<ul>
<li>For each note, it will modify a relation to point to the newly given note.</li>
<li>Notes without this relation will not be affected.</li>
</ul>
</li>
<li><strong>Rename relation</strong>
<ul>
<li>For each note, if it has a relation of the given name, it will be renamed/replaced
with a relation of the new name. The target note of the relation will be
kept intact.</li>
<li>Notes without this relation will not be affected.</li>
</ul>
</li>
<li><strong>Delete relation</strong>
<ul>
<li>For each note, if it has a relation of the given name, it will be deleted.</li>
<li>Notes without this relation will not be affected.</li>
</ul>
</li>
</ul>
<h3>Notes</h3>
<ul>
<li><strong>Rename note</strong>
<ul>
<li>For each note, it will change the title of the note to the given one.</li>
<li>As a more advanced use case, the note can be a “template string” which
allows for dynamic values with access to the note information via&nbsp;
<a
class="reference-link" href="#root/_help_habiZ3HU8Kw8">FNote</a>, for example:
<ul>
<li><code>NEW: ${note.title}</code> will prefix all notes with <code>NEW:</code> .</li>
<li><code>${note.dateCreatedObj.format('MM-DD:')}: ${note.title}</code> will
prefix the note titles with each note's creation date (in month-day format).</li>
</ul>
</li>
</ul>
</li>
<li><strong>Move note</strong>
<ul>
<li>For each note, it will be moved to the specified parent note.</li>
<li>As an alternative for less complex situations, the notes can be moved
directly from within the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;via
cut → paste or via the contextual menu.</li>
</ul>
</li>
<li><strong>Delete note</strong>
<ul>
<li>For each note, it will be deleted.</li>
<li>As an alternative for less complex situations, the notes can be removed
directly from within the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;by
selecting them and pressing <kbd>Delete</kbd>.</li>
</ul>
</li>
<li><strong>Delete note revisions</strong>
<ul>
<li>This will delete all the&nbsp;<a class="reference-link" href="#root/_help_vZWERwf8U3nx">Note Revisions</a>&nbsp;of
the notes.</li>
</ul>
</li>
</ul>
<h3>Others</h3>
<ul>
<li><strong>Execute script</strong>
<ul>
<li>For more complex scenarios, it is possible to type in a JavaScript expression
in order to apply the necessary changes.</li>
<li>Examples:
<ul>
<li>
<p>To apply a suffix (<code>- suffix</code> in this example), to the note
title:</p><pre><code class="language-application-javascript-env-backend">note.title = note.title + " - suffix";</code></pre>
</li>
<li>
<p>To alter attributes of a note based on another attribute, such as setting
the <code>#shareAlias</code> label to the title of the note:</p><pre><code class="language-application-javascript-env-backend">note.setLabel("shareAlias", note.title)</code></pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

View File

@@ -1,27 +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>Bulk actions</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Bulk actions</h1>
<div class="ck-content">
<h3>Execute script</h3>
<p>For more complex scenarios, it is possible to type in a JavaScript expression
in order to apply the necessary changes.</p>
<p>To apply a suffix (<code>- suffix</code> in this example), to the note
title:</p><pre><code class="language-application-javascript-env-backend">note.title = note.title + " - suffix";</code></pre>
<p>To alter attributes of a note in a bulk action, such as setting the <code>#shareAlias</code> label
to the title of the note:</p><pre><code class="language-application-javascript-env-backend">note.setLabel("shareAlias", note.title)</code></pre>
</div>
</div>
</body>
</html>

View File

@@ -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&nbsp;<a class="reference-link"
href="#root/_help_cbkrhQjrkKrh">Synchronization</a>&nbsp;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>

View File

@@ -13,14 +13,14 @@
<h1 data-trilium-h1>Custom Request Handler</h1>
<div class="ck-content">
<p>Trilium provides a mechanism for <a href="../Scripting.html">scripts</a> to
<p>Trilium provides a mechanism for <a href="#root/_help_CdNpE2pqjmI6">scripts</a> to
open a public REST endpoint. This opens a way for various integrations
with other services - a simple example would be creating new note from
Slack by issuing a slash command (e.g. <code>/trilium buy milk</code>).</p>
<h2>Create note from outside Trilium</h2>
<p>Let's take a look at an example. The goal is to provide a REST endpoint
to which we can send title and content and Trilium will create a note.</p>
<p>We'll start with creating a JavaScript backend <a href="../Note%20Types/Code.html">code note</a> containing:</p><pre><code class="language-text-x-trilium-auto">const {req, res} = api;
<p>We'll start with creating a JavaScript backend <a href="#root/_help_6f9hih2hXXZk">code note</a> containing:</p><pre><code class="language-text-x-trilium-auto">const {req, res} = api;
const {secret, title, content} = req.body;
if (req.method == 'POST' &amp;&amp; secret === 'secret-password') {
@@ -55,7 +55,7 @@ Content-Type: application/json
}+++++++++++++++++++++++++++++++++++++++++++++++</code></pre>
<p>Notice the <code>/custom</code> part in the request path - Trilium considers
any request with this prefix as "custom" and tries to find a matching handler
by looking at all notes which have <code>customRequestHandler</code> <a href="Attributes.html">label</a>.
by looking at all notes which have <code>customRequestHandler</code> <a href="#root/_help_zEY4DaJG4YT5">label</a>.
Value of this label then contains a regular expression which will match
the request path (in our case trivial regex "create-note").</p>
<p>Trilium will then find our code note created above and execute it. <code>api.req</code>, <code>api.res</code> are
@@ -68,12 +68,12 @@ Content-Type: application/json
and you need to take care of this yourself.</p>
<p>Once we pass these checks we will just create the desired note using
<a
href="../Note%20Types/Code/Script%20API.html">Script API</a>.</p>
href="#root/_help_GLks18SNjxmC">Script API</a>.</p>
<h2>Custom resource provider</h2>
<p>Another common use case is that you want to just expose a file note -
in such case you create label <code>customResourceProvider</code> (value
is again path regex).</p>
<p>For more information, see&nbsp;<a href="Custom%20Resource%20Providers.html">Custom Resource Providers</a>.</p>
<p>For more information, see&nbsp;<a href="#root/_help_d3fAXQ2diepH">Custom Resource Providers</a>.</p>
<h2>Advanced concepts</h2>
<p><code>api.req</code> and <code>api.res</code> are Express.js objects - you
can always look into its <a href="https://expressjs.com/en/api.html">documentation</a> for

View File

@@ -16,30 +16,30 @@
<p>Your Trilium data is stored in a <a href="https://www.sqlite.org">SQLite</a> database
which contains all notes, tree structure, metadata, and most of the configuration.
The database file is named <code>document.db</code> and is stored in the
application's default&nbsp;<a href="../Installation%20%26%20Setup/Data%20directory.html">Data directory</a>.</p>
application's default&nbsp;<a href="#root/_help_tAassRL4RSQL">Data directory</a>.</p>
<h2>Demo Notes</h2>
<p>When first starting Trilium, it will provide a set of notes to showcase
various features of the application.</p>
<p>For more information see&nbsp;<a class="reference-link" href="Database/Demo%20Notes.html">Demo Notes</a>.</p>
<p>For more information see&nbsp;<a class="reference-link" href="#root/_help_6tZeKvSHEUiB">Demo Notes</a>.</p>
<h2>Manually Modifying the Database</h2>
<p>Trilium provides a lot of flexibility, and with it, opportunities for
advanced users to tweak it. If you need to explore or modify the database
directly, you can use a tool such as <a href="https://sqlitebrowser.org/">SQLite Browser</a> to
work directly on the database file.</p>
<p>See&nbsp;<a href="Database/Manually%20altering%20the%20database.html">Manually altering the database</a>&nbsp;for
<p>See&nbsp;<a href="#root/_help_oyIAJ9PvvwHX">Manually altering the database</a>&nbsp;for
more information.</p>
<h2>How to Reset the Database</h2>
<p>If you are experimenting with Trilium and want to return it to its original
state, you can do that by deleting the current database. When you restart
the application, it will generate a new database containing the original
demo notes.</p>
<p>To delete the database, simply go to the <a href="../Installation%20%26%20Setup/Data%20directory.html">data directory</a> and
<p>To delete the database, simply go to the <a href="#root/_help_tAassRL4RSQL">data directory</a> and
delete the <code>document.db</code> file (and any other files starting with <code>document.db</code>).</p>
<p>If you do not need to preserve any configurations that might be stored
in the <code>config.ini</code> file, you can just delete all of the <a href="../Installation%20%26%20Setup/Data%20directory.html">data directory's</a> contents
in the <code>config.ini</code> file, you can just delete all of the <a href="#root/_help_tAassRL4RSQL">data directory's</a> contents
to fully restore the application to its original state. You can also review
the <a href="Configuration%20(config.ini%20or%20e.html">configuration</a> file
to provide all <code>config.ini</code> values as environment variables instead.</p>
the <a href="#root/_help_Gzjqa934BdH4">configuration</a> file to provide
all <code>config.ini</code> values as environment variables instead.</p>
</div>
</div>
</body>

View File

@@ -16,15 +16,15 @@
<p>When you run Trilium for the first time, it will generate a new database
containing demo notes. These notes showcase its many features, such as:</p>
<ul>
<li><a class="reference-link" href="../../Note%20Types/Relation%20Map.html">Relation Map</a>
<li><a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a>
</li>
<li><a class="reference-link" href="../Advanced%20Showcases/Day%20Notes.html">Day Notes</a>
<li><a class="reference-link" href="#root/_help_l0tKav7yLHGF">Day Notes</a>
</li>
<li><a class="reference-link" href="../Advanced%20Showcases/Weight%20Tracker.html">Weight Tracker</a>
<li><a class="reference-link" href="#root/_help_R7abl2fc6Mxi">Weight Tracker</a>
</li>
<li><a class="reference-link" href="../Advanced%20Showcases/Task%20Manager.html">Task Manager</a>
<li><a class="reference-link" href="#root/_help_xYjQUYhpbUEW">Task Manager</a>
</li>
<li><a class="reference-link" href="../../Basic%20Concepts%20and%20Features/Themes.html">Themes</a>
<li><a class="reference-link" href="#root/_help_Wy267RK4M69c">Themes</a>
</li>
</ul>
<h3>Restoring Demo Notes</h3>

View File

@@ -20,7 +20,7 @@
of your <code>document.db</code> file.</p>
<h2>Modifying it internally using the SQL Console</h2>
<p>The SQL Console is Trilium's built-in database editor.</p>
<p>See&nbsp;<a class="reference-link" href="Manually%20altering%20the%20database/SQL%20Console.html">SQL Console</a>.</p>
<p>See&nbsp;<a class="reference-link" href="#root/_help_YKWqdJhzi2VY">SQL Console</a>.</p>
<h2>Externally modifying the database</h2>
<p>Sometimes the SQL Console cannot be used (for example if the application
cannot start).</p>
@@ -32,7 +32,7 @@
<p>To do so:</p>
<ol>
<li>In the main menu, select File → Open database… and navigate to the database
in the&nbsp;<a href="../../Installation%20%26%20Setup/Data%20directory.html">Data directory</a>.</li>
in the&nbsp;<a href="#root/_help_tAassRL4RSQL">Data directory</a>.</li>
<li>Select the <em>Execute SQL</em> tab.</li>
<li>Type in the desired SQL statement.</li>
<li>Press the "Play" button in the toolbar underneath the "Execute SQL" tab

View File

@@ -14,7 +14,7 @@
<div class="ck-content">
<p>The SQL Console is Trilium's built-in database editor.</p>
<p>It can be accessed by going to the <a href="../../../Basic%20Concepts%20and%20Features/UI%20Elements">global menu</a>
<p>It can be accessed by going to the <a href="#root/_help_Vc8PjrjAGuOp">global menu</a>
Advanced → Open SQL Console.</p>
<p>
<img src="SQL Console_image.png">
@@ -42,7 +42,7 @@
<h3>Saved SQL console</h3>
<p>SQL queries or commands can be saved into a dedicated note.</p>
<p>To do so, simply write the query and press the
<img src="2_SQL Console_image.png">button. Once saved, the note will appear in&nbsp;<a href="../../Advanced%20Showcases/Day%20Notes.html">Day Notes</a>.</p>
<img src="2_SQL Console_image.png">button. Once saved, the note will appear in&nbsp;<a href="#root/_help_l0tKav7yLHGF">Day Notes</a>.</p>
<ul>
<li>The SQL expression will not be displayed by default, but it can still
be viewed by going to the note context menu and selecting <em>Note source</em>.</li>

View File

@@ -18,7 +18,7 @@
note title.</p>
<p>For this use case, Trilium (since v0.52) supports <code>#titleTemplate</code>
<a
href="Attributes.html">label</a>. You can create such a label for a given note, assign it a value,
href="#root/_help_zEY4DaJG4YT5">label</a>. You can create such a label for a given note, assign it a value,
and this value will be used as a default title when creating child notes.
As with other labels, you can make it inheritable to apply recursively,
and you can even place it on the root note to have it applied globally
@@ -42,23 +42,31 @@
<p>The value of <code>#titleTemplate</code> is evaluated at the point of note's
creation as a JavaScript string, which means it can be enriched with the
help of JS string interpolation with dynamic data.</p>
<p>As an example, imagine you collect server outage incidents and write some
notes. It looks like this:</p>
<p>Second variable injected is <code>parentNote</code> which gives access to
the parent <a href="#root/_help_habiZ3HU8Kw8"><code>FNote</code></a>.</p>
<p>See also&nbsp;<a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>&nbsp;which
provides similar capabilities, including default note's content.</p>
<h3>Examples</h3>
<ul>
<li>Incidents
<li>Imagine you collect server outage incidents and write some notes. It looks
like this:
<ul>
<li>2022-05-09: System crash</li>
<li>2022-05-15: Backup delay</li>
<li>Incidents
<ul>
<li>2022-05-09: System crash</li>
<li>2022-05-15: Backup delay</li>
</ul>
</li>
<li>You can automatize the date assignment by assigning a label <code>#titleTemplate="${now.format('YYYY-MM-DD')}: "</code> to
the parent note "Incidents". Whenever a new child note is created, the
title template is evaluated with the injected <a href="https://day.js.org/docs/en/display/format">now</a> object.</li>
</ul>
</li>
<li>To use a parent's attribute in the title of new notes: <code>#titleTemplate="${parentNote.getLabelValue('authorName')}'s literary works"</code>
</li>
<li>To mirror the parent's note title: <code>${parentNote.title}</code>
</li>
</ul>
<p>You can automatize the date assignment by assigning a label <code>#titleTemplate="${now.format('YYYY-MM-DD')}: "</code> to
the parent note "Incidents". Whenever a new child note is created, the
title template is evaluated with the injected <a href="https://day.js.org/docs/en/display/format">now</a> object.</p>
<p>Second variable injected is <a href="https://triliumnext.github.io/Notes/backend_api/BNote.html">parentNote</a>,
an example could be <code>#titleTemplate="${parentNote.getLabelValue('authorName')}'s literary works"</code>.</p>
<p>See also [[<a href="Templates.html">template</a>]] which provides similar
capabilities, including default note's content.</p>
</div>
</div>
</body>

View File

@@ -0,0 +1,202 @@
<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>Hidden Notes</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Hidden Notes</h1>
<div class="ck-content">
<figure class="image image-style-align-right">
<img style="aspect-ratio:263/445;" src="Hidden Notes_image.png" width="263"
height="445">
</figure>
<p>For easy extensibility, a lot of features in Trilium make use of actual
notes to store information as opposed to having them stored in a separate
location in the database. This allows some functions such as&nbsp;<a class="reference-link"
href="#root/_help_zEY4DaJG4YT5">Attributes</a>,&nbsp;<a class="reference-link"
href="#root/_help_Cq5X6iKQop6R">Relations</a>&nbsp;or even&nbsp;<a class="reference-link"
href="#root/_help_eIg8jdvaoNNd">Search</a>&nbsp;and&nbsp;<a class="reference-link"
href="#root/_help_QEAPj01N5f7w">Links</a>&nbsp;to be able to operate on
them.</p>
<p>As the name suggests, these notes are hidden to the user by default to
prevent cluttering the note tree and to prevent them from being accidentally
deleted.</p>
<p>The hidden notes are stored in the user's&nbsp;<a class="reference-link"
href="#root/_help_wX4HbRucYSDD">Database</a>&nbsp;just like normal notes,
but they have a unique&nbsp;<a class="reference-link" href="#root/_help_m1lbrzyKDaRB">Note ID</a>&nbsp;which
allows them to be distinguished from the normal ones.</p>
<h2>Accessing the hidden note tree</h2>
<p>From the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>,
select <em>Advanced</em><em>Show Hidden Subtree</em>.</p>
<h2>Contents of the hidden note tree</h2>
<p>Here is a brief summary of all the notes within the hidden tree:</p>
<figure
class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:19.93%;">
<col style="width:80.07%;">
</colgroup>
<thead>
<tr>
<th>Note</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="reference-link" href="#root/_hidden/_help__globalNoteMap">Note Map</a>
</td>
<td>
<p>This note is actually opened when the&nbsp;<a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>&nbsp;feature
that is accessed from the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</p>
<p>It is possible to create any child notes in it without any additional
meaning. For example, it can be used to store a list of note maps which
can be linked to from other notes or <a href="#root/_help_u3YFHC9tQlpm">bookmarked</a>.</p>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_hidden/_help__sqlConsole">SQL Console History</a>
</td>
<td>
<p>When SQL queries or commands are executed in the&nbsp;<a class="reference-link"
href="#root/_help_YKWqdJhzi2VY">SQL Console</a>, they are stored here,
grouped by month. Only the query is stored and not the results.</p>
<p>This section can be accessed without going to the hidden tree by simply
going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
selecting Advanced → Open SQL Console History.</p>
<p>Notes can be added as children of this tree, but it's generally not recommended
to do so to not interfere with the normal history process.</p>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_hidden/_help__search">Search History</a>
</td>
<td>
<p>Whenever a search is executed from the full&nbsp;<a class="reference-link"
href="#root/_help_eIg8jdvaoNNd">Search</a>, the query will be stored here,
grouped by month. Only the search parameters are stored and not the results
themselves.</p>
<p>This section can be accessed without going to the hidden tree by simply
going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
selecting Advanced → Open Search History.</p>
<p>Notes can be added as children of this tree, but it's generally not recommended
to do so to not interfere with the normal history process.</p>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_hidden/_help__bulkAction">Bulk Action</a>
</td>
<td>
<p>This section is used for&nbsp;<a class="reference-link" href="#root/_help_ivYnonVFBxbQ">Bulk Actions</a>.
The last configuration for bulk actions will be stored as part of this
note, each action in its own <code>action</code> label.</p>
<p>Notes can be added as children of this tree, but there won't be any benefit
in doing so.</p>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_hidden/_help__backendLog">Backend Log</a>
</td>
<td>
<p>This note corresponds to the backend log feature (see&nbsp;<a class="reference-link"
href="#root/_help_qzNzp9LYQyPT">Error logs</a>).</p>
<p>This item can be accessed without going to the hidden try by going to
the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
selecting Advanced → Show backend log.</p>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_hidden/_help__userHidden">User Hidden</a>
</td>
<td>This section can be used by <a href="#root/_help_CdNpE2pqjmI6">scripts</a> to
create their own notes that should not be directly visible to the user.
The note can be identified by scripts by its unique ID: <code>_userHidden</code>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_hidden/_help__lbTplRoot">Launch Bar Templates</a>
</td>
<td>
<p>This section contains the templates for the creation of launchers in the&nbsp;
<a
class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>. It is not possible to create child notes here.</p>
<p>Theoretically some of the notes here can be customized, but there's not
much benefit to be had in doing so.</p>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_hidden/_help__share">Shared Notes</a>
</td>
<td>
<p>This tree lists all of the notes that are <a href="#root/_help_R9pX4DGra2Vt">shared</a> publicly.
It can be useful to track down which notes are shared regardless of their
position in the note tree.</p>
<p>This section can be accessed without going to the hidden tree simply by
going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
selecting <em>Show Shared Notes Subtree</em>.</p>
<p>Sub-notes cannot be created here.</p>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_hidden/_help__lbRoot">Launch Bar</a>
</td>
<td>
<p>The tree contains both available and displayed items of the&nbsp;<a class="reference-link"
href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</p>
<p>This section can be accessed without going to the hidden tree by:</p>
<ul>
<li>Going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
selecting <em>Configure Launchbar</em>.</li>
<li>Right-clicking an empty space on the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>&nbsp;and
selecting <em>Configure Launchbar</em>.</li>
</ul>
<p>Sub-notes cannot be created here.</p>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_hidden/_help__options">Options</a>
</td>
<td>
<p>This section stores the list of&nbsp;<a class="reference-link" href="#root/_help_4TIF1oA4VQRO">Options</a>.</p>
<p>This section can be accessed without going to the hidden tree by:</p>
<ul>
<li>Going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
selecting <em>Options</em>.</li>
<li>Pressing the dedicated Options icon in the&nbsp;<a class="reference-link"
href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_hidden/_help__lbMobileRoot">Mobile Launch Bar</a>
</td>
<td>
<p>This is very similar to the <em>Launch Bar</em>, but is dedicated for the
mobile UI only.</p>
<p>Accessing it outside the <em>Launch Bar</em> is the same as the Launch Bar,
but needs to be done so from the mobile interface.</p>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_hidden/_help__help">User Guide</a>
</td>
<td>This is where the note structure for the User Guide is actually stored.
Only the metadata is stored, as the help itself is present as actual files
in the application directory.</td>
</tr>
</tbody>
</table>
</figure>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

View File

@@ -22,7 +22,7 @@
<p>When notes are exported, their note ID is kept in the metadata of the
export. However when they are imported back in, a new note ID is generated
for all the notes. This also includes other entities that are part of the
import/export process such as&nbsp;<a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Attachments.html">Attachments</a>.</p>
import/export process such as&nbsp;<a class="reference-link" href="#root/_help_0vhv7lsOLy82">Attachments</a>.</p>
<h2>Note collisions</h2>
<p>Since the Note ID is a fixed-width randomly generated number, due to the
<a

View File

@@ -21,7 +21,7 @@
<li>Note Map, which shows the hierarchical tree structure.</li>
</ul>
<h2>Link Map</h2>
<p>Shows <a href="Attributes.html">relations</a> between notes:</p>
<p>Shows <a href="#root/_help_zEY4DaJG4YT5">relations</a> between notes:</p>
<p>
<img src="1_Note Map (Link map, Tree m.png">
</p>
@@ -33,11 +33,11 @@
<h2>Dedicated note type</h2>
<p>Apart from the note map feature which can be accessed from any note, it
is also possible to create a dedicated note which will display the relations
in full screen. See&nbsp;<a href="../Note%20Types/Note%20Map.html">Note Map</a>&nbsp;for
in full screen. See&nbsp;<a href="#root/_help_bdUJEHsAPYQR">Note Map</a>&nbsp;for
more information.</p>
<h2>See also</h2>
<p><a href="../Note%20Types/Relation%20Map.html">Relation map</a> is a similar
concept, with some differences:</p>
<p><a href="#root/_help_iRwzGnHPzonm">Relation map</a> is a similar concept,
with some differences:</p>
<ul>
<li>note map is automatically generated while relation map must be created
manually</li>

View File

@@ -15,48 +15,47 @@
<div class="ck-content">
<h2>Understanding the source code of the different notes</h2>
<p>Internally, the structure of the content of each note is different based
on the&nbsp;<a class="reference-link" href="../Note%20Types.html">Note Types</a>.</p>
on the&nbsp;<a class="reference-link" href="#root/_help_KSZ04uQ2D1St">Note Types</a>.</p>
<p>For example:</p>
<ul>
<li><a class="reference-link" href="../Note%20Types/Text.html">Text</a>&nbsp;notes&nbsp;are
<li><a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;notes&nbsp;are
represented internally as HTML, using the&nbsp;<a class="reference-link"
href="Technologies%20used/CKEditor.html">CKEditor</a>&nbsp;representation.
Note that due to the custom plugins, some HTML elements are specific to
Trilium only, for example the admonitions.</li>
<li><a class="reference-link" href="../Note%20Types/Code.html">Code</a>&nbsp;notes&nbsp;are
href="#root/_help_MI26XDLSAlCD">CKEditor</a>&nbsp;representation. Note
that due to the custom plugins, some HTML elements are specific to Trilium
only, for example the admonitions.</li>
<li><a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;notes&nbsp;are
plain text and are represented internally as-is.</li>
<li><a class="reference-link" href="../Note%20Types/Geo%20Map.html">Geo Map</a>&nbsp;notes
<li><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map</a>&nbsp;notes
contain only minimal information (viewport, zoom) as a JSON.</li>
<li><a class="reference-link" href="../Note%20Types/Canvas.html">Canvas</a>&nbsp;notes
<li><a class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a>&nbsp;notes
are represented as JSON, with Trilium's own information alongside with&nbsp;
<a
class="reference-link" href="Technologies%20used/Excalidraw.html">Excalidraw</a>'s internal JSON representation format.</li>
<li><a class="reference-link" href="../Note%20Types/Mind%20Map.html">Mind Map</a>&nbsp;notes
class="reference-link" href="#root/_help_H0mM1lTxF9JI">Excalidraw</a>'s internal JSON representation format.</li>
<li><a class="reference-link" href="#root/_help_gBbsAeiuUxI5">Mind Map</a>&nbsp;notes
are represented as JSON, with the internal format of&nbsp;<a class="reference-link"
href="Technologies%20used/MindElixir.html">MindElixir</a>.</li>
href="#root/_help_N4IDkixaDG9C">MindElixir</a>.</li>
</ul>
<p>Note that some information is also stored as&nbsp;<a class="reference-link"
href="../Basic%20Concepts%20and%20Features/Notes/Attachments.html">Attachments</a>.
For example&nbsp;<a class="reference-link" href="../Note%20Types/Canvas.html">Canvas</a>&nbsp;notes
use the attachments feature to store the custom libraries, and alongside
with&nbsp;<a class="reference-link" href="../Note%20Types/Mind%20Map.html">Mind Map</a>&nbsp;and
other similar note types it stores an SVG representation of the content
for use in other features such as including in other notes, shared notes,
etc.</p>
href="#root/_help_0vhv7lsOLy82">Attachments</a>. For example&nbsp;<a class="reference-link"
href="#root/_help_grjYqerjn243">Canvas</a>&nbsp;notes use the attachments
feature to store the custom libraries, and alongside with&nbsp;<a class="reference-link"
href="#root/_help_gBbsAeiuUxI5">Mind Map</a>&nbsp;and other similar note
types it stores an SVG representation of the content for use in other features
such as including in other notes, shared notes, etc.</p>
<p>Here's part of the HTML representation of this note, as it's stored in
the database (but prettified).</p><pre><code class="language-text-x-trilium-auto">&lt;h2&gt;
Understanding the source code of the different notes
&lt;/h2&gt;
&lt;p&gt;
Internally, the structure of the content of each note is different based on the&amp;nbsp;
&lt;a class="reference-link" href="../Note%20Types.html"&gt;
&lt;a class="reference-link" href="#root/_help_KSZ04uQ2D1St"&gt;
Note Types
&lt;/a&gt;
.
&lt;/p&gt;</code></pre>
<h2>Viewing the source code</h2>
<p>It is possible to view the source code of a note by pressing the contextual
menu in&nbsp;<a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20buttons.html">Note buttons</a>&nbsp;and
menu in&nbsp;<a class="reference-link" href="#root/_help_8YBEPzcpUgxw">Note buttons</a>&nbsp;and
selecting <em>Note source</em>.</p>
<p>
<img src="Note source_image.png">

View File

@@ -17,8 +17,9 @@
documents. This feature is particularly useful for publishing content directly
from your Trilium notes, making it accessible to others online.</p>
<h2>Prerequisites</h2>
<p>To use the sharing feature, you must have a <a href="../Installation%20%26%20Setup/Server%20Installation.html">server installation</a> of
Trilium. This is necessary because the notes will be hosted from the server.</p>
<p>To use the sharing feature, you must have a&nbsp;<a class="reference-link"
href="#root/_help_WOcw2SLH6tbX">Server Installation</a>&nbsp;of Trilium.
This is necessary because the notes will be hosted from the server.</p>
<h2>How to Share a Note</h2>
<ol>
<li>
@@ -58,20 +59,21 @@
<h3>Password Protection</h3>
<p>To protect shared notes with a username and password, you can use the <code>#shareCredentials</code> attribute.
Add this label to the note with the format <code>#shareCredentials="username:password"</code>.
To protect an entire subtree, make sure the label is <a href="Attributes/Attribute%20Inheritance.html">inheritable</a>.</p>
To protect an entire subtree, make sure the label is <a href="#root/_help_bwZpz2ajCEwO">inheritable</a>.</p>
<h2>Advanced Sharing Options</h2>
<h3>Customizing the Appearance of Shared Notes</h3>
<p>The default shared page is basic in design, but you can customize it using
your own CSS:</p>
<ul>
<li><strong>Custom CSS</strong>: Link a CSS <a href="../Note%20Types/Code.html">code note</a> to
the shared page by adding a <code>~shareCss</code> relation to the note.
If you want this style to apply to the entire subtree, make the label inheritable.
You can hide the CSS code note from the tree navigation by adding the <code>#shareHiddenFromTree</code> label.</li>
<li><strong>Custom CSS</strong>: Link a CSS&nbsp;<a class="reference-link"
href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;note to the shared page by
adding a <code>~shareCss</code> relation to the note. If you want this style
to apply to the entire subtree, make the label inheritable. You can hide
the CSS code note from the tree navigation by adding the <code>#shareHiddenFromTree</code> label.</li>
<li><strong>Omitting Default CSS</strong>: For extensive styling changes,
use the <code>#shareOmitDefaultCss</code> label to avoid conflicts with Trilium's
<a
href="../Basic%20Concepts%20and%20Features/Themes.html">default stylesheet</a>.</li>
href="#root/_help_Wy267RK4M69c">default stylesheet</a>.</li>
</ul>
<h3>Adding JavaScript</h3>
<p>You can inject custom JavaScript into the shared note using the <code>~shareJs</code> relation.
@@ -112,16 +114,6 @@ for (const attr of parentNote.attributes) {
making it easier to use Trilium as a fully-fledged website. Consider combining
this with the <code>#shareIndex</code> label, which will display a list of
all shared notes.</p>
<h2>Additional Options</h2>
<ul>
<li><strong>Raw Note Sharing</strong>: Use the <code>#shareRaw</code> label
to share a note without any HTML wrapper.</li>
<li><strong>Disallow Robot Indexing</strong>: Add the <code>#shareDisallowRobotIndexing</code> label
to prevent search engines from indexing the shared page by including a <code>noindex, follow</code> meta
tag and <code>X-Robots-Tag: noindex</code> header.</li>
<li><strong>Shared Notes Index</strong>: For text notes with the <code>#shareIndex</code> label,
the content will display a list of all shared note roots.</li>
</ul>
<h2>Limitations</h2>
<p>While the sharing feature is powerful, it has some limitations:</p>
<ul>
@@ -135,6 +127,84 @@ for (const attr of parentNote.attributes) {
<li><strong>Include Notes</strong>: Not supported.</li>
</ul>
<p>Some of these limitations may be addressed in future updates.</p>
<h2>Attribute reference</h2>
<figure class="table">
<table>
<thead>
<tr>
<th>Attribute</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>shareHiddenFromTree</code>
</td>
<td>this note is hidden from left navigation tree, but still accessible with
its URL</td>
</tr>
<tr>
<td><code>shareExternalLink</code>
</td>
<td>note will act as a link to an external website in the share tree</td>
</tr>
<tr>
<td><code>shareAlias</code>
</td>
<td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code>
</td>
</tr>
<tr>
<td><code>shareOmitDefaultCss</code>
</td>
<td>default share page CSS will be omitted. Use when you make extensive styling
changes.</td>
</tr>
<tr>
<td><code>shareRoot</code>
</td>
<td>marks note which is served on /share root.</td>
</tr>
<tr>
<td><code>shareDescription</code>
</td>
<td>define text to be added to the HTML meta tag for description</td>
</tr>
<tr>
<td><code>shareRaw</code>
</td>
<td>Note will be served in its raw format, without HTML wrapper. See also&nbsp;
<a
class="reference-link" href="#root/_help_Qjt68inQ2bRj">Serving directly the content of a note</a>&nbsp;for an alternative method
without setting an attribute.</td>
</tr>
<tr>
<td><code>shareDisallowRobotIndexing</code>
</td>
<td>
<p>Indicates to web crawlers that the page should not be indexed of this
note by:</p>
<ul>
<li>Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li>
<li>Setting the <code>noindex, follow</code> meta tag.</li>
</ul>
</td>
</tr>
<tr>
<td><code>shareCredentials</code>
</td>
<td>require credentials to access this shared note. Value is expected to be
in format <code>username:password</code>. Don't forget to make this inheritable
to apply to child-notes/images.</td>
</tr>
<tr>
<td><code>shareIndex</code>
</td>
<td>Note with this label will list all roots of shared notes.</td>
</tr>
</tbody>
</table>
</figure>
</div>
</div>
</body>

View File

@@ -15,7 +15,7 @@
<div class="ck-content">
<p>One core aspect of Trilium that allows it to have support for multiple&nbsp;
<a
href="../Note%20Types.html">Note Types</a>&nbsp;is the fact that it makes use of various off-the-shelf
href="#root/_help_KSZ04uQ2D1St">Note Types</a>&nbsp;is the fact that it makes use of various off-the-shelf
or reusable libraries.</p>
<p>The sub-pages showcase some of the technologies used, for a better understanding
of how Trilium works but also to credit the developers of that particular

View File

@@ -15,7 +15,7 @@
<div class="ck-content">
<h2>Editor core</h2>
<p>The CKEditor is the WYSIWYG (standing for What You See Is What You Get)
editor behind&nbsp;<a href="../../Note%20Types/Text.html">Text</a>&nbsp;notes.</p>
editor behind&nbsp;<a href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;notes.</p>
<p>Their website is <a href="https://ckeditor.com/">ckeditor.com</a>.</p>
<p>CKEditor by itself is a commercial product, but the core is open-source.
As described in <a href="https://ckeditor.com/docs/ckeditor5/latest/features/index.html">its documentation</a>,

View File

@@ -14,8 +14,8 @@
<div class="ck-content">
<p><a href="https://excalidraw.com/">Excalidraw</a> is the technology behind
the&nbsp;<a href="../../Note%20Types/Canvas.html">Canvas</a>&nbsp;notes.
The source code of the library is available on <a href="https://github.com/excalidraw/excalidraw">GitHub</a>.</p>
the&nbsp;<a href="#root/_help_grjYqerjn243">Canvas</a>&nbsp;notes. The
source code of the library is available on <a href="https://github.com/excalidraw/excalidraw">GitHub</a>.</p>
<p>We are using an unmodified version of it, so it shares the same <a href="https://github.com/excalidraw/excalidraw/issues">issues</a> as
the original.</p>
</div>

View File

@@ -13,7 +13,7 @@
<h1 data-trilium-h1>Leaflet</h1>
<div class="ck-content">
<p>Leaflet is the library behind&nbsp;<a href="../../Note%20Types/Geo%20Map.html">Geo map</a>&nbsp;notes.</p>
<p>Leaflet is the library behind&nbsp;<a href="#root/_help_81SGnPGMk7Xc">Geo map</a>&nbsp;notes.</p>
<h2>Plugins</h2>
<p>Leaflet is also highly customizable via external plugins.</p>
<p>Currently we use:</p>

View File

@@ -13,7 +13,7 @@
<h1 data-trilium-h1>MindElixir</h1>
<div class="ck-content">
<p>MindElixir is the library we are using for the&nbsp;<a href="../../Note%20Types/Mind%20Map.html">Mind Map</a>&nbsp;note
<p>MindElixir is the library we are using for the&nbsp;<a href="#root/_help_gBbsAeiuUxI5">Mind Map</a>&nbsp;note
types.</p>
<p>The main library is available on <a href="https://github.com/SSShooter/mind-elixir-core/issues">GitHub as mind-elixir-core</a>.</p>
<p>The library is embedded as-is without additional modifications.</p>

View File

@@ -18,10 +18,10 @@
main effects:</p>
<ol>
<li><strong>Attribute Inheritance</strong>: All attributes from the template
note are <a href="Attributes/Attribute%20Inheritance.html">inherited</a> by
the instance notes. Even attributes with <code>#isInheritable=false</code> are
inherited by the instance notes, although only inheritable attributes are
further inherited by the children of the instance notes.</li>
note are <a href="#root/_help_bwZpz2ajCEwO">inherited</a> by the instance
notes. Even attributes with <code>#isInheritable=false</code> are inherited
by the instance notes, although only inheritable attributes are further
inherited by the children of the instance notes.</li>
<li><strong>Content Duplication</strong>: The content of the template note
is copied to the instance note, provided the instance note is empty at
the time of template assignment.</li>
@@ -32,7 +32,7 @@
<p>A typical example would be a "Book" template note, which might include:</p>
<ul>
<li><strong>Promoted Attributes</strong>: Such as publication year, author,
etc. (see <a href="Attributes/Promoted%20Attributes.html">promoted attributes</a>).</li>
etc. (see <a href="#root/_help_OFXdgB2nNk1F">promoted attributes</a>).</li>
<li><strong>Outline</strong>: An outline for a book review, including sections
like themes, conclusion, etc.</li>
<li><strong>Child Notes</strong>: Additional notes for highlights, summary,
@@ -51,7 +51,7 @@
</p>
<p>For the template to appear in the menu, the template note must have the <code>#template</code> label.
Do not confuse this with the <code>~template</code> relation, which links
the instance note to the template note. If you use <a href="../Basic%20Concepts%20and%20Features/Navigation/Workspace.html">workspaces</a>,
the instance note to the template note. If you use <a href="#root/_help_9sRHySam5fXb">workspaces</a>,
you can also mark templates with <code>#workspaceTemplate</code> to display
them only in the workspace.</p>
<p>Templates can also be added or changed after note creation by creating
@@ -60,11 +60,11 @@
<p>From a visual perspective, templates can define <code>#iconClass</code> and <code>#cssClass</code> attributes,
allowing all instance notes (e.g., books) to display a specific icon and
CSS style.</p>
<p>Explore the concept further in the <a href="Database.html">demo notes</a>,
including examples like the <a href="../Note%20Types/Relation%20Map.html">Relation Map</a>,
<p>Explore the concept further in the <a href="#root/_help_wX4HbRucYSDD">demo notes</a>,
including examples like the <a href="#root/_help_iRwzGnHPzonm">Relation Map</a>,
<a
href="Advanced%20Showcases/Task%20Manager.html">Task Manager</a>, and <a href="Advanced%20Showcases/Day%20Notes.html">Day Notes</a>.</p>
<p>Additionally, see <a href="Default%20Note%20Title.html">default note title</a> for
href="#root/_help_xYjQUYhpbUEW">Task Manager</a>, and <a href="#root/_help_l0tKav7yLHGF">Day Notes</a>.</p>
<p>Additionally, see <a href="#root/_help_47ZrP6FNuoG8">default note title</a> for
creating title templates. Note templates and title templates can be combined
by creating a <code>#titleTemplate</code> for a template note.</p>
</div>

View File

@@ -13,9 +13,8 @@
<h1 data-trilium-h1>Markdown</h1>
<div class="ck-content">
<p>Trilium Notes supports importing Markdown restricted to the <a href="https://spec.commonmark.org/current/">CommonMark specification</a> (where
<a
href="https://github.com/TriliumNext/Notes/issues/2026">tables are not supported</a>)</p>
<p>Trilium supports Markdown for both import and export, while trying to
keep compatibility as high as possible.</p>
<h2>Import</h2>
<h3>Clipboard import</h3>
<p>If you want to import just a chunk of markdown from clipboard, you can
@@ -57,6 +56,23 @@
<p>If you want to export protected notes, enter a protected session first!
This will export the notes in an unencrypted form, so if you reimport into
Trilium, make sure to re-protect these notes.</p>
<h2>Supported syntax</h2>
<ul>
<li><a href="https://github.github.com/gfm/">GitHub-Flavored Markdown</a> is
the main syntax that Trilium is following.</li>
<li>Images are supported. When exporting, images are usually kept in the basic
Markdown syntax but will use the HTML syntax if the image has a custom
width. Figures are always embedded as HTML.</li>
<li>Tables are supported with the Markdown syntax. If the table is too complex
or contains elements that would render as HTML, the table is also rendered
as HTML.</li>
<li><a class="reference-link" href="#root/_help_NwBbFdNZ9h7O">Admonitions</a>&nbsp;are
supported using GitHub's format.</li>
<li>Links are supported. “Reference links” (internal links that mirror a note's
title and display its icon) are embedded as HTML in order to preserve the
information on import.</li>
<li>Math equations are supported using <code>$</code> and <code>$$</code> syntaxes.</li>
</ul>
</div>
</div>
</body>

View File

@@ -28,7 +28,7 @@
<li><kbd><span></span></kbd>, <kbd><span></span></kbd> - collapse/expand node</li>
<li><kbd>Alt</kbd> + <kbd><span></span></kbd>, <kbd>Alt</kbd> + <kbd><span></span></kbd> -
go back / forwards in the history</li>
<li><kbd>Ctrl</kbd> + <kbd>J</kbd> - show <a href="Navigation/Note%20Navigation.html">"Jump to" dialog</a>
<li><kbd>Ctrl</kbd> + <kbd>J</kbd> - show <a href="#root/_help_MMiBEQljMQh2">"Jump to" dialog</a>
</li>
<li><kbd>Ctrl</kbd> + <kbd>.</kbd> - scroll to current note (useful when you
scroll away from your note or your focus is currently in the editor)</li>
@@ -36,13 +36,13 @@
<li><kbd>Alt</kbd> + <kbd>C</kbd> - collapse whole note tree</li>
<li><kbd>Alt</kbd> + <kbd>-</kbd> (alt with minus sign) - collapse subtree (if
some subtree takes too much space on tree pane you can collapse it)</li>
<li>you can define a <a href="../Advanced%20Usage/Attributes.html">label</a> <code>#keyboardShortcut</code> with
<li>you can define a <a href="#root/_help_zEY4DaJG4YT5">label</a> <code>#keyboardShortcut</code> with
e.g. value <kbd>Ctrl</kbd> + <kbd>I</kbd> . Pressing this keyboard combination
will then bring you to the note on which it is defined. Note that Trilium
must be reloaded/restarted (<kbd>Ctrl</kbd> + <kbd>R</kbd> ) for changes to
be in effect.</li>
</ul>
<p>See demo of some of these features in <a href="Navigation/Note%20Navigation.html">note navigation</a>.</p>
<p>See demo of some of these features in <a href="#root/_help_MMiBEQljMQh2">note navigation</a>.</p>
<h2>Tabs</h2>
<ul>
<li><kbd>Ctrl</kbd> + <kbd>🖱 Left click</kbd> - (or middle mouse click) on note
@@ -59,8 +59,8 @@
<ul>
<li><code>CTRL+O</code> - creates new note after the current note</li>
<li><code>CTRL+P</code> - creates new sub-note into current note</li>
<li><code>F2</code> - edit <a href="Navigation/Note%20Navigation.html">prefix</a> of
current note clone</li>
<li><code>F2</code> - edit <a href="#root/_help_MMiBEQljMQh2">prefix</a> of current
note clone</li>
</ul>
<h2>Moving / cloning notes</h2>
<ul>
@@ -75,7 +75,7 @@
<li><kbd>Shift</kbd>+<kbd>🖱 Left click</kbd> - multi select note which you
clicked on</li>
<li><kbd>Ctrl</kbd>+<kbd>C</kbd> - copies current note (or current selection)
into clipboard (used for <a href="Notes/Cloning%20Notes.html">cloning</a>
into clipboard (used for <a href="#root/_help_IakOLONlIfGI">cloning</a>
</li>
<li><kbd>Ctrl</kbd>+<kbd>X</kbd> - cuts current (or current selection) note
into clipboard (used for moving notes)</li>
@@ -85,8 +85,8 @@
<li><kbd>Del</kbd> - delete note / sub-tree</li>
</ul>
<h2>Editing notes</h2>
<p>Trilium uses CKEditor 5 for the <a href="../Note%20Types/Text.html">text notes</a> and
CodeMirror 5 for <a href="../Note%20Types/Code.html">code notes</a>. Check
<p>Trilium uses CKEditor 5 for the <a href="#root/_help_iPIMuisry3hd">text notes</a> and
CodeMirror 5 for <a href="#root/_help_6f9hih2hXXZk">code notes</a>. Check
the documentation of these projects to see all their built-in keyboard
shortcuts.</p>
<ul>
@@ -97,9 +97,9 @@
<li><kbd>Enter</kbd> in tree pane switches from tree pane into note title.
Enter from note title switches focus to text editor. <kbd>Ctrl</kbd>+<kbd>.</kbd> switches
back from editor to tree pane.</li>
<li><kbd>Ctrl</kbd>+<kbd>K</kbd> - create / edit <a href="../Note%20Types/Text/Links.html">external link</a>
<li><kbd>Ctrl</kbd>+<kbd>K</kbd> - create / edit <a href="#root/_help_QEAPj01N5f7w">external link</a>
</li>
<li><kbd>Ctrl</kbd>+<kbd>L</kbd> - create <a href="../Note%20Types/Text/Links.html">internal (note) link</a>
<li><kbd>Ctrl</kbd>+<kbd>L</kbd> - create <a href="#root/_help_QEAPj01N5f7w">internal (note) link</a>
</li>
<li><kbd>Alt</kbd>+<kbd>T</kbd> - inserts current date and time at caret position</li>
<li><kbd>Ctrl</kbd>+<kbd>.</kbd> - jump away from the editor to tree pane and
@@ -122,9 +122,9 @@
<li><kbd>Alt</kbd>+<kbd>M</kbd> - distraction-free mode - display only note
editor, everything else is hidden</li>
<li><kbd>F11</kbd> - toggle full screen</li>
<li><kbd>Ctrl</kbd> + <kbd>S</kbd> - toggle <a href="Navigation/Search.html">search</a> form
<li><kbd>Ctrl</kbd> + <kbd>S</kbd> - toggle <a href="#root/_help_eIg8jdvaoNNd">search</a> form
in tree pane</li>
<li><kbd>Alt</kbd> +<kbd>A</kbd> - show note <a href="../Advanced%20Usage/Attributes.html">attributes</a> dialog</li>
<li><kbd>Alt</kbd> +<kbd>A</kbd> - show note <a href="#root/_help_zEY4DaJG4YT5">attributes</a> dialog</li>
</ul>
</div>
</div>

View File

@@ -22,7 +22,7 @@
a full search or create notes.</p>
<h2>Entering jump to note</h2>
<ul>
<li>In the&nbsp;<a class="reference-link" href="../UI%20Elements/Launch%20Bar.html">Launch Bar</a>,
<li>In the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>,
press
<img src="1_Jump to Note_image.png">button.</li>
<li>Using the keyboard, press <kbd>Ctrl</kbd> + <kbd>J</kbd>.</li>

View File

@@ -20,9 +20,10 @@
<img src="Note Hoisting_note-hoistin.gif">
</p>
<p>In addition to showing only this subtree, this also narrows both full
text search and <a href="Note%20Navigation.html">“jump to note”</a> to just
notes present in hoisted subtree.</p>
<p>See also <a href="Workspace.html">Workspace</a> which extends this feature.</p>
text search and <a href="#root/_help_MMiBEQljMQh2">“jump to note”</a> to
just notes present in hoisted subtree.</p>
<p>See also <a href="#root/_help_9sRHySam5fXb">Workspace</a> which extends
this feature.</p>
</div>
</div>
</body>

View File

@@ -27,7 +27,7 @@
<p>This is useful to quickly find and view arbitrary notes - click on <code>Jump to</code> button
on the top or press <kbd>Ctrl</kbd> + <kbd>J</kbd> . Then type part of the
note name and autocomplete will help you pick the desired note.</p>
<p>See&nbsp;<a class="reference-link" href="Jump%20to%20Note.html">Jump to Note</a>&nbsp;for
<p>See&nbsp;<a class="reference-link" href="#root/_help_F1r9QtzQLZqm">Jump to Note</a>&nbsp;for
more information.</p>
</div>
</div>

View File

@@ -21,20 +21,20 @@
searches through the content of notes and not just the title of a note)
and displays the result in an easy-to-access manner.</p>
<p>The alternative to the quick search is the&nbsp;<a class="reference-link"
href="Search.html">Search</a>&nbsp;function, which opens in a dedicated
tab and has support for advanced queries.</p>
href="#root/_help_eIg8jdvaoNNd">Search</a>&nbsp;function, which opens in
a dedicated tab and has support for advanced queries.</p>
<p>For even faster navigation, it's possible to use&nbsp;<a class="reference-link"
href="Jump%20to%20Note.html">Jump to Note</a>&nbsp;which will only search
href="#root/_help_F1r9QtzQLZqm">Jump to Note</a>&nbsp;which will only search
through the note titles instead of the content.</p>
<h2>Layout</h2>
<p>Based on the&nbsp;<a class="reference-link" href="../UI%20Elements/Vertical%20and%20horizontal%20layout.html">Vertical and horizontal layout</a>,
<p>Based on the&nbsp;<a class="reference-link" href="#root/_help_x0JgW8UqGXvq">Vertical and horizontal layout</a>,
the quick search is placed:</p>
<ul>
<li>On the vertical layout, it is displayed right above the&nbsp;<a class="reference-link"
href="../UI%20Elements/Note%20Tree.html">Note Tree</a>.</li>
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li>On the horizontal layout, it is displayed in the&nbsp;<a class="reference-link"
href="../UI%20Elements/Launch%20Bar.html">Launch Bar</a>, where it can
be positioned just like any other icon.</li>
href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>, where it can be positioned
just like any other icon.</li>
</ul>
</div>
</div>

View File

@@ -0,0 +1,68 @@
<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>Search in note</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Search in note</h1>
<div class="ck-content">
<figure class="image image_resized" style="width:100%;">
<img style="aspect-ratio:898/93;" src="Search in note_image.png" width="898"
height="93">
</figure>
<p>Local search allows you to search within the currently displayed note.&nbsp;</p>
<h2>Alternatives</h2>
<ul>
<li>Pressing Ctrl+F while in a browser while not focused in a&nbsp;<a class="reference-link"
href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;or a&nbsp;<a class="reference-link"
href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;note will trigger the browser's
native search. This will also find text that is part of Trilium's UI.</li>
<li>Pressing Ctrl+F in a&nbsp;<a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;note
will reveal&nbsp;<a class="reference-link" href="#root/_help_MI26XDLSAlCD">CKEditor</a>'s
search functionality.</li>
</ul>
<h2>Accessing the search</h2>
<ul>
<li>On desktop, press<kbd>Ctrl</kbd> + <kbd>F</kbd>
</li>
<li>From the&nbsp;<a class="reference-link" href="#root/_help_8YBEPzcpUgxw">Note buttons</a>,
look for the context menu and select <em>Search in note</em>.</li>
</ul>
<h2>Interaction</h2>
<ul>
<li>Finding:
<ul>
<li>Fill in the <em>Find in text…</em> with the text to search for.</li>
<li>The search will be executed automatically in the background.</li>
<li>Use up and down arrows of the text box to navigate between results.</li>
</ul>
</li>
<li>Replacing:
<ul>
<li>Fill in the <em>Find in text</em>… field with the text to replace.</li>
<li>Fill in the <em>Replace with…</em> field the text to replace it with.</li>
<li>Press <em>Replace</em> to replace only the current result.</li>
<li>Press <em>Replace all</em> to replace all of them at once.</li>
</ul>
</li>
<li>Options:
<ul>
<li><em>Case sensitive</em> the search will distinguish upper case characters
from lower case (e.g. searching for Hello will not match <code>hello</code>).</li>
<li><em>Match words</em> - the search will find only exact word matches (e.g.
searching for <code>Java</code> will not match <code>JavaScript</code>).</li>
</ul>
</li>
</ul>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

View File

@@ -13,19 +13,124 @@
<h1 data-trilium-h1>Search</h1>
<div class="ck-content">
<h2>Local Search</h2>
<p>Local search allows you to search within the currently displayed note.
To initiate a local search, press <kbd>Ctrl</kbd> + <kbd>F</kbd>. If using
a web browser, this will be handled by the browser's native search functionality.
In the desktop (electron) version, a separate dialog will apear.</p>
<h2>Note Search</h2>
<figure class="image">
<img style="aspect-ratio:987/725;" src="Search_image.png" width="987"
height="725">
</figure>
<p>Note search enables you to find notes by searching for text in the title,
content, or <a href="../../Advanced%20Usage/Attributes.html">attributes</a> of
the notes. You also have the option to save your searches, which will create
a special search note which is visible on your navigation tree and contains
the search results as sub-items.</p>
content, or <a href="#root/_help_zEY4DaJG4YT5">attributes</a> of the notes.
You also have the option to save your searches, which will create a special
search note which is visible on your navigation tree and contains the search
results as sub-items.</p>
<h2>Accessing the search</h2>
<ul>
<li>From the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>,
look for the dedicated search button.</li>
<li>To limit the search to a note and its children, select <em>Search from subtree</em> from
the&nbsp;<a class="reference-link" href="#root/_help_YtSN43OrfzaA">Note tree contextual menu</a>&nbsp;or
press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd>.</li>
</ul>
<h2>Interaction</h2>
<p>To search for notes, click on the magnifying glass icon on the toolbar
or press the <kbd>Ctrl</kbd> + <kbd>S</kbd> keyboard <a href="../Keyboard%20Shortcuts.html">shortcut</a>.</p>
or press the keyboard <a href="#root/_help_A9Oc6YKKc65v">shortcut</a>.</p>
<ol>
<li>Set the text to search for in the <em>Search string</em> field.
<ol>
<li>Apart from searching for words ad-literam, there is also the possibility
to search for attributes or properties of notes.</li>
<li>See the examples below for more information.</li>
</ol>
</li>
<li>To limit the search to a note and its sub-children, set a note in <em>Ancestor</em>.
<ol>
<li>This value is also pre-filled if the search is triggered from a <a href="#root/_help_OR8WJ7Iz9K4U">hoisted note</a> or
a <a href="#root/_help_9sRHySam5fXb">workspace</a>.</li>
<li>To search the entire database, keep the value empty.</li>
</ol>
</li>
<li>To limit the search to only a few levels of hierarchy (e.g. look in sub-children
but not in sub-sub-children of a note), set the <em>depth</em> field to one
of the provided values.</li>
<li>In addition to that, the search can be configured via the <em>Add search options</em> buttons,
as described in the follow-up section.</li>
<li>Press <em>Search</em> to trigger the search. The results are displayed below
the search configuration pane.</li>
<li>The <em>Search &amp; Execute actions</em> button is only relevant if at
least one action has been added (as described in the section below).</li>
<li>The <em>Save to note</em> will create a new note with the search configuration.
For more information, see&nbsp;<a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>.</li>
</ol>
<h2>Search options</h2>
<p>Click on which search option to apply from the Add search option section.</p>
<ul>
<li>For each search option selected, the search configuration will update
to reveal the entry. Each search option will have its own configuration.</li>
<li>To remove a search option, simply press the X button to the right of it.</li>
</ul>
<p>The options available are:</p>
<ol>
<li>Search script
<ol>
<li>This feature allows writing a&nbsp;<a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;note
that will handle the search on its own.</li>
</ol>
</li>
<li>Fast search
<ol>
<li>The search will not look into the content of the notes, but it will still
look into note titles and attributes, relations (based on the search query).</li>
<li>This method can speed up the search considerably for large <a href="#root/_help_wX4HbRucYSDD">databases</a>.</li>
</ol>
</li>
<li>Include archived
<ol>
<li><a class="reference-link" href="#root/_help_MKmLg5x6xkor">Archived Notes</a>&nbsp;will
also be included in the results, whereas otherwise they would be ignored.</li>
</ol>
</li>
<li>Order by
<ol>
<li>Allows changing the criteria for ordering the results, for example to
order by creation date or alphabetically instead of by relevancy (default).</li>
<li>It's also possible to change the order (ascending or descending) of the
results.</li>
</ol>
</li>
<li>Limit
<ol>
<li>Limits the results to a given maximum.</li>
<li>This can help if the number of results would otherwise be high, at the
cost of not being able to view all the results.</li>
</ol>
</li>
<li>Debug
<ol>
<li>This will print additional information in the server log (see&nbsp;
<a
class="reference-link" href="#root/_help_qzNzp9LYQyPT">Error logs</a>), regarding how the search expression was parsed.</li>
<li>This function is especially useful after understanding the search functionality
in detail, in order to determine why a complex search query is not working
as expected.</li>
</ol>
</li>
<li>Action
<ol>
<li>Apart from just searching, it is also possible to apply actions such as
to add a label or a relation to the notes that have been matched by the
search.</li>
<li>Unlike other search configurations, here it's possible to apply the same
action multiple times (i.e. in order to be able to apply multiple labels
to notes).</li>
<li>The actions given are the same as the ones in&nbsp;<a class="reference-link"
href="#root/_help_ivYnonVFBxbQ">Bulk Actions</a>, which is an alternative
for operating directly with notes within the&nbsp;<a class="reference-link"
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li>After defining the actions, first press <em>Search</em> to check the matched
notes and then press <em>Search &amp; Execute actions</em> to trigger the
actions.</li>
</ol>
</li>
</ol>
<h3>Simple Note Search Examples</h3>
<ul>
<li><code>rings tolkien</code>: Full-text search to find notes containing

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

View File

@@ -21,7 +21,7 @@
note by looking at the content of the notes, their relationships, as well
as the date they were created.</p>
<p>To access the list of similar notes, press the “Similar Notes” tab in
the&nbsp;<a class="reference-link" href="../UI%20Elements/Ribbon.html">Ribbon</a>.</p>
the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>.</p>
<h2>Interaction</h2>
<ul>
<li>Hover over a note to see a short preview of the note.</li>

View File

@@ -16,7 +16,7 @@
<p>This page explains the basic concepts related to the tree structure of
notes in TriliumNext.</p>
<h2>Note</h2>
<p>A note is the central entity in TriliumNext. For more details, see <a href="../Notes.html">Note</a>.</p>
<p>A note is the central entity in TriliumNext. For more details, see <a href="#root/_help_BFs8mudNFgCS">Note</a>.</p>
<h2>Branch</h2>
<p>A branch describes the placement of a note within the note tree. Essentially,
it is a tuple of <code>parentNoteId</code> and <code>noteId</code>, indicating
@@ -24,7 +24,7 @@
<p>Each note can have multiple branches, meaning any note can be placed in
multiple locations within the tree. This concept is referred to as "
<a
href="../Notes/Cloning%20Notes.html">cloning</a>."</p>
href="#root/_help_IakOLONlIfGI">cloning</a>."</p>
<h2>Prefix</h2>
<p>A prefix is a branch-specific title modifier for a note. If you place
your note in two different locations within the tree and want to alter

View File

@@ -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:&nbsp;</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>

View File

@@ -0,0 +1,100 @@
<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="#root/_help_OR8WJ7Iz9K4U">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="#root/_help_OR8WJ7Iz9K4U">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:&nbsp;</p>
<p>
<img src="1_Workspaces_image.png">
</p>
</li>
<li>
<p>visual identification of workspace in tabs:
<br>
<img src="Workspaces_image.png">
</p>
</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&nbsp;<a class="reference-link" href="#root/_help_l0tKav7yLHGF">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>

View File

@@ -17,14 +17,14 @@
and content.</p>
<h3>Note types</h3>
<p>The main note type is a rich-text note type called&nbsp;<a class="reference-link"
href="../Note%20Types/Text.html">Text</a>. For diagrams and drawing there
is&nbsp;<a class="reference-link" href="../Note%20Types/Canvas.html">Canvas</a>&nbsp;and&nbsp;
href="#root/_help_iPIMuisry3hd">Text</a>. For diagrams and drawing there
is&nbsp;<a class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a>&nbsp;and&nbsp;
<a
class="reference-link" href="../Note%20Types/Mermaid%20Diagrams.html">Mermaid Diagrams</a>.</p>
class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a>.</p>
<p>There are also more complex note types such as&nbsp;<a class="reference-link"
href="../Note%20Types/Saved%20Search.html">Saved Search</a>,&nbsp;<a class="reference-link"
href="../Note%20Types/Render%20Note.html">Render Note</a>&nbsp;that usually
go hand-in-hand with&nbsp;<a class="reference-link" href="../Scripting.html">Scripting</a>.</p>
href="#root/_help_m523cpzocqaD">Saved Search</a>,&nbsp;<a class="reference-link"
href="#root/_help_HcABDtFCkbFN">Render Note</a>&nbsp;that usually go hand-in-hand
with&nbsp;<a class="reference-link" href="#root/_help_CdNpE2pqjmI6">Scripting</a>.</p>
<p>In Trilium there's no specific "folder" note type. Any note can have children
and thus be a folder.</p>
<h3>Root note</h3>
@@ -32,7 +32,7 @@
tree. All other notes are placed below it in the structure.</p>
<h3>Tree structure</h3>
<p>Importantly, note itself doesn't carry information on its placement in
note tree. See&nbsp;<a class="reference-link" href="Notes/Cloning%20Notes.html">Cloning Notes</a>&nbsp;for
note tree. See&nbsp;<a class="reference-link" href="#root/_help_IakOLONlIfGI">Cloning Notes</a>&nbsp;for
details.</p>
<p>Tree structure of notes can resemble file system - but compared to that
notes in Trilium can act as both file and directory - meaning that note
@@ -43,10 +43,10 @@
(soft-delete) - the actual content, title, attributes etc. are not deleted,
only hidden.</p>
<p>Within (by default) 7 days, it is possible to undelete these soft-deleted
notes - open Recent Changes dialog, and you will see a list of all modified
notes including the deleted ones. Notes available for undeletion have a
link to do so. This is kind of "trash can" functionality known from e.g.
Windows.</p>
notes - open the&nbsp;<a class="reference-link" href="#root/_help_r5JGHN99bVKn">Recent Changes</a>&nbsp;dialog,
and you will see a list of all modified notes including the deleted ones.
Notes available for undeletion have a link to do so. This is kind of "trash
can" functionality known from e.g. Windows.</p>
<p>Clicking an undelete will recover the note, it's content and attributes
- note should be just as before being deleted. This action will also undelete
note's children which have been deleted in the same action.</p>
@@ -57,10 +57,10 @@
<p>After the 7 days (configurable) the notes will be "erased" - their title,
content, revisions and attributes will be erased, and it will not be possible
anymore to recover them (unless you restore a&nbsp;<a class="reference-link"
href="../Installation%20%26%20Setup/Backup.html">Backup</a>).</p>
href="#root/_help_ODY7qQn5m2FT">Backup</a>).</p>
<h2>See also</h2>
<ul>
<li><a href="Notes/Read-Only%20Notes.html">Read-only note</a>
<li><a class="reference-link" href="#root/_help_CoFPLs3dRlXc">Read-Only Notes</a>
</li>
</ul>
</div>

View File

@@ -13,10 +13,10 @@
<h1 data-trilium-h1>Archived Notes</h1>
<div class="ck-content">
<p>Archived notes are notes which have <code>archived</code> <a href="../../Advanced%20Usage/Attributes.html">attribute</a> -
either directly or <a href="../../Advanced%20Usage/Attributes/Attribute%20Inheritance.html">inherited</a>.</p>
<p>Archived notes are notes which have <code>archived</code> <a href="#root/_help_zEY4DaJG4YT5">attribute</a> -
either directly or <a href="#root/_help_bwZpz2ajCEwO">inherited</a>.</p>
<p>Such notes are then by default not shown in the autocomplete and in the
full text <a href="../Navigation/Search.html">search</a>.</p>
full text <a href="#root/_help_eIg8jdvaoNNd">search</a>.</p>
<p>This can be useful for notes which are no longer very useful but still
valuable enough to keep around without them getting too much in the way.</p>
<p>You can control whether archived notes are displayed in the note tree

View File

@@ -13,11 +13,11 @@
<h1 data-trilium-h1>Attachments</h1>
<div class="ck-content">
<p>A <a href="../Notes.html">note</a> in Trilium can <em>own</em> one or more
attachments, which can be either images or files. These attachments can
be displayed or linked within the note that owns them.</p>
<p>This can be especially useful to include dependencies for your <a href="../../Scripting.html">scripts</a>.
The&nbsp;<a class="reference-link" href="../../Advanced%20Usage/Advanced%20Showcases/Weight%20Tracker.html">Weight Tracker</a>&nbsp;shows
<p>A <a href="#root/_help_BFs8mudNFgCS">note</a> in Trilium can <em>own</em> one
or more attachments, which can be either images or files. These attachments
can be displayed or linked within the note that owns them.</p>
<p>This can be especially useful to include dependencies for your <a href="#root/_help_CdNpE2pqjmI6">scripts</a>.
The&nbsp;<a class="reference-link" href="#root/_help_R7abl2fc6Mxi">Weight Tracker</a>&nbsp;shows
how to use <a href="https://chartjs.org/">chartjs</a> which is attached to
the script note.</p>
<p>Each note exclusively owns its attachments, meaning attachments cannot
@@ -29,19 +29,19 @@
text of the owning note; otherwise, they will be automatically deleted
after a configurable timeout period if not referenced.</p>
<h2>Converting notes to attachments</h2>
<p><a class="reference-link" href="../../Note%20Types/File.html">File</a>&nbsp;notes
<p><a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a>&nbsp;notes
can be easily converted to attachments of the parent note.</p>
<p>To do so:</p>
<ul>
<li>For a single note, press the context menu from the&nbsp;<a class="reference-link"
href="../UI%20Elements/Note%20buttons.html">Note buttons</a>&nbsp;and select <em>Convert into attachment</em>.</li>
href="#root/_help_8YBEPzcpUgxw">Note buttons</a>&nbsp;and select <em>Convert into attachment</em>.</li>
<li>For multiple notes, select the given notes in the&nbsp;<a class="reference-link"
href="../UI%20Elements/Note%20Tree.html">Note Tree</a>, right click → Advanced
Convert to attachment.</li>
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>, right click → Advanced
Convert to attachment.</li>
</ul>
<h2>Attachment previews</h2>
<p>Attachments share the same content preview for images, videos, PDFs, etc.
as the&nbsp;<a class="reference-link" href="../../Note%20Types/File.html">File</a>&nbsp;note
as the&nbsp;<a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a>&nbsp;note
type.</p>
</div>
</div>

View File

@@ -98,18 +98,11 @@
<p>In the demo, you can see how a clone can be created using the context
menu. It's possible to do this also using the Add Link dialog or with <kbd>Ctrl</kbd>+<kbd>C</kbd> and <kbd>Ctrl</kbd>+<kbd>V</kbd>
<a
href="../Keyboard%20Shortcuts.html">keyboard shortcuts</a>.</p>
href="#root/_help_A9Oc6YKKc65v">keyboard shortcuts</a>.</p>
<p>As seen in the demo, you can view the list of all available clones in
the "Note Paths" tab in the Ribbon toolbar.</p>
<p>Titles of cloned notes in the tree view have an asterisk to the right
to easily see that the note is also placed into some other location.</p>
<h2>Prefix</h2>
<p>Since notes can be categorized into multiple places, it's recommended
to choose a generalized name that fits into all locations instead of something
more specific to avoid confusion. In some cases this isn't possible so
Trilium provides "branch prefixes", which is shown before the note name
in the tree and as such provides a specific kind of context. The prefix
is location specific, so it's displayed only in the tree pane.</p>
<h2>Deleting notes/clones</h2>
<p>With clones, it might not be immediately obvious how deleting works.</p>
<p>If you try to delete a note, it works like this:</p>

View File

@@ -0,0 +1,29 @@
<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>Branch prefix</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Branch prefix</h1>
<div class="ck-content">
<p>Since a single note can appear into multiple places in the&nbsp;<a class="reference-link"
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;via a process called&nbsp;
<a
class="reference-link" href="#root/_help_IakOLONlIfGI">Cloning Notes</a>, it's recommended to choose a generalized name that
fits into all locations instead of something more specific to avoid confusion.</p>
<p>In some cases this isn't possible so Trilium provides "branch prefixes",
which is shown before the note name in the tree and as such provides a
specific kind of context.</p>
<p>The prefix is location-specific, so it's displayed only in the note tree.</p>
</div>
</div>
</body>
</html>

View File

@@ -37,7 +37,7 @@
<p>Should you encounter any visual issues in the resulting PDF file (e.g.
a table does not fit properly, there is cut off text, etc.) feel free to
<a
href="../../Troubleshooting/Reporting%20issues.html">report the issue</a>. In this case, it's best to offer a sample note (click
href="#root/_help_wy8So3yZZlH9">report the issue</a>. In this case, it's best to offer a sample note (click
on the
<img src="1_Export as PDF_image.png">button, select Export note → This note and all of its descendants → HTML
in ZIP archive). Make sure not to accidentally leak any personal information.</p>
@@ -45,7 +45,7 @@
<p>When exporting to PDF, there are no customizable settings such as page
orientation, size, etc. However, it is possible to specify a given note
to be printed as a PDF in landscape mode by adding the <code>#printLandscape</code> attribute
to it (see&nbsp;<a class="reference-link" href="../../Advanced%20Usage/Attributes.html">Attributes</a>).</p>
to it (see&nbsp;<a class="reference-link" href="#root/_help_zEY4DaJG4YT5">Attributes</a>).</p>
<h2>Page size</h2>
<p>By default, the resulting PDF will be in Letter format. It is possible
to adjust it to another page size via the <code>#printPageSize</code> attribute,
@@ -53,8 +53,8 @@
<h2>Keyboard shortcut</h2>
<p>It's possible to trigger the export to PDF from the keyboard by going
to&nbsp;<em>Keyboard shortcuts</em>&nbsp;in&nbsp;<a class="reference-link"
href="../UI%20Elements/Options.html">Options</a>&nbsp;and assigning a key
combination for the <code>exportAsPdf</code> action.</p>
href="#root/_help_4TIF1oA4VQRO">Options</a>&nbsp;and assigning a key combination
for the <code>exportAsPdf</code> action.</p>
</div>
</div>
</body>

View File

@@ -15,15 +15,24 @@
<div class="ck-content">
<p>When a note has one or more child notes, they will be listed at the end
of the note for easy navigation.</p>
<h2>Configuration</h2>
<ul>
<li>To hide the note list for a particular note, simply apply the <code>hideChildrenOverview</code>
<a
href="#root/_help_zEY4DaJG4YT5">label</a>.</li>
<li>For some view types, such as Grid view, only a subset of notes will be
displayed and pagination can be used to navigate through all of them for
performance reasons. To adjust the number of notes per page, set <code>pageSize</code> to
the desired number.</li>
</ul>
<h2>View types</h2>
<p>By default, the notes will be displayed in a grid, however there are also
some other view types available.</p>
<aside class="admonition tip">
<p>Generally the view type can only be changed in a&nbsp;<a class="reference-link"
href="../../Note%20Types/Book.html">Book</a>&nbsp;note from the&nbsp;
<a
class="reference-link" href="../UI%20Elements/Ribbon.html">Ribbon</a>, but it can also be changed manually on any type of note using
the <code>#viewType</code> attribute.</p>
href="#root/_help_GTwFsgaA0lCt">Book</a>&nbsp;note from the&nbsp;<a class="reference-link"
href="#root/_help_BlN9DFI679QC">Ribbon</a>, but it can also be changed
manually on any type of note using the <code>#viewType</code> attribute.</p>
</aside>
<h3>Grid view</h3>
<figure class="image image-style-align-center">
@@ -33,11 +42,11 @@
<p>This view presents the child notes in a grid format, allowing for a more
visual navigation experience.</p>
<ul>
<li>For&nbsp;<a class="reference-link" href="../../Note%20Types/Text.html">Text</a>&nbsp;notes,
<li>For&nbsp;<a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;notes,
the text can be slighly scrollable via the mouse wheel to reveal more context.</li>
<li>For&nbsp;<a class="reference-link" href="../../Note%20Types/Code.html">Code</a>&nbsp;notes,
<li>For&nbsp;<a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;notes,
syntax highlighting is applied.</li>
<li>For&nbsp;<a class="reference-link" href="../../Note%20Types/File.html">File</a>&nbsp;notes,
<li>For&nbsp;<a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a>&nbsp;notes,
a preview is made available for audio, video and PDF notes.</li>
<li>If the note does not have a content, a list of its child notes will be
displayed instead.</li>
@@ -60,8 +69,7 @@
<p>In the calendar view, child notes are represented as events, with a start
date and optionally an end date. The view also has interaction support
such as moving or creating new events. See&nbsp;<a class="reference-link"
href="Note%20List/Calendar%20View.html">Calendar View</a>&nbsp;for more
information.</p>
href="#root/_help_xWbu3jpNWapp">Calendar View</a>&nbsp;for more information.</p>
</div>
</div>
</body>

View File

@@ -21,7 +21,7 @@
data to store.</p>
<p>To turn off note versioning for a particular note (or subtree), add <code>disableVersioning</code>
<a
href="../../Advanced%20Usage/Attributes.html">label</a>to the note.</p>
href="#root/_help_zEY4DaJG4YT5">label</a>to the note.</p>
<h2>Note Revision Snapshots Limit</h2>
<p>The limit on the number of note snapshots can be configured in the Options
-&gt; Other dialog. The note revision snapshot number limit refers to the

View File

@@ -21,8 +21,8 @@
<li><strong>Encryption:</strong> Protected notes are encrypted using a key
derived from your password. This ensures that without the correct password,
protected notes remain indecipherable. Even if someone gains access to
your Trilium <a href="../../Advanced%20Usage/Database.html">database</a>,
they won't be able to read your encrypted notes.</li>
your Trilium <a href="#root/_help_wX4HbRucYSDD">database</a>, they won't
be able to read your encrypted notes.</li>
<li><strong>Time-limited access:</strong> To access protected notes, you must
first enter your password, which decrypts the note for reading and writing.
However, after a specified period of inactivity (10 minutes by default),
@@ -63,7 +63,7 @@
<ul>
<li>Note structure (i.e., it remains visible that there are protected notes)</li>
<li>Metadata, such as the last modified date</li>
<li><a href="../../Advanced%20Usage/Attributes.html">Attributes</a>
<li><a href="#root/_help_zEY4DaJG4YT5">Attributes</a>
</li>
</ul>
<h2>Encryption Details</h2>
@@ -84,7 +84,7 @@
<ul>
<li>The data encryption key is encrypted using <a href="https://en.wikipedia.org/wiki/Advanced_Encryption_Standard">AES-128</a> with
a random <a href="https://en.wikipedia.org/wiki/Initialization_vector">IV</a>.</li>
<li>The data encryption key is randomly generated during the <a href="../../Advanced%20Usage/Database.html">database</a> initialization
<li>The data encryption key is randomly generated during the <a href="#root/_help_wX4HbRucYSDD">database</a> initialization
and remains constant throughout the documents lifetime. When the password
is changed, only this key is re-encrypted.</li>
</ul>

View File

@@ -13,9 +13,9 @@
<h1 data-trilium-h1>Read-Only Notes</h1>
<div class="ck-content">
<p>Some note types such as&nbsp;<a class="reference-link" href="../../Note%20Types/Text.html">Text</a>&nbsp;and&nbsp;
<p>Some note types such as&nbsp;<a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;and&nbsp;
<a
class="reference-link" href="../../Note%20Types/Code.html">Code</a>&nbsp;notes in Trilium can be set to read-only. When a note is
class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;notes in Trilium can be set to read-only. When a note is
in read-only mode, it is presented to the user in a non-editable view,
with the option to switch to editing mode if needed.</p>
<h2>Automatic read-only mode</h2>
@@ -26,12 +26,12 @@
of the next section.</p>
<p>In addition, it's possible to change the number of characters at which
the automatic read-only mode will trigger in&nbsp;<a class="reference-link"
href="../UI%20Elements/Options.html">Options</a>&nbsp;by going to the options
for&nbsp;<a class="reference-link" href="#root/_hidden/_options/_optionsTextNotes">Text Notes</a>&nbsp;and&nbsp;
href="#root/_help_4TIF1oA4VQRO">Options</a>&nbsp;by going to the options
for&nbsp;<a class="reference-link" href="#root/_hidden/_options/_help__optionsTextNotes">Text Notes</a>&nbsp;and&nbsp;
<a
class="reference-link" href="#root/_hidden/_options/_optionsCodeNotes">Code Notes</a>.</p>
class="reference-link" href="#root/_hidden/_options/_help__optionsCodeNotes">Code Notes</a>.</p>
<h2>Changing a note's read-only behavior</h2>
<p>Via the&nbsp;<a class="reference-link" href="../UI%20Elements/Ribbon.html">Ribbon</a>,
<p>Via the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>,
by going to the <em>Basic Properties</em> tab and looking for the <em>Editable</em> selection.
The following options are possible:</p>
<ul>
@@ -50,8 +50,7 @@
type does not support read-only mode.</p>
<h3>Manually setting the options</h3>
<p>Apart from using the ribbon as previously mentioned, it's also possible
to use <a href="../../Advanced%20Usage/Attributes.html">labels</a> to change
the behavior:</p>
to use <a href="#root/_help_zEY4DaJG4YT5">labels</a> to change the behavior:</p>
<ul>
<li>To set as read-only, apply the <code>readOnly</code> label to the note.</li>
<li>To disable automatic read-only (always editable), apply the <code>autoReadOnlyDisabled</code> label.</li>
@@ -59,17 +58,17 @@
<h2>Temporarily editing a read-only note</h2>
<p>When accessing a read-only note, it's possible to temporarily edit it
by using the
<img src="Read-Only Notes_image.png">button in the&nbsp;<a class="reference-link" href="../UI%20Elements/Floating%20buttons.html">Floating buttons</a>&nbsp;area.</p>
<img src="Read-Only Notes_image.png">button in the&nbsp;<a class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>&nbsp;area.</p>
<p>When pressed, the note will become editable but will become read-only
again after navigating to a different note.</p>
<h2>Special read-only behavior</h2>
<p>Some note types have a special behavior based on whether the read-only
mode is enabled:</p>
<ul>
<li><a class="reference-link" href="../../Note%20Types/Mermaid%20Diagrams.html">Mermaid Diagrams</a>&nbsp;will
<li><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a>&nbsp;will
hide the Mermaid source code and display the diagram preview in full-size.
In this case, the read-only mode can be easily toggled on or off via a
dedicated button in the&nbsp;<a class="reference-link" href="../UI%20Elements/Floating%20buttons.html">Floating buttons</a>&nbsp;area.</li>
dedicated button in the&nbsp;<a class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>&nbsp;area.</li>
</ul>
</div>
</div>

View File

@@ -13,13 +13,20 @@
<h1 data-trilium-h1>Sorting Notes</h1>
<div class="ck-content">
<h2>Sorting Notes</h2>
<p>You can sort notes by right-clicking the parent note in the note tree
and selecting Advanced -&gt; Sort notes by ... This will sort existing
notes, but will not automatically sort future notes added to this parent
note</p>
<h2>Manual sorting</h2>
<p>You can sort notes by right-clicking the parent note in the&nbsp;<a class="reference-link"
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;and selecting Advanced
-&gt; Sort notes by ... This will sort existing notes, but will not automatically
sort future notes added to this parent note.</p>
<p>The sorting dialog allows:</p>
<ul>
<li>Sorting by title, creation or modification date.</li>
<li>Changing sorting direction can also be adjusted (ascending or descending).</li>
<li>Ensuring folders are displayed at the top.</li>
<li>Natural sort, based on the sorting rules of a particular language.</li>
</ul>
<h2>Automatic/Permanent Sorting</h2>
<p>Child notes can be automatically sorted by attaching specific <a href="../../Advanced%20Usage/Attributes.html">labels</a> to
<p>Child notes can be automatically sorted by attaching specific <a href="#root/_help_zEY4DaJG4YT5">labels</a> to
the parent note:</p>
<ul>
<li><code>#sorted</code>: Enables sorting. Can optionally include the name

View File

@@ -25,9 +25,9 @@
<p>Trilium supports custom user themes, allowing you to personalize the application's
appearance. To create a custom theme, follow these steps:</p>
<ol>
<li><strong>Create a CSS Code Note</strong>: Start by creating a new <a href="../Note%20Types/Code.html">code note</a> with
<li><strong>Create a CSS Code Note</strong>: Start by creating a new <a href="#root/_help_6f9hih2hXXZk">code note</a> with
the <code>CSS</code> type.</li>
<li><strong>Annotate with</strong> <code>#appTheme</code>: Add the <a href="../Advanced%20Usage/Attributes.html">attribute</a> <code>#appTheme=my-theme-name</code> to
<li><strong>Annotate with</strong> <code>#appTheme</code>: Add the <a href="#root/_help_zEY4DaJG4YT5">attribute</a> <code>#appTheme=my-theme-name</code> to
your note, where <code>my-theme-name</code> is the name of your custom theme.</li>
<li><strong>Define Your Styles</strong>: Write your custom CSS within the
note. Below is an example of a custom theme:</li>
@@ -89,7 +89,7 @@ body .CodeMirror {
<ol>
<li>Go to "Menu" -&gt; "Options" -&gt; "Appearance."</li>
<li>In the theme selection dropdown, you should see your custom theme listed
under the name you provided with the <code>#appTheme</code> <a href="../Advanced%20Usage/Attributes.html">label</a>.</li>
under the name you provided with the <code>#appTheme</code> <a href="#root/_help_zEY4DaJG4YT5">label</a>.</li>
<li>Select your custom theme to activate it.</li>
</ol>
<p>If you make changes to your theme, press <kbd>Ctrl</kbd> + <kbd>R</kbd> to
@@ -112,9 +112,9 @@ body .CodeMirror {
<p>To use custom CSS:</p>
<ol>
<li><strong>Create a CSS Code Note</strong>: Create a new&nbsp;<a class="reference-link"
href="../Note%20Types/Code.html">Code</a>&nbsp;note with the <code>CSS</code> type.</li>
href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;note with the <code>CSS</code> type.</li>
<li><strong>Add the</strong> <code>appCss</code> <strong>Label</strong>: Annotate
the note with the <code>#appCss</code> <a href="../Advanced%20Usage/Attributes.html">label</a>.</li>
the note with the <code>#appCss</code> <a href="#root/_help_zEY4DaJG4YT5">label</a>.</li>
<li><strong>Write Your CSS</strong>: Add your custom CSS rules to the note.</li>
</ol>
<p>For example:</p><pre><code class="language-text-x-trilium-auto">/* Custom CSS to style specific elements */
@@ -132,7 +132,7 @@ body .CodeMirror {
<p>To apply specific styles to certain notes in the tree:</p>
<ul>
<li><strong>Use the</strong> <code>cssClass</code> <strong>Attribute</strong>:
Add the <code>cssClass</code> <a href="../Advanced%20Usage/Attributes.html">attribute</a> to
Add the <code>cssClass</code> <a href="#root/_help_zEY4DaJG4YT5">attribute</a> to
a note, and assign it a value representing the desired CSS class.</li>
<li><strong>Define an</strong> <code>iconClass</code>: You can also define
a custom icon for a note using the <code>iconClass</code> attribute, selecting
@@ -143,7 +143,7 @@ body .CodeMirror {
<h3>User-Provided Themes</h3>
<p>A gallery of user-created themes is available, showcasing the variety
of customizations that the Trilium community has developed. For more information,
check the&nbsp;<a class="reference-link" href="Themes/Theme%20Gallery.html">Theme Gallery</a>.</p>
check the&nbsp;<a class="reference-link" href="#root/_help_VbjZvtUek0Ln">Theme Gallery</a>.</p>
<h3>Asset Path Management</h3>
<p>When referencing built-in assets like images in your custom themes or
CSS, you can avoid hardcoding version numbers by using the <code>vX</code> alias.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

View File

@@ -18,18 +18,18 @@
height="144">
</figure>
<p>Depending on the current note, a panel will appear near the top-right
of the note, right underneath the&nbsp;<a class="reference-link" href="Ribbon.html">Ribbon</a>.
of the note, right underneath the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>.
These buttons offer additional interaction that is specific to that particular
note.</p>
<p>For example:</p>
<ul>
<li>For&nbsp;<a class="reference-link" href="../../Note%20Types/Mermaid%20Diagrams.html">Mermaid Diagrams</a>&nbsp;and&nbsp;
<li>For&nbsp;<a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a>&nbsp;and&nbsp;
<a
class="reference-link" href="../../Note%20Types/Canvas.html">Canvas</a>, there are buttons to download the SVG representation of the
class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a>, there are buttons to download the SVG representation of the
note, or to copy a reference to the note for pasting it a&nbsp;<a class="reference-link"
href="../../Note%20Types/Text.html">Text</a>&nbsp;note.</li>
<li>For <a href="../Notes/Read-Only%20Notes.html">read-only notes</a>, there
is a button to temporarily edit the note for quick modifications.</li>
href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;note.</li>
<li>For <a href="#root/_help_CoFPLs3dRlXc">read-only notes</a>, there is a
button to temporarily edit the note for quick modifications.</li>
</ul>
<h2>Interaction</h2>
<p>The floating button area can be collapsed by pressing the two right arrows

View File

@@ -19,7 +19,7 @@
<img src="Global menu_image.png">
</p>
<h2>Accessing the global menu</h2>
<p>See&nbsp;<a href="Vertical%20and%20horizontal%20layout.html">Vertical and horizontal layout</a>&nbsp;since
<p>See&nbsp;<a href="#root/_help_x0JgW8UqGXvq">Vertical and horizontal layout</a>&nbsp;since
the position of the global menu is changed based on which layout has been
selected.</p>
</div>

View File

@@ -16,7 +16,7 @@
<h2>Position of the Launch bar</h2>
<p>Depending on the layout selected, the launcher bar will either be on the
left side of the screen with buttons displayed vertically or at the top
of the screen. See&nbsp;<a href="Vertical%20and%20horizontal%20layout.html">Vertical and horizontal layout</a>&nbsp;for
of the screen. See&nbsp;<a href="#root/_help_x0JgW8UqGXvq">Vertical and horizontal layout</a>&nbsp;for
more information.</p>
<h2>Terminology</h2>
<ul>
@@ -33,10 +33,10 @@
<li>Right click in the empty space between launchers on the launch bar and
select <em>Configure Launchbar.</em>
</li>
<li>Click on the&nbsp;<a href="Global%20menu.html">Global menu</a>&nbsp;and
<li>Click on the&nbsp;<a href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
select <em>Configure Launchbar</em>.</li>
</ul>
<p>This will open a new tab with the&nbsp;<a href="Note%20Tree.html">Note Tree</a>&nbsp;listing
<p>This will open a new tab with the&nbsp;<a href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;listing
the launchers.</p>
<p>
<img src="Launch Bar_image.png">
@@ -51,13 +51,13 @@
<p>Similarly, to remove it from the launch bar, simply look for it in <em>Visible Launchers</em> then
right click it and select <em>Move to available launchers</em> or use drag-and-drop.</p>
<p>Drag-and-drop the items in the&nbsp;tree&nbsp;in order to change their
order. See&nbsp;<a href="Note%20Tree.html">Note Tree</a>&nbsp;for more
interaction options, including using keyboard shortcuts.</p>
order. See&nbsp;<a href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;for
more interaction options, including using keyboard shortcuts.</p>
<h2>Customizing the launcher</h2>
<ul>
<li>The icon of a launcher can be changed just like a normal note. See&nbsp;
<a
href="../Notes/Note%20Icons.html">Note Icons</a>&nbsp;for more information.</li>
href="#root/_help_p9kXRFAkwN4o">Note Icons</a>&nbsp;for more information.</li>
<li>The title of the launcher can also be changed.</li>
</ul>
<h3>Resetting</h3>
@@ -76,7 +76,7 @@
<li>Set the <code>target</code> promoted attribute to the note to navigate to.</li>
<li>Optionally, set <code>hoistedNote</code> to hoist a particular note. See&nbsp;
<a
href="../Navigation/Note%20Hoisting.html">Note Hoisting</a>&nbsp;for more information.</li>
href="#root/_help_OR8WJ7Iz9K4U">Note Hoisting</a>&nbsp;for more information.</li>
<li>Optionally, set a <code>keyboardShortcut</code> to trigger the launcher.</li>
</ol>
</li>
@@ -84,7 +84,7 @@
<p><strong>Script Launcher</strong>
<br>An advanced launcher which will run a script upon pressing. See&nbsp;
<a
href="../../Scripting.html">Scripts</a>&nbsp;for more information.</p>
href="#root/_help_CdNpE2pqjmI6">Scripts</a>&nbsp;for more information.</p>
<ol>
<li>Set <code>script</code> to point to the desired script to run.</li>
<li>Optionally, set a <code>keyboardShortcut</code> to trigger the launcher.</li>
@@ -95,7 +95,7 @@
</p>
<p>Allows defining a custom widget to be rendered inside the launcher. See&nbsp;
<a
href="../../Scripting/Widget%20Basics.html">Widget Basics</a>&nbsp;for more information.</p>
href="#root/_help_SynTBQiBsdYJ">Widget Basics</a>&nbsp;for more information.</p>
</li>
<li>
<p><strong>Spacers</strong>
@@ -103,7 +103,7 @@
visual distinction.</p>
</li>
</ol>
<p>Launchers are configured via predefined&nbsp;<a href="../../Advanced%20Usage/Attributes/Promoted%20Attributes.html">Promoted Attributes</a>.</p>
<p>Launchers are configured via predefined&nbsp;<a href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>.</p>
</div>
</div>
</body>

View File

@@ -16,7 +16,7 @@
<p>This page explains how to manipulate the note tree in TriliumNext, focusing
on moving notes.</p>
<p>
<img src="1_Note Tree_image.png">
<img src="Note Tree_image.png">
</p>
<h2>Drag and Drop</h2>
<p>
@@ -28,7 +28,7 @@
<p>
<img src="Note Tree_move-note-with-k.gif" alt="Example of using keyboard keys to move a note">Trilium offers efficient keyboard-based manipulation using the following
<a
href="../Keyboard%20Shortcuts.html">shortcuts</a>:</p>
href="#root/_help_A9Oc6YKKc65v">shortcuts</a>:</p>
<ul>
<li><kbd>Ctrl</kbd> + <kbd><span></span></kbd> and <kbd>Ctrl</kbd> +<kbd><span></span></kbd>:
Move the note up or down in the order.</li>
@@ -42,22 +42,11 @@
</ul>
<h2>Context Menu</h2>
<p>You can also move notes using the familiar cut and paste functions available
in the context menu, or with the associated keyboard <a href="../Keyboard%20Shortcuts.html">shortcuts</a>: <code>CTRL-C</code> (
in the context menu, or with the associated keyboard <a href="#root/_help_A9Oc6YKKc65v">shortcuts</a>: <code>CTRL-C</code> (
<a
href="../Notes/Cloning%20Notes.html">copy</a>), <kbd>Ctrl</kbd> + <kbd>X</kbd> (cut) and <kbd>Ctrl</kbd> + <kbd>V</kbd> (paste).</p>
<h2>Multiple selection</h2>
<p>It is possible to select multiple notes at one time.</p>
<p>To do so, first select the note to start the selection with. Then hold
Shift and click on the note to end the selection with. All the notes between
the start and the end note will be selected as well.</p>
<p>
<img src="Note Tree_image.png">
</p>
<p>In the right-click menu, operations such as Cut, Copy, Move to, Clone
to or Delete will apply to all the selected notes. It is also possible
to apply&nbsp;<a href="../../Advanced%20Usage/Bulk%20actions.html">Bulk actions</a>&nbsp;to
them. The rest of the options will not be available and will appear disabled
in the menu.</p>
href="#root/_help_IakOLONlIfGI">copy</a>), <kbd>Ctrl</kbd> + <kbd>X</kbd> (cut) and <kbd>Ctrl</kbd> + <kbd>V</kbd> (paste).</p>
<p>See&nbsp;<a class="reference-link" href="#root/_help_YtSN43OrfzaA">Note Tree Menu</a>&nbsp;for
more information.</p>
</div>
</div>
</body>

View File

@@ -0,0 +1,32 @@
<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>Multiple selection</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Multiple selection</h1>
<div class="ck-content">
<p>It is possible to select multiple notes at one time.</p>
<p>To do so, first select the note to start the selection with. Then hold
Shift and click on the note to end the selection with. All the notes between
the start and the end note will be selected as well.</p>
<p>
<img src="Multiple selection_image.png">
</p>
<p>In the right-click menu, operations such as Cut, Copy, Move to, Clone
to or Delete will apply to all the selected notes. It is also possible
to apply&nbsp;<a class="reference-link" href="#root/_help_ivYnonVFBxbQ">Bulk Actions</a>&nbsp;to
them. The rest of the options will not be available and will appear disabled
in the menu.</p>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.3 KiB

View File

@@ -0,0 +1,242 @@
<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>Note tree contextual menu</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Note tree contextual menu</h1>
<div class="ck-content">
<figure class="image image-style-align-right">
<img style="aspect-ratio:372/760;" src="1_Note tree contextual menu_.png"
width="372" height="760">
</figure>
<p>The <em>note tree menu</em> can be accessed by right-clicking in the&nbsp;
<a
class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</p>
<h2>Interaction</h2>
<p>The contextual menu can operate:</p>
<ul>
<li>On a single note, by right clicking it in the note tree.</li>
<li>On multiple notes, by selecting them first. See&nbsp;<a class="reference-link"
href="#root/_help_yTjUdsOi4CIE">Multiple selection</a>&nbsp;on how to do
so.
<ul>
<li>When right clicking, do note that usually the note being right clicked
is also included in the affected notes, regardless of whether it was selected
or not.</li>
</ul>
</li>
</ul>
<h2>Available options</h2>
<aside class="admonition note">
<p>When multiple notes are selected, only a subset of notes will be active.
The ones that do support multiple notes will mention this in the list below.</p>
</aside>
<ul>
<li><strong>Open in a new tab</strong>
<ul>
<li>Will open a single note in a new <a href="#root/_help_3seOhtN8uLIY">tab</a>.</li>
</ul>
</li>
<li><strong>Open in a new split</strong>
<ul>
<li>Will open a split to the right with the given note within the current
tab.</li>
</ul>
</li>
<li><strong>Hoist note</strong>
<ul>
<li>Will focus the note tree on this note. See&nbsp;<a class="reference-link"
href="#root/_help_OR8WJ7Iz9K4U">Note Hoisting</a>&nbsp;for more information.</li>
</ul>
</li>
<li><strong>Insert note after</strong>
<ul>
<li>Allows easy creation of a note with a specified <a href="#root/_help_KSZ04uQ2D1St">note type</a>.</li>
<li><a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>&nbsp;will
also be present (if any) at the end of the list.</li>
<li>The note will be added on the same level of hierarchy as the note selected.</li>
</ul>
</li>
<li><strong>Insert child note</strong>
<ul>
<li>Same as <em>Insert note after</em>, but the note will be created as a child
of the selected note.</li>
</ul>
</li>
<li><strong>Protect subtree</strong>
<ul>
<li>Will mark this note and all of its descendents as protected. See&nbsp;
<a
class="reference-link" href="#root/_help_bwg0e8ewQMak">Protected Notes</a>&nbsp;for more information.</li>
</ul>
</li>
<li><strong>Unprotect subtree</strong>
<ul>
<li>Will unprotect this note and all of its descendents.</li>
</ul>
</li>
<li><strong>Cut</strong>
<ul>
<li>Will place the given notes in clipboard.</li>
<li>Use one of the two paste functions (or the keyboard shortcuts) to move
them to the desired location.</li>
</ul>
</li>
<li><strong>Copy / clone</strong>
<ul>
<li>Will place the given notes in clipboard.</li>
<li>Use one of the two paste functions (or the keyboard shortcuts) to copy
them to the desired location.</li>
<li>Note that the copy function here works according to the&nbsp;<a class="reference-link"
href="#root/_help_IakOLONlIfGI">Cloning Notes</a>&nbsp;functionality (i.e.
the note itself will be present in two locations at once, and editing it
in one place will edit it everywhere).</li>
<li>To simply create a duplicate note that can be modified independently,
look for <em>Duplicate subtree</em>.</li>
</ul>
</li>
<li><strong>Paste into</strong>
<ul>
<li>If there are any notes in clipboard, they will be pasted as child notes
to the right-clicked one.</li>
</ul>
</li>
<li><strong>Paste after</strong>
<ul>
<li>If there are any notes in clipboard, they will be pasted underneath the
right-clicked one.</li>
</ul>
</li>
<li><strong>Move to…</strong>
<ul>
<li>Will display a modal to specify where to move the desired notes.</li>
</ul>
</li>
<li><strong>Clone to…</strong>
<ul>
<li>Will display a modal to specify where to <a href="#root/_help_IakOLONlIfGI">clone</a> the
desired notes.</li>
</ul>
</li>
<li><strong>Delete</strong>
<ul>
<li>Will delete the given notes, asking for confirmation first.</li>
<li>In the dialog, the following options can be configured:
<ul>
<li><em>Delete also all clones</em> to ensure that the note will be deleted
everywhere if it has been placed into multiple locations (see&nbsp;<a class="reference-link"
href="#root/_help_IakOLONlIfGI">Cloning Notes</a>).</li>
<li><em>Erase notes permanently</em> will ensure that the note cannot be recovered
from&nbsp;<a class="reference-link" href="#root/_help_r5JGHN99bVKn">Recent Changes</a>.</li>
</ul>
</li>
</ul>
</li>
<li><strong>Import into note</strong>
<ul>
<li>Opens the <a href="#root/_help_mHbBMPDPkVV5">import</a> dialog and places
the imported notes as child notes of the selected one.</li>
</ul>
</li>
<li><strong>Export</strong>
<ul>
<li>Opens the <a href="#root/_help_mHbBMPDPkVV5">export</a> dialog for the selected
notes.</li>
</ul>
</li>
<li><strong>Search in subtree</strong>
<ul>
<li>Opens a full&nbsp;<a class="reference-link" href="#root/_help_eIg8jdvaoNNd">Search</a>&nbsp;with
it preconfigured to only look into this note and its descendants (the <em>Ancestor</em> field).</li>
</ul>
</li>
</ul>
<h2>Advanced options</h2>
<figure class="image image-style-align-right">
<img style="aspect-ratio:289/355;" src="Note tree contextual menu_.png"
width="289" height="355">
</figure>
<p>The advanced options menu offers some of the less frequently used actions
for notes.</p>
<p>To access these options, first look for the <em>Advanced</em> option in
the contextual menu to reveal a sub-menu with:</p>
<ul>
<li><strong>Apply bulk actions</strong>
<ul>
<li>Opens the&nbsp;<a class="reference-link" href="#root/_help_ivYnonVFBxbQ">Bulk Actions</a>&nbsp;dialog,
to apply actions such as adding labels or moving notes to multiple notes
at once (see&nbsp;<a class="reference-link" href="#root/_help_yTjUdsOi4CIE">Multiple selection</a>).</li>
</ul>
</li>
<li><strong>Edit branch prefix</strong>
<ul>
<li>Opens a dialog to assign a name to be able to distinguish <a href="#root/_help_IakOLONlIfGI">clones</a>,
see&nbsp;<a class="reference-link" href="#root/_help_TBwsyfadTA18">Branch prefix</a>&nbsp;for
more information.</li>
</ul>
</li>
<li><strong>Convert to attachment</strong>
<ul>
<li>Converts the selected notes to&nbsp;<a class="reference-link" href="#root/_help_0vhv7lsOLy82">Attachments</a>&nbsp;of
their parent notes.</li>
<li>This functional is most useful when dealing with image&nbsp;<a class="reference-link"
href="#root/_help_W8vYD3Q1zjCR">File</a>&nbsp;notes that were imported
from an external source or an older version of Trilium.</li>
</ul>
</li>
<li><strong>Duplicate subtree</strong>
<ul>
<li>Creates a copy of the note and its descendants.</li>
<li>This process is different from&nbsp;<a class="reference-link" href="#root/_help_IakOLONlIfGI">Cloning Notes</a>&nbsp;since
the duplicated note can be edited independently from the original.</li>
<li>An alternative to this, if done regularly, would be&nbsp;<a class="reference-link"
href="#root/_help_KC1HB96bqqHX">Templates</a>.</li>
</ul>
</li>
<li><strong>Expand subtree</strong>
<ul>
<li>Expands all the child notes in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
</ul>
</li>
<li><strong>Collapse subtree</strong>
<ul>
<li>Collapses all the child notes in the note tree.</li>
</ul>
</li>
<li><strong>Sort by…</strong>
<ul>
<li>Opens a dialog to sort all the child notes of the selected note.</li>
<li>The sorting is done only once, there is an automatic sorting mechanism
as well that can be set using&nbsp;<a class="reference-link" href="#root/_help_zEY4DaJG4YT5">Attributes</a>.</li>
<li>See&nbsp;<a class="reference-link" href="#root/_help_aGlEvb9hyDhS">Sorting Notes</a>&nbsp;for
more information.</li>
</ul>
</li>
<li><strong>Copy note path to clipboard</strong>
<ul>
<li>Copies a URL fragment representing the full path to this branch for a
note, such as <code>#root/Hb2E70L7HPuf/4sRFgMZhYFts/2IVuShedRJ3U/LJVMvKXOFv7n</code>.</li>
<li>The URL to manually create&nbsp;<a class="reference-link" href="#root/_help_QEAPj01N5f7w">Links</a>&nbsp;within
notes, or for note&nbsp;<a class="reference-link" href="#root/_help_wArbEsdSae6g">Navigation</a>.</li>
</ul>
</li>
<li><strong>Recent changes in subtree</strong>
<ul>
<li>This will open&nbsp;<a class="reference-link" href="#root/_help_r5JGHN99bVKn">Recent Changes</a>,
but filtered to only the changes related to this note or one of its descendants.</li>
</ul>
</li>
</ul>
</div>
</div>
</body>
</html>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.3 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View File

@@ -13,17 +13,17 @@
<h1 data-trilium-h1>Note buttons</h1>
<div class="ck-content">
<p>To the right of the&nbsp;<a href="Ribbon.html">Ribbon</a>&nbsp;there are
a few more buttons:
<p>To the right of the&nbsp;<a href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;there
are a few more buttons:
<img src="Note buttons_image.png">
</p>
<ul>
<li>The Note Revisions button displays the&nbsp;<a href="../Notes/Note%20Revisions.html">Note Revisions</a>&nbsp;for
<li>The Note Revisions button displays the&nbsp;<a href="#root/_help_vZWERwf8U3nx">Note Revisions</a>&nbsp;for
that particular note.</li>
<li>The contextual menu offers commands for the note or its subtree, such
as import, export, viewing the&nbsp;<a href="../../Advanced%20Usage/Note%20source.html">Note source code</a>&nbsp;or&nbsp;
as import, export, viewing the&nbsp;<a href="#root/_help_4FahAwuGTAwC">Note source code</a>&nbsp;or&nbsp;
<a
href="../Notes/Attachments.html">Attachments</a>.</li>
href="#root/_help_0vhv7lsOLy82">Attachments</a>.</li>
</ul>
</div>
</div>

View File

@@ -22,21 +22,22 @@
<h2>Entering options</h2>
<p>The Options can be accessed via:</p>
<ul>
<li>The&nbsp;<a href="Global%20menu.html">Global menu</a>, by selecting the <em>Options</em> item.</li>
<li>The&nbsp;<a href="#root/_help_x3i7MxGccDuM">Global menu</a>, by selecting
the <em>Options</em> item.</li>
<li>The
<img src="1_Options_image.png">button in the&nbsp;<a href="Launch%20Bar.html">Launch Bar</a>&nbsp;which
<img src="1_Options_image.png">button in the&nbsp;<a href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>&nbsp;which
can optionally be hidden if not desirable.</li>
<li>Optionally, a keyboard shortcut can be defined, but it is not assigned
by default.</li>
<li>By clicking on this link:&nbsp;<a class="reference-link" href="#root/_hidden/_options">Options</a>.</li>
<li>By clicking on this link:&nbsp;<a class="reference-link" href="#root/_hidden/_help__options">Options</a>.</li>
</ul>
<p>Once in the options section, simply select one of the option categories
using the&nbsp;<a class="reference-link" href="Note%20Tree.html">Note Tree</a>.</p>
using the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</p>
<h2>Exiting options</h2>
<p>When entering the options, they are opened in a new <a href="Tabs.html">tab</a>.
<p>When entering the options, they are opened in a new <a href="#root/_help_3seOhtN8uLIY">tab</a>.
To close them, simply close the tab.</p>
<h2>Options when using sync</h2>
<p>When using&nbsp;<a class="reference-link" href="../../Installation%20%26%20Setup/Synchronization.html">Synchronization</a>,
<p>When using&nbsp;<a class="reference-link" href="#root/_help_cbkrhQjrkKrh">Synchronization</a>,
some of the options will be kept in sync across all the devices while others
can be changed independently.</p>
<p>Generally, the options that relate to appearance are intentionally kept

View File

@@ -0,0 +1,51 @@
<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>Recent Changes</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Recent Changes</h1>
<div class="ck-content">
<figure class="image image-style-align-center image_resized" style="width:50%;">
<img style="aspect-ratio:988/572;" src="1_Recent Changes_image.png" width="988"
height="572">
</figure>
<h2>Accessing the recent changes</h2>
<ul>
<li>For an overview of the changes across all documents, press the
<img src="Recent Changes_image.png"
width="25" height="21">button in the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.
<ul>
<li>If there is a <a href="#root/_help_OR8WJ7Iz9K4U">hoisted note</a> or a
<a
href="#root/_help_9sRHySam5fXb">workspace</a>, the list of recent changes will be limited to the descendents
of the hoisted note, or the workspace.</li>
</ul>
</li>
<li>To limit the list of recent changes to a note and its descendants, look
for the corresponding option in the&nbsp;<a class="reference-link" href="#root/_help_YtSN43OrfzaA">Note tree contextual menu</a>&nbsp;
Advanced.</li>
</ul>
<h2>Interaction</h2>
<ul>
<li>Notes which were changed will appear in reverse chronological order (latest
update first).</li>
<li>The title of the note is displayed, as well as the note path. Clicking
on the note title will dismiss the dialog and navigate to that particular
note.</li>
<li>Deleted notes will also be listed here, at their time of deletion. Press
the <em>Undelete</em> link next to them in order to recover them.</li>
</ul>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

View File

@@ -20,91 +20,93 @@
about the current note.</p>
<h2>Settings</h2>
<p>It is possible to change whether some ribbon items will be automatically
open when navigating to a new note. To do so, in&nbsp;<a href="Options.html">Settings</a>,
open when navigating to a new note. To do so, in&nbsp;<a href="#root/_help_4TIF1oA4VQRO">Settings</a>,
go to <em>Appearance</em> and look for the <em>Ribbon widgets</em> section.</p>
<h2>Formatting</h2>
<p>If you are using the <em>Fixed</em> formatting toolbar, all the formatting
buttons for text notes will appear here. See&nbsp;<a href="../../Note%20Types/Text/Formatting%20toolbar.html">Formatting toolbar</a>&nbsp;for
buttons for text notes will appear here. See&nbsp;<a href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>&nbsp;for
more information.</p>
<h2>Tabs</h2>
<h3>Basic Properties</h3>
<ul>
<li><em><strong>Note type</strong></em> allows changing the <a href="../../Note%20Types.html">note type</a> of
<li><em><strong>Note type</strong></em> allows changing the <a href="#root/_help_KSZ04uQ2D1St">note type</a> of
a note.
<ul>
<li>Generally this is desirable only if the note is empty.</li>
<li>As a more advanced use, it's possible to change the note type in order
to modify the <a href="../../Advanced%20Usage/Note%20source.html">source code</a> of
a note.</li>
to modify the <a href="#root/_help_4FahAwuGTAwC">source code</a> of a note.</li>
</ul>
</li>
<li><em><strong>Protect the note</strong></em> toggles whether the current
note is encrypted and accessible only by entering the protected session.
See&nbsp;<a href="../Notes/Protected%20Notes.html">Protected Notes</a>&nbsp;for
See&nbsp;<a href="#root/_help_bwg0e8ewQMak">Protected Notes</a>&nbsp;for
more information.</li>
<li><em><strong>Editable</strong></em> changes whether the current note:
<ul>
<li>Enters <a href="../Notes/Read-Only%20Notes.html">read-only mode</a> automatically
<li>Enters <a href="#root/_help_CoFPLs3dRlXc">read-only mode</a> automatically
if the note is too big (default behaviour).</li>
<li>Is always in read-only mode (however it can still be edited temporarily).</li>
<li>Is always editable, regardless of its size.</li>
</ul>
</li>
<li><em><strong>Bookmark</strong></em> toggles the display of the current note
into the&nbsp;<a href="Launch%20Bar.html">Launch Bar</a>&nbsp;for easy
access. See&nbsp;<a href="../Navigation/Bookmarks.html">Bookmarks</a>&nbsp;for
into the&nbsp;<a href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>&nbsp;for
easy access. See&nbsp;<a href="#root/_help_u3YFHC9tQlpm">Bookmarks</a>&nbsp;for
more information.</li>
<li><em><strong>Shared</strong></em> toggles whether the current note is publicly
accessible if you have a <a href="../../Installation%20%26%20Setup/Server%20Installation.html">server instance</a> set
up. See&nbsp;<a href="../../Advanced%20Usage/Sharing.html">Sharing</a>&nbsp;for
more information.</li>
accessible if you have a <a href="#root/_help_WOcw2SLH6tbX">server instance</a> set
up. See&nbsp;<a href="#root/_help_R9pX4DGra2Vt">Sharing</a>&nbsp;for more
information.</li>
<li><em><strong>Template</strong></em> toggles whether the current note is
considered a template and can be used to easily create notes with the same
content. See&nbsp;<a href="../../Advanced%20Usage/Templates.html">Template</a>&nbsp;for
content. See&nbsp;<a href="#root/_help_KC1HB96bqqHX">Template</a>&nbsp;for
more information.</li>
<li><em><strong>Language</strong></em> changes the main language of the current
note, mostly useful for spell checking or right-to-left support. See&nbsp;
<a
href="../../Note%20Types/Text/Content%20language%20%26%20Right-to-le.html">Content language &amp; Right-to-left support</a>&nbsp;for more information.</li>
href="#root/_help_veGu4faJErEM">Content language &amp; Right-to-left support</a>&nbsp;for more information.</li>
</ul>
<h3>Owned Attributes</h3>
<p>This section allows editing the labels and relations of a note. For more
information, see&nbsp;<a href="../../Advanced%20Usage/Attributes.html">Attributes</a>.</p>
information, see&nbsp;<a href="#root/_help_zEY4DaJG4YT5">Attributes</a>.</p>
<p>The plus button to the right offers a simplified way to insert labels
and relations, via a graphical input. From this menu, it's also possible
to define label and relation definitions (see&nbsp;<a href="../../Advanced%20Usage/Attributes/Promoted%20Attributes.html">Promoted Attributes</a>).</p>
to define label and relation definitions (see&nbsp;<a href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>).</p>
<h3>Inherited Attributes</h3>
<p>This section displays the attributes which are applied to this note via&nbsp;
<a
href="../../Advanced%20Usage/Attributes/Attribute%20Inheritance.html">Attribute Inheritance</a>. It is not possible to alter the attributes
href="#root/_help_bwZpz2ajCEwO">Attribute Inheritance</a>. It is not possible to alter the attributes
from this section.</p>
<h3>Note Paths</h3>
<p>This section displays all the places where the current note has been cloned
to. Here the current note can also be cloned to a new location (similar
to the&nbsp;<a href="Note%20Tree.html">Note Tree</a>) See&nbsp;<a href="../Notes/Cloning%20Notes.html">Cloning Notes</a>&nbsp;for
more information.</p>
to the&nbsp;<a href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>) See&nbsp;
<a
href="#root/_help_IakOLONlIfGI">Cloning Notes</a>&nbsp;for more information.</p>
<h3>Note Map</h3>
<p>The note map displays all the relations of the current note to other notes,
as well as the subtree structure. See&nbsp;<a href="Note%20Tree.html">Note Tree</a>&nbsp;for
as well as the subtree structure. See&nbsp;<a href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;for
more information.</p>
<h3>Similar Notes</h3>
<p>This section lists all the notes that are similar to the current one.
See&nbsp;<a href="../Navigation/Similar%20Notes.html">Similar Notes</a>&nbsp;for
See&nbsp;<a href="#root/_help_xWtq5NUHOwql">Similar Notes</a>&nbsp;for
more information.</p>
<h3>Note Info</h3>
<p>This section displays information about the current note:</p>
<ul>
<li>The <a href="../../Advanced%20Usage/Note%20ID.html">internal ID</a> of the
note.</li>
<li>The <a href="../../Note%20Types.html">type of the note</a>, as well as
<li>The <a href="#root/_help_m1lbrzyKDaRB">internal ID</a> of the note.</li>
<li>The <a href="#root/_help_KSZ04uQ2D1St">type of the note</a>, as well as
its MIME type (used mostly for exporting notes).</li>
<li>The created and modification dates.</li>
<li>The estimated size of the note in the&nbsp;<a href="../../Advanced%20Usage/Database.html">Database</a>,
<li>The estimated size of the note in the&nbsp;<a href="#root/_help_wX4HbRucYSDD">Database</a>,
as well as its children count and size.</li>
</ul>
<h3>Edited notes</h3>
<p>This section pops automatically when entering a <a href="../../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.html">day note</a> and
<p>This section pops automatically when entering a <a href="#root/_help_l0tKav7yLHGF">day note</a> and
shows the notes that were edited that day.</p>
<p>It is possible to disable this behavior from settings, by going to&nbsp;
<a
class="reference-link" href="#root/_hidden/_options/_help__optionsAppearance">Appearance</a>&nbsp;settings and looking for the <em>Ribbon widgets</em> section.</p>
</div>
</div>
</body>

View File

@@ -20,9 +20,9 @@
<p>The right sidebar displays specific content for the current note. Currently
it includes:</p>
<ul>
<li><a class="reference-link" href="../../Note%20Types/Text/Table%20of%20contents.html">Table of contents</a>
<li><a class="reference-link" href="#root/_help_BFvAtE74rbP6">Table of contents</a>
</li>
<li><a class="reference-link" href="../../Note%20Types/Text/Highlights%20list.html">Highlights list</a>
<li><a class="reference-link" href="#root/_help_AxshuNRegLAv">Highlights list</a>
</li>
</ul>
<p>Note that the sidebar is not displayed if it would otherwise be empty,
@@ -31,10 +31,10 @@
<p>The sidebar can be hidden or shown by using the <code>toggleRightPane</code> keyboard
shortcut, which is not assigned by default.</p>
<h2>Relation with splits</h2>
<p>When using&nbsp;<a class="reference-link" href="Split%20View.html">Split View</a>,
<p>When using&nbsp;<a class="reference-link" href="#root/_help_luNhaphA37EO">Split View</a>,
there is a single sidebar serving all the open splits for the current
<a
href="Tabs.html">tab</a>.</p>
href="#root/_help_3seOhtN8uLIY">tab</a>.</p>
<p>Clicking on a note within the split view will display the sidebar for
that note. If there are no items to display in the sidebar, it will remain
closed.</p>

View File

@@ -37,9 +37,9 @@
<li>Use the
<img src="Split View_4_Split View_im.png">or the
<img src="Split View_1_Split View_im.png">button to move around the splits.</li>
<li>Each <a href="Tabs.html">tab</a> has its own split view configuration (e.g.
one tab can have two notes in a split view, whereas the others are one-note
views).
<li>Each <a href="#root/_help_3seOhtN8uLIY">tab</a> has its own split view configuration
(e.g. one tab can have two notes in a split view, whereas the others are
one-note views).
<ul>
<li>The tab will indicate only the title of the main note (the first one in
the list).</li>
@@ -48,10 +48,10 @@
</ul>
<h2>Splits and the note tree &amp; hoisting</h2>
<p>Clicking on the content of a split will focus that split. While focused,
the&nbsp;<a class="reference-link" href="Note%20Tree.html">Note Tree</a>&nbsp;will
the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;will
also indicate the note that is being edited.</p>
<p>It is possible for each of the splits to have their own&nbsp;<a class="reference-link"
href="../Navigation/Note%20Hoisting.html">Note Hoisting</a>.</p>
href="#root/_help_OR8WJ7Iz9K4U">Note Hoisting</a>.</p>
<p>When a new split is created, it will share the same note hoisting as the
previous one. An easy solution to this is to simply hoist the notes after
the split is created.</p>

View File

@@ -19,13 +19,13 @@
</figure>
<p>In Trilium, tabs allow easy switching between notes.</p>
<h2>Layout</h2>
<p>Depending on the&nbsp;<a class="reference-link" href="Vertical%20and%20horizontal%20layout.html">Vertical and horizontal layout</a>:</p>
<p>Depending on the&nbsp;<a class="reference-link" href="#root/_help_x0JgW8UqGXvq">Vertical and horizontal layout</a>:</p>
<ul>
<li>For the vertical layout, the tabs will be placed at the top but to the
right of the&nbsp;<a class="reference-link" href="Note%20Tree.html">Note Tree</a>.</li>
right of the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li>For the horizontal layout, the tabs will be placed at the top in full-width,
above the&nbsp;<a href="Note%20Tree.html">note tree</a>, allowing for more
tabs to be comfortably displayed.</li>
above the&nbsp;<a href="#root/_help_oPVyFC7WL2Lp">note tree</a>, allowing
for more tabs to be comfortably displayed.</li>
</ul>
<h2>Interaction</h2>
<ul>
@@ -34,8 +34,8 @@
<li>To close a tab, press the corresponding
<img src="Tabs_image.png">button.</li>
<li>For multitasking, tabs can be used alongside&nbsp;<a class="reference-link"
href="Split%20View.html">Split View</a>. Each tab can have one or more
notes, displayed horizontally.</li>
href="#root/_help_luNhaphA37EO">Split View</a>. Each tab can have one or
more notes, displayed horizontally.</li>
<li>Tabs can be reordered by drag-and-dropping it into a new position.</li>
<li>An existing tab can be displayed in a new window by dragging the tab upwards
or downwards. It is not possible to combine tabs back into another window.</li>

View File

@@ -18,19 +18,19 @@
<h3>Vertical layout</h3>
<p>The vertical layout is Trilium's original layout:</p>
<ul>
<li>The&nbsp;<a class="reference-link" href="Launch%20Bar.html">Launch Bar</a>&nbsp;is
<li>The&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>&nbsp;is
positioned on the left side of the screen, with buttons being laid out
vertically.</li>
<li>The tab bar is at the top, but to the right of the&nbsp;<a class="reference-link"
href="Note%20Tree.html">Note Tree</a>.</li>
<li>The&nbsp;<a class="reference-link" href="../Navigation/Quick%20search.html">Quick search</a>&nbsp;is
at the top of the&nbsp;<a class="reference-link" href="Note%20Tree.html">Note Tree</a>.</li>
<li>The&nbsp;<a class="reference-link" href="Note%20Tree.html">Note Tree</a>&nbsp;can
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li>The&nbsp;<a class="reference-link" href="#root/_help_Ms1nauBra7gq">Quick search</a>&nbsp;is
at the top of the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li>The&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;can
be collapsed by pressing the
<img src="5_Vertical and horizontal la.png">button at the bottom of the&nbsp;<a class="reference-link" href="Launch%20Bar.html">Launch Bar</a>.</li>
<li>The&nbsp;<a class="reference-link" href="Global%20menu.html">Global menu</a>&nbsp;can
<img src="5_Vertical and horizontal la.png">button at the bottom of the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</li>
<li>The&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;can
be accessed via the
<img src="4_Vertical and horizontal la.png">icon at the top of the&nbsp;<a class="reference-link" href="Launch%20Bar.html">Launch Bar</a>.</li>
<img src="4_Vertical and horizontal la.png">icon at the top of the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</li>
</ul>
<p>
<img src="3_Vertical and horizontal la.png">
@@ -39,25 +39,25 @@
<p>The horizontal layout is a more traditional layout, since it bears similarity
with other applications. In this mode:</p>
<ul>
<li>The&nbsp;<a class="reference-link" href="Launch%20Bar.html">Launch Bar</a>&nbsp;is
<li>The&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>&nbsp;is
at the top of the screen, with the buttons laid horizontally.</li>
<li>The tab bar is at the top of the screen, but now covers the entirety of
the width, allowing for more tabs to be displayed at once.</li>
<li>The&nbsp;<a class="reference-link" href="../Navigation/Quick%20search.html">Quick search</a>&nbsp;is
now part of the&nbsp;<a class="reference-link" href="Launch%20Bar.html">Launch Bar</a>.
<li>The&nbsp;<a class="reference-link" href="#root/_help_Ms1nauBra7gq">Quick search</a>&nbsp;is
now part of the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.
It can be moved around according to preference and even removed if needed.</li>
<li>The&nbsp;<a class="reference-link" href="Note%20Tree.html">Note Tree</a>&nbsp;can
<li>The&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;can
be collapsed by pressing the small
<img src="1_Vertical and horizontal la.png">button to the left of the first tab.</li>
<li>The&nbsp;<a class="reference-link" href="Global%20menu.html">Global menu</a>&nbsp;can
<li>The&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;can
be accessed via the
<img src="Vertical and horizontal la.png">button at the end of the&nbsp;<a class="reference-link" href="Launch%20Bar.html">Launch Bar</a>.</li>
<img src="Vertical and horizontal la.png">button at the end of the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</li>
</ul>
<p>
<img src="2_Vertical and horizontal la.png">
</p>
<h2>Changing the layout</h2>
<p>Go to&nbsp;<a class="reference-link" href="Options.html">Options</a>&nbsp;and
<p>Go to&nbsp;<a class="reference-link" href="#root/_help_4TIF1oA4VQRO">Options</a>&nbsp;and
look for the <em>Appearance</em> option on the left. Then look for the <em>Layout</em> section,
where there is the possibility to switch between the two available layouts.</p>
<p>Selecting an option will immediately apply the new layout by reloading

View File

@@ -16,7 +16,7 @@
<h2>macOS support</h2>
<p>Originally, Trilium Notes considered the macOS build unsupported. TriliumNext
commits to make the experience on macOS as good as possible.</p>
<p>if you find any platform-specific issues, feel free to <a href="Troubleshooting/Reporting%20issues.html">report them</a>.</p>
<p>if you find any platform-specific issues, feel free to <a href="#root/_help_wy8So3yZZlH9">report them</a>.</p>
<h2>Translation / localisation support</h2>
<p>The original Trilium Notes application did not support multiple languages.
Since we believe that internationalisation is a core part of an application,
@@ -36,19 +36,18 @@
<li>the assumption that only single person has access to the app simplifies
many things, or just outright makes them possible. In multi-user app, our
<a
href="Scripting.html">scripting</a>support would be a XSS security hole, while with the single
href="#root/_help_CdNpE2pqjmI6">scripting</a>support would be a XSS security hole, while with the single
user assumption it's an endless customizable tool.</li>
</ul>
<h2>How to open multiple documents in one Trilium instance</h2>
<p>This is normally not supported - one Trilium process can open only a single
instance of a <a href="Advanced%20Usage/Database.html">database</a>. However,
instance of a <a href="#root/_help_wX4HbRucYSDD">database</a>. However,
you can run two Trilium processes (from one installation), each connected
to a separate document. To achieve this, you need to set a location for
the <a href="Installation%20%26%20Setup/Data%20directory.html">data directory</a> in
the <code>TRILIUM_DATA_DIR</code> environment variable and separate port
on <code>TRILIUM_PORT</code> environment variable. How to do that depends
on the platform, in Unix-based systems you can achieve that by running
command such as this:</p><pre><code class="language-text-x-trilium-auto">TRILIUM_DATA_DIR=/home/me/path/to/data/dir TRILIUM_PORT=12345 trilium </code></pre>
the <a href="#root/_help_tAassRL4RSQL">data directory</a> in the <code>TRILIUM_DATA_DIR</code> environment
variable and separate port on <code>TRILIUM_PORT</code> environment variable.
How to do that depends on the platform, in Unix-based systems you can achieve
that by running command such as this:</p><pre><code class="language-text-x-trilium-auto">TRILIUM_DATA_DIR=/home/me/path/to/data/dir TRILIUM_PORT=12345 trilium </code></pre>
<p>You can save this command into a <code>.sh</code> script file or make an
alias. Do this similarly for a second instance with different data directory
and port.</p>
@@ -59,9 +58,9 @@
that they will corrupt the database file, resulting in data loss and this
message in the Trilium logs:</p><pre><code class="language-text-x-trilium-auto">SqliteError: database disk image is malformed</code></pre>
<p>The only supported way to sync Trilium's data across the network is to
use a <a href="Installation%20%26%20Setup/Synchronization.html">sync/web server</a>.</p>
use a <a href="#root/_help_cbkrhQjrkKrh">sync/web server</a>.</p>
<h2>Why database instead of flat files?</h2>
<p>Trilium stores notes in a <a href="Advanced%20Usage/Database.html">database</a> which
<p>Trilium stores notes in a <a href="#root/_help_wX4HbRucYSDD">database</a> which
is an SQLite database. People often ask why doesn't Trilium rather use
flat files for note storage - it's fair question since flat files are easily
interoperable, work with SCM/git etc.</p>
@@ -70,17 +69,17 @@
with probably more problems.</p>
<p>More detailed answer:</p>
<ul>
<li><a href="Basic%20Concepts%20and%20Features/Notes/Cloning%20Notes.html">clones</a> are
what you might call "hard directory link" in filesystem lingo, but this
concept is not implemented in any filesystem</li>
<li><a href="#root/_help_IakOLONlIfGI">clones</a> are what you might call "hard
directory link" in filesystem lingo, but this concept is not implemented
in any filesystem</li>
<li>filesystems make a distinction between directory and file while there's
intentionally no such difference in Trilium</li>
<li>files are stored in no particular order and user can't change this</li>
<li>Trilium allows storing note <a href="Advanced%20Usage/Attributes.html">attributes</a> which
<li>Trilium allows storing note <a href="#root/_help_zEY4DaJG4YT5">attributes</a> which
could be represented in extended user attributes but their support differs
greatly among different filesystems / operating systems</li>
<li>Trilium makes links / relations between different notes which can be quickly
retrieved / navigated (e.g. for <a href="Advanced%20Usage/Note%20Map%20(Link%20map%2C%20Tree%20map).html">note map</a>).
retrieved / navigated (e.g. for <a href="#root/_help_BCkXAVs63Ttv">note map</a>).
There's no such support in file systems which means these would have to
be stored in some kind of side-car files (mini-databases).</li>
<li>Filesystems are generally not transactional. While this is not completely

View File

@@ -15,7 +15,7 @@
<div class="ck-content">
<p>Trilium supports simple backup scheme where it saves copy of the&nbsp;
<a
class="reference-link" href="../Advanced%20Usage/Database.html">Database</a>&nbsp;on these events:</p>
class="reference-link" href="#root/_help_wX4HbRucYSDD">Database</a>&nbsp;on these events:</p>
<ul>
<li>once a day</li>
<li>once a week</li>
@@ -24,27 +24,27 @@
</ul>
<p>So in total you'll have at most 4 backups from different points in time
which should protect you from various problems. These backups are stored
by default in <code>backup</code> directory placed in the <a href="Data%20directory.html">data directory</a>.</p>
by default in <code>backup</code> directory placed in the <a href="#root/_help_tAassRL4RSQL">data directory</a>.</p>
<p>This is only very basic backup solution, and you're encouraged to add
some better backup solution - e.g. backing up the&nbsp;<a class="reference-link"
href="../Advanced%20Usage/Database.html">Database</a>&nbsp;to cloud / different
href="#root/_help_wX4HbRucYSDD">Database</a>&nbsp;to cloud / different
computer etc.</p>
<p>Note that&nbsp;<a class="reference-link" href="Synchronization.html">Synchronization</a>&nbsp;provides
<p>Note that&nbsp;<a class="reference-link" href="#root/_help_cbkrhQjrkKrh">Synchronization</a>&nbsp;provides
also some backup capabilities by its nature of distributing the data to
other computers.</p>
<h2>Restoring backup</h2>
<p>Let's assume you want to restore the weekly backup, here's how to do it:</p>
<ul>
<li>find <a href="Data%20directory.html">data directory</a> Trilium uses - easy
way is to open "About Trilium Notes" from "Menu" in upper left corner and
looking at "data directory"
<li>find <a href="#root/_help_tAassRL4RSQL">data directory</a> Trilium uses
- easy way is to open "About Trilium Notes" from "Menu" in upper left corner
and looking at "data directory"
<ul>
<li>I'll refer to <code>~/trilium-data</code> as data directory from now on</li>
</ul>
</li>
<li>find <code>~/trilium-data/backup/backup-weekly.db</code> - this is the&nbsp;
<a
class="reference-link" href="../Advanced%20Usage/Database.html">Database</a>&nbsp;backup</li>
class="reference-link" href="#root/_help_wX4HbRucYSDD">Database</a>&nbsp;backup</li>
<li>at this point stop/kill Trilium</li>
<li>delete <code>~/trilium-data/document.db</code>, <code>~/trilium-data/document.db-wal</code> and <code>~/trilium-data/document.db-shm</code> (latter
two files are auto generated)</li>
@@ -59,11 +59,11 @@
will be detected and synced to the newer version.</p>
<h2>Disabling backup</h2>
<p>Although this is not recommended, it is possible to disable backup in <code>config.ini</code> in
the <a href="Data%20directory.html">data directory</a>:</p><pre><code class="language-text-x-trilium-auto">[General]
the <a href="#root/_help_tAassRL4RSQL">data directory</a>:</p><pre><code class="language-text-x-trilium-auto">[General]
... some other configs
# set to true to disable backups (e.g. because of limited space on server)
noBackup=true</code></pre>
<p>You can also review the <a href="../Advanced%20Usage/Configuration%20(config.ini%20or%20e.html">configuration</a> file
<p>You can also review the <a href="#root/_help_Gzjqa934BdH4">configuration</a> file
to provide all <code>config.ini</code> values as environment variables instead.</p>
<p>See <a href="https://github.com/TriliumNext/Notes/blob/master/config-sample.ini">sample config</a>.</p>
</div>

View File

@@ -15,11 +15,11 @@
<div class="ck-content">
<p>Data directory contains:</p>
<ul>
<li><code>document.db</code> - <a href="../Advanced%20Usage/Database.html">database</a>
<li><code>document.db</code> - <a href="#root/_help_wX4HbRucYSDD">database</a>
</li>
<li><code>config.ini</code> - instance level settings like port on which the
Trilium application runs</li>
<li><code>backup</code> - contains automatically <a href="Backup.html">backup</a> of
<li><code>backup</code> - contains automatically <a href="#root/_help_ODY7qQn5m2FT">backup</a> of
documents</li>
<li><code>log</code> - contains application log files</li>
</ul>
@@ -72,7 +72,7 @@
<h3>Create a script to run with specific data directory</h3>
<p>An alternative to globally setting environment variable is to run only
the Trilium Notes with this environment variable. This then allows for
different setup styles like two <a href="../Advanced%20Usage/Database.html">database</a> instances
different setup styles like two <a href="#root/_help_wX4HbRucYSDD">database</a> instances
or "portable" installation.</p>
<p>To do this in unix based systems simply run trilium like this:</p><pre><code class="language-text-x-trilium-auto">TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data trilium</code></pre>
<p>You can then save the above command as a shell script on your path for

View File

@@ -28,7 +28,7 @@
<ul>
<li><code>trilium-no-cert-check</code>: Starts Trilium without validating
<a
href="Server%20Installation/TLS%20Configuration.html">TLS certificates</a>, useful if connecting to a server with a self-signed
href="#root/_help_l2VkvOwUNfZj">TLS certificates</a>, useful if connecting to a server with a self-signed
certificate.
<ul>
<li>Alternatively, set the <code>NODE_TLS_REJECT_UNAUTHORIZED=0</code> environment
@@ -36,14 +36,14 @@
</ul>
</li>
<li><code>trilium-portable</code>: Launches Trilium in portable mode, where
the <a href="Data%20directory.html">data directory</a> is created within
the <a href="#root/_help_tAassRL4RSQL">data directory</a> is created within
the application's directory, making it easy to move the entire setup.</li>
<li><code>trilium-safe-mode</code>: Boots Trilium in "safe mode," disabling
any startup scripts that might cause the application to crash.</li>
</ul>
<h2>Synchronization</h2>
<p>For Trilium desktp users who wish to synchronize their data with a server
instance, refer to the&nbsp;<a class="reference-link" href="Synchronization.html">Synchronization</a>&nbsp;guide
instance, refer to the&nbsp;<a class="reference-link" href="#root/_help_cbkrhQjrkKrh">Synchronization</a>&nbsp;guide
for detailed instructions.</p>
</div>
</div>

View File

@@ -13,14 +13,14 @@
<h1 data-trilium-h1>Mobile Frontend</h1>
<div class="ck-content">
<p>Trilium (<a href="Server%20Installation.html">server edition</a>) has
a mobile web frontend which is optimized for touch based devices - smartphones
<p>Trilium (<a href="#root/_help_WOcw2SLH6tbX">server edition</a>) has a
mobile web frontend which is optimized for touch based devices - smartphones
and tablets. It is activated automatically during login process based on
browser detection.</p>
<p>Mobile frontend is limited in features compared to full desktop frontend.
See below for more details on this.</p>
<p>Note that this is not an Android/iOS app, this is just mobile friendly
web page served on the <a href="Server%20Installation.html">server edition</a>.</p>
web page served on the <a href="#root/_help_WOcw2SLH6tbX">server edition</a>.</p>
<h2>Screenshots</h2>
<h3>Mobile phone</h3>
<p>
@@ -36,7 +36,7 @@
<ul>
<li>it is possible to browse the whole note tree, read and edit all types
of notes, but you can create only text notes</li>
<li>reading and editing <a href="../Basic%20Concepts%20and%20Features/Notes/Protected%20Notes.html">protected notes</a> is
<li>reading and editing <a href="#root/_help_bwg0e8ewQMak">protected notes</a> is
possible, but creating them is not supported</li>
<li>editing options is not supported</li>
<li>cloning notes is not supported</li>
@@ -47,7 +47,7 @@
If this is not appropriate, you can use <code>?mobile</code> or <code>?desktop</code> query
param on <strong>login</strong> page (Note: you might need to log out).</p>
<h2>Scripting</h2>
<p>You can alter the behavior with <a href="../Scripting.html">scripts</a> just
<p>You can alter the behavior with <a href="#root/_help_CdNpE2pqjmI6">scripts</a> just
like for normal frontend. For script notes to be executed, they need to
have labeled <code>#run=mobileStartup</code>.</p>
</div>

View File

@@ -14,42 +14,42 @@
<div class="ck-content">
<p>This guide outlines the steps to install Trilium on your own server. You
might consider this option if you want to set up <a href="Synchronization.html">synchronization</a> or
might consider this option if you want to set up <a href="#root/_help_cbkrhQjrkKrh">synchronization</a> or
use Trilium in a browser - accessible from anywhere.</p>
<h2>Installation Options</h2>
<p>There are several ways to install Trilium on a server, each with its own
advantages:</p>
<ul>
<li><strong>Recommended</strong>: <a href="Server%20Installation/1.%20Installing%20the%20server/Docker%20Server%20Installation.html">Docker Installation</a> -
<li><strong>Recommended</strong>: <a href="#root/_help_rWX5eY045zbE">Docker Installation</a> -
Available for <strong>AMD64</strong> and <strong>ARM</strong> architectures.</li>
<li><a href="Server%20Installation/1.%20Installing%20the%20server/Packaged%20server%20installation.html">Packaged Server Installation</a>
<li><a href="#root/_help_3tW6mORuTHnB">Packaged Server Installation</a>
</li>
<li><a href="https://www.pikapods.com/pods?run=trilium-next">PikaPods managed hosting</a>
</li>
<li><a href="Server%20Installation/1.%20Installing%20the%20server/Manual%20server%20installation.html">Manual Installation</a>
<li><a href="#root/_help_J1Bb6lVlwU5T">Manual Installation</a>
</li>
<li><a href="Server%20Installation/1.%20Installing%20the%20server/Kubernetes%20server%20installation.html">Kubernetes</a>
<li><a href="#root/_help_DCmT6e7clMoP">Kubernetes</a>
</li>
<li><a href="https://www.cloudron.io/store/com.github.trilium.cloudronapp.html">Cloudron</a>
</li>
<li><a href="https://homelabos.com/docs/software/trilium/">HomelabOS</a>
</li>
<li><a href="Server%20Installation/1.%20Installing%20the%20server/NixOS%20server%20installation.html">NixOS Module</a>
<li><a href="#root/_help_moVgBcoxE3EK">NixOS Module</a>
</li>
</ul>
<p>The server installation includes both web and <a href="Mobile%20Frontend.html">mobile frontends</a>.</p>
<p>The server installation includes both web and <a href="#root/_help_RDslemsQ6gCp">mobile frontends</a>.</p>
<h2>Configuration</h2>
<p>After setting up your server installation, you may want to configure settings
such as the port or enable <a href="Server%20Installation/TLS%20Configuration.html">TLS</a>.
Configuration is managed via the Trilium <code>config.ini</code> file, which
is located in the <a href="Data%20directory.html">data directory</a> by default.
such as the port or enable <a href="#root/_help_l2VkvOwUNfZj">TLS</a>. Configuration
is managed via the Trilium <code>config.ini</code> file, which is located
in the <a href="#root/_help_tAassRL4RSQL">data directory</a> by default.
To begin customizing your setup, copy the provided <code>config-sample.ini</code> file
with default values to <code>config.ini</code>.</p>
<p>You can also review the <a href="../Advanced%20Usage/Configuration%20(config.ini%20or%20e.html">configuration</a> file
<p>You can also review the <a href="#root/_help_Gzjqa934BdH4">configuration</a> file
to provide all <code>config.ini</code> values as environment variables instead.</p>
<h3>Config Location</h3>
<p>By default, <code>config.ini</code>, the <a href="../Advanced%20Usage/Database.html">database</a>,
and other important Trilium data files are stored in the <a href="Data%20directory.html">data directory</a>.
<p>By default, <code>config.ini</code>, the <a href="#root/_help_wX4HbRucYSDD">database</a>,
and other important Trilium data files are stored in the <a href="#root/_help_tAassRL4RSQL">data directory</a>.
If you prefer a different location, you can change it by setting the <code>TRILIUM_DATA_DIR</code> environment
variable:</p><pre><code class="language-text-x-trilium-auto">export TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data</code></pre>
<h3>Disabling Authentication</h3>
@@ -72,7 +72,7 @@ noAuthentication=true</code></pre>
<p>To avoid limiting the size of payloads, include this in the <code>server {}</code> block:</p><pre><code class="language-text-x-trilium-auto"># Set to 0 for unlimited. Default is 1M.
client_max_body_size 0;</code></pre>
<h3>Apache</h3>
<p>For an Apache setup, refer to the <a href="Server%20Installation/2.%20Reverse%20proxy/Apache.html">Apache proxy setup</a> guide.</p>
<p>For an Apache setup, refer to the <a href="#root/_help_fDLvzOx29Pfg">Apache proxy setup</a> guide.</p>
</div>
</div>
</body>

View File

@@ -80,9 +80,9 @@ docker inspect [container_name]</code></pre>
is the container's path. More details can be found in the <a href="https://docs.docker.com/storage/volumes/">Docker Volumes Documentation</a>.</p>
<h2>Reverse Proxy</h2>
<ol>
<li><a href="../2.%20Reverse%20proxy/Nginx.html">Nginx</a>
<li><a href="#root/_help_ud6MShXL4WpO">Nginx</a>
</li>
<li><a href="../2.%20Reverse%20proxy/Apache.html">Apache</a>
<li><a href="#root/_help_fDLvzOx29Pfg">Apache</a>
</li>
</ol>
<h3>Note on --user Directive</h3>

View File

@@ -49,7 +49,7 @@ nohup TRILIUM_ENV=dev node src/www &amp;</code></pre>
browser and navigate to <a href="http://localhost:8080">http://localhost:8080</a> to
access Trilium (replace "localhost" with your hostname).</p>
<h2>TLS</h2>
<p>Don't forget to <a href="../TLS%20Configuration.html">configure TLS</a> which
<p>Don't forget to <a href="#root/_help_l2VkvOwUNfZj">configure TLS</a> which
is required for secure usage!</p>
</div>
</div>

View File

@@ -77,10 +77,10 @@ WantedBy=multi-user.target</code></pre>
at Module.load (module.js:565:32)
at tryModuleLoad (module.js:505:12)</code></pre>
<p>If you get an error like this, you need to either upgrade your glibc (typically
by upgrading to up-to-date distribution version) or use some other <a href="../../Server%20Installation.html">server installation</a> method.</p>
by upgrading to up-to-date distribution version) or use some other <a href="#root/_help_WOcw2SLH6tbX">server installation</a> method.</p>
<h2>TLS</h2>
<p>Don't forget to <a href="../TLS%20Configuration.html">configure TLS</a>,
which is required for secure usage!</p>
<p>Don't forget to <a href="#root/_help_l2VkvOwUNfZj">configure TLS</a>, which
is required for secure usage!</p>
</div>
</div>
</body>

View File

@@ -13,7 +13,7 @@
<h1 data-trilium-h1>TLS Configuration</h1>
<div class="ck-content">
<p>Configuring TLS is essential for <a href="../Server%20Installation.html">server installation</a> in
<p>Configuring TLS is essential for <a href="#root/_help_WOcw2SLH6tbX">server installation</a> in
Trilium. This guide details the steps to set up TLS within Trilium itself.</p>
<p>For a more robust solution, consider using TLS termination with a reverse
proxy (recommended, e.g., Nginx). You can follow a <a href="https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-20-04">guide like this</a> for
@@ -31,7 +31,7 @@
</ul>
<h2>Modifying <code>config.ini</code></h2>
<p>Once you have your certificate, modify the <code>config.ini</code> file
in the <a href="../Data%20directory.html">data directory</a> to configure
in the <a href="#root/_help_tAassRL4RSQL">data directory</a> to configure
Trilium to use it:</p><pre><code class="language-text-x-trilium-auto">[Network]
port=8080
# Set to true for TLS/SSL/HTTPS (secure), false for HTTP (insecure).
@@ -40,7 +40,7 @@ https=true
# Relevant only if https=true
certPath=/[username]/.acme.sh/[hostname]/fullchain.cer
keyPath=/[username]/.acme.sh/[hostname]/example.com.key</code></pre>
<p>You can also review the <a href="../../Advanced%20Usage/Configuration%20(config.ini%20or%20e.html">configuration</a> file
<p>You can also review the <a href="#root/_help_Gzjqa934BdH4">configuration</a> file
to provide all <code>config.ini</code> values as environment variables instead.</p>
<p>The above example shows how this is set up in an environment where the
certificate was generated using Let's Encrypt's ACME utility. Your paths

View File

@@ -27,7 +27,7 @@
<h2>Setting Up Synchronization</h2>
<h3>Security Considerations</h3>
<p>Setting up the server securely is critical and can be complex. It is crucial
to use a valid <a href="Server%20Installation/TLS%20Configuration.html">TLS certificate</a> (HTTPS)
to use a valid <a href="#root/_help_l2VkvOwUNfZj">TLS certificate</a> (HTTPS)
rather than an unencrypted HTTP connection to ensure security and avoid
potential vulnerabilities.</p>
<h3>Synchronizing a Desktop Instance with a Sync Server</h3>
@@ -55,7 +55,7 @@
<p>This method is used when you already have a sync server and want to configure
a new desktop instance to sync with it.</p>
<ol>
<li><strong>Desktop Setup</strong>: Follow the <a href="Desktop%20Installation.html">desktop installation page</a>.</li>
<li><strong>Desktop Setup</strong>: Follow the <a href="#root/_help_poXkQfguuA0U">desktop installation page</a>.</li>
<li><strong>Initial Configuration</strong>: When prompted, choose the option
to set up sync with a sync server.</li>
</ol>
@@ -97,7 +97,7 @@
<h3>Conflict Resolution</h3>
<p>If you edit the same note on multiple instances before synchronization,
Trilium resolves conflicts by retaining the newer change and discarding
the older one. The older version remains accessible in <a href="../Basic%20Concepts%20and%20Features/Notes/Note%20Revisions.html">note revisions</a>,
the older one. The older version remains accessible in <a href="#root/_help_vZWERwf8U3nx">note revisions</a>,
allowing data recovery if needed.</p>
<h3>Hash Check</h3>
<p>After each synchronization, Trilium computes a hash of all synced data

View File

@@ -20,21 +20,21 @@
be performed manually. The upgrade process varies depending on the installation
method:</p>
<ul>
<li><a href="Server%20Installation/1.%20Installing%20the%20server/Docker%20Server%20Installation.html"><strong>Docker Server Installation</strong></a>:
<li><a href="#root/_help_rWX5eY045zbE"><strong>Docker Server Installation</strong></a>:
Pull the new image and restart the container.</li>
<li><strong>Other Installations</strong>: Download the latest version from
the <a href="https://github.com/TriliumNext/Notes/releases/latest">release page</a> and
replace the existing application files.</li>
</ul>
<h2>Database Compatibility and Migration</h2>
<p>Upon startup, Trilium will automatically migrate the <a href="../Advanced%20Usage/Database.html">database</a> to
<p>Upon startup, Trilium will automatically migrate the <a href="#root/_help_wX4HbRucYSDD">database</a> to
the new version. Note that after migration, older versions of Trilium will
be unable to read the database. If you need to revert to a previous version
of Trilium and its database, you can restore the <a href="Backup.html">backup</a> that
of Trilium and its database, you can restore the <a href="#root/_help_ODY7qQn5m2FT">backup</a> that
is created prior to migration.</p>
<h2>Sync Compatibility</h2>
<p>The <a href="Synchronization.html">synchronization</a> protocol used by
Trilium is versioned, requiring all members of the sync cluster to use
<p>The <a href="#root/_help_cbkrhQjrkKrh">synchronization</a> protocol used
by Trilium is versioned, requiring all members of the sync cluster to use
the same protocol version. Therefore, when upgrading to a new version,
you may need to upgrade all instances in the sync cluster. Changes to the
sync protocol version are typically indicated on the release page.</p>

View File

@@ -32,8 +32,8 @@
</ul>
<p>Trilium will save these clippings as a new child note under a "clipper
inbox" note.</p>
<p>By default, that's the <a href="../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.html">day note</a> but
you can override that by setting the <a href="../Advanced%20Usage/Attributes.html">label</a> <code>clipperInbox</code>,
<p>By default, that's the <a href="#root/_help_l0tKav7yLHGF">day note</a> but
you can override that by setting the <a href="#root/_help_zEY4DaJG4YT5">label</a> <code>clipperInbox</code>,
on any other note.</p>
<p>If there's multiple clippings from the same page (and on the same day),
then they will be added to the same note.</p>
@@ -48,7 +48,7 @@
<h2>Configuration</h2>
<p>The extension needs to connect to a running Trilium instance. By default,
it scans a port range on the local computer to find a desktop Trilium instance.</p>
<p>It's also possible to configure the <a href="Server%20Installation.html">server</a> address
<p>It's also possible to configure the <a href="#root/_help_WOcw2SLH6tbX">server</a> address
if you don't run the desktop application, or want it to work without the
desktop application running.</p>
<h2>Username</h2>

View File

@@ -18,10 +18,10 @@
<h2>Creating a new note with a different type via the note tree</h2>
<p>The default note type in Trilium (e.g. when creating a new note) is&nbsp;
<a
class="reference-link" href="Note%20Types/Text.html">Text</a>, since it's for general use.</p>
class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>, since it's for general use.</p>
<p>To create a new note of a different type, head to the&nbsp;<a class="reference-link"
href="Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.html">Note Tree</a>&nbsp;and
right click an existing note where to place the new one and select:</p>
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;and right click an existing
note where to place the new one and select:</p>
<ul>
<li><em>Insert note after</em>, to put the new note underneath the one selected.</li>
<li><em>Insert child note</em>, to insert the note as a child of the selected
@@ -32,18 +32,18 @@
</p>
<h2>Creating a new note of a different type via add link or new tab</h2>
<ul>
<li>When adding a <a href="Note%20Types/Text/Links.html">link</a> in a&nbsp;
<a
class="reference-link" href="Note%20Types/Text.html">Text</a>&nbsp;note, type the desired title of the new note and press Enter.
Afterwards the type of the note will be asked.</li>
<li>When adding a <a href="#root/_help_QEAPj01N5f7w">link</a> in a&nbsp;<a class="reference-link"
href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;note, type the desired title
of the new note and press Enter. Afterwards the type of the note will be
asked.</li>
<li>Similarly, when creating a new tab, type the desired title and press Enter.</li>
</ul>
<h2>Changing the type of a note</h2>
<p>It is possible to change the type of a note after it has been created
via the <em>Basic Properties</em> tab in the&nbsp;<a class="reference-link"
href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.html">Ribbon</a>.
Note that it's generally a good idea to change the note type only if the
note is empty. Can also be used to edit the <a href="Advanced%20Usage/Note%20source.html">source of a note</a>.</p>
href="#root/_help_BlN9DFI679QC">Ribbon</a>. Note that it's generally a
good idea to change the note type only if the note is empty. Can also be
used to edit the <a href="#root/_help_4FahAwuGTAwC">source of a note</a>.</p>
<h2>Supported note types</h2>
<p>The following note types are supported by Trilium:</p>
<figure class="table"
@@ -61,45 +61,45 @@
</thead>
<tbody>
<tr>
<td><a class="reference-link" href="Note%20Types/Text.html">Text</a>
<td><a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>
</td>
<td>The default note type, which allows for rich text formatting, images,
admonitions and right-to-left support.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Code.html">Code</a>
<td><a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a>
</td>
<td>Uses a mono-space font and can be used to store larger chunks of code
or plain text than a text note, and has better syntax highlighting.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Saved%20Search.html">Saved Search</a>
<td><a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>
</td>
<td>Stores the information about a search (the search text, criteria, etc.)
for later use. Can be used for quick filtering of a large amount of notes,
for example. The search can easily be triggered.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Relation%20Map.html">Relation Map</a>
<td><a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a>
</td>
<td>Allows easy creation of notes and relations between them. Can be used
for mainly relational data such as a family tree.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Note%20Map.html">Note Map</a>
<td><a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>
</td>
<td>Displays the relationships between the notes, whether via relations or
their hierarchical structure.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Render%20Note.html">Render Note</a>
<td><a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a>
</td>
<td>Used in&nbsp;<a class="reference-link" href="Scripting.html">Scripting</a>,
<td>Used in&nbsp;<a class="reference-link" href="#root/_help_CdNpE2pqjmI6">Scripting</a>,
it displays the HTML content of another note. This allows displaying any
kind of content, provided there is a script behind it to generate it.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Book.html">Book</a>
<td><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Book</a>
</td>
<td>
<p>Displays the children of the note either as a grid, a list, or for a more
@@ -108,37 +108,37 @@
</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Mermaid%20Diagrams.html">Mermaid Diagrams</a>
<td><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a>
</td>
<td>Displays diagrams such as bar charts, flow charts, state diagrams, etc.
Requires a bit of technical knowledge since the diagrams are written in
a specialized format.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Canvas.html">Canvas</a>
<td><a class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a>
</td>
<td>Allows easy drawing of sketches, diagrams, handwritten content. Uses the
same technology behind <a href="https://excalidraw.com">excalidraw.com</a>.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Web%20View.html">Web View</a>
<td><a class="reference-link" href="#root/_help_1vHRoWCEjj0L">Web View</a>
</td>
<td>Displays the content of an external web page, similar to a browser.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Mind%20Map.html">Mind Map</a>
<td><a class="reference-link" href="#root/_help_gBbsAeiuUxI5">Mind Map</a>
</td>
<td>Easy for brainstorming ideas, by placing them in a hierarchical layout.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Geo%20Map.html">Geo Map</a>
<td><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map</a>
</td>
<td>Displays the children of the note as a geographical map, one use-case
would be to plan vacations. It even has basic support for tracks. Notes
can also be created from it.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/File.html">File</a>
<td><a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a>
</td>
<td>Represents an uploaded file such as PDFs, images, video or audio files.</td>
</tr>

View File

@@ -13,7 +13,7 @@
<h1 data-trilium-h1>Book</h1>
<div class="ck-content">
<p>A <strong>Book Note</strong> in Trilium is a special type of <a href="../Basic%20Concepts%20and%20Features/Notes.html">note</a> designed
<p>A <strong>Book Note</strong> in Trilium is a special type of <a href="#root/_help_BFs8mudNFgCS">note</a> designed
to display the contents of its child notes sequentially, creating a linear,
book-like reading experience. This format is particularly useful for viewing
multiple smaller notes in a cohesive, continuous manner.</p>
@@ -27,12 +27,12 @@
<p>The Book Note format compiles the contents of all child notes into one
continuous view. This makes it ideal for reading extensive information
broken into smaller, manageable segments.</p>
<p>It uses the&nbsp;<a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.html">Note List</a>&nbsp;mechanism
<p>It uses the&nbsp;<a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a>&nbsp;mechanism
to display the child notes, allowing the use of any of the view types (grid,
list, calendar).</p>
<p>To adjust the view type, see the dedicated <em>Book</em> tab in the&nbsp;
<a
class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.html">Ribbon</a>.</p>
class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>.</p>
</div>
</div>
</body>

View File

@@ -22,37 +22,36 @@
<li>JavaScript code notes can be executed inside Trilium for some extra functionality
<ul>
<li>we call such JavaScript code notes "scripts" - see&nbsp;<a class="reference-link"
href="../Scripting.html">Scripting</a>
href="#root/_help_CdNpE2pqjmI6">Scripting</a>
</li>
</ul>
</li>
<li>JSON, XML etc. can be used as storage for structured data (typically used
in conjunction with scripting)</li>
</ul>
<p>For shorter snippets of code that can be embedded in&nbsp;<a href="Text.html">Text</a>&nbsp;notes,
see&nbsp;<a href="Text/Developer-specific%20formatting/Code%20blocks.html">Code blocks</a>.</p>
<p>For shorter snippets of code that can be embedded in&nbsp;<a href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;notes,
see&nbsp;<a href="#root/_help_QxEyIjRBizuC">Code blocks</a>.</p>
<p>
<img src="Code_image.png">
</p>
<h2>Adjusting the language of a code note</h2>
<p>In the&nbsp;<a href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.html">Ribbon</a>,
look for the <em>Note type</em> selector and click it to reveal the possible
note types. Inside of it there will be a section called <em>Code</em>, select
any one of the languages.</p>
<p>In the&nbsp;<a href="#root/_help_BlN9DFI679QC">Ribbon</a>, look for the <em>Note type</em> selector
and click it to reveal the possible note types. Inside of it there will
be a section called <em>Code</em>, select any one of the languages.</p>
<p>
<img src="1_Code_image.png">
</p>
<h2>Adjusting the list of languages</h2>
<p>Trilium supports syntax highlighting for many languages, but by default
displays only some of them. The supported languages can be adjusted by
going to&nbsp;<a href="../Basic%20Concepts%20and%20Features/UI%20Elements/Options.html">Options</a>,
then <em>Code Notes</em> and looking for the <em>Available MIME types in the dropdown</em> section.
Simply check any of the items to add them to the list, or un-check them
to remove them from the list.</p>
going to&nbsp;<a href="#root/_help_4TIF1oA4VQRO">Options</a>, then <em>Code Notes</em> and
looking for the <em>Available MIME types in the dropdown</em> section. Simply
check any of the items to add them to the list, or un-check them to remove
them from the list.</p>
<p>Note that the list of languages is not immediately refreshed, you'd have
to manually <a href="../Troubleshooting/Refreshing%20the%20application.html">refresh the application</a>.</p>
<p>The list of languages is also shared with the&nbsp;<a href="Text/Developer-specific%20formatting/Code%20blocks.html">Code blocks</a>&nbsp;feature
of&nbsp;<a href="Text.html">Text</a>&nbsp;notes.</p>
to manually <a href="#root/_help_s8alTXmpFR61">refresh the application</a>.</p>
<p>The list of languages is also shared with the&nbsp;<a href="#root/_help_QxEyIjRBizuC">Code blocks</a>&nbsp;feature
of&nbsp;<a href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;notes.</p>
</div>
</div>
</body>

View File

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

Some files were not shown because too many files have changed in this diff Show More